@objectstack/spec 0.6.1 → 0.7.1

package/dist/api/websocket.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.zod.d.ts","sourceRoot":"","sources":["../../src/api/websocket.zod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;;;;;GAOG;AAMH;;;GAGG;AACH,eAAO,MAAM,oBAAoB,gHAW/B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAMxE;;;GAGG;AACH,eAAO,MAAM,cAAc,yHAczB,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;EAI/B,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,CAAC,CAAC,OAAO,CAAC;IACxC,UAAU,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACpC,GAAG,CAAC,EAAE,WAAW,EAAE,CAAC;IACpB,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC;IACnB,GAAG,CAAC,EAAE,WAAW,CAAC;CACnB,CAKC,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,kBAAkB,aAMiD,CAAC;AAEjF,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;;;;qBA/BrB,oBAAoB,EAAE;cAC7B,WAAW,EAAE;aACd,WAAW,EAAE;cACZ,WAAW;;qBAHJ,oBAAoB,EAAE;cAC7B,WAAW,EAAE;aACd,WAAW,EAAE;cACZ,WAAW;;;;;;;qBAHJ,oBAAoB,EAAE;cAC7B,WAAW,EAAE;aACd,WAAW,EAAE;cACZ,WAAW;;;;;;;;qBAHJ,oBAAoB,EAAE;cAC7B,WAAW,EAAE;aACd,WAAW,EAAE;cACZ,WAAW;;;;EAkCjB,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;;GAGG;AACH,eAAO,MAAM,wBAAwB;;;;;;EAEnC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAM1E;;;GAGG;AACH,eAAO,MAAM,uBAAuB,kDAKlC,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAE9E;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;EAS9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;EAK/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAMlE;;;GAGG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAqB/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE;;;GAGG;AACH,eAAO,MAAM,iBAAiB,4CAI5B,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAElE;;;;GAIG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkB9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;EAO9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAgBhE;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;yBA3MpB,oBAAoB,EAAE;kBAC7B,WAAW,EAAE;iBACd,WAAW,EAAE;kBACZ,WAAW;;yBAHJ,oBAAoB,EAAE;kBAC7B,WAAW,EAAE;iBACd,WAAW,EAAE;kBACZ,WAAW;;;;;;;yBAHJ,oBAAoB,EAAE;kBAC7B,WAAW,EAAE;iBACd,WAAW,EAAE;kBACZ,WAAW;;;;;;;;yBAHJ,oBAAoB,EAAE;kBAC7B,WAAW,EAAE;iBACd,WAAW,EAAE;kBACZ,WAAW;;;;;;;;;;;;yBAHJ,oBAAoB,EAAE;kBAC7B,WAAW,EAAE;iBACd,WAAW,EAAE;kBACZ,WAAW;;;;;;;;;;;;;yBAHJ,oBAAoB,EAAE;kBAC7B,WAAW,EAAE;iBACd,WAAW,EAAE;kBACZ,WAAW;;;;;;EA2MjB,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;EAGnC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAE1E;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAO7B,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGhC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE;;;GAGG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAG5B,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;EAK3B,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;EAK7B,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;EAE5B,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;EAG5B,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAE5D;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;yBAhUpB,oBAAoB,EAAE;kBAC7B,WAAW,EAAE;iBACd,WAAW,EAAE;kBACZ,WAAW;;yBAHJ,oBAAoB,EAAE;kBAC7B,WAAW,EAAE;iBACd,WAAW,EAAE;kBACZ,WAAW;;;;;;;yBAHJ,oBAAoB,EAAE;kBAC7B,WAAW,EAAE;iBACd,WAAW,EAAE;kBACZ,WAAW;;;;;;;;yBAHJ,oBAAoB,EAAE;kBAC7B,WAAW,EAAE;iBACd,WAAW,EAAE;kBACZ,WAAW;;;;;;;;;;;;yBAHJ,oBAAoB,EAAE;kBAC7B,WAAW,EAAE;iBACd,WAAW,EAAE;kBACZ,WAAW;;;;;;;;;;;;;yBAHJ,oBAAoB,EAAE;kBAC7B,WAAW,EAAE;iBACd,WAAW,EAAE;kBACZ,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAwUjB,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAMtE;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;EAShC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAMpE;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;EAY/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;EAMpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;EAOtC,CAAC;AAEH,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAC"}

package/dist/api/websocket.zod.js

@@ -0,0 +1,470 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketServerConfigSchema = exports.SimpleCursorPositionSchema = exports.SimplePresenceStateSchema = exports.WebSocketEventSchema = exports.WebSocketConfigSchema = exports.WebSocketMessageSchema = exports.PongMessageSchema = exports.PingMessageSchema = exports.ErrorMessageSchema = exports.AckMessageSchema = exports.EditMessageSchema = exports.CursorMessageSchema = exports.PresenceMessageSchema = exports.EventMessageSchema = exports.UnsubscribeMessageSchema = exports.SubscribeMessageSchema = exports.DocumentStateSchema = exports.EditOperationSchema = exports.EditOperationType = exports.CursorPositionSchema = exports.PresenceUpdateSchema = exports.PresenceStateSchema = exports.WebSocketPresenceStatus = exports.UnsubscribeRequestSchema = exports.EventSubscriptionSchema = exports.EventPatternSchema = exports.EventFilterSchema = exports.EventFilterCondition = exports.FilterOperator = exports.WebSocketMessageType = void 0;
+const zod_1 = require("zod");
+const identifiers_zod_1 = require("../shared/identifiers.zod");
+/**
+ * WebSocket Event Protocol
+ *
+ * Defines the schema for WebSocket-based real-time communication in ObjectStack.
+ * Supports event subscriptions, filtering, presence tracking, and collaborative editing.
+ *
+ * Industry alignment: Firebase Realtime Database, Socket.IO, Pusher
+ */
+// ==========================================
+// Message Types
+// ==========================================
+/**
+ * WebSocket Message Type Enum
+ * Defines the types of messages that can be sent over WebSocket
+ */
+exports.WebSocketMessageType = zod_1.z.enum([
+    'subscribe', // Client subscribes to events
+    'unsubscribe', // Client unsubscribes from events
+    'event', // Server sends event to client
+    'ping', // Keepalive ping
+    'pong', // Keepalive pong response
+    'ack', // Acknowledgment of message receipt
+    'error', // Error message
+    'presence', // Presence update (user status)
+    'cursor', // Cursor position update (collaborative editing)
+    'edit', // Document edit operation (collaborative editing)
+]);
+// ==========================================
+// Event Subscription
+// ==========================================
+/**
+ * Event Filter Operator Enum
+ * SQL-like filter operators for event filtering
+ */
+exports.FilterOperator = zod_1.z.enum([
+    'eq', // Equal
+    'ne', // Not equal
+    'gt', // Greater than
+    'gte', // Greater than or equal
+    'lt', // Less than
+    'lte', // Less than or equal
+    'in', // In array
+    'nin', // Not in array
+    'contains', // String contains
+    'startsWith', // String starts with
+    'endsWith', // String ends with
+    'exists', // Field exists
+    'regex', // Regex match
+]);
+/**
+ * Event Filter Condition
+ * Defines a single filter condition for event filtering
+ */
+exports.EventFilterCondition = zod_1.z.object({
+    field: zod_1.z.string().describe('Field path to filter on (supports dot notation, e.g., "user.email")'),
+    operator: exports.FilterOperator.describe('Comparison operator'),
+    value: zod_1.z.any().optional().describe('Value to compare against (not needed for "exists" operator)'),
+});
+/**
+ * Event Filter Schema
+ * Logical combination of filter conditions
+ */
+exports.EventFilterSchema = zod_1.z.object({
+    conditions: zod_1.z.array(exports.EventFilterCondition).optional().describe('Array of filter conditions'),
+    and: zod_1.z.lazy(() => zod_1.z.array(exports.EventFilterSchema)).optional().describe('AND logical combination of filters'),
+    or: zod_1.z.lazy(() => zod_1.z.array(exports.EventFilterSchema)).optional().describe('OR logical combination of filters'),
+    not: zod_1.z.lazy(() => exports.EventFilterSchema).optional().describe('NOT logical negation of filter'),
+});
+/**
+ * Event Pattern Schema
+ * Event name pattern that supports wildcards for subscriptions
+ */
+exports.EventPatternSchema = zod_1.z
+    .string()
+    .min(1)
+    .regex(/^[a-z*][a-z0-9_.*]*$/, {
+    message: 'Event pattern must be lowercase and may contain letters, numbers, underscores, dots, or wildcards (e.g., "record.*", "*.created", "user.login")',
+})
+    .describe('Event pattern (supports wildcards like "record.*" or "*.created")');
+/**
+ * Event Subscription Config
+ * Configuration for subscribing to specific events
+ */
+exports.EventSubscriptionSchema = zod_1.z.object({
+    subscriptionId: zod_1.z.string().uuid().describe('Unique subscription identifier'),
+    events: zod_1.z.array(exports.EventPatternSchema).describe('Event patterns to subscribe to (supports wildcards, e.g., "record.*", "user.created")'),
+    objects: zod_1.z.array(zod_1.z.string()).optional().describe('Object names to filter events by (e.g., ["account", "contact"])'),
+    filters: exports.EventFilterSchema.optional().describe('Advanced filter conditions for event payloads'),
+    channels: zod_1.z.array(zod_1.z.string()).optional().describe('Channel names for scoped subscriptions'),
+});
+/**
+ * Unsubscribe Request
+ * Request to unsubscribe from events
+ */
+exports.UnsubscribeRequestSchema = zod_1.z.object({
+    subscriptionId: zod_1.z.string().uuid().describe('Subscription ID to unsubscribe from'),
+});
+// ==========================================
+// Presence Tracking
+// ==========================================
+/**
+ * Presence Status Enum
+ * User availability status for presence tracking
+ */
+exports.WebSocketPresenceStatus = zod_1.z.enum([
+    'online', // User is actively online
+    'away', // User is idle/away
+    'busy', // User is busy (do not disturb)
+    'offline', // User is offline
+]);
+/**
+ * Presence State Schema
+ * Tracks real-time user presence and activity
+ */
+exports.PresenceStateSchema = zod_1.z.object({
+    userId: zod_1.z.string().describe('User identifier'),
+    sessionId: zod_1.z.string().uuid().describe('Unique session identifier'),
+    status: exports.WebSocketPresenceStatus.describe('Current presence status'),
+    lastSeen: zod_1.z.string().datetime().describe('ISO 8601 datetime of last activity'),
+    currentLocation: zod_1.z.string().optional().describe('Current page/route user is viewing'),
+    device: zod_1.z.enum(['desktop', 'mobile', 'tablet', 'other']).optional().describe('Device type'),
+    customStatus: zod_1.z.string().optional().describe('Custom user status message'),
+    metadata: zod_1.z.record(zod_1.z.any()).optional().describe('Additional custom presence data'),
+});
+/**
+ * Presence Update Request
+ * Client request to update presence status
+ */
+exports.PresenceUpdateSchema = zod_1.z.object({
+    status: exports.WebSocketPresenceStatus.optional().describe('Updated presence status'),
+    currentLocation: zod_1.z.string().optional().describe('Updated current location'),
+    customStatus: zod_1.z.string().optional().describe('Updated custom status message'),
+    metadata: zod_1.z.record(zod_1.z.any()).optional().describe('Updated metadata'),
+});
+// ==========================================
+// Collaborative Editing Protocol
+// ==========================================
+/**
+ * Cursor Position Schema
+ * Represents a cursor position in a document
+ */
+exports.CursorPositionSchema = zod_1.z.object({
+    userId: zod_1.z.string().describe('User identifier'),
+    sessionId: zod_1.z.string().uuid().describe('Session identifier'),
+    documentId: zod_1.z.string().describe('Document identifier being edited'),
+    position: zod_1.z.object({
+        line: zod_1.z.number().int().nonnegative().describe('Line number (0-indexed)'),
+        column: zod_1.z.number().int().nonnegative().describe('Column number (0-indexed)'),
+    }).optional().describe('Cursor position in document'),
+    selection: zod_1.z.object({
+        start: zod_1.z.object({
+            line: zod_1.z.number().int().nonnegative(),
+            column: zod_1.z.number().int().nonnegative(),
+        }),
+        end: zod_1.z.object({
+            line: zod_1.z.number().int().nonnegative(),
+            column: zod_1.z.number().int().nonnegative(),
+        }),
+    }).optional().describe('Selection range (if text is selected)'),
+    color: zod_1.z.string().optional().describe('Cursor color for visual representation'),
+    userName: zod_1.z.string().optional().describe('Display name of user'),
+    lastUpdate: zod_1.z.string().datetime().describe('ISO 8601 datetime of last cursor update'),
+});
+/**
+ * Edit Operation Type Enum
+ * Types of edit operations for collaborative editing
+ */
+exports.EditOperationType = zod_1.z.enum([
+    'insert', // Insert text at position
+    'delete', // Delete text from range
+    'replace', // Replace text in range
+]);
+/**
+ * Edit Operation Schema
+ * Represents a single edit operation on a document
+ * Supports Operational Transformation (OT) for conflict resolution
+ */
+exports.EditOperationSchema = zod_1.z.object({
+    operationId: zod_1.z.string().uuid().describe('Unique operation identifier'),
+    documentId: zod_1.z.string().describe('Document identifier'),
+    userId: zod_1.z.string().describe('User who performed the edit'),
+    sessionId: zod_1.z.string().uuid().describe('Session identifier'),
+    type: exports.EditOperationType.describe('Type of edit operation'),
+    position: zod_1.z.object({
+        line: zod_1.z.number().int().nonnegative().describe('Line number (0-indexed)'),
+        column: zod_1.z.number().int().nonnegative().describe('Column number (0-indexed)'),
+    }).describe('Starting position of the operation'),
+    endPosition: zod_1.z.object({
+        line: zod_1.z.number().int().nonnegative(),
+        column: zod_1.z.number().int().nonnegative(),
+    }).optional().describe('Ending position (for delete/replace operations)'),
+    content: zod_1.z.string().optional().describe('Content to insert/replace'),
+    version: zod_1.z.number().int().nonnegative().describe('Document version before this operation'),
+    timestamp: zod_1.z.string().datetime().describe('ISO 8601 datetime when operation was created'),
+    baseOperationId: zod_1.z.string().uuid().optional().describe('Previous operation ID this builds upon (for OT)'),
+});
+/**
+ * Document State Schema
+ * Represents the current state of a collaborative document
+ */
+exports.DocumentStateSchema = zod_1.z.object({
+    documentId: zod_1.z.string().describe('Document identifier'),
+    version: zod_1.z.number().int().nonnegative().describe('Current document version'),
+    content: zod_1.z.string().describe('Current document content'),
+    lastModified: zod_1.z.string().datetime().describe('ISO 8601 datetime of last modification'),
+    activeSessions: zod_1.z.array(zod_1.z.string().uuid()).describe('Active editing session IDs'),
+    checksum: zod_1.z.string().optional().describe('Content checksum for integrity verification'),
+});
+// ==========================================
+// WebSocket Messages
+// ==========================================
+/**
+ * Base WebSocket Message
+ * All WebSocket messages extend this base structure
+ */
+const BaseWebSocketMessage = zod_1.z.object({
+    messageId: zod_1.z.string().uuid().describe('Unique message identifier'),
+    type: exports.WebSocketMessageType.describe('Message type'),
+    timestamp: zod_1.z.string().datetime().describe('ISO 8601 datetime when message was sent'),
+});
+/**
+ * Subscribe Message
+ * Client sends this to subscribe to events
+ */
+exports.SubscribeMessageSchema = BaseWebSocketMessage.extend({
+    type: zod_1.z.literal('subscribe'),
+    subscription: exports.EventSubscriptionSchema.describe('Subscription configuration'),
+});
+/**
+ * Unsubscribe Message
+ * Client sends this to unsubscribe from events
+ */
+exports.UnsubscribeMessageSchema = BaseWebSocketMessage.extend({
+    type: zod_1.z.literal('unsubscribe'),
+    request: exports.UnsubscribeRequestSchema.describe('Unsubscribe request'),
+});
+/**
+ * Event Message
+ * Server sends this when a subscribed event occurs
+ */
+exports.EventMessageSchema = BaseWebSocketMessage.extend({
+    type: zod_1.z.literal('event'),
+    subscriptionId: zod_1.z.string().uuid().describe('Subscription ID this event belongs to'),
+    eventName: identifiers_zod_1.EventNameSchema.describe('Event name'),
+    object: zod_1.z.string().optional().describe('Object name the event relates to'),
+    payload: zod_1.z.any().describe('Event payload data'),
+    userId: zod_1.z.string().optional().describe('User who triggered the event'),
+});
+/**
+ * Presence Message
+ * Presence update message
+ */
+exports.PresenceMessageSchema = BaseWebSocketMessage.extend({
+    type: zod_1.z.literal('presence'),
+    presence: exports.PresenceStateSchema.describe('Presence state'),
+});
+/**
+ * Cursor Message
+ * Cursor position update for collaborative editing
+ */
+exports.CursorMessageSchema = BaseWebSocketMessage.extend({
+    type: zod_1.z.literal('cursor'),
+    cursor: exports.CursorPositionSchema.describe('Cursor position'),
+});
+/**
+ * Edit Message
+ * Document edit operation for collaborative editing
+ */
+exports.EditMessageSchema = BaseWebSocketMessage.extend({
+    type: zod_1.z.literal('edit'),
+    operation: exports.EditOperationSchema.describe('Edit operation'),
+});
+/**
+ * Acknowledgment Message
+ * Server acknowledges receipt of a message
+ */
+exports.AckMessageSchema = BaseWebSocketMessage.extend({
+    type: zod_1.z.literal('ack'),
+    ackMessageId: zod_1.z.string().uuid().describe('ID of the message being acknowledged'),
+    success: zod_1.z.boolean().describe('Whether the operation was successful'),
+    error: zod_1.z.string().optional().describe('Error message if operation failed'),
+});
+/**
+ * Error Message
+ * Server sends error information
+ */
+exports.ErrorMessageSchema = BaseWebSocketMessage.extend({
+    type: zod_1.z.literal('error'),
+    code: zod_1.z.string().describe('Error code'),
+    message: zod_1.z.string().describe('Error message'),
+    details: zod_1.z.any().optional().describe('Additional error details'),
+});
+/**
+ * Ping Message
+ * Keepalive ping from client or server
+ */
+exports.PingMessageSchema = BaseWebSocketMessage.extend({
+    type: zod_1.z.literal('ping'),
+});
+/**
+ * Pong Message
+ * Keepalive pong response
+ */
+exports.PongMessageSchema = BaseWebSocketMessage.extend({
+    type: zod_1.z.literal('pong'),
+    pingMessageId: zod_1.z.string().uuid().optional().describe('ID of ping message being responded to'),
+});
+/**
+ * WebSocket Message Union
+ * Discriminated union of all WebSocket message types
+ */
+exports.WebSocketMessageSchema = zod_1.z.discriminatedUnion('type', [
+    exports.SubscribeMessageSchema,
+    exports.UnsubscribeMessageSchema,
+    exports.EventMessageSchema,
+    exports.PresenceMessageSchema,
+    exports.CursorMessageSchema,
+    exports.EditMessageSchema,
+    exports.AckMessageSchema,
+    exports.ErrorMessageSchema,
+    exports.PingMessageSchema,
+    exports.PongMessageSchema,
+]);
+// ==========================================
+// Connection Configuration
+// ==========================================
+/**
+ * WebSocket Connection Config
+ * Configuration for WebSocket connections
+ */
+exports.WebSocketConfigSchema = zod_1.z.object({
+    url: zod_1.z.string().url().describe('WebSocket server URL'),
+    protocols: zod_1.z.array(zod_1.z.string()).optional().describe('WebSocket sub-protocols'),
+    reconnect: zod_1.z.boolean().optional().default(true).describe('Enable automatic reconnection'),
+    reconnectInterval: zod_1.z.number().int().positive().optional().default(1000).describe('Reconnection interval in milliseconds'),
+    maxReconnectAttempts: zod_1.z.number().int().positive().optional().default(5).describe('Maximum reconnection attempts'),
+    pingInterval: zod_1.z.number().int().positive().optional().default(30000).describe('Ping interval in milliseconds'),
+    timeout: zod_1.z.number().int().positive().optional().default(5000).describe('Message timeout in milliseconds'),
+    headers: zod_1.z.record(zod_1.z.string()).optional().describe('Custom headers for WebSocket handshake'),
+});
+// ==========================================
+// Simplified Collaboration API
+// ==========================================
+/**
+ * Simplified WebSocket Event Schema
+ *
+ * A simplified event schema for basic WebSocket communication.
+ * Complements the comprehensive WebSocketMessageSchema above for simpler use cases.
+ *
+ * @example Subscribe to channel
+ * ```typescript
+ * {
+ *   type: 'subscribe',
+ *   channel: 'record.account.123',
+ *   payload: { events: ['created', 'updated'] },
+ *   timestamp: Date.now()
+ * }
+ * ```
+ *
+ * @example Data change notification
+ * ```typescript
+ * {
+ *   type: 'data-change',
+ *   channel: 'record.account.123',
+ *   payload: { id: '123', action: 'updated', data: {...} },
+ *   timestamp: Date.now()
+ * }
+ * ```
+ */
+exports.WebSocketEventSchema = zod_1.z.object({
+    type: zod_1.z.enum([
+        'subscribe', // Client subscribes to channel
+        'unsubscribe', // Client unsubscribes from channel
+        'data-change', // Data modification event
+        'presence-update', // User presence change
+        'cursor-update', // Cursor position change (collaborative editing)
+        'error', // Error message
+    ]).describe('Event type'),
+    channel: zod_1.z.string().describe('Channel identifier (e.g., "record.account.123", "user.456")'),
+    payload: zod_1.z.any().describe('Event payload data'),
+    timestamp: zod_1.z.number().describe('Unix timestamp in milliseconds'),
+});
+/**
+ * Simplified Presence State Schema
+ *
+ * A simplified presence schema for basic user presence tracking.
+ * Complements the comprehensive PresenceStateSchema for simpler integrations.
+ *
+ * Use this for basic presence features. For advanced features like device tracking,
+ * custom status, and session management, use the comprehensive PresenceStateSchema above.
+ *
+ * @example User online
+ * ```typescript
+ * {
+ *   userId: 'user123',
+ *   userName: 'John Doe',
+ *   status: 'online',
+ *   lastSeen: Date.now(),
+ *   metadata: { currentPage: '/dashboard' }
+ * }
+ * ```
+ */
+exports.SimplePresenceStateSchema = zod_1.z.object({
+    userId: zod_1.z.string().describe('User identifier'),
+    userName: zod_1.z.string().describe('User display name'),
+    status: zod_1.z.enum(['online', 'away', 'offline']).describe('User presence status'),
+    lastSeen: zod_1.z.number().describe('Unix timestamp of last activity in milliseconds'),
+    metadata: zod_1.z.record(zod_1.z.any()).optional().describe('Additional presence metadata (e.g., current page, custom status)'),
+});
+/**
+ * Simplified Cursor Position Schema
+ *
+ * A simplified cursor position schema for basic collaborative editing.
+ * Complements the comprehensive CursorPositionSchema for simpler use cases.
+ *
+ * Use this for basic cursor sharing. For advanced features like selections,
+ * color coding, and document versioning, use the comprehensive CursorPositionSchema above.
+ *
+ * @example Cursor in text field
+ * ```typescript
+ * {
+ *   userId: 'user123',
+ *   recordId: 'account_456',
+ *   fieldName: 'description',
+ *   position: 42,
+ *   selection: { start: 42, end: 57 }
+ * }
+ * ```
+ */
+exports.SimpleCursorPositionSchema = zod_1.z.object({
+    userId: zod_1.z.string().describe('User identifier'),
+    recordId: zod_1.z.string().describe('Record identifier being edited'),
+    fieldName: zod_1.z.string().describe('Field name being edited'),
+    position: zod_1.z.number().describe('Cursor position (character offset from start)'),
+    selection: zod_1.z.object({
+        start: zod_1.z.number().describe('Selection start position'),
+        end: zod_1.z.number().describe('Selection end position'),
+    }).optional().describe('Text selection range (if text is selected)'),
+});
+/**
+ * WebSocket Server Configuration Schema
+ *
+ * Server-side configuration for WebSocket services.
+ * Controls features like presence tracking, cursor sharing, and connection management.
+ *
+ * @example Production configuration
+ * ```typescript
+ * {
+ *   enabled: true,
+ *   path: '/ws',
+ *   heartbeatInterval: 30000,
+ *   reconnectAttempts: 5,
+ *   presence: true,
+ *   cursorSharing: true
+ * }
+ * ```
+ */
+exports.WebSocketServerConfigSchema = zod_1.z.object({
+    enabled: zod_1.z.boolean().default(false).describe('Enable WebSocket server'),
+    path: zod_1.z.string().default('/ws').describe('WebSocket endpoint path'),
+    heartbeatInterval: zod_1.z.number().default(30000).describe('Heartbeat interval in milliseconds'),
+    reconnectAttempts: zod_1.z.number().default(5).describe('Maximum reconnection attempts for clients'),
+    presence: zod_1.z.boolean().default(false).describe('Enable presence tracking'),
+    cursorSharing: zod_1.z.boolean().default(false).describe('Enable collaborative cursor sharing'),
+});