@liveblocks/node 3.6.0 → 3.7.0-preview1

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, SubscriptionData, Patchable, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, 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, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, GroupScopes, GroupData, 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, getMentionsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
@@ -75,7 +75,9 @@ type LiveblocksOptions = {
 };
 type CreateSessionOptions<U extends BaseUserMeta = DU> = PartialUnless<U["info"], {
     userInfo: U["info"];
-}>;
+}> & {
+    tenantId?: string;
+};
 type IdentifyUserOptions<U extends BaseUserMeta = DU> = PartialUnless<U["info"], {
     userInfo: U["info"];
 }>;
@@ -246,6 +248,7 @@ type RoomsQueryCriteria = {
 };
 type InboxNotificationsQueryCriteria = {
     userId: string;
+    tenantId?: string;
     /**
      * The query to filter inbox notifications by. It is based on our query language.
      *
@@ -285,6 +288,7 @@ type CreateRoomOptions = {
     groupsAccesses?: RoomAccesses;
     usersAccesses?: RoomAccesses;
     metadata?: RoomMetadata;
+    tenantId?: string;
 };
 type UpdateRoomOptions = {
     defaultAccesses?: RoomPermission | null;
@@ -427,6 +431,8 @@ declare class Liveblocks {
      * uniquely identify the user account in your system. The uniqueness of this
      * value will determine how many MAUs will be counted/billed.
      *
+     * @param tenantId (optional) The tenant ID to authorize the user for.
+     *
      * @param options.userInfo Custom metadata to attach to this user. Data you
      * add here will be visible to all other clients in the room, through the
      * `other.info` property.
@@ -477,6 +483,7 @@ declare class Liveblocks {
      * @param params.userId (optional) A filter on users accesses.
      * @param params.metadata (optional) A filter on metadata. Multiple metadata keys can be used to filter rooms.
      * @param params.groupIds (optional) A filter on groups accesses. Multiple groups can be used.
+     * @param params.tenantId (optional) A filter on tenant ID.
      * @param params.query (optional) A query to filter rooms by. It is based on our query language. You can filter by metadata and room ID.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns A list of rooms.
@@ -506,6 +513,7 @@ declare class Liveblocks {
      * @param params.groupsAccesses (optional) The group accesses for the room. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
      * @param params.usersAccesses (optional) The user accesses for the room. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
      * @param params.metadata (optional) The metadata for the room. Supports upto a maximum of 50 entries. Key length has a limit of 40 characters. Value length has a limit of 256 characters.
+     * @param params.tenantId (optional) The tenant ID to create the room for.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created room.
      */
@@ -521,6 +529,7 @@ declare class Liveblocks {
      * @param params.groupsAccesses (optional) The group accesses for the room if the room will be created. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
      * @param params.usersAccesses (optional) The user accesses for the room if the room will be created. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
      * @param params.metadata (optional) The metadata for the room if the room will be created. Supports upto a maximum of 50 entries. Key length has a limit of 40 characters. Value length has a limit of 256 characters.
+     * @param params.tenantId (optional) The tenant ID to create the room for.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The room.
      */
@@ -758,10 +767,14 @@ declare class Liveblocks {
         threadId: string;
     }, options?: RequestOptions): Promise<ThreadData<M>>;
     /**
+     * @deprecated Prefer using `getMentionsFromCommentBody` to extract mentions
+     * from comments and threads, or `Liveblocks.getThreadSubscriptions` to get
+     * the list of users who are subscribed to a thread.
+     *
      * Gets a thread's participants.
      *
      * Participants are users who have commented on the thread
-     * or users and groups that have been mentioned in a comment.
+     * or users that have been mentioned in a comment.
      *
      * @param params.roomId The room ID to get the thread participants from.
      * @param params.threadId The thread ID to get the participants from.
@@ -1006,6 +1019,7 @@ declare class Liveblocks {
      * Returns the inbox notifications for a user.
      * @param params.userId The user ID to get the inbox notifications from.
      * @param params.query The query to filter inbox notifications by. It is based on our query language and can filter by unread.
+     * @param params.tenantId (optional) The tenant ID to get the inbox notifications for.
      * @param options.signal (optional) An abort signal to cancel the request.
      */
     getInboxNotifications(params: GetInboxNotificationsOptions, options?: RequestOptions): Promise<Page<InboxNotificationData>>;
@@ -1017,6 +1031,7 @@ declare class Liveblocks {
      *
      * @param criteria.userId The user ID to get the inbox notifications from.
      * @param criteria.query The query to filter inbox notifications by. It is based on our query language and can filter by unread.
+     * @param criteria.tenantId (optional) The tenant ID to get the inbox notifications for.
      * @param options.pageSize (optional) The page size to use for each request.
      * @param options.signal (optional) An abort signal to cancel the request.
      */
@@ -1026,12 +1041,14 @@ declare class Liveblocks {
     /**
      * Returns all room subscription settings for a user.
      * @param params.userId The user ID to get the room subscription settings from.
+     * @param params.tenantId (optional) The tenant ID to get the room subscription settings for.
      * @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;
+        tenantId?: string;
     } & PaginationOptions, options?: RequestOptions): Promise<Page<UserRoomSubscriptionSettings>>;
     /**
      * Gets the user's room subscription settings.
@@ -1075,10 +1092,21 @@ declare class Liveblocks {
         currentRoomId: string;
         newRoomId: string;
     }, options?: RequestOptions): Promise<RoomData>;
+    /**
+     * Triggers an inbox notification for a user.
+     * @param params.userId The user ID to trigger the inbox notification for.
+     * @param params.kind The kind of inbox notification to trigger.
+     * @param params.subjectId The subject ID of the triggered inbox notification.
+     * @param params.activityData The activity data of the triggered inbox notification.
+     * @param params.roomId (optional) The room ID to trigger the inbox notification for.
+     * @param params.tenantId (optional) The tenant ID to trigger the inbox notification for.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
     triggerInboxNotification<K extends KDAD>(params: {
         userId: string;
         kind: K;
         roomId?: string;
+        tenantId?: string;
         subjectId: string;
         activityData: DAD[K];
     }, options?: RequestOptions): Promise<void>;
@@ -1095,10 +1123,12 @@ declare class Liveblocks {
     /**
      * Deletes all inbox notifications for a user.
      * @param params.userId The user ID for which to delete all the inbox notifications.
+     * @param params.tenantId (optional) The tenant ID to delete the inbox notifications for.
      * @param options.signal (optional) An abort signal to cancel the request.
      */
     deleteAllInboxNotifications(params: {
         userId: string;
+        tenantId?: string;
     }, options?: RequestOptions): Promise<void>;
     /**
      * Get notification settings for a user for a project.
@@ -1126,6 +1156,73 @@ declare class Liveblocks {
     deleteNotificationSettings(params: {
         userId: string;
     }, options?: RequestOptions): Promise<void>;
+    /**
+     * Create a group
+     * @param params.groupId The ID of the group to create.
+     * @param params.memberIds The IDs of the members to add to the group.
+     * @param params.tenantId (optional) The tenant ID to create the group for.
+     * @param params.scopes (optional) The scopes to grant to the group. The default is `{ mention: true }`.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    createGroup(params: {
+        groupId: string;
+        memberIds?: string[];
+        tenantId?: string;
+        scopes?: GroupScopes;
+    }, options?: RequestOptions): Promise<GroupData>;
+    /**
+     * Get a group
+     * @param params.groupId The ID of the group to get.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    getGroup(params: {
+        groupId: string;
+    }, options?: RequestOptions): Promise<GroupData>;
+    /**
+     * Add members to a group
+     * @param params.groupId The ID of the group to add members to.
+     * @param params.memberIds The IDs of the members to add to the group.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    addGroupMembers(params: {
+        groupId: string;
+        memberIds: string[];
+    }, options?: RequestOptions): Promise<GroupData>;
+    /**
+     * Remove members from a group
+     * @param params.groupId The ID of the group to remove members from.
+     * @param params.memberIds The IDs of the members to remove from the group.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    removeGroupMembers(params: {
+        groupId: string;
+        memberIds: string[];
+    }, options?: RequestOptions): Promise<GroupData>;
+    /**
+     * Delete a group
+     * @param params.groupId The ID of the group to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    deleteGroup(params: {
+        groupId: string;
+    }, options?: RequestOptions): Promise<void>;
+    /**
+     * Get all groups
+     * @param params.limit (optional) The number of groups to return.
+     * @param params.startingAfter (optional) The cursor to start the pagination from.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    getGroups(params?: PaginationOptions, options?: RequestOptions): Promise<Page<GroupData>>;
+    /**
+     * Returns all groups a user is a member of.
+     * @param params.userId The user ID to get the groups for.
+     * @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.
+     */
+    getUserGroups(params: {
+        userId: string;
+    } & PaginationOptions, options?: RequestOptions): Promise<Page<GroupData>>;
     /**
      * Retrieves the current Storage contents for the given room ID and calls the
      * provided callback function, in which you can mutate the Storage contents

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, SubscriptionData, Patchable, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, 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, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, GroupScopes, GroupData, 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, getMentionsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
@@ -75,7 +75,9 @@ type LiveblocksOptions = {
 };
 type CreateSessionOptions<U extends BaseUserMeta = DU> = PartialUnless<U["info"], {
     userInfo: U["info"];
-}>;
+}> & {
+    tenantId?: string;
+};
 type IdentifyUserOptions<U extends BaseUserMeta = DU> = PartialUnless<U["info"], {
     userInfo: U["info"];
 }>;
@@ -246,6 +248,7 @@ type RoomsQueryCriteria = {
 };
 type InboxNotificationsQueryCriteria = {
     userId: string;
+    tenantId?: string;
     /**
      * The query to filter inbox notifications by. It is based on our query language.
      *
@@ -285,6 +288,7 @@ type CreateRoomOptions = {
     groupsAccesses?: RoomAccesses;
     usersAccesses?: RoomAccesses;
     metadata?: RoomMetadata;
+    tenantId?: string;
 };
 type UpdateRoomOptions = {
     defaultAccesses?: RoomPermission | null;
@@ -427,6 +431,8 @@ declare class Liveblocks {
      * uniquely identify the user account in your system. The uniqueness of this
      * value will determine how many MAUs will be counted/billed.
      *
+     * @param tenantId (optional) The tenant ID to authorize the user for.
+     *
      * @param options.userInfo Custom metadata to attach to this user. Data you
      * add here will be visible to all other clients in the room, through the
      * `other.info` property.
@@ -477,6 +483,7 @@ declare class Liveblocks {
      * @param params.userId (optional) A filter on users accesses.
      * @param params.metadata (optional) A filter on metadata. Multiple metadata keys can be used to filter rooms.
      * @param params.groupIds (optional) A filter on groups accesses. Multiple groups can be used.
+     * @param params.tenantId (optional) A filter on tenant ID.
      * @param params.query (optional) A query to filter rooms by. It is based on our query language. You can filter by metadata and room ID.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns A list of rooms.
@@ -506,6 +513,7 @@ declare class Liveblocks {
      * @param params.groupsAccesses (optional) The group accesses for the room. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
      * @param params.usersAccesses (optional) The user accesses for the room. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
      * @param params.metadata (optional) The metadata for the room. Supports upto a maximum of 50 entries. Key length has a limit of 40 characters. Value length has a limit of 256 characters.
+     * @param params.tenantId (optional) The tenant ID to create the room for.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created room.
      */
@@ -521,6 +529,7 @@ declare class Liveblocks {
      * @param params.groupsAccesses (optional) The group accesses for the room if the room will be created. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
      * @param params.usersAccesses (optional) The user accesses for the room if the room will be created. Can contain a maximum of 100 entries. Key length has a limit of 40 characters.
      * @param params.metadata (optional) The metadata for the room if the room will be created. Supports upto a maximum of 50 entries. Key length has a limit of 40 characters. Value length has a limit of 256 characters.
+     * @param params.tenantId (optional) The tenant ID to create the room for.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The room.
      */
@@ -758,10 +767,14 @@ declare class Liveblocks {
         threadId: string;
     }, options?: RequestOptions): Promise<ThreadData<M>>;
     /**
+     * @deprecated Prefer using `getMentionsFromCommentBody` to extract mentions
+     * from comments and threads, or `Liveblocks.getThreadSubscriptions` to get
+     * the list of users who are subscribed to a thread.
+     *
      * Gets a thread's participants.
      *
      * Participants are users who have commented on the thread
-     * or users and groups that have been mentioned in a comment.
+     * or users that have been mentioned in a comment.
      *
      * @param params.roomId The room ID to get the thread participants from.
      * @param params.threadId The thread ID to get the participants from.
@@ -1006,6 +1019,7 @@ declare class Liveblocks {
      * Returns the inbox notifications for a user.
      * @param params.userId The user ID to get the inbox notifications from.
      * @param params.query The query to filter inbox notifications by. It is based on our query language and can filter by unread.
+     * @param params.tenantId (optional) The tenant ID to get the inbox notifications for.
      * @param options.signal (optional) An abort signal to cancel the request.
      */
     getInboxNotifications(params: GetInboxNotificationsOptions, options?: RequestOptions): Promise<Page<InboxNotificationData>>;
@@ -1017,6 +1031,7 @@ declare class Liveblocks {
      *
      * @param criteria.userId The user ID to get the inbox notifications from.
      * @param criteria.query The query to filter inbox notifications by. It is based on our query language and can filter by unread.
+     * @param criteria.tenantId (optional) The tenant ID to get the inbox notifications for.
      * @param options.pageSize (optional) The page size to use for each request.
      * @param options.signal (optional) An abort signal to cancel the request.
      */
@@ -1026,12 +1041,14 @@ declare class Liveblocks {
     /**
      * Returns all room subscription settings for a user.
      * @param params.userId The user ID to get the room subscription settings from.
+     * @param params.tenantId (optional) The tenant ID to get the room subscription settings for.
      * @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;
+        tenantId?: string;
     } & PaginationOptions, options?: RequestOptions): Promise<Page<UserRoomSubscriptionSettings>>;
     /**
      * Gets the user's room subscription settings.
@@ -1075,10 +1092,21 @@ declare class Liveblocks {
         currentRoomId: string;
         newRoomId: string;
     }, options?: RequestOptions): Promise<RoomData>;
+    /**
+     * Triggers an inbox notification for a user.
+     * @param params.userId The user ID to trigger the inbox notification for.
+     * @param params.kind The kind of inbox notification to trigger.
+     * @param params.subjectId The subject ID of the triggered inbox notification.
+     * @param params.activityData The activity data of the triggered inbox notification.
+     * @param params.roomId (optional) The room ID to trigger the inbox notification for.
+     * @param params.tenantId (optional) The tenant ID to trigger the inbox notification for.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
     triggerInboxNotification<K extends KDAD>(params: {
         userId: string;
         kind: K;
         roomId?: string;
+        tenantId?: string;
         subjectId: string;
         activityData: DAD[K];
     }, options?: RequestOptions): Promise<void>;
@@ -1095,10 +1123,12 @@ declare class Liveblocks {
     /**
      * Deletes all inbox notifications for a user.
      * @param params.userId The user ID for which to delete all the inbox notifications.
+     * @param params.tenantId (optional) The tenant ID to delete the inbox notifications for.
      * @param options.signal (optional) An abort signal to cancel the request.
      */
     deleteAllInboxNotifications(params: {
         userId: string;
+        tenantId?: string;
     }, options?: RequestOptions): Promise<void>;
     /**
      * Get notification settings for a user for a project.
@@ -1126,6 +1156,73 @@ declare class Liveblocks {
     deleteNotificationSettings(params: {
         userId: string;
     }, options?: RequestOptions): Promise<void>;
+    /**
+     * Create a group
+     * @param params.groupId The ID of the group to create.
+     * @param params.memberIds The IDs of the members to add to the group.
+     * @param params.tenantId (optional) The tenant ID to create the group for.
+     * @param params.scopes (optional) The scopes to grant to the group. The default is `{ mention: true }`.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    createGroup(params: {
+        groupId: string;
+        memberIds?: string[];
+        tenantId?: string;
+        scopes?: GroupScopes;
+    }, options?: RequestOptions): Promise<GroupData>;
+    /**
+     * Get a group
+     * @param params.groupId The ID of the group to get.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    getGroup(params: {
+        groupId: string;
+    }, options?: RequestOptions): Promise<GroupData>;
+    /**
+     * Add members to a group
+     * @param params.groupId The ID of the group to add members to.
+     * @param params.memberIds The IDs of the members to add to the group.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    addGroupMembers(params: {
+        groupId: string;
+        memberIds: string[];
+    }, options?: RequestOptions): Promise<GroupData>;
+    /**
+     * Remove members from a group
+     * @param params.groupId The ID of the group to remove members from.
+     * @param params.memberIds The IDs of the members to remove from the group.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    removeGroupMembers(params: {
+        groupId: string;
+        memberIds: string[];
+    }, options?: RequestOptions): Promise<GroupData>;
+    /**
+     * Delete a group
+     * @param params.groupId The ID of the group to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    deleteGroup(params: {
+        groupId: string;
+    }, options?: RequestOptions): Promise<void>;
+    /**
+     * Get all groups
+     * @param params.limit (optional) The number of groups to return.
+     * @param params.startingAfter (optional) The cursor to start the pagination from.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    getGroups(params?: PaginationOptions, options?: RequestOptions): Promise<Page<GroupData>>;
+    /**
+     * Returns all groups a user is a member of.
+     * @param params.userId The user ID to get the groups for.
+     * @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.
+     */
+    getUserGroups(params: {
+        userId: string;
+    } & PaginationOptions, options?: RequestOptions): Promise<Page<GroupData>>;
     /**
      * Retrieves the current Storage contents for the given room ID and calls the
      * provided callback function, in which you can mutate the Storage contents