@automerge/automerge-repo 1.0.12 → 1.0.14

package/dist/AutomergeUrl.d.ts

@@ -0,0 +1,45 @@
+import type { LegacyDocumentId, AutomergeUrl, BinaryDocumentId, DocumentId, AnyDocumentId } from "./types.js";
+export declare const urlPrefix = "automerge:";
+/** Given an Automerge URL, returns the DocumentId in both base58check-encoded form and binary form */
+export declare const parseAutomergeUrl: (url: AutomergeUrl) => {
+    /** unencoded DocumentId */
+    binaryDocumentId: BinaryDocumentId;
+    /** encoded DocumentId */
+    documentId: DocumentId;
+};
+/**
+ * Given a documentId in either binary or base58check-encoded form, returns an Automerge URL.
+ * Throws on invalid input.
+ */
+export declare const stringifyAutomergeUrl: (arg: UrlOptions | DocumentId | BinaryDocumentId) => AutomergeUrl;
+/**
+ * Given a string, returns true if it is a valid Automerge URL. This function also acts as a type
+ * discriminator in Typescript.
+ */
+export declare const isValidAutomergeUrl: (str: string | undefined | null) => str is AutomergeUrl;
+export declare const isValidDocumentId: (str: string) => str is DocumentId;
+export declare const isValidUuid: (str: string) => str is LegacyDocumentId;
+/**
+ * Returns a new Automerge URL with a random UUID documentId. Called by Repo.create(), and also used by tests.
+ */
+export declare const generateAutomergeUrl: () => AutomergeUrl;
+export declare const documentIdToBinary: (docId: DocumentId) => BinaryDocumentId | undefined;
+export declare const binaryToDocumentId: (docId: BinaryDocumentId) => DocumentId;
+export declare const parseLegacyUUID: (str: string) => AutomergeUrl | undefined;
+/**
+ * Given any valid expression of a document ID, returns a DocumentId in base58check-encoded form.
+ *
+ * Currently supports:
+ * - base58check-encoded DocumentId
+ * - Automerge URL
+ * - legacy UUID
+ * - binary DocumentId
+ *
+ * Throws on invalid input.
+ */
+export declare const interpretAsDocumentId: (id: AnyDocumentId) => DocumentId;
+type UrlOptions = {
+    documentId: DocumentId | BinaryDocumentId;
+};
+export {};
+//# sourceMappingURL=AutomergeUrl.d.ts.map

package/dist/AutomergeUrl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AutomergeUrl.d.ts","sourceRoot":"","sources":["../src/AutomergeUrl.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,UAAU,EACV,aAAa,EACd,MAAM,YAAY,CAAA;AAInB,eAAO,MAAM,SAAS,eAAe,CAAA;AAErC,sGAAsG;AACtG,eAAO,MAAM,iBAAiB,QAAS,YAAY;IAQ/C,2BAA2B;;IAE3B,yBAAyB;;CAG5B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,QAC3B,UAAU,GAAG,UAAU,GAAG,gBAAgB,iBAoBhD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,QACzB,MAAM,GAAG,SAAS,GAAG,IAAI,wBAU/B,CAAA;AAED,eAAO,MAAM,iBAAiB,QAAS,MAAM,sBAQ5C,CAAA;AAED,eAAO,MAAM,WAAW,QAAS,MAAM,4BACnB,CAAA;AAEpB;;GAEG;AACH,eAAO,MAAM,oBAAoB,QAAO,YAGvC,CAAA;AAED,eAAO,MAAM,kBAAkB,UAAW,UAAU,iCACW,CAAA;AAE/D,eAAO,MAAM,kBAAkB,UAAW,gBAAgB,eACnB,CAAA;AAEvC,eAAO,MAAM,eAAe,QAAS,MAAM,6BAI1C,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,OAAQ,aAAa,eAqBtD,CAAA;AAID,KAAK,UAAU,GAAG;IAChB,UAAU,EAAE,UAAU,GAAG,gBAAgB,CAAA;CAC1C,CAAA"}

package/dist/AutomergeUrl.js

@@ -0,0 +1,108 @@
+import * as Uuid from "uuid";
+import bs58check from "bs58check";
+export const urlPrefix = "automerge:";
+/** Given an Automerge URL, returns the DocumentId in both base58check-encoded form and binary form */
+export const parseAutomergeUrl = (url) => {
+    const regex = new RegExp(`^${urlPrefix}(\\w+)$`);
+    const [_, docMatch] = url.match(regex) || [];
+    const documentId = docMatch;
+    const binaryDocumentId = documentIdToBinary(documentId);
+    if (!binaryDocumentId)
+        throw new Error("Invalid document URL: " + url);
+    return {
+        /** unencoded DocumentId */
+        binaryDocumentId,
+        /** encoded DocumentId */
+        documentId,
+    };
+};
+/**
+ * Given a documentId in either binary or base58check-encoded form, returns an Automerge URL.
+ * Throws on invalid input.
+ */
+export const stringifyAutomergeUrl = (arg) => {
+    let documentId = arg instanceof Uint8Array || typeof arg === "string"
+        ? arg
+        : "documentId" in arg
+            ? arg.documentId
+            : undefined;
+    const encodedDocumentId = documentId instanceof Uint8Array
+        ? binaryToDocumentId(documentId)
+        : typeof documentId === "string"
+            ? documentId
+            : undefined;
+    if (encodedDocumentId === undefined)
+        throw new Error("Invalid documentId: " + documentId);
+    return (urlPrefix + encodedDocumentId);
+};
+/**
+ * Given a string, returns true if it is a valid Automerge URL. This function also acts as a type
+ * discriminator in Typescript.
+ */
+export const isValidAutomergeUrl = (str) => {
+    if (!str || !str.startsWith(urlPrefix))
+        return false;
+    const automergeUrl = str;
+    try {
+        const { documentId } = parseAutomergeUrl(automergeUrl);
+        return isValidDocumentId(documentId);
+    }
+    catch {
+        return false;
+    }
+};
+export const isValidDocumentId = (str) => {
+    // try to decode from base58
+    const binaryDocumentID = documentIdToBinary(str);
+    if (binaryDocumentID === undefined)
+        return false; // invalid base58check encoding
+    // confirm that the document ID is a valid UUID
+    const documentId = Uuid.stringify(binaryDocumentID);
+    return Uuid.validate(documentId);
+};
+export const isValidUuid = (str) => Uuid.validate(str);
+/**
+ * Returns a new Automerge URL with a random UUID documentId. Called by Repo.create(), and also used by tests.
+ */
+export const generateAutomergeUrl = () => {
+    const documentId = Uuid.v4(null, new Uint8Array(16));
+    return stringifyAutomergeUrl({ documentId });
+};
+export const documentIdToBinary = (docId) => bs58check.decodeUnsafe(docId);
+export const binaryToDocumentId = (docId) => bs58check.encode(docId);
+export const parseLegacyUUID = (str) => {
+    if (!Uuid.validate(str))
+        return undefined;
+    const documentId = Uuid.parse(str);
+    return stringifyAutomergeUrl({ documentId });
+};
+/**
+ * Given any valid expression of a document ID, returns a DocumentId in base58check-encoded form.
+ *
+ * Currently supports:
+ * - base58check-encoded DocumentId
+ * - Automerge URL
+ * - legacy UUID
+ * - binary DocumentId
+ *
+ * Throws on invalid input.
+ */
+export const interpretAsDocumentId = (id) => {
+    // binary
+    if (id instanceof Uint8Array)
+        return binaryToDocumentId(id);
+    // url
+    if (isValidAutomergeUrl(id))
+        return parseAutomergeUrl(id).documentId;
+    // base58check
+    if (isValidDocumentId(id))
+        return id;
+    // legacy UUID
+    if (isValidUuid(id)) {
+        console.warn("Future versions will not support UUIDs as document IDs; use Automerge URLs instead.");
+        const binaryDocumentID = Uuid.parse(id);
+        return binaryToDocumentId(binaryDocumentID);
+    }
+    // none of the above
+    throw new Error(`Invalid AutomergeUrl: '${id}'`);
+};

package/dist/DocHandle.js

@@ -3,7 +3,7 @@ import debug from "debug";
 import { EventEmitter } from "eventemitter3";
 import { assign, createMachine, interpret, } from "xstate";
 import { waitFor } from "xstate/lib/waitFor.js";
-import { stringifyAutomergeUrl } from "./DocUrl.js";
+import { stringifyAutomergeUrl } from "./AutomergeUrl.js";
 import { encode } from "./helpers/cbor.js";
 import { headsAreSame } from "./helpers/headsAreSame.js";
 import { withTimeout } from "./helpers/withTimeout.js";

package/dist/Repo.d.ts

@@ -4,7 +4,7 @@ import { NetworkAdapter } from "./network/NetworkAdapter.js";
 import { NetworkSubsystem } from "./network/NetworkSubsystem.js";
 import { StorageAdapter } from "./storage/StorageAdapter.js";
 import { StorageSubsystem } from "./storage/StorageSubsystem.js";
-import { DocumentId, PeerId, type AutomergeUrl } from "./types.js";
+import type { AnyDocumentId, DocumentId, PeerId } from "./types.js";
 /** A Repo is a collection of documents with networking, syncing, and storage capabilities. */
 /** The `Repo` is the main entry point of this library
  *
@@ -55,11 +55,11 @@ export declare class Repo extends EventEmitter<RepoEvents> {
      * event to advertise interest in the document.
      */
     find<T>(
-    /** The documentId of the handle to retrieve */
-    automergeUrl: AutomergeUrl): DocHandle<T>;
+    /** The url or documentId of the handle to retrieve */
+    id: AnyDocumentId): DocHandle<T>;
     delete(
-    /** The documentId of the handle to delete */
-    id: DocumentId | AutomergeUrl): void;
+    /** The url or documentId of the handle to delete */
+    id: AnyDocumentId): void;
 }
 export interface RepoConfig {
     /** Our unique identifier */

package/dist/Repo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,SAAS,EAAiC,MAAM,gBAAgB,CAAA;AAQzE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAA;AAElE,8FAA8F;AAC9F;;;;;;GAMG;AACH,qBAAa,IAAK,SAAQ,YAAY,CAAC,UAAU,CAAC;;IAGhD,cAAc;IACd,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,cAAc;IACd,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAEnC,mDAAmD;IACnD,cAAc;IACd,gBAAgB,SAAM;IAItB,sDAAsD;IACtD,cAAc;IACd,WAAW,EAAE,WAAW,CAAmB;gBAE/B,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,UAAU;IA8HjE,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED;;;;OAIG;IACH,MAAM,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;IA0BzB;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAuBnC;;;OAGG;IACH,IAAI,CAAC,CAAC;IACJ,+CAA+C;IAC/C,YAAY,EAAE,YAAY,GACzB,SAAS,CAAC,CAAC,CAAC;IAgCf,MAAM;IACJ,6CAA6C;IAC7C,EAAE,EAAE,UAAU,GAAG,YAAY;CAUhC;AAED,MAAM,WAAW,UAAU;IACzB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,gDAAgD;IAChD,OAAO,CAAC,EAAE,cAAc,CAAA;IAExB,oDAAoD;IACpD,OAAO,EAAE,cAAc,EAAE,CAAA;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAGrB,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,6BAA6B;IAC7B,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,4FAA4F;IAC5F,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;CAC7D;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;IACtB,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAA;CACvB"}
+{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAM5C,OAAO,EAAE,SAAS,EAAiC,MAAM,gBAAgB,CAAA;AAEzE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAA;AAEhE,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAEnE,8FAA8F;AAC9F;;;;;;GAMG;AACH,qBAAa,IAAK,SAAQ,YAAY,CAAC,UAAU,CAAC;;IAGhD,cAAc;IACd,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,cAAc;IACd,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAEnC,mDAAmD;IACnD,cAAc;IACd,gBAAgB,SAAM;IAItB,sDAAsD;IACtD,cAAc;IACd,WAAW,EAAE,WAAW,CAAmB;gBAE/B,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,UAAU;IA8HjE,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED;;;;OAIG;IACH,MAAM,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;IA0BzB;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAuBnC;;;OAGG;IACH,IAAI,CAAC,CAAC;IACJ,sDAAsD;IACtD,EAAE,EAAE,aAAa,GAChB,SAAS,CAAC,CAAC,CAAC;IAqBf,MAAM;IACJ,oDAAoD;IACpD,EAAE,EAAE,aAAa;CAUpB;AAED,MAAM,WAAW,UAAU;IACzB,4BAA4B;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,gDAAgD;IAChD,OAAO,CAAC,EAAE,cAAc,CAAA;IAExB,oDAAoD;IACpD,OAAO,EAAE,cAAc,EAAE,CAAA;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAED;;;;;;;KAOK;AACL,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAGrB,MAAM,WAAW,UAAU;IACzB,+CAA+C;IAC/C,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,6BAA6B;IAC7B,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,4FAA4F;IAC5F,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;CAC7D;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;IACtB,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,UAAU,CAAA;CACvB"}

package/dist/Repo.js

@@ -1,8 +1,8 @@
 import { next as Automerge } from "@automerge/automerge";
 import debug from "debug";
 import { EventEmitter } from "eventemitter3";
+import { generateAutomergeUrl, interpretAsDocumentId, parseAutomergeUrl, } from "./AutomergeUrl.js";
 import { DocHandle } from "./DocHandle.js";
-import { generateAutomergeUrl, isValidAutomergeUrl, parseAutomergeUrl, parseLegacyUUID, } from "./DocUrl.js";
 import { throttle } from "./helpers/throttle.js";
 import { NetworkSubsystem } from "./network/NetworkSubsystem.js";
 import { StorageSubsystem } from "./storage/StorageSubsystem.js";
@@ -81,7 +81,7 @@ export class Repo extends EventEmitter {
             // TODO Pass the delete on to the network
             // synchronizer.removeDocument(documentId)
             if (storageSubsystem) {
-                storageSubsystem.remove(documentId).catch(err => {
+                storageSubsystem.removeDoc(documentId).catch(err => {
                     this.#log("error deleting document", { documentId, err });
                 });
             }
@@ -198,19 +198,9 @@ export class Repo extends EventEmitter {
      * event to advertise interest in the document.
      */
     find(
-    /** The documentId of the handle to retrieve */
-    automergeUrl) {
-        if (!isValidAutomergeUrl(automergeUrl)) {
-            const maybeAutomergeUrl = parseLegacyUUID(automergeUrl);
-            if (maybeAutomergeUrl) {
-                console.warn("Legacy UUID document ID detected, converting to AutomergeUrl. This will be removed in a future version.");
-                automergeUrl = maybeAutomergeUrl;
-            }
-            else {
-                throw new Error(`Invalid AutomergeUrl: '${automergeUrl}'`);
-            }
-        }
-        const { documentId } = parseAutomergeUrl(automergeUrl);
+    /** The url or documentId of the handle to retrieve */
+    id) {
+        const documentId = interpretAsDocumentId(id);
         // If we have the handle cached, return it
         if (this.#handleCache[documentId]) {
             if (this.#handleCache[documentId].isUnavailable()) {
@@ -228,13 +218,12 @@ export class Repo extends EventEmitter {
         return handle;
     }
     delete(
-    /** The documentId of the handle to delete */
+    /** The url or documentId of the handle to delete */
     id) {
-        if (isValidAutomergeUrl(id))
-            id = parseAutomergeUrl(id).documentId;
-        const handle = this.#getHandle(id, false);
+        const documentId = interpretAsDocumentId(id);
+        const handle = this.#getHandle(documentId, false);
         handle.delete();
-        delete this.#handleCache[id];
-        this.emit("delete-document", { documentId: id });
+        delete this.#handleCache[documentId];
+        this.emit("delete-document", { documentId });
     }
 }

package/dist/helpers/cbor.js

@@ -1,6 +1,6 @@
 import { Encoder, decode as cborXdecode } from "cbor-x";
 export function encode(obj) {
-    const encoder = new Encoder({ tagUint8Array: false });
+    const encoder = new Encoder({ tagUint8Array: false, useRecords: false });
     return encoder.encode(obj);
 }
 export function decode(buf) {

package/dist/index.d.ts

@@ -26,7 +26,7 @@
  * ```
  */
 export { DocHandle } from "./DocHandle.js";
-export { isValidAutomergeUrl, parseAutomergeUrl, stringifyAutomergeUrl, } from "./DocUrl.js";
+export { isValidAutomergeUrl, parseAutomergeUrl, stringifyAutomergeUrl, } from "./AutomergeUrl.js";
 export { Repo } from "./Repo.js";
 export { NetworkAdapter } from "./network/NetworkAdapter.js";
 export { isValidRepoMessage } from "./network/messages.js";
@@ -36,7 +36,7 @@ export * as cbor from "./helpers/cbor.js";
 export type { DocHandleChangePayload, DocHandleDeletePayload, DocHandleEncodedChangePayload, DocHandleEphemeralMessagePayload, DocHandleEvents, DocHandleOptions, DocHandleOutboundEphemeralMessagePayload, HandleState, } from "./DocHandle.js";
 export type { DeleteDocumentPayload, DocumentPayload, RepoConfig, RepoEvents, SharePolicy, } from "./Repo.js";
 export type { NetworkAdapterEvents, OpenPayload, PeerCandidatePayload, PeerDisconnectedPayload, } from "./network/NetworkAdapter.js";
-export type { ArriveMessage, DocumentUnavailableMessage, EphemeralMessage, Message, RepoMessage, RequestMessage, SyncMessage, WelcomeMessage, } from "./network/messages.js";
-export type { StorageKey } from "./storage/StorageAdapter.js";
+export type { DocumentUnavailableMessage, EphemeralMessage, Message, RepoMessage, RequestMessage, SyncMessage, } from "./network/messages.js";
+export type { Chunk, ChunkInfo, ChunkType, StorageKey, } from "./storage/types.js";
 export * from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAE5D,eAAe;AACf,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAA;AAIzC,YAAY,EACV,sBAAsB,EACtB,sBAAsB,EACtB,6BAA6B,EAC7B,gCAAgC,EAChC,eAAe,EACf,gBAAgB,EAChB,wCAAwC,EACxC,WAAW,GACZ,MAAM,gBAAgB,CAAA;AACvB,YAAY,EACV,qBAAqB,EACrB,eAAe,EACf,UAAU,EACV,UAAU,EACV,WAAW,GACZ,MAAM,WAAW,CAAA;AAClB,YAAY,EACV,oBAAoB,EACpB,WAAW,EACX,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,6BAA6B,CAAA;AACpC,YAAY,EACV,aAAa,EACb,0BAA0B,EAC1B,gBAAgB,EAChB,OAAO,EACP,WAAW,EACX,cAAc,EACd,WAAW,EACX,cAAc,GACf,MAAM,uBAAuB,CAAA;AAC9B,YAAY,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAA;AAC7D,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,GACtB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAA;AAE5D,eAAe;AACf,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAA;AAIzC,YAAY,EACV,sBAAsB,EACtB,sBAAsB,EACtB,6BAA6B,EAC7B,gCAAgC,EAChC,eAAe,EACf,gBAAgB,EAChB,wCAAwC,EACxC,WAAW,GACZ,MAAM,gBAAgB,CAAA;AAEvB,YAAY,EACV,qBAAqB,EACrB,eAAe,EACf,UAAU,EACV,UAAU,EACV,WAAW,GACZ,MAAM,WAAW,CAAA;AAElB,YAAY,EACV,oBAAoB,EACpB,WAAW,EACX,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,6BAA6B,CAAA;AAEpC,YAAY,EACV,0BAA0B,EAC1B,gBAAgB,EAChB,OAAO,EACP,WAAW,EACX,cAAc,EACd,WAAW,GACZ,MAAM,uBAAuB,CAAA;AAE9B,YAAY,EACV,KAAK,EACL,SAAS,EACT,SAAS,EACT,UAAU,GACX,MAAM,oBAAoB,CAAA;AAE3B,cAAc,YAAY,CAAA"}

package/dist/index.js

@@ -26,7 +26,7 @@
  * ```
  */
 export { DocHandle } from "./DocHandle.js";
-export { isValidAutomergeUrl, parseAutomergeUrl, stringifyAutomergeUrl, } from "./DocUrl.js";
+export { isValidAutomergeUrl, parseAutomergeUrl, stringifyAutomergeUrl, } from "./AutomergeUrl.js";
 export { Repo } from "./Repo.js";
 export { NetworkAdapter } from "./network/NetworkAdapter.js";
 export { isValidRepoMessage } from "./network/messages.js";

package/dist/network/NetworkAdapter.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter } from "eventemitter3";
 import { PeerId } from "../types.js";
-import { RepoMessage } from "./messages.js";
+import { Message } from "./messages.js";
 /** An interface representing some way to connect to other peers
  *
  * @remarks
@@ -19,7 +19,7 @@ export declare abstract class NetworkAdapter extends EventEmitter<NetworkAdapter
      *
      * @argument message - the message to send
      */
-    abstract send(message: RepoMessage): void;
+    abstract send(message: Message): void;
     /** Called by the {@link Repo} to disconnect from the network */
     abstract disconnect(): void;
 }
@@ -33,7 +33,7 @@ export interface NetworkAdapterEvents {
     /** Emitted when the network adapter learns that a peer has disconnected */
     "peer-disconnected": (payload: PeerDisconnectedPayload) => void;
     /** Emitted when the network adapter receives a message from a peer */
-    message: (payload: RepoMessage) => void;
+    message: (payload: Message) => void;
 }
 export interface OpenPayload {
     network: NetworkAdapter;

package/dist/network/NetworkAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NetworkAdapter.d.ts","sourceRoot":"","sources":["../../src/network/NetworkAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE3C;;;;;;GAMG;AACH,8BAAsB,cAAe,SAAQ,YAAY,CAAC,oBAAoB,CAAC;IAC7E,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAEtC;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAEzC,gEAAgE;IAChE,QAAQ,CAAC,UAAU,IAAI,IAAI;CAC5B;AAID,MAAM,WAAW,oBAAoB;IACnC,mDAAmD;IACnD,KAAK,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;IAErC,yCAAyC;IACzC,KAAK,EAAE,MAAM,IAAI,CAAA;IAEjB,+DAA+D;IAC/D,gBAAgB,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAEzD,2EAA2E;IAC3E,mBAAmB,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,IAAI,CAAA;IAE/D,sEAAsE;IACtE,OAAO,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;CACxC;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,cAAc,CAAA;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAA;CACf"}
+{"version":3,"file":"NetworkAdapter.d.ts","sourceRoot":"","sources":["../../src/network/NetworkAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAA;AAEvC;;;;;;GAMG;AACH,8BAAsB,cAAe,SAAQ,YAAY,CAAC,oBAAoB,CAAC;IAC7E,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAEtC;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAErC,gEAAgE;IAChE,QAAQ,CAAC,UAAU,IAAI,IAAI;CAC5B;AAID,MAAM,WAAW,oBAAoB;IACnC,mDAAmD;IACnD,KAAK,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,IAAI,CAAA;IAErC,yCAAyC;IACzC,KAAK,EAAE,MAAM,IAAI,CAAA;IAEjB,+DAA+D;IAC/D,gBAAgB,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAEzD,2EAA2E;IAC3E,mBAAmB,EAAE,CAAC,OAAO,EAAE,uBAAuB,KAAK,IAAI,CAAA;IAE/D,sEAAsE;IACtE,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;CACpC;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,cAAc,CAAA;CACxB;AAED,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAA;CACf"}

package/dist/network/messages.d.ts

@@ -65,31 +65,20 @@ export type RequestMessage = {
     /** The document ID this message requests */
     documentId: DocumentId;
 };
-/** Notify the network that we have arrived so everyone knows our peer ID */
-export type ArriveMessage = {
-    type: "arrive";
+/** (anticipating work in progress) */
+export type AuthMessage<TPayload = any> = {
+    type: "auth";
     /** The peer ID of the sender of this message */
     senderId: PeerId;
-    /** Arrive messages don't have a targetId */
-    targetId: never;
-};
-/** Respond to an arriving peer with our peer ID */
-export type WelcomeMessage = {
-    type: "welcome";
-    /** The peer ID of the recipient sender this message */
-    senderId: PeerId;
     /** The peer ID of the recipient of this message */
     targetId: PeerId;
+    /** The payload of the auth message (up to the specific auth provider) */
+    payload: TPayload;
 };
 /** These are message types that a {@link NetworkAdapter} surfaces to a {@link Repo}. */
 export type RepoMessage = SyncMessage | EphemeralMessage | RequestMessage | DocumentUnavailableMessage;
-/** These are all the message types that a {@link NetworkAdapter} might see.
- *
- * @remarks
- * It is not _required_ that a {@link NetworkAdapter} use these types: They are free to use
- * whatever message type makes sense for their transport. However, this type is a useful default.
- * */
-export type Message = RepoMessage | ArriveMessage | WelcomeMessage;
+/** These are all the message types that a {@link NetworkAdapter} might see. */
+export type Message = RepoMessage | AuthMessage;
 /**
  * The contents of a message, without the sender ID or other properties added by the {@link NetworkSubsystem})
  */

package/dist/network/messages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/network/messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE3D;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IAEZ,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,iCAAiC;IACjC,IAAI,EAAE,UAAU,CAAA;IAEhB,0DAA0D;IAC1D,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED;;;;;;;;;KASK;AACL,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,WAAW,CAAA;IAEjB,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,qFAAqF;IACrF,KAAK,EAAE,MAAM,CAAA;IAEb,8GAA8G;IAC9G,SAAS,EAAE,SAAS,CAAA;IAEpB,+CAA+C;IAC/C,UAAU,EAAE,UAAU,CAAA;IAEtB,qCAAqC;IACrC,IAAI,EAAE,UAAU,CAAA;CACjB,CAAA;AAED,uHAAuH;AACvH,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,iBAAiB,CAAA;IAEvB,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,yDAAyD;IACzD,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED;;;;;KAKK;AACL,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,SAAS,CAAA;IAEf,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,yCAAyC;IACzC,IAAI,EAAE,UAAU,CAAA;IAEhB,4CAA4C;IAC5C,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED,4EAA4E;AAC5E,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,QAAQ,CAAA;IAEd,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,4CAA4C;IAC5C,QAAQ,EAAE,KAAK,CAAA;CAChB,CAAA;AAED,mDAAmD;AACnD,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,SAAS,CAAA;IAEf,uDAAuD;IACvD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,wFAAwF;AACxF,MAAM,MAAM,WAAW,GACnB,WAAW,GACX,gBAAgB,GAChB,cAAc,GACd,0BAA0B,CAAA;AAE9B;;;;;KAKK;AACL,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,aAAa,GAAG,cAAc,CAAA;AAElE;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IACrD,CAAC,SAAS,gBAAgB,GACtB,IAAI,CAAC,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,WAAW,CAAC,GAC3C,IAAI,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;AAIzB,eAAO,MAAM,kBAAkB,YAAa,OAAO,2BAOT,CAAA;AAG1C,eAAO,MAAM,4BAA4B,QAAS,OAAO,sCACzB,CAAA;AAEhC,eAAO,MAAM,gBAAgB,QAAS,OAAO,0BACrB,CAAA;AAExB,eAAO,MAAM,aAAa,QAAS,OAAO,uBACrB,CAAA;AAErB,eAAO,MAAM,kBAAkB,QAAS,OAAO,4BACrB,CAAA"}
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../../src/network/messages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE3D;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAA;IAEZ,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,iCAAiC;IACjC,IAAI,EAAE,UAAU,CAAA;IAEhB,0DAA0D;IAC1D,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED;;;;;;;;;KASK;AACL,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,WAAW,CAAA;IAEjB,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,qFAAqF;IACrF,KAAK,EAAE,MAAM,CAAA;IAEb,8GAA8G;IAC9G,SAAS,EAAE,SAAS,CAAA;IAEpB,+CAA+C;IAC/C,UAAU,EAAE,UAAU,CAAA;IAEtB,qCAAqC;IACrC,IAAI,EAAE,UAAU,CAAA;CACjB,CAAA;AAED,uHAAuH;AACvH,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,iBAAiB,CAAA;IAEvB,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,yDAAyD;IACzD,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED;;;;;KAKK;AACL,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,SAAS,CAAA;IAEf,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,yCAAyC;IACzC,IAAI,EAAE,UAAU,CAAA;IAEhB,4CAA4C;IAC5C,UAAU,EAAE,UAAU,CAAA;CACvB,CAAA;AAED,sCAAsC;AACtC,MAAM,MAAM,WAAW,CAAC,QAAQ,GAAG,GAAG,IAAI;IACxC,IAAI,EAAE,MAAM,CAAA;IAEZ,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAEhB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAA;IAEhB,yEAAyE;IACzE,OAAO,EAAE,QAAQ,CAAA;CAClB,CAAA;AAED,wFAAwF;AACxF,MAAM,MAAM,WAAW,GACnB,WAAW,GACX,gBAAgB,GAChB,cAAc,GACd,0BAA0B,CAAA;AAE9B,+EAA+E;AAC/E,MAAM,MAAM,OAAO,GAAG,WAAW,GAAG,WAAW,CAAA;AAE/C;;GAEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,IACrD,CAAC,SAAS,gBAAgB,GACtB,IAAI,CAAC,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,WAAW,CAAC,GAC3C,IAAI,CAAC,CAAC,EAAE,UAAU,CAAC,CAAA;AAIzB,eAAO,MAAM,kBAAkB,YAAa,OAAO,2BAOT,CAAA;AAG1C,eAAO,MAAM,4BAA4B,QAAS,OAAO,sCACzB,CAAA;AAEhC,eAAO,MAAM,gBAAgB,QAAS,OAAO,0BACrB,CAAA;AAExB,eAAO,MAAM,aAAa,QAAS,OAAO,uBACrB,CAAA;AAErB,eAAO,MAAM,kBAAkB,QAAS,OAAO,4BACrB,CAAA"}

package/dist/storage/StorageAdapter.d.ts

@@ -1,33 +1,30 @@
+import { StorageKey, Chunk } from "./types.js";
 /** A storage adapter represents some way of storing binary data for a {@link Repo}
  *
  * @remarks
- * `StorageAdapter`s are a little like a key/value store. The keys are arrays
- * of strings ({@link StorageKey}) and the values are binary blobs.
+ * `StorageAdapter`s provide a key/value storage interface. The keys are arrays of strings
+ * ({@link StorageKey}) and the values are binary blobs.
  */
 export declare abstract class StorageAdapter {
-    /** Load the single blob correspongind to `key` */
+    /** Load the single value corresponding to `key` */
     abstract load(key: StorageKey): Promise<Uint8Array | undefined>;
-    /** save the blod `data` to the key `key` */
+    /** Save the value `data` to the key `key` */
     abstract save(key: StorageKey, data: Uint8Array): Promise<void>;
-    /** remove the blob corresponding to `key` */
+    /** Remove the value corresponding to `key` */
     abstract remove(key: StorageKey): Promise<void>;
-    /** Load all blobs with keys that start with `keyPrefix` */
-    abstract loadRange(keyPrefix: StorageKey): Promise<{
-        key: StorageKey;
-        data: Uint8Array;
-    }[]>;
-    /** Remove all blobs with keys that start with `keyPrefix` */
+    /**
+     * Load all values with keys that start with `keyPrefix`.
+     *
+     * @remarks
+     * The `keyprefix` will match any key that starts with the given array. For example:
+     * - `[documentId, "incremental"]` will match all incremental saves
+     * - `[documentId]` will match all data for a given document.
+     *
+     * Be careful! `[documentId]` would also match something like `[documentId, "syncState"]`! We
+     * aren't using this yet but keep it in mind.)
+     */
+    abstract loadRange(keyPrefix: StorageKey): Promise<Chunk[]>;
+    /** Remove all values with keys that start with `keyPrefix` */
     abstract removeRange(keyPrefix: StorageKey): Promise<void>;
 }
-/** The type of keys for a {@link StorageAdapter}
- *
- * @remarks
- * Storage keys are arrays because they are hierarchical and the storage
- * subsystem will need to be able to do range queries for all keys that
- * have a particular prefix. For example, incremental changes for a given
- * document might be stored under `[<documentId>, "incremental", <SHA256>]`.
- * `StorageAdapter` implementations should not assume any particular structure
- * though.
- **/
-export type StorageKey = string[];
 //# sourceMappingURL=StorageAdapter.d.ts.map

package/dist/storage/StorageAdapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StorageAdapter.d.ts","sourceRoot":"","sources":["../../src/storage/StorageAdapter.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,8BAAsB,cAAc;IAMlC,kDAAkD;IAClD,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAC/D,4CAA4C;IAC5C,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAC/D,6CAA6C;IAC7C,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAO/C,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC;QAAC,GAAG,EAAE,UAAU,CAAC;QAAC,IAAI,EAAE,UAAU,CAAA;KAAC,EAAE,CAAC;IACzF,6DAA6D;IAC7D,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAC3D;AAED;;;;;;;;;IASI;AACJ,MAAM,MAAO,UAAU,GAAG,MAAM,EAAE,CAAA"}
+{"version":3,"file":"StorageAdapter.d.ts","sourceRoot":"","sources":["../../src/storage/StorageAdapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAE9C;;;;;GAKG;AACH,8BAAsB,cAAc;IAClC,mDAAmD;IACnD,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAE/D,6CAA6C;IAC7C,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/D,8CAA8C;IAC9C,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/C;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,SAAS,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAE3D,8DAA8D;IAC9D,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;CAC3D"}

package/dist/storage/StorageAdapter.js

@@ -1,8 +1,8 @@
 /** A storage adapter represents some way of storing binary data for a {@link Repo}
  *
  * @remarks
- * `StorageAdapter`s are a little like a key/value store. The keys are arrays
- * of strings ({@link StorageKey}) and the values are binary blobs.
+ * `StorageAdapter`s provide a key/value storage interface. The keys are arrays of strings
+ * ({@link StorageKey}) and the values are binary blobs.
  */
 export class StorageAdapter {
 }

package/dist/storage/StorageSubsystem.d.ts

@@ -1,12 +1,48 @@
 import * as A from "@automerge/automerge/next";
 import { type DocumentId } from "../types.js";
 import { StorageAdapter } from "./StorageAdapter.js";
-export type ChunkType = "snapshot" | "incremental";
+/**
+ * The storage subsystem is responsible for saving and loading Automerge documents to and from
+ * storage adapter. It also provides a generic key/value storage interface for other uses.
+ */
 export declare class StorageSubsystem {
     #private;
     constructor(storageAdapter: StorageAdapter);
-    loadDoc(documentId: DocumentId): Promise<A.Doc<unknown> | null>;
+    /** Loads a value from storage. */
+    load(
+    /** Namespace to prevent collisions with other users of the storage subsystem. */
+    namespace: string, 
+    /** Key to load. Typically a UUID or other unique identifier, but could be any string. */
+    key: string): Promise<Uint8Array | undefined>;
+    /** Saves a value in storage. */
+    save(
+    /** Namespace to prevent collisions with other users of the storage subsystem. */
+    namespace: string, 
+    /** Key to load. Typically a UUID or other unique identifier, but could be any string. */
+    key: string, 
+    /** Data to save, as a binary blob. */
+    data: Uint8Array): Promise<void>;
+    /** Removes a value from storage. */
+    remove(
+    /** Namespace to prevent collisions with other users of the storage subsystem. */
+    namespace: string, 
+    /** Key to remove. Typically a UUID or other unique identifier, but could be any string. */
+    key: string): Promise<void>;
+    /**
+     * Loads the Automerge document with the given ID from storage.
+     */
+    loadDoc<T>(documentId: DocumentId): Promise<A.Doc<T> | null>;
+    /**
+     * Saves the provided Automerge document to storage.
+     *
+     * @remarks
+     * Under the hood this makes incremental saves until the incremental size is greater than the
+     * snapshot size, at which point the document is compacted into a single snapshot.
+     */
     saveDoc(documentId: DocumentId, doc: A.Doc<unknown>): Promise<void>;
-    remove(documentId: DocumentId): Promise<void>;
+    /**
+     * Removes the Automerge document with the given ID from storage
+     */
+    removeDoc(documentId: DocumentId): Promise<void>;
 }
 //# sourceMappingURL=StorageSubsystem.d.ts.map

package/dist/storage/StorageSubsystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StorageSubsystem.d.ts","sourceRoot":"","sources":["../../src/storage/StorageSubsystem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,2BAA2B,CAAA;AAK9C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAc,MAAM,qBAAqB,CAAA;AAUhE,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,aAAa,CAAA;AAelD,qBAAa,gBAAgB;;gBAQf,cAAc,EAAE,cAAc;IAuDpC,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IA0B/D,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAanE,MAAM,CAAC,UAAU,EAAE,UAAU;CAmCpC"}
+{"version":3,"file":"StorageSubsystem.d.ts","sourceRoot":"","sources":["../../src/storage/StorageSubsystem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,2BAA2B,CAAA;AAI9C,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAKpD;;;GAGG;AACH,qBAAa,gBAAgB;;gBAef,cAAc,EAAE,cAAc;IAc1C,kCAAkC;IAC5B,IAAI;IACR,iFAAiF;IACjF,SAAS,EAAE,MAAM;IAEjB,yFAAyF;IACzF,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAKlC,gCAAgC;IAC1B,IAAI;IACR,iFAAiF;IACjF,SAAS,EAAE,MAAM;IAEjB,yFAAyF;IACzF,GAAG,EAAE,MAAM;IAEX,sCAAsC;IACtC,IAAI,EAAE,UAAU,GACf,OAAO,CAAC,IAAI,CAAC;IAKhB,oCAAoC;IAC9B,MAAM;IACV,iFAAiF;IACjF,SAAS,EAAE,MAAM;IAEjB,2FAA2F;IAC3F,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,IAAI,CAAC;IAOhB;;OAEG;IACG,OAAO,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAmClE;;;;;;OAMG;IACG,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAazE;;OAEG;IACG,SAAS,CAAC,UAAU,EAAE,UAAU;CAsGvC"}