@liveblocks/node 3.14.0-pre5 → 3.14.0-rc1

package/dist/index.d.cts

@@ -78,7 +78,11 @@ type LiveblocksOptions = {
 type CreateSessionOptions<U extends BaseUserMeta = DU> = PartialUnless<U["info"], {
     userInfo: U["info"];
 }> & {
+    /**
+     * @deprecated Use `organizationId` instead.
+     */
     tenantId?: string;
+    organizationId?: string;
 };
 type IdentifyUserOptions<U extends BaseUserMeta = DU> = PartialUnless<U["info"], {
     userInfo: U["info"];
@@ -91,7 +95,11 @@ type AuthResponse = {
 type Identity = {
     userId: string;
     groupIds: string[];
+    /**
+     * @deprecated Use `organizationId` instead.
+     */
     tenantId?: string;
+    organizationId?: string;
 };
 type ThreadParticipants = {
     participantIds: string[];
@@ -130,6 +138,7 @@ type RoomData = {
     id: string;
     createdAt: Date;
     lastConnectionAt?: Date;
+    organizationId: string;
     defaultAccesses: RoomPermission;
     usersAccesses: RoomAccesses;
     groupsAccesses: RoomAccesses;
@@ -230,7 +239,11 @@ type CM = DCM;
 type S = DS;
 type U = DU;
 type RoomsQueryCriteria = {
+    /**
+     * @deprecated Use `organizationId` instead.
+     */
     tenantId?: string;
+    organizationId?: string;
     userId?: string;
     groupIds?: string[];
     /**
@@ -264,7 +277,11 @@ type RoomsQueryCriteria = {
 };
 type InboxNotificationsQueryCriteria = {
     userId: string;
+    /**
+     * @deprecated Use `organizationId` instead.
+     */
     tenantId?: string;
+    organizationId?: string;
     /**
      * The query to filter inbox notifications by. It is based on our query language.
      *
@@ -304,11 +321,15 @@ type CreateRoomOptions = {
     groupsAccesses?: RoomAccesses;
     usersAccesses?: RoomAccesses;
     metadata?: RoomMetadata;
+    /**
+     * @deprecated Use `organizationId` instead.
+     */
     tenantId?: string;
+    organizationId?: string;
     /**
-     * @private Preferred storage engine version to use when creating the
-     * room. Only takes effect if the room doesn't exist yet. Version
-     * 2 supports streaming and will become the default in the future.
+     * Preferred storage engine version to use when creating the room. Only takes
+     * effect if the room doesn't exist yet. Version 2 can support larger
+     * documents, is more performant, and will become the default in the future.
      */
     engine?: 1 | 2;
 };
@@ -476,7 +497,7 @@ 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.organizationId (optional) The organization 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
@@ -528,7 +549,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.organizationId (optional) A filter on organization 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.
@@ -558,7 +579,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 params.organizationId (optional) The organization ID to create the room for.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created room.
      */
@@ -574,7 +595,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 params.organizationId (optional) The organization ID to create the room for.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The room.
      */
@@ -1034,7 +1055,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 params.organizationId (optional) The organization 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>>;
@@ -1046,7 +1067,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 criteria.organizationId (optional) The organization 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.
      */
@@ -1056,13 +1077,17 @@ 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.organizationId (optional) The organization 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;
+        organizationId?: string;
+        /**
+         * @deprecated Use `organizationId` instead.
+         */
         tenantId?: string;
     } & PaginationOptions, options?: RequestOptions): Promise<Page<UserRoomSubscriptionSettings>>;
     /**
@@ -1114,13 +1139,17 @@ declare class Liveblocks {
      * @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 params.organizationId (optional) The organization 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;
+        organizationId?: string;
+        /**
+         * @deprecated Use `organizationId` instead.
+         */
         tenantId?: string;
         subjectId: string;
         activityData: DAD[K];
@@ -1138,11 +1167,15 @@ 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 params.organizationId (optional) The organization ID to delete the inbox notifications for.
      * @param options.signal (optional) An abort signal to cancel the request.
      */
     deleteAllInboxNotifications(params: {
         userId: string;
+        organizationId?: string;
+        /**
+         * @deprecated Use `organizationId` instead.
+         */
         tenantId?: string;
     }, options?: RequestOptions): Promise<void>;
     /**
@@ -1175,13 +1208,17 @@ declare class Liveblocks {
      * 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.organizationId (optional) The organization 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[];
+        organizationId?: string;
+        /**
+         * @deprecated Use `organizationId` instead.
+         */
         tenantId?: string;
         scopes?: GroupScopes;
     }, options?: RequestOptions): Promise<GroupData>;

package/dist/index.d.ts

@@ -78,7 +78,11 @@ type LiveblocksOptions = {
 type CreateSessionOptions<U extends BaseUserMeta = DU> = PartialUnless<U["info"], {
     userInfo: U["info"];
 }> & {
+    /**
+     * @deprecated Use `organizationId` instead.
+     */
     tenantId?: string;
+    organizationId?: string;
 };
 type IdentifyUserOptions<U extends BaseUserMeta = DU> = PartialUnless<U["info"], {
     userInfo: U["info"];
@@ -91,7 +95,11 @@ type AuthResponse = {
 type Identity = {
     userId: string;
     groupIds: string[];
+    /**
+     * @deprecated Use `organizationId` instead.
+     */
     tenantId?: string;
+    organizationId?: string;
 };
 type ThreadParticipants = {
     participantIds: string[];
@@ -130,6 +138,7 @@ type RoomData = {
     id: string;
     createdAt: Date;
     lastConnectionAt?: Date;
+    organizationId: string;
     defaultAccesses: RoomPermission;
     usersAccesses: RoomAccesses;
     groupsAccesses: RoomAccesses;
@@ -230,7 +239,11 @@ type CM = DCM;
 type S = DS;
 type U = DU;
 type RoomsQueryCriteria = {
+    /**
+     * @deprecated Use `organizationId` instead.
+     */
     tenantId?: string;
+    organizationId?: string;
     userId?: string;
     groupIds?: string[];
     /**
@@ -264,7 +277,11 @@ type RoomsQueryCriteria = {
 };
 type InboxNotificationsQueryCriteria = {
     userId: string;
+    /**
+     * @deprecated Use `organizationId` instead.
+     */
     tenantId?: string;
+    organizationId?: string;
     /**
      * The query to filter inbox notifications by. It is based on our query language.
      *
@@ -304,11 +321,15 @@ type CreateRoomOptions = {
     groupsAccesses?: RoomAccesses;
     usersAccesses?: RoomAccesses;
     metadata?: RoomMetadata;
+    /**
+     * @deprecated Use `organizationId` instead.
+     */
     tenantId?: string;
+    organizationId?: string;
     /**
-     * @private Preferred storage engine version to use when creating the
-     * room. Only takes effect if the room doesn't exist yet. Version
-     * 2 supports streaming and will become the default in the future.
+     * Preferred storage engine version to use when creating the room. Only takes
+     * effect if the room doesn't exist yet. Version 2 can support larger
+     * documents, is more performant, and will become the default in the future.
      */
     engine?: 1 | 2;
 };
@@ -476,7 +497,7 @@ 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.organizationId (optional) The organization 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
@@ -528,7 +549,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.organizationId (optional) A filter on organization 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.
@@ -558,7 +579,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 params.organizationId (optional) The organization ID to create the room for.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created room.
      */
@@ -574,7 +595,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 params.organizationId (optional) The organization ID to create the room for.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The room.
      */
@@ -1034,7 +1055,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 params.organizationId (optional) The organization 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>>;
@@ -1046,7 +1067,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 criteria.organizationId (optional) The organization 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.
      */
@@ -1056,13 +1077,17 @@ 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.organizationId (optional) The organization 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;
+        organizationId?: string;
+        /**
+         * @deprecated Use `organizationId` instead.
+         */
         tenantId?: string;
     } & PaginationOptions, options?: RequestOptions): Promise<Page<UserRoomSubscriptionSettings>>;
     /**
@@ -1114,13 +1139,17 @@ declare class Liveblocks {
      * @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 params.organizationId (optional) The organization 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;
+        organizationId?: string;
+        /**
+         * @deprecated Use `organizationId` instead.
+         */
         tenantId?: string;
         subjectId: string;
         activityData: DAD[K];
@@ -1138,11 +1167,15 @@ 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 params.organizationId (optional) The organization ID to delete the inbox notifications for.
      * @param options.signal (optional) An abort signal to cancel the request.
      */
     deleteAllInboxNotifications(params: {
         userId: string;
+        organizationId?: string;
+        /**
+         * @deprecated Use `organizationId` instead.
+         */
         tenantId?: string;
     }, options?: RequestOptions): Promise<void>;
     /**
@@ -1175,13 +1208,17 @@ declare class Liveblocks {
      * 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.organizationId (optional) The organization 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[];
+        organizationId?: string;
+        /**
+         * @deprecated Use `organizationId` instead.
+         */
         tenantId?: string;
         scopes?: GroupScopes;
     }, options?: RequestOptions): Promise<GroupData>;