@syncular/client 0.0.6-96 → 0.1.0

package/dist/worker-protocol.d.ts

@@ -0,0 +1,64 @@
+import type { SyncularGeneratedWorkerRequest } from './generated-bridge';
+import type { SyncularBootstrapStatus, SyncularDiagnosticEvent, SyncularErrorCategory, SyncularErrorCode, SyncularErrorRecommendedAction, SyncularLiveQueryEvent, SyncularRealtimeConnectionState, SyncularRowsChangedEvent } from './types';
+export declare const SYNCULAR_WORKER_PROTOCOL_VERSION = 2;
+export interface SyncularWorkerErrorPayload {
+    code: SyncularErrorCode;
+    message: string;
+    category?: SyncularErrorCategory;
+    retryable?: boolean;
+    recommendedAction?: SyncularErrorRecommendedAction;
+    name?: string;
+    stack?: string;
+    details?: unknown;
+}
+export declare function createSyncularWorkerErrorPayload(code: SyncularErrorCode, message?: string, options?: {
+    name?: string;
+    stack?: string;
+    details?: unknown;
+}): SyncularWorkerErrorPayload;
+export type { SyncularWorkerRealtimeOptions, SyncularWorkerRuntimeArtifact, } from './generated-bridge';
+export type SyncularWorkerRequest = SyncularGeneratedWorkerRequest;
+interface SyncularWorkerResponseBase {
+    id: number;
+    protocolVersion: typeof SYNCULAR_WORKER_PROTOCOL_VERSION;
+}
+interface SyncularWorkerEventBase {
+    protocolVersion: typeof SYNCULAR_WORKER_PROTOCOL_VERSION;
+}
+export type SyncularWorkerResponse = (SyncularWorkerResponseBase & {
+    ok: true;
+    value?: unknown;
+}) | (SyncularWorkerResponseBase & {
+    ok: false;
+    error: SyncularWorkerErrorPayload;
+});
+export type SyncularWorkerEvent = (SyncularWorkerEventBase & {
+    type: 'liveQueryEvents';
+    events: Array<SyncularLiveQueryEvent<Record<string, unknown>>>;
+}) | (SyncularWorkerEventBase & SyncularRowsChangedEvent & {
+    type: 'rowsChanged';
+}) | (SyncularWorkerEventBase & {
+    type: 'bootstrapChanged';
+    bootstrap: SyncularBootstrapStatus;
+}) | (SyncularWorkerEventBase & {
+    type: 'realtimeState';
+    state: SyncularRealtimeConnectionState;
+}) | (SyncularWorkerEventBase & {
+    type: 'presenceEvent';
+    action: 'join' | 'leave' | 'update' | 'snapshot';
+    scopeKey: string;
+    clientId?: string;
+    actorId?: string;
+    metadata?: Record<string, unknown>;
+    entries?: Array<{
+        clientId: string;
+        actorId: string;
+        joinedAt: number;
+        metadata?: Record<string, unknown>;
+    }>;
+}) | (SyncularWorkerEventBase & {
+    type: 'diagnostic';
+    event: SyncularDiagnosticEvent;
+});
+export type SyncularWorkerOutboundMessage = SyncularWorkerResponse | SyncularWorkerEvent;
+//# sourceMappingURL=worker-protocol.d.ts.map

package/dist/worker-protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-protocol.d.ts","sourceRoot":"","sources":["../src/worker-protocol.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,KAAK,EACV,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,EACjB,8BAA8B,EAC9B,sBAAsB,EACtB,+BAA+B,EAC/B,wBAAwB,EACzB,MAAM,SAAS,CAAC;AAEjB,eAAO,MAAM,gCAAgC,IAAI,CAAC;AAElD,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,iBAAiB,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,8BAA8B,CAAC;IACnD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,wBAAgB,gCAAgC,CAC9C,IAAI,EAAE,iBAAiB,EACvB,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,GAAE;IACP,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;CACd,GACL,0BAA0B,CAY5B;AAED,YAAY,EACV,6BAA6B,EAC7B,6BAA6B,GAC9B,MAAM,oBAAoB,CAAC;AAC5B,MAAM,MAAM,qBAAqB,GAAG,8BAA8B,CAAC;AAEnE,UAAU,0BAA0B;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,EAAE,OAAO,gCAAgC,CAAC;CAC1D;AAED,UAAU,uBAAuB;IAC/B,eAAe,EAAE,OAAO,gCAAgC,CAAC;CAC1D;AAED,MAAM,MAAM,sBAAsB,GAC9B,CAAC,0BAA0B,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,GAC5D,CAAC,0BAA0B,GAAG;IAC5B,EAAE,EAAE,KAAK,CAAC;IACV,KAAK,EAAE,0BAA0B,CAAC;CACnC,CAAC,CAAC;AAEP,MAAM,MAAM,mBAAmB,GAC3B,CAAC,uBAAuB,GAAG;IACzB,IAAI,EAAE,iBAAiB,CAAC;IACxB,MAAM,EAAE,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;CAChE,CAAC,GACF,CAAC,uBAAuB,GACtB,wBAAwB,GAAG;IACzB,IAAI,EAAE,aAAa,CAAC;CACrB,CAAC,GACJ,CAAC,uBAAuB,GAAG;IACzB,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,EAAE,uBAAuB,CAAC;CACpC,CAAC,GACF,CAAC,uBAAuB,GAAG;IACzB,IAAI,EAAE,eAAe,CAAC;IACtB,KAAK,EAAE,+BAA+B,CAAC;CACxC,CAAC,GACF,CAAC,uBAAuB,GAAG;IACzB,IAAI,EAAE,eAAe,CAAC;IACtB,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAC;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACpC,CAAC,CAAC;CACJ,CAAC,GACF,CAAC,uBAAuB,GAAG;IACzB,IAAI,EAAE,YAAY,CAAC;IACnB,KAAK,EAAE,uBAAuB,CAAC;CAChC,CAAC,CAAC;AAEP,MAAM,MAAM,6BAA6B,GACrC,sBAAsB,GACtB,mBAAmB,CAAC"}

package/dist/worker-protocol.js

@@ -0,0 +1,16 @@
+import { SYNCULAR_ERROR_DEFINITIONS } from '@syncular/core';
+export const SYNCULAR_WORKER_PROTOCOL_VERSION = 2;
+export function createSyncularWorkerErrorPayload(code, message, options = {}) {
+    const definition = SYNCULAR_ERROR_DEFINITIONS[code];
+    return {
+        code,
+        message: message ?? definition.message,
+        category: definition.category,
+        retryable: definition.retryable,
+        recommendedAction: definition.recommendedAction,
+        ...(options.name ? { name: options.name } : {}),
+        ...(options.stack ? { stack: options.stack } : {}),
+        ...(options.details !== undefined ? { details: options.details } : {}),
+    };
+}
+//# sourceMappingURL=worker-protocol.js.map

package/dist/worker-protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-protocol.js","sourceRoot":"","sources":["../src/worker-protocol.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AAa5D,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC;AAalD,MAAM,UAAU,gCAAgC,CAC9C,IAAuB,EACvB,OAAgB,EAChB,OAAO,GAIH,EAAE;IAEN,MAAM,UAAU,GAAG,0BAA0B,CAAC,IAAI,CAAC,CAAC;IACpD,OAAO;QACL,IAAI;QACJ,OAAO,EAAE,OAAO,IAAI,UAAU,CAAC,OAAO;QACtC,QAAQ,EAAE,UAAU,CAAC,QAAQ;QAC7B,SAAS,EAAE,UAAU,CAAC,SAAS;QAC/B,iBAAiB,EAAE,UAAU,CAAC,iBAAiB;QAC/C,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/C,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClD,GAAG,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACvE,CAAC;AACJ,CAAC"}

package/dist/worker-realtime.d.ts

@@ -0,0 +1,39 @@
+import type { ResolvedSyncularClientConfig, SyncularDiagnosticEvent, SyncularLiveQueryEvent, SyncularSyncRequestOptions, SyncularSyncResult } from './types';
+import type { SyncularWorkerEvent, SyncularWorkerRealtimeOptions } from './worker-protocol';
+export interface SyncularWorkerRealtimeClient {
+    syncPull(options?: SyncularSyncRequestOptions): Promise<SyncularSyncResult>;
+    applyRealtimeSyncPack?(bytes: Uint8Array): Promise<SyncularSyncResult>;
+    drainLiveQueryEvents<Row extends Record<string, unknown> = Record<string, unknown>>(): Array<SyncularLiveQueryEvent<Row>>;
+}
+export interface SyncularWorkerRealtimeSocket {
+    onopen: ((event: Event) => void) | null;
+    onmessage: ((event: MessageEvent) => void) | null;
+    onerror: ((event: Event) => void) | null;
+    onclose: ((event: CloseEvent) => void) | null;
+    send(data: string): void;
+    close(): void;
+}
+export interface SyncularWorkerRealtimeControllerOptions {
+    getClient(): SyncularWorkerRealtimeClient;
+    getConfig(): ResolvedSyncularClientConfig | undefined;
+    getLocationOrigin(): string;
+    createWebSocket(url: string): SyncularWorkerRealtimeSocket;
+    postEvent(event: SyncularWorkerEvent): void;
+    postDiagnostic?: (event: Omit<SyncularDiagnosticEvent, 'at'> & {
+        at?: number;
+    }) => void;
+    setTimeout?: typeof setTimeout;
+    clearTimeout?: typeof clearTimeout;
+    random?: () => number;
+}
+export declare class SyncularWorkerRealtimeController {
+    #private;
+    private readonly controllerOptions;
+    constructor(controllerOptions: SyncularWorkerRealtimeControllerOptions);
+    start(options: SyncularWorkerRealtimeOptions): void;
+    stop(): void;
+    sendPresence(action: 'join' | 'leave' | 'update', scopeKey: string, metadata?: Record<string, unknown>): void;
+}
+export declare function resolveSyncularRealtimeUrl(config: ResolvedSyncularClientConfig, options: SyncularWorkerRealtimeOptions, locationOrigin: string): string;
+export declare function isSyncularRealtimeSyncMessage(value: unknown): boolean;
+//# sourceMappingURL=worker-realtime.d.ts.map

package/dist/worker-realtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-realtime.d.ts","sourceRoot":"","sources":["../src/worker-realtime.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,4BAA4B,EAC5B,uBAAuB,EACvB,sBAAsB,EAEtB,0BAA0B,EAC1B,kBAAkB,EACnB,MAAM,SAAS,CAAC;AACjB,OAAO,KAAK,EACV,mBAAmB,EACnB,6BAA6B,EAC9B,MAAM,mBAAmB,CAAC;AAM3B,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,OAAO,CAAC,EAAE,0BAA0B,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC5E,qBAAqB,CAAC,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACvE,oBAAoB,CAClB,GAAG,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC1D,KAAK,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC;CACzC;AAoCD,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IACxC,SAAS,EAAE,CAAC,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IAClD,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IACzC,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;IAC9C,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,IAAI,IAAI,CAAC;CACf;AAED,MAAM,WAAW,uCAAuC;IACtD,SAAS,IAAI,4BAA4B,CAAC;IAC1C,SAAS,IAAI,4BAA4B,GAAG,SAAS,CAAC;IACtD,iBAAiB,IAAI,MAAM,CAAC;IAC5B,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,4BAA4B,CAAC;IAC3D,SAAS,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAC5C,cAAc,CAAC,EAAE,CACf,KAAK,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,GAAG;QAAE,EAAE,CAAC,EAAE,MAAM,CAAA;KAAE,KACzD,IAAI,CAAC;IACV,UAAU,CAAC,EAAE,OAAO,UAAU,CAAC;IAC/B,YAAY,CAAC,EAAE,OAAO,YAAY,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,MAAM,CAAC;CACvB;AAED,qBAAa,gCAAgC;;IAiBzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB;IADpC,YACmB,iBAAiB,EAAE,uCAAuC,EAS5E;IAED,KAAK,CAAC,OAAO,EAAE,6BAA6B,GAAG,IAAI,CAYlD;IAED,IAAI,IAAI,IAAI,CAUX;IAED,YAAY,CACV,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,EACnC,QAAQ,EAAE,MAAM,EAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACjC,IAAI,CAmBN;CA2cF;AAgDD,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,4BAA4B,EACpC,OAAO,EAAE,6BAA6B,EACtC,cAAc,EAAE,MAAM,GACrB,MAAM,CAcR;AAED,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAErE"}