@liveblocks/core 2.25.0-aiprivatebeta10 → 2.25.0-aiprivatebeta11

package/dist/index.d.cts

@@ -3818,6 +3818,9 @@ type InferFromSchema<T extends JSONSchema7> = JSONSchema7 extends T ? JsonObject
 } ? {
     -readonly [K in keyof T["properties"]]?: InferFromSchema<T["properties"][K]>;
 } : T extends {
+    type: "string" | "number" | "boolean";
+    enum: readonly (infer U)[];
+} ? U : T extends {
     type: "string";
 } ? string : T extends {
     type: "number";
@@ -3833,6 +3836,8 @@ type AiToolTypePack<A extends JsonObject = JsonObject, R extends ToolResultData
     A: A;
     R: R;
 };
+type AskUserMessageInChatOptions = Omit<AiGenerationOptions, "tools" | "knowledge">;
+type SetToolResultOptions = Omit<AiGenerationOptions, "tools" | "knowledge">;
 type AiToolInvocationProps<A extends JsonObject, R extends ToolResultData> = Resolve<DistributiveOmit<AiToolInvocationPart<A, R>, "type"> & {
     respond: (result: R) => void;
     /**
@@ -3947,15 +3952,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<SetToolResultResponse>): {
+declare function createStore_forChatMessages(toolsStore: ReturnType<typeof createStore_forTools>, setToolResult: (chatId: string, messageId: MessageId, toolCallId: string, result: ToolResultData, options?: SetToolResultOptions) => Promise<SetToolResultResponse>): {
     getMessageById: (messageId: MessageId) => AiChatMessage | undefined;
     getChatMessagesForBranchΣ: (chatId: string, branch?: MessageId) => DerivedSignal<UiChatMessage[]>;
     createOptimistically: {
@@ -3975,7 +3976,7 @@ declare function createStore_forUserAiChats(): {
     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 = {
@@ -4007,16 +4008,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<SetToolResultResponse>;
+    setToolResult: (chatId: string, messageId: MessageId, toolCallId: string, result: ToolResultData, options?: SetToolResultOptions) => Promise<SetToolResultResponse>;
     /** @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,9 +4028,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. */
-    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 = {

package/dist/index.d.ts

@@ -3818,6 +3818,9 @@ type InferFromSchema<T extends JSONSchema7> = JSONSchema7 extends T ? JsonObject
 } ? {
     -readonly [K in keyof T["properties"]]?: InferFromSchema<T["properties"][K]>;
 } : T extends {
+    type: "string" | "number" | "boolean";
+    enum: readonly (infer U)[];
+} ? U : T extends {
     type: "string";
 } ? string : T extends {
     type: "number";
@@ -3833,6 +3836,8 @@ type AiToolTypePack<A extends JsonObject = JsonObject, R extends ToolResultData
     A: A;
     R: R;
 };
+type AskUserMessageInChatOptions = Omit<AiGenerationOptions, "tools" | "knowledge">;
+type SetToolResultOptions = Omit<AiGenerationOptions, "tools" | "knowledge">;
 type AiToolInvocationProps<A extends JsonObject, R extends ToolResultData> = Resolve<DistributiveOmit<AiToolInvocationPart<A, R>, "type"> & {
     respond: (result: R) => void;
     /**
@@ -3947,15 +3952,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<SetToolResultResponse>): {
+declare function createStore_forChatMessages(toolsStore: ReturnType<typeof createStore_forTools>, setToolResult: (chatId: string, messageId: MessageId, toolCallId: string, result: ToolResultData, options?: SetToolResultOptions) => Promise<SetToolResultResponse>): {
     getMessageById: (messageId: MessageId) => AiChatMessage | undefined;
     getChatMessagesForBranchΣ: (chatId: string, branch?: MessageId) => DerivedSignal<UiChatMessage[]>;
     createOptimistically: {
@@ -3975,7 +3976,7 @@ declare function createStore_forUserAiChats(): {
     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 = {
@@ -4007,16 +4008,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<SetToolResultResponse>;
+    setToolResult: (chatId: string, messageId: MessageId, toolCallId: string, result: ToolResultData, options?: SetToolResultOptions) => Promise<SetToolResultResponse>;
     /** @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,9 +4028,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. */
-    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 = {

package/dist/index.js

@@ -6,7 +6,7 @@ var __export = (target, all) => {
 
 // src/version.ts
 var PKG_NAME = "@liveblocks/core";
-var PKG_VERSION = "2.25.0-aiprivatebeta10";
+var PKG_VERSION = "2.25.0-aiprivatebeta11";
 var PKG_FORMAT = "esm";
 
 // src/dupe-detection.ts
@@ -3780,46 +3780,61 @@ var KnowledgeStack = class {
 function now() {
   return (/* @__PURE__ */ new Date()).toISOString();
 }
+var kWILDCARD = Symbol("*");
 function createStore_forTools() {
-  const toolsByChatId\u03A3 = new DefaultMap((_chatId) => {
-    return new DefaultMap((_toolName) => {
-      return new Signal(void 0);
+  const toolsByChatId\u03A3 = new DefaultMap(
+    (_chatId) => {
+      return new DefaultMap((_name) => {
+        return new Signal(void 0);
+      });
+    }
+  );
+  const globalOrScopedTool\u03A3 = new DefaultMap((nameAndChat) => {
+    const [name, chatId] = tryParseJson(nameAndChat);
+    return DerivedSignal.from(() => {
+      return (
+        // A tool that's registered and scoped to a specific chat ID...
+        (chatId !== void 0 ? toolsByChatId\u03A3.get(chatId)?.get(name) : void 0)?.get() ?? // ...or a globally registered tool
+        toolsByChatId\u03A3.getOrCreate(kWILDCARD).get(name)?.get()
+      );
     });
   });
-  function getToolDefinition\u03A3(chatId, toolName) {
-    return toolsByChatId\u03A3.getOrCreate(chatId).getOrCreate(toolName);
+  function getTool\u03A3(name, chatId) {
+    const key = JSON.stringify(chatId !== void 0 ? [name, chatId] : [name]);
+    return globalOrScopedTool\u03A3.getOrCreate(key);
   }
-  function addToolDefinition(chatId, name, definition) {
-    if (!definition.execute && !definition.render) {
+  function registerTool(name, tool, chatId) {
+    if (!tool.execute && !tool.render) {
       throw new Error(
-        "A tool definition must have an execute() function, a render property, or both."
+        "A tool definition must have an execute() function, a render() function, or both."
       );
     }
-    toolsByChatId\u03A3.getOrCreate(chatId).getOrCreate(name).set(definition);
+    const key = chatId ?? kWILDCARD;
+    toolsByChatId\u03A3.getOrCreate(key).getOrCreate(name).set(tool);
+    return () => unregisterTool(key, name);
   }
-  function removeToolDefinition(chatId, toolName) {
+  function unregisterTool(chatId, name) {
     const tools = toolsByChatId\u03A3.get(chatId);
     if (tools === void 0) return;
-    const tool = tools.get(toolName);
+    const tool = tools.get(name);
     if (tool === void 0) return;
     tool.set(void 0);
   }
-  function getToolsForChat(chatId) {
-    const tools = toolsByChatId\u03A3.get(chatId);
-    if (tools === void 0) return [];
-    return Array.from(tools.entries()).map(([name, tool]) => {
-      if (tool.get() === void 0) return null;
-      return {
-        name,
-        definition: tool.get()
-      };
-    }).filter((tool) => tool !== null);
+  function getToolDescriptions(chatId) {
+    const globalTools\u03A3 = toolsByChatId\u03A3.get(kWILDCARD);
+    const scopedTools\u03A3 = toolsByChatId\u03A3.get(chatId);
+    return Array.from([
+      ...globalTools\u03A3?.entries() ?? [],
+      ...scopedTools\u03A3?.entries() ?? []
+    ]).flatMap(([name, tool\u03A3]) => {
+      const tool = tool\u03A3.get();
+      return tool ? [{ name, description: tool.description, parameters: tool.parameters }] : [];
+    });
   }
   return {
-    getToolDefinition\u03A3,
-    getToolsForChat,
-    addToolDefinition,
-    removeToolDefinition
+    getToolDescriptions,
+    getTool\u03A3,
+    registerTool
   };
 }
 function createStore_forChatMessages(toolsStore, setToolResult) {
@@ -3909,7 +3924,7 @@ function createStore_forChatMessages(toolsStore, setToolResult) {
             continue;
           }
           seenToolCallIds.add(toolCall.toolCallId);
-          const toolDef = toolsStore.getToolDefinition\u03A3(message.chatId, toolCall.toolName).get();
+          const toolDef = toolsStore.getTool\u03A3(toolCall.toolName, message.chatId).get();
           const respondSync = (result) => {
             setToolResult(
               message.chatId,
@@ -4091,16 +4106,16 @@ function createStore_forChatMessages(toolsStore, setToolResult) {
   };
 }
 function createStore_forUserAiChats() {
-  const mutable\u03A3 = new MutableSignal(
+  const allChatsInclDeleted\u03A3 = new MutableSignal(
     SortedList.with((x, y) => y.createdAt < x.createdAt)
   );
-  const chats\u03A3 = DerivedSignal.from(
-    () => Array.from(mutable\u03A3.get()).filter((c) => !c.deletedAt)
+  const nonDeletedChats\u03A3 = DerivedSignal.from(
+    () => Array.from(allChatsInclDeleted\u03A3.get()).filter((c) => !c.deletedAt)
   );
   function upsertMany(chats) {
-    mutable\u03A3.mutate((list) => {
+    allChatsInclDeleted\u03A3.mutate((list) => {
       for (const chat of chats) {
-        remove(chat.id);
+        list.removeBy((c) => c.id === chat.id, 1);
         list.add(chat);
       }
     });
@@ -4108,19 +4123,26 @@ function createStore_forUserAiChats() {
   function upsert(chat) {
     upsertMany([chat]);
   }
-  function remove(chatId) {
-    mutable\u03A3.mutate((list) => list.removeBy((c) => c.id === chatId, 1));
+  function markDeleted(chatId) {
+    allChatsInclDeleted\u03A3.mutate((list) => {
+      const chat = list.find((c) => c.id === chatId);
+      if (!chat) return false;
+      upsert({ ...chat, deletedAt: now() });
+      return void 0;
+    });
   }
   function getChatById(chatId) {
-    return Array.from(mutable\u03A3.get()).find((chat) => chat.id === chatId);
+    return Array.from(allChatsInclDeleted\u03A3.get()).find(
+      (chat) => chat.id === chatId
+    );
   }
   return {
-    chats\u03A3,
+    chats\u03A3: nonDeletedChats\u03A3,
     getChatById,
     // Mutations
     upsert,
     upsertMany,
-    remove
+    markDeleted
   };
 }
 function createAi(config) {
@@ -4220,7 +4242,7 @@ function createAi(config) {
               context.messagesStore.remove(m.chatId, m.id);
             }
             for (const chatId of msg["-chats"] ?? []) {
-              context.chatsStore.remove(chatId);
+              context.chatsStore.markDeleted(chatId);
               context.messagesStore.removeByChatId(chatId);
             }
             for (const chatId of msg.clear ?? []) {
@@ -4246,7 +4268,7 @@ function createAi(config) {
           context.chatsStore.upsert(msg.chat);
           break;
         case "delete-chat":
-          context.chatsStore.remove(msg.chatId);
+          context.chatsStore.markDeleted(msg.chatId);
           context.messagesStore.removeByChatId(msg.chatId);
           break;
         case "get-message-tree":
@@ -4346,6 +4368,7 @@ function createAi(config) {
   }
   async function setToolResult(chatId, messageId, toolCallId, result, options) {
     const knowledge = context.knowledge.get();
+    const tools = context.toolsStore.getToolDescriptions(chatId);
     const resp = await sendClientMsgWithResponse({
       cmd: "set-tool-result",
       chatId,
@@ -4356,12 +4379,10 @@ function createAi(config) {
         copilotId: options?.copilotId,
         stream: options?.stream,
         timeout: options?.timeout,
+        // Knowledge and tools aren't coming from the options, but retrieved
+        // from the global context
         knowledge: knowledge.length > 0 ? knowledge : void 0,
-        tools: context.toolsStore.getToolsForChat(chatId).map((tool) => ({
-          name: tool.name,
-          description: tool.definition.description,
-          parameters: tool.definition.parameters
-        }))
+        tools: tools.length > 0 ? tools : void 0
       }
     });
     if (resp.ok) {
@@ -4387,6 +4408,7 @@ function createAi(config) {
       clearChat: (chatId) => sendClientMsgWithResponse({ cmd: "clear-chat", chatId }),
       askUserMessageInChat: async (chatId, userMessage, targetMessageId, options) => {
         const knowledge = context.knowledge.get();
+        const tools = context.toolsStore.getToolDescriptions(chatId);
         const resp = await sendClientMsgWithResponse({
           cmd: "ask-in-chat",
           chatId,
@@ -4396,12 +4418,10 @@ function createAi(config) {
             copilotId: options?.copilotId,
             stream: options?.stream,
             timeout: options?.timeout,
+            // Knowledge and tools aren't coming from the options, but retrieved
+            // from the global context
             knowledge: knowledge.length > 0 ? knowledge : void 0,
-            tools: context.toolsStore.getToolsForChat(chatId).map((tool) => ({
-              name: tool.name,
-              description: tool.definition.description,
-              parameters: tool.definition.parameters
-            }))
+            tools: tools.length > 0 ? tools : void 0
           }
         });
         messagesStore.allowAutoExecuteToolCall(resp.targetMessage.id);
@@ -4413,14 +4433,13 @@ function createAi(config) {
       signals: {
         chats\u03A3: context.chatsStore.chats\u03A3,
         getChatMessagesForBranch\u03A3: context.messagesStore.getChatMessagesForBranch\u03A3,
-        getToolDefinition\u03A3: context.toolsStore.getToolDefinition\u03A3
+        getTool\u03A3: context.toolsStore.getTool\u03A3
       },
       getChatById: context.chatsStore.getChatById,
       registerKnowledgeLayer,
       deregisterKnowledgeLayer,
       updateKnowledge,
-      registerChatTool: context.toolsStore.addToolDefinition,
-      unregisterChatTool: context.toolsStore.removeToolDefinition
+      registerTool: context.toolsStore.registerTool
     },
     kInternal,
     { enumerable: false }