@syncular/server-hono 0.0.6-96 → 0.2.1

package/dist/routes.d.ts

@@ -1,161 +0,0 @@
-/**
- * @syncular/server-hono - Sync routes for Hono
- *
- * Provides:
- * - POST /      (combined push + pull in one round-trip)
- * - GET  /snapshot-chunks/:chunkId (download encoded snapshot chunks)
- * - GET  /realtime (optional WebSocket "wake up" notifications)
- */
-import type { ScopeCacheBackend, ServerSyncDialect, ServerTableHandler, SnapshotChunkStorage, SqlFamily, SyncCoreDb, SyncRealtimeBroadcaster, SyncServerAuth } from '@syncular/server';
-import { type CompactOptions, type PruneOptions } from '@syncular/server';
-import type { Context } from 'hono';
-import { Hono } from 'hono';
-import type { UpgradeWebSocket } from 'hono/ws';
-import { type Kysely } from 'kysely';
-import { type SyncRateLimitConfig } from './rate-limit';
-import { WebSocketConnectionManager } from './ws';
-export interface SyncAuthResult extends SyncServerAuth {
-}
-/**
- * WebSocket configuration for realtime sync.
- *
- * Note: this endpoint is only a "wake up" mechanism; clients must still pull.
- */
-export interface SyncWebSocketConfig {
-    enabled?: boolean;
-    /**
-     * Runtime-provided WebSocket upgrader (e.g. from `hono/bun`'s `createBunWebSocket()`).
-     */
-    upgradeWebSocket?: UpgradeWebSocket;
-    heartbeatIntervalMs?: number;
-    /**
-     * Maximum number of concurrent WebSocket connections across the entire process.
-     * Default: 5000
-     */
-    maxConnectionsTotal?: number;
-    /**
-     * Maximum number of concurrent WebSocket connections per clientId.
-     * Default: 3
-     */
-    maxConnectionsPerClient?: number;
-}
-export interface SyncRoutesConfigWithRateLimit {
-    /**
-     * Max commits per pull request.
-     * Default: 100
-     */
-    maxPullLimitCommits?: number;
-    /**
-     * Max subscriptions per pull request.
-     * Default: 200
-     */
-    maxSubscriptionsPerPull?: number;
-    /**
-     * Max snapshot rows per snapshot page.
-     * Default: 5000
-     */
-    maxPullLimitSnapshotRows?: number;
-    /**
-     * Max snapshot pages per subscription per pull response.
-     * Default: 10
-     */
-    maxPullMaxSnapshotPages?: number;
-    /**
-     * Max operations per pushed commit.
-     * Default: 200
-     */
-    maxOperationsPerPush?: number;
-    /**
-     * Request/response payload snapshots recorded for console inspection.
-     */
-    requestPayloadSnapshots?: {
-        /**
-         * Enable payload snapshot storage in `sync_request_payloads`.
-         * Default: true when console event recording is enabled.
-         */
-        enabled?: boolean;
-        /**
-         * Max serialized payload size in bytes per request/response snapshot.
-         * Larger payloads are truncated with metadata.
-         * Default: 128 KiB.
-         */
-        maxBytes?: number;
-    };
-    /**
-     * Rate limiting configuration.
-     * Set to false to disable all rate limiting.
-     */
-    rateLimit?: SyncRateLimitConfig | false;
-    /**
-     * WebSocket realtime configuration.
-     */
-    websocket?: SyncWebSocketConfig;
-    /**
-     * Optional pruning configuration. When enabled, the server periodically prunes
-     * old commit history based on active client cursors.
-     */
-    prune?: {
-        /** Minimum time between prune runs. Default: 5 minutes. */
-        minIntervalMs?: number;
-        /** Pruning watermark options. */
-        options?: PruneOptions;
-    };
-    /**
-     * Optional compaction configuration. When enabled, the server periodically
-     * compacts older change history to reduce storage.
-     */
-    compact?: {
-        /** Minimum time between compaction runs. Default: 30 minutes. */
-        minIntervalMs?: number;
-        /** Compaction options. */
-        options?: CompactOptions;
-    };
-    /**
-     * Optional multi-instance realtime broadcaster.
-     * When provided, instances publish/subscribe commit wakeups via the broadcaster.
-     */
-    realtime?: {
-        broadcaster: SyncRealtimeBroadcaster;
-        /** Optional stable instance id (useful in tests). */
-        instanceId?: string;
-    };
-}
-export interface CreateSyncRoutesOptions<DB extends SyncCoreDb = SyncCoreDb, Auth extends SyncAuthResult = SyncAuthResult, F extends SqlFamily = SqlFamily> {
-    db: Kysely<DB>;
-    dialect: ServerSyncDialect<F>;
-    handlers: ServerTableHandler<DB, Auth>[];
-    authenticate: (c: Context) => Promise<Auth | null>;
-    sync?: SyncRoutesConfigWithRateLimit;
-    wsConnectionManager?: WebSocketConnectionManager;
-    /**
-     * Optional snapshot chunk storage adapter.
-     * When provided, stores snapshot chunk bodies in external storage
-     * (S3, R2, etc.) instead of inline in the database.
-     */
-    chunkStorage?: SnapshotChunkStorage;
-    /**
-     * Optional scope cache backend for resolveScopes() results.
-     * Request-local memoization is always applied for every pull.
-     */
-    scopeCache?: ScopeCacheBackend;
-    /**
-     * Optional live emitter for console websocket activity feed.
-     * When provided, sync lifecycle events are published to `/console/events/live`.
-     */
-    consoleLiveEmitter?: {
-        emit(event: {
-            type: 'push' | 'pull' | 'commit' | 'client_update';
-            timestamp: string;
-            data: Record<string, unknown>;
-        }): void;
-    };
-    /**
-     * Optional console schema readiness promise.
-     * When provided, request-event recording waits for this promise before writing.
-     */
-    consoleSchemaReady?: Promise<void>;
-}
-export declare function createSyncRoutes<DB extends SyncCoreDb = SyncCoreDb, Auth extends SyncAuthResult = SyncAuthResult, F extends SqlFamily = SqlFamily>(options: CreateSyncRoutesOptions<DB, Auth, F>): Hono;
-export declare function getSyncWebSocketConnectionManager(routes: Hono): WebSocketConnectionManager | undefined;
-export declare function getSyncRealtimeUnsubscribe(routes: Hono): (() => void) | undefined;
-//# sourceMappingURL=routes.d.ts.map

package/dist/routes.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"routes.d.ts","sourceRoot":"","sources":["../src/routes.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAaH,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,SAAS,EACT,UAAU,EACV,uBAAuB,EAEvB,cAAc,EACf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,KAAK,cAAc,EAGnB,KAAK,YAAY,EAMlB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EAAE,OAAO,EAAqB,MAAM,MAAM,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,OAAO,EACL,KAAK,MAAM,EAIZ,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAGL,KAAK,mBAAmB,EACzB,MAAM,cAAc,CAAC;AACtB,OAAO,EAGL,0BAA0B,EAC3B,MAAM,MAAM,CAAC;AAQd,MAAM,WAAW,cAAe,SAAQ,cAAc;CAAG;AAEzD;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,uBAAuB,CAAC,EAAE;QACxB;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB;;;;WAIG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAC;IACF;;;OAGG;IACH,SAAS,CAAC,EAAE,mBAAmB,GAAG,KAAK,CAAC;IACxC;;OAEG;IACH,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAEhC;;;OAGG;IACH,KAAK,CAAC,EAAE;QACN,2DAA2D;QAC3D,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,iCAAiC;QACjC,OAAO,CAAC,EAAE,YAAY,CAAC;KACxB,CAAC;IAEF;;;OAGG;IACH,OAAO,CAAC,EAAE;QACR,iEAAiE;QACjE,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,0BAA0B;QAC1B,OAAO,CAAC,EAAE,cAAc,CAAC;KAC1B,CAAC;IAEF;;;OAGG;IACH,QAAQ,CAAC,EAAE;QACT,WAAW,EAAE,uBAAuB,CAAC;QACrC,qDAAqD;QACrD,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACH;AAED,MAAM,WAAW,uBAAuB,CACtC,EAAE,SAAS,UAAU,GAAG,UAAU,EAClC,IAAI,SAAS,cAAc,GAAG,cAAc,EAC5C,CAAC,SAAS,SAAS,GAAG,SAAS;IAE/B,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IACf,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAC9B,QAAQ,EAAE,kBAAkB,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC;IACzC,YAAY,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IACnD,IAAI,CAAC,EAAE,6BAA6B,CAAC;IACrC,mBAAmB,CAAC,EAAE,0BAA0B,CAAC;IACjD;;;;OAIG;IACH,YAAY,CAAC,EAAE,oBAAoB,CAAC;IACpC;;;OAGG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAC/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE;QACnB,IAAI,CAAC,KAAK,EAAE;YACV,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,eAAe,CAAC;YACnD,SAAS,EAAE,MAAM,CAAC;YAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;SAC/B,GAAG,IAAI,CAAC;KACV,CAAC;IACF;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACpC;AAiQD,wBAAgB,gBAAgB,CAC9B,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,GAAG,IAAI,CA66CrD;AAED,wBAAgB,iCAAiC,CAC/C,MAAM,EAAE,IAAI,GACX,0BAA0B,GAAG,SAAS,CAExC;AAED,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,IAAI,GACX,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAE1B"}