@liveblocks/core 3.13.0-ack1 → 3.13.0-metadata2

package/dist/index.d.cts

@@ -1140,7 +1140,7 @@ declare global {
         [key: string]: unknown;
     }
 }
-type ExtendableTypes = "Presence" | "Storage" | "UserMeta" | "RoomEvent" | "ThreadMetadata" | "RoomInfo" | "GroupInfo" | "ActivitiesData";
+type ExtendableTypes = "Presence" | "Storage" | "UserMeta" | "RoomEvent" | "ThreadMetadata" | "CommentMetadata" | "RoomInfo" | "GroupInfo" | "ActivitiesData";
 type MakeErrorString<K extends ExtendableTypes, Reason extends string = "does not match its requirements"> = `The type you provided for '${K}' ${Reason}. To learn how to fix this, see https://liveblocks.io/docs/errors/${K}`;
 type GetOverride<K extends ExtendableTypes, B, Reason extends string = "does not match its requirements"> = GetOverrideOrErrorValue<K, B, MakeErrorString<K, Reason>>;
 type GetOverrideOrErrorValue<K extends ExtendableTypes, B, ErrorType> = unknown extends Liveblocks[K] ? B : Liveblocks[K] extends B ? Liveblocks[K] : ErrorType;
@@ -1148,7 +1148,8 @@ type DP = GetOverride<"Presence", JsonObject, "is not a valid JSON object">;
 type DS = GetOverride<"Storage", LsonObject, "is not a valid LSON value">;
 type DU = GetOverrideOrErrorValue<"UserMeta", BaseUserMeta, Record<"id" | "info", MakeErrorString<"UserMeta">>>;
 type DE = GetOverride<"RoomEvent", Json, "is not a valid JSON value">;
-type DM = GetOverride<"ThreadMetadata", BaseMetadata>;
+type DTM = GetOverride<"ThreadMetadata", BaseMetadata>;
+type DCM = GetOverride<"CommentMetadata", BaseMetadata>;
 type DRI = GetOverride<"RoomInfo", BaseRoomInfo>;
 type DGI = GetOverride<"GroupInfo", BaseGroupInfo>;
 type DAD = GetOverrideOrErrorValue<"ActivitiesData", BaseActivitiesData, {
@@ -1213,7 +1214,7 @@ type CommentMixedAttachment = CommentAttachment | CommentLocalAttachment;
 /**
  * Represents a comment.
  */
-type CommentData = {
+type CommentData<CM extends BaseMetadata = DCM> = {
     type: "comment";
     id: string;
     threadId: string;
@@ -1223,13 +1224,15 @@ type CommentData = {
     editedAt?: Date;
     reactions: CommentReaction[];
     attachments: CommentAttachment[];
+    metadata: CM;
 } & Relax<{
     body: CommentBody;
 } | {
     deletedAt: Date;
 }>;
-type CommentDataPlain = Omit<DateToString<CommentData>, "reactions" | "body"> & {
+type CommentDataPlain<CM extends BaseMetadata = DCM> = Omit<DateToString<CommentData<CM>>, "reactions" | "body" | "metadata"> & {
     reactions: DateToString<CommentReaction>[];
+    metadata: CM;
 } & Relax<{
     body: CommentBody;
 } | {
@@ -1284,22 +1287,22 @@ type SearchCommentsResult = {
 /**
  * Represents a thread of comments.
  */
-type ThreadData<M extends BaseMetadata = DM> = {
+type ThreadData<TM extends BaseMetadata = DTM, CM extends BaseMetadata = DCM> = {
     type: "thread";
     id: string;
     roomId: string;
     createdAt: Date;
     updatedAt: Date;
-    comments: CommentData[];
-    metadata: M;
+    comments: CommentData<CM>[];
+    metadata: TM;
     resolved: boolean;
 };
-interface ThreadDataWithDeleteInfo<M extends BaseMetadata = DM> extends ThreadData<M> {
+interface ThreadDataWithDeleteInfo<TM extends BaseMetadata = DTM, CM extends BaseMetadata = DCM> extends ThreadData<TM, CM> {
     deletedAt?: Date;
 }
-type ThreadDataPlain<M extends BaseMetadata> = Omit<DateToString<ThreadData<M>>, "comments" | "metadata"> & {
-    comments: CommentDataPlain[];
-    metadata: M;
+type ThreadDataPlain<TM extends BaseMetadata = DTM, CM extends BaseMetadata = DCM> = Omit<DateToString<ThreadData<TM, CM>>, "comments" | "metadata"> & {
+    comments: CommentDataPlain<CM>[];
+    metadata: TM;
 };
 type ThreadDeleteInfo = {
     type: "deletedThread";
@@ -1537,17 +1540,17 @@ type MakeOptionalFieldsNullable<T> = {
 };
 type Patchable<T> = Partial<MakeOptionalFieldsNullable<T>>;
 
-interface RoomHttpApi<M extends BaseMetadata> {
+interface RoomHttpApi<TM extends BaseMetadata, CM extends BaseMetadata> {
     getThreads(options: {
         roomId: string;
         cursor?: string;
         query?: {
             resolved?: boolean;
             subscribed?: boolean;
-            metadata?: Partial<QueryMetadata<M>>;
+            metadata?: Partial<QueryMetadata<TM>>;
         };
     }): Promise<{
-        threads: ThreadData<M>[];
+        threads: ThreadData<TM, CM>[];
         inboxNotifications: InboxNotificationData[];
         subscriptions: SubscriptionData[];
         requestedAt: Date;
@@ -1560,7 +1563,7 @@ interface RoomHttpApi<M extends BaseMetadata> {
         signal?: AbortSignal;
     }): Promise<{
         threads: {
-            updated: ThreadData<M>[];
+            updated: ThreadData<TM, CM>[];
             deleted: ThreadDeleteInfo[];
         };
         inboxNotifications: {
@@ -1577,7 +1580,7 @@ interface RoomHttpApi<M extends BaseMetadata> {
     searchComments(options: {
         roomId: string;
         query: {
-            threadMetadata?: Partial<QueryMetadata<M>>;
+            threadMetadata?: Partial<QueryMetadata<TM>>;
             threadResolved?: boolean;
             hasAttachments?: boolean;
             hasMentions?: boolean;
@@ -1588,19 +1591,20 @@ interface RoomHttpApi<M extends BaseMetadata> {
     }): Promise<{
         data: Array<SearchCommentsResult>;
     }>;
-    createThread({ roomId, metadata, body, commentId, threadId, attachmentIds, }: {
+    createThread({ roomId, metadata, body, commentId, threadId, commentMetadata, attachmentIds, }: {
         roomId: string;
         threadId?: string;
         commentId?: string;
-        metadata: M | undefined;
+        metadata: TM | undefined;
+        commentMetadata: CM | undefined;
         body: CommentBody;
         attachmentIds?: string[];
-    }): Promise<ThreadData<M>>;
+    }): Promise<ThreadData<TM, CM>>;
     getThread(options: {
         roomId: string;
         threadId: string;
     }): Promise<{
-        thread?: ThreadData<M>;
+        thread?: ThreadData<TM, CM>;
         inboxNotification?: InboxNotificationData;
         subscription?: SubscriptionData;
     }>;
@@ -1610,23 +1614,31 @@ interface RoomHttpApi<M extends BaseMetadata> {
     }): Promise<void>;
     editThreadMetadata({ roomId, metadata, threadId, }: {
         roomId: string;
-        metadata: Patchable<M>;
+        metadata: Patchable<TM>;
         threadId: string;
-    }): Promise<M>;
-    createComment({ roomId, threadId, commentId, body, attachmentIds, }: {
+    }): Promise<TM>;
+    editCommentMetadata({ roomId, threadId, commentId, metadata, }: {
+        roomId: string;
+        threadId: string;
+        commentId: string;
+        metadata: Patchable<CM>;
+    }): Promise<CM>;
+    createComment({ roomId, threadId, commentId, body, metadata, attachmentIds, }: {
         roomId: string;
         threadId: string;
         commentId?: string;
         body: CommentBody;
+        metadata?: CM;
         attachmentIds?: string[];
-    }): Promise<CommentData>;
-    editComment({ roomId, threadId, commentId, body, attachmentIds, }: {
+    }): Promise<CommentData<CM>>;
+    editComment({ roomId, threadId, commentId, body, attachmentIds, metadata, }: {
         roomId: string;
         threadId: string;
         commentId: string;
         body: CommentBody;
         attachmentIds?: string[];
-    }): Promise<CommentData>;
+        metadata?: Patchable<CM>;
+    }): Promise<CommentData<CM>>;
     deleteComment({ roomId, threadId, commentId, }: {
         roomId: string;
         threadId: string;
@@ -1764,7 +1776,7 @@ interface RoomHttpApi<M extends BaseMetadata> {
         signal: AbortSignal;
     }): Promise<string>;
 }
-interface NotificationHttpApi<M extends BaseMetadata> {
+interface NotificationHttpApi<TM extends BaseMetadata, CM extends BaseMetadata> {
     getInboxNotifications(options?: {
         cursor?: string;
         query?: {
@@ -1773,7 +1785,7 @@ interface NotificationHttpApi<M extends BaseMetadata> {
         };
     }): Promise<{
         inboxNotifications: InboxNotificationData[];
-        threads: ThreadData<M>[];
+        threads: ThreadData<TM, CM>[];
         subscriptions: SubscriptionData[];
         nextCursor: string | null;
         requestedAt: Date;
@@ -1791,7 +1803,7 @@ interface NotificationHttpApi<M extends BaseMetadata> {
             deleted: InboxNotificationDeleteInfo[];
         };
         threads: {
-            updated: ThreadData<M>[];
+            updated: ThreadData<TM, CM>[];
             deleted: ThreadDeleteInfo[];
         };
         subscriptions: {
@@ -1816,16 +1828,16 @@ interface NotificationHttpApi<M extends BaseMetadata> {
     }): Promise<NotificationSettingsPlain>;
     updateNotificationSettings(settings: PartialNotificationSettings): Promise<NotificationSettingsPlain>;
 }
-interface LiveblocksHttpApi<M extends BaseMetadata> extends RoomHttpApi<M>, NotificationHttpApi<M> {
+interface LiveblocksHttpApi<TM extends BaseMetadata, CM extends BaseMetadata> extends RoomHttpApi<TM, CM>, NotificationHttpApi<TM, CM> {
     getUrlMetadata(url: string): Promise<UrlMetadata>;
     getUserThreads_experimental(options?: {
         cursor?: string;
         query?: {
             resolved?: boolean;
-            metadata?: Partial<QueryMetadata<M>>;
+            metadata?: Partial<QueryMetadata<TM>>;
         };
     }): Promise<{
-        threads: ThreadData<M>[];
+        threads: ThreadData<TM, CM>[];
         inboxNotifications: InboxNotificationData[];
         subscriptions: SubscriptionData[];
         nextCursor: string | null;
@@ -1841,7 +1853,7 @@ interface LiveblocksHttpApi<M extends BaseMetadata> extends RoomHttpApi<M>, Noti
             deleted: InboxNotificationDeleteInfo[];
         };
         threads: {
-            updated: ThreadData<M>[];
+            updated: ThreadData<TM, CM>[];
             deleted: ThreadDeleteInfo[];
         };
         subscriptions: {
@@ -1901,6 +1913,7 @@ type CommentsOrNotificationsErrorContext = {
     commentId: string;
     body: CommentBody;
     metadata: BaseMetadata;
+    commentMetadata: BaseMetadata;
 } | {
     type: "DELETE_THREAD_ERROR";
     roomId: string;
@@ -1910,6 +1923,12 @@ type CommentsOrNotificationsErrorContext = {
     roomId: string;
     threadId: string;
     metadata: Patchable<BaseMetadata>;
+} | {
+    type: "EDIT_COMMENT_METADATA_ERROR";
+    roomId: string;
+    threadId: string;
+    commentId: string;
+    metadata: Patchable<BaseMetadata>;
 } | {
     type: "MARK_THREAD_AS_RESOLVED_ERROR" | "MARK_THREAD_AS_UNRESOLVED_ERROR" | "SUBSCRIBE_TO_THREAD_ERROR" | "UNSUBSCRIBE_FROM_THREAD_ERROR";
     roomId: string;
@@ -1920,6 +1939,7 @@ type CommentsOrNotificationsErrorContext = {
     threadId: string;
     commentId: string;
     body: CommentBody;
+    metadata: BaseMetadata;
 } | {
     type: "DELETE_COMMENT_ERROR";
     roomId: string;
@@ -1996,6 +2016,12 @@ type EnterOptions<P extends JsonObject = DP, S extends LsonObject = DS> = Resolv
      * the authentication endpoint or connect via WebSocket.
      */
     autoConnect?: boolean;
+    /**
+     * @private Preferred storage engine version to use when creating the
+     * room. Only takes effect if the room doesn't exist yet. Version
+     * 2 supports streaming and will become the default in the future.
+     */
+    engine?: 1 | 2;
 } & PartialUnless<P, {
     /**
      * The initial Presence to use and announce when you enter the Room. The
@@ -2024,7 +2050,7 @@ type InternalSyncStatus = SyncStatus | "has-local-changes";
  * of Liveblocks, NEVER USE ANY OF THESE DIRECTLY, because bad things
  * will probably happen if you do.
  */
-type PrivateClientApi<U extends BaseUserMeta, M extends BaseMetadata> = {
+type PrivateClientApi<U extends BaseUserMeta, TM extends BaseMetadata, CM extends BaseMetadata> = {
     readonly currentUserId: Signal<string | undefined>;
     readonly mentionSuggestionsCache: Map<string, MentionData[]>;
     readonly resolveMentionSuggestions: ClientOptions<U>["resolveMentionSuggestions"];
@@ -2032,13 +2058,13 @@ type PrivateClientApi<U extends BaseUserMeta, M extends BaseMetadata> = {
     readonly roomsInfoStore: BatchStore<DRI | undefined, string>;
     readonly groupsInfoStore: BatchStore<DGI | undefined, string>;
     readonly getRoomIds: () => string[];
-    readonly httpClient: LiveblocksHttpApi<M>;
-    as<M2 extends BaseMetadata>(): Client<U, M2>;
+    readonly httpClient: LiveblocksHttpApi<TM, CM>;
+    as<TM2 extends BaseMetadata, CM2 extends BaseMetadata>(): Client<U, TM2, CM2>;
     createSyncSource(): SyncSource;
     emitError(context: LiveblocksErrorContext, cause?: Error): void;
     ai: Ai;
 };
-type NotificationsApi<M extends BaseMetadata> = {
+type NotificationsApi<TM extends BaseMetadata, CM extends BaseMetadata> = {
     /**
      * Gets a page (or the initial page) for user inbox notifications and their
      * associated threads and thread subscriptions.
@@ -2065,7 +2091,7 @@ type NotificationsApi<M extends BaseMetadata> = {
         };
     }): Promise<{
         inboxNotifications: InboxNotificationData[];
-        threads: ThreadData<M>[];
+        threads: ThreadData<TM, CM>[];
         subscriptions: SubscriptionData[];
         nextCursor: string | null;
         requestedAt: Date;
@@ -2106,7 +2132,7 @@ type NotificationsApi<M extends BaseMetadata> = {
             deleted: InboxNotificationDeleteInfo[];
         };
         threads: {
-            updated: ThreadData<M>[];
+            updated: ThreadData<TM, CM>[];
             deleted: ThreadDeleteInfo[];
         };
         subscriptions: {
@@ -2186,23 +2212,23 @@ type NotificationsApi<M extends BaseMetadata> = {
  * narrower.
  */
 type OpaqueClient = Client<BaseUserMeta>;
-type Client<U extends BaseUserMeta = DU, M extends BaseMetadata = DM> = {
+type Client<U extends BaseUserMeta = DU, TM extends BaseMetadata = DTM, CM extends BaseMetadata = DCM> = {
     /**
      * Gets a room. Returns null if {@link Client.enter} has not been called previously.
      *
      * @param roomId The id of the room
      */
-    getRoom<P extends JsonObject = DP, S extends LsonObject = DS, E extends Json = DE, M2 extends BaseMetadata = M>(roomId: string): Room<P, S, U, E, M2> | null;
+    getRoom<P extends JsonObject = DP, S extends LsonObject = DS, E extends Json = DE, TM2 extends BaseMetadata = TM, CM2 extends BaseMetadata = CM>(roomId: string): Room<P, S, U, E, TM2, CM2> | null;
     /**
      * Enter a room.
      * @param roomId The id of the room
      * @param options Optional. You can provide initializers for the Presence or Storage when entering the Room.
      * @returns The room and a leave function. Call the returned leave() function when you no longer need the room.
      */
-    enterRoom<P extends JsonObject = DP, S extends LsonObject = DS, E extends Json = DE, M2 extends BaseMetadata = M>(roomId: string, ...args: OptionalTupleUnless<P & S, [
+    enterRoom<P extends JsonObject = DP, S extends LsonObject = DS, E extends Json = DE, TM2 extends BaseMetadata = TM, CM2 extends BaseMetadata = CM>(roomId: string, ...args: OptionalTupleUnless<P & S, [
         options: EnterOptions<NoInfr<P>, NoInfr<S>>
     ]>): {
-        room: Room<P, S, U, E, M2>;
+        room: Room<P, S, U, E, TM2, CM2>;
         leave: () => void;
     };
     /**
@@ -2268,7 +2294,7 @@ type Client<U extends BaseUserMeta = DU, M extends BaseMetadata = DM> = {
      * of Liveblocks, NEVER USE ANY OF THESE DIRECTLY, because bad things
      * will probably happen if you do.
      */
-    readonly [kInternal]: PrivateClientApi<U, M>;
+    readonly [kInternal]: PrivateClientApi<U, TM, CM>;
     /**
      * Returns the current global sync status of the Liveblocks client. If any
      * part of Liveblocks has any local pending changes that haven't been
@@ -2292,7 +2318,7 @@ type Client<U extends BaseUserMeta = DU, M extends BaseMetadata = DM> = {
         readonly error: Observable<LiveblocksError>;
         readonly syncStatus: Observable<void>;
     };
-} & NotificationsApi<M>;
+} & NotificationsApi<TM, CM>;
 type AuthEndpoint = string | ((room?: string) => Promise<CustomAuthenticationResult>);
 /**
  * The authentication endpoint that is called to ensure that the current user has access to a room.
@@ -2486,9 +2512,8 @@ declare const ServerMsgCode: Readonly<{
     USER_LEFT: 102;
     BROADCASTED_EVENT: 103;
     ROOM_STATE: 104;
-    INITIAL_STORAGE_STATE: 200;
+    STORAGE_STATE: 200;
     UPDATE_STORAGE: 201;
-    STORAGE_ACK: 202;
     UPDATE_YDOC: 300;
     THREAD_CREATED: 400;
     THREAD_DELETED: 407;
@@ -2499,6 +2524,7 @@ declare const ServerMsgCode: Readonly<{
     COMMENT_DELETED: 404;
     COMMENT_REACTION_ADDED: 405;
     COMMENT_REACTION_REMOVED: 406;
+    COMMENT_METADATA_UPDATED: 409;
     REJECT_STORAGE_OP: 299;
 }>;
 declare namespace ServerMsgCode {
@@ -2507,9 +2533,8 @@ declare namespace ServerMsgCode {
     type USER_LEFT = typeof ServerMsgCode.USER_LEFT;
     type BROADCASTED_EVENT = typeof ServerMsgCode.BROADCASTED_EVENT;
     type ROOM_STATE = typeof ServerMsgCode.ROOM_STATE;
-    type INITIAL_STORAGE_STATE = typeof ServerMsgCode.INITIAL_STORAGE_STATE;
+    type STORAGE_STATE = typeof ServerMsgCode.STORAGE_STATE;
     type UPDATE_STORAGE = typeof ServerMsgCode.UPDATE_STORAGE;
-    type STORAGE_ACK = typeof ServerMsgCode.STORAGE_ACK;
     type UPDATE_YDOC = typeof ServerMsgCode.UPDATE_YDOC;
     type THREAD_CREATED = typeof ServerMsgCode.THREAD_CREATED;
     type THREAD_DELETED = typeof ServerMsgCode.THREAD_DELETED;
@@ -2520,13 +2545,14 @@ declare namespace ServerMsgCode {
     type COMMENT_DELETED = typeof ServerMsgCode.COMMENT_DELETED;
     type COMMENT_REACTION_ADDED = typeof ServerMsgCode.COMMENT_REACTION_ADDED;
     type COMMENT_REACTION_REMOVED = typeof ServerMsgCode.COMMENT_REACTION_REMOVED;
+    type COMMENT_METADATA_UPDATED = typeof ServerMsgCode.COMMENT_METADATA_UPDATED;
     type REJECT_STORAGE_OP = typeof ServerMsgCode.REJECT_STORAGE_OP;
 }
 /**
  * Messages that can be sent from the server to the client.
  */
-type ServerMsg<P extends JsonObject, U extends BaseUserMeta, E extends Json> = UpdatePresenceServerMsg<P> | UserJoinServerMsg<U> | UserLeftServerMsg | BroadcastedEventServerMsg<E> | RoomStateServerMsg<U> | InitialDocumentStateServerMsg | UpdateStorageServerMsg | StorageAckServerMsg | YDocUpdateServerMsg | RejectedStorageOpServerMsg | CommentsEventServerMsg;
-type CommentsEventServerMsg = ThreadCreatedEvent | ThreadDeletedEvent | ThreadMetadataUpdatedEvent | ThreadUpdatedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved;
+type ServerMsg<P extends JsonObject, U extends BaseUserMeta, E extends Json> = UpdatePresenceServerMsg<P> | UserJoinServerMsg<U> | UserLeftServerMsg | BroadcastedEventServerMsg<E> | RoomStateServerMsg<U> | StorageStateServerMsg | UpdateStorageServerMsg | YDocUpdateServerMsg | RejectedStorageOpServerMsg | CommentsEventServerMsg;
+type CommentsEventServerMsg = ThreadCreatedEvent | ThreadDeletedEvent | ThreadMetadataUpdatedEvent | ThreadUpdatedEvent | CommentCreatedEvent | CommentEditedEvent | CommentDeletedEvent | CommentReactionAdded | CommentReactionRemoved | CommentMetadataUpdatedEvent;
 type ThreadCreatedEvent = {
     type: ServerMsgCode.THREAD_CREATED;
     threadId: string;
@@ -2570,6 +2596,11 @@ type CommentReactionRemoved = {
     commentId: string;
     emoji: string;
 };
+type CommentMetadataUpdatedEvent = {
+    type: ServerMsgCode.COMMENT_METADATA_UPDATED;
+    threadId: string;
+    commentId: string;
+};
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
  * a User updated their presence. For example, when a user moves their cursor.
@@ -2716,11 +2747,11 @@ type RoomStateServerMsg<U extends BaseUserMeta> = {
 };
 /**
  * Sent by the WebSocket server to a single client in response to the client
- * joining the Room, to provide the initial Storage state of the Room. The
- * payload includes the entire Storage document.
+ * sending a FetchStorageClientMsg message, to provide the initial Storage
+ * state of the Room. The payload includes the entire Storage document.
  */
-type InitialDocumentStateServerMsg = {
-    readonly type: ServerMsgCode.INITIAL_STORAGE_STATE;
+type StorageStateServerMsg = {
+    readonly type: ServerMsgCode.STORAGE_STATE;
     readonly items: IdTuple<SerializedCrdt>[];
 };
 /**
@@ -2734,14 +2765,6 @@ type UpdateStorageServerMsg = {
     readonly type: ServerMsgCode.UPDATE_STORAGE;
     readonly ops: Op[];
 };
-/**
- * Sent back to client that initiated a storage mutation, to acknowledge which
- * mutations have been persisted.
- */
-type StorageAckServerMsg = {
-    readonly type: ServerMsgCode.STORAGE_ACK;
-    readonly opIds: string[];
-};
 /**
  * Sent by the WebSocket server to the client to indicate that certain opIds
  * have been rejected, possibly due to lack of permissions or exceeding
@@ -3059,12 +3082,12 @@ type SubscribeFn<P extends JsonObject, _TStorage extends LsonObject, U extends B
     (type: "storage-status", listener: Callback<StorageStatus>): () => void;
     (type: "comments", listener: Callback<CommentsEventServerMsg>): () => void;
 };
-type GetThreadsOptions<M extends BaseMetadata> = {
+type GetThreadsOptions<TM extends BaseMetadata> = {
     cursor?: string;
     query?: {
         resolved?: boolean;
         subscribed?: boolean;
-        metadata?: Partial<QueryMetadata<M>>;
+        metadata?: Partial<QueryMetadata<TM>>;
     };
 };
 type GetThreadsSinceOptions = {
@@ -3087,7 +3110,7 @@ type GetSubscriptionSettingsOptions = {
  * a Room instance using globally augmented types only, which is narrower.
  */
 type OpaqueRoom = Room<JsonObject, LsonObject, BaseUserMeta, Json, BaseMetadata>;
-type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUserMeta = DU, E extends Json = DE, M extends BaseMetadata = DM> = {
+type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUserMeta = DU, E extends Json = DE, TM extends BaseMetadata = DTM, CM extends BaseMetadata = DCM> = {
     /**
      * @private
      *
@@ -3301,8 +3324,8 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
      *   requestedAt
      * } = await room.getThreads({ query: { resolved: false }});
      */
-    getThreads(options?: GetThreadsOptions<M>): Promise<{
-        threads: ThreadData<M>[];
+    getThreads(options?: GetThreadsOptions<TM>): Promise<{
+        threads: ThreadData<TM, CM>[];
         inboxNotifications: InboxNotificationData[];
         subscriptions: SubscriptionData[];
         requestedAt: Date;
@@ -3319,7 +3342,7 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
      */
     getThreadsSince(options: GetThreadsSinceOptions): Promise<{
         threads: {
-            updated: ThreadData<M>[];
+            updated: ThreadData<TM, CM>[];
             deleted: ThreadDeleteInfo[];
         };
         inboxNotifications: {
@@ -3340,7 +3363,7 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
      * const { thread, inboxNotification, subscription } = await room.getThread("th_xxx");
      */
     getThread(threadId: string): Promise<{
-        thread?: ThreadData<M>;
+        thread?: ThreadData<TM, CM>;
         inboxNotification?: InboxNotificationData;
         subscription?: SubscriptionData;
     }>;
@@ -3358,10 +3381,11 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
     createThread(options: {
         threadId?: string;
         commentId?: string;
-        metadata: M | undefined;
+        metadata: TM | undefined;
         body: CommentBody;
+        commentMetadata?: CM;
         attachmentIds?: string[];
-    }): Promise<ThreadData<M>>;
+    }): Promise<ThreadData<TM, CM>>;
     /**
      * Deletes a thread.
      *
@@ -3377,9 +3401,21 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
      * await room.editThreadMetadata({ threadId: "th_xxx", metadata: { x: 100, y: 100 } })
      */
     editThreadMetadata(options: {
-        metadata: Patchable<M>;
+        metadata: Patchable<TM>;
+        threadId: string;
+    }): Promise<TM>;
+    /**
+     * Edits a comment's metadata.
+     * To delete an existing metadata property, set its value to `null`.
+     *
+     * @example
+     * await room.editCommentMetadata({ threadId: "th_xxx", commentId: "cm_xxx", metadata: { slackChannelId: "C024BE91L", slackMessageTs: "1700311782.001200" } })
+     */
+    editCommentMetadata(options: {
         threadId: string;
-    }): Promise<M>;
+        commentId: string;
+        metadata: Patchable<CM>;
+    }): Promise<CM>;
     /**
      * Marks a thread as resolved.
      *
@@ -3424,8 +3460,9 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
         threadId: string;
         commentId?: string;
         body: CommentBody;
+        metadata?: CM;
         attachmentIds?: string[];
-    }): Promise<CommentData>;
+    }): Promise<CommentData<CM>>;
     /**
      * Edits a comment.
      *
@@ -3443,8 +3480,9 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
         threadId: string;
         commentId: string;
         body: CommentBody;
+        metadata?: Patchable<CM>;
         attachmentIds?: string[];
-    }): Promise<CommentData>;
+    }): Promise<CommentData<CM>>;
     /**
      * Deletes a comment.
      * If it is the last non-deleted comment, the thread also gets deleted.
@@ -4463,14 +4501,14 @@ declare const MENTION_CHARACTER = "@";
  * @param data The plain comment data object (usually returned by the API)
  * @returns The rich comment data object that can be used by the client.
  */
-declare function convertToCommentData(data: CommentDataPlain): CommentData;
+declare function convertToCommentData<CM extends BaseMetadata>(data: CommentDataPlain<CM>): CommentData<CM>;
 /**
  * Converts a plain thread data object (usually returned by the API) to a thread data object that can be used by the client.
  * This is necessary because the plain data object stores dates as ISO strings, but the client expects them as Date objects.
  * @param data The plain thread data object (usually returned by the API)
  * @returns The rich thread data object that can be used by the client.
  */
-declare function convertToThreadData<M extends BaseMetadata>(data: ThreadDataPlain<M>): ThreadData<M>;
+declare function convertToThreadData<TM extends BaseMetadata, CM extends BaseMetadata>(data: ThreadDataPlain<TM, CM>): ThreadData<TM, CM>;
 /**
  * Converts a plain comment reaction object (usually returned by the API) to a comment reaction object that can be used by the client.
  * This is necessary because the plain data object stores dates as ISO strings, but the client expects them as Date objects.
@@ -5186,4 +5224,4 @@ type EnsureJson<T> = T extends Json ? T : T extends Array<infer I> ? (EnsureJson
     [K in keyof T as EnsureJson<T[K]> extends never ? never : K]: EnsureJson<T[K]>;
 };
 
-export { type AckOp, type ActivityData, type AiAssistantContentPart, type AiAssistantMessage, type AiChat, type AiChatMessage, type AiChatsQuery, type AiKnowledgeRetrievalPart, type AiKnowledgeSource, type AiOpaqueToolDefinition, type AiOpaqueToolInvocationProps, type AiReasoningPart, type AiRetrievalPart, type AiSourcesPart, type AiTextPart, type AiToolDefinition, type AiToolExecuteCallback, type AiToolExecuteContext, type AiToolInvocationPart, type AiToolInvocationProps, type AiToolTypePack, type AiUrlSource, type AiUserMessage, type AiWebRetrievalPart, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, type BaseGroupInfo, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type Client, type ClientMsg, ClientMsgCode, type ClientOptions, type CommentAttachment, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentLocalAttachment, type CommentMixedAttachment, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, type CommentsEventServerMsg, type ContextualPromptContext, type ContextualPromptResponse, type CopilotId, CrdtType, type CreateListOp, type CreateManagedPoolOptions, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type Cursor, type CustomAuthenticationResult, type DAD, type DE, type DGI, type DM, type DP, type DRI, type DS, type DU, DefaultMap, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, Deque, DerivedSignal, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type DistributiveOmit, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type GetThreadsOptions, type GroupData, type GroupDataPlain, type GroupMemberData, type GroupMentionData, type GroupScopes, type History, type HistoryVersion, HttpError, type ISODateString, type ISignal, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IYjsProvider, type IdTuple, type Immutable, type InboxNotificationCustomData, type InboxNotificationCustomDataPlain, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationTextMentionData, type InboxNotificationTextMentionDataPlain, type InboxNotificationThreadData, type InboxNotificationThreadDataPlain, type InferFromSchema, type InitialDocumentStateServerMsg, type Json, type JsonArray, type JsonObject, type JsonScalar, type KDAD, type LargeMessageStrategy, type LayerKey, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, MENTION_CHARACTER, type ManagedPool, type MentionData, type MessageId, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, type NotificationSettings, type NotificationSettingsPlain, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialNotificationSettings, type PartialUnless, type Patchable, Permission, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type Poller, type PrivateClientApi, type PrivateRoomApi, Promise_withResolvers, type QueryMetadata, type QueryParams, type RejectedStorageOpServerMsg, type Relax, type RenderableToolResultResponse, type Resolve, type ResolveGroupsInfoArgs, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomStateServerMsg, type RoomSubscriptionSettings, type SearchCommentsResult, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, Signal, type SignalType, SortedList, type Status, type StorageAckServerMsg, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type SubscriptionData, type SubscriptionDataPlain, type SubscriptionDeleteInfo, type SubscriptionDeleteInfoPlain, type SubscriptionKey, type SyncSource, type SyncStatus, TextEditorType, type ThreadData, type ThreadDataPlain, type ThreadDataWithDeleteInfo, type ThreadDeleteInfo, type ToImmutable, type ToJson, type ToolResultResponse, type URLSafeString, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type UploadAttachmentOptions, type UrlMetadata, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserMentionData, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type WithNavigation, type WithOptional, type WithRequired, type YDocUpdateServerMsg, type YjsSyncStatus, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToGroupData, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createThreadId, defineAiTool, deprecate, deprecateIf, detectDupes, entries, errorIf, findLastIndex, freeze, generateUrl, getMentionsFromCommentBody, getSubscriptionKey, html, htmlSafe, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isNotificationChannelEnabled, isNumberOperator, isPlainObject, isStartsWithOperator, isUrl, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeAbortController, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, patchNotificationSettings, raise, resolveMentionsInCommentBody, sanitizeUrl, shallow, shallow2, stableStringify, stringifyCommentBody, throwUsageError, toPlainLson, tryParseJson, url, urljoin, wait, warnOnce, warnOnceIf, withTimeout };
+export { type AckOp, type ActivityData, type AiAssistantContentPart, type AiAssistantMessage, type AiChat, type AiChatMessage, type AiChatsQuery, type AiKnowledgeRetrievalPart, type AiKnowledgeSource, type AiOpaqueToolDefinition, type AiOpaqueToolInvocationProps, type AiReasoningPart, type AiRetrievalPart, type AiSourcesPart, type AiTextPart, type AiToolDefinition, type AiToolExecuteCallback, type AiToolExecuteContext, type AiToolInvocationPart, type AiToolInvocationProps, type AiToolTypePack, type AiUrlSource, type AiUserMessage, type AiWebRetrievalPart, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, type BaseGroupInfo, type BaseMetadata, type BaseRoomInfo, type BaseUserMeta, type Brand, type BroadcastEventClientMsg, type BroadcastOptions, type BroadcastedEventServerMsg, type Client, type ClientMsg, ClientMsgCode, type ClientOptions, type CommentAttachment, type CommentBody, type CommentBodyBlockElement, type CommentBodyElement, type CommentBodyInlineElement, type CommentBodyLink, type CommentBodyLinkElementArgs, type CommentBodyMention, type CommentBodyMentionElementArgs, type CommentBodyParagraph, type CommentBodyParagraphElementArgs, type CommentBodyText, type CommentBodyTextElementArgs, type CommentData, type CommentDataPlain, type CommentLocalAttachment, type CommentMixedAttachment, type CommentReaction, type CommentUserReaction, type CommentUserReactionPlain, type CommentsEventServerMsg, type ContextualPromptContext, type ContextualPromptResponse, type CopilotId, CrdtType, type CreateListOp, type CreateManagedPoolOptions, type CreateMapOp, type CreateObjectOp, type CreateOp, type CreateRegisterOp, type Cursor, type CustomAuthenticationResult, type DAD, type DCM, type DE, type DGI, type DP, type DRI, type DS, type DTM, type DU, DefaultMap, type Delegates, type DeleteCrdtOp, type DeleteObjectKeyOp, Deque, DerivedSignal, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, type DistributiveOmit, type EnsureJson, type EnterOptions, type EventSource, type FetchStorageClientMsg, type FetchYDocClientMsg, type GetThreadsOptions, type GroupData, type GroupDataPlain, type GroupMemberData, type GroupMentionData, type GroupScopes, type History, type HistoryVersion, HttpError, type ISODateString, type ISignal, type IUserInfo, type IWebSocket, type IWebSocketCloseEvent, type IWebSocketEvent, type IWebSocketInstance, type IWebSocketMessageEvent, type IYjsProvider, type IdTuple, type Immutable, type InboxNotificationCustomData, type InboxNotificationCustomDataPlain, type InboxNotificationData, type InboxNotificationDataPlain, type InboxNotificationDeleteInfo, type InboxNotificationTextMentionData, type InboxNotificationTextMentionDataPlain, type InboxNotificationThreadData, type InboxNotificationThreadDataPlain, type InferFromSchema, type Json, type JsonArray, type JsonObject, type JsonScalar, type KDAD, type LargeMessageStrategy, type LayerKey, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, MENTION_CHARACTER, type ManagedPool, type MentionData, type MessageId, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, type NotificationSettings, type NotificationSettingsPlain, type Observable, type Op, OpCode, type OpaqueClient, type OpaqueRoom, type OptionalTupleUnless, type OthersEvent, type ParentToChildNodeMap, type PartialNotificationSettings, type PartialUnless, type Patchable, Permission, type PlainLson, type PlainLsonFields, type PlainLsonList, type PlainLsonMap, type PlainLsonObject, type Poller, type PrivateClientApi, type PrivateRoomApi, Promise_withResolvers, type QueryMetadata, type QueryParams, type RejectedStorageOpServerMsg, type Relax, type RenderableToolResultResponse, type Resolve, type ResolveGroupsInfoArgs, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomStateServerMsg, type RoomSubscriptionSettings, type SearchCommentsResult, type SerializedChild, type SerializedCrdt, type SerializedList, type SerializedMap, type SerializedObject, type SerializedRegister, type SerializedRootObject, type ServerMsg, ServerMsgCode, type SetParentKeyOp, Signal, type SignalType, SortedList, type Status, type StorageStateServerMsg, type StorageStatus, type StorageUpdate, type StringifyCommentBodyElements, type StringifyCommentBodyOptions, type SubscriptionData, type SubscriptionDataPlain, type SubscriptionDeleteInfo, type SubscriptionDeleteInfoPlain, type SubscriptionKey, type SyncSource, type SyncStatus, TextEditorType, type ThreadData, type ThreadDataPlain, type ThreadDataWithDeleteInfo, type ThreadDeleteInfo, type ToImmutable, type ToJson, type ToolResultResponse, type URLSafeString, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type UploadAttachmentOptions, type UrlMetadata, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserMentionData, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type WithNavigation, type WithOptional, type WithRequired, type YDocUpdateServerMsg, type YjsSyncStatus, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToGroupData, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createThreadId, defineAiTool, deprecate, deprecateIf, detectDupes, entries, errorIf, findLastIndex, freeze, generateUrl, getMentionsFromCommentBody, getSubscriptionKey, html, htmlSafe, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isNotificationChannelEnabled, isNumberOperator, isPlainObject, isStartsWithOperator, isUrl, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeAbortController, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, patchNotificationSettings, raise, resolveMentionsInCommentBody, sanitizeUrl, shallow, shallow2, stableStringify, stringifyCommentBody, throwUsageError, toPlainLson, tryParseJson, url, urljoin, wait, warnOnce, warnOnceIf, withTimeout };