@framers/sql-storage-adapter 0.4.2 → 0.5.1

package/dist/features/sync/protocol/messages.d.ts

@@ -0,0 +1,348 @@
+/**
+ * Cross-Platform Sync Protocol Messages.
+ *
+ * Defines the message format for device-to-device synchronization.
+ * Messages are exchanged over WebSocket or HTTP transport.
+ *
+ * @packageDocumentation
+ */
+import type { VectorClockData } from './vectorClock';
+/**
+ * Type of device in the sync network.
+ */
+export type DeviceType = 'electron' | 'capacitor' | 'browser' | 'server';
+/**
+ * Device information.
+ */
+export interface DeviceInfo {
+    /** Unique device identifier */
+    deviceId: string;
+    /** Device type */
+    deviceType: DeviceType;
+    /** Human-readable device name */
+    deviceName?: string;
+    /** App version running on device */
+    appVersion?: string;
+    /** Platform info (e.g., "macOS 14.0", "iOS 17.0") */
+    platform?: string;
+    /** When device was first seen */
+    firstSeen?: number;
+    /** When device was last active */
+    lastSeen?: number;
+}
+/**
+ * Type of database operation.
+ */
+export type ChangeOperation = 'INSERT' | 'UPDATE' | 'DELETE';
+/**
+ * A single database change record.
+ */
+export interface ChangeRecord {
+    /** Unique change ID (UUID) */
+    changeId: string;
+    /** Table name */
+    table: string;
+    /** Record primary key */
+    recordId: string;
+    /** Type of operation */
+    operation: ChangeOperation;
+    /** Vector clock at time of change */
+    vectorClock: VectorClockData;
+    /** Device that made the change */
+    deviceId: string;
+    /** Record data before change (for UPDATE/DELETE) */
+    oldData?: Record<string, unknown>;
+    /** Record data after change (for INSERT/UPDATE) */
+    newData?: Record<string, unknown>;
+    /** When change was made (local timestamp) */
+    timestamp: number;
+    /** Whether change has been synced */
+    synced?: boolean;
+}
+/**
+ * Batch of changes for efficient transfer.
+ */
+export interface ChangeBatch {
+    /** Changes in this batch */
+    changes: ChangeRecord[];
+    /** Batch sequence number */
+    sequence: number;
+    /** Total batches in this sync */
+    totalBatches: number;
+    /** Compressed (gzip/brotli) if true */
+    compressed?: boolean;
+}
+/**
+ * Current sync status.
+ */
+export type SyncStatus = 'idle' | 'connecting' | 'handshaking' | 'syncing' | 'resolving' | 'error' | 'disconnected';
+/**
+ * Sync progress information.
+ */
+export interface SyncProgress {
+    status: SyncStatus;
+    /** Records pushed to remote */
+    pushed: number;
+    /** Records pulled from remote */
+    pulled: number;
+    /** Conflicts detected */
+    conflicts: number;
+    /** Current table being synced */
+    currentTable?: string;
+    /** Progress percentage (0-100) */
+    percent: number;
+}
+/**
+ * Base message structure.
+ */
+export interface BaseMessage {
+    /** Message type discriminator */
+    type: string;
+    /** Unique message ID for acknowledgment */
+    messageId: string;
+    /** Sender device ID */
+    deviceId: string;
+    /** Message timestamp */
+    timestamp: number;
+}
+/**
+ * Handshake request - initiates connection.
+ */
+export interface HandshakeRequest extends BaseMessage {
+    type: 'handshake_request';
+    /** Sender device info */
+    device: DeviceInfo;
+    /** Current vector clock */
+    vectorClock: VectorClockData;
+    /** Supported protocol version */
+    protocolVersion: number;
+    /** Capabilities (e.g., compression, encryption) */
+    capabilities: string[];
+    /** Tables to sync */
+    tables: string[];
+}
+/**
+ * Handshake response - confirms connection.
+ */
+export interface HandshakeResponse extends BaseMessage {
+    type: 'handshake_response';
+    /** Whether handshake accepted */
+    accepted: boolean;
+    /** Rejection reason if not accepted */
+    rejectionReason?: string;
+    /** Server device info */
+    device: DeviceInfo;
+    /** Server's vector clock */
+    vectorClock: VectorClockData;
+    /** Negotiated protocol version */
+    protocolVersion: number;
+    /** Negotiated capabilities */
+    capabilities: string[];
+    /** Session ID for this connection */
+    sessionId: string;
+}
+/**
+ * Delta push - send local changes to remote.
+ */
+export interface DeltaPush extends BaseMessage {
+    type: 'delta_push';
+    /** Batch of changes */
+    batch: ChangeBatch;
+    /** Current vector clock after changes */
+    vectorClock: VectorClockData;
+}
+/**
+ * Delta pull request - request changes since clock.
+ */
+export interface DeltaPullRequest extends BaseMessage {
+    type: 'delta_pull_request';
+    /** Vector clock to sync from */
+    sinceVectorClock: VectorClockData;
+    /** Tables to pull */
+    tables?: string[];
+    /** Maximum records to return */
+    limit?: number;
+}
+/**
+ * Delta pull response - changes from remote.
+ */
+export interface DeltaPullResponse extends BaseMessage {
+    type: 'delta_pull_response';
+    /** Batch of changes */
+    batch: ChangeBatch;
+    /** Server's current vector clock */
+    vectorClock: VectorClockData;
+    /** Whether more changes available */
+    hasMore: boolean;
+}
+/**
+ * Acknowledgment message.
+ */
+export interface AckMessage extends BaseMessage {
+    type: 'ack';
+    /** ID of message being acknowledged */
+    ackMessageId: string;
+    /** Success status */
+    success: boolean;
+    /** Error message if failed */
+    error?: string;
+}
+/**
+ * Conflict notification.
+ */
+export interface ConflictMessage extends BaseMessage {
+    type: 'conflict';
+    /** Table with conflict */
+    table: string;
+    /** Record ID with conflict */
+    recordId: string;
+    /** Local version */
+    localData: Record<string, unknown>;
+    /** Remote version */
+    remoteData: Record<string, unknown>;
+    /** Local vector clock */
+    localClock: VectorClockData;
+    /** Remote vector clock */
+    remoteClock: VectorClockData;
+    /** Suggested resolution */
+    suggestedResolution?: 'use_local' | 'use_remote' | 'merge';
+}
+/**
+ * Conflict resolution.
+ */
+export interface ConflictResolution extends BaseMessage {
+    type: 'conflict_resolution';
+    /** Original conflict message ID */
+    conflictMessageId: string;
+    /** Resolution strategy */
+    resolution: 'use_local' | 'use_remote' | 'use_merged' | 'keep_both' | 'defer';
+    /** Merged data if using 'use_merged' */
+    mergedData?: Record<string, unknown>;
+}
+/**
+ * Device presence update.
+ */
+export interface PresenceMessage extends BaseMessage {
+    type: 'presence';
+    /** Presence status */
+    status: 'online' | 'offline' | 'away' | 'syncing';
+    /** Device info */
+    device: DeviceInfo;
+    /** Current vector clock */
+    vectorClock?: VectorClockData;
+}
+/**
+ * Heartbeat for connection keep-alive.
+ */
+export interface HeartbeatMessage extends BaseMessage {
+    type: 'heartbeat';
+    /** Sequence number */
+    sequence: number;
+}
+/**
+ * Heartbeat acknowledgment.
+ */
+export interface HeartbeatAck extends BaseMessage {
+    type: 'heartbeat_ack';
+    /** Echo sequence number */
+    sequence: number;
+    /** Round-trip time if measurable */
+    rtt?: number;
+}
+/**
+ * Error message.
+ */
+export interface ErrorMessage extends BaseMessage {
+    type: 'error';
+    /** Error code */
+    code: string;
+    /** Human-readable message */
+    message: string;
+    /** Whether error is recoverable */
+    recoverable: boolean;
+    /** Related message ID if applicable */
+    relatedMessageId?: string;
+}
+/**
+ * All possible sync messages.
+ */
+export type SyncMessage = HandshakeRequest | HandshakeResponse | DeltaPush | DeltaPullRequest | DeltaPullResponse | AckMessage | ConflictMessage | ConflictResolution | PresenceMessage | HeartbeatMessage | HeartbeatAck | ErrorMessage;
+/**
+ * Message type discriminator values.
+ */
+export type SyncMessageType = SyncMessage['type'];
+/**
+ * Generate a unique message ID.
+ */
+export declare function generateMessageId(): string;
+/**
+ * Create a base message with common fields.
+ */
+export declare function createBaseMessage(type: string, deviceId: string): Omit<BaseMessage, 'type'> & {
+    type: string;
+};
+/**
+ * Create a handshake request message.
+ */
+export declare function createHandshakeRequest(device: DeviceInfo, vectorClock: VectorClockData, tables: string[], capabilities?: string[]): HandshakeRequest;
+/**
+ * Create an acknowledgment message.
+ */
+export declare function createAck(deviceId: string, ackMessageId: string, success: boolean, error?: string): AckMessage;
+/**
+ * Create a heartbeat message.
+ */
+export declare function createHeartbeat(deviceId: string, sequence: number): HeartbeatMessage;
+/**
+ * Create an error message.
+ */
+export declare function createError(deviceId: string, code: string, message: string, recoverable?: boolean, relatedMessageId?: string): ErrorMessage;
+/**
+ * Check if message is a handshake request.
+ */
+export declare function isHandshakeRequest(msg: SyncMessage): msg is HandshakeRequest;
+/**
+ * Check if message is a delta push.
+ */
+export declare function isDeltaPush(msg: SyncMessage): msg is DeltaPush;
+/**
+ * Check if message is a conflict.
+ */
+export declare function isConflict(msg: SyncMessage): msg is ConflictMessage;
+/**
+ * Check if message is an error.
+ */
+export declare function isError(msg: SyncMessage): msg is ErrorMessage;
+/**
+ * Type guard to check if an unknown value is a valid SyncMessage.
+ */
+export declare function isSyncMessage(value: unknown): value is SyncMessage;
+/**
+ * Create a delta push message.
+ */
+export declare function createDeltaPushMessage(deviceId: string, changes: ChangeRecord[], vectorClock: VectorClockData, sequence?: number, totalBatches?: number): DeltaPush;
+/**
+ * Create a delta pull request message.
+ */
+export declare function createDeltaPullRequest(deviceId: string, sinceVectorClock: VectorClockData, tables?: string[], limit?: number): DeltaPullRequest;
+/**
+ * Create a presence message.
+ */
+export declare function createPresenceMessage(device: DeviceInfo, status: 'online' | 'offline' | 'away' | 'syncing', vectorClock?: VectorClockData): PresenceMessage;
+/**
+ * Create a heartbeat message.
+ */
+export declare function createHeartbeatMessage(deviceId: string, sequence?: number): HeartbeatMessage;
+/**
+ * Create an ack message.
+ */
+export declare function createAckMessage(deviceId: string, ackMessageId: string, success?: boolean, error?: string): AckMessage;
+/**
+ * Generate a unique change ID.
+ */
+export declare function generateChangeId(): string;
+/**
+ * Create a change record.
+ */
+export declare function createChangeRecord(table: string, recordId: string, operation: ChangeOperation, deviceId: string, vectorClock: VectorClockData, newData?: Record<string, unknown>, oldData?: Record<string, unknown>): ChangeRecord;
+//# sourceMappingURL=messages.d.ts.map

package/dist/features/sync/protocol/messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../../../src/features/sync/protocol/messages.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAMrD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,kBAAkB;IAClB,UAAU,EAAE,UAAU,CAAC;IACvB,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAMD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE7D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,wBAAwB;IACxB,SAAS,EAAE,eAAe,CAAC;IAC3B,qCAAqC;IACrC,WAAW,EAAE,eAAe,CAAC;IAC7B,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC;IACrC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,4BAA4B;IAC5B,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,iCAAiC;IACjC,YAAY,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAMD;;GAEG;AACH,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,YAAY,GACZ,aAAa,GACb,SAAS,GACT,WAAW,GACX,OAAO,GACP,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,UAAU,CAAC;IACnB,+BAA+B;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;CACjB;AAMD;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,iCAAiC;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,uBAAuB;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,IAAI,EAAE,mBAAmB,CAAC;IAC1B,yBAAyB;IACzB,MAAM,EAAE,UAAU,CAAC;IACnB,2BAA2B;IAC3B,WAAW,EAAE,eAAe,CAAC;IAC7B,iCAAiC;IACjC,eAAe,EAAE,MAAM,CAAC;IACxB,mDAAmD;IACnD,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,qBAAqB;IACrB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,IAAI,EAAE,oBAAoB,CAAC;IAC3B,iCAAiC;IACjC,QAAQ,EAAE,OAAO,CAAC;IAClB,uCAAuC;IACvC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,yBAAyB;IACzB,MAAM,EAAE,UAAU,CAAC;IACnB,4BAA4B;IAC5B,WAAW,EAAE,eAAe,CAAC;IAC7B,kCAAkC;IAClC,eAAe,EAAE,MAAM,CAAC;IACxB,8BAA8B;IAC9B,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,WAAW;IAC5C,IAAI,EAAE,YAAY,CAAC;IACnB,uBAAuB;IACvB,KAAK,EAAE,WAAW,CAAC;IACnB,yCAAyC;IACzC,WAAW,EAAE,eAAe,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,IAAI,EAAE,oBAAoB,CAAC;IAC3B,gCAAgC;IAChC,gBAAgB,EAAE,eAAe,CAAC;IAClC,qBAAqB;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,gCAAgC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,WAAW;IACpD,IAAI,EAAE,qBAAqB,CAAC;IAC5B,uBAAuB;IACvB,KAAK,EAAE,WAAW,CAAC;IACnB,oCAAoC;IACpC,WAAW,EAAE,eAAe,CAAC;IAC7B,qCAAqC;IACrC,OAAO,EAAE,OAAO,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,UAAW,SAAQ,WAAW;IAC7C,IAAI,EAAE,KAAK,CAAC;IACZ,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,qBAAqB;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,8BAA8B;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,IAAI,EAAE,UAAU,CAAC;IACjB,0BAA0B;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,qBAAqB;IACrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,yBAAyB;IACzB,UAAU,EAAE,eAAe,CAAC;IAC5B,0BAA0B;IAC1B,WAAW,EAAE,eAAe,CAAC;IAC7B,2BAA2B;IAC3B,mBAAmB,CAAC,EAAE,WAAW,GAAG,YAAY,GAAG,OAAO,CAAC;CAC5D;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACrD,IAAI,EAAE,qBAAqB,CAAC;IAC5B,mCAAmC;IACnC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,0BAA0B;IAC1B,UAAU,EAAE,WAAW,GAAG,YAAY,GAAG,YAAY,GAAG,WAAW,GAAG,OAAO,CAAC;IAC9E,wCAAwC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,WAAW;IAClD,IAAI,EAAE,UAAU,CAAC;IACjB,sBAAsB;IACtB,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAAC;IAClD,kBAAkB;IAClB,MAAM,EAAE,UAAU,CAAC;IACnB,2BAA2B;IAC3B,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD,IAAI,EAAE,WAAW,CAAC;IAClB,sBAAsB;IACtB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,IAAI,EAAE,eAAe,CAAC;IACtB,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C,IAAI,EAAE,OAAO,CAAC;IACd,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,WAAW,EAAE,OAAO,CAAC;IACrB,uCAAuC;IACvC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAMD;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,gBAAgB,GAChB,iBAAiB,GACjB,SAAS,GACT,gBAAgB,GAChB,iBAAiB,GACjB,UAAU,GACV,eAAe,GACf,kBAAkB,GAClB,eAAe,GACf,gBAAgB,GAChB,YAAY,GACZ,YAAY,CAAC;AAEjB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;AAMlD;;GAEG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAI1C;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,MAAM,GACf,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAO9C;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,UAAU,EAClB,WAAW,EAAE,eAAe,EAC5B,MAAM,EAAE,MAAM,EAAE,EAChB,YAAY,GAAE,MAAM,EAAsB,GACzC,gBAAgB,CAUlB;AAED;;GAEG;AACH,wBAAgB,SAAS,CACvB,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,OAAO,EAChB,KAAK,CAAC,EAAE,MAAM,GACb,UAAU,CAQZ;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,GACf,gBAAgB,CAMlB;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,WAAW,GAAE,OAAc,EAC3B,gBAAgB,CAAC,EAAE,MAAM,GACxB,YAAY,CASd;AAMD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,gBAAgB,CAE5E;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,SAAS,CAE9D;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,eAAe,CAEnE;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,WAAW,GAAG,GAAG,IAAI,YAAY,CAE7D;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,WAAW,CAelE;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,YAAY,EAAE,EACvB,WAAW,EAAE,eAAe,EAC5B,QAAQ,SAAI,EACZ,YAAY,SAAI,GACf,SAAS,CAWX;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,MAAM,EAChB,gBAAgB,EAAE,eAAe,EACjC,MAAM,CAAC,EAAE,MAAM,EAAE,EACjB,KAAK,CAAC,EAAE,MAAM,GACb,gBAAgB,CAQlB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,UAAU,EAClB,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EACjD,WAAW,CAAC,EAAE,eAAe,GAC5B,eAAe,CAQjB;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,SAAI,GAAG,gBAAgB,CAMvF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,OAAO,UAAO,EACd,KAAK,CAAC,EAAE,MAAM,GACb,UAAU,CAQZ;AAED;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,MAAM,CAIzC;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,eAAe,EAC1B,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,eAAe,EAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,YAAY,CAad"}

package/dist/features/sync/protocol/messages.js

@@ -0,0 +1,216 @@
+/**
+ * Cross-Platform Sync Protocol Messages.
+ *
+ * Defines the message format for device-to-device synchronization.
+ * Messages are exchanged over WebSocket or HTTP transport.
+ *
+ * @packageDocumentation
+ */
+// ============================================================================
+// Factory Functions
+// ============================================================================
+/**
+ * Generate a unique message ID.
+ */
+export function generateMessageId() {
+    const timestamp = Date.now().toString(36);
+    const random = Math.random().toString(36).substring(2, 10);
+    return `msg_${timestamp}_${random}`;
+}
+/**
+ * Create a base message with common fields.
+ */
+export function createBaseMessage(type, deviceId) {
+    return {
+        type,
+        messageId: generateMessageId(),
+        deviceId,
+        timestamp: Date.now(),
+    };
+}
+/**
+ * Create a handshake request message.
+ */
+export function createHandshakeRequest(device, vectorClock, tables, capabilities = ['gzip', 'delta']) {
+    return {
+        ...createBaseMessage('handshake_request', device.deviceId),
+        type: 'handshake_request',
+        device,
+        vectorClock,
+        protocolVersion: 1,
+        capabilities,
+        tables,
+    };
+}
+/**
+ * Create an acknowledgment message.
+ */
+export function createAck(deviceId, ackMessageId, success, error) {
+    return {
+        ...createBaseMessage('ack', deviceId),
+        type: 'ack',
+        ackMessageId,
+        success,
+        error,
+    };
+}
+/**
+ * Create a heartbeat message.
+ */
+export function createHeartbeat(deviceId, sequence) {
+    return {
+        ...createBaseMessage('heartbeat', deviceId),
+        type: 'heartbeat',
+        sequence,
+    };
+}
+/**
+ * Create an error message.
+ */
+export function createError(deviceId, code, message, recoverable = true, relatedMessageId) {
+    return {
+        ...createBaseMessage('error', deviceId),
+        type: 'error',
+        code,
+        message,
+        recoverable,
+        relatedMessageId,
+    };
+}
+// ============================================================================
+// Type Guards
+// ============================================================================
+/**
+ * Check if message is a handshake request.
+ */
+export function isHandshakeRequest(msg) {
+    return msg.type === 'handshake_request';
+}
+/**
+ * Check if message is a delta push.
+ */
+export function isDeltaPush(msg) {
+    return msg.type === 'delta_push';
+}
+/**
+ * Check if message is a conflict.
+ */
+export function isConflict(msg) {
+    return msg.type === 'conflict';
+}
+/**
+ * Check if message is an error.
+ */
+export function isError(msg) {
+    return msg.type === 'error';
+}
+/**
+ * Type guard to check if an unknown value is a valid SyncMessage.
+ */
+export function isSyncMessage(value) {
+    if (!value || typeof value !== 'object')
+        return false;
+    const msg = value;
+    if (typeof msg.type !== 'string')
+        return false;
+    if (typeof msg.messageId !== 'string')
+        return false;
+    if (typeof msg.deviceId !== 'string')
+        return false;
+    if (typeof msg.timestamp !== 'number')
+        return false;
+    const validTypes = [
+        'handshake_request', 'handshake_response',
+        'delta_push', 'delta_pull_request', 'delta_pull_response',
+        'ack', 'conflict', 'conflict_resolution',
+        'presence', 'heartbeat', 'heartbeat_ack', 'error',
+    ];
+    return validTypes.includes(msg.type);
+}
+/**
+ * Create a delta push message.
+ */
+export function createDeltaPushMessage(deviceId, changes, vectorClock, sequence = 1, totalBatches = 1) {
+    return {
+        ...createBaseMessage('delta_push', deviceId),
+        type: 'delta_push',
+        batch: {
+            changes,
+            sequence,
+            totalBatches,
+        },
+        vectorClock,
+    };
+}
+/**
+ * Create a delta pull request message.
+ */
+export function createDeltaPullRequest(deviceId, sinceVectorClock, tables, limit) {
+    return {
+        ...createBaseMessage('delta_pull_request', deviceId),
+        type: 'delta_pull_request',
+        sinceVectorClock,
+        tables,
+        limit,
+    };
+}
+/**
+ * Create a presence message.
+ */
+export function createPresenceMessage(device, status, vectorClock) {
+    return {
+        ...createBaseMessage('presence', device.deviceId),
+        type: 'presence',
+        status,
+        device,
+        vectorClock,
+    };
+}
+/**
+ * Create a heartbeat message.
+ */
+export function createHeartbeatMessage(deviceId, sequence = 0) {
+    return {
+        ...createBaseMessage('heartbeat', deviceId),
+        type: 'heartbeat',
+        sequence,
+    };
+}
+/**
+ * Create an ack message.
+ */
+export function createAckMessage(deviceId, ackMessageId, success = true, error) {
+    return {
+        ...createBaseMessage('ack', deviceId),
+        type: 'ack',
+        ackMessageId,
+        success,
+        error,
+    };
+}
+/**
+ * Generate a unique change ID.
+ */
+export function generateChangeId() {
+    const timestamp = Date.now().toString(36);
+    const random = Math.random().toString(36).substring(2, 10);
+    return `chg_${timestamp}_${random}`;
+}
+/**
+ * Create a change record.
+ */
+export function createChangeRecord(table, recordId, operation, deviceId, vectorClock, newData, oldData) {
+    return {
+        changeId: generateChangeId(),
+        table,
+        recordId,
+        operation,
+        deviceId,
+        vectorClock,
+        newData,
+        oldData,
+        timestamp: Date.now(),
+        synced: false,
+    };
+}
+//# sourceMappingURL=messages.js.map

package/dist/features/sync/protocol/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../../../../src/features/sync/protocol/messages.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAyUH,+EAA+E;AAC/E,oBAAoB;AACpB,+EAA+E;AAE/E;;GAEG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC3D,OAAO,OAAO,SAAS,IAAI,MAAM,EAAE,CAAC;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAC/B,IAAY,EACZ,QAAgB;IAEhB,OAAO;QACL,IAAI;QACJ,SAAS,EAAE,iBAAiB,EAAE;QAC9B,QAAQ;QACR,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;KACtB,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAkB,EAClB,WAA4B,EAC5B,MAAgB,EAChB,eAAyB,CAAC,MAAM,EAAE,OAAO,CAAC;IAE1C,OAAO;QACL,GAAG,iBAAiB,CAAC,mBAAmB,EAAE,MAAM,CAAC,QAAQ,CAAC;QAC1D,IAAI,EAAE,mBAAmB;QACzB,MAAM;QACN,WAAW;QACX,eAAe,EAAE,CAAC;QAClB,YAAY;QACZ,MAAM;KACP,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,SAAS,CACvB,QAAgB,EAChB,YAAoB,EACpB,OAAgB,EAChB,KAAc;IAEd,OAAO;QACL,GAAG,iBAAiB,CAAC,KAAK,EAAE,QAAQ,CAAC;QACrC,IAAI,EAAE,KAAK;QACX,YAAY;QACZ,OAAO;QACP,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,QAAgB,EAChB,QAAgB;IAEhB,OAAO;QACL,GAAG,iBAAiB,CAAC,WAAW,EAAE,QAAQ,CAAC;QAC3C,IAAI,EAAE,WAAW;QACjB,QAAQ;KACT,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CACzB,QAAgB,EAChB,IAAY,EACZ,OAAe,EACf,cAAuB,IAAI,EAC3B,gBAAyB;IAEzB,OAAO;QACL,GAAG,iBAAiB,CAAC,OAAO,EAAE,QAAQ,CAAC;QACvC,IAAI,EAAE,OAAO;QACb,IAAI;QACJ,OAAO;QACP,WAAW;QACX,gBAAgB;KACjB,CAAC;AACJ,CAAC;AAED,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAE/E;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAAgB;IACjD,OAAO,GAAG,CAAC,IAAI,KAAK,mBAAmB,CAAC;AAC1C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,GAAgB;IAC1C,OAAO,GAAG,CAAC,IAAI,KAAK,YAAY,CAAC;AACnC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,UAAU,CAAC,GAAgB;IACzC,OAAO,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,OAAO,CAAC,GAAgB;IACtC,OAAO,GAAG,CAAC,IAAI,KAAK,OAAO,CAAC;AAC9B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACtD,MAAM,GAAG,GAAG,KAAgC,CAAC;IAC7C,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC/C,IAAI,OAAO,GAAG,CAAC,SAAS,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACpD,IAAI,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACnD,IAAI,OAAO,GAAG,CAAC,SAAS,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAEpD,MAAM,UAAU,GAAG;QACjB,mBAAmB,EAAE,oBAAoB;QACzC,YAAY,EAAE,oBAAoB,EAAE,qBAAqB;QACzD,KAAK,EAAE,UAAU,EAAE,qBAAqB;QACxC,UAAU,EAAE,WAAW,EAAE,eAAe,EAAE,OAAO;KAClD,CAAC;IACF,OAAO,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;AACvC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CACpC,QAAgB,EAChB,OAAuB,EACvB,WAA4B,EAC5B,QAAQ,GAAG,CAAC,EACZ,YAAY,GAAG,CAAC;IAEhB,OAAO;QACL,GAAG,iBAAiB,CAAC,YAAY,EAAE,QAAQ,CAAC;QAC5C,IAAI,EAAE,YAAY;QAClB,KAAK,EAAE;YACL,OAAO;YACP,QAAQ;YACR,YAAY;SACb;QACD,WAAW;KACZ,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CACpC,QAAgB,EAChB,gBAAiC,EACjC,MAAiB,EACjB,KAAc;IAEd,OAAO;QACL,GAAG,iBAAiB,CAAC,oBAAoB,EAAE,QAAQ,CAAC;QACpD,IAAI,EAAE,oBAAoB;QAC1B,gBAAgB;QAChB,MAAM;QACN,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,MAAkB,EAClB,MAAiD,EACjD,WAA6B;IAE7B,OAAO;QACL,GAAG,iBAAiB,CAAC,UAAU,EAAE,MAAM,CAAC,QAAQ,CAAC;QACjD,IAAI,EAAE,UAAU;QAChB,MAAM;QACN,MAAM;QACN,WAAW;KACZ,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,QAAgB,EAAE,QAAQ,GAAG,CAAC;IACnE,OAAO;QACL,GAAG,iBAAiB,CAAC,WAAW,EAAE,QAAQ,CAAC;QAC3C,IAAI,EAAE,WAAW;QACjB,QAAQ;KACT,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAAgB,EAChB,YAAoB,EACpB,OAAO,GAAG,IAAI,EACd,KAAc;IAEd,OAAO;QACL,GAAG,iBAAiB,CAAC,KAAK,EAAE,QAAQ,CAAC;QACrC,IAAI,EAAE,KAAK;QACX,YAAY;QACZ,OAAO;QACP,KAAK;KACN,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB;IAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC3D,OAAO,OAAO,SAAS,IAAI,MAAM,EAAE,CAAC;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,KAAa,EACb,QAAgB,EAChB,SAA0B,EAC1B,QAAgB,EAChB,WAA4B,EAC5B,OAAiC,EACjC,OAAiC;IAEjC,OAAO;QACL,QAAQ,EAAE,gBAAgB,EAAE;QAC5B,KAAK;QACL,QAAQ;QACR,SAAS;QACT,QAAQ;QACR,WAAW;QACX,OAAO;QACP,OAAO;QACP,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,MAAM,EAAE,KAAK;KACd,CAAC;AACJ,CAAC"}