@liveblocks/node 3.13.0-vincent3 → 3.13.1-hackathon

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { BaseUserMeta, DU, LiveObject, Awaitable, DS, OptionalTupleUnless, PlainLsonObject, JsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, SubscriptionData, Patchable, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, GroupScopes, GroupData, LsonObject, ToImmutable, PartialUnless, BaseMetadata, DE, DM, NotificationChannel } from '@liveblocks/core';
+import { BaseUserMeta, DU, LiveObject, Awaitable, DS, JsonObject, OptionalTupleUnless, PlainLsonObject, QueryMetadata, ThreadData, UserSubscriptionData, CommentData, CommentBody, Patchable, SubscriptionData, CommentUserReaction, InboxNotificationData, UserRoomSubscriptionSettings, RoomSubscriptionSettings, KDAD, DAD, NotificationSettings, PartialNotificationSettings, GroupScopes, GroupData, AgentSession, AgentMessage, 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';
 
@@ -94,16 +94,29 @@ type Identity = {
 type ThreadParticipants = {
     participantIds: string[];
 };
-type CreateThreadOptions<M extends BaseMetadata> = {
+type CreateThreadOptions<TM extends BaseMetadata, CM extends BaseMetadata> = {
     roomId: string;
     data: {
         comment: {
             userId: string;
             createdAt?: Date;
             body: CommentBody;
-        };
-    } & PartialUnless<M, {
-        metadata: M;
+        } & PartialUnless<CM, {
+            metadata: CM;
+        }>;
+    } & PartialUnless<TM, {
+        metadata: TM;
+    }>;
+};
+type CreateCommentOptions<CM extends BaseMetadata> = {
+    roomId: string;
+    threadId: string;
+    data: {
+        userId: string;
+        createdAt?: Date;
+        body: CommentBody;
+    } & PartialUnless<CM, {
+        metadata: CM;
     }>;
 };
 type RoomPermission = [] | ["room:write"] | ["room:read", "room:presence:write"] | ["room:read", "room:presence:write", "comments:write"];
@@ -209,7 +222,8 @@ type MassMutateStorageOptions = MutateStorageOptions & {
     concurrency?: number;
 };
 type E = DE;
-type M = DM;
+type TM = DTM;
+type CM = DCM;
 type S = DS;
 type U = DU;
 type RoomsQueryCriteria = {
@@ -404,6 +418,22 @@ type GetWebKnowledgeSourceLinksOptions = {
     copilotId: string;
     knowledgeSourceId: string;
 } & PaginationOptions;
+type CreateAgentSessionOptions = {
+    sessionId: string;
+    metadata?: JsonObject;
+    timestamp?: number;
+};
+type UpdateAgentSessionOptions = {
+    metadata: JsonObject;
+};
+type CreateAgentMessageOptions = {
+    id?: string;
+    timestamp?: number;
+    data: JsonObject;
+};
+type UpdateAgentMessageOptions = {
+    data: JsonObject;
+};
 type KnowledgeSource = ({
     type: "ai-knowledge-web-source";
     link: {
@@ -727,11 +757,11 @@ declare class Liveblocks {
          * ```
          */
         query?: string | {
-            metadata?: Partial<QueryMetadata<M>>;
+            metadata?: Partial<QueryMetadata<TM>>;
             resolved?: boolean;
         };
     }, options?: RequestOptions): Promise<{
-        data: ThreadData<M>[];
+        data: ThreadData<TM, CM>[];
     }>;
     /**
      * Gets a thread.
@@ -744,7 +774,7 @@ declare class Liveblocks {
     getThread(params: {
         roomId: string;
         threadId: string;
-    }, options?: RequestOptions): Promise<ThreadData<M>>;
+    }, options?: RequestOptions): Promise<ThreadData<TM, CM>>;
     /**
      * @deprecated Prefer using `getMentionsFromCommentBody` to extract mentions
      * from comments and threads, or `Liveblocks.getThreadSubscriptions` to get
@@ -791,7 +821,7 @@ declare class Liveblocks {
         roomId: string;
         threadId: string;
         commentId: string;
-    }, options?: RequestOptions): Promise<CommentData>;
+    }, options?: RequestOptions): Promise<CommentData<CM>>;
     /**
      * Creates a comment.
      *
@@ -800,24 +830,18 @@ declare class Liveblocks {
      * @param params.data.userId The user ID of the user who is set to create the comment.
      * @param params.data.createdAt (optional) The date the comment is set to be created.
      * @param params.data.body The body of the comment.
+     * @param params.data.metadata (optional) The metadata for the comment.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created comment.
      */
-    createComment(params: {
-        roomId: string;
-        threadId: string;
-        data: {
-            userId: string;
-            createdAt?: Date;
-            body: CommentBody;
-        };
-    }, options?: RequestOptions): Promise<CommentData>;
+    createComment(params: CreateCommentOptions<CM>, options?: RequestOptions): Promise<CommentData<CM>>;
     /**
      * Edits a comment.
      * @param params.roomId The room ID to edit the comment in.
      * @param params.threadId The thread ID to edit the comment in.
      * @param params.commentId The comment ID to edit.
      * @param params.data.body The body of the comment.
+     * @param params.data.metadata (optional) The metadata for the comment. Value must be a string, boolean or number. Use null to delete a key.
      * @param params.data.editedAt (optional) The date the comment was edited.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The edited comment.
@@ -828,9 +852,10 @@ declare class Liveblocks {
         commentId: string;
         data: {
             body: CommentBody;
+            metadata?: Patchable<CM>;
             editedAt?: Date;
         };
-    }, options?: RequestOptions): Promise<CommentData>;
+    }, options?: RequestOptions): Promise<CommentData<CM>>;
     /**
      * Deletes a comment. Deletes a comment. If there are no remaining comments in the thread, the thread is also deleted.
      * @param params.roomId The room ID to delete the comment in.
@@ -851,10 +876,11 @@ declare class Liveblocks {
      * @param params.thread.comment.userId The user ID of the user who created the comment.
      * @param params.thread.comment.createdAt (optional) The date the comment was created.
      * @param params.thread.comment.body The body of the comment.
+     * @param params.thread.comment.metadata (optional) The metadata for the comment.
      * @param options.signal (optional) An abort signal to cancel the request.
      * @returns The created thread. The thread will be created with the specified comment as its first comment.
      */
-    createThread(params: CreateThreadOptions<M>, options?: RequestOptions): Promise<ThreadData<M>>;
+    createThread(params: CreateThreadOptions<TM, CM>, options?: RequestOptions): Promise<ThreadData<TM, CM>>;
     /**
      * Deletes a thread and all of its comments.
      * @param params.roomId The room ID to delete the thread in.
@@ -879,7 +905,7 @@ declare class Liveblocks {
         data: {
             userId: string;
         };
-    }, options?: RequestOptions): Promise<ThreadData<M>>;
+    }, options?: RequestOptions): Promise<ThreadData<TM, CM>>;
     /**
      * Mark a thread as unresolved.
      * @param params.roomId The room ID of the thread.
@@ -894,7 +920,7 @@ declare class Liveblocks {
         data: {
             userId: string;
         };
-    }, options?: RequestOptions): Promise<ThreadData<M>>;
+    }, options?: RequestOptions): Promise<ThreadData<TM, CM>>;
     /**
      * Subscribes a user to a thread.
      * @param params.roomId The room ID of the thread.
@@ -938,11 +964,32 @@ declare class Liveblocks {
         roomId: string;
         threadId: string;
         data: {
-            metadata: Patchable<M>;
+            metadata: Patchable<TM>;
             userId: string;
             updatedAt?: Date;
         };
-    }, options?: RequestOptions): Promise<M>;
+    }, options?: RequestOptions): Promise<TM>;
+    /**
+     * Updates the metadata of the specified comment in a room.
+     * @param params.roomId The room ID to update the comment in.
+     * @param params.threadId The thread ID to update the comment in.
+     * @param params.commentId The comment ID to update.
+     * @param params.data.metadata The metadata for the comment. Value must be a string, boolean or number. Use null to delete a key.
+     * @param params.data.userId The user ID of the user who updated the comment.
+     * @param params.data.updatedAt (optional) The date the comment metadata is set to be updated.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The updated comment metadata.
+     */
+    editCommentMetadata(params: {
+        roomId: string;
+        threadId: string;
+        commentId: string;
+        data: {
+            metadata: Patchable<CM>;
+            userId: string;
+            updatedAt?: Date;
+        };
+    }, options?: RequestOptions): Promise<CM>;
     /**
      * Adds a new comment reaction to a comment.
      * @param params.roomId The room ID to add the comment reaction in.
@@ -1341,6 +1388,115 @@ declare class Liveblocks {
      * @returns A paginated list of web knowledge source links.
      */
     getWebKnowledgeSourceLinks(params: GetWebKnowledgeSourceLinksOptions, options?: RequestOptions): Promise<Page<WebKnowledgeSourceLink>>;
+    /**
+     * Returns a list of agent sessions in a room.
+     * @param params.roomId The room ID to get the agent sessions from.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns A list of agent sessions.
+     */
+    getAgentSessions(params: {
+        roomId: string;
+    }, options?: RequestOptions): Promise<{
+        data: AgentSession[];
+    }>;
+    /**
+     * Creates a new agent session in a room.
+     * @param params.roomId The room ID to create the agent session in.
+     * @param params.sessionId The session ID for the agent session.
+     * @param params.metadata (optional) The metadata for the agent session.
+     * @param params.timestamp (optional) The timestamp for the agent session. If not provided, the current time will be used.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The created agent session.
+     */
+    createAgentSession(params: {
+        roomId: string;
+    } & CreateAgentSessionOptions, options?: RequestOptions): Promise<AgentSession>;
+    /**
+     * Returns an agent session with the given id.
+     * @param params.roomId The room ID to get the agent session from.
+     * @param params.agentSessionId The agent session ID.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The agent session.
+     */
+    getAgentSession(params: {
+        roomId: string;
+        agentSessionId: string;
+    }, options?: RequestOptions): Promise<AgentSession>;
+    /**
+     * Updates the metadata of an agent session.
+     * @param params.roomId The room ID to update the agent session in.
+     * @param params.agentSessionId The agent session ID to update.
+     * @param params.metadata The metadata for the agent session.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns The updated agent session.
+     */
+    updateAgentSessionMetadata(params: {
+        roomId: string;
+        agentSessionId: string;
+    } & UpdateAgentSessionOptions, options?: RequestOptions): Promise<AgentSession>;
+    /**
+     * Deletes an agent session.
+     * @param params.roomId The room ID to delete the agent session from.
+     * @param params.agentSessionId The agent session ID to delete.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     */
+    deleteAgentSession(params: {
+        roomId: string;
+        agentSessionId: string;
+    }, options?: RequestOptions): Promise<void>;
+    /**
+     * Returns a list of agent messages in an agent session.
+     * @param params.roomId The room ID to get the agent messages from.
+     * @param params.agentSessionId The agent session ID to get the messages from.
+     * @param options.signal (optional) An abort signal to cancel the request.
+     * @returns A list of agent messages.
+     */
+    getAgentMessages(params: {
+        roomId: string;
+        agentSessionId: string;
+    }, options?: RequestOptions): Promise<{
+        data: AgentMessage[];
+    }>;
+    /**
+     * Creates a new agent message in an agent session.
+     * @param params.roomId The room ID to create the agent message in.
+     * @param params.agentSessionId The agent session 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 agent message.
+     */
+    createAgentMessage(params: {
+        roomId: string;
+        agentSessionId: string;
+    } & CreateAgentMessageOptions, options?: RequestOptions): Promise<AgentMessage>;
+    /**
+     * Updates an agent message.
+     * @param params.roomId The room ID to update the agent message in.
+     * @param params.agentSessionId The agent session 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.
+     * @returns The updated agent message.
+     */
+    updateAgentMessage(params: {
+        roomId: string;
+        agentSessionId: string;
+        messageId: string;
+    } & UpdateAgentMessageOptions, options?: RequestOptions): Promise<AgentMessage>;
+    /**
+     * Deletes an agent message.
+     * @param params.roomId The room ID to delete the agent message from.
+     * @param params.agentSessionId The agent session 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.
+     */
+    deleteAgentMessage(params: {
+        roomId: string;
+        agentSessionId: string;
+        messageId: string;
+    }, options?: RequestOptions): Promise<void>;
 }
 declare class LiveblocksError extends Error {
     readonly status: number;
@@ -1391,7 +1547,7 @@ type WebhookRequest = {
  * as member of the augmentation
  */
 type CustomKind = `$${string}`;
-type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | ThreadMetadataUpdatedEvent | NotificationEvent | ThreadCreatedEvent | ThreadDeletedEvent | ThreadMarkedAsResolvedEvent | ThreadMarkedAsUnresolvedEvent | YDocUpdatedEvent;
+type WebhookEvent = StorageUpdatedEvent | UserEnteredEvent | UserLeftEvent | RoomCreatedEvent | RoomDeletedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | CommentMetadataUpdatedEvent | ThreadMetadataUpdatedEvent | NotificationEvent | ThreadCreatedEvent | ThreadDeletedEvent | ThreadMarkedAsResolvedEvent | ThreadMarkedAsUnresolvedEvent | YDocUpdatedEvent;
 type StorageUpdatedEvent = {
     type: "storageUpdated";
     data: {
@@ -1563,6 +1719,25 @@ type ThreadMetadataUpdatedEvent = {
         updatedBy: string;
     };
 };
+type CommentMetadataUpdatedEvent = {
+    type: "commentMetadataUpdated";
+    data: {
+        projectId: string;
+        roomId: string;
+        threadId: string;
+        commentId: string;
+        /**
+         * ISO 8601 datestring
+         * @example "2021-03-01T12:00:00.000Z"
+         */
+        updatedAt: string;
+        /**
+         * ISO 8601 datestring
+         * @example "2021-03-01T12:00:00.000Z"
+         */
+        updatedBy: string;
+    };
+};
 type ThreadCreatedEvent = {
     type: "threadCreated";
     data: {
@@ -1732,4 +1907,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 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 CreateAgentMessageOptions, type CreateAgentSessionOptions, 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 StorageUpdatedEvent, type TextMentionNotificationEvent, type ThreadCreatedEvent, type ThreadDeletedEvent, type ThreadMarkedAsResolvedEvent, type ThreadMarkedAsUnresolvedEvent, type ThreadMetadataUpdatedEvent, type ThreadNotificationEvent, type ThreadParticipants, type UpdateAgentMessageOptions, type UpdateAgentSessionOptions, type UpdateAiCopilotOptions, type UpdateRoomOptions, type UpsertRoomOptions, type UserEnteredEvent, type UserLeftEvent, type WebKnowledgeSourceLink, type WebhookEvent, WebhookHandler, type WebhookRequest, type YDocUpdatedEvent, isCustomNotificationEvent, isTextMentionNotificationEvent, isThreadNotificationEvent };