@dabble/patches 0.7.6 → 0.7.8

package/dist/vue/composables.js

@@ -11,48 +11,86 @@ import {
 import { JSONPatch } from "../json-patch/JSONPatch.js";
 import { usePatchesContext } from "./provider.js";
 import { getDocManager } from "./doc-manager.js";
-function usePatchesDoc(docIdOrOptions, options) {
-  if (typeof docIdOrOptions === "string") {
-    return _usePatchesDocEager(docIdOrOptions, options ?? {});
-  }
-  return _usePatchesDocLazy(docIdOrOptions ?? {});
-}
-function _usePatchesDocEager(docId, options) {
-  const { patches } = usePatchesContext();
-  const { autoClose = false } = options;
-  const shouldUntrack = autoClose === "untrack";
+function createDocReactiveState(options) {
+  const { initialLoading = true, transformState, changeBehavior } = options;
   const doc = ref(void 0);
   const data = shallowRef(void 0);
-  const loading = ref(true);
+  const loading = ref(initialLoading);
   const error = ref(null);
   const rev = ref(0);
   const hasPending = ref(false);
-  const unsubscribers = [];
-  const manager = getDocManager(patches);
   function setupDoc(patchesDoc) {
     doc.value = patchesDoc;
     const unsubState = patchesDoc.subscribe((state) => {
+      if (transformState && state) {
+        state = transformState(state, patchesDoc);
+      }
       data.value = state;
       rev.value = patchesDoc.committedRev;
       hasPending.value = patchesDoc.hasPending;
     });
-    unsubscribers.push(unsubState);
     const unsubSync = patchesDoc.onSyncing((syncState) => {
       loading.value = syncState === "initial" || syncState === "updating";
       error.value = syncState instanceof Error ? syncState : null;
     });
-    unsubscribers.push(unsubSync);
     loading.value = patchesDoc.syncing !== null;
+    return () => {
+      unsubState();
+      unsubSync();
+    };
+  }
+  function resetRefs() {
+    doc.value = void 0;
+    data.value = void 0;
+    loading.value = false;
+    error.value = null;
+    rev.value = 0;
+    hasPending.value = false;
+  }
+  function change(mutator) {
+    if (changeBehavior === "throw") {
+      if (!doc.value) {
+        throw new Error("Cannot make changes: document not loaded yet");
+      }
+      doc.value.change(mutator);
+    } else {
+      doc.value?.change(mutator);
+    }
+  }
+  const baseReturn = {
+    data,
+    loading,
+    error,
+    rev,
+    hasPending,
+    change,
+    doc
+  };
+  return { doc, data, loading, error, rev, hasPending, setupDoc, resetRefs, change, baseReturn };
+}
+function usePatchesDoc(docIdOrOptions, options) {
+  if (typeof docIdOrOptions === "string") {
+    return _usePatchesDocEager(docIdOrOptions, options ?? {});
   }
+  return _usePatchesDocLazy(docIdOrOptions ?? {});
+}
+function _usePatchesDocEager(docId, options) {
+  const { patches } = usePatchesContext();
+  const { autoClose = false, algorithm, metadata } = options;
+  const shouldUntrack = autoClose === "untrack";
+  const openDocOpts = { algorithm, metadata };
+  const manager = getDocManager(patches);
+  const { setupDoc, baseReturn } = createDocReactiveState({ changeBehavior: "throw" });
+  let unsubscribe = null;
   if (autoClose) {
-    manager.openDoc(patches, docId).then((patchesDoc) => {
-      setupDoc(patchesDoc);
+    manager.openDoc(patches, docId, openDocOpts).then((patchesDoc) => {
+      unsubscribe = setupDoc(patchesDoc);
     }).catch((err) => {
-      error.value = err;
-      loading.value = false;
+      baseReturn.error.value = err;
+      baseReturn.loading.value = false;
     });
     onBeforeUnmount(() => {
-      unsubscribers.forEach((unsub) => unsub());
+      unsubscribe?.();
       manager.closeDoc(patches, docId, shouldUntrack);
     });
   } else {
@@ -63,74 +101,30 @@ function _usePatchesDocEager(docId, options) {
       );
     }
     manager.incrementRefCount(docId);
-    setupDoc(patchesDoc);
+    unsubscribe = setupDoc(patchesDoc);
     onBeforeUnmount(() => {
-      unsubscribers.forEach((unsub) => unsub());
+      unsubscribe?.();
       manager.decrementRefCount(docId);
     });
   }
-  function change(mutator) {
-    if (!doc.value) {
-      throw new Error("Cannot make changes: document not loaded yet");
-    }
-    doc.value.change(mutator);
-  }
-  return {
-    data,
-    loading,
-    error,
-    rev,
-    hasPending,
-    change,
-    doc
-  };
+  return baseReturn;
 }
 function _usePatchesDocLazy(options) {
   const { patches } = usePatchesContext();
   const { idProp } = options;
-  let currentDoc = null;
+  const { setupDoc, resetRefs, baseReturn } = createDocReactiveState({
+    initialLoading: false,
+    changeBehavior: "noop",
+    transformState: idProp ? (state, patchesDoc) => ({ ...state, [idProp]: patchesDoc.id }) : void 0
+  });
   let unsubscribe = null;
   const path = ref(null);
-  const doc = ref(void 0);
-  const data = shallowRef(void 0);
-  const loading = ref(false);
-  const error = ref(null);
-  const rev = ref(0);
-  const hasPending = ref(false);
-  function setupDoc(patchesDoc) {
-    currentDoc = patchesDoc;
-    doc.value = patchesDoc;
-    unsubscribe = patchesDoc.subscribe((state) => {
-      if (state && idProp && currentDoc) {
-        state = { ...state, [idProp]: currentDoc.id };
-      }
-      data.value = state;
-      rev.value = patchesDoc.committedRev;
-      hasPending.value = patchesDoc.hasPending;
-    });
-    const unsubSync = patchesDoc.onSyncing((syncState) => {
-      loading.value = syncState === "initial" || syncState === "updating";
-      error.value = syncState instanceof Error ? syncState : null;
-    });
-    const origUnsub = unsubscribe;
-    unsubscribe = () => {
-      origUnsub();
-      unsubSync();
-    };
-    loading.value = patchesDoc.syncing !== null;
-  }
   function teardown() {
     unsubscribe?.();
     unsubscribe = null;
-    currentDoc = null;
-    doc.value = void 0;
-    data.value = void 0;
-    loading.value = false;
-    error.value = null;
-    rev.value = 0;
-    hasPending.value = false;
+    resetRefs();
   }
-  async function load(docPath) {
+  async function load(docPath, options2) {
     if (path.value) {
       const prevPath = path.value;
       teardown();
@@ -138,11 +132,11 @@ function _usePatchesDocLazy(options) {
     }
     path.value = docPath;
     try {
-      const patchesDoc = await patches.openDoc(docPath);
-      setupDoc(patchesDoc);
+      const patchesDoc = await patches.openDoc(docPath, options2);
+      unsubscribe = setupDoc(patchesDoc);
     } catch (err) {
-      error.value = err;
-      loading.value = false;
+      baseReturn.error.value = err;
+      baseReturn.loading.value = false;
     }
   }
   async function close() {
@@ -153,8 +147,8 @@ function _usePatchesDocLazy(options) {
       await patches.closeDoc(prevPath);
     }
   }
-  async function create(docPath, initialState) {
-    const newDoc = await patches.openDoc(docPath);
+  async function create(docPath, initialState, options2) {
+    const newDoc = await patches.openDoc(docPath, options2);
     newDoc.change((patch, root) => {
       if (initialState instanceof JSONPatch) {
         patch.ops = initialState.ops;
@@ -166,22 +160,7 @@ function _usePatchesDocLazy(options) {
     });
     await patches.closeDoc(docPath);
   }
-  function change(mutator) {
-    currentDoc?.change(mutator);
-  }
-  return {
-    data,
-    loading,
-    error,
-    rev,
-    hasPending,
-    change,
-    doc,
-    path,
-    load,
-    close,
-    create
-  };
+  return { ...baseReturn, path, load, close, create };
 }
 function usePatchesSync() {
   const { sync } = usePatchesContext();
@@ -210,43 +189,24 @@ function createDocInjectionKey(name) {
 }
 function providePatchesDoc(name, docId, options = {}) {
   const { patches } = usePatchesContext();
-  const { autoClose = false } = options;
+  const { autoClose = false, algorithm, metadata } = options;
   const shouldUntrack = autoClose === "untrack";
+  const openDocOpts = { algorithm, metadata };
   const manager = getDocManager(patches);
-  const doc = ref(void 0);
-  const data = shallowRef(void 0);
-  const loading = ref(true);
-  const error = ref(null);
-  const rev = ref(0);
-  const hasPending = ref(false);
+  const { setupDoc, baseReturn } = createDocReactiveState({ changeBehavior: "throw" });
   const currentDocId = ref(unref(docId));
-  const unsubscribers = [];
-  function setupDoc(patchesDoc) {
-    unsubscribers.forEach((unsub) => unsub());
-    unsubscribers.length = 0;
-    doc.value = patchesDoc;
-    const unsubState = patchesDoc.subscribe((state) => {
-      data.value = state;
-      rev.value = patchesDoc.committedRev;
-      hasPending.value = patchesDoc.hasPending;
-    });
-    unsubscribers.push(unsubState);
-    const unsubSync = patchesDoc.onSyncing((syncState) => {
-      loading.value = syncState === "initial" || syncState === "updating";
-      error.value = syncState instanceof Error ? syncState : null;
-    });
-    unsubscribers.push(unsubSync);
-    loading.value = patchesDoc.syncing !== null;
-  }
+  let unsubscribe = null;
   async function initDoc(id) {
     currentDocId.value = id;
+    unsubscribe?.();
+    unsubscribe = null;
     if (autoClose) {
       try {
-        const patchesDoc = await manager.openDoc(patches, id);
-        setupDoc(patchesDoc);
+        const patchesDoc = await manager.openDoc(patches, id, openDocOpts);
+        unsubscribe = setupDoc(patchesDoc);
       } catch (err) {
-        error.value = err;
-        loading.value = false;
+        baseReturn.error.value = err;
+        baseReturn.loading.value = false;
       }
     } else {
       try {
@@ -257,36 +217,21 @@ function providePatchesDoc(name, docId, options = {}) {
           );
         }
         manager.incrementRefCount(id);
-        setupDoc(patchesDoc);
+        unsubscribe = setupDoc(patchesDoc);
       } catch (err) {
-        error.value = err;
-        loading.value = false;
+        baseReturn.error.value = err;
+        baseReturn.loading.value = false;
       }
     }
   }
-  function change(mutator) {
-    if (!doc.value) {
-      throw new Error("Cannot make changes: document not loaded yet");
-    }
-    doc.value.change(mutator);
-  }
-  const docReturn = {
-    data,
-    loading,
-    error,
-    rev,
-    hasPending,
-    change,
-    doc
-  };
   const key = createDocInjectionKey(name);
-  provide(key, docReturn);
+  provide(key, baseReturn);
   initDoc(unref(docId));
   if (typeof docId !== "string") {
     watch(docId, async (newDocId, oldDocId) => {
       if (newDocId === oldDocId) return;
-      unsubscribers.forEach((unsub) => unsub());
-      unsubscribers.length = 0;
+      unsubscribe?.();
+      unsubscribe = null;
       if (autoClose) {
         await manager.closeDoc(patches, oldDocId, shouldUntrack);
       } else {
@@ -296,14 +241,14 @@ function providePatchesDoc(name, docId, options = {}) {
     });
   }
   onBeforeUnmount(async () => {
-    unsubscribers.forEach((unsub) => unsub());
+    unsubscribe?.();
     if (autoClose) {
       await manager.closeDoc(patches, currentDocId.value, shouldUntrack);
     } else {
       manager.decrementRefCount(currentDocId.value);
     }
   });
-  return docReturn;
+  return baseReturn;
 }
 function useCurrentDoc(name) {
   const key = createDocInjectionKey(name);

package/dist/vue/doc-manager.d.ts

@@ -6,5 +6,5 @@ import '../types.js';
 import '../json-patch/JSONPatch.js';
 import '@dabble/delta';
 import '../client/ClientAlgorithm.js';
-import '../BaseDoc-DkP3tUhT.js';
+import '../BaseDoc-_Rsau70J.js';
 import '../client/PatchesStore.js';

package/dist/vue/index.d.ts

@@ -11,7 +11,7 @@ import '../types.js';
 import '../json-patch/JSONPatch.js';
 import '@dabble/delta';
 import '../client/ClientAlgorithm.js';
-import '../BaseDoc-DkP3tUhT.js';
+import '../BaseDoc-_Rsau70J.js';
 import '../client/PatchesStore.js';
 import '../net/PatchesSync.js';
 import '../net/protocol/types.js';

package/dist/vue/managed-docs.d.ts

@@ -1,9 +1,18 @@
 import { Ref, ShallowRef } from 'vue';
+import { OpenDocOptions } from '../client/Patches.js';
+import '../event-signal.js';
+import '../json-patch/types.js';
+import '../types.js';
+import '../json-patch/JSONPatch.js';
+import '@dabble/delta';
+import '../client/ClientAlgorithm.js';
+import '../BaseDoc-_Rsau70J.js';
+import '../client/PatchesStore.js';
 
 /**
  * Options for useManagedDocs composable.
  */
-interface UseManagedDocsOptions {
+interface UseManagedDocsOptions extends OpenDocOptions {
     /**
      * Inject doc.id into state under this key on every state update.
      * Useful when the document ID is derived from the path but needed in the data.

package/dist/vue/managed-docs.js

@@ -5,7 +5,8 @@ import { areSetsEqual } from "./utils.js";
 const emptyPaths = /* @__PURE__ */ new Set();
 function useManagedDocs(pathsRef, initialData, reducer, options) {
   const { patches } = usePatchesContext();
-  const { idProp } = options ?? {};
+  const { idProp, algorithm, metadata } = options ?? {};
+  const openDocOpts = { algorithm, metadata };
   const data = shallowRef(initialData);
   const docs = /* @__PURE__ */ new Map();
   const unsubscribes = /* @__PURE__ */ new Map();
@@ -28,7 +29,7 @@ function useManagedDocs(pathsRef, initialData, reducer, options) {
   });
   async function openPath(path) {
     try {
-      const doc = await patches.openDoc(path);
+      const doc = await patches.openDoc(path, openDocOpts);
       if (currentPaths.has(path)) {
         docs.set(path, doc);
         let initialState = doc.state;

package/dist/vue/provider.d.ts

@@ -7,7 +7,7 @@ import '../types.js';
 import '../json-patch/JSONPatch.js';
 import '@dabble/delta';
 import '../client/ClientAlgorithm.js';
-import '../BaseDoc-DkP3tUhT.js';
+import '../BaseDoc-_Rsau70J.js';
 import '../client/PatchesStore.js';
 import '../net/protocol/types.js';
 import '../net/protocol/JSONRPCClient.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dabble/patches",
-  "version": "0.7.6",
+  "version": "0.7.8",
   "description": "Immutable JSON Patch implementation based on RFC 6902 supporting operational transformation and last-writer-wins",
   "author": "Jacob Wright <jacwright@gmail.com>",
   "bugs": {