@liveblocks/node 3.6.0 → 3.7.0-preview1

package/dist/index.js

@@ -3,7 +3,7 @@ import { detectDupes } from "@liveblocks/core";
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "3.6.0";
+var PKG_VERSION = "3.7.0-preview1";
 var PKG_FORMAT = "esm";
 
 // src/client.ts
@@ -12,6 +12,7 @@ import {
   ClientMsgCode,
   convertToCommentData,
   convertToCommentUserReaction,
+  convertToGroupData,
   convertToInboxNotificationData,
   convertToSubscriptionData,
   convertToThreadData,
@@ -170,14 +171,16 @@ var Session = class {
   #postFn;
   #userId;
   #userInfo;
+  #tenantId;
   #sealed = false;
   #permissions = /* @__PURE__ */ new Map();
   /** @internal */
-  constructor(postFn, userId, userInfo) {
+  constructor(postFn, userId, userInfo, tenantId) {
     assertNonEmpty(userId, "userId");
     this.#postFn = postFn;
     this.#userId = userId;
     this.#userInfo = userInfo;
+    this.#tenantId = tenantId;
   }
   #getOrCreate(roomId) {
     if (this.#sealed) {
@@ -256,7 +259,8 @@ var Session = class {
         userId: this.#userId,
         permissions: this.serializePermissions(),
         // Optional metadata
-        userInfo: this.#userInfo
+        userInfo: this.#userInfo,
+        tenantId: this.#tenantId
       });
       return {
         status: normalizeStatusCode(resp.status),
@@ -361,8 +365,8 @@ var Liveblocks = class {
       signal: options?.signal
     });
   }
-  async #delete(path, options) {
-    const url3 = urljoin(this.#baseUrl, path);
+  async #delete(path, params, options) {
+    const url3 = urljoin(this.#baseUrl, path, params);
     const headers = {
       Authorization: `Bearer ${this.#secret}`
     };
@@ -401,6 +405,8 @@ var Liveblocks = class {
    * 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.
@@ -408,7 +414,12 @@ var Liveblocks = class {
    */
   prepareSession(userId, ...rest) {
     const options = rest[0];
-    return new Session(this.#post.bind(this), userId, options?.userInfo);
+    return new Session(
+      this.#post.bind(this),
+      userId,
+      options?.userInfo,
+      options?.tenantId
+    );
   }
   /**
    * Call this to authenticate the user as an actor you want to allow to use
@@ -481,6 +492,7 @@ var Liveblocks = class {
    * @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.
@@ -550,6 +562,7 @@ var Liveblocks = class {
    * @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.
    */
@@ -581,6 +594,7 @@ var Liveblocks = class {
    * @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.
    */
@@ -660,7 +674,11 @@ var Liveblocks = class {
    * @param options.signal (optional) An abort signal to cancel the request.
    */
   async deleteRoom(roomId, options) {
-    const res = await this.#delete(url2`/v2/rooms/${roomId}`, options);
+    const res = await this.#delete(
+      url2`/v2/rooms/${roomId}`,
+      void 0,
+      options
+    );
     if (!res.ok) {
       throw await LiveblocksError.from(res);
     }
@@ -759,7 +777,11 @@ var Liveblocks = class {
    * @param options.signal (optional) An abort signal to cancel the request.
    */
   async deleteStorageDocument(roomId, options) {
-    const res = await this.#delete(url2`/v2/rooms/${roomId}/storage`, options);
+    const res = await this.#delete(
+      url2`/v2/rooms/${roomId}/storage`,
+      void 0,
+      options
+    );
     if (!res.ok) {
       throw await LiveblocksError.from(res);
     }
@@ -905,7 +927,11 @@ var Liveblocks = class {
    * @param options.signal (optional) An abort signal to cancel the request.
    */
   async deleteSchema(schemaId, options) {
-    const res = await this.#delete(url2`/v2/schemas/${schemaId}`, options);
+    const res = await this.#delete(
+      url2`/v2/schemas/${schemaId}`,
+      void 0,
+      options
+    );
     if (!res.ok) {
       throw await LiveblocksError.from(res);
     }
@@ -959,7 +985,11 @@ var Liveblocks = class {
    * @param options.signal (optional) An abort signal to cancel the request.
    */
   async detachSchemaFromRoom(roomId, options) {
-    const res = await this.#delete(url2`/v2/rooms/${roomId}/schema`, options);
+    const res = await this.#delete(
+      url2`/v2/rooms/${roomId}/schema`,
+      void 0,
+      options
+    );
     if (!res.ok) {
       throw await LiveblocksError.from(res);
     }
@@ -1017,10 +1047,14 @@ var Liveblocks = class {
     return convertToThreadData(await res.json());
   }
   /**
+   * @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.
@@ -1142,6 +1176,7 @@ var Liveblocks = class {
     const { roomId, threadId, commentId } = params;
     const res = await this.#delete(
       url2`/v2/rooms/${roomId}/threads/${threadId}/comments/${commentId}`,
+      void 0,
       options
     );
     if (!res.ok) {
@@ -1187,6 +1222,7 @@ var Liveblocks = class {
     const { roomId, threadId } = params;
     const res = await this.#delete(
       url2`/v2/rooms/${roomId}/threads/${threadId}`,
+      void 0,
       options
     );
     if (!res.ok) {
@@ -1373,10 +1409,11 @@ var Liveblocks = class {
    * 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.
    */
   async getInboxNotifications(params, options) {
-    const { userId } = params;
+    const { userId, tenantId, limit, startingAfter } = params;
     let query;
     if (typeof params.query === "string") {
       query = params.query;
@@ -1387,8 +1424,9 @@ var Liveblocks = class {
       url2`/v2/users/${userId}/inbox-notifications`,
       {
         query,
-        limit: params?.limit,
-        startingAfter: params?.startingAfter
+        limit,
+        startingAfter,
+        tenantId
       },
       options
     );
@@ -1409,6 +1447,7 @@ var Liveblocks = class {
    *
    * @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.
    */
@@ -1433,15 +1472,17 @@ var Liveblocks = class {
   /**
    * 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.
    */
   async getUserRoomSubscriptionSettings(params, options) {
-    const { userId, startingAfter, limit } = params;
+    const { userId, tenantId, startingAfter, limit } = params;
     const res = await this.#get(
       url2`/v2/users/${userId}/room-subscription-settings`,
       {
+        tenantId,
         startingAfter,
         limit
       },
@@ -1499,6 +1540,7 @@ var Liveblocks = class {
     const { userId, roomId } = params;
     const res = await this.#delete(
       url2`/v2/rooms/${roomId}/users/${userId}/subscription-settings`,
+      void 0,
       options
     );
     if (!res.ok) {
@@ -1524,6 +1566,16 @@ var Liveblocks = class {
     const data = await res.json();
     return inflateRoomData(data);
   }
+  /**
+   * 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.
+   */
   async triggerInboxNotification(params, options) {
     const res = await this.#post(
       url2`/v2/inbox-notifications/trigger`,
@@ -1544,6 +1596,7 @@ var Liveblocks = class {
     const { userId, inboxNotificationId } = params;
     const res = await this.#delete(
       url2`/v2/users/${userId}/inbox-notifications/${inboxNotificationId}`,
+      void 0,
       options
     );
     if (!res.ok) {
@@ -1553,12 +1606,14 @@ var Liveblocks = class {
   /**
    * 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.
    */
   async deleteAllInboxNotifications(params, options) {
-    const { userId } = params;
+    const { userId, tenantId } = params;
     const res = await this.#delete(
       url2`/v2/users/${userId}/inbox-notifications`,
+      { tenantId },
       options
     );
     if (!res.ok) {
@@ -1613,11 +1668,149 @@ var Liveblocks = class {
     const { userId } = params;
     const res = await this.#delete(
       url2`/v2/users/${userId}/notification-settings`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+  }
+  /**
+   * 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.
+   */
+  async createGroup(params, options) {
+    const res = await this.#post(
+      url2`/v2/groups`,
+      {
+        ...params,
+        // The REST API uses `id` since a group is a resource,
+        // but we use `groupId` here for consistency with the other methods.
+        id: params.groupId
+      },
       options
     );
     if (!res.ok) {
       throw await LiveblocksError.from(res);
     }
+    const group = await res.json();
+    return convertToGroupData(group);
+  }
+  /**
+   * Get a group
+   * @param params.groupId The ID of the group to get.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async getGroup(params, options) {
+    const res = await this.#get(
+      url2`/v2/groups/${params.groupId}`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    const group = await res.json();
+    return convertToGroupData(group);
+  }
+  /**
+   * 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.
+   */
+  async addGroupMembers(params, options) {
+    const res = await this.#post(
+      url2`/v2/groups/${params.groupId}/add-members`,
+      { memberIds: params.memberIds },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    const group = await res.json();
+    return convertToGroupData(group);
+  }
+  /**
+   * 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.
+   */
+  async removeGroupMembers(params, options) {
+    const res = await this.#post(
+      url2`/v2/groups/${params.groupId}/remove-members`,
+      { memberIds: params.memberIds },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    const group = await res.json();
+    return convertToGroupData(group);
+  }
+  /**
+   * Delete a group
+   * @param params.groupId The ID of the group to delete.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async deleteGroup(params, options) {
+    const res = await this.#delete(
+      url2`/v2/groups/${params.groupId}`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+  }
+  /**
+   * 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.
+   */
+  async getGroups(params, options) {
+    const res = await this.#get(
+      url2`/v2/groups`,
+      { startingAfter: params?.startingAfter, limit: params?.limit },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    const page = await res.json();
+    return {
+      ...page,
+      data: page.data.map(convertToGroupData)
+    };
+  }
+  /**
+   * 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.
+   */
+  async getUserGroups(params, options) {
+    const { userId, startingAfter, limit } = params;
+    const res = await this.#get(
+      url2`/v2/users/${userId}/groups`,
+      { startingAfter, limit },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    const page = await res.json();
+    return {
+      ...page,
+      data: page.data.map(convertToGroupData)
+    };
   }
   /**
    * Retrieves the current Storage contents for the given room ID and calls the
@@ -1814,7 +2007,11 @@ var Liveblocks = class {
    * @param options.signal (optional) An abort signal to cancel the request.
    */
   async deleteAiCopilot(copilotId, options) {
-    const res = await this.#delete(url2`/v2/ai/copilots/${copilotId}`, options);
+    const res = await this.#delete(
+      url2`/v2/ai/copilots/${copilotId}`,
+      void 0,
+      options
+    );
     if (!res.ok) {
       throw await LiveblocksError.from(res);
     }
@@ -1879,6 +2076,7 @@ var Liveblocks = class {
   async deleteFileKnowledgeSource(params, options) {
     const res = await this.#delete(
       url2`/v2/ai/copilots/${params.copilotId}/knowledge/file/${params.knowledgeSourceId}`,
+      void 0,
       options
     );
     if (!res.ok) {
@@ -1894,6 +2092,7 @@ var Liveblocks = class {
   async deleteWebKnowledgeSource(params, options) {
     const res = await this.#delete(
       url2`/v2/ai/copilots/${params.copilotId}/knowledge/web/${params.knowledgeSourceId}`,
+      void 0,
       options
     );
     if (!res.ok) {