@syncular/core 0.0.6-95 → 0.1.0

package/dist/snapshot-chunks.d.ts

@@ -1,26 +1,110 @@
 /**
  * @syncular/core - Snapshot chunk encoding helpers
  */
-export declare const SYNC_SNAPSHOT_CHUNK_ENCODING = "json-row-frame-v1";
-export type SyncSnapshotChunkEncoding = typeof SYNC_SNAPSHOT_CHUNK_ENCODING;
+export declare const SYNC_SNAPSHOT_CHUNK_ENCODING_BINARY_TABLE_V1 = "binary-table-v1";
+export declare const SYNC_SNAPSHOT_CHUNK_ENCODINGS: readonly ["binary-table-v1"];
+export declare const SYNC_SNAPSHOT_CHUNK_ENCODING = "binary-table-v1";
+export type SyncSnapshotChunkEncoding = (typeof SYNC_SNAPSHOT_CHUNK_ENCODINGS)[number];
+export declare function isSyncSnapshotChunkEncoding(value: unknown): value is SyncSnapshotChunkEncoding;
 export declare const SYNC_SNAPSHOT_CHUNK_COMPRESSION = "gzip";
 export type SyncSnapshotChunkCompression = typeof SYNC_SNAPSHOT_CHUNK_COMPRESSION;
-/**
- * Encode rows as framed JSON bytes without the format header.
- */
-export declare function encodeSnapshotRowFrames(rows: readonly unknown[]): Uint8Array;
-/**
- * Encode rows as framed JSON bytes with a format header.
- *
- * Format:
- * - 4-byte magic header ("SRF1")
- * - repeated frames of:
- *   - 4-byte big-endian payload byte length
- *   - UTF-8 JSON payload
- */
-export declare function encodeSnapshotRows(rows: readonly unknown[]): Uint8Array;
-/**
- * Decode framed JSON bytes into rows.
- */
-export declare function decodeSnapshotRows(bytes: Uint8Array): unknown[];
+export declare const SYNC_SNAPSHOT_ARTIFACT_COMPRESSION_NONE = "none";
+export declare const SYNC_SCOPED_SNAPSHOT_ARTIFACT_MANIFEST_VERSION = 1;
+export declare const SYNC_SCOPED_SNAPSHOT_ARTIFACT_KIND_SQLITE_V1 = "sqlite-snapshot-v1";
+export type SyncSnapshotArtifactCompression = SyncSnapshotChunkCompression | typeof SYNC_SNAPSHOT_ARTIFACT_COMPRESSION_NONE;
+export type SyncScopedSnapshotArtifactKind = typeof SYNC_SCOPED_SNAPSHOT_ARTIFACT_KIND_SQLITE_V1;
+export interface SnapshotManifestChunkDigestInput {
+    id: string;
+    byteLength: number;
+    sha256: string;
+    encoding: SyncSnapshotChunkEncoding;
+    compression: SyncSnapshotChunkCompression;
+}
+export interface SnapshotManifestDigestInput {
+    version: 1;
+    table: string;
+    asOfCommitSeq: number;
+    scopeDigest: string;
+    rowCursor: string | null;
+    rowLimit: number;
+    nextRowCursor: string | null;
+    isFirstPage: boolean;
+    isLastPage: boolean;
+    chunks: readonly SnapshotManifestChunkDigestInput[];
+}
+export interface SnapshotManifestDigestValue extends Omit<SnapshotManifestDigestInput, 'chunks'> {
+    chunks: SnapshotManifestChunkDigestInput[];
+    digest: string;
+}
+export interface ScopedSnapshotArtifactDigestInput {
+    version: typeof SYNC_SCOPED_SNAPSHOT_ARTIFACT_MANIFEST_VERSION;
+    artifactKind: SyncScopedSnapshotArtifactKind;
+    partitionId: string;
+    subscriptionId: string;
+    table: string;
+    schemaVersion: string;
+    asOfCommitSeq: number;
+    scopeDigest: string;
+    rowCursor: string | null;
+    rowLimit: number;
+    rowCount: number;
+    nextRowCursor: string | null;
+    isFirstPage: boolean;
+    isLastPage: boolean;
+    compression: SyncSnapshotArtifactCompression;
+    byteLength: number;
+    sha256: string;
+    featureSet: readonly string[];
+}
+export interface ScopedSnapshotArtifactManifest extends ScopedSnapshotArtifactDigestInput {
+    featureSet: string[];
+    digest: string;
+}
+export type BinarySnapshotColumnType = 'string' | 'integer' | 'float' | 'boolean' | 'json' | 'bytes';
+export interface BinarySnapshotColumn {
+    name: string;
+    type: BinarySnapshotColumnType;
+    nullable?: boolean;
+}
+export interface BinarySnapshotTable {
+    table: string;
+    columns: readonly BinarySnapshotColumn[];
+    rows: readonly Record<string, unknown>[];
+}
+export type BinarySnapshotRowsEncoder<Row = unknown> = (rows: readonly Row[]) => Uint8Array;
+export interface DecodedBinarySnapshotTable {
+    table: string;
+    columns: BinarySnapshotColumn[];
+    rows: Record<string, unknown>[];
+}
+export declare function snapshotScopeDigestFromCacheKey(scopeKey: string): string;
+export declare function snapshotManifestDigestPayload(manifest: SnapshotManifestDigestInput): string;
+export declare function createSnapshotManifestDigest(manifest: SnapshotManifestDigestInput): Promise<string>;
+export declare function createSnapshotManifest(manifest: SnapshotManifestDigestInput): Promise<SnapshotManifestDigestValue>;
+export declare function scopedSnapshotArtifactDigestPayload(manifest: ScopedSnapshotArtifactDigestInput): string;
+export declare function createScopedSnapshotArtifactDigest(manifest: ScopedSnapshotArtifactDigestInput): Promise<string>;
+export declare function createScopedSnapshotArtifactManifest(manifest: ScopedSnapshotArtifactDigestInput): Promise<ScopedSnapshotArtifactManifest>;
+export declare function encodeBinarySnapshotTable(table: BinarySnapshotTable): Uint8Array;
+export declare class BinarySnapshotTableWriter {
+    private readonly columns;
+    private readonly writer;
+    private readonly nullBitmapBytes;
+    private readonly expectedRows;
+    private rowsWritten;
+    private nullBitmapOffset;
+    constructor(table: string, columns: readonly BinarySnapshotColumn[], rowCount: number, initialCapacity?: number);
+    beginRow(): void;
+    writeNull(columnIndex: number): void;
+    writeString(value: string | Date, label: string): void;
+    writeInteger(value: number | bigint | string, label: string): void;
+    writeFloat(value: number, label: string): void;
+    writeBoolean(value: boolean, label: string): void;
+    writeJson(value: unknown, label: string): void;
+    writeBytes(value: Uint8Array | ArrayBuffer, columnName: string): void;
+    writeValue(columnIndex: number, value: unknown): void;
+    finish(): Uint8Array;
+    private column;
+    private currentNullBitmapOffset;
+}
+export declare function decodeBinarySnapshotTable(bytes: Uint8Array): DecodedBinarySnapshotTable;
 //# sourceMappingURL=snapshot-chunks.d.ts.map

package/dist/snapshot-chunks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snapshot-chunks.d.ts","sourceRoot":"","sources":["../src/snapshot-chunks.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,eAAO,MAAM,4BAA4B,sBAAsB,CAAC;AAChE,MAAM,MAAM,yBAAyB,GAAG,OAAO,4BAA4B,CAAC;AAE5E,eAAO,MAAM,+BAA+B,SAAS,CAAC;AACtD,MAAM,MAAM,4BAA4B,GACtC,OAAO,+BAA+B,CAAC;AAWzC;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,SAAS,OAAO,EAAE,GAAG,UAAU,CA2B5E;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,SAAS,OAAO,EAAE,GAAG,UAAU,CASvE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,EAAE,CAoC/D"}
+{"version":3,"file":"snapshot-chunks.d.ts","sourceRoot":"","sources":["../src/snapshot-chunks.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH,eAAO,MAAM,4CAA4C,oBAAoB,CAAC;AAC9E,eAAO,MAAM,6BAA6B,8BAEhC,CAAC;AACX,eAAO,MAAM,4BAA4B,oBACK,CAAC;AAC/C,MAAM,MAAM,yBAAyB,GACnC,CAAC,OAAO,6BAA6B,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjD,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,yBAAyB,CAKpC;AAED,eAAO,MAAM,+BAA+B,SAAS,CAAC;AACtD,MAAM,MAAM,4BAA4B,GACtC,OAAO,+BAA+B,CAAC;AACzC,eAAO,MAAM,uCAAuC,SAAS,CAAC;AAC9D,eAAO,MAAM,8CAA8C,IAAI,CAAC;AAChE,eAAO,MAAM,4CAA4C,uBACnC,CAAC;AACvB,MAAM,MAAM,+BAA+B,GACvC,4BAA4B,GAC5B,OAAO,uCAAuC,CAAC;AACnD,MAAM,MAAM,8BAA8B,GACxC,OAAO,4CAA4C,CAAC;AAEtD,MAAM,WAAW,gCAAgC;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,yBAAyB,CAAC;IACpC,WAAW,EAAE,4BAA4B,CAAC;CAC3C;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,CAAC,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,SAAS,gCAAgC,EAAE,CAAC;CACrD;AAED,MAAM,WAAW,2BACf,SAAQ,IAAI,CAAC,2BAA2B,EAAE,QAAQ,CAAC;IACnD,MAAM,EAAE,gCAAgC,EAAE,CAAC;IAC3C,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iCAAiC;IAChD,OAAO,EAAE,OAAO,8CAA8C,CAAC;IAC/D,YAAY,EAAE,8BAA8B,CAAC;IAC7C,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,OAAO,CAAC;IACpB,WAAW,EAAE,+BAA+B,CAAC;IAC7C,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;CAC/B;AAED,MAAM,WAAW,8BACf,SAAQ,iCAAiC;IACzC,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB;AAUD,MAAM,MAAM,wBAAwB,GAChC,QAAQ,GACR,SAAS,GACT,OAAO,GACP,SAAS,GACT,MAAM,GACN,OAAO,CAAC;AAEZ,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,wBAAwB,CAAC;IAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,SAAS,oBAAoB,EAAE,CAAC;IACzC,IAAI,EAAE,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CAC1C;AAED,MAAM,MAAM,yBAAyB,CAAC,GAAG,GAAG,OAAO,IAAI,CACrD,IAAI,EAAE,SAAS,GAAG,EAAE,KACjB,UAAU,CAAC;AAEhB,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;CACjC;AAsDD,wBAAgB,+BAA+B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAWxE;AAED,wBAAgB,6BAA6B,CAC3C,QAAQ,EAAE,2BAA2B,GACpC,MAAM,CAuBR;AAED,wBAAsB,4BAA4B,CAChD,QAAQ,EAAE,2BAA2B,GACpC,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED,wBAAsB,sBAAsB,CAC1C,QAAQ,EAAE,2BAA2B,GACpC,OAAO,CAAC,2BAA2B,CAAC,CAMtC;AAeD,wBAAgB,mCAAmC,CACjD,QAAQ,EAAE,iCAAiC,GAC1C,MAAM,CA4BR;AAED,wBAAsB,kCAAkC,CACtD,QAAQ,EAAE,iCAAiC,GAC1C,OAAO,CAAC,MAAM,CAAC,CAEjB;AAED,wBAAsB,oCAAoC,CACxD,QAAQ,EAAE,iCAAiC,GAC1C,OAAO,CAAC,8BAA8B,CAAC,CAOzC;AAED,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,mBAAmB,GACzB,UAAU,CAoCZ;AA+CD,qBAAa,yBAAyB;IASlC,OAAO,CAAC,QAAQ,CAAC,OAAO;IAR1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAuB;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,gBAAgB,CAAuB;IAE/C,YACE,KAAK,EAAE,MAAM,EACI,OAAO,EAAE,SAAS,oBAAoB,EAAE,EACzD,QAAQ,EAAE,MAAM,EAChB,eAAe,CAAC,EAAE,MAAM,EASzB;IAED,QAAQ,IAAI,IAAI,CAMf;IAED,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,CAWnC;IAED,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAGrD;IAED,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAGjE;IAED,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAM7C;IAED,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAMhD;IAED,SAAS,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAG7C;IAED,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,WAAW,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI,CAKpE;IAED,UAAU,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAQpD;IAED,MAAM,IAAI,UAAU,CAOnB;IAED,OAAO,CAAC,MAAM;IAQd,OAAO,CAAC,uBAAuB;CAMhC;AAED,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,UAAU,GAChB,0BAA0B,CA+D5B"}