@liveblocks/node 3.15.0-components1 → 3.15.0-feeds2

package/dist/index.d.cts

@@ -1,8 +1,8 @@
-import { BaseUserMeta, DU, LiveObject, Awaitable, DS, JsonObject, Json, OptionalTupleUnless, PlainLsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, Patchable, SubscriptionData, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, GroupScopes, GroupData, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DTM, DCM, NotificationChannel } from '@liveblocks/core';
+import { BaseUserMeta, DU, LiveObject, Awaitable, DS, Json, JsonObject, OptionalTupleUnless, PlainLsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, Patchable, SubscriptionData, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, GroupScopes, GroupData, Feed, FeedMessage, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DTM, DCM, NotificationChannel } from '@liveblocks/core';
 export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveMap, LiveObject, LiveStructure, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
-declare const ALL_PERMISSIONS: readonly ["room:write", "room:read", "room:presence:write", "comments:write", "comments:read"];
+declare const ALL_PERMISSIONS: readonly ["room:write", "room:read", "room:presence:write", "comments:write", "comments:read", "feeds:write", "feeds:read"];
 type Permission = (typeof ALL_PERMISSIONS)[number];
 /**
  * Class to help you construct the exact permission set to grant a user, used
@@ -41,8 +41,8 @@ type Permission = (typeof ALL_PERMISSIONS)[number];
  */
 declare class Session {
     #private;
-    readonly FULL_ACCESS: readonly ["room:write", "comments:write"];
-    readonly READ_ACCESS: readonly ["room:read", "room:presence:write", "comments:read"];
+    readonly FULL_ACCESS: readonly ["room:write", "comments:write", "feeds:write"];
+    readonly READ_ACCESS: readonly ["room:read", "room:presence:write", "comments:read", "feeds:read"];
     allow(roomIdOrPattern: string, newPerms: readonly Permission[]): this;
     /**
      * Call this to authorize the session to access Liveblocks. Note that this
@@ -444,6 +444,22 @@ type GetWebKnowledgeSourceLinksOptions = {
     copilotId: string;
     knowledgeSourceId: string;
 } & PaginationOptions;
+type CreateFeedOptions<FM extends Json = Json> = {
+    feedId: string;
+    metadata?: FM;
+    timestamp?: number;
+};
+type UpdateFeedOptions<FM extends Json = Json> = {
+    metadata: FM;
+};
+type CreateFeedMessageOptions<FMD extends Json = Json> = {
+    id?: string;
+    timestamp?: number;
+    data: FMD;
+};
+type UpdateFeedMessageOptions<FMD extends Json = Json> = {
+    data: FMD;
+};
 type KnowledgeSource = ({
     type: "ai-knowledge-web-source";
     link: {
@@ -1438,6 +1454,113 @@ declare class Liveblocks {
      * @returns A paginated list of web knowledge source links.
      */
     getWebKnowledgeSourceLinks(params: GetWebKnowledgeSourceLinksOptions, options?: RequestOptions): Promise<Page<WebKnowledgeSourceLink>>;
+    /**
+     * 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.
+     */
+    getFeeds<FM extends Json = Json>(params: {
+        roomId: string;
+    }, options?: RequestOptions): Promise<{
+        data: Feed<FM>[];
+    }>;
+    /**
+     * 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.
+     */
+    createFeed<FM extends Json = Json>(params: {
+        roomId: string;
+    } & CreateFeedOptions<FM>, options?: RequestOptions): Promise<Feed<FM>>;
+    /**
+     * 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.
+     */
+    getFeed<FM extends Json = Json>(params: {
+        roomId: string;
+        feedId: string;
+    }, options?: RequestOptions): Promise<Feed<FM>>;
+    /**
+     * 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.
+     */
+    updateFeed<FM extends Json = Json>(params: {
+        roomId: string;
+        feedId: string;
+    } & UpdateFeedOptions<FM>, options?: RequestOptions): Promise<void>;
+    /**
+     * 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.
+     */
+    deleteFeed(params: {
+        roomId: string;
+        feedId: string;
+    }, options?: RequestOptions): Promise<void>;
+    /**
+     * 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.
+     */
+    getFeedMessages<FMD extends Json = Json>(params: {
+        roomId: string;
+        feedId: string;
+    }, options?: RequestOptions): Promise<{
+        data: FeedMessage<FMD>[];
+    }>;
+    /**
+     * 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.
+     */
+    createFeedMessage<FMD extends Json = Json>(params: {
+        roomId: string;
+        feedId: string;
+    } & CreateFeedMessageOptions<FMD>, options?: RequestOptions): Promise<FeedMessage<FMD>>;
+    /**
+     * 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.
+     */
+    updateFeedMessage<FMD extends Json = Json>(params: {
+        roomId: string;
+        feedId: string;
+        messageId: string;
+    } & UpdateFeedMessageOptions<FMD>, options?: RequestOptions): Promise<void>;
+    /**
+     * 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.
+     */
+    deleteFeedMessage(params: {
+        roomId: string;
+        feedId: string;
+        messageId: string;
+    }, options?: RequestOptions): Promise<void>;
 }
 declare class LiveblocksError extends Error {
     readonly status: number;
@@ -1848,4 +1971,4 @@ declare function isTextMentionNotificationEvent(event: WebhookEvent): event is T
  */
 declare function isCustomNotificationEvent(event: WebhookEvent): event is CustomNotificationEvent;
 
-export { type AiCopilot, type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CreateAiCopilotOptions, type CreateFileKnowledgeSourceOptions, type CreateRoomOptions, type CreateWebKnowledgeSourceOptions, type CustomNotificationEvent, type GetAiCopilotsOptions, type GetInboxNotificationsOptions, type GetKnowledgeSourcesOptions, type GetRoomsOptions, type GetWebKnowledgeSourceLinksOptions, type InboxNotificationsQueryCriteria, type KnowledgeSource, Liveblocks, LiveblocksError, type LiveblocksOptions, type MassMutateStorageCallback, type MassMutateStorageOptions, type MutateStorageCallback, type MutateStorageOptions, type NotificationEvent, type Page, type PaginationOptions, type RoomAccesses, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomPermission, type RoomUser, type RoomsQueryCriteria, type SetPresenceOptions, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UpdateAiCopilotOptions, type UpdateRoomOptions, type UpsertRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebKnowledgeSourceLink, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };
+export { type AiCopilot, type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CreateAiCopilotOptions, type CreateFeedMessageOptions, type CreateFeedOptions, type CreateFileKnowledgeSourceOptions, type CreateRoomOptions, type CreateWebKnowledgeSourceOptions, type CustomNotificationEvent, type GetAiCopilotsOptions, type GetInboxNotificationsOptions, type GetKnowledgeSourcesOptions, type GetRoomsOptions, type GetWebKnowledgeSourceLinksOptions, type InboxNotificationsQueryCriteria, type KnowledgeSource, Liveblocks, LiveblocksError, type LiveblocksOptions, type MassMutateStorageCallback, type MassMutateStorageOptions, type MutateStorageCallback, type MutateStorageOptions, type NotificationEvent, type Page, type PaginationOptions, type RoomAccesses, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomPermission, type RoomUser, type RoomsQueryCriteria, type SetPresenceOptions, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UpdateAiCopilotOptions, type UpdateFeedMessageOptions, type UpdateFeedOptions, type UpdateRoomOptions, type UpsertRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebKnowledgeSourceLink, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-import { BaseUserMeta, DU, LiveObject, Awaitable, DS, JsonObject, Json, OptionalTupleUnless, PlainLsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, Patchable, SubscriptionData, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, GroupScopes, GroupData, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DTM, DCM, NotificationChannel } from '@liveblocks/core';
+import { BaseUserMeta, DU, LiveObject, Awaitable, DS, Json, JsonObject, OptionalTupleUnless, PlainLsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, Patchable, SubscriptionData, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, GroupScopes, GroupData, Feed, FeedMessage, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DTM, DCM, NotificationChannel } from '@liveblocks/core';
 export { CommentBody, CommentBodyBlockElement, CommentBodyElement, CommentBodyInlineElement, CommentBodyLink, CommentBodyLinkElementArgs, CommentBodyMention, CommentBodyMentionElementArgs, CommentBodyParagraph, CommentBodyParagraphElementArgs, CommentBodyText, CommentBodyTextElementArgs, CommentData, CommentUserReaction, IUserInfo, Json, JsonArray, JsonObject, JsonScalar, LiveList, LiveMap, LiveObject, LiveStructure, Lson, LsonObject, PlainLsonObject, ResolveUsersArgs, StringifyCommentBodyElements, StringifyCommentBodyOptions, ThreadData, User, getMentionsFromCommentBody, isNotificationChannelEnabled, stringifyCommentBody } from '@liveblocks/core';
 import { IncomingHttpHeaders } from 'http';
 
-declare const ALL_PERMISSIONS: readonly ["room:write", "room:read", "room:presence:write", "comments:write", "comments:read"];
+declare const ALL_PERMISSIONS: readonly ["room:write", "room:read", "room:presence:write", "comments:write", "comments:read", "feeds:write", "feeds:read"];
 type Permission = (typeof ALL_PERMISSIONS)[number];
 /**
  * Class to help you construct the exact permission set to grant a user, used
@@ -41,8 +41,8 @@ type Permission = (typeof ALL_PERMISSIONS)[number];
  */
 declare class Session {
     #private;
-    readonly FULL_ACCESS: readonly ["room:write", "comments:write"];
-    readonly READ_ACCESS: readonly ["room:read", "room:presence:write", "comments:read"];
+    readonly FULL_ACCESS: readonly ["room:write", "comments:write", "feeds:write"];
+    readonly READ_ACCESS: readonly ["room:read", "room:presence:write", "comments:read", "feeds:read"];
     allow(roomIdOrPattern: string, newPerms: readonly Permission[]): this;
     /**
      * Call this to authorize the session to access Liveblocks. Note that this
@@ -444,6 +444,22 @@ type GetWebKnowledgeSourceLinksOptions = {
     copilotId: string;
     knowledgeSourceId: string;
 } & PaginationOptions;
+type CreateFeedOptions<FM extends Json = Json> = {
+    feedId: string;
+    metadata?: FM;
+    timestamp?: number;
+};
+type UpdateFeedOptions<FM extends Json = Json> = {
+    metadata: FM;
+};
+type CreateFeedMessageOptions<FMD extends Json = Json> = {
+    id?: string;
+    timestamp?: number;
+    data: FMD;
+};
+type UpdateFeedMessageOptions<FMD extends Json = Json> = {
+    data: FMD;
+};
 type KnowledgeSource = ({
     type: "ai-knowledge-web-source";
     link: {
@@ -1438,6 +1454,113 @@ declare class Liveblocks {
      * @returns A paginated list of web knowledge source links.
      */
     getWebKnowledgeSourceLinks(params: GetWebKnowledgeSourceLinksOptions, options?: RequestOptions): Promise<Page<WebKnowledgeSourceLink>>;
+    /**
+     * 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.
+     */
+    getFeeds<FM extends Json = Json>(params: {
+        roomId: string;
+    }, options?: RequestOptions): Promise<{
+        data: Feed<FM>[];
+    }>;
+    /**
+     * 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.
+     */
+    createFeed<FM extends Json = Json>(params: {
+        roomId: string;
+    } & CreateFeedOptions<FM>, options?: RequestOptions): Promise<Feed<FM>>;
+    /**
+     * 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.
+     */
+    getFeed<FM extends Json = Json>(params: {
+        roomId: string;
+        feedId: string;
+    }, options?: RequestOptions): Promise<Feed<FM>>;
+    /**
+     * 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.
+     */
+    updateFeed<FM extends Json = Json>(params: {
+        roomId: string;
+        feedId: string;
+    } & UpdateFeedOptions<FM>, options?: RequestOptions): Promise<void>;
+    /**
+     * 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.
+     */
+    deleteFeed(params: {
+        roomId: string;
+        feedId: string;
+    }, options?: RequestOptions): Promise<void>;
+    /**
+     * 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.
+     */
+    getFeedMessages<FMD extends Json = Json>(params: {
+        roomId: string;
+        feedId: string;
+    }, options?: RequestOptions): Promise<{
+        data: FeedMessage<FMD>[];
+    }>;
+    /**
+     * 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.
+     */
+    createFeedMessage<FMD extends Json = Json>(params: {
+        roomId: string;
+        feedId: string;
+    } & CreateFeedMessageOptions<FMD>, options?: RequestOptions): Promise<FeedMessage<FMD>>;
+    /**
+     * 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.
+     */
+    updateFeedMessage<FMD extends Json = Json>(params: {
+        roomId: string;
+        feedId: string;
+        messageId: string;
+    } & UpdateFeedMessageOptions<FMD>, options?: RequestOptions): Promise<void>;
+    /**
+     * 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.
+     */
+    deleteFeedMessage(params: {
+        roomId: string;
+        feedId: string;
+        messageId: string;
+    }, options?: RequestOptions): Promise<void>;
 }
 declare class LiveblocksError extends Error {
     readonly status: number;
@@ -1848,4 +1971,4 @@ declare function isTextMentionNotificationEvent(event: WebhookEvent): event is T
  */
 declare function isCustomNotificationEvent(event: WebhookEvent): event is CustomNotificationEvent;
 
-export { type AiCopilot, type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CreateAiCopilotOptions, type CreateFileKnowledgeSourceOptions, type CreateRoomOptions, type CreateWebKnowledgeSourceOptions, type CustomNotificationEvent, type GetAiCopilotsOptions, type GetInboxNotificationsOptions, type GetKnowledgeSourcesOptions, type GetRoomsOptions, type GetWebKnowledgeSourceLinksOptions, type InboxNotificationsQueryCriteria, type KnowledgeSource, Liveblocks, LiveblocksError, type LiveblocksOptions, type MassMutateStorageCallback, type MassMutateStorageOptions, type MutateStorageCallback, type MutateStorageOptions, type NotificationEvent, type Page, type PaginationOptions, type RoomAccesses, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomPermission, type RoomUser, type RoomsQueryCriteria, type SetPresenceOptions, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UpdateAiCopilotOptions, type UpdateRoomOptions, type UpsertRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebKnowledgeSourceLink, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };
+export { type AiCopilot, type CommentCreatedEvent, type CommentDeletedEvent, type CommentEditedEvent, type CommentReactionAdded, type CommentReactionRemoved, type CreateAiCopilotOptions, type CreateFeedMessageOptions, type CreateFeedOptions, type CreateFileKnowledgeSourceOptions, type CreateRoomOptions, type CreateWebKnowledgeSourceOptions, type CustomNotificationEvent, type GetAiCopilotsOptions, type GetInboxNotificationsOptions, type GetKnowledgeSourcesOptions, type GetRoomsOptions, type GetWebKnowledgeSourceLinksOptions, type InboxNotificationsQueryCriteria, type KnowledgeSource, Liveblocks, LiveblocksError, type LiveblocksOptions, type MassMutateStorageCallback, type MassMutateStorageOptions, type MutateStorageCallback, type MutateStorageOptions, type NotificationEvent, type Page, type PaginationOptions, type RoomAccesses, type RoomCreatedEvent, type RoomData, type RoomDeletedEvent, type RoomPermission, type RoomUser, type RoomsQueryCriteria, type SetPresenceOptions, type StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UpdateAiCopilotOptions, type UpdateFeedMessageOptions, type UpdateFeedOptions, type UpdateRoomOptions, type UpsertRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebKnowledgeSourceLink, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };

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.15.0-components1";
+var PKG_VERSION = "3.15.0-feeds2";
 var PKG_FORMAT = "esm";
 
 // 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 {
   FULL_ACCESS = FULL_ACCESS;
@@ -360,6 +367,22 @@ var Liveblocks = class {
     xwarn(res, "POST", path);
     return res;
   }
+  async #patch(path, json, options) {
+    const url3 = urljoin(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: options?.signal
+    });
+    xwarn(res, "PATCH", path);
+    return res;
+  }
   async #putBinary(path, body, params, options) {
     const url3 = urljoin(this.#baseUrl, path, params);
     const headers = {
@@ -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(
+      url2`/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(
+      url2`/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(
+      url2`/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(
+      url2`/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(
+      url2`/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(
+      url2`/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(
+      url2`/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(
+      url2`/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(
+      url2`/v2/rooms/${roomId}/feeds/${feedId}/messages/${messageId}`,
+      void 0,
+      options
+    );
+    if (!res.ok) {
+      throw await LiveblocksError.from(res);
+    }
+  }
 };
 var LiveblocksError = class _LiveblocksError extends Error {
   status;