@yorkie-js/react 0.7.10 → 0.7.11-rc

package/dist/yorkie-js-react.d.ts

@@ -98,7 +98,7 @@ declare type DocumentContextType<R, P extends Indexable = Indexable> = {
  * This component must be under a `YorkieProvider` component to initialize the
  * Yorkie client properly.
  */
-export declare const DocumentProvider: <R, P extends Indexable = Indexable>({ docKey, initialRoot, initialPresence, enableDevtools, syncMode, documentPollInterval, children, }: {
+export declare const DocumentProvider: <R, P extends Indexable = Indexable>({ docKey, initialRoot, initialPresence, enableDevtools, syncMode, documentPollInterval, disableGC, children, }: {
     docKey: string;
     initialRoot?: R;
     initialPresence?: P;
@@ -113,6 +113,13 @@ export declare const DocumentProvider: <R, P extends Indexable = Indexable>({ do
      * Default: 3000. Applied at attach time.
      */
     documentPollInterval?: number;
+    /**
+     * `disableGC` declares that this attachment will not produce or consume
+     * tombstones. Use only with Counter or primitive workloads; misuse on a
+     * document that uses Tree, Text, or Array deletions leads to undefined
+     * GC behavior on this client.
+     */
+    disableGC?: boolean;
     children?: default_2.ReactNode;
 }) => JSX.Element;
 
@@ -317,6 +324,13 @@ export declare function useYorkieDoc<R, P extends Indexable = Indexable>(apiKey:
     enableDevtools?: boolean;
     syncMode?: SyncMode;
     documentPollInterval?: number;
+    /**
+     * `disableGC` declares that this attachment will not produce or consume
+     * tombstones. Use only with Counter or primitive workloads; misuse on a
+     * document that uses Tree, Text, or Array deletions leads to undefined
+     * GC behavior on this client.
+     */
+    disableGC?: boolean;
 }): {
     root: R;
     presences: Array<{

package/dist/yorkie-js-react.es.js

@@ -13768,6 +13768,26 @@ class ChangeID {
     newID.versionVector.set(this.actor, lamport);
     return newID;
   }
+  /**
+   * `syncLamport` advances the lamport clock against the given ID without
+   * merging its version vector into the receiver's. It is the counterpart
+   * of `syncClocks` for attachments that have opted out of GC participation
+   * (see docs/design/disable-gc-on-attach.md in the server repo): the
+   * receiver does not need other actors' entries in its VV because it
+   * never produces or consumes tombstones, and dropping them keeps each
+   * subsequent local Change's VV at O(1) instead of O(num_actors).
+   * Lamport must still advance so that TimeTickets produced locally
+   * remain ordered against remote operations.
+   */
+  syncLamport(other) {
+    if (!other.hasClocks()) {
+      return this;
+    }
+    const lamport = other.lamport > this.lamport ? other.lamport + 1n : this.lamport + 1n;
+    const vector = this.versionVector.deepcopy();
+    vector.set(this.actor, lamport);
+    return new ChangeID(this.clientSeq, lamport, this.actor, vector);
+  }
   /**
    * `setClocks` sets the given clocks to this ID. This is used when the snapshot
    * is given from the server.
@@ -19639,6 +19659,12 @@ class Document {
   onlineClients;
   eventStream;
   eventStreamObserver;
+  // `disableGC`, when true, declares that this document does not produce or
+  // consume tombstones (see disable-gc-on-attach in the server repo). It is
+  // set by the client on Attach and consumed by applyChange to skip merging
+  // remote actors' version vectors into changeID, keeping each subsequent
+  // local Change's VV at O(1) for high-fan-out Counter workloads.
+  disableGC;
   /**
    * `history` is exposed to the user to manage undo/redo operations.
    */
@@ -19652,6 +19678,7 @@ class Document {
     this.changeID = InitialChangeID;
     this.checkpoint = InitialCheckpoint;
     this.localChanges = [];
+    this.disableGC = false;
     this.root = CRDTRoot.create();
     this.presences = /* @__PURE__ */ new Map();
     this.onlineClients = /* @__PURE__ */ new Set();
@@ -20060,6 +20087,14 @@ class Document {
     }
     this.changeID = this.changeID.setActor(actorID);
   }
+  /**
+   * `setDisableGC` records whether this document participates in GC. The
+   * client calls this on attach so subsequent applyChange runs use the
+   * lamport-only sync path.
+   */
+  setDisableGC(disableGC) {
+    this.disableGC = disableGC;
+  }
   /**
    * `isEnableDevtools` returns whether devtools is enabled or not.
    */
@@ -20298,7 +20333,7 @@ class Document {
         );
       }
     }
-    this.changeID = this.changeID.syncClocks(change.getID());
+    this.changeID = this.disableGC ? this.changeID.syncLamport(change.getID()) : this.changeID.syncClocks(change.getID());
     if (opInfos.length) {
       const rawChange = this.isEnableDevtools() ? change.toStruct() : void 0;
       events.push(
@@ -20981,7 +21016,7 @@ function createAuthInterceptor(apiKey, token) {
   };
 }
 const name$1 = "@yorkie-js/sdk";
-const version$1 = "0.7.10";
+const version$1 = "0.7.11-rc";
 const pkg$1 = {
   name: name$1,
   version: version$1
@@ -21532,6 +21567,7 @@ class Client {
           doc.setSchemaRules(converter.fromSchemaRules(res.schemaRules));
         }
         const pack = converter.fromChangePack(res.changePack);
+        doc.setDisableGC(opts.disableGC ?? false);
         doc.applyChangePack(pack);
         if (doc.getStatus() === DocStatus.Removed) {
           return doc;
@@ -23064,7 +23100,7 @@ if (typeof globalThis !== "undefined") {
   };
 }
 const name = "@yorkie-js/react";
-const version = "0.7.10";
+const version = "0.7.11-rc";
 const pkg = {
   name,
   version
@@ -23253,7 +23289,7 @@ function shallowEqual(valueA, valueB) {
     valueB
   );
 }
-function useYorkieDocument(client, clientLoading, clientError, docKey, initialRoot, initialPresence, enableDevtools, syncMode, documentPollInterval, docStore) {
+function useYorkieDocument(client, clientLoading, clientError, docKey, initialRoot, initialPresence, enableDevtools, syncMode, documentPollInterval, disableGC, docStore) {
   const initialRootRef = useRef(initialRoot);
   const initialPresenceRef = useRef(initialPresence);
   const [didMount, setDidMount] = useState(false);
@@ -23313,7 +23349,8 @@ function useYorkieDocument(client, clientLoading, clientError, docKey, initialRo
           initialRoot: initialRootRef.current,
           initialPresence: initialPresenceRef.current,
           syncMode,
-          documentPollInterval
+          documentPollInterval,
+          disableGC
         });
         const update = (callback) => {
           try {
@@ -23361,7 +23398,8 @@ function useYorkieDocument(client, clientLoading, clientError, docKey, initialRo
     docStore,
     didMount,
     syncMode,
-    documentPollInterval
+    documentPollInterval,
+    disableGC
   ]);
 }
 const DocumentContext = createContext(void 0);
@@ -23372,6 +23410,7 @@ const DocumentProvider = ({
   enableDevtools = false,
   syncMode,
   documentPollInterval,
+  disableGC,
   children
 }) => {
   const { client, loading: clientLoading, error: clientError } = useYorkie();
@@ -23399,6 +23438,7 @@ const DocumentProvider = ({
     enableDevtools,
     syncMode,
     documentPollInterval,
+    disableGC,
     documentStore
   );
   return /* @__PURE__ */ jsx(DocumentContext.Provider, { value: documentStore, children });
@@ -23518,6 +23558,7 @@ function useYorkieDoc(apiKey, docKey, opts) {
     opts?.enableDevtools ?? false,
     opts?.syncMode,
     opts?.documentPollInterval,
+    opts?.disableGC,
     documentStore
   );
   const documentState = useSelector(documentStore);