@syncular/server 0.0.6-96 → 0.1.0

package/dist/hono/routes/context.d.ts

@@ -0,0 +1,314 @@
+/**
+ * Shared per-instance context for the sync route modules.
+ *
+ * createSyncRoutesContext() contains the entire setup block of the former
+ * monolithic createSyncRoutes() factory (Hono app creation, CORS + rate-limit
+ * middleware, handler registry, websocket manager, realtime broadcaster
+ * bridge, console request-event recording, and the shared push/pull
+ * execution pipeline). Route modules destructure what they need from the
+ * returned context object.
+ */
+import { type ScopeValues, type SyncPullSubscriptionResponse, type SyncPushResponse } from '@syncular/core';
+import type { SqlFamily, SyncCoreDb } from '@syncular/server';
+import { type PushCommitValidator } from '@syncular/server';
+import type { Context } from 'hono';
+import { Hono } from 'hono';
+import { WebSocketConnectionManager, type WebSocketRealtimeSubscription } from '../ws';
+import { type AuditChangeResponse, type AuditDebugExportEvent, type CreateSyncRoutesOptions, type RequestPayloadSnapshot, type SyncAuthResult, type TraceContext } from './shared';
+export declare function createSyncRoutesContext<DB extends SyncCoreDb = SyncCoreDb, Auth extends SyncAuthResult = SyncAuthResult, F extends SqlFamily = SqlFamily>(options: CreateSyncRoutesOptions<DB, Auth, F>): {
+    routes: Hono<import("hono/types").BlankEnv, import("hono/types").BlankSchema, "/">;
+    config: import("./shared").SyncRoutesConfigWithRateLimit;
+    options: CreateSyncRoutesOptions<DB, Auth, F>;
+    authLeaseRoutesConfig: import("./shared").SyncAuthLeaseRoutesConfig<Auth> | undefined;
+    corsConfig: import("./shared").NormalizedSyncCorsConfig | null;
+    handlerRegistry: import("@syncular/server").ServerHandlerCollection<DB, Auth>;
+    binarySyncPackChangeRowEncoders: {
+        [k: string]: import("@syncular/core").BinarySnapshotRowsEncoder;
+    };
+    maxPullLimitCommits: number;
+    maxSubscriptionsPerPull: number;
+    maxPullLimitSnapshotRows: number;
+    maxPullMaxSnapshotPages: number;
+    maxOperationsPerPush: number;
+    maxSyncRequestJsonBytes: number;
+    maxSyncBinaryPackBytes: number;
+    maxSnapshotChunkResponseBytes: number;
+    maxSnapshotArtifactResponseBytes: number;
+    requiredSchemaVersion: number | undefined;
+    latestSchemaVersion: number | undefined;
+    consoleLiveEmitter: {
+        emit(event: {
+            type: 'sync' | 'push' | 'pull' | 'commit' | 'client_update';
+            timestamp: string;
+            data: Record<string, unknown>;
+        }): void;
+    } | undefined;
+    shouldEmitConsoleLiveEvents: boolean;
+    shouldRecordRequestEvents: boolean;
+    shouldCaptureRequestPayloadSnapshots: boolean;
+    getAuth: (c: Context) => Promise<Auth | null>;
+    createAuditScopeResolver: (auth: Auth) => (table: string) => Promise<{
+        scopes: ScopeValues;
+        requiredScopeKeys: string[];
+    } | null>;
+    readVisibleAuditChanges: (args: {
+        auth: Auth;
+        partitionId: string;
+        commitSeqs: readonly number[];
+    }) => Promise<Map<number, AuditChangeResponse[]>>;
+    readAuditDebugRequestEvents: (args: {
+        auth: Auth;
+        partitionId: string;
+        limit: number;
+        from?: string;
+        to?: string;
+    }) => Promise<{
+        events: AuditDebugExportEvent[];
+        truncated: boolean;
+    }>;
+    validateAuthLeaseCommit: PushCommitValidator<DB, Auth> | undefined;
+    readLimitedSyncJsonBody: (c: Context) => Promise<{
+        ok: true;
+        value: unknown;
+    } | {
+        ok: false;
+        response: Response;
+        failure?: {
+            statusCode: number;
+            errorCode: string;
+            errorMessage: string;
+        };
+    }>;
+    websocketConfig: import("./shared").SyncWebSocketConfig | undefined;
+    wsConnectionManager: WebSocketConnectionManager | null;
+    realtimeBroadcaster: import("@syncular/server").SyncRealtimeBroadcaster | null;
+    instanceId: string;
+    logAsyncFailureOnce: (key: string, event: {
+        event: string;
+        error: string;
+        [key: string]: unknown;
+    }) => void;
+    triggerAutoMaintenance: (ctx: {
+        actorId: string;
+        clientId: string;
+        partitionId: string;
+    }) => void;
+    recordRequestEventInBackground: (event: {
+        partitionId: string;
+        requestId: string;
+        traceId?: string | null;
+        spanId?: string | null;
+        eventType: 'sync' | 'push' | 'pull';
+        syncPath: 'http-combined' | 'ws-push';
+        actorId: string;
+        clientId: string;
+        transportPath: 'direct' | 'relay';
+        statusCode: number;
+        outcome: string;
+        responseStatus: string;
+        durationMs: number;
+        errorCode?: string | null;
+        commitSeq?: number | null;
+        operationCount?: number | null;
+        rowCount?: number | null;
+        subscriptionCount?: number | null;
+        scopesSummary?: Record<string, string | string[]> | null;
+        responseSummary?: Record<string, unknown> | null;
+        tables?: string[];
+        errorMessage?: string | null;
+        payloadRef?: string | null;
+        payloadSnapshot?: RequestPayloadSnapshot | null;
+    } | (() => {
+        partitionId: string;
+        requestId: string;
+        traceId?: string | null;
+        spanId?: string | null;
+        eventType: 'sync' | 'push' | 'pull';
+        syncPath: 'http-combined' | 'ws-push';
+        actorId: string;
+        clientId: string;
+        transportPath: 'direct' | 'relay';
+        statusCode: number;
+        outcome: string;
+        responseStatus: string;
+        durationMs: number;
+        errorCode?: string | null;
+        commitSeq?: number | null;
+        operationCount?: number | null;
+        rowCount?: number | null;
+        subscriptionCount?: number | null;
+        scopesSummary?: Record<string, string | string[]> | null;
+        responseSummary?: Record<string, unknown> | null;
+        tables?: string[];
+        errorMessage?: string | null;
+        payloadRef?: string | null;
+        payloadSnapshot?: RequestPayloadSnapshot | null;
+    })) => void;
+    recordRealtimeEventInBackground: (event: {
+        partitionId: string;
+        actorId: string;
+        clientId: string;
+        transportPath: 'direct' | 'relay';
+        eventType: 'connected' | 'disconnected' | 'error' | 'pull_required' | 'ack' | 'rejected';
+        reason?: string | null;
+        cursor?: number | null;
+        latestCursor?: number | null;
+        commitSeq?: number | null;
+        scopeCount?: number | null;
+        skippedCount?: number | null;
+        syncPackEncoding?: string | null;
+    } | (() => {
+        partitionId: string;
+        actorId: string;
+        clientId: string;
+        transportPath: 'direct' | 'relay';
+        eventType: 'connected' | 'disconnected' | 'error' | 'pull_required' | 'ack' | 'rejected';
+        reason?: string | null;
+        cursor?: number | null;
+        latestCursor?: number | null;
+        commitSeq?: number | null;
+        scopeCount?: number | null;
+        skippedCount?: number | null;
+        syncPackEncoding?: string | null;
+    })) => void;
+    recordHttpCombinedFailure: (args: {
+        partitionId: string;
+        requestId: string;
+        traceContext: TraceContext;
+        actorId: string;
+        clientId: string;
+        transportPath: 'direct' | 'relay';
+        eventType: 'sync' | 'push' | 'pull';
+        statusCode: number;
+        outcome: 'rejected' | 'error';
+        durationMs: number;
+        errorCode: string;
+        errorMessage: string;
+        operationCount?: number | null;
+        rowCount?: number | null;
+        subscriptionCount?: number | null;
+        scopesSummary?: Record<string, string | string[]> | null;
+        responseSummary?: Record<string, unknown> | null;
+        payloadSnapshot?: RequestPayloadSnapshot | null;
+    }) => void;
+    recordHttpCombinedReadFailure: (c: Context, failure: {
+        statusCode: number;
+        errorCode: string;
+        errorMessage: string;
+    }) => Promise<void>;
+    notifyRealtimeForAppliedPushes: (ctx: {
+        auth: Auth;
+        clientId: string;
+        partitionId: string;
+        requestId: string;
+        traceContext: TraceContext;
+        transportPath: 'direct' | 'relay';
+        syncPath: 'http-combined' | 'ws-push';
+    }, pushedCommits: import("@syncular/server").PushCommitResult[]) => Promise<void>;
+    buildRealtimeSubscriptionsForPull: (args: {
+        partitionId: string;
+        requestSubscriptions: Array<{
+            id: string;
+            table: string;
+            scopes: Record<string, string | string[]>;
+            cursor: number;
+            verifiedRoot?: string;
+        }>;
+        responseSubscriptions: SyncPullSubscriptionResponse[];
+    }) => WebSocketRealtimeSubscription[];
+    serializeRealtimeSubscriptions: (subscriptions: readonly WebSocketRealtimeSubscription[]) => unknown[];
+    recordPushExecutionSideEffects: (ctx: {
+        auth: Auth;
+        clientId: string;
+        partitionId: string;
+        requestId: string;
+        traceContext: TraceContext;
+        transportPath: 'direct' | 'relay';
+        syncPath: 'http-combined' | 'ws-push';
+    }, summary: {
+        durationMs: number;
+        outcome: string;
+        commitSeq: number | null;
+        operationCount: number;
+        tables: string[];
+        results: SyncPushResponse['results'];
+        payloadSnapshot: RequestPayloadSnapshot | null;
+    }) => void;
+    maybeCountPushConflicts: (ctx: {
+        auth: Auth;
+        clientId: string;
+        partitionId: string;
+        requestId: string;
+        traceContext: TraceContext;
+        transportPath: 'direct' | 'relay';
+        syncPath: 'http-combined' | 'ws-push';
+    }, results: SyncPushResponse['results'], enabled?: boolean) => void;
+    emitCommitLiveEvents: (ctx: {
+        auth: Auth;
+        clientId: string;
+        partitionId: string;
+        requestId: string;
+        traceContext: TraceContext;
+        transportPath: 'direct' | 'relay';
+        syncPath: 'http-combined' | 'ws-push';
+    }, pushedCommits: import("@syncular/server").PushCommitResult[]) => void;
+    executePushCommitBatchWithSideEffects: (ctx: {
+        auth: Auth;
+        clientId: string;
+        partitionId: string;
+        requestId: string;
+        traceContext: TraceContext;
+        transportPath: 'direct' | 'relay';
+        syncPath: 'http-combined' | 'ws-push';
+    }, pushBodies: Omit<{
+        clientCommitId: string;
+        operations: {
+            table: string;
+            row_id: string;
+            op: "delete" | "upsert";
+            payload: Record<string, unknown> | null;
+            base_version?: number | null | undefined;
+        }[];
+        schemaVersion: number;
+        authLease?: {
+            leaseId: string;
+            leaseExpiresAtMs: number;
+            leaseStatusAtEnqueue: string;
+            leaseScopeSummaryJson?: string | undefined;
+            leaseToken?: string | undefined;
+        } | undefined;
+    }, never>[], execOptions?: {
+        countConflictsMetric?: boolean;
+    }) => Promise<import("@syncular/server").PushCommitResult[]>;
+    executePushCommitWithSideEffects: (ctx: {
+        auth: Auth;
+        clientId: string;
+        partitionId: string;
+        requestId: string;
+        traceContext: TraceContext;
+        transportPath: 'direct' | 'relay';
+        syncPath: 'http-combined' | 'ws-push';
+    }, pushBody: Omit<{
+        clientCommitId: string;
+        operations: {
+            table: string;
+            row_id: string;
+            op: "delete" | "upsert";
+            payload: Record<string, unknown> | null;
+            base_version?: number | null | undefined;
+        }[];
+        schemaVersion: number;
+        authLease?: {
+            leaseId: string;
+            leaseExpiresAtMs: number;
+            leaseStatusAtEnqueue: string;
+            leaseScopeSummaryJson?: string | undefined;
+            leaseToken?: string | undefined;
+        } | undefined;
+    }, never>, execOptions?: {
+        countConflictsMetric?: boolean;
+        deferRealtimeNotifications?: boolean;
+    }) => Promise<import("@syncular/server").PushCommitResult>;
+};
+export type SyncRoutesContext<DB extends SyncCoreDb = SyncCoreDb, Auth extends SyncAuthResult = SyncAuthResult, F extends SqlFamily = SqlFamily> = ReturnType<typeof createSyncRoutesContext<DB, Auth, F>>;
+//# sourceMappingURL=context.d.ts.map

package/dist/hono/routes/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/hono/routes/context.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAML,KAAK,WAAW,EAIhB,KAAK,4BAA4B,EAEjC,KAAK,gBAAgB,EACtB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EACV,SAAS,EACT,UAAU,EAEX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAML,KAAK,mBAAmB,EAMzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAqB,MAAM,MAAM,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAY5B,OAAO,EACL,0BAA0B,EAC1B,KAAK,6BAA6B,EACnC,MAAM,OAAO,CAAC;AACf,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAG1B,KAAK,uBAAuB,EAmB5B,KAAK,sBAAsB,EAY3B,KAAK,cAAc,EAInB,KAAK,YAAY,EAElB,MAAM,UAAU,CAAC;AAElB,wBAAgB,uBAAuB,CACrC,EAAE,SAAS,UAAU,GAAG,UAAU,EAClC,IAAI,SAAS,cAAc,GAAG,cAAc,EAC5C,CAAC,SAAS,SAAS,GAAG,SAAS,EAC/B,OAAO,EAAE,uBAAuB,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgIzB,OAAO,KAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC;qCAWV,IAAI,aAMrB,MAAM,KAAG,OAAO,CAAC;gBAT9B,WAAW;2BACA,MAAM,EAAE;QAQ8B,IAAI,CAAC;oCAqCnB;QAC3C,IAAI,EAAE,IAAI,CAAC;QACX,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;KAC/B,KAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,mBAAmB,EAAE,CAAC,CAAC;wCAoEE;QAC/C,IAAI,EAAE,IAAI,CAAC;QACX,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,EAAE,CAAC,EAAE,MAAM,CAAC;KACb,KAAG,OAAO,CAAC;QACV,MAAM,EAAE,qBAAqB,EAAE,CAAC;QAChC,SAAS,EAAE,OAAO,CAAC;KACpB,CAAC;;iCAyLkC,OAAO,KAAG,OAAO;YAH3C,IAAI;eAAS,OAAO;;YACpB,KAAK;kBAAY,QAAQ;;wBANrB,MAAM;uBACP,MAAM;0BACH,MAAM;;MAMmD;;;;;+BAoHlE,MAAM,SACJ;QACL,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,MAAM,CAAC;QACd,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB;kCAckC;QACnC,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACrB,KAAG,IAAI;4CAsMC;qBAtHM,MAAM;mBACR,MAAM;kBACP,MAAM,GAAG,IAAI;iBACd,MAAM,GAAG,IAAI;mBACX,MAAM,GAAG,MAAM,GAAG,MAAM;kBACzB,eAAe,GAAG,SAAS;iBAC5B,MAAM;kBACL,MAAM;uBACD,QAAQ,GAAG,OAAO;oBACrB,MAAM;iBACT,MAAM;wBACC,MAAM;oBACV,MAAM;oBACN,MAAM,GAAG,IAAI;oBACb,MAAM,GAAG,IAAI;yBACR,MAAM,GAAG,IAAI;mBACnB,MAAM,GAAG,IAAI;4BACJ,MAAM,GAAG,IAAI;wBACjB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,IAAI;0BACtC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;iBACvC,MAAM,EAAE;uBACF,MAAM,GAAG,IAAI;qBACf,MAAM,GAAG,IAAI;0BACR,sBAAsB,GAAG,IAAI;QA+FzB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;KAAkB,CAAC,KACzC,IAAI;6CAqCE;qBAjIM,MAAM;iBACV,MAAM;kBACL,MAAM;uBACD,QAAQ,GAAG,OAAO;mBAE7B,WAAW,GACX,cAAc,GACd,OAAO,GACP,eAAe,GACf,KAAK,GACL,UAAU;iBACL,MAAM,GAAG,IAAI;iBACb,MAAM,GAAG,IAAI;uBACP,MAAM,GAAG,IAAI;oBAChB,MAAM,GAAG,IAAI;qBACZ,MAAM,GAAG,IAAI;uBACX,MAAM,GAAG,IAAI;2BACT,MAAM,GAAG,IAAI;QAgHF,CAAC;;;;;;;;;;;;;KAA0B,CAAC,KACzD,IAAI;sCAkBkC;QACvC,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,YAAY,CAAC;QAC3B,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,QAAQ,GAAG,OAAO,CAAC;QAClC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;QACpC,UAAU,EAAE,MAAM,CAAC;QACnB,OAAO,EAAE,UAAU,GAAG,OAAO,CAAC;QAC9B,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;QACrB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAClC,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC;QACzD,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QACjD,eAAe,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;KACjD,KAAG,IAAI;uCA8CH,OAAO;oBAndE,MAAM;mBACP,MAAM;sBACH,MAAM;UAmdnB,OAAO,CAAC,IAAI,CAAC;;cA4BR,IAAI;kBACA,MAAM;qBACH,MAAM;mBACR,MAAM;sBACH,YAAY;uBACX,QAAQ,GAAG,OAAO;kBACvB,eAAe,GAAG,SAAS;sBAiBtB,6CAAoB,KAClC,OAAO,CAAC,IAAI,CAAC;8CAgGiC;QAC/C,WAAW,EAAE,MAAM,CAAC;QACpB,oBAAoB,EAAE,KAAK,CAAC;YAC1B,EAAE,EAAE,MAAM,CAAC;YACX,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;YAC1C,MAAM,EAAE,MAAM,CAAC;YACf,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB,CAAC,CAAC;QACH,qBAAqB,EAAE,4BAA4B,EAAE,CAAC;KACvD,KAAG,6BAA6B,EAAE;oDAiClB,SAAS,6BAA6B,EAAE,KACtD,OAAO,EAAE;;cApKJ,IAAI;kBACA,MAAM;qBACH,MAAM;mBACR,MAAM;sBACH,YAAY;uBACX,QAAQ,GAAG,OAAO;kBACvB,eAAe,GAAG,SAAS;;oBAMzB,MAAM;iBACT,MAAM;mBACJ,MAAM,GAAG,IAAI;wBACR,MAAM;gBACd,MAAM,EAAE;iBACP,gBAAgB,CAAC,SAAS,CAAC;yBACnB,sBAAsB,GAAG,IAAI;UA+J7C,IAAI;;cAjLC,IAAI;kBACA,MAAM;qBACH,MAAM;mBACR,MAAM;sBACH,YAAY;uBACX,QAAQ,GAAG,OAAO;kBACvB,eAAe,GAAG,SAAS;gBAqN5B,gBAAgB,CAAC,SAAS,CAAC,YAC1B,OAAO,KAChB,IAAI;;cA7NC,IAAI;kBACA,MAAM;qBACH,MAAM;mBACR,MAAM;sBACH,YAAY;uBACX,QAAQ,GAAG,OAAO;kBACvB,eAAe,GAAG,SAAS;sBA8OtB,6CAAoB,KAClC,IAAI;;cArPC,IAAI;kBACA,MAAM;qBACH,MAAM;mBACR,MAAM;sBACH,YAAY;uBACX,QAAQ,GAAG,OAAO;kBACvB,eAAe,GAAG,SAAS;mBAqQzB;;;;;;;;;;;;;;;;;eAAiB,gBAChB;QACX,oBAAoB,CAAC,EAAE,OAAO,CAAC;KAChC,KACA,OAAO,CAAC,6CAAoB,CAAC;;cA/QxB,IAAI;kBACA,MAAM;qBACH,MAAM;mBACR,MAAM;sBACH,YAAY;uBACX,QAAQ,GAAG,OAAO;kBACvB,eAAe,GAAG,SAAS;;;;;;;;;;;;;;;;;;6BAiXxB;QACX,oBAAoB,CAAC,EAAE,OAAO,CAAC;QAC/B,0BAA0B,CAAC,EAAE,OAAO,CAAC;KACtC,KACA,OAAO,6CAAoB;EAsM/B;AAED,MAAM,MAAM,iBAAiB,CAC3B,EAAE,SAAS,UAAU,GAAG,UAAU,EAClC,IAAI,SAAS,cAAc,GAAG,cAAc,EAC5C,CAAC,SAAS,SAAS,GAAG,SAAS,IAC7B,UAAU,CAAC,OAAO,uBAAuB,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC"}