@liveblocks/node 3.14.0-types2 → 3.14.0

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.14.0-types2";
+var PKG_VERSION = "3.14.0";
 var PKG_FORMAT = "esm";
 
 // src/client.ts
@@ -92,6 +92,19 @@ var NdJsonStream = class extends TransformStream {
   }
 };
 
+// src/lib/xwarn.ts
+function xwarn(resp, method, path) {
+  const message = resp.headers.get("X-LB-Warn");
+  if (message) {
+    const msg = `  \u26A0 [Liveblocks] ${message} (${method} ${path})`;
+    if (resp.ok) {
+      console.warn(msg);
+    } else {
+      console.error(msg);
+    }
+  }
+}
+
 // src/Session.ts
 import { url } from "@liveblocks/core";
 
@@ -171,16 +184,19 @@ var Session = class {
   #postFn;
   #userId;
   #userInfo;
-  #tenantId;
+  #organizationId;
+  /** Only used as a hint to produce better error messages. */
+  #localDev;
   #sealed = false;
   #permissions = /* @__PURE__ */ new Map();
   /** @internal */
-  constructor(postFn, userId, userInfo, tenantId) {
+  constructor(postFn, userId, userInfo, organizationId, localDev) {
     assertNonEmpty(userId, "userId");
     this.#postFn = postFn;
     this.#userId = userId;
     this.#userInfo = userInfo;
-    this.#tenantId = tenantId;
+    this.#organizationId = organizationId;
+    this.#localDev = localDev ?? false;
   }
   #getOrCreate(roomId) {
     if (this.#sealed) {
@@ -254,14 +270,17 @@ var Session = class {
       );
     }
     try {
-      const resp = await this.#postFn(url`/v2/authorize-user`, {
+      const body = {
         // Required
         userId: this.#userId,
         permissions: this.serializePermissions(),
         // Optional metadata
-        userInfo: this.#userInfo,
-        tenantId: this.#tenantId
-      });
+        userInfo: this.#userInfo
+      };
+      if (this.#organizationId !== void 0) {
+        body.organizationId = this.#organizationId;
+      }
+      const resp = await this.#postFn(url`/v2/authorize-user`, body);
       return {
         status: normalizeStatusCode(resp.status),
         body: await resp.text()
@@ -269,7 +288,7 @@ var Session = class {
     } catch (er) {
       return {
         status: 503,
-        body: 'Call to /v2/authorize-user failed. See "error" for more information.',
+        body: this.#localDev ? "Could not connect to your Liveblocks dev server. Is it running?" : 'Call to /v2/authorize-user failed. See "error" for more information.',
         error: er
       };
     }
@@ -312,6 +331,8 @@ function inflateWebKnowledgeSourceLink(link) {
 var Liveblocks = class {
   #secret;
   #baseUrl;
+  /** Only used as a hint to produce better error messages. */
+  #localDev;
   /**
    * Interact with the Liveblocks API from your Node.js backend.
    */
@@ -321,6 +342,7 @@ var Liveblocks = class {
     assertSecretKey(secret, "secret");
     this.#secret = secret;
     this.#baseUrl = new URL(getBaseUrl(options.baseUrl));
+    this.#localDev = !!options.baseUrl && /^https?:\/\/localhost[:/]/.test(options.baseUrl);
   }
   async #post(path, json, options) {
     const url3 = urljoin(this.#baseUrl, path);
@@ -335,6 +357,7 @@ var Liveblocks = class {
       body: JSON.stringify(json),
       signal: options?.signal
     });
+    xwarn(res, "POST", path);
     return res;
   }
   async #putBinary(path, body, params, options) {
@@ -344,12 +367,14 @@ var Liveblocks = class {
       "Content-Type": "application/octet-stream"
     };
     const fetch = await fetchPolyfill();
-    return await fetch(url3, {
+    const res = await fetch(url3, {
       method: "PUT",
       headers,
       body,
       signal: options?.signal
     });
+    xwarn(res, "PUT", path);
+    return res;
   }
   async #delete(path, params, options) {
     const url3 = urljoin(this.#baseUrl, path, params);
@@ -362,6 +387,7 @@ var Liveblocks = class {
       headers,
       signal: options?.signal
     });
+    xwarn(res, "DELETE", path);
     return res;
   }
   async #get(path, params, options) {
@@ -375,6 +401,7 @@ var Liveblocks = class {
       headers,
       signal: options?.signal
     });
+    xwarn(res, "GET", path);
     return res;
   }
   /* -------------------------------------------------------------------------------------------------
@@ -391,7 +418,7 @@ 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.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
@@ -404,7 +431,8 @@ var Liveblocks = class {
       this.#post.bind(this),
       userId,
       options?.userInfo,
-      options?.tenantId
+      options?.organizationId ?? options?.tenantId,
+      this.#localDev
     );
   }
   /**
@@ -443,14 +471,23 @@ var Liveblocks = class {
   async identifyUser(identity, ...rest) {
     const options = rest[0];
     const path = url2`/v2/identify-user`;
-    const { userId, groupIds, tenantId } = typeof identity === "string" ? { userId: identity, groupIds: void 0, tenantId: void 0 } : identity;
+    const { userId, groupIds, tenantId, organizationId } = typeof identity === "string" ? {
+      userId: identity,
+      groupIds: void 0,
+      tenantId: void 0,
+      organizationId: void 0
+    } : identity;
     assertNonEmpty(userId, "userId");
     const body = {
       userId,
       groupIds,
-      tenantId,
       userInfo: options?.userInfo
     };
+    if (organizationId !== void 0) {
+      body.organizationId = organizationId;
+    } else if (tenantId !== void 0) {
+      body.organizationId = tenantId;
+    }
     try {
       const resp = await this.#post(path, body);
       return {
@@ -460,7 +497,7 @@ var Liveblocks = class {
     } catch (er) {
       return {
         status: 503,
-        body: `Call to ${urljoin(
+        body: this.#localDev ? "Could not connect to your Liveblocks dev server. Is it running?" : `Call to ${urljoin(
           this.#baseUrl,
           path
         )} failed. See "error" for more information.`,
@@ -478,7 +515,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.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.
@@ -495,10 +532,14 @@ var Liveblocks = class {
       limit: params.limit,
       startingAfter: params.startingAfter,
       userId: params.userId,
-      tenantId: params.tenantId,
       groupIds: params.groupIds ? params.groupIds.join(",") : void 0,
       query
     };
+    if (params.organizationId !== void 0) {
+      queryParams.organizationId = params.organizationId;
+    } else if (params.tenantId !== void 0) {
+      queryParams.organizationId = params.tenantId;
+    }
     const res = await this.#get(path, queryParams, options);
     if (!res.ok) {
       throw await LiveblocksError.from(res);
@@ -549,7 +590,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 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.
    */
@@ -560,19 +601,25 @@ var Liveblocks = class {
       usersAccesses,
       metadata,
       tenantId,
+      organizationId,
       engine
     } = params;
+    const body = {
+      id: roomId,
+      defaultAccesses,
+      groupsAccesses,
+      usersAccesses,
+      metadata,
+      engine
+    };
+    if (organizationId !== void 0) {
+      body.organizationId = organizationId;
+    } else if (tenantId !== void 0) {
+      body.organizationId = tenantId;
+    }
     const res = await this.#post(
       options?.idempotent ? url2`/v2/rooms?idempotent` : url2`/v2/rooms`,
-      {
-        id: roomId,
-        defaultAccesses,
-        groupsAccesses,
-        usersAccesses,
-        tenantId,
-        metadata,
-        engine
-      },
+      body,
       options
     );
     if (!res.ok) {
@@ -590,7 +637,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 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.
    */
@@ -727,6 +774,33 @@ var Liveblocks = class {
       throw await LiveblocksError.from(res);
     }
   }
+  /**
+   * Sets ephemeral presence for a user in a room without requiring a WebSocket connection.
+   * The presence data will automatically expire after the specified TTL.
+   * This is useful for scenarios like showing an AI agent's presence in a room.
+   *
+   * @param roomId The id of the room to set presence in.
+   * @param params.userId The ID of the user to set presence for.
+   * @param params.data The presence data as a JSON object.
+   * @param params.userInfo (optional) Metadata about the user or agent
+   * @param params.ttl (optional) Time-to-live in seconds. If not specified, the default TTL is 60 seconds. (minimum: 2, maximum: 3599).
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async setPresence(roomId, params, options) {
+    const res = await this.#post(
+      url2`/v2/rooms/${roomId}/presence`,
+      {
+        userId: params.userId,
+        data: params.data,
+        userInfo: params.userInfo,
+        ttl: params.ttl
+      },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+  }
   async getStorageDocument(roomId, format = "plain-lson", options) {
     const res = await this.#get(
       url2`/v2/rooms/${roomId}/storage`,
@@ -1307,25 +1381,30 @@ 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 params.organizationId (optional) The organization ID to get the inbox notifications for.
    * @param options.signal (optional) An abort signal to cancel the request.
    */
   async getInboxNotifications(params, options) {
-    const { userId, tenantId, limit, startingAfter } = params;
+    const { userId, tenantId, organizationId, limit, startingAfter } = params;
     let query;
     if (typeof params.query === "string") {
       query = params.query;
     } else if (typeof params.query === "object") {
       query = objectToQuery(params.query);
     }
+    const queryParams = {
+      query,
+      limit,
+      startingAfter
+    };
+    if (organizationId !== void 0) {
+      queryParams.organizationId = organizationId;
+    } else if (tenantId !== void 0) {
+      queryParams.organizationId = tenantId;
+    }
     const res = await this.#get(
       url2`/v2/users/${userId}/inbox-notifications`,
-      {
-        query,
-        limit,
-        startingAfter,
-        tenantId
-      },
+      queryParams,
       options
     );
     if (!res.ok) {
@@ -1345,7 +1424,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 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.
    */
@@ -1370,20 +1449,25 @@ 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.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.
    */
   async getUserRoomSubscriptionSettings(params, options) {
-    const { userId, tenantId, startingAfter, limit } = params;
+    const { userId, tenantId, organizationId, startingAfter, limit } = params;
+    const queryParams = {
+      startingAfter,
+      limit
+    };
+    if (organizationId !== void 0) {
+      queryParams.organizationId = organizationId;
+    } else if (tenantId !== void 0) {
+      queryParams.organizationId = tenantId;
+    }
     const res = await this.#get(
       url2`/v2/users/${userId}/room-subscription-settings`,
-      {
-        tenantId,
-        startingAfter,
-        limit
-      },
+      queryParams,
       options
     );
     if (!res.ok) {
@@ -1471,13 +1555,22 @@ var Liveblocks = class {
    * @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.
    */
   async triggerInboxNotification(params, options) {
+    const { tenantId, organizationId, ...restParams } = params;
+    const body = {
+      ...restParams
+    };
+    if (organizationId !== void 0) {
+      body.organizationId = organizationId;
+    } else if (tenantId !== void 0) {
+      body.organizationId = tenantId;
+    }
     const res = await this.#post(
       url2`/v2/inbox-notifications/trigger`,
-      params,
+      body,
       options
     );
     if (!res.ok) {
@@ -1504,14 +1597,20 @@ 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 params.organizationId (optional) The organization ID to delete the inbox notifications for.
    * @param options.signal (optional) An abort signal to cancel the request.
    */
   async deleteAllInboxNotifications(params, options) {
-    const { userId, tenantId } = params;
+    const { userId, tenantId, organizationId } = params;
+    const queryParams = {};
+    if (organizationId !== void 0) {
+      queryParams.organizationId = organizationId;
+    } else if (tenantId !== void 0) {
+      queryParams.organizationId = tenantId;
+    }
     const res = await this.#delete(
       url2`/v2/users/${userId}/inbox-notifications`,
-      { tenantId },
+      queryParams,
       options
     );
     if (!res.ok) {
@@ -1577,21 +1676,24 @@ var Liveblocks = class {
    * 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.
    */
   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
-    );
+    const { tenantId, organizationId, ...restParams } = params;
+    const body = {
+      ...restParams,
+      // 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
+    };
+    if (organizationId !== void 0) {
+      body.organizationId = organizationId;
+    } else if (tenantId !== void 0) {
+      body.organizationId = tenantId;
+    }
+    const res = await this.#post(url2`/v2/groups`, body, options);
     if (!res.ok) {
       throw await LiveblocksError.from(res);
     }