@yorkie-js/sdk 0.6.27 → 0.6.28

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

@@ -783,10 +783,10 @@ export declare class Client {
      * immediately using `fetch` with the `keepalive` option enabled. This is
      * useful for ensuring the deactivation request completes even if the page is
      * being unloaded, such as in `beforeunload` or `unload` event listeners.
+     * If synchronous is true, the server will wait for all pending operations to
+     * complete before deactivating.
      */
-    deactivate(options?: {
-        keepalive: boolean;
-    }): Promise<void>;
+    deactivate(options?: DeactivateOptions): Promise<void>;
     /**
      * `hasDocument` checks if the given document is attached to this client.
      * @param docKey - the key of the document.
@@ -1896,6 +1896,25 @@ declare type DataSize = {
     meta: number;
 };
 
+/**
+ * `DeactivateOptions` are user-settable options used when deactivating clients.
+ */
+declare interface DeactivateOptions {
+    /**
+     * `keepalive` is used to enable the keepalive option when deactivating.
+     * If true, the client will request deactivation immediately using `fetch`
+     * with the `keepalive` option enabled. This is useful for ensuring the
+     * deactivation request completes even if the page is being unloaded.
+     */
+    keepalive?: boolean;
+    /**
+     * `synchronous` is used to enable the synchronous option when deactivating.
+     * If true, the server will wait for all pending operations to complete
+     * before deactivating.
+     */
+    synchronous?: boolean;
+}
+
 /**
  * `DecreasedDepthOf` represents the type of the decreased depth of the given depth.
  */
@@ -2569,11 +2588,17 @@ declare class Document_2<R, P extends Indexable = Indexable> {
      * `getMyPresence` returns the presence of the current client.
      */
     getMyPresence(): P;
+    /**
+     * `getOthersPresences` returns the presences of all other clients.
+     */
+    getOthersPresences(): Array<{
+        clientID: ActorID;
+        presence: P;
+    }>;
     /**
      * `getPresence` returns the presence of the given clientID.
      */
     getPresence(clientID: ActorID): P | undefined;
-    /* Excluded from this release type: getPresenceForTest */
     /**
      * `getPresences` returns the presences of online clients.
      */
@@ -2581,6 +2606,7 @@ declare class Document_2<R, P extends Indexable = Indexable> {
         clientID: ActorID;
         presence: P;
     }>;
+    /* Excluded from this release type: getPresenceForTest */
     /* Excluded from this release type: getSelfForTest */
     /* Excluded from this release type: getOthersForTest */
     /**

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

@@ -7059,6 +7059,10 @@ const _DeactivateClientRequest = class _DeactivateClientRequest extends Message
      * @generated from field: string client_id = 1;
      */
     __publicField(this, "clientId", "");
+    /**
+     * @generated from field: bool synchronous = 2;
+     */
+    __publicField(this, "synchronous", false);
     proto3.util.initPartial(data, this);
   }
   static fromBinary(bytes, options) {
@@ -7083,6 +7087,13 @@ __publicField(_DeactivateClientRequest, "fields", proto3.util.newFieldList(() =>
     kind: "scalar",
     T: 9
     /* ScalarType.STRING */
+  },
+  {
+    no: 2,
+    name: "synchronous",
+    kind: "scalar",
+    T: 8
+    /* ScalarType.BOOL */
   }
 ]));
 let DeactivateClientRequest = _DeactivateClientRequest;
@@ -21350,6 +21361,22 @@ class Document {
     const p = this.presences.get(this.changeID.getActorID());
     return p ? deepcopy(p) : {};
   }
+  /**
+   * `getOthersPresences` returns the presences of all other clients.
+   */
+  getOthersPresences() {
+    const others = [];
+    const myClientID = this.changeID.getActorID();
+    for (const clientID of this.onlineClients) {
+      if (clientID !== myClientID && this.presences.has(clientID)) {
+        others.push({
+          clientID,
+          presence: deepcopy(this.presences.get(clientID))
+        });
+      }
+    }
+    return others;
+  }
   /**
    * `getPresence` returns the presence of the given clientID.
    */
@@ -21361,16 +21388,6 @@ class Document {
     const p = this.presences.get(clientID);
     return p ? deepcopy(p) : void 0;
   }
-  /**
-   * `getPresenceForTest` returns the presence of the given clientID
-   * regardless of whether the client is online or not.
-   *
-   * @internal
-   */
-  getPresenceForTest(clientID) {
-    const p = this.presences.get(clientID);
-    return p ? deepcopy(p) : void 0;
-  }
   /**
    * `getPresences` returns the presences of online clients.
    */
@@ -21390,6 +21407,16 @@ class Document {
     }
     return presences;
   }
+  /**
+   * `getPresenceForTest` returns the presence of the given clientID
+   * regardless of whether the client is online or not.
+   *
+   * @internal
+   */
+  getPresenceForTest(clientID) {
+    const p = this.presences.get(clientID);
+    return p ? deepcopy(p) : void 0;
+  }
   /**
    * `getSelfForTest` returns the client that has attached this document.
    *
@@ -21664,7 +21691,7 @@ function createAuthInterceptor(apiKey, token) {
   };
 }
 const name = "@yorkie-js/sdk";
-const version = "0.6.27";
+const version = "0.6.28";
 const pkg = {
   name,
   version
@@ -21827,15 +21854,20 @@ class Client {
    * immediately using `fetch` with the `keepalive` option enabled. This is
    * useful for ensuring the deactivation request completes even if the page is
    * being unloaded, such as in `beforeunload` or `unload` event listeners.
+   * If synchronous is true, the server will wait for all pending operations to
+   * complete before deactivating.
    */
-  deactivate(options = { keepalive: false }) {
+  deactivate(options = { keepalive: false, synchronous: false }) {
     if (this.status === "deactivated") {
       return Promise.resolve();
     }
     const task = async () => {
       try {
         await this.rpcClient.deactivateClient(
-          { clientId: this.id },
+          {
+            clientId: this.id,
+            synchronous: options.synchronous
+          },
           { headers: { "x-shard-key": `${this.apiKey}/${this.key}` } }
         );
         this.deactivateInternal();