@dabble/patches 0.7.8 → 0.7.10

package/dist/types.d.ts

@@ -57,13 +57,30 @@ interface PatchesSnapshot<T = any> extends PatchesState<T> {
     changes: Change[];
 }
 /**
- * Represents the syncing state of a document.
- * @property initial - The document is not syncing.
- * @property updating - The document is syncing.
- * @property null - The document is not syncing.
- * @property Error - The document is syncing with an error.
+ * Sync status for a document, used by both PatchesDoc and PatchesSync's SyncedDoc.
+ * - `'unsynced'` — not yet synced (initial state, or disconnected)
+ * - `'syncing'`  — actively syncing with the server
+ * - `'synced'`   — up to date with the server
+ * - `'error'`    — sync failed (see syncError for details)
  */
-type SyncingState = 'initial' | 'updating' | null | Error;
+type DocSyncStatus = 'unsynced' | 'syncing' | 'synced' | 'error';
+/**
+ * Represents the synced state of a document.
+ * @property committedRev - The last committed revision number from the server.
+ * @property hasPending - Whether there are local changes that haven't been committed yet.
+ * @property syncStatus - The current sync status of the document.
+ * @property syncError - The error from the last failed sync attempt, if any.
+ * @property isLoaded - Whether the document has completed its initial load. Sticky: once true, never reverts to false
+ *   within a sync lifecycle. A document is considered loaded when it has data to display (server data, cached data,
+ *   or local changes) or sync has resolved (successfully or with error).
+ */
+interface SyncedDoc {
+    committedRev: number;
+    hasPending: boolean;
+    syncStatus: DocSyncStatus;
+    syncError: Error | null;
+    isLoaded: boolean;
+}
 /** Status options for a branch */
 type BranchStatus = 'open' | 'closed' | 'merged' | 'archived' | 'abandoned';
 interface Branch {
@@ -220,4 +237,4 @@ type PathProxy<T = any> = IsAny<T> extends true ? DeepPathProxy : {
  */
 type ChangeMutator<T> = (patch: JSONPatch, root: PathProxy<T>) => void;
 
-export type { Branch, BranchStatus, Change, ChangeInput, ChangeMutator, CommitChangesOptions, DeleteDocOptions, DocumentTombstone, EditableBranchMetadata, EditableVersionMetadata, ListChangesOptions, ListVersionsOptions, PatchesSnapshot, PatchesState, PathProxy, SyncingState, VersionMetadata };
+export type { Branch, BranchStatus, Change, ChangeInput, ChangeMutator, CommitChangesOptions, DeleteDocOptions, DocSyncStatus, DocumentTombstone, EditableBranchMetadata, EditableVersionMetadata, ListChangesOptions, ListVersionsOptions, PatchesSnapshot, PatchesState, PathProxy, SyncedDoc, VersionMetadata };

package/dist/vue/composables.d.ts

@@ -1,6 +1,6 @@
 import { ShallowRef, Ref, MaybeRef } from 'vue';
 import { OpenDocOptions } from '../client/Patches.js';
-import { a as PatchesDoc } from '../BaseDoc-_Rsau70J.js';
+import { a as PatchesDoc } from '../BaseDoc-BfVJNeCi.js';
 import { JSONPatch } from '../json-patch/JSONPatch.js';
 import { ChangeMutator } from '../types.js';
 import '../event-signal.js';

package/dist/vue/composables.js

@@ -12,7 +12,7 @@ import { JSONPatch } from "../json-patch/JSONPatch.js";
 import { usePatchesContext } from "./provider.js";
 import { getDocManager } from "./doc-manager.js";
 function createDocReactiveState(options) {
-  const { initialLoading = true, transformState, changeBehavior } = options;
+  const { initialLoading = true, hasSyncContext = false, transformState, changeBehavior } = options;
   const doc = ref(void 0);
   const data = shallowRef(void 0);
   const loading = ref(initialLoading);
@@ -21,6 +21,19 @@ function createDocReactiveState(options) {
   const hasPending = ref(false);
   function setupDoc(patchesDoc) {
     doc.value = patchesDoc;
+    let loaded = false;
+    function updateLoading() {
+      if (loaded) return;
+      if (patchesDoc.isLoaded) {
+        loaded = true;
+        loading.value = false;
+      } else if (patchesDoc.syncStatus === "syncing") {
+        loading.value = true;
+      } else if (!hasSyncContext) {
+        loaded = true;
+        loading.value = false;
+      }
+    }
     const unsubState = patchesDoc.subscribe((state) => {
       if (transformState && state) {
         state = transformState(state, patchesDoc);
@@ -28,12 +41,12 @@ function createDocReactiveState(options) {
       data.value = state;
       rev.value = patchesDoc.committedRev;
       hasPending.value = patchesDoc.hasPending;
+      updateLoading();
     });
-    const unsubSync = patchesDoc.onSyncing((syncState) => {
-      loading.value = syncState === "initial" || syncState === "updating";
-      error.value = syncState instanceof Error ? syncState : null;
+    const unsubSync = patchesDoc.onSyncStatus((status) => {
+      updateLoading();
+      error.value = status === "error" ? patchesDoc.syncError : null;
     });
-    loading.value = patchesDoc.syncing !== null;
     return () => {
       unsubState();
       unsubSync();
@@ -75,12 +88,16 @@ function usePatchesDoc(docIdOrOptions, options) {
   return _usePatchesDocLazy(docIdOrOptions ?? {});
 }
 function _usePatchesDocEager(docId, options) {
-  const { patches } = usePatchesContext();
+  const { patches, sync } = 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" });
+  const { setupDoc, baseReturn } = createDocReactiveState({
+    initialLoading: !!autoClose,
+    hasSyncContext: !!sync,
+    changeBehavior: "throw"
+  });
   let unsubscribe = null;
   if (autoClose) {
     manager.openDoc(patches, docId, openDocOpts).then((patchesDoc) => {
@@ -110,10 +127,11 @@ function _usePatchesDocEager(docId, options) {
   return baseReturn;
 }
 function _usePatchesDocLazy(options) {
-  const { patches } = usePatchesContext();
+  const { patches, sync } = usePatchesContext();
   const { idProp } = options;
-  const { setupDoc, resetRefs, baseReturn } = createDocReactiveState({
+  const { setupDoc, resetRefs, loading, baseReturn } = createDocReactiveState({
     initialLoading: false,
+    hasSyncContext: !!sync,
     changeBehavior: "noop",
     transformState: idProp ? (state, patchesDoc) => ({ ...state, [idProp]: patchesDoc.id }) : void 0
   });
@@ -131,12 +149,13 @@ function _usePatchesDocLazy(options) {
       await patches.closeDoc(prevPath);
     }
     path.value = docPath;
+    loading.value = true;
     try {
       const patchesDoc = await patches.openDoc(docPath, options2);
       unsubscribe = setupDoc(patchesDoc);
     } catch (err) {
       baseReturn.error.value = err;
-      baseReturn.loading.value = false;
+      loading.value = false;
     }
   }
   async function close() {
@@ -168,11 +187,11 @@ function usePatchesSync() {
     throw new Error("PatchesSync not found in context. Did you forget to pass sync to providePatchesContext()?");
   }
   const connected = ref(sync.state.connected);
-  const syncing = ref(sync.state.syncing === "updating");
+  const syncing = ref(sync.state.syncStatus === "syncing");
   const online = ref(sync.state.online);
   const unsubscribe = sync.onStateChange((state) => {
     connected.value = state.connected;
-    syncing.value = state.syncing === "updating";
+    syncing.value = state.syncStatus === "syncing";
     online.value = state.online;
   });
   onBeforeUnmount(() => {
@@ -188,12 +207,16 @@ function createDocInjectionKey(name) {
   return Symbol(`patches-doc-${name}`);
 }
 function providePatchesDoc(name, docId, options = {}) {
-  const { patches } = usePatchesContext();
+  const { patches, sync } = 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" });
+  const { setupDoc, baseReturn } = createDocReactiveState({
+    initialLoading: !!autoClose,
+    hasSyncContext: !!sync,
+    changeBehavior: "throw"
+  });
   const currentDocId = ref(unref(docId));
   let unsubscribe = null;
   async function initDoc(id) {

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-_Rsau70J.js';
+import '../BaseDoc-BfVJNeCi.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-_Rsau70J.js';
+import '../BaseDoc-BfVJNeCi.js';
 import '../client/PatchesStore.js';
 import '../net/PatchesSync.js';
 import '../net/protocol/types.js';

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

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

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-_Rsau70J.js';
+import '../BaseDoc-BfVJNeCi.js';
 import '../client/PatchesStore.js';
 import '../net/protocol/types.js';
 import '../net/protocol/JSONRPCClient.js';
@@ -16,6 +16,7 @@ import '../net/PatchesClient.js';
 import '../net/websocket/WebSocketTransport.js';
 import '../utils/deferred.js';
 import '../algorithms/ot/shared/changeBatching.js';
+import '../shared/utils.js';
 
 /**
  * Injection key for Patches instance.

package/dist/vue/utils.d.ts

@@ -1 +1,5 @@
 export { areSetsEqual, fillPath } from '../shared/utils.js';
+import '../types.js';
+import '../json-patch/JSONPatch.js';
+import '@dabble/delta';
+import '../json-patch/types.js';

package/package.json

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