@syncular/core 0.0.1-60

package/dist/schemas/sync.d.ts

@@ -0,0 +1,391 @@
+/**
+ * @syncular/core - Sync protocol Zod schemas
+ *
+ * These schemas define the sync protocol types and can be used for:
+ * - Runtime validation
+ * - OpenAPI spec generation
+ * - Type inference
+ */
+import { z } from 'zod';
+export declare const SyncOpSchema: z.ZodEnum<{
+    delete: "delete";
+    upsert: "upsert";
+}>;
+export type SyncOp = z.infer<typeof SyncOpSchema>;
+/**
+ * Scope values in a subscription request (can be arrays)
+ */
+export declare const ScopeValuesSchema: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+export declare const SyncOperationSchema: z.ZodObject<{
+    table: z.ZodString;
+    row_id: z.ZodString;
+    op: z.ZodEnum<{
+        delete: "delete";
+        upsert: "upsert";
+    }>;
+    payload: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    base_version: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+}, z.core.$strip>;
+export type SyncOperation = z.infer<typeof SyncOperationSchema>;
+export declare const SyncPushRequestSchema: z.ZodObject<{
+    clientId: z.ZodString;
+    clientCommitId: z.ZodString;
+    operations: z.ZodArray<z.ZodObject<{
+        table: z.ZodString;
+        row_id: z.ZodString;
+        op: z.ZodEnum<{
+            delete: "delete";
+            upsert: "upsert";
+        }>;
+        payload: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        base_version: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>;
+    schemaVersion: z.ZodNumber;
+}, z.core.$strip>;
+export type SyncPushRequest = z.infer<typeof SyncPushRequestSchema>;
+export declare const SyncOperationResultSchema: z.ZodUnion<readonly [z.ZodObject<{
+    opIndex: z.ZodNumber;
+    status: z.ZodLiteral<"applied">;
+}, z.core.$strip>, z.ZodObject<{
+    opIndex: z.ZodNumber;
+    status: z.ZodLiteral<"conflict">;
+    message: z.ZodString;
+    server_version: z.ZodNumber;
+    server_row: z.ZodUnknown;
+}, z.core.$strip>, z.ZodObject<{
+    opIndex: z.ZodNumber;
+    status: z.ZodLiteral<"error">;
+    error: z.ZodString;
+    code: z.ZodOptional<z.ZodString>;
+    retriable: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>]>;
+export type SyncOperationResult = z.infer<typeof SyncOperationResultSchema>;
+export declare const SyncPushResponseSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    status: z.ZodEnum<{
+        applied: "applied";
+        cached: "cached";
+        rejected: "rejected";
+    }>;
+    commitSeq: z.ZodOptional<z.ZodNumber>;
+    results: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        opIndex: z.ZodNumber;
+        status: z.ZodLiteral<"applied">;
+    }, z.core.$strip>, z.ZodObject<{
+        opIndex: z.ZodNumber;
+        status: z.ZodLiteral<"conflict">;
+        message: z.ZodString;
+        server_version: z.ZodNumber;
+        server_row: z.ZodUnknown;
+    }, z.core.$strip>, z.ZodObject<{
+        opIndex: z.ZodNumber;
+        status: z.ZodLiteral<"error">;
+        error: z.ZodString;
+        code: z.ZodOptional<z.ZodString>;
+        retriable: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>]>>;
+}, z.core.$strip>;
+export type SyncPushResponse = z.infer<typeof SyncPushResponseSchema>;
+export declare const SyncBootstrapStateSchema: z.ZodObject<{
+    asOfCommitSeq: z.ZodNumber;
+    tables: z.ZodArray<z.ZodString>;
+    tableIndex: z.ZodNumber;
+    rowCursor: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type SyncBootstrapState = z.infer<typeof SyncBootstrapStateSchema>;
+export declare const SyncSubscriptionRequestSchema: z.ZodObject<{
+    id: z.ZodString;
+    shape: z.ZodString;
+    scopes: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+    params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    cursor: z.ZodNumber;
+    bootstrapState: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        asOfCommitSeq: z.ZodNumber;
+        tables: z.ZodArray<z.ZodString>;
+        tableIndex: z.ZodNumber;
+        rowCursor: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type SyncSubscriptionRequest = z.infer<typeof SyncSubscriptionRequestSchema>;
+export declare const SyncPullRequestSchema: z.ZodObject<{
+    clientId: z.ZodString;
+    limitCommits: z.ZodNumber;
+    limitSnapshotRows: z.ZodOptional<z.ZodNumber>;
+    maxSnapshotPages: z.ZodOptional<z.ZodNumber>;
+    dedupeRows: z.ZodOptional<z.ZodBoolean>;
+    subscriptions: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        shape: z.ZodString;
+        scopes: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+        params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        cursor: z.ZodNumber;
+        bootstrapState: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            asOfCommitSeq: z.ZodNumber;
+            tables: z.ZodArray<z.ZodString>;
+            tableIndex: z.ZodNumber;
+            rowCursor: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SyncPullRequest = z.infer<typeof SyncPullRequestSchema>;
+export declare const SyncChangeSchema: z.ZodObject<{
+    table: z.ZodString;
+    row_id: z.ZodString;
+    op: z.ZodEnum<{
+        delete: "delete";
+        upsert: "upsert";
+    }>;
+    row_json: z.ZodNullable<z.ZodUnknown>;
+    row_version: z.ZodNullable<z.ZodNumber>;
+    scopes: z.ZodRecord<z.ZodString, z.ZodString>;
+}, z.core.$strip>;
+export type SyncChange = z.infer<typeof SyncChangeSchema>;
+export declare const SyncCommitSchema: z.ZodObject<{
+    commitSeq: z.ZodNumber;
+    createdAt: z.ZodString;
+    actorId: z.ZodString;
+    changes: z.ZodArray<z.ZodObject<{
+        table: z.ZodString;
+        row_id: z.ZodString;
+        op: z.ZodEnum<{
+            delete: "delete";
+            upsert: "upsert";
+        }>;
+        row_json: z.ZodNullable<z.ZodUnknown>;
+        row_version: z.ZodNullable<z.ZodNumber>;
+        scopes: z.ZodRecord<z.ZodString, z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SyncCommit = z.infer<typeof SyncCommitSchema>;
+export declare const SyncSnapshotChunkRefSchema: z.ZodObject<{
+    id: z.ZodString;
+    byteLength: z.ZodNumber;
+    sha256: z.ZodString;
+    encoding: z.ZodLiteral<"ndjson">;
+    compression: z.ZodLiteral<"gzip">;
+}, z.core.$strip>;
+export type SyncSnapshotChunkRef = z.infer<typeof SyncSnapshotChunkRefSchema>;
+export declare const SyncSnapshotSchema: z.ZodObject<{
+    table: z.ZodString;
+    rows: z.ZodArray<z.ZodUnknown>;
+    chunks: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        byteLength: z.ZodNumber;
+        sha256: z.ZodString;
+        encoding: z.ZodLiteral<"ndjson">;
+        compression: z.ZodLiteral<"gzip">;
+    }, z.core.$strip>>>;
+    isFirstPage: z.ZodBoolean;
+    isLastPage: z.ZodBoolean;
+}, z.core.$strip>;
+export type SyncSnapshot = z.infer<typeof SyncSnapshotSchema>;
+export declare const SyncPullSubscriptionResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    status: z.ZodEnum<{
+        active: "active";
+        revoked: "revoked";
+    }>;
+    scopes: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+    bootstrap: z.ZodBoolean;
+    bootstrapState: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        asOfCommitSeq: z.ZodNumber;
+        tables: z.ZodArray<z.ZodString>;
+        tableIndex: z.ZodNumber;
+        rowCursor: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>>;
+    nextCursor: z.ZodNumber;
+    commits: z.ZodArray<z.ZodObject<{
+        commitSeq: z.ZodNumber;
+        createdAt: z.ZodString;
+        actorId: z.ZodString;
+        changes: z.ZodArray<z.ZodObject<{
+            table: z.ZodString;
+            row_id: z.ZodString;
+            op: z.ZodEnum<{
+                delete: "delete";
+                upsert: "upsert";
+            }>;
+            row_json: z.ZodNullable<z.ZodUnknown>;
+            row_version: z.ZodNullable<z.ZodNumber>;
+            scopes: z.ZodRecord<z.ZodString, z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    snapshots: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        table: z.ZodString;
+        rows: z.ZodArray<z.ZodUnknown>;
+        chunks: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            byteLength: z.ZodNumber;
+            sha256: z.ZodString;
+            encoding: z.ZodLiteral<"ndjson">;
+            compression: z.ZodLiteral<"gzip">;
+        }, z.core.$strip>>>;
+        isFirstPage: z.ZodBoolean;
+        isLastPage: z.ZodBoolean;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type SyncPullSubscriptionResponse = z.infer<typeof SyncPullSubscriptionResponseSchema>;
+export declare const SyncPullResponseSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    subscriptions: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        status: z.ZodEnum<{
+            active: "active";
+            revoked: "revoked";
+        }>;
+        scopes: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+        bootstrap: z.ZodBoolean;
+        bootstrapState: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            asOfCommitSeq: z.ZodNumber;
+            tables: z.ZodArray<z.ZodString>;
+            tableIndex: z.ZodNumber;
+            rowCursor: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>>>;
+        nextCursor: z.ZodNumber;
+        commits: z.ZodArray<z.ZodObject<{
+            commitSeq: z.ZodNumber;
+            createdAt: z.ZodString;
+            actorId: z.ZodString;
+            changes: z.ZodArray<z.ZodObject<{
+                table: z.ZodString;
+                row_id: z.ZodString;
+                op: z.ZodEnum<{
+                    delete: "delete";
+                    upsert: "upsert";
+                }>;
+                row_json: z.ZodNullable<z.ZodUnknown>;
+                row_version: z.ZodNullable<z.ZodNumber>;
+                scopes: z.ZodRecord<z.ZodString, z.ZodString>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        snapshots: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            table: z.ZodString;
+            rows: z.ZodArray<z.ZodUnknown>;
+            chunks: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                byteLength: z.ZodNumber;
+                sha256: z.ZodString;
+                encoding: z.ZodLiteral<"ndjson">;
+                compression: z.ZodLiteral<"gzip">;
+            }, z.core.$strip>>>;
+            isFirstPage: z.ZodBoolean;
+            isLastPage: z.ZodBoolean;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SyncPullResponse = z.infer<typeof SyncPullResponseSchema>;
+export declare const SyncCombinedRequestSchema: z.ZodObject<{
+    clientId: z.ZodString;
+    push: z.ZodOptional<z.ZodObject<{
+        clientCommitId: z.ZodString;
+        operations: z.ZodArray<z.ZodObject<{
+            table: z.ZodString;
+            row_id: z.ZodString;
+            op: z.ZodEnum<{
+                delete: "delete";
+                upsert: "upsert";
+            }>;
+            payload: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            base_version: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        }, z.core.$strip>>;
+        schemaVersion: z.ZodNumber;
+    }, z.core.$strip>>;
+    pull: z.ZodOptional<z.ZodObject<{
+        limitCommits: z.ZodNumber;
+        limitSnapshotRows: z.ZodOptional<z.ZodNumber>;
+        maxSnapshotPages: z.ZodOptional<z.ZodNumber>;
+        dedupeRows: z.ZodOptional<z.ZodBoolean>;
+        subscriptions: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            shape: z.ZodString;
+            scopes: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+            params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            cursor: z.ZodNumber;
+            bootstrapState: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                asOfCommitSeq: z.ZodNumber;
+                tables: z.ZodArray<z.ZodString>;
+                tableIndex: z.ZodNumber;
+                rowCursor: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SyncCombinedRequest = z.infer<typeof SyncCombinedRequestSchema>;
+export declare const SyncCombinedResponseSchema: z.ZodObject<{
+    ok: z.ZodLiteral<true>;
+    push: z.ZodOptional<z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        status: z.ZodEnum<{
+            applied: "applied";
+            cached: "cached";
+            rejected: "rejected";
+        }>;
+        commitSeq: z.ZodOptional<z.ZodNumber>;
+        results: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+            opIndex: z.ZodNumber;
+            status: z.ZodLiteral<"applied">;
+        }, z.core.$strip>, z.ZodObject<{
+            opIndex: z.ZodNumber;
+            status: z.ZodLiteral<"conflict">;
+            message: z.ZodString;
+            server_version: z.ZodNumber;
+            server_row: z.ZodUnknown;
+        }, z.core.$strip>, z.ZodObject<{
+            opIndex: z.ZodNumber;
+            status: z.ZodLiteral<"error">;
+            error: z.ZodString;
+            code: z.ZodOptional<z.ZodString>;
+            retriable: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>]>>;
+    }, z.core.$strip>>;
+    pull: z.ZodOptional<z.ZodObject<{
+        ok: z.ZodLiteral<true>;
+        subscriptions: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            status: z.ZodEnum<{
+                active: "active";
+                revoked: "revoked";
+            }>;
+            scopes: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
+            bootstrap: z.ZodBoolean;
+            bootstrapState: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+                asOfCommitSeq: z.ZodNumber;
+                tables: z.ZodArray<z.ZodString>;
+                tableIndex: z.ZodNumber;
+                rowCursor: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>>>;
+            nextCursor: z.ZodNumber;
+            commits: z.ZodArray<z.ZodObject<{
+                commitSeq: z.ZodNumber;
+                createdAt: z.ZodString;
+                actorId: z.ZodString;
+                changes: z.ZodArray<z.ZodObject<{
+                    table: z.ZodString;
+                    row_id: z.ZodString;
+                    op: z.ZodEnum<{
+                        delete: "delete";
+                        upsert: "upsert";
+                    }>;
+                    row_json: z.ZodNullable<z.ZodUnknown>;
+                    row_version: z.ZodNullable<z.ZodNumber>;
+                    scopes: z.ZodRecord<z.ZodString, z.ZodString>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>>;
+            snapshots: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                table: z.ZodString;
+                rows: z.ZodArray<z.ZodUnknown>;
+                chunks: z.ZodOptional<z.ZodArray<z.ZodObject<{
+                    id: z.ZodString;
+                    byteLength: z.ZodNumber;
+                    sha256: z.ZodString;
+                    encoding: z.ZodLiteral<"ndjson">;
+                    compression: z.ZodLiteral<"gzip">;
+                }, z.core.$strip>>>;
+                isFirstPage: z.ZodBoolean;
+                isLastPage: z.ZodBoolean;
+            }, z.core.$strip>>>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SyncCombinedResponse = z.infer<typeof SyncCombinedResponseSchema>;
+//# sourceMappingURL=sync.d.ts.map

package/dist/schemas/sync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../../src/schemas/sync.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,eAAO,MAAM,YAAY;;;EAA+B,CAAC;AACzD,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAWlD;;GAEG;AACH,eAAO,MAAM,iBAAiB,uFAG7B,CAAC;AAMF,eAAO,MAAM,mBAAmB;;;;;;;;;iBAM9B,CAAC;AAEH,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAMhE,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;iBAKhC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAuBpE,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;mBAIpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;iBAKjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAMtE,eAAO,MAAM,wBAAwB;;;;;iBAKnC,CAAC;AAEH,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAM1E,eAAO,MAAM,6BAA6B;;;;;;;;;;;;iBAOxC,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,6BAA6B,CACrC,CAAC;AAEF,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;iBAOhC,CAAC;AAEH,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAC;AAEpE,eAAO,MAAM,gBAAgB;;;;;;;;;;iBAO3B,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;iBAK3B,CAAC;AAEH,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D,eAAO,MAAM,0BAA0B;;;;;;iBAMrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,eAAO,MAAM,kBAAkB;;;;;;;;;;;;iBAM7B,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D,eAAO,MAAM,kCAAkC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAS7C,CAAC;AAEH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,kCAAkC,CAC1C,CAAC;AAEF,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAGjC,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAMtE,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIpC,CAAC;AAEH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAIrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC"}

package/dist/schemas/sync.js

@@ -0,0 +1,156 @@
+/**
+ * @syncular/core - Sync protocol Zod schemas
+ *
+ * These schemas define the sync protocol types and can be used for:
+ * - Runtime validation
+ * - OpenAPI spec generation
+ * - Type inference
+ */
+import { z } from 'zod';
+// ============================================================================
+// Operation Types
+// ============================================================================
+export const SyncOpSchema = z.enum(['upsert', 'delete']);
+// ============================================================================
+// Scope Schemas
+// ============================================================================
+/**
+ * Stored scopes on a change (single values only)
+ */
+const StoredScopesSchema = z.record(z.string(), z.string());
+/**
+ * Scope values in a subscription request (can be arrays)
+ */
+export const ScopeValuesSchema = z.record(z.string(), z.union([z.string(), z.array(z.string())]));
+// ============================================================================
+// Sync Operation Schema
+// ============================================================================
+export const SyncOperationSchema = z.object({
+    table: z.string(),
+    row_id: z.string(),
+    op: SyncOpSchema,
+    payload: z.record(z.string(), z.unknown()).nullable(),
+    base_version: z.number().int().nullable().optional(),
+});
+// ============================================================================
+// Push Request/Response Schemas
+// ============================================================================
+export const SyncPushRequestSchema = z.object({
+    clientId: z.string().min(1),
+    clientCommitId: z.string().min(1),
+    operations: z.array(SyncOperationSchema).min(1),
+    schemaVersion: z.number().int().min(1),
+});
+const SyncOperationResultAppliedSchema = z.object({
+    opIndex: z.number().int(),
+    status: z.literal('applied'),
+});
+const SyncOperationResultConflictSchema = z.object({
+    opIndex: z.number().int(),
+    status: z.literal('conflict'),
+    message: z.string(),
+    server_version: z.number().int(),
+    server_row: z.unknown(),
+});
+const SyncOperationResultErrorSchema = z.object({
+    opIndex: z.number().int(),
+    status: z.literal('error'),
+    error: z.string(),
+    code: z.string().optional(),
+    retriable: z.boolean().optional(),
+});
+export const SyncOperationResultSchema = z.union([
+    SyncOperationResultAppliedSchema,
+    SyncOperationResultConflictSchema,
+    SyncOperationResultErrorSchema,
+]);
+export const SyncPushResponseSchema = z.object({
+    ok: z.literal(true),
+    status: z.enum(['applied', 'cached', 'rejected']),
+    commitSeq: z.number().int().optional(),
+    results: z.array(SyncOperationResultSchema),
+});
+// ============================================================================
+// Bootstrap State Schema
+// ============================================================================
+export const SyncBootstrapStateSchema = z.object({
+    asOfCommitSeq: z.number().int(),
+    tables: z.array(z.string()),
+    tableIndex: z.number().int(),
+    rowCursor: z.string().nullable(),
+});
+// ============================================================================
+// Pull Request/Response Schemas
+// ============================================================================
+export const SyncSubscriptionRequestSchema = z.object({
+    id: z.string().min(1),
+    shape: z.string().min(1),
+    scopes: ScopeValuesSchema,
+    params: z.record(z.string(), z.unknown()).optional(),
+    cursor: z.number().int(),
+    bootstrapState: SyncBootstrapStateSchema.nullable().optional(),
+});
+export const SyncPullRequestSchema = z.object({
+    clientId: z.string().min(1),
+    limitCommits: z.number().int().min(1),
+    limitSnapshotRows: z.number().int().min(1).optional(),
+    maxSnapshotPages: z.number().int().min(1).optional(),
+    dedupeRows: z.boolean().optional(),
+    subscriptions: z.array(SyncSubscriptionRequestSchema),
+});
+export const SyncChangeSchema = z.object({
+    table: z.string(),
+    row_id: z.string(),
+    op: SyncOpSchema,
+    row_json: z.unknown().nullable(),
+    row_version: z.number().int().nullable(),
+    scopes: StoredScopesSchema,
+});
+export const SyncCommitSchema = z.object({
+    commitSeq: z.number().int(),
+    createdAt: z.string(),
+    actorId: z.string(),
+    changes: z.array(SyncChangeSchema),
+});
+export const SyncSnapshotChunkRefSchema = z.object({
+    id: z.string(),
+    byteLength: z.number().int(),
+    sha256: z.string(),
+    encoding: z.literal('ndjson'),
+    compression: z.literal('gzip'),
+});
+export const SyncSnapshotSchema = z.object({
+    table: z.string(),
+    rows: z.array(z.unknown()),
+    chunks: z.array(SyncSnapshotChunkRefSchema).optional(),
+    isFirstPage: z.boolean(),
+    isLastPage: z.boolean(),
+});
+export const SyncPullSubscriptionResponseSchema = z.object({
+    id: z.string(),
+    status: z.enum(['active', 'revoked']),
+    scopes: ScopeValuesSchema,
+    bootstrap: z.boolean(),
+    bootstrapState: SyncBootstrapStateSchema.nullable().optional(),
+    nextCursor: z.number().int(),
+    commits: z.array(SyncCommitSchema),
+    snapshots: z.array(SyncSnapshotSchema).optional(),
+});
+export const SyncPullResponseSchema = z.object({
+    ok: z.literal(true),
+    subscriptions: z.array(SyncPullSubscriptionResponseSchema),
+});
+// ============================================================================
+// Combined Sync Request/Response Schemas
+// ============================================================================
+export const SyncCombinedRequestSchema = z.object({
+    clientId: z.string().min(1),
+    push: SyncPushRequestSchema.omit({ clientId: true }).optional(),
+    pull: SyncPullRequestSchema.omit({ clientId: true }).optional(),
+});
+export const SyncCombinedResponseSchema = z.object({
+    ok: z.literal(true),
+    push: SyncPushResponseSchema.optional(),
+    pull: SyncPullResponseSchema.optional(),
+});
+//# sourceMappingURL=sync.js.map

package/dist/schemas/sync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync.js","sourceRoot":"","sources":["../../src/schemas/sync.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,+EAA+E;AAC/E,kBAAkB;AAClB,+EAA+E;AAE/E,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;AAGzD,+EAA+E;AAC/E,gBAAgB;AAChB,+EAA+E;AAE/E;;GAEG;AACH,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;AAE5D;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CACvC,CAAC,CAAC,MAAM,EAAE,EACV,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAC3C,CAAC;AAEF,+EAA+E;AAC/E,wBAAwB;AACxB,+EAA+E;AAE/E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,EAAE,EAAE,YAAY;IAChB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IACrD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACrD,CAAC,CAAC;AAIH,+EAA+E;AAC/E,gCAAgC;AAChC,+EAA+E;AAE/E,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACjC,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/C,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CACvC,CAAC,CAAC;AAIH,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACzB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;CAC7B,CAAC,CAAC;AAEH,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACzB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IAC7B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAChC,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;CACxB,CAAC,CAAC;AAEH,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACzB,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;IAC1B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC;IAC/C,gCAAgC;IAChC,iCAAiC;IACjC,8BAA8B;CAC/B,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACnB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IACjD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACtC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC;CAC5C,CAAC,CAAC;AAIH,+EAA+E;AAC/E,yBAAyB;AACzB,+EAA+E;AAE/E,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC/B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC3B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC5B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAC;AAIH,+EAA+E;AAC/E,gCAAgC;AAChC,+EAA+E;AAE/E,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxB,MAAM,EAAE,iBAAiB;IACzB,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;IACpD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACxB,cAAc,EAAE,wBAAwB,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC/D,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrC,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACrD,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACpD,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAClC,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,6BAA6B,CAAC;CACtD,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,EAAE,EAAE,YAAY;IAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACxC,MAAM,EAAE,kBAAkB;CAC3B,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC3B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;CACnC,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IAC7B,WAAW,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;CAC/B,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC1B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,QAAQ,EAAE;IACtD,WAAW,EAAE,CAAC,CAAC,OAAO,EAAE;IACxB,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;CACxB,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CAAC;IACzD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACrC,MAAM,EAAE,iBAAiB;IACzB,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE;IACtB,cAAc,EAAE,wBAAwB,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC9D,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC5B,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC;IAClC,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;CAClD,CAAC,CAAC;AAMH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACnB,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,kCAAkC,CAAC;CAC3D,CAAC,CAAC;AAIH,+EAA+E;AAC/E,yCAAyC;AACzC,+EAA+E;AAE/E,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC/D,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE;CAChE,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;IACnB,IAAI,EAAE,sBAAsB,CAAC,QAAQ,EAAE;IACvC,IAAI,EAAE,sBAAsB,CAAC,QAAQ,EAAE;CACxC,CAAC,CAAC"}

package/dist/scopes/index.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @syncular/core - Scope types, patterns, and utilities
+ *
+ * Scope patterns define how data is partitioned for sync.
+ * Scopes are stored as JSONB on changes for flexible filtering.
+ * Patterns use `{placeholder}` syntax to extract or inject values.
+ */
+/**
+ * Scope pattern string, e.g., 'user:{user_id}', 'project:{project_id}'
+ */
+export type ScopePattern = string;
+/**
+ * Scope values - the actual values for scope variables.
+ * Values can be single strings or arrays (for multi-value subscriptions).
+ *
+ * @example
+ * { user_id: 'U1' }
+ * { project_id: ['P1', 'P2'] }
+ * { year: '2025', month: '03' }
+ */
+export type ScopeValues = Record<string, string | string[]>;
+/**
+ * Stored scopes on a change - always single values (not arrays).
+ * This is what gets stored in the JSONB column.
+ *
+ * @example
+ * { user_id: 'U1', project_id: 'P1' }
+ */
+export type StoredScopes = Record<string, string>;
+/**
+ * Simplified scope definition.
+ * Can be a simple pattern string or an object with explicit column mapping.
+ *
+ * @example
+ * ```typescript
+ * // Simple: pattern column is auto-derived
+ * scopes: ['user:{user_id}', 'org:{org_id}']
+ *
+ * // Explicit: when column differs from pattern variable
+ * scopes: [
+ *   { pattern: 'user:{user_id}', column: 'owner_id' }
+ * ]
+ * ```
+ */
+export type ScopeDefinition = string | {
+    pattern: string;
+    column: string;
+};
+/**
+ * Normalize scope definitions to a pattern-to-column map.
+ *
+ * @example
+ * normalizeScopes(['user:{user_id}'])
+ * // → { 'user:{user_id}': 'user_id' }
+ */
+export declare function normalizeScopes(scopes: ScopeDefinition[]): Record<string, string>;
+/**
+ * Extract variable names from a scope pattern.
+ *
+ * @example
+ * extractScopeVars('project:{project_id}') // ['project_id']
+ * extractScopeVars('event_date:{year}:{month}') // ['year', 'month']
+ */
+export declare function extractScopeVars(pattern: ScopePattern): string[];
+//# sourceMappingURL=index.d.ts.map

package/dist/scopes/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/scopes/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAC;AAE5D;;;;;;GAMG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAElD;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AA+B3E;;;;;;GAMG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,eAAe,EAAE,GACxB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAgBxB;AAID;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM,EAAE,CAIhE"}