@fatagnus/dink-convex 1.0.0

package/dist/factories.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Factory functions for simplified @fatagnus/dink-convex setup.
+ *
+ * These factories reduce boilerplate by providing pre-configured
+ * implementations that users can use with minimal code.
+ *
+ * @module factories
+ */
+import { customMutation } from "convex-helpers/server/customFunctions";
+/**
+ * Create a sync-enabled mutation wrapper.
+ *
+ * This factory creates a custom mutation that automatically:
+ * - Generates CRDT deltas on insert/update/delete
+ * - Stores deltas in sync_deltas and sync_outbox tables
+ * - Schedules immediate outbox processing for real-time sync
+ *
+ * @param mutation - The mutation function from _generated/server
+ * @param syncedTables - Array of table names that should be synced
+ * @param options - Optional configuration
+ * @returns A custom mutation wrapper with sync triggers
+ *
+ * @example
+ * ```typescript
+ * // convex/syncSetup.ts
+ * import { createSyncMutation } from "@fatagnus/dink-convex";
+ * import { mutation } from "./_generated/server";
+ * import { internal } from "./_generated/api";
+ *
+ * export const syncMutation = createSyncMutation(mutation, ["tasks"], {
+ *   getInternal: () => internal,
+ * });
+ * ```
+ */
+export declare function createSyncMutation<MutationType extends (...args: any[]) => any>(mutation: MutationType, syncedTables: string[], options: {
+    /** Function that returns the internal API for scheduling */
+    getInternal: () => {
+        outboxProcessor: {
+            processOutboxBatch: unknown;
+        };
+    };
+}): ReturnType<typeof customMutation>;
+/**
+ * Configuration for createSyncCrons.
+ */
+export interface SyncCronsConfig {
+    /** Cron interval in minutes (default: 1) */
+    intervalMinutes?: number;
+}
+/**
+ * Create sync cron jobs.
+ *
+ * This factory creates the cron job definition for outbox processing.
+ * Returns the crons object that should be exported as default.
+ *
+ * @param cronJobs - The cronJobs function from convex/server
+ * @param internal - The internal API from _generated/api
+ * @param config - Optional configuration
+ * @returns Cron jobs definition to export as default
+ *
+ * @example
+ * ```typescript
+ * // convex/crons.ts
+ * import { createSyncCrons } from "@fatagnus/dink-convex";
+ * import { cronJobs } from "convex/server";
+ * import { internal } from "./_generated/api";
+ *
+ * export default createSyncCrons(cronJobs, internal);
+ * ```
+ */
+export declare function createSyncCrons(cronJobs: () => {
+    interval: (name: string, interval: {
+        minutes: number;
+    }, fn: unknown) => void;
+}, internal: {
+    outboxProcessor: {
+        processOutboxBatch: unknown;
+    };
+}, config?: SyncCronsConfig): ReturnType<typeof cronJobs>;
+//# sourceMappingURL=factories.d.ts.map

package/dist/factories.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factories.d.ts","sourceRoot":"","sources":["../src/factories.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,EAAE,cAAc,EAAa,MAAM,uCAAuC,CAAC;AAiBlF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,kBAAkB,CAEhC,YAAY,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAE5C,QAAQ,EAAE,YAAY,EACtB,YAAY,EAAE,MAAM,EAAE,EACtB,OAAO,EAAE;IACP,4DAA4D;IAC5D,WAAW,EAAE,MAAM;QAAE,eAAe,EAAE;YAAE,kBAAkB,EAAE,OAAO,CAAA;SAAE,CAAA;KAAE,CAAC;CACzE,GACA,UAAU,CAAC,OAAO,cAAc,CAAC,CA4InC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,4CAA4C;IAC5C,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,MAAM;IACd,QAAQ,EAAE,CACR,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,EAC7B,EAAE,EAAE,OAAO,KACR,IAAI,CAAC;CACX,EACD,QAAQ,EAAE;IAAE,eAAe,EAAE;QAAE,kBAAkB,EAAE,OAAO,CAAA;KAAE,CAAA;CAAE,EAC9D,MAAM,CAAC,EAAE,eAAe,GACvB,UAAU,CAAC,OAAO,QAAQ,CAAC,CAW7B"}

package/dist/factories.js

@@ -0,0 +1,159 @@
+/**
+ * Factory functions for simplified @fatagnus/dink-convex setup.
+ *
+ * These factories reduce boilerplate by providing pre-configured
+ * implementations that users can use with minimal code.
+ *
+ * @module factories
+ */
+import { Triggers } from "convex-helpers/server/triggers";
+import { customMutation, customCtx } from "convex-helpers/server/customFunctions";
+import { generateInsertDelta, generateUpdateDelta, generateDeleteDelta, } from "./crdt.js";
+/**
+ * Create a sync-enabled mutation wrapper.
+ *
+ * This factory creates a custom mutation that automatically:
+ * - Generates CRDT deltas on insert/update/delete
+ * - Stores deltas in sync_deltas and sync_outbox tables
+ * - Schedules immediate outbox processing for real-time sync
+ *
+ * @param mutation - The mutation function from _generated/server
+ * @param syncedTables - Array of table names that should be synced
+ * @param options - Optional configuration
+ * @returns A custom mutation wrapper with sync triggers
+ *
+ * @example
+ * ```typescript
+ * // convex/syncSetup.ts
+ * import { createSyncMutation } from "@fatagnus/dink-convex";
+ * import { mutation } from "./_generated/server";
+ * import { internal } from "./_generated/api";
+ *
+ * export const syncMutation = createSyncMutation(mutation, ["tasks"], {
+ *   getInternal: () => internal,
+ * });
+ * ```
+ */
+export function createSyncMutation(mutation, syncedTables, options) {
+    const triggers = new Triggers();
+    const syncedTableSet = new Set(syncedTables);
+    /**
+     * Get the next sequence number using innerDb (bypasses triggers).
+     */
+    async function getNextSeqFromInnerDb(innerDb) {
+        const latest = await innerDb.query("sync_deltas").order("desc").first();
+        return (latest?.seq ?? 0) + 1;
+    }
+    // Create sync trigger handler that uses innerDb for writes
+    const syncTriggerHandler = async (ctx, change, tableName) => {
+        if (!syncedTableSet.has(tableName))
+            return;
+        // Use innerDb to get seq and write to sync tables (bypasses triggers to avoid recursion)
+        const seq = await getNextSeqFromInnerDb(ctx.innerDb);
+        let delta;
+        let docId;
+        switch (change.operation) {
+            case "insert":
+                if (!change.newDoc || !change.newDoc.syncId) {
+                    console.log(`[createSyncMutation] Skipping insert - no newDoc or syncId for ${tableName}`);
+                    return;
+                }
+                delta = generateInsertDelta(tableName, change.newDoc.syncId, change.newDoc);
+                docId = change.newDoc.syncId;
+                console.log(`[createSyncMutation] Generated insert delta for ${tableName}/${docId}, seq=${seq}`);
+                break;
+            case "update":
+                if (!change.oldDoc || !change.newDoc || !change.newDoc.syncId) {
+                    console.log(`[createSyncMutation] Skipping update - missing docs or syncId for ${tableName}`);
+                    return;
+                }
+                delta = generateUpdateDelta(tableName, change.newDoc.syncId, change.oldDoc, change.newDoc);
+                docId = change.newDoc.syncId;
+                console.log(`[createSyncMutation] Generated update delta for ${tableName}/${docId}, seq=${seq}`);
+                break;
+            case "delete":
+                if (!change.oldDoc || !change.oldDoc.syncId) {
+                    console.log(`[createSyncMutation] Skipping delete - no oldDoc or syncId for ${tableName}`);
+                    return;
+                }
+                delta = generateDeleteDelta(tableName, change.oldDoc.syncId);
+                docId = change.oldDoc.syncId;
+                console.log(`[createSyncMutation] Generated delete delta for ${tableName}/${docId}, seq=${seq}`);
+                break;
+            default:
+                return;
+        }
+        // Convert Uint8Array to ArrayBuffer for Convex storage
+        const deltaArrayBuffer = delta.buffer.slice(delta.byteOffset, delta.byteOffset + delta.byteLength);
+        // Store in sync_deltas and sync_outbox using innerDb (bypasses triggers)
+        await ctx.innerDb.insert("sync_deltas", {
+            collection: tableName,
+            docId,
+            bytes: deltaArrayBuffer,
+            seq,
+            timestamp: Date.now(),
+        });
+        await ctx.innerDb.insert("sync_outbox", {
+            collection: tableName,
+            docId,
+            delta: deltaArrayBuffer,
+            seq,
+            status: "pending",
+            retries: 0,
+            createdAt: Date.now(),
+        });
+        console.log(`[createSyncMutation] Stored delta and outbox entry for ${tableName}/${docId}`);
+        // Schedule immediate outbox processing if scheduler is available
+        if (ctx.scheduler) {
+            try {
+                const internal = options.getInternal();
+                await ctx.scheduler.runAfter(0, internal.outboxProcessor.processOutboxBatch, {});
+                console.log(`[createSyncMutation] Scheduled immediate outbox processing`);
+            }
+            catch (err) {
+                console.log(`[createSyncMutation] Could not schedule outbox processing: ${err}`);
+            }
+        }
+    };
+    // Register trigger for each synced table
+    for (const tableName of syncedTables) {
+        triggers.register(tableName, ((ctx, change) => syncTriggerHandler(ctx, change, tableName)));
+    }
+    // Return the custom mutation wrapper
+    return customMutation(mutation, customCtx((ctx) => {
+        // wrapDB wraps ctx.db with trigger-enabled version and adds innerDb to ctx
+        const wrappedCtx = triggers.wrapDB(ctx);
+        return {
+            ...ctx,
+            db: wrappedCtx.db,
+        };
+    }));
+}
+/**
+ * Create sync cron jobs.
+ *
+ * This factory creates the cron job definition for outbox processing.
+ * Returns the crons object that should be exported as default.
+ *
+ * @param cronJobs - The cronJobs function from convex/server
+ * @param internal - The internal API from _generated/api
+ * @param config - Optional configuration
+ * @returns Cron jobs definition to export as default
+ *
+ * @example
+ * ```typescript
+ * // convex/crons.ts
+ * import { createSyncCrons } from "@fatagnus/dink-convex";
+ * import { cronJobs } from "convex/server";
+ * import { internal } from "./_generated/api";
+ *
+ * export default createSyncCrons(cronJobs, internal);
+ * ```
+ */
+export function createSyncCrons(cronJobs, internal, config) {
+    const crons = cronJobs();
+    const intervalMinutes = config?.intervalMinutes ?? 1;
+    crons.interval("processOutbox", { minutes: intervalMinutes }, internal.outboxProcessor.processOutboxBatch);
+    return crons;
+}
+//# sourceMappingURL=factories.js.map

package/dist/factories.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factories.js","sourceRoot":"","sources":["../src/factories.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AAElF,OAAO,EACL,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,GACpB,MAAM,WAAW,CAAC;AAWnB;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,kBAAkB,CAIhC,QAAsB,EACtB,YAAsB,EACtB,OAGC;IAED,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAoB,CAAC;IAClD,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;IAc7C;;OAEG;IACH,KAAK,UAAU,qBAAqB,CAAC,OAA8B;QACjE,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC;QACxE,OAAO,CAAE,MAAM,EAAE,GAAc,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED,2DAA2D;IAC3D,MAAM,kBAAkB,GAAG,KAAK,EAC9B,GAAe,EACf,MAIC,EACD,SAAiB,EACF,EAAE;QACjB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC;YAAE,OAAO;QAE3C,yFAAyF;QACzF,MAAM,GAAG,GAAG,MAAM,qBAAqB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACrD,IAAI,KAAiB,CAAC;QACtB,IAAI,KAAa,CAAC;QAElB,QAAQ,MAAM,CAAC,SAAS,EAAE,CAAC;YACzB,KAAK,QAAQ;gBACX,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;oBAC5C,OAAO,CAAC,GAAG,CAAC,kEAAkE,SAAS,EAAE,CAAC,CAAC;oBAC3F,OAAO;gBACT,CAAC;gBACD,KAAK,GAAG,mBAAmB,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC5E,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;gBAC7B,OAAO,CAAC,GAAG,CAAC,mDAAmD,SAAS,IAAI,KAAK,SAAS,GAAG,EAAE,CAAC,CAAC;gBACjG,MAAM;YAER,KAAK,QAAQ;gBACX,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;oBAC9D,OAAO,CAAC,GAAG,CAAC,qEAAqE,SAAS,EAAE,CAAC,CAAC;oBAC9F,OAAO;gBACT,CAAC;gBACD,KAAK,GAAG,mBAAmB,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC3F,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;gBAC7B,OAAO,CAAC,GAAG,CAAC,mDAAmD,SAAS,IAAI,KAAK,SAAS,GAAG,EAAE,CAAC,CAAC;gBACjG,MAAM;YAER,KAAK,QAAQ;gBACX,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;oBAC5C,OAAO,CAAC,GAAG,CAAC,kEAAkE,SAAS,EAAE,CAAC,CAAC;oBAC3F,OAAO;gBACT,CAAC;gBACD,KAAK,GAAG,mBAAmB,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC7D,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;gBAC7B,OAAO,CAAC,GAAG,CAAC,mDAAmD,SAAS,IAAI,KAAK,SAAS,GAAG,EAAE,CAAC,CAAC;gBACjG,MAAM;YAER;gBACE,OAAO;QACX,CAAC;QAED,uDAAuD;QACvD,MAAM,gBAAgB,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CACzC,KAAK,CAAC,UAAU,EAChB,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,UAAU,CACpC,CAAC;QAEF,yEAAyE;QACzE,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE;YACtC,UAAU,EAAE,SAAS;YACrB,KAAK;YACL,KAAK,EAAE,gBAAgB;YACvB,GAAG;YACH,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACtB,CAAC,CAAC;QAEH,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE;YACtC,UAAU,EAAE,SAAS;YACrB,KAAK;YACL,KAAK,EAAE,gBAAgB;YACvB,GAAG;YACH,MAAM,EAAE,SAAS;YACjB,OAAO,EAAE,CAAC;YACV,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACtB,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,CAAC,0DAA0D,SAAS,IAAI,KAAK,EAAE,CAAC,CAAC;QAE5F,iEAAiE;QACjE,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;YAClB,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;gBACvC,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,eAAe,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;gBACjF,OAAO,CAAC,GAAG,CAAC,4DAA4D,CAAC,CAAC;YAC5E,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,OAAO,CAAC,GAAG,CAAC,8DAA8D,GAAG,EAAE,CAAC,CAAC;YACnF,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEF,yCAAyC;IACzC,KAAK,MAAM,SAAS,IAAI,YAAY,EAAE,CAAC;QACrC,QAAQ,CAAC,QAAQ,CACf,SAAkB,EAClB,CAAC,CAAC,GAAY,EAAE,MAAe,EAAE,EAAE,CACjC,kBAAkB,CAChB,GAAiB,EACjB,MAAkD,EAClD,SAAS,CACV,CAAU,CACd,CAAC;IACJ,CAAC;IAED,qCAAqC;IACrC,OAAO,cAAc,CACnB,QAAQ,EACR,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;QAChB,2EAA2E;QAC3E,MAAM,UAAU,GAAG,QAAQ,CAAC,MAAM,CAAC,GAA4C,CAAC,CAAC;QACjF,OAAO;YACL,GAAG,GAAG;YACN,EAAE,EAAG,UAA8B,CAAC,EAAE;SACvC,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAUD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,eAAe,CAC7B,QAMC,EACD,QAA8D,EAC9D,MAAwB;IAExB,MAAM,KAAK,GAAG,QAAQ,EAAE,CAAC;IACzB,MAAM,eAAe,GAAG,MAAM,EAAE,eAAe,IAAI,CAAC,CAAC;IAErD,KAAK,CAAC,QAAQ,CACZ,eAAe,EACf,EAAE,OAAO,EAAE,eAAe,EAAE,EAC5B,QAAQ,CAAC,eAAe,CAAC,kBAAkB,CAC5C,CAAC;IAEF,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/http.d.ts

@@ -0,0 +1,238 @@
+/**
+ * HTTP endpoint utilities for dinkd communication.
+ *
+ * Provides helpers for the /api/dink/applyDelta HTTP endpoint
+ * that receives CRDT deltas from edge devices.
+ *
+ * @module http
+ */
+/**
+ * Payload for applying a delta from edge.
+ */
+export interface ApplyDeltaPayload {
+    /** Collection/table name */
+    collection: string;
+    /** Document sync ID */
+    docId: string;
+    /** CRDT delta bytes as number array (JSON-serializable) */
+    bytes: number[];
+    /** Optional edge ID that originated this delta */
+    edgeId?: string;
+}
+/**
+ * Parsed delta payload with Uint8Array bytes.
+ */
+export interface ParsedDeltaPayload {
+    collection: string;
+    docId: string;
+    bytes: Uint8Array;
+    /** Optional edge ID that originated this delta */
+    edgeId?: string;
+}
+/**
+ * Response from applyDelta endpoint.
+ */
+export type ApplyDeltaResponse = {
+    success: true;
+    seq: number;
+} | {
+    success: false;
+    error: string;
+};
+/**
+ * Parameters for getSnapshot endpoint.
+ */
+export interface GetSnapshotParams {
+    /** Collection/table name */
+    collection: string;
+    /** Document sync ID */
+    docId: string;
+}
+/**
+ * Parsed getSnapshot parameters.
+ */
+export interface ParsedGetSnapshotParams {
+    collection: string;
+    docId: string;
+}
+/**
+ * Response from getSnapshot endpoint.
+ */
+export type GetSnapshotResponse = {
+    success: true;
+    bytes: number[];
+    seq: number;
+} | {
+    success: false;
+    error: string;
+    status?: number;
+};
+/**
+ * Parameters for listDocuments endpoint.
+ */
+export interface ListDocumentsParams {
+    /** Collection/table name */
+    collection: string;
+    /** Optional pagination cursor */
+    cursor?: string;
+    /** Optional limit for number of results (default: 100) */
+    limit?: number;
+}
+/**
+ * Parsed listDocuments parameters.
+ */
+export interface ParsedListDocumentsParams {
+    collection: string;
+    cursor?: string;
+    limit?: number;
+}
+/**
+ * Response from listDocuments endpoint.
+ */
+export type ListDocumentsResponse = {
+    success: true;
+    docIds: string[];
+    nextCursor?: string;
+} | {
+    success: false;
+    error: string;
+};
+/**
+ * Result of parsing the delta payload.
+ */
+export type ParsePayloadResult = {
+    success: true;
+    data: ParsedDeltaPayload;
+} | {
+    success: false;
+    error: string;
+};
+/**
+ * Result of parsing the getSnapshot parameters.
+ */
+export type ParseGetSnapshotResult = {
+    success: true;
+    data: ParsedGetSnapshotParams;
+} | {
+    success: false;
+    error: string;
+};
+/**
+ * Result of parsing the listDocuments parameters.
+ */
+export type ParseListDocumentsResult = {
+    success: true;
+    data: ParsedListDocumentsParams;
+} | {
+    success: false;
+    error: string;
+};
+/**
+ * Result of encoding document as snapshot.
+ */
+export type EncodeSnapshotResult = {
+    success: true;
+    bytes: Uint8Array;
+} | {
+    success: false;
+    error: string;
+};
+/**
+ * Result of validating the auth header.
+ */
+export type AuthValidationResult = {
+    valid: true;
+} | {
+    valid: false;
+    error: string;
+};
+/**
+ * Result of applying delta to document.
+ */
+export type ApplyDeltaResult = {
+    success: true;
+    mergedState: Uint8Array;
+    fromEdge: true;
+} | {
+    success: false;
+    error: string;
+};
+/**
+ * Validate the Authorization header for applyDelta endpoint.
+ *
+ * Expects: Authorization: Bearer <appSyncKey>
+ *
+ * @param header - The Authorization header value
+ * @param expectedKey - The expected app sync key
+ * @returns Validation result
+ */
+export declare function validateAuthHeader(header: string | null, expectedKey: string): AuthValidationResult;
+/**
+ * Parse and validate the getSnapshot query parameters.
+ *
+ * @param params - The query parameters
+ * @returns Parsed parameters result
+ */
+export declare function parseGetSnapshotParams(params: GetSnapshotParams): ParseGetSnapshotResult;
+/**
+ * Parse and validate the listDocuments query parameters.
+ *
+ * @param params - The query parameters
+ * @returns Parsed parameters result
+ */
+export declare function parseListDocumentsParams(params: ListDocumentsParams): ParseListDocumentsResult;
+/**
+ * Parse and validate the applyDelta request payload.
+ *
+ * @param payload - The raw request payload
+ * @returns Parsed payload result
+ */
+export declare function parseApplyDeltaPayload(payload: ApplyDeltaPayload): ParsePayloadResult;
+/**
+ * Apply a CRDT delta to an existing document state.
+ *
+ * Merges the incoming delta with the existing state using Yjs CRDT semantics.
+ * This is the core merge function used by the HTTP endpoint.
+ *
+ * @param delta - The incoming CRDT delta (Yjs update)
+ * @param existingState - The existing document state, or null for new document
+ * @returns Merged state result with fromEdge flag for skipping outbox
+ */
+export declare function applyDeltaToDocument(delta: Uint8Array, existingState: Uint8Array | null): ApplyDeltaResult;
+/**
+ * Create a JSON response with proper headers.
+ *
+ * @param data - Response data to serialize
+ * @param status - HTTP status code
+ * @returns Response object
+ */
+export declare function createJsonResponse(data: unknown, status: number): Response;
+/**
+ * Create an error response with proper headers.
+ *
+ * @param error - Error message
+ * @param status - HTTP status code
+ * @returns Response object
+ */
+export declare function createErrorResponse(error: string, status: number): Response;
+/**
+ * Encode a document's data as a Yjs snapshot.
+ *
+ * Creates a Yjs document with all fields from the document data,
+ * compatible with the edge SDK's YjsDocument format.
+ *
+ * @param documentData - The document data to encode
+ * @returns Encoded snapshot result with Uint8Array bytes
+ *
+ * @example
+ * ```typescript
+ * const result = encodeDocumentAsSnapshot({
+ *   _collection: "tasks",
+ *   syncId: "sync-123",
+ *   title: "My Task",
+ *   completed: false,
+ * });
+ * ```
+ */
+export declare function encodeDocumentAsSnapshot(documentData: Record<string, unknown>): EncodeSnapshotResult;
+//# sourceMappingURL=http.d.ts.map

package/dist/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,2DAA2D;IAC3D,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,kDAAkD;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,UAAU,CAAC;IAClB,kDAAkD;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAC/C;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,iCAAiC;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0DAA0D;IAC1D,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,GACxD;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,kBAAkB,CAAA;CAAE,GAC3C;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,uBAAuB,CAAA;CAAE,GAChD;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAChC;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,IAAI,EAAE,yBAAyB,CAAA;CAAE,GAClD;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC5B;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,UAAU,CAAA;CAAE,GACpC;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC5B;IAAE,KAAK,EAAE,IAAI,CAAA;CAAE,GACf;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB;IAAE,OAAO,EAAE,IAAI,CAAC;IAAC,WAAW,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,GAC1D;IAAE,OAAO,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,MAAM,GAAG,IAAI,EACrB,WAAW,EAAE,MAAM,GAClB,oBAAoB,CAetB;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,iBAAiB,GACxB,sBAAsB,CAoBxB;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,mBAAmB,GAC1B,wBAAwB,CAyB1B;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,iBAAiB,GACzB,kBAAkB,CAgCpB;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAClC,KAAK,EAAE,UAAU,EACjB,aAAa,EAAE,UAAU,GAAG,IAAI,GAC/B,gBAAgB,CA2BlB;AAED;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,QAAQ,CAO1E;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,QAAQ,CAE3E;AAKD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACpC,oBAAoB,CA0BtB"}