@liveblocks/node 3.22.0-rc1 → 3.22.0

package/dist/index.cjs

@@ -3,7 +3,7 @@ var _core = require('@liveblocks/core');
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "3.22.0-rc1";
+var PKG_VERSION = "3.22.0";
 var PKG_FORMAT = "cjs";
 
 // src/client.ts
@@ -337,6 +337,12 @@ function inflateWebKnowledgeSourceLink(link) {
     lastIndexedAt: new Date(link.lastIndexedAt)
   };
 }
+function inflateHistoryVersion(version) {
+  return {
+    ...version,
+    createdAt: new Date(version.createdAt)
+  };
+}
 var Liveblocks = class {
   #secret;
   #baseUrl;
@@ -777,7 +783,7 @@ var Liveblocks = class {
    */
   async getActiveUsers(roomId, options) {
     const res = await this.#get(
-      _core.url`/v2/rooms/${roomId}/active_users`,
+      _core.url`/v2/rooms/${roomId}/active-users`,
       void 0,
       options
     );
@@ -794,7 +800,7 @@ var Liveblocks = class {
    */
   async broadcastEvent(roomId, message, options) {
     const res = await this.#post(
-      _core.url`/v2/rooms/${roomId}/broadcast_event`,
+      _core.url`/v2/rooms/${roomId}/broadcast-event`,
       message,
       options
     );
@@ -961,6 +967,82 @@ var Liveblocks = class {
     }
     return res.arrayBuffer();
   }
+  /**
+   * Returns the version history snapshots for the room, sorted by creation date from newest to oldest.
+   * @param roomId The ID of the room to get the version history from.
+   * @param params.limit (optional) The number of versions to return. The limit can range between 1 and 100, and defaults to 20.
+   * @param params.cursor (optional) A cursor used for pagination. Get the value from the `nextCursor` response of the previous page.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns A list of version history snapshots and the next page cursor.
+   */
+  async getVersionHistory(roomId, params = {}, options) {
+    const res = await this.#get(
+      _core.url`/v2/rooms/${roomId}/versions`,
+      { limit: params.limit, cursor: params.cursor },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    const page = await res.json();
+    return {
+      nextCursor: page.nextCursor,
+      data: page.data.map(inflateHistoryVersion)
+    };
+  }
+  /**
+   * Creates a new version history snapshot of the room, capturing both its Storage and Yjs documents.
+   * @param roomId The ID of the room to create a version history snapshot for.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns The created version ID.
+   */
+  async createVersionHistorySnapshot(roomId, options) {
+    const res = await this.#post(
+      _core.url`/v2/rooms/${roomId}/versions`,
+      {},
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    return await res.json();
+  }
+  /**
+   * Returns a specific version of the room's Yjs document encoded as a binary Yjs update.
+   * @param params.roomId The room ID to get the Yjs document version from.
+   * @param params.versionId The ID of the version to get.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns The version's Yjs document encoded as a binary update.
+   */
+  async getYjsVersion(params, options) {
+    const { roomId, versionId } = params;
+    const res = await this.#get(
+      _core.url`/v2/rooms/${roomId}/versions/${versionId}/yjs`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    return res.arrayBuffer();
+  }
+  /**
+   * Permanently deletes a version from the room's history.
+   * @param params.roomId The room ID to delete the version in.
+   * @param params.versionId The ID of the version to delete.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async deleteVersion(params, options) {
+    const { roomId, versionId } = params;
+    const res = await this.#delete(
+      _core.url`/v2/rooms/${roomId}/versions/${versionId}`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+  }
   /* -------------------------------------------------------------------------------------------------
    * Comments
    * -----------------------------------------------------------------------------------------------*/
@@ -1933,7 +2015,7 @@ var Liveblocks = class {
     try {
       const resp = await this.#requestStorageMutation(roomId, { signal });
       const { actor, nodes } = resp;
-      const pool = _core.createManagedPool.call(void 0, roomId, {
+      const pool = _core.createManagedPool.call(void 0, {
         getCurrentConnectionId: () => actor,
         onDispatch: (ops, _reverse, _storageUpdates) => {
           if (ops.length === 0) return;