@liveblocks/node 1.19.0-test1 → 2.0.0-alpha1

package/dist/index.mjs

@@ -3,11 +3,27 @@ import { detectDupes } from "@liveblocks/core";
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "1.19.0-test1";
+var PKG_VERSION = "2.0.0-alpha1";
 var PKG_FORMAT = "esm";
 
+// src/client.ts
+import {
+  convertToCommentData,
+  convertToCommentUserReaction,
+  convertToInboxNotificationData,
+  convertToThreadData,
+  objectToQuery
+} from "@liveblocks/core";
+
 // src/utils.ts
 var DEFAULT_BASE_URL = "https://api.liveblocks.io";
+function getBaseUrl(baseUrl) {
+  if (typeof baseUrl === "string" && baseUrl.startsWith("http")) {
+    return baseUrl;
+  } else {
+    return DEFAULT_BASE_URL;
+  }
+}
 async function fetchPolyfill() {
   return typeof globalThis.fetch !== "undefined" ? globalThis.fetch : (await import("node-fetch")).default;
 }
@@ -59,55 +75,6 @@ function url(strings, ...values) {
   );
 }
 
-// src/authorize.ts
-async function authorize(options) {
-  let url2 = null;
-  try {
-    const { room, secret, userId, userInfo, groupIds } = (
-      // Ensure we'll validate inputs at runtime
-      options
-    );
-    assertNonEmpty(secret, "secret");
-    assertNonEmpty(room, "room");
-    assertNonEmpty(userId, "userId");
-    url2 = buildLiveblocksAuthorizeEndpoint(options, room);
-    const fetch = await fetchPolyfill();
-    const resp = await fetch(buildLiveblocksAuthorizeEndpoint(options, room), {
-      method: "POST",
-      headers: {
-        Authorization: `Bearer ${secret}`,
-        "Content-Type": "application/json"
-      },
-      body: JSON.stringify({
-        userId,
-        userInfo,
-        groupIds
-      })
-    });
-    return {
-      status: normalizeStatusCode(resp.status),
-      body: await resp.text()
-    };
-  } catch (er) {
-    return {
-      status: 503,
-      body: (url2 ? `Call to "${url2}" failed.` : "Invalid authorize request.") + ' See "error" for more information.',
-      error: er
-    };
-  }
-}
-function buildLiveblocksAuthorizeEndpoint(options, roomId) {
-  const path = `/v2/rooms/${encodeURIComponent(roomId)}/authorize`;
-  return urljoin(options.baseUrl || DEFAULT_BASE_URL, path);
-}
-
-// src/client.ts
-import {
-  convertToCommentData,
-  convertToCommentUserReaction,
-  convertToThreadData
-} from "@liveblocks/core";
-
 // src/Session.ts
 var ALL_PERMISSIONS = Object.freeze([
   "room:write",
@@ -126,7 +93,7 @@ var READ_ACCESS = Object.freeze([
   "comments:read"
 ]);
 var FULL_ACCESS = Object.freeze(["room:write", "comments:write"]);
-var roomPatternRegex = /^[^*]{1,128}[*]?$/;
+var roomPatternRegex = /^([*]|[^*]{1,128}[*]?)$/;
 var Session = class {
   /** @internal */
   constructor(postFn, userId, userInfo) {
@@ -161,6 +128,9 @@ var Session = class {
     }
   }
   allow(roomIdOrPattern, newPerms) {
+    if (typeof roomIdOrPattern !== "string") {
+      throw new Error("Room name or pattern must be a string");
+    }
     if (!roomPatternRegex.test(roomIdOrPattern)) {
       throw new Error("Invalid room name or pattern");
     }
@@ -206,10 +176,9 @@ var Session = class {
   async authorize() {
     this.seal();
     if (!this.hasPermissions()) {
-      return {
-        status: 403,
-        body: "Forbidden"
-      };
+      console.warn(
+        "Access tokens without any permission will not be supported soon, you should use wildcards when the client requests a token for resources outside a room. See https://liveblocks.io/docs/errors/liveblocks-client/access-tokens-not-enough-permissions"
+      );
     }
     try {
       const resp = await this._postFn(url`/v2/authorize-user`, {
@@ -243,7 +212,7 @@ var Liveblocks = class {
     const secret = options_.secret;
     assertSecretKey(secret, "secret");
     this._secret = secret;
-    this._baseUrl = new URL(options.baseUrl ?? DEFAULT_BASE_URL);
+    this._baseUrl = new URL(getBaseUrl(options.baseUrl));
   }
   /** @internal */
   async post(path, json) {
@@ -268,12 +237,21 @@ var Liveblocks = class {
       "Content-Type": "application/json"
     };
     const fetch = await fetchPolyfill();
-    const res = await fetch(url2, {
+    return await fetch(url2, {
       method: "PUT",
       headers,
       body: JSON.stringify(json)
     });
-    return res;
+  }
+  /** @internal */
+  async putBinary(path, body, params) {
+    const url2 = urljoin(this._baseUrl, path, params);
+    const headers = {
+      Authorization: `Bearer ${this._secret}`,
+      "Content-Type": "application/octet-stream"
+    };
+    const fetch = await fetchPolyfill();
+    return await fetch(url2, { method: "PUT", headers, body });
   }
   /** @internal */
   async delete(path) {
@@ -288,7 +266,6 @@ var Liveblocks = class {
   /** @internal */
   async get(path, params) {
     const url2 = urljoin(this._baseUrl, path, params);
-    console.log("url", url2);
     const headers = {
       Authorization: `Bearer ${this._secret}`
     };
@@ -388,10 +365,17 @@ 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.query (optional) A query to filter rooms by. It is based on our query language. You can filter by metadata and room ID.
    * @returns A list of rooms.
    */
   async getRooms(params = {}) {
     const path = url`/v2/rooms`;
+    let query;
+    if (typeof params.query === "string") {
+      query = params.query;
+    } else if (typeof params.query === "object") {
+      query = objectToQuery(params.query);
+    }
     const queryParams = {
       limit: params.limit,
       startingAfter: params.startingAfter,
@@ -399,21 +383,26 @@ var Liveblocks = class {
       groupIds: params.groupIds ? params.groupIds.join(",") : void 0,
       // "Flatten" {metadata: {foo: "bar"}} to {"metadata.foo": "bar"}
       ...Object.fromEntries(
-        Object.entries(params.metadata ?? {}).map(([key, val]) => {
-          const value = Array.isArray(val) ? val.join(",") : val;
-          return [`metadata.${key}`, value];
-        })
-      )
+        Object.entries(params.metadata ?? {}).map(([key, val]) => [
+          `metadata.${key}`,
+          val
+        ])
+      ),
+      query
     };
     const res = await this.get(path, queryParams);
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
     const data = await res.json();
     const rooms = data.data.map((room) => {
       const lastConnectionAt = room.lastConnectionAt ? new Date(room.lastConnectionAt) : void 0;
-      const createdAt = room.createdAt ? new Date(room.createdAt) : void 0;
+      const createdAt = new Date(room.createdAt);
       return {
         ...room,
-        lastConnectionAt,
-        createdAt
+        createdAt,
+        lastConnectionAt
       };
     });
     return {
@@ -445,7 +434,7 @@ var Liveblocks = class {
     }
     const data = await res.json();
     const lastConnectionAt = data.lastConnectionAt ? new Date(data.lastConnectionAt) : void 0;
-    const createdAt = data.createdAt ? new Date(data.createdAt) : void 0;
+    const createdAt = new Date(data.createdAt);
     return {
       ...data,
       lastConnectionAt,
@@ -465,11 +454,11 @@ var Liveblocks = class {
     }
     const data = await res.json();
     const lastConnectionAt = data.lastConnectionAt ? new Date(data.lastConnectionAt) : void 0;
-    const createdAt = data.createdAt ? new Date(data.createdAt) : void 0;
+    const createdAt = new Date(data.createdAt);
     return {
       ...data,
-      lastConnectionAt,
-      createdAt
+      createdAt,
+      lastConnectionAt
     };
   }
   /**
@@ -496,7 +485,7 @@ var Liveblocks = class {
     }
     const data = await res.json();
     const lastConnectionAt = data.lastConnectionAt ? new Date(data.lastConnectionAt) : void 0;
-    const createdAt = data.createdAt ? new Date(data.createdAt) : void 0;
+    const createdAt = new Date(data.createdAt);
     return {
       ...data,
       lastConnectionAt,
@@ -605,12 +594,12 @@ var Liveblocks = class {
   /**
    * Send a Yjs binary update to the room’s Yjs document. You can use this endpoint to initialize Yjs data for the room or to update the room’s Yjs document.
    * @param roomId The id of the room to send the Yjs binary update to.
-   * @param params The Yjs binary update to send. Read the [Yjs documentation](https://docs.yjs.dev/api/document-updates) to learn how to create a binary update.
+   * @param update The Yjs update to send. Typically the result of calling `Yjs.encodeStateAsUpdate(doc)`. Read the [Yjs documentation](https://docs.yjs.dev/api/document-updates) to learn how to create a binary update.
+   * @param params.guid (optional) If provided, the binary update will be applied to the Yjs subdocument with the given guid. If not provided, the binary update will be applied to the root Yjs document.
    */
-  async sendYjsBinaryUpdate(roomId, params) {
-    const { update } = params;
-    const res = await this.put(url`/v2/rooms/${roomId}/ydoc`, {
-      update
+  async sendYjsBinaryUpdate(roomId, update, params = {}) {
+    const res = await this.putBinary(url`/v2/rooms/${roomId}/ydoc`, update, {
+      guid: params.guid
     });
     if (!res.ok) {
       const text = await res.text();
@@ -621,10 +610,13 @@ var Liveblocks = class {
    * Returns the room’s Yjs document encoded as a single binary update. This can be used by Y.applyUpdate(responseBody) to get a copy of the document in your backend.
    * See [Yjs documentation](https://docs.yjs.dev/api/document-updates) for more information on working with updates.
    * @param roomId The id of the room to get the Yjs document from.
+   * @param params.guid (optional) If provided, returns the binary update of the Yjs subdocument with the given guid. If not provided, returns the binary update of the root Yjs document.
    * @returns The room’s Yjs document encoded as a single binary update.
    */
-  async getYjsDocumentAsBinaryUpdate(roomId) {
-    const res = await this.get(url`/v2/rooms/${roomId}/ydoc-binary`);
+  async getYjsDocumentAsBinaryUpdate(roomId, params = {}) {
+    const res = await this.get(url`/v2/rooms/${roomId}/ydoc-binary`, {
+      guid: params.guid
+    });
     if (!res.ok) {
       const text = await res.text();
       throw new LiveblocksError(res.status, text);
@@ -767,12 +759,19 @@ var Liveblocks = class {
    * Gets all the threads in a room.
    *
    * @param params.roomId The room ID to get the threads from.
+   * @param params.query The query to filter threads by. It is based on our query language and can filter by metadata.
    * @returns A list of threads.
    */
   async getThreads(params) {
     const { roomId } = params;
+    let query;
+    if (typeof params.query === "string") {
+      query = params.query;
+    } else if (typeof params.query === "object") {
+      query = objectToQuery(params.query);
+    }
     const res = await this.get(url`/v2/rooms/${roomId}/threads`, {
-      "metadata.resolved": "false"
+      query
     });
     if (!res.ok) {
       const text = await res.text();
@@ -797,9 +796,7 @@ var Liveblocks = class {
       const text = await res.text();
       throw new LiveblocksError(res.status, text);
     }
-    return convertToThreadData(
-      await res.json()
-    );
+    return convertToThreadData(await res.json());
   }
   /**
    * Gets a thread's participants.
@@ -929,9 +926,7 @@ var Liveblocks = class {
       const text = await res.text();
       throw new LiveblocksError(res.status, text);
     }
-    return convertToThreadData(
-      await res.json()
-    );
+    return convertToThreadData(await res.json());
   }
   /**
    * Updates the metadata of the specified thread in a room.
@@ -1006,6 +1001,104 @@ var Liveblocks = class {
       throw new LiveblocksError(res.status, text);
     }
   }
+  /**
+   * Returns the inbox notifications for a user.
+   * @param params.userId The user ID to get the inbox notifications from.
+   * @param params.inboxNotificationId The ID of the inbox notification to get.
+   */
+  async getInboxNotification(params) {
+    const { userId, inboxNotificationId } = params;
+    const res = await this.get(
+      url`/v2/users/${userId}/inbox-notifications/${inboxNotificationId}`
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+    return convertToInboxNotificationData(
+      await res.json()
+    );
+  }
+  /**
+   * Gets the user's room notification settings.
+   * @param params.userId The user ID to get the room notifications from.
+   * @param params.roomId The room ID to get the room notification settings from.
+   */
+  async getRoomNotificationSettings(params) {
+    const { userId, roomId } = params;
+    const res = await this.get(
+      url`/v2/rooms/${roomId}/users/${userId}/notification-settings`
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+    return await res.json();
+  }
+  /**
+   * Updates the user's room notification settings.
+   * @param params.userId The user ID to update the room notification settings for.
+   * @param params.roomId The room ID to update the room notification settings for.
+   * @param params.data The new room notification settings for the user.
+   */
+  async updateRoomNotificationSettings(params) {
+    const { userId, roomId, data } = params;
+    const res = await this.post(
+      url`/v2/rooms/${roomId}/users/${userId}/notification-settings`,
+      data
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+    return await res.json();
+  }
+  /**
+   * Delete the user's room notification settings.
+   * @param params.userId The user ID to delete the room notification settings from.
+   * @param params.roomId The room ID to delete the room notification settings from.
+   */
+  async deleteRoomNotificationSettings(params) {
+    const { userId, roomId } = params;
+    const res = await this.delete(
+      url`/v2/rooms/${roomId}/users/${userId}/notification-settings`
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+  }
+  /**
+   * Update a room ID.
+   * @param params.roomId The current ID of the room.
+   * @param params.newRoomId The new room ID.
+   */
+  async updateRoomId(params) {
+    const { currentRoomId, newRoomId } = params;
+    const res = await this.post(
+      url`/v2/rooms/${currentRoomId}/update-room-id`,
+      {
+        newRoomId
+      }
+    );
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+    const data = await res.json();
+    return {
+      ...data,
+      createdAt: new Date(data.createdAt),
+      lastConnectionAt: data.lastConnectionAt ? new Date(data.lastConnectionAt) : void 0
+    };
+  }
+  async triggerInboxNotification(params) {
+    const res = await this.post(url`/v2/inbox-notifications/trigger`, params);
+    if (!res.ok) {
+      const text = await res.text();
+      throw new LiveblocksError(res.status, text);
+    }
+  }
 };
 var LiveblocksError = class extends Error {
   constructor(status, message = "") {
@@ -1121,7 +1214,8 @@ var _WebhookHandler = class _WebhookHandler {
       "commentReactionRemoved",
       "threadMetadataUpdated",
       "threadCreated",
-      "ydocUpdated"
+      "ydocUpdated",
+      "notification"
     ].includes(event.type))
       return;
     throw new Error(
@@ -1142,8 +1236,8 @@ import {
 detectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);
 export {
   Liveblocks,
+  LiveblocksError,
   WebhookHandler,
-  authorize,
   getMentionedIdsFromCommentBody,
   stringifyCommentBody
 };