@liveblocks/node 2.24.0-sub1 → 2.24.1

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, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, NotificationChannel } from '@liveblocks/core';
+import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, SubscriptionData, Patchable, CommentUserReaction, InboxNotificationData, RoomSubscriptionSettings, UserRoomSubscriptionSettings, 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';
 
@@ -612,6 +612,20 @@ declare class Liveblocks {
         roomId: string;
         threadId: string;
     }, options?: RequestOptions): Promise<ThreadParticipants>;
+    /**
+     * 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.
+     */
+    getThreadSubscriptions(params: {
+        roomId: string;
+        threadId: string;
+    }, options?: RequestOptions): Promise<{
+        data: UserSubscriptionData[];
+    }>;
     /**
      * Gets a thread's comment.
      *
@@ -729,6 +743,35 @@ declare class Liveblocks {
             userId: string;
         };
     }, options?: RequestOptions): Promise<ThreadData<M>>;
+    /**
+     * 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.
+     */
+    subscribeToThread(params: {
+        roomId: string;
+        threadId: string;
+        data: {
+            userId: string;
+        };
+    }, options?: RequestOptions): Promise<SubscriptionData>;
+    /**
+     * 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.
+     */
+    unsubscribeFromThread(params: {
+        roomId: string;
+        threadId: string;
+        data: {
+            userId: string;
+        };
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Updates the metadata of the specified thread in a room.
      * @param params.roomId The room ID to update the thread in.
@@ -832,6 +875,16 @@ declare class Liveblocks {
         userId: string;
         roomId: string;
     }, options?: RequestOptions): Promise<RoomSubscriptionSettings>;
+    /**
+     * 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.
+     */
+    getUserRoomSubscriptionSettings(params: {
+        userId: string;
+    } & PaginationOptions, options?: RequestOptions): Promise<Page<UserRoomSubscriptionSettings>>;
     /**
      * Gets the user's room subscription settings.
      * @param params.userId The user ID to get the room subscription settings from.

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, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, NotificationChannel } from '@liveblocks/core';
+import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, SubscriptionData, Patchable, CommentUserReaction, InboxNotificationData, RoomSubscriptionSettings, UserRoomSubscriptionSettings, 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';
 
@@ -612,6 +612,20 @@ declare class Liveblocks {
         roomId: string;
         threadId: string;
     }, options?: RequestOptions): Promise<ThreadParticipants>;
+    /**
+     * 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.
+     */
+    getThreadSubscriptions(params: {
+        roomId: string;
+        threadId: string;
+    }, options?: RequestOptions): Promise<{
+        data: UserSubscriptionData[];
+    }>;
     /**
      * Gets a thread's comment.
      *
@@ -729,6 +743,35 @@ declare class Liveblocks {
             userId: string;
         };
     }, options?: RequestOptions): Promise<ThreadData<M>>;
+    /**
+     * 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.
+     */
+    subscribeToThread(params: {
+        roomId: string;
+        threadId: string;
+        data: {
+            userId: string;
+        };
+    }, options?: RequestOptions): Promise<SubscriptionData>;
+    /**
+     * 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.
+     */
+    unsubscribeFromThread(params: {
+        roomId: string;
+        threadId: string;
+        data: {
+            userId: string;
+        };
+    }, options?: RequestOptions): Promise<void>;
     /**
      * Updates the metadata of the specified thread in a room.
      * @param params.roomId The room ID to update the thread in.
@@ -832,6 +875,16 @@ declare class Liveblocks {
         userId: string;
         roomId: string;
     }, options?: RequestOptions): Promise<RoomSubscriptionSettings>;
+    /**
+     * 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.
+     */
+    getUserRoomSubscriptionSettings(params: {
+        userId: string;
+    } & PaginationOptions, options?: RequestOptions): Promise<Page<UserRoomSubscriptionSettings>>;
     /**
      * Gets the user's room subscription settings.
      * @param params.userId The user ID to get the room subscription settings from.

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-sub1";
+var PKG_VERSION = "2.24.1";
 var PKG_FORMAT = "esm";
 
 // src/client.ts
@@ -13,7 +13,9 @@ import {
   convertToCommentData,
   convertToCommentUserReaction,
   convertToInboxNotificationData,
+  convertToSubscriptionData,
   convertToThreadData,
+  convertToUserSubscriptionData,
   createManagedPool,
   createNotificationSettings,
   isPlainObject,
@@ -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(
+      url2`/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(convertToUserSubscriptionData)
+    };
+  }
   /**
    * Gets a thread's comment.
    *
@@ -1192,6 +1217,46 @@ var Liveblocks = class {
     }
     return convertToThreadData(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(
+      url2`/v2/rooms/${roomId}/threads/${threadId}/subscribe`,
+      { userId: params.data.userId },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    return convertToSubscriptionData(
+      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(
+      url2`/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.
@@ -1360,6 +1425,28 @@ var Liveblocks = class {
   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(
+      url2`/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.