@liveblocks/core 2.25.0-aiprivatebeta9 → 3.1.0-alpha1

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import { JSONSchema7 } from 'json-schema';
-import { ComponentType } from 'react';
 
 /**
  * Throws an error if multiple copies of a Liveblocks package are being loaded
@@ -1192,8 +1191,10 @@ type CommentBodyParagraph = {
     type: "paragraph";
     children: CommentBodyInlineElement[];
 };
-type CommentBodyMention = {
+type CommentBodyMention = Relax<CommentBodyUserMention>;
+type CommentBodyUserMention = {
     type: "mention";
+    kind: "user";
     id: string;
 };
 type CommentBodyLink = {
@@ -1290,13 +1291,6 @@ type NotificationChannelSettings = {
 type NotificationSettingsPlain = {
     [C in NotificationChannel]?: NotificationChannelSettings;
 };
-/**
- * @deprecated Renamed to `NotificationSettings`
- *
- * Notification settings.
- * One channel for one set of settings.
- */
-type UserNotificationSettings = NotificationSettings;
 /**
  * Notification settings.
  * One channel for one set of settings.
@@ -1363,10 +1357,6 @@ type RoomSubscriptionSettings = {
 type UserRoomSubscriptionSettings = {
     roomId: string;
 } & RoomSubscriptionSettings;
-/**
- * @deprecated Renamed to `RoomSubscriptionSettings`
- */
-type RoomNotificationSettings = RoomSubscriptionSettings;
 
 type SubscriptionData<K extends keyof DAD = keyof DAD> = {
     kind: NotificationKind<K>;
@@ -1819,14 +1809,11 @@ type CommentsOrNotificationsErrorContext = {
     inboxNotificationId: string;
 } | {
     type: "MARK_ALL_INBOX_NOTIFICATIONS_AS_READ_ERROR" | "DELETE_ALL_INBOX_NOTIFICATIONS_ERROR";
-} | {
-    type: "UPDATE_NOTIFICATION_SETTINGS_ERROR";
-    roomId: string;
 } | {
     type: "UPDATE_ROOM_SUBSCRIPTION_SETTINGS_ERROR";
     roomId: string;
 } | {
-    type: "UPDATE_USER_NOTIFICATION_SETTINGS_ERROR";
+    type: "UPDATE_NOTIFICATION_SETTINGS_ERROR";
 };
 type LiveblocksErrorContext = Relax<RoomConnectionErrorContext | CommentsOrNotificationsErrorContext | AiConnectionErrorContext>;
 declare class LiveblocksError extends Error {
@@ -1834,8 +1821,6 @@ declare class LiveblocksError extends Error {
     constructor(message: string, context: LiveblocksErrorContext, cause?: Error);
     /** Convenience accessor for error.context.roomId (if available) */
     get roomId(): LiveblocksErrorContext["roomId"];
-    /** @deprecated Prefer using `context.code` instead, to enable type narrowing */
-    get code(): LiveblocksErrorContext["code"];
     /**
      * Creates a LiveblocksError from a generic error, by attaching Liveblocks
      * contextual information like room ID, thread ID, etc.
@@ -1843,6 +1828,12 @@ declare class LiveblocksError extends Error {
     static from(context: LiveblocksErrorContext, cause?: Error): LiveblocksError;
 }
 
+type MentionData = Relax<UserMentionData>;
+type UserMentionData = {
+    kind: "user";
+    id: string;
+};
+
 type ResolveMentionSuggestionsArgs = {
     /**
      * The ID of the current room.
@@ -1904,7 +1895,7 @@ type InternalSyncStatus = SyncStatus | "has-local-changes";
  */
 type PrivateClientApi<U extends BaseUserMeta, M extends BaseMetadata> = {
     readonly currentUserId: Signal<string | undefined>;
-    readonly mentionSuggestionsCache: Map<string, string[]>;
+    readonly mentionSuggestionsCache: Map<string, MentionData[]>;
     readonly resolveMentionSuggestions: ClientOptions<U>["resolveMentionSuggestions"];
     readonly usersStore: BatchStore<U["info"] | undefined, string>;
     readonly roomsInfoStore: BatchStore<DRI | undefined, string>;
@@ -2155,13 +2146,11 @@ type ClientOptions<U extends BaseUserMeta = DU> = {
     backgroundKeepAliveTimeout?: number;
     polyfills?: Polyfills;
     largeMessageStrategy?: LargeMessageStrategy;
-    /** @deprecated Use `largeMessageStrategy="experimental-fallback-to-http"` instead. */
-    unstable_fallbackToHTTP?: boolean;
     unstable_streamData?: boolean;
     /**
-     * A function that returns a list of user IDs matching a string.
+     * A function that returns a list of mention suggestions matching a string.
      */
-    resolveMentionSuggestions?: (args: ResolveMentionSuggestionsArgs) => Awaitable<string[]>;
+    resolveMentionSuggestions?: (args: ResolveMentionSuggestionsArgs) => Awaitable<string[] | MentionData[]>;
     /**
      * A function that returns user info from user IDs.
      * You should return a list of user objects of the same size, in the same order.
@@ -3013,11 +3002,6 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
         readonly self: Observable<User<P, U>>;
         readonly myPresence: Observable<P>;
         readonly others: Observable<OthersEvent<P, U>>;
-        /**
-         * @deprecated Renamed to `storageBatch`. The `storage` event source will
-         * soon be replaced by another/incompatible API.
-         */
-        readonly storage: Observable<StorageUpdate[]>;
         readonly storageBatch: Observable<StorageUpdate[]>;
         readonly history: Observable<HistoryEvent>;
         /**
@@ -3314,12 +3298,6 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
      * await room.getAttachmentUrl("at_xxx");
      */
     getAttachmentUrl(attachmentId: string): Promise<string>;
-    /**
-     * @deprecated Renamed to `getSubscriptionSettings`
-     *
-     * Gets the user's subscription settings for the current room.
-     */
-    getNotificationSettings(options?: GetSubscriptionSettingsOptions): Promise<RoomSubscriptionSettings>;
     /**
      * Gets the user's subscription settings for the current room.
      *
@@ -3327,12 +3305,6 @@ type Room<P extends JsonObject = DP, S extends LsonObject = DS, U extends BaseUs
      * const settings = await room.getSubscriptionSettings();
      */
     getSubscriptionSettings(options?: GetSubscriptionSettingsOptions): Promise<RoomSubscriptionSettings>;
-    /**
-     * @deprecated Renamed to `updateSubscriptionSettings`
-     *
-     * Updates the user's subscription settings for the current room.
-     */
-    updateNotificationSettings(settings: Partial<RoomSubscriptionSettings>): Promise<RoomSubscriptionSettings>;
     /**
      * Updates the user's subscription settings for the current room.
      *
@@ -3527,7 +3499,6 @@ type ISODateString = Brand<string, "ISODateString">;
 type ChatId = string;
 type MessageId = Brand<`ms_${string}`, "MessageId">;
 type CmdId = Brand<string, "CmdId">;
-type ClientId = Brand<string, "ClientId">;
 type CopilotId = Brand<`co_${string}`, "CopilotId">;
 type ServerAiMsg = ServerCmdResponse | ServerEvent;
 type DefineCmd<CmdName extends string, TRequest, TResponse> = [
@@ -3620,13 +3591,6 @@ type AskInChatPair = DefineCmd<"ask-in-chat", {
      * message ID.
      */
     targetMessageId: MessageId;
-    /**
-     * A client ID unique to this command. Later delta and settle messages will
-     * reference this client ID, which is important to ensure that tool calls
-     * with side effects will only get executed once, and only by the client
-     * that originally made the request that produced the tool call.
-     */
-    clientId: ClientId;
     generationOptions: AiGenerationOptions;
 }, {
     sourceMessage?: AiChatMessage;
@@ -3637,13 +3601,33 @@ type AbortAiPair = DefineCmd<"abort-ai", {
 }, {
     ok: true;
 }>;
-type ToolResultData = Json;
+type ToolResultResponse<R extends JsonObject = JsonObject> = Relax<({
+    data: R;
+    description?: string;
+} | {
+    error: string;
+} | {
+    cancel: true | /* reason */ string;
+})>;
+type NonEmptyString<T extends string> = T & {
+    __nonEmpty: true;
+};
+type RenderableToolResultResponse<R extends JsonObject = JsonObject> = Relax<{
+    type: "success";
+    data: R;
+} | {
+    type: "error";
+    error: NonEmptyString<string>;
+} | {
+    type: "cancelled";
+    cancelled: true;
+    reason?: string;
+}>;
 type SetToolResultPair = DefineCmd<"set-tool-result", {
     chatId: ChatId;
     messageId: MessageId;
-    toolCallId: string;
-    result: ToolResultData;
-    clientId: ClientId;
+    invocationId: string;
+    result: ToolResultResponse;
     generationOptions: AiGenerationOptions;
 }, {
     ok: true;
@@ -3651,7 +3635,7 @@ type SetToolResultPair = DefineCmd<"set-tool-result", {
 } | {
     ok: false;
 }>;
-type ServerEvent = RebootedEvent | CmdFailedEvent | ErrorServerEvent | SyncServerEvent | DeltaServerEvent | SettleServerEvent;
+type ServerEvent = RebootedEvent | CmdFailedEvent | WarningServerEvent | ErrorServerEvent | SyncServerEvent | DeltaServerEvent | SettleServerEvent;
 type RebootedEvent = {
     event: "rebooted";
 };
@@ -3661,6 +3645,10 @@ type CmdFailedEvent = {
     failedCmdId: CmdId;
     error: string;
 };
+type WarningServerEvent = {
+    event: "warning";
+    message: string;
+};
 type ErrorServerEvent = {
     event: "error";
     error: string;
@@ -3680,8 +3668,6 @@ type SyncServerEvent = {
 type DeltaServerEvent = {
     event: "delta";
     id: MessageId;
-    /** The client ID that originally made the request that led to this event */
-    clientId: ClientId;
     delta: AiAssistantDeltaUpdate;
 };
 /**
@@ -3691,8 +3677,6 @@ type DeltaServerEvent = {
  */
 type SettleServerEvent = {
     event: "settle";
-    /** The client ID that originally made the request that led to this event */
-    clientId: ClientId;
     message: AiAwaitingToolAssistantMessage | AiCompletedAssistantMessage | AiFailedAssistantMessage;
 };
 type AiChat = {
@@ -3708,28 +3692,28 @@ type AiToolDescription = {
     description?: string;
     parameters: JSONSchema7;
 };
-type AiToolInvocationPart<A extends JsonObject = JsonObject, R extends ToolResultData = ToolResultData> = Relax<AiReceivingToolInvocationPart | AiExecutingToolInvocationPart<A> | AiExecutedToolInvocationPart<A, R>>;
+type AiToolInvocationPart<A extends JsonObject = JsonObject, R extends JsonObject = JsonObject> = Relax<AiReceivingToolInvocationPart | AiExecutingToolInvocationPart<A> | AiExecutedToolInvocationPart<A, R>>;
 type AiReceivingToolInvocationPart = {
     type: "tool-invocation";
-    status: "receiving";
-    toolCallId: string;
-    toolName: string;
+    stage: "receiving";
+    invocationId: string;
+    name: string;
     partialArgs: Json;
 };
 type AiExecutingToolInvocationPart<A extends JsonObject = JsonObject> = {
     type: "tool-invocation";
-    status: "executing";
-    toolCallId: string;
-    toolName: string;
+    stage: "executing";
+    invocationId: string;
+    name: string;
     args: A;
 };
-type AiExecutedToolInvocationPart<A extends JsonObject = JsonObject, R extends ToolResultData = ToolResultData> = {
+type AiExecutedToolInvocationPart<A extends JsonObject = JsonObject, R extends JsonObject = JsonObject> = {
     type: "tool-invocation";
-    status: "executed";
-    toolCallId: string;
-    toolName: string;
+    stage: "executed";
+    invocationId: string;
+    name: string;
     args: A;
-    result: R;
+    result: RenderableToolResultResponse<R>;
 };
 type AiTextPart = {
     type: "text";
@@ -3811,120 +3795,137 @@ type AiFailedAssistantMessage = {
     contentSoFar: AiAssistantContentPart[];
     errorReason: string;
 };
-type AiChatMessage = AiUserMessage | AiAssistantMessage;
+type AiChatMessage = Relax<AiUserMessage | AiAssistantMessage>;
 type AiKnowledgeSource = {
     description: string;
     value: Json;
 };
 
-type InferFromSchema<T extends JSONSchema7> = JSONSchema7 extends T ? JsonObject : T extends {
-    type: "object";
-    properties: Record<string, JSONSchema7>;
-    required: readonly string[];
-} ? Resolve<{
-    -readonly [K in keyof T["properties"] as K extends string ? K extends Extract<K, T["required"][number]> ? K : never : never]: InferFromSchema<T["properties"][K]>;
-} & {
-    -readonly [K in keyof T["properties"] as K extends string ? K extends Extract<K, T["required"][number]> ? never : K : never]?: InferFromSchema<T["properties"][K]>;
-}> : T extends {
+type JSONObjectSchema7 = JSONSchema7 & {
     type: "object";
-    properties: Record<string, JSONSchema7>;
+};
+type NoFields = {};
+type Infer<T> = T extends JSONSchema7 ? InferFromSchema<T> : never;
+type InferAllOf<T extends readonly JSONSchema7[]> = T extends readonly [
+    infer U,
+    ...infer R
+] ? R extends readonly JSONSchema7[] ? Infer<U> & InferAllOf<R> : Infer<U> : unknown;
+type InferRequireds<P, R extends readonly string[]> = {
+    -readonly [K in keyof P as K extends string ? K extends Extract<K, R[number]> ? K : never : never]: Infer<P[K]>;
+};
+type InferOptionals<P, R extends readonly string[]> = {
+    -readonly [K in keyof P as K extends string ? K extends Extract<K, R[number]> ? never : K : never]?: Infer<P[K]>;
+};
+type InferBaseObject<T extends JSONObjectSchema7> = T extends {
+    properties?: infer P extends Record<string, JSONSchema7>;
+    required?: infer R;
+} ? InferRequireds<P, R extends readonly string[] ? R : []> & InferOptionals<P, R extends readonly string[] ? R : []> : NoFields;
+type InferAdditionals<T extends JSONObjectSchema7> = T extends {
+    additionalProperties: false;
+} ? NoFields : T extends {
+    additionalProperties?: true;
+} ? JsonObject : T extends {
+    additionalProperties: infer A;
 } ? {
-    -readonly [K in keyof T["properties"]]?: InferFromSchema<T["properties"][K]>;
-} : T extends {
+    [extra: string]: Infer<A> | undefined;
+} : JsonObject;
+type InferFromObjectSchema<T extends JSONObjectSchema7> = Resolve<InferBaseObject<T> & InferAdditionals<T>>;
+type InferFromArraySchema<T extends JSONSchema7> = T extends {
+    items: infer U;
+} ? Infer<U>[] : Json[];
+type InferFromSchema<T extends JSONSchema7> = JSONSchema7 extends T ? JsonObject : T extends {
+    type: "object";
+} ? InferFromObjectSchema<T> : T extends {
+    type: "array";
+} ? InferFromArraySchema<T> : T extends {
+    oneOf: readonly (infer U)[];
+} ? Infer<U> : T extends {
+    anyOf: readonly (infer U)[];
+} ? Infer<U> : T extends {
+    allOf: readonly JSONSchema7[];
+} ? InferAllOf<T["allOf"]> : T extends {
+    not: JSONSchema7;
+} ? Json : T extends {
+    enum: readonly (infer U)[];
+} ? U : T extends {
+    const: infer C;
+} ? C : T extends {
     type: "string";
 } ? string : T extends {
     type: "number";
+} ? number : T extends {
+    type: "integer";
 } ? number : T extends {
     type: "boolean";
 } ? boolean : T extends {
     type: "null";
-} ? null : T extends {
-    type: "array";
-    items: JSONSchema7;
-} ? InferFromSchema<T["items"]>[] : unknown;
-type AiToolTypePack<A extends JsonObject = JsonObject, R extends ToolResultData = ToolResultData> = {
+} ? null : Json;
+
+type AiToolTypePack<A extends JsonObject = JsonObject, R extends JsonObject = JsonObject> = {
     A: A;
     R: R;
 };
-type AiToolInvocationProps<A extends JsonObject, R extends ToolResultData> = Resolve<DistributiveOmit<AiToolInvocationPart<A, R>, "type"> & {
-    respond: (result: R) => void;
+type AskUserMessageInChatOptions = Omit<AiGenerationOptions, "tools" | "knowledge">;
+type SetToolResultOptions = Omit<AiGenerationOptions, "tools" | "knowledge">;
+type AiToolInvocationProps<A extends JsonObject, R extends JsonObject> = Resolve<DistributiveOmit<AiToolInvocationPart<A, R>, "type"> & {
+    respond: (...args: OptionalTupleUnless<R, [result: ToolResultResponse<R>]>) => void;
     /**
-     * Exposes specific inferred types as a "type pack" which we can pass
-     * around statically to components to "bind" them to specific inferred
-     * A and R values. There is no runtime presence for these.
+     * These are the inferred types for your tool call which you can pass down
+     * to UI components, like so:
+     *
+     *     <AiTool.Confirmation
+     *       types={types}
+     *       confirm={
+     *         // Now fully type-safe!
+     *         (args) => result
+     *       } />
+     *
+     * This will make your AiTool.Confirmation component aware of the types for
+     * `args` and `result`.
      */
-    $types: AiToolTypePack<A, R>;
+    types: AiToolTypePack<A, R>;
     [kInternal]: {
         execute: AiToolExecuteCallback<A, R> | undefined;
     };
 }>;
-type AiOpaqueToolInvocationProps = AiToolInvocationProps<JsonObject, ToolResultData>;
+type AiOpaqueToolInvocationProps = AiToolInvocationProps<JsonObject, JsonObject>;
 type AiToolExecuteContext = {
-    toolName: string;
-    toolCallId: string;
+    name: string;
+    invocationId: string;
 };
-type AiToolExecuteCallback<A extends JsonObject, R extends ToolResultData> = (args: A, context: AiToolExecuteContext) => Awaitable<R>;
-type AiToolDefinition<S extends JSONSchema7, A extends JsonObject, R extends ToolResultData> = {
+type AiToolExecuteCallback<A extends JsonObject, R extends JsonObject> = (args: A, context: AiToolExecuteContext) => Record<string, never> extends R ? Awaitable<ToolResultResponse<R> | undefined | void> : Awaitable<ToolResultResponse<R>>;
+type AiToolDefinition<S extends JSONObjectSchema7, A extends JsonObject, R extends JsonObject> = {
     description?: string;
     parameters: S;
     execute?: AiToolExecuteCallback<A, R>;
-    render?: ComponentType<AiToolInvocationProps<A, R>>;
+    render?: (props: AiToolInvocationProps<A, R>) => unknown;
+    enabled?: boolean;
 };
-type AiOpaqueToolDefinition = AiToolDefinition<JSONSchema7, JsonObject, ToolResultData>;
+type AiOpaqueToolDefinition = AiToolDefinition<JSONObjectSchema7, JsonObject, JsonObject>;
 /**
  * Helper function to help infer the types of `args`, `render`, and `result`.
  * This function has no runtime implementation and is only needed to make it
  * possible for TypeScript to infer types.
  */
-declare function defineAiTool<R extends ToolResultData>(): <const S extends JSONSchema7>(def: AiToolDefinition<S, InferFromSchema<S> extends JsonObject ? InferFromSchema<S> : JsonObject, R>) => AiOpaqueToolDefinition;
-type UiChatMessage = AiChatMessage & {
-    navigation: {
-        /**
-         * The message ID of the parent message, or null if there is no parent.
-         */
-        parent: MessageId | null;
-        /**
-         * The message ID of the left sibling message, or null if there is no left sibling.
-         */
-        prev: MessageId | null;
-        /**
-         * The message ID of the right sibling message, or null if there is no right sibling.
-         */
-        next: MessageId | null;
-    };
-};
-type UiUserMessage = AiUserMessage & {
-    navigation: {
-        /**
-         * The message ID of the parent message, or null if there is no parent.
-         */
-        parent: MessageId | null;
-        /**
-         * The message ID of the left sibling message, or null if there is no left sibling.
-         */
-        prev: MessageId | null;
-        /**
-         * The message ID of the right sibling message, or null if there is no right sibling.
-         */
-        next: MessageId | null;
-    };
+declare function defineAiTool<R extends JsonObject>(): <const S extends JSONObjectSchema7>(def: AiToolDefinition<S, InferFromSchema<S> extends JsonObject ? InferFromSchema<S> : JsonObject, R>) => AiOpaqueToolDefinition;
+type NavigationInfo = {
+    /**
+     * The message ID of the parent message, or null if there is no parent.
+     */
+    parent: MessageId | null;
+    /**
+     * The message ID of the left sibling message, or null if there is no left sibling.
+     */
+    prev: MessageId | null;
+    /**
+     * The message ID of the right sibling message, or null if there is no right sibling.
+     */
+    next: MessageId | null;
 };
-type UiAssistantMessage = AiAssistantMessage & {
-    navigation: {
-        /**
-         * The message ID of the parent message, or null if there is no parent.
-         */
-        parent: MessageId | null;
-        /**
-         * The message ID of the left sibling message, or null if there is no left sibling.
-         */
-        prev: MessageId | null;
-        /**
-         * The message ID of the right sibling message, or null if there is no right sibling.
-         */
-        next: MessageId | null;
-    };
+type WithNavigation<T> = T & {
+    navigation: NavigationInfo;
 };
+type UiChatMessage = WithNavigation<AiChatMessage>;
 type AiContext = {
     staticSessionInfoSig: Signal<StaticSessionInfo | null>;
     dynamicSessionInfoSig: Signal<DynamicSessionInfo | null>;
@@ -3948,15 +3949,11 @@ declare class KnowledgeStack {
     updateKnowledge(layerKey: LayerKey, key: string, data: AiKnowledgeSource | null): void;
 }
 declare function createStore_forTools(): {
-    getToolDefinitionΣ: (chatId: string, toolName: string) => Signal<AiOpaqueToolDefinition | undefined>;
-    getToolsForChat: (chatId: string) => {
-        name: string;
-        definition: AiOpaqueToolDefinition;
-    }[];
-    addToolDefinition: (chatId: string, name: string, definition: AiOpaqueToolDefinition) => void;
-    removeToolDefinition: (chatId: string, toolName: string) => void;
+    getToolDescriptions: (chatId: string) => AiToolDescription[];
+    getToolΣ: (name: string, chatId?: string) => DerivedSignal<AiOpaqueToolDefinition | undefined>;
+    registerTool: (name: string, tool: AiOpaqueToolDefinition, chatId?: string) => () => void;
 };
-declare function createStore_forChatMessages(toolsStore: ReturnType<typeof createStore_forTools>, setToolResult: (chatId: string, messageId: MessageId, toolCallId: string, result: ToolResultData, options?: AiGenerationOptions) => Promise<AskInChatResponse>): {
+declare function createStore_forChatMessages(toolsStore: ReturnType<typeof createStore_forTools>, setToolResultFn: (chatId: string, messageId: MessageId, invocationId: string, result: ToolResultResponse, options?: SetToolResultOptions) => Promise<void>): {
     getMessageById: (messageId: MessageId) => AiChatMessage | undefined;
     getChatMessagesForBranchΣ: (chatId: string, branch?: MessageId) => DerivedSignal<UiChatMessage[]>;
     createOptimistically: {
@@ -3969,21 +3966,21 @@ declare function createStore_forChatMessages(toolsStore: ReturnType<typeof creat
     removeByChatId: (chatId: string) => void;
     addDelta: (messageId: MessageId, delta: AiAssistantDeltaUpdate) => void;
     failAllPending: () => void;
+    markMine(messageId: MessageId): void;
 };
 declare function createStore_forUserAiChats(): {
     chatsΣ: DerivedSignal<AiChat[]>;
     getChatById: (chatId: string) => AiChat | undefined;
     upsert: (chat: AiChat) => void;
     upsertMany: (chats: AiChat[]) => void;
-    remove: (chatId: string) => void;
+    markDeleted: (chatId: string) => void;
 };
 /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
 type Ai = {
     [kInternal]: {
         context: AiContext;
     };
-    connect: () => void;
-    reconnect: () => void;
+    connectInitially: () => void;
     disconnect: () => void;
     getStatus: () => Status;
     /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
@@ -4007,16 +4004,16 @@ type Ai = {
         id: MessageId;
         parentMessageId: MessageId | null;
         content: AiUserContentPart[];
-    }, targetMessageId: MessageId, options?: AiGenerationOptions) => Promise<AskInChatResponse>;
+    }, targetMessageId: MessageId, options?: AskUserMessageInChatOptions) => Promise<AskInChatResponse>;
     /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
     abort: (messageId: MessageId) => Promise<AbortAiResponse>;
     /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
-    setToolResult: (chatId: string, messageId: MessageId, toolCallId: string, result: ToolResultData, options?: AiGenerationOptions) => Promise<AskInChatResponse>;
+    setToolResult: (chatId: string, messageId: MessageId, invocationId: string, result: ToolResultResponse, options?: SetToolResultOptions) => Promise<void>;
     /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
     signals: {
         chatsΣ: DerivedSignal<AiChat[]>;
         getChatMessagesForBranchΣ(chatId: string, branch?: MessageId): DerivedSignal<UiChatMessage[]>;
-        getToolDefinitionΣ(chatId: string, toolName: string): Signal<AiOpaqueToolDefinition | undefined>;
+        getToolΣ(name: string, chatId?: string): DerivedSignal<AiOpaqueToolDefinition | undefined>;
     };
     /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
     getChatById: (chatId: string) => AiChat | undefined;
@@ -4027,11 +4024,7 @@ type Ai = {
     /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
     updateKnowledge: (layerKey: LayerKey, data: AiKnowledgeSource, key?: string) => void;
     /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
-    debug_getAllKnowledge(): AiKnowledgeSource[];
-    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
-    registerChatTool: (chatId: string, name: string, definition: AiOpaqueToolDefinition) => void;
-    /** @private This API will change, and is not considered stable. DO NOT RELY on it. */
-    unregisterChatTool: (chatId: string, toolName: string) => void;
+    registerTool: (name: string, tool: AiOpaqueToolDefinition, chatId?: string) => () => void;
 };
 
 type CommentBodyParagraphElementArgs = {
@@ -4112,9 +4105,12 @@ declare function isCommentBodyText(element: CommentBodyElement): element is Comm
 declare function isCommentBodyMention(element: CommentBodyElement): element is CommentBodyMention;
 declare function isCommentBodyLink(element: CommentBodyElement): element is CommentBodyLink;
 /**
- * Get an array of each user's ID that has been mentioned in a `CommentBody`.
+ * Get an array of all mentions in a `CommentBody`.
+ *
+ * Narrow results with an optional predicate, e.g.
+ * `(mention) => mention.kind === "user"` to only get user mentions.
  */
-declare function getMentionedIdsFromCommentBody(body: CommentBody): string[];
+declare function getMentionsFromCommentBody(body: CommentBody, predicate?: (mention: CommentBodyMention) => boolean): CommentBodyMention[];
 declare function resolveUsersInCommentBody<U extends BaseUserMeta>(body: CommentBody, resolveUsers?: (args: ResolveUsersArgs) => Awaitable<(U["info"] | undefined)[] | undefined>): Promise<Map<string, U["info"]>>;
 declare function htmlSafe(value: string): HtmlSafeString;
 declare class HtmlSafeString {
@@ -4817,9 +4813,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]>;
 };
 
-/** @deprecated Use HttpError instead. */
-declare const CommentsApiError: typeof HttpError;
-/** @deprecated Use HttpError instead. */
-declare const NotificationsApiError: typeof HttpError;
-
-export { type AckOp, type ActivityData, type AiAssistantContentPart, type AiChat, type AiChatMessage, type AiKnowledgeSource, type AiOpaqueToolDefinition, type AiOpaqueToolInvocationProps, type AiReasoningPart, type AiTextPart, type AiToolDefinition, type AiToolExecuteCallback, type AiToolExecuteContext, type AiToolInvocationPart, type AiToolInvocationProps, type AiToolTypePack, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, 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, CommentsApiError, 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 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 History, type HistoryVersion, HttpError, 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, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, type ManagedPool, type MessageId, MutableSignal, type NoInfr, type NodeMap, type NotificationChannel, type NotificationChannelSettings, type NotificationKind, type NotificationSettings, type NotificationSettingsPlain, NotificationsApiError, 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 Resolve, type ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomNotificationSettings, type RoomStateServerMsg, type RoomSubscriptionSettings, 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 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 ToolResultData, type URLSafeString, type UiAssistantMessage, type UiChatMessage, type UiUserMessage, type UnsubscribeCallback, type UpdateObjectOp, type UpdatePresenceClientMsg, type UpdatePresenceServerMsg, type UpdateStorageClientMsg, type UpdateStorageServerMsg, type UpdateYDocClientMsg, type UploadAttachmentOptions, type User, type UserJoinServerMsg, type UserLeftServerMsg, type UserNotificationSettings, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createThreadId, defineAiTool, deprecate, deprecateIf, detectDupes, entries, errorIf, freeze, generateCommentUrl, getMentionedIdsFromCommentBody, getSubscriptionKey, html, htmlSafe, isChildCrdt, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isNotificationChannelEnabled, isPlainObject, isRootCrdt, isStartsWithOperator, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeAbortController, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, patchNotificationSettings, raise, resolveUsersInCommentBody, shallow, shallow2, stableStringify, stringifyCommentBody, throwUsageError, toAbsoluteUrl, toPlainLson, tryParseJson, url, urljoin, wait, withTimeout };
+export { type AckOp, type ActivityData, type AiAssistantContentPart, type AiAssistantMessage, type AiChat, type AiChatMessage, type AiKnowledgeSource, type AiOpaqueToolDefinition, type AiOpaqueToolInvocationProps, type AiReasoningPart, type AiTextPart, type AiToolDefinition, type AiToolExecuteCallback, type AiToolExecuteContext, type AiToolInvocationPart, type AiToolInvocationProps, type AiToolTypePack, type AiUserMessage, type AsyncError, type AsyncLoading, type AsyncResult, type AsyncSuccess, type Awaitable, type BaseActivitiesData, type BaseAuthResult, 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 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 History, type HistoryVersion, HttpError, 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, LiveList, type LiveListUpdate, LiveMap, type LiveMapUpdate, type LiveNode, LiveObject, type LiveObjectUpdate, type LiveStructure, LiveblocksError, type LiveblocksErrorContext, type LostConnectionEvent, type Lson, type LsonObject, 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 ResolveMentionSuggestionsArgs, type ResolveRoomsInfoArgs, type ResolveUsersArgs, type Room, type RoomEventMessage, type RoomStateServerMsg, type RoomSubscriptionSettings, 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 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 User, type UserJoinServerMsg, type UserLeftServerMsg, type UserMentionData, type UserRoomSubscriptionSettings, type UserSubscriptionData, type UserSubscriptionDataPlain, WebsocketCloseCodes, type WithNavigation, type YDocUpdateServerMsg, type YjsSyncStatus, ackOp, asPos, assert, assertNever, autoRetry, b64decode, batch, checkBounds, chunk, cloneLson, compactObject, fancyConsole as console, convertToCommentData, convertToCommentUserReaction, convertToInboxNotificationData, convertToSubscriptionData, convertToThreadData, convertToUserSubscriptionData, createClient, createCommentAttachmentId, createCommentId, createInboxNotificationId, createManagedPool, createNotificationSettings, createThreadId, defineAiTool, deprecate, deprecateIf, detectDupes, entries, errorIf, freeze, generateCommentUrl, getMentionsFromCommentBody, getSubscriptionKey, html, htmlSafe, isChildCrdt, isCommentBodyLink, isCommentBodyMention, isCommentBodyText, isJsonArray, isJsonObject, isJsonScalar, isLiveNode, isNotificationChannelEnabled, isPlainObject, isRootCrdt, isStartsWithOperator, kInternal, keys, legacy_patchImmutableObject, lsonToJson, makeAbortController, makeEventSource, makePoller, makePosition, mapValues, memoizeOnSuccess, nanoid, nn, objectToQuery, patchLiveObjectKey, patchNotificationSettings, raise, resolveUsersInCommentBody, shallow, shallow2, stableStringify, stringifyCommentBody, throwUsageError, toAbsoluteUrl, toPlainLson, tryParseJson, url, urljoin, wait, withTimeout };