@liveblocks/node 2.24.0-deque1 → 2.24.0-sub1

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, CommentData, CommentBody, Patchable, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, KDAD, DAD, UserNotificationSettings, PartialUserNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, NotificationChannel } from '@liveblocks/core';
+import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, CommentData, CommentBody, Patchable, CommentUserReaction, InboxNotificationData, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, NotificationChannel } from '@liveblocks/core';
 export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveMap, LiveObject, LiveStructure, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionedIdsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
@@ -821,37 +821,75 @@ declare class Liveblocks {
         pageSize?: number;
     }): AsyncGenerator<InboxNotificationData>;
     /**
-     * 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.
      */
     getRoomNotificationSettings(params: {
         userId: string;
         roomId: string;
-    }, options?: RequestOptions): Promise<RoomNotificationSettings>;
+    }, options?: RequestOptions): Promise<RoomSubscriptionSettings>;
+    /**
+     * 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.
+     */
+    getRoomSubscriptionSettings(params: {
+        userId: string;
+        roomId: string;
+    }, options?: RequestOptions): Promise<RoomSubscriptionSettings>;
     /**
-     * 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.
      */
     updateRoomNotificationSettings(params: {
         userId: string;
         roomId: string;
-        data: RoomNotificationSettings;
-    }, options?: RequestOptions): Promise<RoomNotificationSettings>;
+        data: Partial<RoomSubscriptionSettings>;
+    }, options?: RequestOptions): Promise<RoomSubscriptionSettings>;
     /**
-     * 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.
+     * 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.
+     */
+    updateRoomSubscriptionSettings(params: {
+        userId: string;
+        roomId: string;
+        data: Partial<RoomSubscriptionSettings>;
+    }, options?: RequestOptions): Promise<RoomSubscriptionSettings>;
+    /**
+     * @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.
      */
     deleteRoomNotificationSettings(params: {
         userId: string;
         roomId: string;
     }, options?: RequestOptions): Promise<void>;
+    /**
+     * 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.
+     */
+    deleteRoomSubscriptionSettings(params: {
+        userId: string;
+        roomId: string;
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Update a room ID.
      * @param params.roomId The current ID of the room.
@@ -894,7 +932,7 @@ declare class Liveblocks {
      */
     getNotificationSettings(params: {
         userId: string;
-    }, options?: RequestOptions): Promise<UserNotificationSettings>;
+    }, options?: RequestOptions): Promise<NotificationSettings>;
     /**
      * Update the user's notification settings.
      * @param params.userId The user ID to update the notification settings for.
@@ -903,8 +941,8 @@ declare class Liveblocks {
      */
     updateNotificationSettings(params: {
         userId: string;
-        data: PartialUserNotificationSettings;
-    }, options?: RequestOptions): Promise<UserNotificationSettings>;
+        data: PartialNotificationSettings;
+    }, options?: RequestOptions): Promise<NotificationSettings>;
     /**
      * Delete the user's notification settings
      * @param params.userId The user ID to update the notification settings for.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, CommentData, CommentBody, Patchable, CommentUserReaction, InboxNotificationData, RoomNotificationSettings, KDAD, DAD, UserNotificationSettings, PartialUserNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, NotificationChannel } from '@liveblocks/core';
+import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, CommentData, CommentBody, Patchable, CommentUserReaction, InboxNotificationData, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, NotificationChannel } from '@liveblocks/core';
 export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveMap, LiveObject, LiveStructure, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionedIdsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
@@ -821,37 +821,75 @@ declare class Liveblocks {
         pageSize?: number;
     }): AsyncGenerator<InboxNotificationData>;
     /**
-     * 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.
      */
     getRoomNotificationSettings(params: {
         userId: string;
         roomId: string;
-    }, options?: RequestOptions): Promise<RoomNotificationSettings>;
+    }, options?: RequestOptions): Promise<RoomSubscriptionSettings>;
+    /**
+     * 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.
+     */
+    getRoomSubscriptionSettings(params: {
+        userId: string;
+        roomId: string;
+    }, options?: RequestOptions): Promise<RoomSubscriptionSettings>;
     /**
-     * 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.
      */
     updateRoomNotificationSettings(params: {
         userId: string;
         roomId: string;
-        data: RoomNotificationSettings;
-    }, options?: RequestOptions): Promise<RoomNotificationSettings>;
+        data: Partial<RoomSubscriptionSettings>;
+    }, options?: RequestOptions): Promise<RoomSubscriptionSettings>;
     /**
-     * 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.
+     * 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.
+     */
+    updateRoomSubscriptionSettings(params: {
+        userId: string;
+        roomId: string;
+        data: Partial<RoomSubscriptionSettings>;
+    }, options?: RequestOptions): Promise<RoomSubscriptionSettings>;
+    /**
+     * @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.
      */
     deleteRoomNotificationSettings(params: {
         userId: string;
         roomId: string;
     }, options?: RequestOptions): Promise<void>;
+    /**
+     * 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.
+     */
+    deleteRoomSubscriptionSettings(params: {
+        userId: string;
+        roomId: string;
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Update a room ID.
      * @param params.roomId The current ID of the room.
@@ -894,7 +932,7 @@ declare class Liveblocks {
      */
     getNotificationSettings(params: {
         userId: string;
-    }, options?: RequestOptions): Promise<UserNotificationSettings>;
+    }, options?: RequestOptions): Promise<NotificationSettings>;
     /**
      * Update the user's notification settings.
      * @param params.userId The user ID to update the notification settings for.
@@ -903,8 +941,8 @@ declare class Liveblocks {
      */
     updateNotificationSettings(params: {
         userId: string;
-        data: PartialUserNotificationSettings;
-    }, options?: RequestOptions): Promise<UserNotificationSettings>;
+        data: PartialNotificationSettings;
+    }, options?: RequestOptions): Promise<NotificationSettings>;
     /**
      * Delete the user's notification settings
      * @param params.userId The user ID to update the notification settings for.

package/dist/index.js

@@ -3,7 +3,7 @@ import { detectDupes } from "@liveblocks/core";
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "2.24.0-deque1";
+var PKG_VERSION = "2.24.0-sub1";
 var PKG_FORMAT = "esm";
 
 // src/client.ts
@@ -15,7 +15,7 @@ import {
   convertToInboxNotificationData,
   convertToThreadData,
   createManagedPool,
-  createUserNotificationSettings,
+  createNotificationSettings,
   isPlainObject,
   LiveObject,
   makeAbortController,
@@ -1350,15 +1350,26 @@ 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);
+  }
+  /**
+   * 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(
-      url2`/v2/rooms/${roomId}/users/${userId}/notification-settings`,
+      url2`/v2/rooms/${roomId}/users/${userId}/subscription-settings`,
       void 0,
       options
     );
@@ -1368,16 +1379,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(
-      url2`/v2/rooms/${roomId}/users/${userId}/notification-settings`,
+      url2`/v2/rooms/${roomId}/users/${userId}/subscription-settings`,
       data,
       options
     );
@@ -1387,15 +1410,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(
-      url2`/v2/rooms/${roomId}/users/${userId}/notification-settings`,
+      url2`/v2/rooms/${roomId}/users/${userId}/subscription-settings`,
       options
     );
     if (!res.ok) {
@@ -1478,7 +1512,7 @@ var Liveblocks = class {
       throw await LiveblocksError.from(res);
     }
     const plainSettings = await res.json();
-    const settings = createUserNotificationSettings(plainSettings);
+    const settings = createNotificationSettings(plainSettings);
     return settings;
   }
   /**
@@ -1498,7 +1532,7 @@ var Liveblocks = class {
       throw await LiveblocksError.from(res);
     }
     const plainSettings = await res.json();
-    const settings = createUserNotificationSettings(plainSettings);
+    const settings = createNotificationSettings(plainSettings);
     return settings;
   }
   /**