@automerge/automerge-repo 1.0.1 → 1.0.2

package/dist/DocUrl.d.ts

@@ -36,5 +36,6 @@ export declare const isValidAutomergeUrl: (str: string) => str is AutomergeUrl;
 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;
 export {};
 //# sourceMappingURL=DocUrl.d.ts.map

package/dist/DocUrl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DocUrl.d.ts","sourceRoot":"","sources":["../src/DocUrl.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,UAAU,EAChB,MAAM,YAAY,CAAA;AAInB,eAAO,MAAM,SAAS,eAAe,CAAA;AAErC;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,QAAS,YAAY;;;CAIlD,CAAA;AAED,UAAU,4BAA4B;IACpC,UAAU,EAAE,UAAU,GAAG,gBAAgB,CAAA;CAC1C;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,oBAE/B,4BAA4B,KAAG,YAQjC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,QAAS,MAAM,wBAK9C,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,QAAO,YAGpC,CAAA;AAEJ,eAAO,MAAM,kBAAkB,UACtB,UAAU,KAChB,gBAAgB,GAAG,SACyC,CAAA;AAE/D,eAAO,MAAM,kBAAkB,UAAW,gBAAgB,KAAG,UACtB,CAAA"}
+{"version":3,"file":"DocUrl.d.ts","sourceRoot":"","sources":["../src/DocUrl.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,gBAAgB,EACrB,KAAK,UAAU,EAChB,MAAM,YAAY,CAAA;AAInB,eAAO,MAAM,SAAS,eAAe,CAAA;AAErC;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,QAAS,YAAY;;;CAIlD,CAAA;AAED,UAAU,4BAA4B;IACpC,UAAU,EAAE,UAAU,GAAG,gBAAgB,CAAA;CAC1C;AAED;;;;;;GAMG;AACH,eAAO,MAAM,qBAAqB,oBAE/B,4BAA4B,KAAG,YAQjC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,QAAS,MAAM,wBAK9C,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,QAAO,YAGpC,CAAA;AAEJ,eAAO,MAAM,kBAAkB,UACtB,UAAU,KAChB,gBAAgB,GAAG,SACyC,CAAA;AAE/D,eAAO,MAAM,kBAAkB,UAAW,gBAAgB,KAAG,UACtB,CAAA;AAEvC,eAAO,MAAM,eAAe,QAAS,MAAM,KAAG,YAAY,GAAG,SAM5D,CAAA"}

package/dist/DocUrl.js

@@ -1,4 +1,4 @@
-import { v4 as uuid } from "uuid";
+import * as Uuid from "uuid";
 import bs58check from "bs58check";
 export const urlPrefix = "automerge:";
 /**
@@ -47,10 +47,17 @@ export const isValidAutomergeUrl = (str) => {
  * @returns a new Automerge URL with a random UUID documentId
  */
 export const generateAutomergeUrl = () => stringifyAutomergeUrl({
-    documentId: uuid(null, new Uint8Array(16)),
+    documentId: Uuid.v4(null, new Uint8Array(16)),
 });
 export const documentIdToBinary = (docId) => bs58check.decodeUnsafe(docId);
 export const binaryToDocumentId = (docId) => bs58check.encode(docId);
+export const parseLegacyUUID = (str) => {
+    if (Uuid.validate(str)) {
+        const uuid = Uuid.parse(str);
+        return stringifyAutomergeUrl({ documentId: uuid });
+    }
+    return undefined;
+};
 /**
  * parts breaks up the URL into constituent pieces,
  * eventually this could include things like heads, so we use this structure

package/dist/Repo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AACA,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,KAAK,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AAIlE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE5C,8FAA8F;AAC9F,qBAAa,IAAK,SAAQ,YAAY,CAAC,mBAAmB,CAAC;;IAGzD,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAGnC,sDAAsD;IACtD,WAAW,EAAE,WAAW,CAAmB;gBAE/B,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,UAAU;IAoHjE,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED;;;;OAIG;IACH,MAAM,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;IA0BzB;;;OAGG;IACH,IAAI,CAAC,CAAC;IACJ,+CAA+C;IAC/C,YAAY,EAAE,YAAY,GACzB,SAAS,CAAC,CAAC,CAAC;IAwBf,MAAM;IACJ,6CAA6C;IAC7C,EAAE,EAAE,UAAU,GAAG,YAAY;CAchC;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,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAGrB,UAAU,mBAAmB;IAC3B,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;CAC7D;AAED,UAAU,eAAe;IACvB,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;IACtB,KAAK,EAAE,OAAO,CAAA;CACf;AAED,UAAU,qBAAqB;IAC7B,UAAU,EAAE,UAAU,CAAA;CACvB"}
+{"version":3,"file":"Repo.d.ts","sourceRoot":"","sources":["../src/Repo.ts"],"names":[],"mappings":"AACA,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,KAAK,YAAY,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,YAAY,CAAA;AASlE,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAG5C,8FAA8F;AAC9F,qBAAa,IAAK,SAAQ,YAAY,CAAC,mBAAmB,CAAC;;IAGzD,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;IAGnC,sDAAsD;IACtD,WAAW,EAAE,WAAW,CAAmB;gBAE/B,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,UAAU;IAuHjE,8CAA8C;IAC9C,IAAI,OAAO,uCAEV;IAED;;;;OAIG;IACH,MAAM,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC;IA0BzB;;;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;CAchC;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,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,UAAU,CAAC,EAAE,UAAU,KACpB,OAAO,CAAC,OAAO,CAAC,CAAA;AAGrB,UAAU,mBAAmB;IAC3B,QAAQ,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,IAAI,CAAA;IACxC,iBAAiB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACvD,sBAAsB,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,IAAI,CAAA;CAC7D;AAED,UAAU,eAAe;IACvB,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;IACtB,KAAK,EAAE,OAAO,CAAA;CACf;AAED,UAAU,qBAAqB;IAC7B,UAAU,EAAE,UAAU,CAAA;CACvB"}

package/dist/Repo.js

@@ -2,7 +2,7 @@ import debug from "debug";
 import { NetworkSubsystem } from "./network/NetworkSubsystem.js";
 import { StorageSubsystem } from "./storage/StorageSubsystem.js";
 import { CollectionSynchronizer } from "./synchronizer/CollectionSynchronizer.js";
-import { parseAutomergeUrl, generateAutomergeUrl, isValidAutomergeUrl } from "./DocUrl.js";
+import { parseAutomergeUrl, generateAutomergeUrl, isValidAutomergeUrl, parseLegacyUUID, } from "./DocUrl.js";
 import { DocHandle } from "./DocHandle.js";
 import { EventEmitter } from "eventemitter3";
 /** A Repo is a collection of documents with networking, syncing, and storage capabilities. */
@@ -49,9 +49,12 @@ export class Repo extends EventEmitter {
             }
             else {
                 handle.awaitNetwork();
-                this.networkSubsystem.whenReady().then(() => {
+                this.networkSubsystem
+                    .whenReady()
+                    .then(() => {
                     handle.networkReady();
-                }).catch(err => {
+                })
+                    .catch(err => {
                     this.#log("error waiting for network", { err });
                 });
             }
@@ -151,7 +154,14 @@ export class Repo extends EventEmitter {
     /** The documentId of the handle to retrieve */
     automergeUrl) {
         if (!isValidAutomergeUrl(automergeUrl)) {
-            throw new Error(`Invalid AutomergeUrl: '${automergeUrl}'`);
+            let 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);
         // If we have the handle cached, return it

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automerge/automerge-repo",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A repository object to manage a collection of automerge documents",
   "repository": "https://github.com/automerge/automerge-repo",
   "author": "Peter van Hardenberg <pvh@pvh.ca>",
@@ -65,5 +65,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9c1eb5fb161eac78a71a6e866b30879994278d22"
+  "gitHead": "c72b9ec33c3a1f7f39ad20cb4fa0d766afe42158"
 }

package/src/DocUrl.ts

@@ -3,7 +3,7 @@ import {
   type BinaryDocumentId,
   type DocumentId,
 } from "./types.js"
-import { v4 as uuid } from "uuid"
+import * as Uuid from "uuid"
 import bs58check from "bs58check"
 
 export const urlPrefix = "automerge:"
@@ -63,7 +63,7 @@ export const isValidAutomergeUrl = (str: string): str is AutomergeUrl => {
  */
 export const generateAutomergeUrl = (): AutomergeUrl =>
   stringifyAutomergeUrl({
-    documentId: uuid(null, new Uint8Array(16)) as BinaryDocumentId,
+    documentId: Uuid.v4(null, new Uint8Array(16)) as BinaryDocumentId,
   })
 
 export const documentIdToBinary = (
@@ -74,6 +74,14 @@ export const documentIdToBinary = (
 export const binaryToDocumentId = (docId: BinaryDocumentId): DocumentId =>
   bs58check.encode(docId) as DocumentId
 
+export const parseLegacyUUID = (str: string): AutomergeUrl | undefined => {
+  if (Uuid.validate(str)) {
+    const uuid = Uuid.parse(str) as BinaryDocumentId
+    return stringifyAutomergeUrl({ documentId: uuid })
+  }
+  return undefined
+}
+
 /**
  * parts breaks up the URL into constituent pieces,
  * eventually this could include things like heads, so we use this structure

package/src/Repo.ts

@@ -6,10 +6,16 @@ import { StorageSubsystem } from "./storage/StorageSubsystem.js"
 import { CollectionSynchronizer } from "./synchronizer/CollectionSynchronizer.js"
 import { type AutomergeUrl, DocumentId, PeerId } from "./types.js"
 import { v4 as uuid } from "uuid"
-import { parseAutomergeUrl, generateAutomergeUrl, isValidAutomergeUrl } from "./DocUrl.js"
+import {
+  parseAutomergeUrl,
+  generateAutomergeUrl,
+  isValidAutomergeUrl,
+  parseLegacyUUID,
+} from "./DocUrl.js"
 
 import { DocHandle } from "./DocHandle.js"
 import { EventEmitter } from "eventemitter3"
+import bs58check from "bs58check"
 
 /** A Repo is a collection of documents with networking, syncing, and storage capabilities. */
 export class Repo extends EventEmitter<DocCollectionEvents> {
@@ -61,11 +67,14 @@ export class Repo extends EventEmitter<DocCollectionEvents> {
         handle.request()
       } else {
         handle.awaitNetwork()
-        this.networkSubsystem.whenReady().then(() => {
-          handle.networkReady()
-        }).catch(err => {
-          this.#log("error waiting for network", { err })
-        })
+        this.networkSubsystem
+          .whenReady()
+          .then(() => {
+            handle.networkReady()
+          })
+          .catch(err => {
+            this.#log("error waiting for network", { err })
+          })
       }
 
       // Register the document with the synchronizer. This advertises our interest in the document.
@@ -120,7 +129,7 @@ export class Repo extends EventEmitter<DocCollectionEvents> {
     })
   }
 
-    /** Returns an existing handle if we have it; creates one otherwise. */
+  /** Returns an existing handle if we have it; creates one otherwise. */
   #getHandle<T>(
     /** The documentId of the handle to look up or create */
     documentId: DocumentId,
@@ -183,7 +192,15 @@ export class Repo extends EventEmitter<DocCollectionEvents> {
     automergeUrl: AutomergeUrl
   ): DocHandle<T> {
     if (!isValidAutomergeUrl(automergeUrl)) {
-      throw new Error(`Invalid AutomergeUrl: '${automergeUrl}'`)
+      let 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)

package/test/Repo.test.ts

@@ -22,6 +22,9 @@ import {
   generateLargeObject,
   LargeObject,
 } from "./helpers/generate-large-object.js"
+import { parseAutomergeUrl } from "../dist/DocUrl.js"
+
+import * as Uuid from "uuid"
 
 describe("Repo", () => {
   describe("single repo", () => {
@@ -50,6 +53,34 @@ describe("Repo", () => {
       assert.equal(handle.isReady(), true)
     })
 
+    it("can find a document once it's created", () => {
+      const { repo } = setup()
+      const handle = repo.create<TestDoc>()
+      handle.change((d: TestDoc) => {
+        d.foo = "bar"
+      })
+
+      const handle2 = repo.find(handle.url)
+      assert.equal(handle, handle2)
+      assert.deepEqual(handle2.docSync(), { foo: "bar" })
+    })
+
+    it("can find a document using a legacy UUID (for now)", () => {
+      const { repo } = setup()
+      const handle = repo.create<TestDoc>()
+      handle.change((d: TestDoc) => {
+        d.foo = "bar"
+      })
+
+      const url = handle.url
+      const { binaryDocumentId } = parseAutomergeUrl(url)
+      const legacyDocumentId = Uuid.stringify(binaryDocumentId) as AutomergeUrl // a white lie
+
+      const handle2 = repo.find(legacyDocumentId)
+      assert.equal(handle, handle2)
+      assert.deepEqual(handle2.docSync(), { foo: "bar" })
+    })
+
     it("can change a document", async () => {
       const { repo } = setup()
       const handle = repo.create<TestDoc>()