@liveblocks/node 2.24.0-deque1 → 2.24.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 = "2.24.0-deque1";
+var PKG_VERSION = "2.24.0";
 var PKG_FORMAT = "cjs";
 
 // src/client.ts
@@ -25,6 +25,8 @@ var PKG_FORMAT = "cjs";
 
 
 
+
+
 // src/lib/itertools.ts
 async function asyncConsume(iterable) {
   const result = [];
@@ -1021,6 +1023,29 @@ var Liveblocks = class {
     }
     return await res.json();
   }
+  /**
+   * Gets a thread's subscriptions.
+   *
+   * @param params.roomId The room ID to get the thread subscriptions from.
+   * @param params.threadId The thread ID to get the subscriptions from.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns An array of subscriptions.
+   */
+  async getThreadSubscriptions(params, options) {
+    const { roomId, threadId } = params;
+    const res = await this.#get(
+      _core.url`/v2/rooms/${roomId}/threads/${threadId}/subscriptions`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    const { data } = await res.json();
+    return {
+      data: data.map(_core.convertToUserSubscriptionData)
+    };
+  }
   /**
    * Gets a thread's comment.
    *
@@ -1192,6 +1217,46 @@ var Liveblocks = class {
     }
     return _core.convertToThreadData.call(void 0, await res.json());
   }
+  /**
+   * Subscribes a user to a thread.
+   * @param params.roomId The room ID of the thread.
+   * @param params.threadId The thread ID to subscribe to.
+   * @param params.data.userId The user ID of the user to subscribe to the thread.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns The thread subscription.
+   */
+  async subscribeToThread(params, options) {
+    const { roomId, threadId } = params;
+    const res = await this.#post(
+      _core.url`/v2/rooms/${roomId}/threads/${threadId}/subscribe`,
+      { userId: params.data.userId },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    return _core.convertToSubscriptionData.call(void 0, 
+      await res.json()
+    );
+  }
+  /**
+   * Unsubscribes a user from a thread.
+   * @param params.roomId The room ID of the thread.
+   * @param params.threadId The thread ID to unsubscribe from.
+   * @param params.data.userId The user ID of the user to unsubscribe from the thread.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async unsubscribeFromThread(params, options) {
+    const { roomId, threadId } = params;
+    const res = await this.#post(
+      _core.url`/v2/rooms/${roomId}/threads/${threadId}/unsubscribe`,
+      { userId: params.data.userId },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+  }
   /**
    * Updates the metadata of the specified thread in a room.
    * @param params.roomId The room ID to update the thread in.
@@ -1350,15 +1415,48 @@ var Liveblocks = class {
     }
   }
   /**
-   * Gets the user's room notification settings.
-   * @param params.userId The user ID to get the room notifications from.
-   * @param params.roomId The room ID to get the room notification settings from.
+   * @deprecated Renamed to `getRoomSubscriptionSettings`
+   *
+   * Gets the user's room subscription settings.
+   * @param params.userId The user ID to get the room subscription settings from.
+   * @param params.roomId The room ID to get the room subscription settings from.
    * @param options.signal (optional) An abort signal to cancel the request.
    */
   async getRoomNotificationSettings(params, options) {
+    return this.getRoomSubscriptionSettings(params, options);
+  }
+  /**
+   * Returns all room subscription settings for a user.
+   * @param params.userId The user ID to get the room subscription settings from.
+   * @param params.startingAfter (optional) The cursor to start the pagination from.
+   * @param params.limit (optional) The number of items to return.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async getUserRoomSubscriptionSettings(params, options) {
+    const { userId, startingAfter, limit } = params;
+    const res = await this.#get(
+      _core.url`/v2/users/${userId}/room-subscription-settings`,
+      {
+        startingAfter,
+        limit
+      },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    return await res.json();
+  }
+  /**
+   * Gets the user's room subscription settings.
+   * @param params.userId The user ID to get the room subscription settings from.
+   * @param params.roomId The room ID to get the room subscription settings from.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async getRoomSubscriptionSettings(params, options) {
     const { userId, roomId } = params;
     const res = await this.#get(
-      _core.url`/v2/rooms/${roomId}/users/${userId}/notification-settings`,
+      _core.url`/v2/rooms/${roomId}/users/${userId}/subscription-settings`,
       void 0,
       options
     );
@@ -1368,16 +1466,28 @@ var Liveblocks = class {
     return await res.json();
   }
   /**
-   * Updates the user's room notification settings.
-   * @param params.userId The user ID to update the room notification settings for.
-   * @param params.roomId The room ID to update the room notification settings for.
-   * @param params.data The new room notification settings for the user.
+   * @deprecated Renamed to `updateRoomSubscriptionSettings`
+   *
+   * Updates the user's room subscription settings.
+   * @param params.userId The user ID to update the room subscription settings for.
+   * @param params.roomId The room ID to update the room subscription settings for.
+   * @param params.data The new room subscription settings for the user.
    * @param options.signal (optional) An abort signal to cancel the request.
    */
   async updateRoomNotificationSettings(params, options) {
+    return this.updateRoomSubscriptionSettings(params, options);
+  }
+  /**
+   * Updates the user's room subscription settings.
+   * @param params.userId The user ID to update the room subscription settings for.
+   * @param params.roomId The room ID to update the room subscription settings for.
+   * @param params.data The new room subscription settings for the user.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async updateRoomSubscriptionSettings(params, options) {
     const { userId, roomId, data } = params;
     const res = await this.#post(
-      _core.url`/v2/rooms/${roomId}/users/${userId}/notification-settings`,
+      _core.url`/v2/rooms/${roomId}/users/${userId}/subscription-settings`,
       data,
       options
     );
@@ -1387,15 +1497,26 @@ var Liveblocks = class {
     return await res.json();
   }
   /**
-   * Delete the user's room notification settings.
-   * @param params.userId The user ID to delete the room notification settings from.
-   * @param params.roomId The room ID to delete the room notification settings from.
+   * @deprecated Renamed to `deleteRoomSubscriptionSettings`
+   *
+   * Delete the user's room subscription settings.
+   * @param params.userId The user ID to delete the room subscription settings from.
+   * @param params.roomId The room ID to delete the room subscription settings from.
    * @param options.signal (optional) An abort signal to cancel the request.
    */
   async deleteRoomNotificationSettings(params, options) {
+    return this.deleteRoomSubscriptionSettings(params, options);
+  }
+  /**
+   * Delete the user's room subscription settings.
+   * @param params.userId The user ID to delete the room subscription settings from.
+   * @param params.roomId The room ID to delete the room subscription settings from.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async deleteRoomSubscriptionSettings(params, options) {
     const { userId, roomId } = params;
     const res = await this.#delete(
-      _core.url`/v2/rooms/${roomId}/users/${userId}/notification-settings`,
+      _core.url`/v2/rooms/${roomId}/users/${userId}/subscription-settings`,
       options
     );
     if (!res.ok) {
@@ -1478,7 +1599,7 @@ var Liveblocks = class {
       throw await LiveblocksError.from(res);
     }
     const plainSettings = await res.json();
-    const settings = _core.createUserNotificationSettings.call(void 0, plainSettings);
+    const settings = _core.createNotificationSettings.call(void 0, plainSettings);
     return settings;
   }
   /**
@@ -1498,7 +1619,7 @@ var Liveblocks = class {
       throw await LiveblocksError.from(res);
     }
     const plainSettings = await res.json();
-    const settings = _core.createUserNotificationSettings.call(void 0, plainSettings);
+    const settings = _core.createNotificationSettings.call(void 0, plainSettings);
     return settings;
   }
   /**