@yorkie-js/sdk 0.6.11-rc → 0.6.12

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

@@ -285,7 +285,8 @@ declare class Change_2 extends Message<Change_2> {
  * Finally returns a Change after the modification has been completed.
  */
 declare class ChangeContext<P extends Indexable = Indexable> {
-    private id;
+    private prevID;
+    private nextID;
     private delimiter;
     private message?;
     private root;
@@ -301,11 +302,11 @@ declare class ChangeContext<P extends Indexable = Indexable> {
      * presence changes.
      */
     private reversePresenceKeys;
-    constructor(id: ChangeID, root: CRDTRoot, presence: P, message?: string);
+    constructor(prevID: ChangeID, root: CRDTRoot, presence: P, message?: string);
     /**
      * `create` creates a new instance of ChangeContext.
      */
-    static create<P extends Indexable>(id: ChangeID, root: CRDTRoot, presence: P, message?: string): ChangeContext<P>;
+    static create<P extends Indexable>(prevID: ChangeID, root: CRDTRoot, presence: P, message?: string): ChangeContext<P>;
     /**
      * `push` pushes the given operation to this context.
      */
@@ -323,9 +324,14 @@ declare class ChangeContext<P extends Indexable = Indexable> {
      */
     registerGCPair(pair: GCPair): void;
     /**
-     * `getChange` creates a new instance of Change in this context.
+     * `getNextID` returns the next ID of this context. It will be set to the
+     * document for the next change.returns the next ID of this context.
+     */
+    getNextID(): ChangeID;
+    /**
+     * `toChange` creates a new instance of Change in this context.
      */
-    getChange(): Change<P>;
+    toChange(): Change<P>;
     /**
      * `hasChange` returns whether this context has change or not.
      */
@@ -360,10 +366,14 @@ declare class ChangeContext<P extends Indexable = Indexable> {
 declare class ChangeID {
     private clientSeq;
     private serverSeq?;
-    private lamport;
     private actor;
+    private lamport;
     private versionVector;
     constructor(clientSeq: number, lamport: bigint, actor: ActorID, vector: VersionVector, serverSeq?: bigint);
+    /**
+     * `hasClocks` returns true if this ID has logical clocks.
+     */
+    hasClocks(): boolean;
     /**
      * `of` creates a new instance of ChangeID.
      */
@@ -371,9 +381,10 @@ declare class ChangeID {
     /**
      * `next` creates a next ID of this ID.
      */
-    next(): ChangeID;
+    next(excludeClocks?: boolean): ChangeID;
     /**
-     * `syncClocks` syncs logical clocks with the given ID.
+     * `syncClocks` syncs logical clocks with the given ID. If the given ID
+     * doesn't have logical clocks, this ID is returned.
      */
     syncClocks(other: ChangeID): ChangeID;
     /**
@@ -389,6 +400,10 @@ declare class ChangeID {
      * `setActor` sets the given actor.
      */
     setActor(actorID: ActorID): ChangeID;
+    /**
+     * `setLamport` sets the given lamport clock.
+     */
+    setLamport(lamport: bigint): ChangeID;
     /**
      * `setVersionVector` sets the given version vector.
      */
@@ -761,6 +776,7 @@ export declare class Client {
      */
     detach<R, P extends Indexable>(doc: Document_2<R, P>, opts?: {
         removeIfNotAttached?: boolean;
+        keepalive?: boolean;
     }): Promise<Document_2<R, P>>;
     /**
      * `changeRealtimeSync` changes the synchronization mode of the given document.
@@ -2505,10 +2521,6 @@ declare class Document_2<R, P extends Indexable = Indexable> {
      * `canUndo` returns whether there are any operations to undo.
      */
     private canUndo;
-    /**
-     * 'filterVersionVector' filters detached client's lamport from version vector.
-     */
-    private filterVersionVector;
     /**
      * `canRedo` returns whether there are any operations to redo.
      */

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

@@ -7581,76 +7581,11 @@ class YorkieError extends Error {
     this.toString = () => `[code=${this.code}]: ${this.message}`;
   }
 }
-function deepcopy(object) {
-  if (object instanceof Map) {
-    const pairs = Array.from(object);
-    return new Map(JSON.parse(JSON.stringify(pairs)));
-  }
-  return JSON.parse(JSON.stringify(object));
-}
-const isEmpty = (object) => {
-  if (!object) {
-    return true;
-  }
-  return Object.entries(object).length === 0;
-};
-const stringifyObjectValues = (attributes) => {
-  const attrs = {};
-  for (const [key, value] of Object.entries(attributes)) {
-    attrs[key] = JSON.stringify(value);
-  }
-  return attrs;
-};
-const parseObjectValues = (attrs) => {
-  const attributes = {};
-  for (const [key, value] of Object.entries(attrs)) {
-    attributes[key] = JSON.parse(value);
-  }
-  return attributes;
-};
 var PresenceChangeType = /* @__PURE__ */ ((PresenceChangeType2) => {
   PresenceChangeType2["Put"] = "put";
   PresenceChangeType2["Clear"] = "clear";
   return PresenceChangeType2;
 })(PresenceChangeType || {});
-class Presence {
-  constructor(changeContext, presence) {
-    __publicField(this, "context");
-    __publicField(this, "presence");
-    this.context = changeContext;
-    this.presence = presence;
-  }
-  /**
-   * `set` updates the presence based on the partial presence.
-   */
-  set(presence, option) {
-    for (const key of Object.keys(presence)) {
-      this.presence[key] = presence[key];
-    }
-    this.context.setPresenceChange({
-      type: "put",
-      presence: deepcopy(this.presence)
-    });
-    this.context.setReversePresence(presence, option);
-  }
-  /**
-   * `get` returns the presence value of the given key.
-   */
-  get(key) {
-    return this.presence[key];
-  }
-  /**
-   * `clear` clears the presence.
-   * @internal
-   */
-  clear() {
-    this.presence = {};
-    this.context.setPresenceChange({
-      type: "clear"
-      /* Clear */
-    });
-  }
-}
 const InitialActorID = "000000000000000000000000";
 const TimeTicketSize = 8 + 4 + 12;
 class TimeTicket {
@@ -7766,10 +7701,11 @@ class TimeTicket {
     return 0;
   }
 }
+const InitialLamport = 0n;
 const InitialDelimiter = 0;
 const MaxLamport = 9223372036854775807n;
 const InitialTimeTicket = new TimeTicket(
-  0n,
+  InitialLamport,
   InitialDelimiter,
   InitialActorID
 );
@@ -10980,6 +10916,33 @@ class RHT {
     this.numberOfRemovedElement--;
   }
 }
+function deepcopy(object) {
+  if (object instanceof Map) {
+    const pairs = Array.from(object);
+    return new Map(JSON.parse(JSON.stringify(pairs)));
+  }
+  return JSON.parse(JSON.stringify(object));
+}
+const isEmpty = (object) => {
+  if (!object) {
+    return true;
+  }
+  return Object.entries(object).length === 0;
+};
+const stringifyObjectValues = (attributes) => {
+  const attrs = {};
+  for (const [key, value] of Object.entries(attributes)) {
+    attrs[key] = JSON.stringify(value);
+  }
+  return attrs;
+};
+const parseObjectValues = (attrs) => {
+  const attributes = {};
+  for (const [key, value] of Object.entries(attrs)) {
+    attributes[key] = JSON.parse(value);
+  }
+  return attributes;
+};
 class CRDTTextValue {
   constructor(content) {
     __publicField(this, "attributes");
@@ -13895,12 +13858,15 @@ class ChangeID {
     __publicField(this, "clientSeq");
     // `serverSeq` is optional and only present for changes stored on the server.
     __publicField(this, "serverSeq");
-    // `lamport` and `actor` are the lamport clock and the actor of this change.
-    // This is used to determine the order of changes in logical time.
-    __publicField(this, "lamport");
+    // `actor` is the creator of this change.
     __publicField(this, "actor");
+    // `lamport` is the lamport clock of this change. This is used to determine
+    // the order of changes in logical time. It is optional and only present
+    // if the change has operations.
+    __publicField(this, "lamport");
     // `versionVector` is the vector clock of this change. This is used to
-    // determine the relationship is causal or not between changes.
+    // determine the relationship is causal or not between changes. It is optional
+    // and only present if the change has operations.
     __publicField(this, "versionVector");
     this.clientSeq = clientSeq;
     this.serverSeq = serverSeq;
@@ -13908,6 +13874,12 @@ class ChangeID {
     this.versionVector = vector;
     this.actor = actor;
   }
+  /**
+   * `hasClocks` returns true if this ID has logical clocks.
+   */
+  hasClocks() {
+    return this.versionVector.size() > 0 && this.lamport != InitialLamport;
+  }
   /**
    * `of` creates a new instance of ChangeID.
    */
@@ -13917,7 +13889,16 @@ class ChangeID {
   /**
    * `next` creates a next ID of this ID.
    */
-  next() {
+  next(excludeClocks = false) {
+    if (excludeClocks) {
+      return new ChangeID(
+        this.clientSeq + 1,
+        this.lamport,
+        this.actor,
+        InitialVersionVector,
+        InitialLamport
+      );
+    }
     const vector = this.versionVector.deepcopy();
     vector.set(this.actor, this.lamport + 1n);
     return new ChangeID(
@@ -13928,9 +13909,13 @@ class ChangeID {
     );
   }
   /**
-   * `syncClocks` syncs logical clocks with the given ID.
+   * `syncClocks` syncs logical clocks with the given ID. If the given ID
+   * doesn't have logical clocks, this ID is returned.
    */
   syncClocks(other) {
+    if (!other.hasClocks()) {
+      return this;
+    }
     const lamport = other.lamport > this.lamport ? other.lamport + 1n : this.lamport + 1n;
     const maxVersionVector = this.versionVector.max(other.versionVector);
     const newID = new ChangeID(
@@ -13971,6 +13956,18 @@ class ChangeID {
       this.serverSeq
     );
   }
+  /**
+   * `setLamport` sets the given lamport clock.
+   */
+  setLamport(lamport) {
+    return new ChangeID(
+      this.clientSeq,
+      lamport,
+      this.actor,
+      this.versionVector,
+      this.serverSeq
+    );
+  }
   /**
    * `setVersionVector` sets the given version vector.
    */
@@ -16926,8 +16923,9 @@ function createObservable(executor) {
   };
 }
 class ChangeContext {
-  constructor(id, root, presence, message) {
-    __publicField(this, "id");
+  constructor(prevID, root, presence, message) {
+    __publicField(this, "prevID");
+    __publicField(this, "nextID");
     __publicField(this, "delimiter");
     __publicField(this, "message");
     __publicField(this, "root");
@@ -16943,7 +16941,8 @@ class ChangeContext {
      * presence changes.
      */
     __publicField(this, "reversePresenceKeys");
-    this.id = id;
+    this.prevID = prevID;
+    this.nextID = prevID.next();
     this.delimiter = InitialDelimiter;
     this.root = root;
     this.operations = [];
@@ -16955,8 +16954,8 @@ class ChangeContext {
   /**
    * `create` creates a new instance of ChangeContext.
    */
-  static create(id, root, presence, message) {
-    return new ChangeContext(id, root, presence, message);
+  static create(prevID, root, presence, message) {
+    return new ChangeContext(prevID, root, presence, message);
   }
   /**
    * `push` pushes the given operation to this context.
@@ -16983,11 +16982,22 @@ class ChangeContext {
     this.root.registerGCPair(pair);
   }
   /**
-   * `getChange` creates a new instance of Change in this context.
+   * `getNextID` returns the next ID of this context. It will be set to the
+   * document for the next change.returns the next ID of this context.
    */
-  getChange() {
+  getNextID() {
+    if (this.operations.length === 0) {
+      return this.prevID.next(true).setLamport(this.prevID.getLamport()).setVersionVector(this.prevID.getVersionVector());
+    }
+    return this.nextID;
+  }
+  /**
+   * `toChange` creates a new instance of Change in this context.
+   */
+  toChange() {
+    const id = this.operations.length === 0 ? this.prevID.next(true) : this.nextID;
     return Change.create({
-      id: this.id,
+      id,
       operations: this.operations,
       presenceChange: this.presenceChange,
       message: this.message
@@ -17033,13 +17043,13 @@ class ChangeContext {
    */
   issueTimeTicket() {
     this.delimiter += 1;
-    return this.id.createTimeTicket(this.delimiter);
+    return this.nextID.createTimeTicket(this.delimiter);
   }
   /**
    * `getLastTimeTicket` returns the last time ticket issued in this context.
    */
   getLastTimeTicket() {
-    return this.id.createTimeTicket(this.delimiter);
+    return this.nextID.createTimeTicket(this.delimiter);
   }
 }
 class CRDTRoot {
@@ -18968,6 +18978,43 @@ function buildCRDTElement(context, value, createdAt) {
   }
   return element;
 }
+class Presence {
+  constructor(changeContext, presence) {
+    __publicField(this, "context");
+    __publicField(this, "presence");
+    this.context = changeContext;
+    this.presence = presence;
+  }
+  /**
+   * `set` updates the presence based on the partial presence.
+   */
+  set(presence, option) {
+    for (const key of Object.keys(presence)) {
+      this.presence[key] = presence[key];
+    }
+    this.context.setPresenceChange({
+      type: PresenceChangeType.Put,
+      presence: deepcopy(this.presence)
+    });
+    this.context.setReversePresence(presence, option);
+  }
+  /**
+   * `get` returns the presence value of the given key.
+   */
+  get(key) {
+    return this.presence[key];
+  }
+  /**
+   * `clear` clears the presence.
+   * @internal
+   */
+  clear() {
+    this.presence = {};
+    this.context.setPresenceChange({
+      type: PresenceChangeType.Clear
+    });
+  }
+}
 const MaxUndoRedoStackDepth = 50;
 class History {
   constructor() {
@@ -19235,7 +19282,7 @@ class Document {
     this.ensureClone();
     const actorID = this.changeID.getActorID();
     const context = ChangeContext.create(
-      this.changeID.next(),
+      this.changeID,
       this.clone.root,
       this.clone.presences.get(actorID) || {},
       message
@@ -19263,7 +19310,7 @@ class Document {
       if (logger.isEnabled(LogLevel.Trivial)) {
         logger.trivial(`trying to update a local change: ${this.toJSON()}`);
       }
-      const change = context.getChange();
+      const change = context.toChange();
       const { opInfos, reverseOps } = change.execute(
         this.root,
         this.presences,
@@ -19283,7 +19330,7 @@ class Document {
       if (opInfos.length > 0) {
         this.internalHistory.clearRedo();
       }
-      this.changeID = change.getID();
+      this.changeID = context.getNextID();
       const event = [];
       if (opInfos.length > 0) {
         event.push({
@@ -20152,14 +20199,6 @@ class Document {
   canUndo() {
     return this.internalHistory.hasUndo() && !this.isUpdating;
   }
-  /**
-   * 'filterVersionVector' filters detached client's lamport from version vector.
-   */
-  filterVersionVector(minSyncedVersionVector) {
-    const versionVector = this.changeID.getVersionVector();
-    const filteredVersionVector = versionVector.filter(minSyncedVersionVector);
-    this.changeID = this.changeID.setVersionVector(filteredVersionVector);
-  }
   /**
    * `canRedo` returns whether there are any operations to redo.
    */
@@ -20186,7 +20225,7 @@ class Document {
     }
     this.ensureClone();
     const context = ChangeContext.create(
-      this.changeID.next(),
+      this.changeID,
       this.clone.root,
       this.clone.presences.get(this.changeID.getActorID()) || {}
     );
@@ -20203,7 +20242,7 @@ class Document {
       undoOp.setExecutedAt(ticket);
       context.push(undoOp);
     }
-    const change = context.getChange();
+    const change = context.toChange();
     change.execute(this.clone.root, this.clone.presences, OpSource.UndoRedo);
     const { opInfos, reverseOps } = change.execute(
       this.root,
@@ -20224,7 +20263,7 @@ class Document {
       return;
     }
     this.localChanges.push(change);
-    this.changeID = change.getID();
+    this.changeID = context.getNextID();
     const actorID = this.changeID.getActorID();
     const event = [];
     if (opInfos.length > 0) {
@@ -20273,7 +20312,7 @@ class Document {
     }
     this.ensureClone();
     const context = ChangeContext.create(
-      this.changeID.next(),
+      this.changeID,
       this.clone.root,
       this.clone.presences.get(this.changeID.getActorID()) || {}
     );
@@ -20290,7 +20329,7 @@ class Document {
       redoOp.setExecutedAt(ticket);
       context.push(redoOp);
     }
-    const change = context.getChange();
+    const change = context.toChange();
     change.execute(this.clone.root, this.clone.presences, OpSource.UndoRedo);
     const { opInfos, reverseOps } = change.execute(
       this.root,
@@ -20311,7 +20350,7 @@ class Document {
       return;
     }
     this.localChanges.push(change);
-    this.changeID = change.getID();
+    this.changeID = context.getNextID();
     const actorID = this.changeID.getActorID();
     const event = [];
     if (opInfos.length > 0) {
@@ -20390,7 +20429,7 @@ function createAuthInterceptor(apiKey, token) {
   };
 }
 const name = "@yorkie-js/sdk";
-const version = "0.6.11-rc";
+const version = "0.6.12";
 const pkg = {
   name,
   version
@@ -20558,16 +20597,15 @@ class Client {
     if (this.status === "deactivated") {
       return Promise.resolve();
     }
-    this.deactivateInternal();
     const task = async () => {
       try {
         await this.rpcClient.deactivateClient(
           { clientId: this.id },
           { headers: { "x-shard-key": this.apiKey } }
         );
+        this.deactivateInternal();
         logger.info(`[DC] c"${this.getKey()}" deactivated`);
       } catch (err) {
-        this.status = "activated";
         logger.error(`[DC] c:"${this.getKey()}" err :`, err);
         await this.handleConnectError(err);
         throw err;
@@ -20651,12 +20689,12 @@ class Client {
           await this.runWatchLoop(doc.getKey());
         }
         logger.info(`[AD] c:"${this.getKey()}" attaches d:"${doc.getKey()}"`);
-        const crdtRoot = doc.getRootObject();
+        const crdtObject = doc.getRootObject();
         if (opts.initialRoot) {
           const initialRoot = opts.initialRoot;
           doc.update((root) => {
             for (const [k, v] of Object.entries(initialRoot)) {
-              if (!crdtRoot.has(k)) {
+              if (!crdtObject.has(k)) {
                 const key = k;
                 root[key] = v;
               }
@@ -20679,7 +20717,7 @@ class Client {
    * the changes should be applied to other replicas before GC time. For this,
    * if the document is no longer used by this client, it should be detached.
    */
-  detach(doc, opts = { removeIfNotAttached: false }) {
+  detach(doc, opts = { keepalive: false }) {
     if (!this.isActive()) {
       throw new YorkieError(
         Code.ErrClientNotActivated,
@@ -20694,14 +20732,14 @@ class Client {
       );
     }
     doc.update((_, p) => p.clear());
-    return this.enqueueTask(async () => {
+    const task = async () => {
       try {
         const res = await this.rpcClient.detachDocument(
           {
             clientId: this.id,
             documentId: attachment.docID,
             changePack: converter.toChangePack(doc.createChangePack()),
-            removeIfNotAttached: opts.removeIfNotAttached
+            removeIfNotAttached: opts.removeIfNotAttached ?? false
           },
           { headers: { "x-shard-key": `${this.apiKey}/${doc.getKey()}` } }
         );
@@ -20718,7 +20756,14 @@ class Client {
         await this.handleConnectError(err);
         throw err;
       }
-    });
+    };
+    if (opts.keepalive) {
+      this.keepalive = true;
+      const resp = task();
+      this.keepalive = false;
+      return resp;
+    }
+    return this.enqueueTask(task);
   }
   /**
    * `changeRealtimeSync` changes the synchronization mode of the given document.