@korajs/react 0.3.2 → 0.5.0

package/dist/index.cjs

@@ -31,6 +31,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   KoraProvider: () => KoraProvider,
+  useApp: () => useApp,
   useCollection: () => useCollection,
   useMutation: () => useMutation,
   useQuery: () => useQuery,
@@ -49,12 +50,8 @@ function KoraProvider({
   fallback,
   children
 }) {
-  const [resolvedStore, setResolvedStore] = (0, import_react.useState)(
-    store ?? null
-  );
-  const [resolvedSync, setResolvedSync] = (0, import_react.useState)(
-    syncEngine ?? null
-  );
+  const [resolvedStore, setResolvedStore] = (0, import_react.useState)(store ?? null);
+  const [resolvedSync, setResolvedSync] = (0, import_react.useState)(syncEngine ?? null);
   const [ready, setReady] = (0, import_react.useState)(!app);
   const [initError, setInitError] = (0, import_react.useState)(null);
   (0, import_react.useEffect)(() => {
@@ -93,7 +90,10 @@ function KoraProvider({
   }
   const value = {
     store: resolvedStore,
-    syncEngine: resolvedSync
+    syncEngine: resolvedSync,
+    app: app ?? null,
+    events: app?.events ?? null,
+    subscribeSyncStatus: app?.sync?.subscribeStatus ?? null
   };
   return (0, import_react.createElement)(KoraContext.Provider, { value }, children);
 }
@@ -107,6 +107,17 @@ function useKoraContext() {
   return context;
 }
 
+// src/hooks/use-app.ts
+function useApp() {
+  const { app } = useKoraContext();
+  if (!app) {
+    throw new Error(
+      'useApp() requires KoraProvider to be initialized with an "app" prop. Pass your createApp() result to <KoraProvider app={app}>.'
+    );
+  }
+  return app;
+}
+
 // src/hooks/use-query.ts
 var import_react2 = require("react");
 
@@ -182,6 +193,18 @@ var QueryStore = class {
 };
 
 // src/hooks/use-query.ts
+var APP_NOT_READY_CODE = "APP_NOT_READY";
+function assertQueryReady(query) {
+  const descriptor = query.getDescriptor();
+  if (descriptor.collection === "__pending__") {
+    const err = new Error(
+      "Cannot use useQuery() before app.ready. Await app.ready or wrap your UI in <KoraProvider app={app}>."
+    );
+    err.name = "AppNotReadyError";
+    Object.assign(err, { code: APP_NOT_READY_CODE });
+    throw err;
+  }
+}
 var EMPTY_ARRAY2 = Object.freeze([]);
 var noopSubscribe = (_onStoreChange) => {
   return () => {
@@ -189,6 +212,9 @@ var noopSubscribe = (_onStoreChange) => {
 };
 function useQuery(query, options) {
   const enabled = options?.enabled !== false;
+  if (enabled) {
+    assertQueryReady(query);
+  }
   const descriptorKey = JSON.stringify(query.getDescriptor());
   const queryStoreRef = (0, import_react2.useRef)(null);
   const prevKeyRef = (0, import_react2.useRef)(null);
@@ -221,7 +247,7 @@ function useQuery(query, options) {
 
 // src/hooks/use-mutation.ts
 var import_react3 = require("react");
-function useMutation(mutationFn) {
+function useMutation(mutationFn, options) {
   const [state, setState] = (0, import_react3.useState)({
     isLoading: false,
     error: null
@@ -235,21 +261,35 @@ function useMutation(mutationFn) {
   }, []);
   const fnRef = (0, import_react3.useRef)(mutationFn);
   fnRef.current = mutationFn;
+  const optionsRef = (0, import_react3.useRef)(options);
+  optionsRef.current = options;
   const mutateAsync = (0, import_react3.useCallback)(async (...args) => {
+    const opts = optionsRef.current;
+    let context;
     if (mountedRef.current) {
       setState({ isLoading: true, error: null });
     }
     try {
+      if (opts?.onMutate) {
+        context = await opts.onMutate(...args);
+      }
       const result = await fnRef.current(...args);
       if (mountedRef.current) {
         setState({ isLoading: false, error: null });
       }
+      opts?.onSuccess?.(result, ...args);
+      opts?.onSettled?.(result, null, ...args);
       return result;
     } catch (err) {
       const error = err instanceof Error ? err : new Error(String(err));
+      if (context !== void 0 && opts?.onRollback) {
+        await opts.onRollback(context, ...args);
+      }
       if (mountedRef.current) {
         setState({ isLoading: false, error });
       }
+      opts?.onError?.(error, ...args);
+      opts?.onSettled?.(void 0, error, ...args);
       throw error;
     }
   }, []);
@@ -276,21 +316,44 @@ function useMutation(mutationFn) {
 
 // src/hooks/use-sync-status.ts
 var import_react4 = require("react");
-var POLL_INTERVAL_MS = 500;
 var OFFLINE_STATUS = Object.freeze({
   status: "offline",
   pendingOperations: 0,
-  lastSyncedAt: null
+  lastSyncedAt: null,
+  lastSuccessfulPush: null,
+  lastSuccessfulPull: null,
+  conflicts: 0
 });
+var SYNC_STATUS_EVENT_TYPES = [
+  "sync:connected",
+  "sync:disconnected",
+  "sync:schema-mismatch",
+  "sync:auth-failed",
+  "sync:sent",
+  "sync:received",
+  "sync:acknowledged",
+  "sync:apply-failed",
+  "sync:diagnostics",
+  "sync:initial-sync-progress"
+];
 function useSyncStatus() {
-  const { syncEngine } = useKoraContext();
+  const { syncEngine, subscribeSyncStatus, events } = useKoraContext();
   const snapshotRef = (0, import_react4.useRef)(OFFLINE_STATUS);
   const serializedRef = (0, import_react4.useRef)(JSON.stringify(OFFLINE_STATUS));
   const subscribe = (0, import_react4.useCallback)(
     (onStoreChange) => {
-      if (!syncEngine) return () => {
-      };
-      const intervalId = setInterval(() => {
+      if (subscribeSyncStatus) {
+        return subscribeSyncStatus((status) => {
+          snapshotRef.current = status;
+          serializedRef.current = JSON.stringify(status);
+          onStoreChange();
+        });
+      }
+      if (!syncEngine) {
+        return () => {
+        };
+      }
+      const refresh = () => {
         const newStatus = syncEngine.getStatus();
         const newSerialized = JSON.stringify(newStatus);
         if (newSerialized !== serializedRef.current) {
@@ -298,29 +361,28 @@ function useSyncStatus() {
           serializedRef.current = newSerialized;
           onStoreChange();
         }
-      }, POLL_INTERVAL_MS);
-      const initialStatus = syncEngine.getStatus();
-      const initialSerialized = JSON.stringify(initialStatus);
-      if (initialSerialized !== serializedRef.current) {
-        snapshotRef.current = initialStatus;
-        serializedRef.current = initialSerialized;
-        onStoreChange();
+      };
+      if (events) {
+        const unsubs = SYNC_STATUS_EVENT_TYPES.map((type) => events.on(type, refresh));
+        refresh();
+        return () => {
+          for (const unsub of unsubs) {
+            unsub();
+          }
+        };
       }
+      refresh();
       return () => {
-        clearInterval(intervalId);
       };
     },
-    [syncEngine]
+    [syncEngine, subscribeSyncStatus, events]
   );
   const getSnapshot = (0, import_react4.useCallback)(() => {
-    return snapshotRef.current;
-  }, []);
-  (0, import_react4.useEffect)(() => {
-    if (!syncEngine) {
-      snapshotRef.current = OFFLINE_STATUS;
-      serializedRef.current = JSON.stringify(OFFLINE_STATUS);
+    if (subscribeSyncStatus) {
+      return snapshotRef.current;
     }
-  }, [syncEngine]);
+    return syncEngine ? syncEngine.getStatus() : OFFLINE_STATUS;
+  }, [syncEngine, subscribeSyncStatus]);
   return (0, import_react4.useSyncExternalStore)(subscribe, getSnapshot);
 }
 
@@ -334,21 +396,35 @@ function useCollection(name) {
 }
 
 // src/hooks/use-rich-text.ts
+var import_store = require("@korajs/store");
 var import_react6 = require("react");
 var Y = __toESM(require("yjs"), 1);
 var LOAD_ORIGIN = "kora-load";
+var REMOTE_ORIGIN = "kora-remote";
+var DOC_CHANNEL_ORIGIN = "kora-doc-channel";
 var TEXT_KEY = "content";
 var COMPACT_AFTER_DELTAS = 20;
-function useRichText(collectionName, recordId, fieldName) {
-  const { store } = useKoraContext();
-  const collection = (0, import_react6.useMemo)(() => store.collection(collectionName), [store, collectionName]);
+var PERSIST_DEBOUNCE_MS = 400;
+function useRichText(collectionName, recordId, fieldName, options) {
+  const { store, syncEngine } = useKoraContext();
+  const collection = (0, import_react6.useMemo)(
+    () => store.collection(collectionName),
+    [store, collectionName]
+  );
   const [doc] = (0, import_react6.useState)(() => new Y.Doc());
   const [ready, setReady] = (0, import_react6.useState)(false);
   const [error, setError] = (0, import_react6.useState)(null);
   const [canUndo, setCanUndo] = (0, import_react6.useState)(false);
   const [canRedo, setCanRedo] = (0, import_react6.useState)(false);
+  const [cursors, setCursors] = (0, import_react6.useState)([]);
   const baseUpdateRef = (0, import_react6.useRef)(null);
   const pendingDeltasRef = (0, import_react6.useRef)([]);
+  const docChannelActiveRef = (0, import_react6.useRef)(false);
+  const persistTimerRef = (0, import_react6.useRef)(null);
+  const userRef = (0, import_react6.useRef)(options?.user);
+  (0, import_react6.useEffect)(() => {
+    userRef.current = options?.user;
+  }, [options?.user]);
   const text = (0, import_react6.useMemo)(() => doc.getText(TEXT_KEY), [doc]);
   const undoManager = (0, import_react6.useMemo)(() => new Y.UndoManager(text), [text]);
   const syncHistoryState = (0, import_react6.useCallback)(() => {
@@ -363,6 +439,72 @@ function useRichText(collectionName, recordId, fieldName) {
     undoManager.redo();
     syncHistoryState();
   }, [syncHistoryState, undoManager]);
+  const resolveAwarenessUser = (0, import_react6.useCallback)(() => {
+    if (userRef.current) {
+      return userRef.current;
+    }
+    if (syncEngine) {
+      const existing = syncEngine.getAwarenessManager().getLocalState()?.user;
+      if (existing) {
+        return existing;
+      }
+    }
+    return {
+      name: "Anonymous",
+      color: "#6366f1"
+    };
+  }, [syncEngine]);
+  const setCursor = (0, import_react6.useCallback)(
+    (anchor, head) => {
+      if (!syncEngine) {
+        return;
+      }
+      const awareness = syncEngine.getAwarenessManager();
+      const state = {
+        user: resolveAwarenessUser(),
+        cursor: {
+          collection: collectionName,
+          recordId,
+          field: fieldName,
+          anchor,
+          head
+        }
+      };
+      awareness.setLocalState(state);
+    },
+    [collectionName, fieldName, recordId, resolveAwarenessUser, syncEngine]
+  );
+  const clearCursor = (0, import_react6.useCallback)(() => {
+    if (!syncEngine) {
+      return;
+    }
+    const awareness = syncEngine.getAwarenessManager();
+    const current = awareness.getLocalState();
+    if (!current?.cursor) {
+      return;
+    }
+    if (current.cursor.collection !== collectionName || current.cursor.recordId !== recordId || current.cursor.field !== fieldName) {
+      return;
+    }
+    awareness.setLocalState({ user: current.user });
+  }, [collectionName, fieldName, recordId, syncEngine]);
+  const applyRemoteSnapshot = (0, import_react6.useCallback)(
+    (value) => {
+      const encoded = encodeRichtextInput(value);
+      if (!encoded) {
+        return;
+      }
+      const currentSnapshot = Y.encodeStateAsUpdate(doc);
+      if (updatesEqual(currentSnapshot, encoded)) {
+        return;
+      }
+      Y.applyUpdate(doc, encoded, REMOTE_ORIGIN);
+      baseUpdateRef.current = encoded;
+      pendingDeltasRef.current = [];
+      syncHistoryState();
+    },
+    [doc, syncHistoryState]
+  );
   (0, import_react6.useEffect)(() => {
     let disposed = false;
     const initialize = async () => {
@@ -381,18 +523,15 @@ function useRichText(collectionName, recordId, fieldName) {
         if (encoded) {
           Y.applyUpdate(doc, encoded, LOAD_ORIGIN);
         }
+        const channel = syncEngine?.getRichtextDocChannel?.();
+        docChannelActiveRef.current = channel?.shouldUseChannel(encoded?.length ?? 0, options?.useDocChannel) ?? false;
         setReady(true);
       } catch (cause) {
         if (disposed) return;
         setError(cause instanceof Error ? cause : new Error(String(cause)));
       }
     };
-    const persist = async (_update, origin) => {
-      syncHistoryState();
-      if (origin === LOAD_ORIGIN) {
-        return;
-      }
-      pendingDeltasRef.current.push(_update);
+    const flushPersist = async () => {
       const snapshot = composeRichtextSnapshot(baseUpdateRef.current, pendingDeltasRef.current);
       if (pendingDeltasRef.current.length >= COMPACT_AFTER_DELTAS) {
         baseUpdateRef.current = snapshot;
@@ -408,55 +547,151 @@ function useRichText(collectionName, recordId, fieldName) {
         }
       }
     };
+    const schedulePersist = () => {
+      if (persistTimerRef.current) {
+        clearTimeout(persistTimerRef.current);
+      }
+      persistTimerRef.current = setTimeout(() => {
+        persistTimerRef.current = null;
+        void flushPersist();
+      }, PERSIST_DEBOUNCE_MS);
+    };
+    const persist = (_update, origin) => {
+      syncHistoryState();
+      if (origin === LOAD_ORIGIN || origin === REMOTE_ORIGIN || origin === DOC_CHANNEL_ORIGIN) {
+        return;
+      }
+      pendingDeltasRef.current.push(_update);
+      if (docChannelActiveRef.current && syncEngine) {
+        syncEngine.getRichtextDocChannel().send(collectionName, recordId, fieldName, _update);
+        schedulePersist();
+        return;
+      }
+      void flushPersist();
+    };
     doc.on("update", persist);
     void initialize();
     syncHistoryState();
     return () => {
       disposed = true;
+      if (persistTimerRef.current) {
+        clearTimeout(persistTimerRef.current);
+        persistTimerRef.current = null;
+      }
       doc.off("update", persist);
       undoManager.destroy();
       baseUpdateRef.current = null;
       pendingDeltasRef.current = [];
+      docChannelActiveRef.current = false;
     };
-  }, [collection, doc, fieldName, recordId, syncHistoryState, undoManager]);
-  return { doc, text, undo, redo, canUndo, canRedo, ready, error };
+  }, [
+    collection,
+    collectionName,
+    doc,
+    fieldName,
+    options?.useDocChannel,
+    recordId,
+    syncEngine,
+    syncHistoryState,
+    undoManager
+  ]);
+  (0, import_react6.useEffect)(() => {
+    if (!ready || !syncEngine || !docChannelActiveRef.current) {
+      return;
+    }
+    const channel = syncEngine.getRichtextDocChannel();
+    return channel.subscribe(collectionName, recordId, fieldName, (update) => {
+      Y.applyUpdate(doc, update, DOC_CHANNEL_ORIGIN);
+      syncHistoryState();
+    });
+  }, [collectionName, doc, fieldName, ready, recordId, syncEngine, syncHistoryState]);
+  (0, import_react6.useEffect)(() => {
+    if (!ready) {
+      return;
+    }
+    const unsubscribe = store.collection(collectionName).where({ id: recordId }).subscribe((results) => {
+      const record = results[0];
+      if (!record) {
+        return;
+      }
+      applyRemoteSnapshot(record[fieldName]);
+    });
+    return unsubscribe;
+  }, [applyRemoteSnapshot, collectionName, fieldName, ready, recordId, store]);
+  (0, import_react6.useEffect)(() => {
+    if (!syncEngine) return;
+    const awareness = syncEngine.getAwarenessManager();
+    const localClientId = awareness.clientId;
+    const updateCursors = () => {
+      const states = awareness.getStates();
+      const fieldCursors = [];
+      for (const [clientId, state] of states) {
+        if (clientId === localClientId) continue;
+        if (!state.cursor) continue;
+        if (state.cursor.collection !== collectionName || state.cursor.recordId !== recordId || state.cursor.field !== fieldName) {
+          continue;
+        }
+        fieldCursors.push({
+          clientId,
+          userName: state.user.name,
+          color: state.user.color,
+          anchor: state.cursor.anchor,
+          head: state.cursor.head
+        });
+      }
+      setCursors(fieldCursors);
+    };
+    const unsubscribe = awareness.on("change", () => {
+      updateCursors();
+    });
+    updateCursors();
+    return () => {
+      unsubscribe();
+      clearCursor();
+    };
+  }, [clearCursor, collectionName, fieldName, recordId, syncEngine]);
+  return { doc, text, undo, redo, canUndo, canRedo, ready, error, cursors, setCursor, clearCursor };
 }
 function encodeRichtextInput(value) {
   if (value === null || value === void 0) {
     return null;
   }
-  if (typeof value === "string") {
-    const doc = new Y.Doc();
-    doc.getText(TEXT_KEY).insert(0, value);
-    return Y.encodeStateAsUpdate(doc);
-  }
-  if (value instanceof Uint8Array) {
-    return value;
-  }
-  if (value instanceof ArrayBuffer) {
-    return new Uint8Array(value);
-  }
-  if (typeof globalThis !== "undefined" && "Buffer" in globalThis) {
-    const BufferCtor = globalThis.Buffer;
-    if (BufferCtor.isBuffer(value)) {
-      return new Uint8Array(value.buffer, value.byteOffset, value.byteLength);
+  try {
+    return (0, import_store.encodeRichtext)(value);
+  } catch {
+    if (typeof value === "string") {
+      const fallbackDoc = new Y.Doc();
+      fallbackDoc.getText(TEXT_KEY).insert(0, value);
+      return Y.encodeStateAsUpdate(fallbackDoc);
     }
+    throw new Error("Richtext record value must be a string, Uint8Array, ArrayBuffer, or null.");
   }
-  throw new Error("Richtext record value must be a string, Uint8Array, ArrayBuffer, or null.");
 }
 function composeRichtextSnapshot(base, deltas) {
-  const doc = new Y.Doc();
+  const mergedDoc = new Y.Doc();
   if (base) {
-    Y.applyUpdate(doc, base);
+    Y.applyUpdate(mergedDoc, base);
   }
   for (const delta of deltas) {
-    Y.applyUpdate(doc, delta);
+    Y.applyUpdate(mergedDoc, delta);
+  }
+  return Y.encodeStateAsUpdate(mergedDoc);
+}
+function updatesEqual(left, right) {
+  if (left.length !== right.length) {
+    return false;
+  }
+  for (let index = 0; index < left.length; index++) {
+    if (left[index] !== right[index]) {
+      return false;
+    }
   }
-  return Y.encodeStateAsUpdate(doc);
+  return true;
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   KoraProvider,
+  useApp,
   useCollection,
   useMutation,
   useQuery,