@liveblocks/node 3.15.0-components1 → 3.15.0-feeds1

package/README.md

@@ -1,24 +1,14 @@
-<p align="center">
-  <a href="https://liveblocks.io#gh-light-mode-only">
-    <img src="https://raw.githubusercontent.com/liveblocks/liveblocks/main/.github/assets/header-light.svg" alt="Liveblocks" />
-  </a>
-  <a href="https://liveblocks.io#gh-dark-mode-only">
-    <img src="https://raw.githubusercontent.com/liveblocks/liveblocks/main/.github/assets/header-dark.svg" alt="Liveblocks" />
-  </a>
+<p>
+  <a href="https://liveblocks.io#gh-light-mode-only"><img src="https://raw.githubusercontent.com/liveblocks/liveblocks/main/.github/assets/header-light.svg" alt="Liveblocks" /></a>
+  <a href="https://liveblocks.io#gh-dark-mode-only"><img src="https://raw.githubusercontent.com/liveblocks/liveblocks/main/.github/assets/header-dark.svg" alt="Liveblocks" /></a>
 </p>
 
 # `@liveblocks/node`
 
 <p>
-  <a href="https://npmjs.org/package/@liveblocks/node">
-    <img src="https://img.shields.io/npm/v/@liveblocks/node?style=flat&label=npm&color=c33" alt="NPM" />
-  </a>
-  <a href="https://bundlephobia.com/package/@liveblocks/node">
-    <img src="https://img.shields.io/bundlephobia/minzip/@liveblocks/node?style=flat&label=size&color=09f" alt="Size" />
-  </a>
-  <a href="https://github.com/liveblocks/liveblocks/blob/main/LICENSE">
-    <img src="https://img.shields.io/github/license/liveblocks/liveblocks?style=flat&label=license&color=f80" alt="License" />
-  </a>
+  <a href="https://npmjs.org/package/@liveblocks/node"><img src="https://img.shields.io/npm/v/@liveblocks/node?style=flat&label=npm&color=c33" alt="NPM" /></a>
+  <a href="https://bundlephobia.com/package/@liveblocks/node"><img src="https://img.shields.io/bundlephobia/minzip/@liveblocks/node?style=flat&label=size&color=09f" alt="Size" /></a>
+  <a href="https://github.com/liveblocks/liveblocks/blob/main/licenses/LICENSE-APACHE-2.0"><img src="https://img.shields.io/badge/license-Apache--2.0-green" alt="License" /></a>
 </p>
 
 `@liveblocks/node` provides server-side utilities to set up

package/dist/index.cjs

@@ -3,7 +3,7 @@ var _core = require('@liveblocks/core');
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/node";
-var PKG_VERSION = "3.15.0-components1";
+var PKG_VERSION = "3.15.0-feeds1";
 var PKG_FORMAT = "cjs";
 
 // src/client.ts
@@ -165,7 +165,9 @@ var ALL_PERMISSIONS = Object.freeze([
   "room:read",
   "room:presence:write",
   "comments:write",
-  "comments:read"
+  "comments:read",
+  "feeds:write",
+  "feeds:read"
 ]);
 function isPermission(value) {
   return ALL_PERMISSIONS.includes(value);
@@ -174,9 +176,14 @@ var MAX_PERMS_PER_SET = 10;
 var READ_ACCESS = Object.freeze([
   "room:read",
   "room:presence:write",
-  "comments:read"
+  "comments:read",
+  "feeds:read"
+]);
+var FULL_ACCESS = Object.freeze([
+  "room:write",
+  "comments:write",
+  "feeds:write"
 ]);
-var FULL_ACCESS = Object.freeze(["room:write", "comments:write"]);
 var roomPatternRegex = /^([*]|[^*]{1,128}[*]?)$/;
 var Session = (_class = class {
   __init() {this.FULL_ACCESS = FULL_ACCESS}
@@ -360,6 +367,22 @@ var Liveblocks = class {
     xwarn(res, "POST", path);
     return res;
   }
+  async #patch(path, json, options) {
+    const url3 = _core.urljoin.call(void 0, this.#baseUrl, path);
+    const headers = {
+      Authorization: `Bearer ${this.#secret}`,
+      "Content-Type": "application/json"
+    };
+    const fetch = await fetchPolyfill();
+    const res = await fetch(url3, {
+      method: "PATCH",
+      headers,
+      body: JSON.stringify(json),
+      signal: _optionalChain([options, 'optionalAccess', _2 => _2.signal])
+    });
+    xwarn(res, "PATCH", path);
+    return res;
+  }
   async #putBinary(path, body, params, options) {
     const url3 = _core.urljoin.call(void 0, this.#baseUrl, path, params);
     const headers = {
@@ -371,7 +394,7 @@ var Liveblocks = class {
       method: "PUT",
       headers,
       body,
-      signal: _optionalChain([options, 'optionalAccess', _2 => _2.signal])
+      signal: _optionalChain([options, 'optionalAccess', _3 => _3.signal])
     });
     xwarn(res, "PUT", path);
     return res;
@@ -385,7 +408,7 @@ var Liveblocks = class {
     const res = await fetch(url3, {
       method: "DELETE",
       headers,
-      signal: _optionalChain([options, 'optionalAccess', _3 => _3.signal])
+      signal: _optionalChain([options, 'optionalAccess', _4 => _4.signal])
     });
     xwarn(res, "DELETE", path);
     return res;
@@ -399,7 +422,7 @@ var Liveblocks = class {
     const res = await fetch(url3, {
       method: "GET",
       headers,
-      signal: _optionalChain([options, 'optionalAccess', _4 => _4.signal])
+      signal: _optionalChain([options, 'optionalAccess', _5 => _5.signal])
     });
     xwarn(res, "GET", path);
     return res;
@@ -430,8 +453,8 @@ var Liveblocks = class {
     return new Session(
       this.#post.bind(this),
       userId,
-      _optionalChain([options, 'optionalAccess', _5 => _5.userInfo]),
-      _nullishCoalesce(_optionalChain([options, 'optionalAccess', _6 => _6.organizationId]), () => ( _optionalChain([options, 'optionalAccess', _7 => _7.tenantId]))),
+      _optionalChain([options, 'optionalAccess', _6 => _6.userInfo]),
+      _nullishCoalesce(_optionalChain([options, 'optionalAccess', _7 => _7.organizationId]), () => ( _optionalChain([options, 'optionalAccess', _8 => _8.tenantId]))),
       this.#localDev
     );
   }
@@ -481,7 +504,7 @@ var Liveblocks = class {
     const body = {
       userId,
       groupIds,
-      userInfo: _optionalChain([options, 'optionalAccess', _8 => _8.userInfo])
+      userInfo: _optionalChain([options, 'optionalAccess', _9 => _9.userInfo])
     };
     if (organizationId !== void 0) {
       body.organizationId = organizationId;
@@ -567,7 +590,7 @@ var Liveblocks = class {
    */
   async *iterRooms(criteria, options) {
     const { signal } = _nullishCoalesce(options, () => ( {}));
-    const pageSize = _core.checkBounds.call(void 0, "pageSize", _nullishCoalesce(_optionalChain([options, 'optionalAccess', _9 => _9.pageSize]), () => ( 40)), 20);
+    const pageSize = _core.checkBounds.call(void 0, "pageSize", _nullishCoalesce(_optionalChain([options, 'optionalAccess', _10 => _10.pageSize]), () => ( 40)), 20);
     let cursor = void 0;
     while (true) {
       const { nextCursor, data } = await this.getRooms(
@@ -618,7 +641,7 @@ var Liveblocks = class {
       body.organizationId = tenantId;
     }
     const res = await this.#post(
-      _optionalChain([options, 'optionalAccess', _10 => _10.idempotent]) ? _core.url`/v2/rooms?idempotent` : _core.url`/v2/rooms`,
+      _optionalChain([options, 'optionalAccess', _11 => _11.idempotent]) ? _core.url`/v2/rooms?idempotent` : _core.url`/v2/rooms`,
       body,
       options
     );
@@ -1074,7 +1097,7 @@ var Liveblocks = class {
       _core.url`/v2/rooms/${roomId}/threads/${threadId}/comments`,
       {
         ...data,
-        createdAt: _optionalChain([data, 'access', _11 => _11.createdAt, 'optionalAccess', _12 => _12.toISOString, 'call', _13 => _13()])
+        createdAt: _optionalChain([data, 'access', _12 => _12.createdAt, 'optionalAccess', _13 => _13.toISOString, 'call', _14 => _14()])
       },
       options
     );
@@ -1100,7 +1123,7 @@ var Liveblocks = class {
       _core.url`/v2/rooms/${roomId}/threads/${threadId}/comments/${commentId}`,
       {
         body: data.body,
-        editedAt: _optionalChain([data, 'access', _14 => _14.editedAt, 'optionalAccess', _15 => _15.toISOString, 'call', _16 => _16()]),
+        editedAt: _optionalChain([data, 'access', _15 => _15.editedAt, 'optionalAccess', _16 => _16.toISOString, 'call', _17 => _17()]),
         metadata: data.metadata
       },
       options
@@ -1148,7 +1171,7 @@ var Liveblocks = class {
         ...data,
         comment: {
           ...data.comment,
-          createdAt: _optionalChain([data, 'access', _17 => _17.comment, 'access', _18 => _18.createdAt, 'optionalAccess', _19 => _19.toISOString, 'call', _20 => _20()])
+          createdAt: _optionalChain([data, 'access', _18 => _18.comment, 'access', _19 => _19.createdAt, 'optionalAccess', _20 => _20.toISOString, 'call', _21 => _21()])
         }
       },
       options
@@ -1271,7 +1294,7 @@ var Liveblocks = class {
       _core.url`/v2/rooms/${roomId}/threads/${threadId}/metadata`,
       {
         ...data,
-        updatedAt: _optionalChain([data, 'access', _21 => _21.updatedAt, 'optionalAccess', _22 => _22.toISOString, 'call', _23 => _23()])
+        updatedAt: _optionalChain([data, 'access', _22 => _22.updatedAt, 'optionalAccess', _23 => _23.toISOString, 'call', _24 => _24()])
       },
       options
     );
@@ -1297,7 +1320,7 @@ var Liveblocks = class {
       _core.url`/v2/rooms/${roomId}/threads/${threadId}/comments/${commentId}/metadata`,
       {
         ...data,
-        updatedAt: _optionalChain([data, 'access', _24 => _24.updatedAt, 'optionalAccess', _25 => _25.toISOString, 'call', _26 => _26()])
+        updatedAt: _optionalChain([data, 'access', _25 => _25.updatedAt, 'optionalAccess', _26 => _26.toISOString, 'call', _27 => _27()])
       },
       options
     );
@@ -1323,7 +1346,7 @@ var Liveblocks = class {
       _core.url`/v2/rooms/${roomId}/threads/${threadId}/comments/${commentId}/add-reaction`,
       {
         ...data,
-        createdAt: _optionalChain([data, 'access', _27 => _27.createdAt, 'optionalAccess', _28 => _28.toISOString, 'call', _29 => _29()])
+        createdAt: _optionalChain([data, 'access', _28 => _28.createdAt, 'optionalAccess', _29 => _29.toISOString, 'call', _30 => _30()])
       },
       options
     );
@@ -1349,7 +1372,7 @@ var Liveblocks = class {
       _core.url`/v2/rooms/${roomId}/threads/${threadId}/comments/${params.commentId}/remove-reaction`,
       {
         ...data,
-        removedAt: _optionalChain([data, 'access', _30 => _30.removedAt, 'optionalAccess', _31 => _31.toISOString, 'call', _32 => _32()])
+        removedAt: _optionalChain([data, 'access', _31 => _31.removedAt, 'optionalAccess', _32 => _32.toISOString, 'call', _33 => _33()])
       },
       options
     );
@@ -1430,7 +1453,7 @@ var Liveblocks = class {
    */
   async *iterInboxNotifications(criteria, options) {
     const { signal } = _nullishCoalesce(options, () => ( {}));
-    const pageSize = _core.checkBounds.call(void 0, "pageSize", _nullishCoalesce(_optionalChain([options, 'optionalAccess', _33 => _33.pageSize]), () => ( 50)), 10);
+    const pageSize = _core.checkBounds.call(void 0, "pageSize", _nullishCoalesce(_optionalChain([options, 'optionalAccess', _34 => _34.pageSize]), () => ( 50)), 10);
     let cursor = void 0;
     while (true) {
       const { nextCursor, data } = await this.getInboxNotifications(
@@ -1777,7 +1800,7 @@ var Liveblocks = class {
   async getGroups(params, options) {
     const res = await this.#get(
       _core.url`/v2/groups`,
-      { startingAfter: _optionalChain([params, 'optionalAccess', _34 => _34.startingAfter]), limit: _optionalChain([params, 'optionalAccess', _35 => _35.limit]) },
+      { startingAfter: _optionalChain([params, 'optionalAccess', _35 => _35.startingAfter]), limit: _optionalChain([params, 'optionalAccess', _36 => _36.limit]) },
       options
     );
     if (!res.ok) {
@@ -1839,7 +1862,7 @@ var Liveblocks = class {
   async massMutateStorage(criteria, callback, massOptions) {
     const concurrency = _core.checkBounds.call(void 0, 
       "concurrency",
-      _nullishCoalesce(_optionalChain([massOptions, 'optionalAccess', _36 => _36.concurrency]), () => ( 8)),
+      _nullishCoalesce(_optionalChain([massOptions, 'optionalAccess', _37 => _37.concurrency]), () => ( 8)),
       1,
       20
     );
@@ -1855,7 +1878,7 @@ var Liveblocks = class {
   }
   async #_mutateOneRoom(roomId, room, callback, options) {
     const debounceInterval = 200;
-    const { signal, abort } = _core.makeAbortController.call(void 0, _optionalChain([options, 'optionalAccess', _37 => _37.signal]));
+    const { signal, abort } = _core.makeAbortController.call(void 0, _optionalChain([options, 'optionalAccess', _38 => _38.signal]));
     let opsBuffer = [];
     let outstandingFlush$ = void 0;
     let lastFlush = performance.now();
@@ -1921,7 +1944,7 @@ var Liveblocks = class {
     const res = await this.#post(
       _core.url`/v2/rooms/${roomId}/send-message`,
       { messages },
-      { signal: _optionalChain([options, 'optionalAccess', _38 => _38.signal]) }
+      { signal: _optionalChain([options, 'optionalAccess', _39 => _39.signal]) }
     );
     if (!res.ok) {
       throw await LiveblocksError.from(res);
@@ -2058,7 +2081,7 @@ var Liveblocks = class {
           "Content-Type": params.file.type,
           "Content-Length": String(params.file.size)
         },
-        signal: _optionalChain([options, 'optionalAccess', _39 => _39.signal])
+        signal: _optionalChain([options, 'optionalAccess', _40 => _40.signal])
       }
     );
     if (!res.ok) {
@@ -2190,6 +2213,180 @@ var Liveblocks = class {
       data: page.data.map(inflateWebKnowledgeSourceLink)
     };
   }
+  /* -------------------------------------------------------------------------------------------------
+   * Feeds
+   * -----------------------------------------------------------------------------------------------*/
+  /**
+   * Returns a list of feeds in a room.
+   * @param params.roomId The room ID to get the feeds from.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns A list of feeds.
+   */
+  async getFeeds(params, options) {
+    const { roomId } = params;
+    const res = await this.#get(
+      _core.url`/v2/rooms/${roomId}/feeds`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    return await res.json();
+  }
+  /**
+   * Creates a new feed in a room.
+   * @param params.roomId The room ID to create the feed in.
+   * @param params.feedId The feed ID.
+   * @param params.metadata (optional) The metadata for the feed.
+   * @param params.timestamp (optional) The timestamp for the feed. If not provided, the current time will be used.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns The created feed.
+   */
+  async createFeed(params, options) {
+    const { roomId, feedId, metadata, timestamp } = params;
+    const res = await this.#post(
+      _core.url`/v2/rooms/${roomId}/feed`,
+      { feedId, metadata, timestamp },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    return (await res.json()).data;
+  }
+  /**
+   * Returns a feed with the given id.
+   * @param params.roomId The room ID to get the feed from.
+   * @param params.feedId The feed ID.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns The feed.
+   */
+  async getFeed(params, options) {
+    const { roomId, feedId } = params;
+    const res = await this.#get(
+      _core.url`/v2/rooms/${roomId}/feeds/${feedId}`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    return (await res.json()).data;
+  }
+  /**
+   * Updates the metadata of a feed.
+   * @param params.roomId The room ID to update the feed in.
+   * @param params.feedId The feed ID to update.
+   * @param params.metadata The metadata for the feed.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async updateFeed(params, options) {
+    const { roomId, feedId, metadata } = params;
+    const res = await this.#patch(
+      _core.url`/v2/rooms/${roomId}/feeds/${feedId}`,
+      { metadata },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+  }
+  /**
+   * Deletes a feed.
+   * @param params.roomId The room ID to delete the feed from.
+   * @param params.feedId The feed ID to delete.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async deleteFeed(params, options) {
+    const { roomId, feedId } = params;
+    const res = await this.#delete(
+      _core.url`/v2/rooms/${roomId}/feeds/${feedId}`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+  }
+  /**
+   * Returns a list of messages in a feed.
+   * @param params.roomId The room ID to get the feed messages from.
+   * @param params.feedId The feed ID to get the messages from.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns A list of feed messages.
+   */
+  async getFeedMessages(params, options) {
+    const { roomId, feedId } = params;
+    const res = await this.#get(
+      _core.url`/v2/rooms/${roomId}/feeds/${feedId}/messages`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    return await res.json();
+  }
+  /**
+   * Creates a new message in a feed.
+   * @param params.roomId The room ID to create the feed message in.
+   * @param params.feedId The feed ID to create the message in.
+   * @param params.id (optional) The message ID. If not provided, one will be generated.
+   * @param params.timestamp (optional) The message timestamp. If not provided, the current time will be used.
+   * @param params.data The message data.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   * @returns The created feed message.
+   */
+  async createFeedMessage(params, options) {
+    const { roomId, feedId, id, timestamp, data } = params;
+    const res = await this.#post(
+      _core.url`/v2/rooms/${roomId}/feeds/${feedId}/messages`,
+      { id, timestamp, data },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+    return (await res.json()).data;
+  }
+  /**
+   * Updates a feed message.
+   * @param params.roomId The room ID to update the feed message in.
+   * @param params.feedId The feed ID to update the message in.
+   * @param params.messageId The message ID to update.
+   * @param params.data The message data.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async updateFeedMessage(params, options) {
+    const { roomId, feedId, messageId, data } = params;
+    const res = await this.#patch(
+      _core.url`/v2/rooms/${roomId}/feeds/${feedId}/messages/${messageId}`,
+      { data },
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+  }
+  /**
+   * Deletes a feed message.
+   * @param params.roomId The room ID to delete the feed message from.
+   * @param params.feedId The feed ID to delete the message from.
+   * @param params.messageId The message ID to delete.
+   * @param options.signal (optional) An abort signal to cancel the request.
+   */
+  async deleteFeedMessage(params, options) {
+    const { roomId, feedId, messageId } = params;
+    const res = await this.#delete(
+      _core.url`/v2/rooms/${roomId}/feeds/${feedId}/messages/${messageId}`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+  }
 };
 var LiveblocksError = class _LiveblocksError extends Error {