@loro-dev/streams-crdt 0.1.0 → 0.1.2

package/README.md

@@ -295,6 +295,91 @@ The required ordering is:
 If you cannot provide steps 1 and 3, do not use a persisted remote cursor
 store.
 
+## Snapshot Codec Hooks
+
+Use `snapshotCodec` when you want transport to transform full snapshots during
+upload and bootstrap:
+
+```ts
+const transport = new StreamsCrdt({
+  streamUrl,
+  adapter: createLoroDocAdapter(doc),
+  snapshotCodec: {
+    // Sync or async are both allowed.
+    compress: async (snapshot) => snapshot,
+    decompress: (snapshot) => snapshot,
+  },
+});
+```
+
+### Behavior
+
+- `snapshotCodec.compress(snapshot)` runs right before a snapshot is uploaded to
+  Loro Streams
+- `snapshotCodec.decompress(snapshot)` runs right after a non-empty snapshot is
+  downloaded from Loro Streams and right before `adapter.applySnapshot(...)`
+- Both hooks must be provided together
+- Both hooks may return either `Uint8Array` or `Promise<Uint8Array>`
+- These hooks affect **full snapshots only**. Incremental update batches are
+  unchanged
+
+### Compatibility
+
+Transport does not version or negotiate snapshot codecs for you.
+
+If you enable `snapshotCodec`, you must make sure `decompress` can still read
+any older snapshots that are already stored for that stream. This is especially
+important when:
+
+- existing snapshots were uploaded without compression
+- you change the compression format later
+- you roll out the codec gradually across clients
+
+### `@loro-dev/streams-crdt/zstd`
+
+`@loro-dev/streams-crdt/zstd` is an optional helper entry point built on top of
+[`@bokuweb/zstd-wasm`](https://www.npmjs.com/package/@bokuweb/zstd-wasm).
+
+Install the optional peer dependency first:
+
+```bash
+pnpm add @loro-dev/streams-crdt @bokuweb/zstd-wasm
+```
+
+Then wire the exported hooks directly into `snapshotCodec`:
+
+```ts
+import { LoroDoc } from "loro-crdt";
+import {
+  createLoroDocAdapter,
+  createStreamUrl,
+  StreamsCrdt,
+} from "@loro-dev/streams-crdt/loro";
+import {
+  compress,
+  decompress,
+} from "@loro-dev/streams-crdt/zstd";
+
+const doc = new LoroDoc();
+const transport = new StreamsCrdt({
+  streamUrl: createStreamUrl({
+    bucketId: "my-bucket",
+    streamId: "doc-1",
+  }),
+  adapter: createLoroDocAdapter(doc),
+  snapshotCodec: { compress, decompress },
+});
+```
+
+`@loro-dev/streams-crdt/zstd` exports:
+
+- `compress(snapshot)` — async; uses an extra Worker when available and falls
+  back to the current thread otherwise
+- `compressInWorker(snapshot)` — async; worker-only compression helper
+- `compressOnCurrentThread(snapshot)` — async; current-thread compression
+  helper
+- `decompress(snapshot)` — async; current-thread decompression helper
+
 ## Automatic Snapshot Upload
 
 The transport can upload snapshots automatically during `join()` when callers
@@ -348,6 +433,7 @@ const transport = new StreamsCrdt({
 | `@loro-dev/streams-crdt` | Transport core, cursor stores, ID helpers, all shared types |
 | `@loro-dev/streams-crdt/loro` | Everything above + `createLoroDocAdapter(doc)` |
 | `@loro-dev/streams-crdt/flock` | Everything above + `createFlockAdapter(flock)` |
+| `@loro-dev/streams-crdt/zstd` | Snapshot `compress` / `decompress` hooks backed by `@bokuweb/zstd-wasm` |
 
 ## Public API Reference
 
@@ -364,6 +450,7 @@ const transport = new StreamsCrdt({
 - `TransportJoinParams` — `join()` options
 - `TransportSubscription` — active live subscription handle
 - `TransportRoomStatus` — `"joined" | "reconnecting" | "disconnected" | "error"`
+- `SnapshotCodec`, `SnapshotTransformHook` — full snapshot encode/decode hooks
 - `SnapshotUploadOptions` — snapshot upload configuration
 - `RemoteCursor` — replay progress metadata
 - `RemoteCursorStore` — abstract cursor storage interface
@@ -387,7 +474,17 @@ const transport = new StreamsCrdt({
 `@loro-dev/streams-crdt/flock` re-exports everything from the root plus:
 
 - `createFlockAdapter(flock)` — creates a `CrdtAdapter` for one `Flock` replica
-- `FlockVersionVector` — Flock-specific version vector type
+- `VersionVector`, `ExportBundle` — re-exported from `@loro-dev/flock-wasm`
+
+### Zstd Entry Point
+
+`@loro-dev/streams-crdt/zstd` exports:
+
+- `compress(snapshot)` — async snapshot compression helper
+- `compressInWorker(snapshot)` — async worker-only snapshot compression helper
+- `compressOnCurrentThread(snapshot)` — async current-thread snapshot
+  compression helper
+- `decompress(snapshot)` — async snapshot decompression helper
 
 ## Notes
 

package/dist/flock.d.ts

@@ -1,36 +1,11 @@
-import { C as IndexedDbRemoteCursorStore, D as RemoteCursorStore, E as RemoteCursorSaveSource, O as createInitialRemoteCursor, S as InMemoryRemoteCursorStore, T as RemoteCursor, _ as TransportRoomStatus, a as CrdtAdapter, b as BeforeRemoteCursorSaveContext, c as JsonValue, d as StreamsAuthProvider, f as StreamsCrdtOptions, g as TransportJoinParams, h as TransportError, i as StreamsCrdt, l as Result, m as TransportDeleteStreamSuccess, n as isValidBucketId, o as CrdtUpdateBatch, p as TransportCreateStreamSuccess, r as isValidRillId, s as JsonObject, t as createStreamUrl, u as SnapshotUploadOptions, v as TransportSubscription, w as IndexedDbRemoteCursorStoreOptions, x as BeforeRemoteCursorSaveHook, y as TransportSyncSuccess } from "./stream-id-1f2mhtmk.js";
+import { A as createInitialRemoteCursor, C as BeforeRemoteCursorSaveHook, D as RemoteCursor, E as IndexedDbRemoteCursorStoreOptions, O as RemoteCursorSaveSource, S as BeforeRemoteCursorSaveContext, T as IndexedDbRemoteCursorStore, _ as TransportError, a as CrdtAdapter, b as TransportSubscription, c as JsonValue, d as SnapshotTransformHook, f as SnapshotUploadOptions, g as TransportDeleteStreamSuccess, h as TransportCreateStreamSuccess, i as StreamsCrdt, k as RemoteCursorStore, l as Result, m as StreamsCrdtOptions, n as isValidBucketId, o as CrdtUpdateBatch, p as StreamsAuthProvider, r as isValidRillId, s as JsonObject, t as createStreamUrl, u as SnapshotCodec, v as TransportJoinParams, w as InMemoryRemoteCursorStore, x as TransportSyncSuccess, y as TransportRoomStatus } from "./stream-id-BfuQIfcB.js";
+import { ExportBundle, Flock, VersionVector, VersionVector as VersionVector$1 } from "@loro-dev/flock-wasm";
 
 //#region src/flock.d.ts
-type FlockVersionEntry = {
-  logicalCounter: number;
-  physicalTime?: number;
-};
-/**
- * Flock version vector shape used by the built-in Flock adapter.
- */
-type FlockVersionVector = Record<string, FlockVersionEntry>;
-type FlockExportBundle = {
-  readonly version?: number;
-  readonly entries: Record<string, unknown>;
-};
-type FlockLike = {
-  exportJson(options?: {
-    from?: FlockVersionVector;
-    peerId?: string;
-  }): FlockExportBundle;
-  importJson(bundle: FlockExportBundle): unknown;
-  merge?(replica: unknown): unknown;
-  peerId?(): string;
-  version(): unknown;
-  exportFile?(): Uint8Array;
-  subscribe?(listener: (batch: {
-    source?: string;
-  }) => void): () => void;
-};
 /**
  * Creates a `CrdtAdapter` for one Flock replica.
  */
-declare function createFlockAdapter(flock: FlockLike): CrdtAdapter<JsonObject>;
+declare function createFlockAdapter(flock: Flock): CrdtAdapter<VersionVector$1>;
 //#endregion
-export { BeforeRemoteCursorSaveContext, BeforeRemoteCursorSaveHook, CrdtAdapter, CrdtUpdateBatch, FlockVersionVector, InMemoryRemoteCursorStore, IndexedDbRemoteCursorStore, IndexedDbRemoteCursorStoreOptions, JsonObject, JsonValue, RemoteCursor, RemoteCursorSaveSource, RemoteCursorStore, Result, SnapshotUploadOptions, StreamsAuthProvider, StreamsCrdt, StreamsCrdtOptions, TransportCreateStreamSuccess, TransportDeleteStreamSuccess, TransportError, TransportJoinParams, TransportRoomStatus, TransportSubscription, TransportSyncSuccess, createFlockAdapter, createInitialRemoteCursor, createStreamUrl, isValidBucketId, isValidRillId };
+export { BeforeRemoteCursorSaveContext, BeforeRemoteCursorSaveHook, CrdtAdapter, CrdtUpdateBatch, type ExportBundle, InMemoryRemoteCursorStore, IndexedDbRemoteCursorStore, IndexedDbRemoteCursorStoreOptions, JsonObject, JsonValue, RemoteCursor, RemoteCursorSaveSource, RemoteCursorStore, Result, SnapshotCodec, SnapshotTransformHook, SnapshotUploadOptions, StreamsAuthProvider, StreamsCrdt, StreamsCrdtOptions, TransportCreateStreamSuccess, TransportDeleteStreamSuccess, TransportError, TransportJoinParams, TransportRoomStatus, TransportSubscription, TransportSyncSuccess, type VersionVector, createFlockAdapter, createInitialRemoteCursor, createStreamUrl, isValidBucketId, isValidRillId };
 //# sourceMappingURL=flock.d.ts.map

package/dist/flock.js

@@ -1,74 +1,45 @@
-import { a as InMemoryRemoteCursorStore, i as StreamsCrdt, n as isValidBucketId, o as IndexedDbRemoteCursorStore, r as isValidRillId, s as createInitialRemoteCursor, t as createStreamUrl } from "./stream-id-CIhmveJD.js";
+import { a as InMemoryRemoteCursorStore, i as StreamsCrdt, n as isValidBucketId, o as IndexedDbRemoteCursorStore, r as isValidRillId, s as createInitialRemoteCursor, t as createStreamUrl } from "./stream-id-YOFZ4I6Y.js";
 //#region src/flock.ts
-function toVersionVector(version) {
-	const out = {};
-	for (const [peer, raw] of Object.entries(version)) {
-		if (typeof raw !== "object" || raw == null || Array.isArray(raw)) continue;
-		const logicalCounter = typeof raw.logicalCounter === "number" ? raw.logicalCounter : void 0;
-		if (logicalCounter == null || !Number.isFinite(logicalCounter)) continue;
-		out[peer] = typeof raw.physicalTime === "number" && Number.isFinite(raw.physicalTime) ? {
-			logicalCounter,
-			physicalTime: raw.physicalTime
-		} : { logicalCounter };
-	}
-	return out;
-}
-function fromVersionVector(version) {
-	const out = {};
-	for (const [peer, entry] of Object.entries(version)) out[peer] = entry.physicalTime === void 0 ? { logicalCounter: entry.logicalCounter } : {
-		logicalCounter: entry.logicalCounter,
-		physicalTime: entry.physicalTime
-	};
-	return out;
+function isAfter(entry, current) {
+	return entry.physicalTime > current.physicalTime || entry.physicalTime === current.physicalTime && entry.logicalCounter > current.logicalCounter;
 }
 function mergeVersions(base, incoming) {
 	const merged = { ...base };
 	for (const [peer, entry] of Object.entries(incoming)) {
+		if (entry == null) continue;
 		const current = merged[peer];
-		if (current == null || entry.logicalCounter > current.logicalCounter) {
-			merged[peer] = { ...entry };
-			continue;
-		}
-		if (entry.logicalCounter < current.logicalCounter) continue;
-		const physicalTime = Math.max(current.physicalTime ?? Number.NEGATIVE_INFINITY, entry.physicalTime ?? Number.NEGATIVE_INFINITY);
-		merged[peer] = physicalTime === Number.NEGATIVE_INFINITY ? { logicalCounter: current.logicalCounter } : {
-			logicalCounter: current.logicalCounter,
-			physicalTime
-		};
+		if (current == null || isAfter(entry, current)) merged[peer] = { ...entry };
 	}
 	return merged;
 }
+function parseClock(record) {
+	const firstComma = record.c.indexOf(",");
+	const secondComma = record.c.indexOf(",", firstComma + 1);
+	if (firstComma < 0 || secondComma < 0) return null;
+	const physicalTime = Number(record.c.slice(0, firstComma));
+	const logicalCounter = Number(record.c.slice(firstComma + 1, secondComma));
+	if (!Number.isFinite(physicalTime) || !Number.isFinite(logicalCounter)) return null;
+	return {
+		peerId: record.c.slice(secondComma + 1),
+		entry: {
+			physicalTime,
+			logicalCounter
+		}
+	};
+}
 function extractVersionFromBundle(bundle) {
 	const out = {};
-	for (const raw of Object.values(bundle.entries)) {
-		if (typeof raw !== "object" || raw == null || Array.isArray(raw)) continue;
-		const entry = raw;
-		if (typeof entry.peerId !== "string") continue;
-		const logicalCounter = typeof entry.logicalCounter === "number" ? entry.logicalCounter : typeof entry.counter === "number" ? entry.counter : void 0;
-		if (logicalCounter == null || !Number.isFinite(logicalCounter)) continue;
-		out[entry.peerId] = typeof entry.physicalTime === "number" && Number.isFinite(entry.physicalTime) ? {
-			logicalCounter,
-			physicalTime: entry.physicalTime
-		} : { logicalCounter };
+	for (const record of Object.values(bundle.entries)) {
+		const parsed = parseClock(record);
+		if (parsed == null) continue;
+		const current = out[parsed.peerId];
+		if (current == null || isAfter(parsed.entry, current)) out[parsed.peerId] = parsed.entry;
 	}
 	return out;
 }
 function hasEntries(bundle) {
 	return Object.keys(bundle.entries).length > 0;
 }
-function tryMergeSnapshotFromFile(flock, snapshot) {
-	if (typeof flock.merge !== "function") return null;
-	const ctor = flock.constructor;
-	if (ctor == null || typeof ctor.fromFile !== "function") return null;
-	try {
-		const peerId = typeof flock.peerId === "function" ? flock.peerId() : void 0;
-		const replica = ctor.fromFile(snapshot, peerId);
-		flock.merge(replica);
-		return toVersionVector(flock.version() ?? {});
-	} catch {
-		return null;
-	}
-}
 /**
 * Creates a `CrdtAdapter` for one Flock replica.
 */
@@ -80,59 +51,46 @@ function createFlockAdapter(flock) {
 	};
 	return {
 		emptyVersion: () => ({}),
-		mergeVersions: (base, incoming) => fromVersionVector(mergeVersions(toVersionVector(base), toVersionVector(incoming))),
-		exportSnapshot: () => {
-			if (typeof flock.exportFile === "function") return flock.exportFile();
-			return new TextEncoder().encode(JSON.stringify({
-				version: 0,
-				entries: {}
-			}));
-		},
+		mergeVersions,
+		exportSnapshot: () => flock.exportFile(),
 		applySnapshot: (snapshot) => {
-			if (snapshot.byteLength === 0) return {};
-			const mergedVersion = tryMergeSnapshotFromFile(flock, snapshot);
-			if (mergedVersion != null) return fromVersionVector(mergedVersion);
-			const bundle = JSON.parse(new TextDecoder().decode(snapshot));
-			if (hasEntries(bundle)) flock.importJson(bundle);
-			return fromVersionVector(extractVersionFromBundle(bundle));
+			flock.importFile(snapshot);
+			return flock.version();
 		},
 		exportUpdates: (fromVersion) => {
-			const from = toVersionVector(fromVersion);
-			const bundle = flock.exportJson({ from });
-			recordExportFrontier(from);
+			const bundle = flock.exportJson(fromVersion);
+			recordExportFrontier(fromVersion);
 			if (!hasEntries(bundle)) return;
 			const exportedVersion = extractVersionFromBundle(bundle);
 			recordExportFrontier(exportedVersion);
 			return {
 				updates: [new TextEncoder().encode(JSON.stringify(bundle))],
-				version: fromVersionVector(exportedVersion)
+				version: exportedVersion
 			};
 		},
 		applyRemoteUpdates: (updates, remoterVersion) => {
-			let merged = toVersionVector(remoterVersion);
+			let merged = remoterVersion;
 			for (const update of updates) {
 				const bundle = JSON.parse(new TextDecoder().decode(update));
 				if (!hasEntries(bundle)) continue;
 				flock.importJson(bundle);
 				merged = mergeVersions(merged, extractVersionFromBundle(bundle));
 			}
-			return fromVersionVector(merged);
+			return merged;
 		},
 		subscribeLocalUpdates: (listener) => {
-			if (typeof flock.subscribe !== "function") return () => void 0;
 			return flock.subscribe((batch) => {
 				if (batch.source !== "local") return;
-				const drain = () => {
-					const peerId = typeof flock.peerId === "function" ? flock.peerId() : void 0;
-					const batchPayload = flock.exportJson({
+				const drain = async () => {
+					const batchPayload = await flock.exportJson({
 						from: lastExportedVersion,
-						peerId
+						peerId: flock.peerId()
 					});
 					if (!hasEntries(batchPayload)) return;
-					recordExportFrontier(toVersionVector(fromVersionVector(flock.version() ?? {})));
+					recordExportFrontier(flock.version());
 					listener({
 						updates: [new TextEncoder().encode(JSON.stringify(batchPayload))],
-						version: fromVersionVector(extractVersionFromBundle(batchPayload))
+						version: extractVersionFromBundle(batchPayload)
 					});
 				};
 				localExportQueue = localExportQueue.then(drain).catch(() => {});

package/dist/flock.js.map

@@ -1 +1 @@
-{"version":3,"file":"flock.js","names":[],"sources":["../src/flock.ts"],"sourcesContent":["import type { JsonObject, CrdtAdapter } from \"./types\";\n\nexport { StreamsCrdt } from \"./transport\";\nexport * from \"./shared\";\n\ntype FlockVersionEntry = {\n  logicalCounter: number;\n  physicalTime?: number;\n};\n\n/**\n * Flock version vector shape used by the built-in Flock adapter.\n */\nexport type FlockVersionVector = Record<string, FlockVersionEntry>;\n\ntype FlockExportBundle = {\n  readonly version?: number;\n  readonly entries: Record<string, unknown>;\n};\n\ntype FlockLike = {\n  exportJson(options?: {\n    from?: FlockVersionVector;\n    peerId?: string;\n  }): FlockExportBundle;\n  importJson(bundle: FlockExportBundle): unknown;\n  merge?(replica: unknown): unknown;\n  peerId?(): string;\n  version(): unknown;\n  exportFile?(): Uint8Array;\n  subscribe?(listener: (batch: { source?: string }) => void): () => void;\n};\n\nfunction toVersionVector(version: JsonObject): FlockVersionVector {\n  const out: FlockVersionVector = {};\n  for (const [peer, raw] of Object.entries(version)) {\n    if (typeof raw !== \"object\" || raw == null || Array.isArray(raw)) {\n      continue;\n    }\n    const logicalCounter =\n      typeof raw.logicalCounter === \"number\" ? raw.logicalCounter : undefined;\n    if (logicalCounter == null || !Number.isFinite(logicalCounter)) {\n      continue;\n    }\n    out[peer] =\n      typeof raw.physicalTime === \"number\" && Number.isFinite(raw.physicalTime)\n        ? { logicalCounter, physicalTime: raw.physicalTime }\n        : { logicalCounter };\n  }\n  return out;\n}\n\nfunction fromVersionVector(version: FlockVersionVector): JsonObject {\n  const out: Record<string, JsonObject> = {};\n  for (const [peer, entry] of Object.entries(version)) {\n    out[peer] =\n      entry.physicalTime === undefined\n        ? { logicalCounter: entry.logicalCounter }\n        : {\n            logicalCounter: entry.logicalCounter,\n            physicalTime: entry.physicalTime,\n          };\n  }\n  return out;\n}\n\nfunction mergeVersions(\n  base: FlockVersionVector,\n  incoming: FlockVersionVector,\n): FlockVersionVector {\n  const merged: FlockVersionVector = { ...base };\n  for (const [peer, entry] of Object.entries(incoming)) {\n    const current = merged[peer];\n    if (current == null || entry.logicalCounter > current.logicalCounter) {\n      merged[peer] = { ...entry };\n      continue;\n    }\n    if (entry.logicalCounter < current.logicalCounter) {\n      continue;\n    }\n    const physicalTime = Math.max(\n      current.physicalTime ?? Number.NEGATIVE_INFINITY,\n      entry.physicalTime ?? Number.NEGATIVE_INFINITY,\n    );\n    merged[peer] =\n      physicalTime === Number.NEGATIVE_INFINITY\n        ? { logicalCounter: current.logicalCounter }\n        : { logicalCounter: current.logicalCounter, physicalTime };\n  }\n  return merged;\n}\n\nfunction extractVersionFromBundle(\n  bundle: FlockExportBundle,\n): FlockVersionVector {\n  const out: FlockVersionVector = {};\n  for (const raw of Object.values(bundle.entries)) {\n    if (typeof raw !== \"object\" || raw == null || Array.isArray(raw)) {\n      continue;\n    }\n    const entry = raw as {\n      peerId?: unknown;\n      logicalCounter?: unknown;\n      counter?: unknown;\n      physicalTime?: unknown;\n    };\n    if (typeof entry.peerId !== \"string\") {\n      continue;\n    }\n    const logicalCounter =\n      typeof entry.logicalCounter === \"number\"\n        ? entry.logicalCounter\n        : typeof entry.counter === \"number\"\n          ? entry.counter\n          : undefined;\n    if (logicalCounter == null || !Number.isFinite(logicalCounter)) {\n      continue;\n    }\n    out[entry.peerId] =\n      typeof entry.physicalTime === \"number\" &&\n      Number.isFinite(entry.physicalTime)\n        ? { logicalCounter, physicalTime: entry.physicalTime }\n        : { logicalCounter };\n  }\n  return out;\n}\n\nfunction hasEntries(bundle: FlockExportBundle): boolean {\n  return Object.keys(bundle.entries).length > 0;\n}\n\nfunction tryMergeSnapshotFromFile(\n  flock: FlockLike,\n  snapshot: Uint8Array,\n): FlockVersionVector | null {\n  if (typeof flock.merge !== \"function\") {\n    return null;\n  }\n  const ctor = (\n    flock as unknown as {\n      readonly constructor?: {\n        fromFile?: (bytes: Uint8Array, peerId?: string) => unknown;\n      };\n    }\n  ).constructor;\n  if (ctor == null || typeof ctor.fromFile !== \"function\") {\n    return null;\n  }\n  try {\n    const peerId =\n      typeof flock.peerId === \"function\" ? flock.peerId() : undefined;\n    const replica = ctor.fromFile(snapshot, peerId);\n    flock.merge(replica);\n    return toVersionVector((flock.version() as JsonObject) ?? {});\n  } catch {\n    return null;\n  }\n}\n\n/**\n * Creates a `CrdtAdapter` for one Flock replica.\n */\nexport function createFlockAdapter(flock: FlockLike): CrdtAdapter<JsonObject> {\n  let lastExportedVersion: FlockVersionVector = {};\n  let localExportQueue = Promise.resolve();\n\n  const recordExportFrontier = (version: FlockVersionVector): void => {\n    lastExportedVersion = mergeVersions(lastExportedVersion, version);\n  };\n\n  return {\n    emptyVersion: () => ({}),\n    mergeVersions: (base, incoming) =>\n      fromVersionVector(\n        mergeVersions(toVersionVector(base), toVersionVector(incoming)),\n      ),\n    exportSnapshot: () => {\n      if (typeof flock.exportFile === \"function\") {\n        return flock.exportFile();\n      }\n      return new TextEncoder().encode(\n        JSON.stringify({ version: 0, entries: {} }),\n      );\n    },\n    applySnapshot: (snapshot) => {\n      if (snapshot.byteLength === 0) {\n        return {};\n      }\n      const mergedVersion = tryMergeSnapshotFromFile(flock, snapshot);\n      if (mergedVersion != null) {\n        return fromVersionVector(mergedVersion);\n      }\n      const bundle = JSON.parse(\n        new TextDecoder().decode(snapshot),\n      ) as FlockExportBundle;\n      if (hasEntries(bundle)) {\n        flock.importJson(bundle);\n      }\n      return fromVersionVector(extractVersionFromBundle(bundle));\n    },\n    exportUpdates: (fromVersion) => {\n      const from = toVersionVector(fromVersion);\n      const bundle = flock.exportJson({ from });\n      recordExportFrontier(from);\n      if (!hasEntries(bundle)) {\n        return undefined;\n      }\n      const exportedVersion = extractVersionFromBundle(bundle);\n      recordExportFrontier(exportedVersion);\n      return {\n        updates: [new TextEncoder().encode(JSON.stringify(bundle))],\n        version: fromVersionVector(exportedVersion),\n      };\n    },\n    applyRemoteUpdates: (updates, remoterVersion) => {\n      let merged = toVersionVector(remoterVersion);\n      for (const update of updates) {\n        const bundle = JSON.parse(\n          new TextDecoder().decode(update),\n        ) as FlockExportBundle;\n        if (!hasEntries(bundle)) {\n          continue;\n        }\n        flock.importJson(bundle);\n        merged = mergeVersions(merged, extractVersionFromBundle(bundle));\n      }\n      return fromVersionVector(merged);\n    },\n    subscribeLocalUpdates: (listener) => {\n      if (typeof flock.subscribe !== \"function\") {\n        return () => undefined;\n      }\n      const unsubscribe = flock.subscribe((batch) => {\n        if (batch.source !== \"local\") {\n          return;\n        }\n        const drain = () => {\n          const peerId =\n            typeof flock.peerId === \"function\" ? flock.peerId() : undefined;\n          const batchPayload = flock.exportJson({\n            from: lastExportedVersion,\n            peerId,\n          });\n          if (!hasEntries(batchPayload)) {\n            return;\n          }\n          const currentVersion = toVersionVector(\n            fromVersionVector((flock.version() as FlockVersionVector) ?? {}),\n          );\n          recordExportFrontier(currentVersion);\n          listener({\n            updates: [new TextEncoder().encode(JSON.stringify(batchPayload))],\n            version: fromVersionVector(extractVersionFromBundle(batchPayload)),\n          });\n        };\n\n        localExportQueue = localExportQueue.then(drain).catch(() => {\n          /* swallow to keep queue alive */\n        });\n      });\n      return unsubscribe;\n    },\n  };\n}\n"],"mappings":";;AAiCA,SAAS,gBAAgB,SAAyC;CAChE,MAAM,MAA0B,EAAE;AAClC,MAAK,MAAM,CAAC,MAAM,QAAQ,OAAO,QAAQ,QAAQ,EAAE;AACjD,MAAI,OAAO,QAAQ,YAAY,OAAO,QAAQ,MAAM,QAAQ,IAAI,CAC9D;EAEF,MAAM,iBACJ,OAAO,IAAI,mBAAmB,WAAW,IAAI,iBAAiB,KAAA;AAChE,MAAI,kBAAkB,QAAQ,CAAC,OAAO,SAAS,eAAe,CAC5D;AAEF,MAAI,QACF,OAAO,IAAI,iBAAiB,YAAY,OAAO,SAAS,IAAI,aAAa,GACrE;GAAE;GAAgB,cAAc,IAAI;GAAc,GAClD,EAAE,gBAAgB;;AAE1B,QAAO;;AAGT,SAAS,kBAAkB,SAAyC;CAClE,MAAM,MAAkC,EAAE;AAC1C,MAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,QAAQ,CACjD,KAAI,QACF,MAAM,iBAAiB,KAAA,IACnB,EAAE,gBAAgB,MAAM,gBAAgB,GACxC;EACE,gBAAgB,MAAM;EACtB,cAAc,MAAM;EACrB;AAET,QAAO;;AAGT,SAAS,cACP,MACA,UACoB;CACpB,MAAM,SAA6B,EAAE,GAAG,MAAM;AAC9C,MAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,SAAS,EAAE;EACpD,MAAM,UAAU,OAAO;AACvB,MAAI,WAAW,QAAQ,MAAM,iBAAiB,QAAQ,gBAAgB;AACpE,UAAO,QAAQ,EAAE,GAAG,OAAO;AAC3B;;AAEF,MAAI,MAAM,iBAAiB,QAAQ,eACjC;EAEF,MAAM,eAAe,KAAK,IACxB,QAAQ,gBAAgB,OAAO,mBAC/B,MAAM,gBAAgB,OAAO,kBAC9B;AACD,SAAO,QACL,iBAAiB,OAAO,oBACpB,EAAE,gBAAgB,QAAQ,gBAAgB,GAC1C;GAAE,gBAAgB,QAAQ;GAAgB;GAAc;;AAEhE,QAAO;;AAGT,SAAS,yBACP,QACoB;CACpB,MAAM,MAA0B,EAAE;AAClC,MAAK,MAAM,OAAO,OAAO,OAAO,OAAO,QAAQ,EAAE;AAC/C,MAAI,OAAO,QAAQ,YAAY,OAAO,QAAQ,MAAM,QAAQ,IAAI,CAC9D;EAEF,MAAM,QAAQ;AAMd,MAAI,OAAO,MAAM,WAAW,SAC1B;EAEF,MAAM,iBACJ,OAAO,MAAM,mBAAmB,WAC5B,MAAM,iBACN,OAAO,MAAM,YAAY,WACvB,MAAM,UACN,KAAA;AACR,MAAI,kBAAkB,QAAQ,CAAC,OAAO,SAAS,eAAe,CAC5D;AAEF,MAAI,MAAM,UACR,OAAO,MAAM,iBAAiB,YAC9B,OAAO,SAAS,MAAM,aAAa,GAC/B;GAAE;GAAgB,cAAc,MAAM;GAAc,GACpD,EAAE,gBAAgB;;AAE1B,QAAO;;AAGT,SAAS,WAAW,QAAoC;AACtD,QAAO,OAAO,KAAK,OAAO,QAAQ,CAAC,SAAS;;AAG9C,SAAS,yBACP,OACA,UAC2B;AAC3B,KAAI,OAAO,MAAM,UAAU,WACzB,QAAO;CAET,MAAM,OACJ,MAKA;AACF,KAAI,QAAQ,QAAQ,OAAO,KAAK,aAAa,WAC3C,QAAO;AAET,KAAI;EACF,MAAM,SACJ,OAAO,MAAM,WAAW,aAAa,MAAM,QAAQ,GAAG,KAAA;EACxD,MAAM,UAAU,KAAK,SAAS,UAAU,OAAO;AAC/C,QAAM,MAAM,QAAQ;AACpB,SAAO,gBAAiB,MAAM,SAAS,IAAmB,EAAE,CAAC;SACvD;AACN,SAAO;;;;;;AAOX,SAAgB,mBAAmB,OAA2C;CAC5E,IAAI,sBAA0C,EAAE;CAChD,IAAI,mBAAmB,QAAQ,SAAS;CAExC,MAAM,wBAAwB,YAAsC;AAClE,wBAAsB,cAAc,qBAAqB,QAAQ;;AAGnE,QAAO;EACL,qBAAqB,EAAE;EACvB,gBAAgB,MAAM,aACpB,kBACE,cAAc,gBAAgB,KAAK,EAAE,gBAAgB,SAAS,CAAC,CAChE;EACH,sBAAsB;AACpB,OAAI,OAAO,MAAM,eAAe,WAC9B,QAAO,MAAM,YAAY;AAE3B,UAAO,IAAI,aAAa,CAAC,OACvB,KAAK,UAAU;IAAE,SAAS;IAAG,SAAS,EAAE;IAAE,CAAC,CAC5C;;EAEH,gBAAgB,aAAa;AAC3B,OAAI,SAAS,eAAe,EAC1B,QAAO,EAAE;GAEX,MAAM,gBAAgB,yBAAyB,OAAO,SAAS;AAC/D,OAAI,iBAAiB,KACnB,QAAO,kBAAkB,cAAc;GAEzC,MAAM,SAAS,KAAK,MAClB,IAAI,aAAa,CAAC,OAAO,SAAS,CACnC;AACD,OAAI,WAAW,OAAO,CACpB,OAAM,WAAW,OAAO;AAE1B,UAAO,kBAAkB,yBAAyB,OAAO,CAAC;;EAE5D,gBAAgB,gBAAgB;GAC9B,MAAM,OAAO,gBAAgB,YAAY;GACzC,MAAM,SAAS,MAAM,WAAW,EAAE,MAAM,CAAC;AACzC,wBAAqB,KAAK;AAC1B,OAAI,CAAC,WAAW,OAAO,CACrB;GAEF,MAAM,kBAAkB,yBAAyB,OAAO;AACxD,wBAAqB,gBAAgB;AACrC,UAAO;IACL,SAAS,CAAC,IAAI,aAAa,CAAC,OAAO,KAAK,UAAU,OAAO,CAAC,CAAC;IAC3D,SAAS,kBAAkB,gBAAgB;IAC5C;;EAEH,qBAAqB,SAAS,mBAAmB;GAC/C,IAAI,SAAS,gBAAgB,eAAe;AAC5C,QAAK,MAAM,UAAU,SAAS;IAC5B,MAAM,SAAS,KAAK,MAClB,IAAI,aAAa,CAAC,OAAO,OAAO,CACjC;AACD,QAAI,CAAC,WAAW,OAAO,CACrB;AAEF,UAAM,WAAW,OAAO;AACxB,aAAS,cAAc,QAAQ,yBAAyB,OAAO,CAAC;;AAElE,UAAO,kBAAkB,OAAO;;EAElC,wBAAwB,aAAa;AACnC,OAAI,OAAO,MAAM,cAAc,WAC7B,cAAa,KAAA;AA8Bf,UA5BoB,MAAM,WAAW,UAAU;AAC7C,QAAI,MAAM,WAAW,QACnB;IAEF,MAAM,cAAc;KAClB,MAAM,SACJ,OAAO,MAAM,WAAW,aAAa,MAAM,QAAQ,GAAG,KAAA;KACxD,MAAM,eAAe,MAAM,WAAW;MACpC,MAAM;MACN;MACD,CAAC;AACF,SAAI,CAAC,WAAW,aAAa,CAC3B;AAKF,0BAHuB,gBACrB,kBAAmB,MAAM,SAAS,IAA2B,EAAE,CAAC,CACjE,CACmC;AACpC,cAAS;MACP,SAAS,CAAC,IAAI,aAAa,CAAC,OAAO,KAAK,UAAU,aAAa,CAAC,CAAC;MACjE,SAAS,kBAAkB,yBAAyB,aAAa,CAAC;MACnE,CAAC;;AAGJ,uBAAmB,iBAAiB,KAAK,MAAM,CAAC,YAAY,GAE1D;KACF;;EAGL"}
+{"version":3,"file":"flock.js","names":[],"sources":["../src/flock.ts"],"sourcesContent":["import { Flock } from \"@loro-dev/flock-wasm\";\nimport type {\n  EventBatch,\n  ExportBundle,\n  ExportRecord,\n  VersionVector,\n  VersionVectorEntry,\n} from \"@loro-dev/flock-wasm\";\nimport type { CrdtAdapter } from \"./types\";\n\nexport { StreamsCrdt } from \"./transport\";\nexport * from \"./shared\";\nexport type { ExportBundle, VersionVector } from \"@loro-dev/flock-wasm\";\n\nfunction isAfter(\n  entry: VersionVectorEntry,\n  current: VersionVectorEntry,\n): boolean {\n  return (\n    entry.physicalTime > current.physicalTime ||\n    (entry.physicalTime === current.physicalTime &&\n      entry.logicalCounter > current.logicalCounter)\n  );\n}\n\nfunction mergeVersions(\n  base: VersionVector,\n  incoming: VersionVector,\n): VersionVector {\n  const merged: VersionVector = { ...base };\n  for (const [peer, entry] of Object.entries(incoming)) {\n    if (entry == null) {\n      continue;\n    }\n    const current = merged[peer];\n    if (current == null || isAfter(entry, current)) {\n      merged[peer] = { ...entry };\n    }\n  }\n  return merged;\n}\n\nfunction parseClock(\n  record: ExportRecord,\n): { peerId: string; entry: VersionVectorEntry } | null {\n  const firstComma = record.c.indexOf(\",\");\n  const secondComma = record.c.indexOf(\",\", firstComma + 1);\n  if (firstComma < 0 || secondComma < 0) {\n    return null;\n  }\n\n  const physicalTime = Number(record.c.slice(0, firstComma));\n  const logicalCounter = Number(record.c.slice(firstComma + 1, secondComma));\n  if (!Number.isFinite(physicalTime) || !Number.isFinite(logicalCounter)) {\n    return null;\n  }\n\n  return {\n    peerId: record.c.slice(secondComma + 1),\n    entry: { physicalTime, logicalCounter },\n  };\n}\n\nfunction extractVersionFromBundle(bundle: ExportBundle): VersionVector {\n  const out: VersionVector = {};\n  for (const record of Object.values(bundle.entries)) {\n    const parsed = parseClock(record);\n    if (parsed == null) {\n      continue;\n    }\n    const current = out[parsed.peerId];\n    if (current == null || isAfter(parsed.entry, current)) {\n      out[parsed.peerId] = parsed.entry;\n    }\n  }\n  return out;\n}\n\nfunction hasEntries(bundle: ExportBundle): boolean {\n  return Object.keys(bundle.entries).length > 0;\n}\n\n/**\n * Creates a `CrdtAdapter` for one Flock replica.\n */\nexport function createFlockAdapter(flock: Flock): CrdtAdapter<VersionVector> {\n  let lastExportedVersion: VersionVector = {};\n  let localExportQueue = Promise.resolve();\n\n  const recordExportFrontier = (version: VersionVector): void => {\n    lastExportedVersion = mergeVersions(lastExportedVersion, version);\n  };\n\n  return {\n    emptyVersion: () => ({}),\n    mergeVersions,\n    exportSnapshot: () => flock.exportFile(),\n    applySnapshot: (snapshot) => {\n      flock.importFile(snapshot);\n      return flock.version();\n    },\n    exportUpdates: (fromVersion) => {\n      const bundle = flock.exportJson(fromVersion);\n      recordExportFrontier(fromVersion);\n      if (!hasEntries(bundle)) {\n        return undefined;\n      }\n      const exportedVersion = extractVersionFromBundle(bundle);\n      recordExportFrontier(exportedVersion);\n      return {\n        updates: [new TextEncoder().encode(JSON.stringify(bundle))],\n        version: exportedVersion,\n      };\n    },\n    applyRemoteUpdates: (updates, remoterVersion) => {\n      let merged = remoterVersion;\n      for (const update of updates) {\n        const bundle = JSON.parse(\n          new TextDecoder().decode(update),\n        ) as ExportBundle;\n        if (!hasEntries(bundle)) {\n          continue;\n        }\n        flock.importJson(bundle);\n        merged = mergeVersions(merged, extractVersionFromBundle(bundle));\n      }\n      return merged;\n    },\n    subscribeLocalUpdates: (listener) => {\n      const unsubscribe = flock.subscribe((batch) => {\n        if (batch.source !== \"local\") {\n          return;\n        }\n        const drain = async () => {\n          const batchPayload = await flock.exportJson({\n            from: lastExportedVersion,\n            peerId: flock.peerId(),\n          });\n          if (!hasEntries(batchPayload)) {\n            return;\n          }\n          recordExportFrontier(flock.version());\n          listener({\n            updates: [new TextEncoder().encode(JSON.stringify(batchPayload))],\n            version: extractVersionFromBundle(batchPayload),\n          });\n        };\n\n        localExportQueue = localExportQueue.then(drain).catch(() => {\n          /* swallow to keep queue alive */\n        });\n      });\n      return unsubscribe;\n    },\n  };\n}\n"],"mappings":";;AAcA,SAAS,QACP,OACA,SACS;AACT,QACE,MAAM,eAAe,QAAQ,gBAC5B,MAAM,iBAAiB,QAAQ,gBAC9B,MAAM,iBAAiB,QAAQ;;AAIrC,SAAS,cACP,MACA,UACe;CACf,MAAM,SAAwB,EAAE,GAAG,MAAM;AACzC,MAAK,MAAM,CAAC,MAAM,UAAU,OAAO,QAAQ,SAAS,EAAE;AACpD,MAAI,SAAS,KACX;EAEF,MAAM,UAAU,OAAO;AACvB,MAAI,WAAW,QAAQ,QAAQ,OAAO,QAAQ,CAC5C,QAAO,QAAQ,EAAE,GAAG,OAAO;;AAG/B,QAAO;;AAGT,SAAS,WACP,QACsD;CACtD,MAAM,aAAa,OAAO,EAAE,QAAQ,IAAI;CACxC,MAAM,cAAc,OAAO,EAAE,QAAQ,KAAK,aAAa,EAAE;AACzD,KAAI,aAAa,KAAK,cAAc,EAClC,QAAO;CAGT,MAAM,eAAe,OAAO,OAAO,EAAE,MAAM,GAAG,WAAW,CAAC;CAC1D,MAAM,iBAAiB,OAAO,OAAO,EAAE,MAAM,aAAa,GAAG,YAAY,CAAC;AAC1E,KAAI,CAAC,OAAO,SAAS,aAAa,IAAI,CAAC,OAAO,SAAS,eAAe,CACpE,QAAO;AAGT,QAAO;EACL,QAAQ,OAAO,EAAE,MAAM,cAAc,EAAE;EACvC,OAAO;GAAE;GAAc;GAAgB;EACxC;;AAGH,SAAS,yBAAyB,QAAqC;CACrE,MAAM,MAAqB,EAAE;AAC7B,MAAK,MAAM,UAAU,OAAO,OAAO,OAAO,QAAQ,EAAE;EAClD,MAAM,SAAS,WAAW,OAAO;AACjC,MAAI,UAAU,KACZ;EAEF,MAAM,UAAU,IAAI,OAAO;AAC3B,MAAI,WAAW,QAAQ,QAAQ,OAAO,OAAO,QAAQ,CACnD,KAAI,OAAO,UAAU,OAAO;;AAGhC,QAAO;;AAGT,SAAS,WAAW,QAA+B;AACjD,QAAO,OAAO,KAAK,OAAO,QAAQ,CAAC,SAAS;;;;;AAM9C,SAAgB,mBAAmB,OAA0C;CAC3E,IAAI,sBAAqC,EAAE;CAC3C,IAAI,mBAAmB,QAAQ,SAAS;CAExC,MAAM,wBAAwB,YAAiC;AAC7D,wBAAsB,cAAc,qBAAqB,QAAQ;;AAGnE,QAAO;EACL,qBAAqB,EAAE;EACvB;EACA,sBAAsB,MAAM,YAAY;EACxC,gBAAgB,aAAa;AAC3B,SAAM,WAAW,SAAS;AAC1B,UAAO,MAAM,SAAS;;EAExB,gBAAgB,gBAAgB;GAC9B,MAAM,SAAS,MAAM,WAAW,YAAY;AAC5C,wBAAqB,YAAY;AACjC,OAAI,CAAC,WAAW,OAAO,CACrB;GAEF,MAAM,kBAAkB,yBAAyB,OAAO;AACxD,wBAAqB,gBAAgB;AACrC,UAAO;IACL,SAAS,CAAC,IAAI,aAAa,CAAC,OAAO,KAAK,UAAU,OAAO,CAAC,CAAC;IAC3D,SAAS;IACV;;EAEH,qBAAqB,SAAS,mBAAmB;GAC/C,IAAI,SAAS;AACb,QAAK,MAAM,UAAU,SAAS;IAC5B,MAAM,SAAS,KAAK,MAClB,IAAI,aAAa,CAAC,OAAO,OAAO,CACjC;AACD,QAAI,CAAC,WAAW,OAAO,CACrB;AAEF,UAAM,WAAW,OAAO;AACxB,aAAS,cAAc,QAAQ,yBAAyB,OAAO,CAAC;;AAElE,UAAO;;EAET,wBAAwB,aAAa;AAwBnC,UAvBoB,MAAM,WAAW,UAAU;AAC7C,QAAI,MAAM,WAAW,QACnB;IAEF,MAAM,QAAQ,YAAY;KACxB,MAAM,eAAe,MAAM,MAAM,WAAW;MAC1C,MAAM;MACN,QAAQ,MAAM,QAAQ;MACvB,CAAC;AACF,SAAI,CAAC,WAAW,aAAa,CAC3B;AAEF,0BAAqB,MAAM,SAAS,CAAC;AACrC,cAAS;MACP,SAAS,CAAC,IAAI,aAAa,CAAC,OAAO,KAAK,UAAU,aAAa,CAAC,CAAC;MACjE,SAAS,yBAAyB,aAAa;MAChD,CAAC;;AAGJ,uBAAmB,iBAAiB,KAAK,MAAM,CAAC,YAAY,GAE1D;KACF;;EAGL"}

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-import { C as IndexedDbRemoteCursorStore, D as RemoteCursorStore, E as RemoteCursorSaveSource, O as createInitialRemoteCursor, S as InMemoryRemoteCursorStore, T as RemoteCursor, _ as TransportRoomStatus, a as CrdtAdapter, b as BeforeRemoteCursorSaveContext, c as JsonValue, d as StreamsAuthProvider, f as StreamsCrdtOptions, g as TransportJoinParams, h as TransportError, i as StreamsCrdt, l as Result, m as TransportDeleteStreamSuccess, n as isValidBucketId, o as CrdtUpdateBatch, p as TransportCreateStreamSuccess, r as isValidRillId, s as JsonObject, t as createStreamUrl, u as SnapshotUploadOptions, v as TransportSubscription, w as IndexedDbRemoteCursorStoreOptions, x as BeforeRemoteCursorSaveHook, y as TransportSyncSuccess } from "./stream-id-1f2mhtmk.js";
-export { BeforeRemoteCursorSaveContext, BeforeRemoteCursorSaveHook, CrdtAdapter, CrdtUpdateBatch, InMemoryRemoteCursorStore, IndexedDbRemoteCursorStore, IndexedDbRemoteCursorStoreOptions, JsonObject, JsonValue, RemoteCursor, RemoteCursorSaveSource, RemoteCursorStore, Result, SnapshotUploadOptions, StreamsAuthProvider, StreamsCrdt, StreamsCrdtOptions, TransportCreateStreamSuccess, TransportDeleteStreamSuccess, TransportError, TransportJoinParams, TransportRoomStatus, TransportSubscription, TransportSyncSuccess, createInitialRemoteCursor, createStreamUrl, isValidBucketId, isValidRillId };
+import { A as createInitialRemoteCursor, C as BeforeRemoteCursorSaveHook, D as RemoteCursor, E as IndexedDbRemoteCursorStoreOptions, O as RemoteCursorSaveSource, S as BeforeRemoteCursorSaveContext, T as IndexedDbRemoteCursorStore, _ as TransportError, a as CrdtAdapter, b as TransportSubscription, c as JsonValue, d as SnapshotTransformHook, f as SnapshotUploadOptions, g as TransportDeleteStreamSuccess, h as TransportCreateStreamSuccess, i as StreamsCrdt, k as RemoteCursorStore, l as Result, m as StreamsCrdtOptions, n as isValidBucketId, o as CrdtUpdateBatch, p as StreamsAuthProvider, r as isValidRillId, s as JsonObject, t as createStreamUrl, u as SnapshotCodec, v as TransportJoinParams, w as InMemoryRemoteCursorStore, x as TransportSyncSuccess, y as TransportRoomStatus } from "./stream-id-BfuQIfcB.js";
+export { BeforeRemoteCursorSaveContext, BeforeRemoteCursorSaveHook, CrdtAdapter, CrdtUpdateBatch, InMemoryRemoteCursorStore, IndexedDbRemoteCursorStore, IndexedDbRemoteCursorStoreOptions, JsonObject, JsonValue, RemoteCursor, RemoteCursorSaveSource, RemoteCursorStore, Result, SnapshotCodec, SnapshotTransformHook, SnapshotUploadOptions, StreamsAuthProvider, StreamsCrdt, StreamsCrdtOptions, TransportCreateStreamSuccess, TransportDeleteStreamSuccess, TransportError, TransportJoinParams, TransportRoomStatus, TransportSubscription, TransportSyncSuccess, createInitialRemoteCursor, createStreamUrl, isValidBucketId, isValidRillId };

package/dist/index.js

@@ -1,2 +1,2 @@
-import { a as InMemoryRemoteCursorStore, i as StreamsCrdt, n as isValidBucketId, o as IndexedDbRemoteCursorStore, r as isValidRillId, s as createInitialRemoteCursor, t as createStreamUrl } from "./stream-id-CIhmveJD.js";
+import { a as InMemoryRemoteCursorStore, i as StreamsCrdt, n as isValidBucketId, o as IndexedDbRemoteCursorStore, r as isValidRillId, s as createInitialRemoteCursor, t as createStreamUrl } from "./stream-id-YOFZ4I6Y.js";
 export { InMemoryRemoteCursorStore, IndexedDbRemoteCursorStore, StreamsCrdt, createInitialRemoteCursor, createStreamUrl, isValidBucketId, isValidRillId };

package/dist/loro.d.ts

@@ -1,4 +1,4 @@
-import { C as IndexedDbRemoteCursorStore, D as RemoteCursorStore, E as RemoteCursorSaveSource, O as createInitialRemoteCursor, S as InMemoryRemoteCursorStore, T as RemoteCursor, _ as TransportRoomStatus, a as CrdtAdapter, b as BeforeRemoteCursorSaveContext, c as JsonValue, d as StreamsAuthProvider, f as StreamsCrdtOptions, g as TransportJoinParams, h as TransportError, i as StreamsCrdt, l as Result, m as TransportDeleteStreamSuccess, n as isValidBucketId, o as CrdtUpdateBatch, p as TransportCreateStreamSuccess, r as isValidRillId, s as JsonObject, t as createStreamUrl, u as SnapshotUploadOptions, v as TransportSubscription, w as IndexedDbRemoteCursorStoreOptions, x as BeforeRemoteCursorSaveHook, y as TransportSyncSuccess } from "./stream-id-1f2mhtmk.js";
+import { A as createInitialRemoteCursor, C as BeforeRemoteCursorSaveHook, D as RemoteCursor, E as IndexedDbRemoteCursorStoreOptions, O as RemoteCursorSaveSource, S as BeforeRemoteCursorSaveContext, T as IndexedDbRemoteCursorStore, _ as TransportError, a as CrdtAdapter, b as TransportSubscription, c as JsonValue, d as SnapshotTransformHook, f as SnapshotUploadOptions, g as TransportDeleteStreamSuccess, h as TransportCreateStreamSuccess, i as StreamsCrdt, k as RemoteCursorStore, l as Result, m as StreamsCrdtOptions, n as isValidBucketId, o as CrdtUpdateBatch, p as StreamsAuthProvider, r as isValidRillId, s as JsonObject, t as createStreamUrl, u as SnapshotCodec, v as TransportJoinParams, w as InMemoryRemoteCursorStore, x as TransportSyncSuccess, y as TransportRoomStatus } from "./stream-id-BfuQIfcB.js";
 import { LoroDoc } from "loro-crdt";
 
 //#region src/loro.d.ts
@@ -18,5 +18,5 @@ import { LoroDoc } from "loro-crdt";
  */
 declare function createLoroDocAdapter(doc: LoroDoc): CrdtAdapter<JsonObject>;
 //#endregion
-export { BeforeRemoteCursorSaveContext, BeforeRemoteCursorSaveHook, CrdtAdapter, CrdtUpdateBatch, InMemoryRemoteCursorStore, IndexedDbRemoteCursorStore, IndexedDbRemoteCursorStoreOptions, JsonObject, JsonValue, RemoteCursor, RemoteCursorSaveSource, RemoteCursorStore, Result, SnapshotUploadOptions, StreamsAuthProvider, StreamsCrdt, StreamsCrdtOptions, TransportCreateStreamSuccess, TransportDeleteStreamSuccess, TransportError, TransportJoinParams, TransportRoomStatus, TransportSubscription, TransportSyncSuccess, createInitialRemoteCursor, createLoroDocAdapter, createStreamUrl, isValidBucketId, isValidRillId };
+export { BeforeRemoteCursorSaveContext, BeforeRemoteCursorSaveHook, CrdtAdapter, CrdtUpdateBatch, InMemoryRemoteCursorStore, IndexedDbRemoteCursorStore, IndexedDbRemoteCursorStoreOptions, JsonObject, JsonValue, RemoteCursor, RemoteCursorSaveSource, RemoteCursorStore, Result, SnapshotCodec, SnapshotTransformHook, SnapshotUploadOptions, StreamsAuthProvider, StreamsCrdt, StreamsCrdtOptions, TransportCreateStreamSuccess, TransportDeleteStreamSuccess, TransportError, TransportJoinParams, TransportRoomStatus, TransportSubscription, TransportSyncSuccess, createInitialRemoteCursor, createLoroDocAdapter, createStreamUrl, isValidBucketId, isValidRillId };
 //# sourceMappingURL=loro.d.ts.map

package/dist/loro.js

@@ -1,4 +1,4 @@
-import { a as InMemoryRemoteCursorStore, i as StreamsCrdt, n as isValidBucketId, o as IndexedDbRemoteCursorStore, r as isValidRillId, s as createInitialRemoteCursor, t as createStreamUrl } from "./stream-id-CIhmveJD.js";
+import { a as InMemoryRemoteCursorStore, i as StreamsCrdt, n as isValidBucketId, o as IndexedDbRemoteCursorStore, r as isValidRillId, s as createInitialRemoteCursor, t as createStreamUrl } from "./stream-id-YOFZ4I6Y.js";
 import { VersionVector, decodeImportBlobMeta } from "loro-crdt";
 //#region src/loro.ts
 function toDocVersionRecord(version) {

package/dist/{stream-id-1f2mhtmk.d.ts → stream-id-BfuQIfcB.d.ts}

@@ -119,10 +119,13 @@ type JsonPrimitive = string | number | boolean | null;
  */
 type JsonValue = JsonPrimitive | JsonObject | JsonValue[];
 /**
- * JSON object shape used by public transport types.
+ * JSON-like object shape used by public transport types.
+ *
+ * Sparse records may expose `undefined` for omitted keys at runtime (for
+ * example Flock's `VersionVector` index signature), so object fields allow it.
  */
 type JsonObject = {
-  readonly [key: string]: JsonValue;
+  readonly [key: string]: JsonValue | undefined;
 };
 /**
  * Authorization source for gateway requests.
@@ -239,6 +242,24 @@ interface SnapshotUploadOptions {
   /** Minimum byte delta since the last remote snapshot before uploading. */
   readonly minBytesSinceRemoteSnapshot?: number;
 }
+/**
+ * Transforms a remote snapshot payload during upload or bootstrap.
+ */
+type SnapshotTransformHook = (snapshot: Uint8Array) => MaybePromise<Uint8Array>;
+/**
+ * Optional snapshot codec hooks used only for full snapshot upload/bootstrap.
+ *
+ * `compress` runs before transport uploads a snapshot to Loro Streams.
+ * `decompress` runs after transport downloads a non-empty snapshot and before
+ * the adapter imports it.
+ *
+ * Callers own compatibility with any snapshots that were already uploaded
+ * without this codec or with an older codec revision.
+ */
+interface SnapshotCodec {
+  readonly compress: SnapshotTransformHook;
+  readonly decompress: SnapshotTransformHook;
+}
 /**
  * Active live subscription returned by `join()`.
  *
@@ -334,6 +355,17 @@ interface StreamsCrdtOptions<TVersion extends JsonObject> {
    * hooks.
    */
   readonly beforeRemoteCursorSaveHooks?: ReadonlyArray<BeforeRemoteCursorSaveHook<TVersion>>;
+  /**
+   * Optional codec hooks for full snapshots only.
+   *
+   * Both hooks must be provided together. If set, transport compresses the
+   * adapter snapshot before upload and decompresses downloaded snapshots before
+   * `applySnapshot()`.
+   *
+   * Callers must keep compatibility with any older snapshots already stored on
+   * the server.
+   */
+  readonly snapshotCodec?: SnapshotCodec;
   readonly snapshotUpload?: SnapshotUploadOptions;
   readonly reconnectConfig?: Partial<ReconnectConfig>;
   readonly debug?: boolean;
@@ -459,5 +491,5 @@ declare function createStreamUrl(input: {
   baseUrl?: string;
 }): string;
 //#endregion
-export { IndexedDbRemoteCursorStore as C, RemoteCursorStore as D, RemoteCursorSaveSource as E, createInitialRemoteCursor as O, InMemoryRemoteCursorStore as S, RemoteCursor as T, TransportRoomStatus as _, CrdtAdapter as a, BeforeRemoteCursorSaveContext as b, JsonValue as c, StreamsAuthProvider as d, StreamsCrdtOptions as f, TransportJoinParams as g, TransportError as h, StreamsCrdt as i, Result as l, TransportDeleteStreamSuccess as m, isValidBucketId as n, CrdtUpdateBatch as o, TransportCreateStreamSuccess as p, isValidRillId as r, JsonObject as s, createStreamUrl as t, SnapshotUploadOptions as u, TransportSubscription as v, IndexedDbRemoteCursorStoreOptions as w, BeforeRemoteCursorSaveHook as x, TransportSyncSuccess as y };
-//# sourceMappingURL=stream-id-1f2mhtmk.d.ts.map
+export { createInitialRemoteCursor as A, BeforeRemoteCursorSaveHook as C, RemoteCursor as D, IndexedDbRemoteCursorStoreOptions as E, RemoteCursorSaveSource as O, BeforeRemoteCursorSaveContext as S, IndexedDbRemoteCursorStore as T, TransportError as _, CrdtAdapter as a, TransportSubscription as b, JsonValue as c, SnapshotTransformHook as d, SnapshotUploadOptions as f, TransportDeleteStreamSuccess as g, TransportCreateStreamSuccess as h, StreamsCrdt as i, RemoteCursorStore as k, Result as l, StreamsCrdtOptions as m, isValidBucketId as n, CrdtUpdateBatch as o, StreamsAuthProvider as p, isValidRillId as r, JsonObject as s, createStreamUrl as t, SnapshotCodec as u, TransportJoinParams as v, InMemoryRemoteCursorStore as w, TransportSyncSuccess as x, TransportRoomStatus as y };
+//# sourceMappingURL=stream-id-BfuQIfcB.d.ts.map

package/dist/{stream-id-CIhmveJD.js → stream-id-YOFZ4I6Y.js}

@@ -589,6 +589,18 @@ function normalizeSnapshotUploadConfig(config) {
 		minBytesSinceRemoteSnapshot: BigInt(Math.floor(minBytes))
 	};
 }
+function assertSnapshotBytes(value, label) {
+	if (value instanceof Uint8Array) return value;
+	throw new Error(`${label} must return Uint8Array`);
+}
+function normalizeSnapshotCodec(codec) {
+	if (codec == null) return;
+	if (typeof codec.compress !== "function" || typeof codec.decompress !== "function") throw new Error("snapshotCodec.compress and snapshotCodec.decompress must be provided together");
+	return {
+		compress: async (snapshot) => assertSnapshotBytes(await codec.compress(snapshot), "snapshotCodec.compress"),
+		decompress: async (snapshot) => assertSnapshotBytes(await codec.decompress(snapshot), "snapshotCodec.decompress")
+	};
+}
 function jsonValueEquals(a, b) {
 	if (a === b) return true;
 	if (typeof a !== typeof b || a == null || b == null) return false;
@@ -1003,14 +1015,16 @@ var StreamsTransportClient = class {
 //#region src/transport-cursor.ts
 var TransportCursorManager = class {
 	adapter;
+	decodeSnapshot;
 	saveRemoteCursor;
 	constructor(options) {
 		this.adapter = options.adapter;
+		this.decodeSnapshot = options.decodeSnapshot;
 		this.saveRemoteCursor = options.saveRemoteCursor;
 	}
 	async applyBootstrapPayload(cursor, snapshot, updates, nextOffset) {
 		let nextVersion = cursor.serverLowerBoundVersion;
-		if (snapshot.byteLength > 0) nextVersion = await this.adapter.applySnapshot(snapshot);
+		if (snapshot.byteLength > 0) nextVersion = await this.adapter.applySnapshot(this.decodeSnapshot == null ? snapshot : await this.decodeSnapshot(snapshot));
 		if (updates.length > 0) nextVersion = await this.adapter.applyRemoteUpdates([...updates], nextVersion);
 		return await this.saveRemoteCursor({
 			...cursor,
@@ -1194,6 +1208,7 @@ function createTransportSnapshotState() {
 var TransportSnapshotManager = class {
 	adapter;
 	config;
+	encodeSnapshot;
 	readSnapshotOffsetValue;
 	putSnapshotAt;
 	enqueueExclusive;
@@ -1203,6 +1218,7 @@ var TransportSnapshotManager = class {
 	constructor(options) {
 		this.adapter = options.adapter;
 		this.config = options.config;
+		this.encodeSnapshot = options.encodeSnapshot;
 		this.readSnapshotOffsetValue = options.readSnapshotOffsetValue;
 		this.putSnapshotAt = options.putSnapshotAt;
 		this.enqueueExclusive = options.enqueueExclusive;
@@ -1273,7 +1289,7 @@ var TransportSnapshotManager = class {
 			if (tailBytes <= snapshotBytes) return;
 			if (tailBytes - snapshotBytes < config.minBytesSinceRemoteSnapshot) return;
 			const snapshot = this.adapter.exportSnapshot();
-			await this.putSnapshotAt(state.cursor.nextOffset, snapshot);
+			await this.putSnapshotAt(state.cursor.nextOffset, this.encodeSnapshot == null ? snapshot : await this.encodeSnapshot(snapshot));
 		} catch (error) {
 			this.logError("snapshot upload failed", error);
 		}
@@ -1367,6 +1383,7 @@ var StreamsCrdt = class StreamsCrdt {
 		};
 		this.debug = options.debug ?? false;
 		this.beforeRemoteCursorSave = composeBeforeRemoteCursorSaveHooks(options.beforeRemoteCursorSave, ...options.beforeRemoteCursorSaveHooks ?? []);
+		const snapshotCodec = normalizeSnapshotCodec(options.snapshotCodec);
 		const snapshotUploadConfig = normalizeSnapshotUploadConfig(options.snapshotUpload);
 		this.client = new StreamsTransportClient({
 			streamUrl: this.streamUrl,
@@ -1377,11 +1394,13 @@ var StreamsCrdt = class StreamsCrdt {
 		});
 		this.cursorManager = new TransportCursorManager({
 			adapter: this.adapter,
+			decodeSnapshot: snapshotCodec?.decompress,
 			saveRemoteCursor: (cursor, source) => this.saveRemoteCursor(cursor, source)
 		});
 		this.snapshotManager = new TransportSnapshotManager({
 			adapter: this.adapter,
 			config: snapshotUploadConfig,
+			encodeSnapshot: snapshotCodec?.compress,
 			readSnapshotOffsetValue: () => this.readSnapshotOffsetValue(),
 			putSnapshotAt: (snapshotOffset, snapshot) => this.putSnapshotAt(snapshotOffset, snapshot),
 			enqueueExclusive: (task) => this.enqueueExclusive(task),
@@ -2148,4 +2167,4 @@ function createStreamUrl(input) {
 //#endregion
 export { InMemoryRemoteCursorStore as a, StreamsCrdt as i, isValidBucketId as n, IndexedDbRemoteCursorStore as o, isValidRillId as r, createInitialRemoteCursor as s, createStreamUrl as t };
 
-//# sourceMappingURL=stream-id-CIhmveJD.js.map
+//# sourceMappingURL=stream-id-YOFZ4I6Y.js.map