@liveblocks/core 2.25.0-aiprivatebeta8 → 3.0.0

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-aiprivatebeta8";
+var PKG_VERSION = "3.0.0";
 var PKG_FORMAT = "esm";
 
 // src/dupe-detection.ts
@@ -3715,6 +3715,11 @@ function appendDelta(content, delta) {
 
 // src/ai.ts
 var DEFAULT_REQUEST_TIMEOUT = 4e3;
+function defineAiTool() {
+  return (def) => {
+    return def;
+  };
+}
 var KnowledgeStack = class {
   #_layers;
   #stack;
@@ -3775,50 +3780,66 @@ 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) {
-  const seenToolCallIds = /* @__PURE__ */ new Set();
+function createStore_forChatMessages(toolsStore, setToolResultFn) {
+  const myMessages = /* @__PURE__ */ new Set();
+  const handledInvocations = /* @__PURE__ */ new Set();
   const messagePoolByChatId\u03A3 = new DefaultMap(
     (_chatId) => new MutableSignal(
       new TreePool(
@@ -3896,39 +3917,39 @@ function createStore_forChatMessages(toolsStore, setToolResult) {
         });
       }
       if (message.role === "assistant" && message.status === "awaiting-tool") {
-        for (const toolCall of message.contentSoFar.filter(
-          (part) => part.type === "tool-invocation" && part.status === "executing"
-        )) {
-          if (seenToolCallIds.has(toolCall.toolCallId)) {
-            continue;
-          }
-          seenToolCallIds.add(toolCall.toolCallId);
-          const toolDef = toolsStore.getToolDefinition\u03A3(message.chatId, toolCall.toolName).get();
-          const respondSync = (result) => {
-            setToolResult(
-              message.chatId,
-              message.id,
-              toolCall.toolCallId,
-              result
-              // TODO Pass in AiGenerationOptions here, or make the backend use the same options
-            ).catch((err) => {
-              error2(
-                `Error trying to respond to tool-call: ${String(err)} (in respond())`
-              );
-            });
-          };
-          const executeFn = toolDef?.execute;
-          if (executeFn) {
-            (async () => {
-              const result = await executeFn(toolCall.args);
-              respondSync(result);
-            })().catch((err) => {
-              error2(
-                `Error trying to respond to tool-call: ${String(err)} (in execute())`
-              );
-            });
+        if (myMessages.has(message.id)) {
+          for (const toolInvocation of message.contentSoFar.filter(
+            (part) => part.type === "tool-invocation" && part.stage === "executing"
+          )) {
+            if (!handledInvocations.has(toolInvocation.invocationId)) {
+              handledInvocations.add(toolInvocation.invocationId);
+            } else {
+              continue;
+            }
+            const executeFn = toolsStore.getTool\u03A3(toolInvocation.name, message.chatId).get()?.execute;
+            if (executeFn) {
+              (async () => {
+                const result = await executeFn(toolInvocation.args, {
+                  name: toolInvocation.name,
+                  invocationId: toolInvocation.invocationId
+                });
+                return await setToolResultFn(
+                  message.chatId,
+                  message.id,
+                  toolInvocation.invocationId,
+                  result ?? { data: {} }
+                  // TODO Pass in AiGenerationOptions here, or make the backend use the same options
+                );
+              })().catch((err) => {
+                error2(
+                  `Error trying to respond to tool-call: ${String(err)} (in execute())`
+                );
+              });
+            }
           }
         }
+      } else {
+        myMessages.delete(message.id);
       }
     });
   }
@@ -4073,20 +4094,23 @@ function createStore_forChatMessages(toolsStore, setToolResult) {
     remove,
     removeByChatId,
     addDelta,
-    failAllPending
+    failAllPending,
+    markMine(messageId) {
+      myMessages.add(messageId);
+    }
   };
 }
 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);
       }
     });
@@ -4094,19 +4118,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) {
@@ -4116,7 +4147,6 @@ function createAi(config) {
     false
     // AI doesn't have actors (yet, but it will)
   );
-  const clientId = nanoid(7);
   const chatsStore = createStore_forUserAiChats();
   const toolsStore = createStore_forTools();
   const messagesStore = createStore_forChatMessages(toolsStore, setToolResult);
@@ -4196,7 +4226,11 @@ function createAi(config) {
           context.messagesStore.upsert(msg.message);
           break;
         }
+        case "warning":
+          warn(msg.message);
+          break;
         case "error":
+          error2(msg.error);
           break;
         case "rebooted":
           context.messagesStore.failAllPending();
@@ -4207,7 +4241,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 ?? []) {
@@ -4233,7 +4267,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":
@@ -4277,7 +4311,13 @@ function createAi(config) {
       );
     }
   });
+  function connectInitially() {
+    if (managedSocket.getStatus() === "initial") {
+      managedSocket.connect();
+    }
+  }
   async function sendClientMsgWithResponse(msg) {
+    connectInitially();
     if (managedSocket.getStatus() !== "connected") {
       await managedSocket.events.didConnect.waitUntil();
     }
@@ -4331,70 +4371,65 @@ function createAi(config) {
   function updateKnowledge(layerKey, data, key = nanoid()) {
     context.knowledge.updateKnowledge(layerKey, key, data);
   }
-  function debug_getAllKnowledge() {
-    return context.knowledge.get();
-  }
-  async function setToolResult(chatId, messageId, toolCallId, result, options) {
+  async function setToolResult(chatId, messageId, invocationId, result, options) {
     const knowledge = context.knowledge.get();
-    return sendClientMsgWithResponse({
+    const tools = context.toolsStore.getToolDescriptions(chatId);
+    const resp = await sendClientMsgWithResponse({
       cmd: "set-tool-result",
       chatId,
       messageId,
-      toolCallId,
-      clientId,
+      invocationId,
       result,
       generationOptions: {
         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) {
+      messagesStore.markMine(resp.message.id);
+    }
   }
   return Object.defineProperty(
     {
       [kInternal]: {
         context
       },
-      connect: () => managedSocket.connect(),
-      reconnect: () => managedSocket.reconnect(),
+      connectInitially,
+      // reconnect: () => managedSocket.reconnect(),
       disconnect: () => managedSocket.disconnect(),
       getChats,
       getOrCreateChat,
       deleteChat: (chatId) => {
-        return sendClientMsgWithResponse({
-          cmd: "delete-chat",
-          chatId
-        });
+        return sendClientMsgWithResponse({ cmd: "delete-chat", chatId });
       },
       getMessageTree,
       deleteMessage: (chatId, messageId) => sendClientMsgWithResponse({ cmd: "delete-message", chatId, messageId }),
       clearChat: (chatId) => sendClientMsgWithResponse({ cmd: "clear-chat", chatId }),
       askUserMessageInChat: async (chatId, userMessage, targetMessageId, options) => {
         const knowledge = context.knowledge.get();
-        return sendClientMsgWithResponse({
+        const tools = context.toolsStore.getToolDescriptions(chatId);
+        const resp = await sendClientMsgWithResponse({
           cmd: "ask-in-chat",
           chatId,
           sourceMessage: userMessage,
           targetMessageId,
-          clientId,
           generationOptions: {
             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.markMine(resp.targetMessage.id);
+        return resp;
       },
       abort: (messageId) => sendClientMsgWithResponse({ cmd: "abort-ai", messageId }),
       setToolResult,
@@ -4402,15 +4437,13 @@ function createAi(config) {
       signals: {
         chats\u03A3: context.chatsStore.chats\u03A3,
         getChatMessagesForBranch\u03A3: context.messagesStore.getChatMessagesForBranch\u03A3,
-        getChatById: context.chatsStore.getChatById,
-        getToolDefinition\u03A3: context.toolsStore.getToolDefinition\u03A3
+        getTool\u03A3: context.toolsStore.getTool\u03A3
       },
+      getChatById: context.chatsStore.getChatById,
       registerKnowledgeLayer,
       deregisterKnowledgeLayer,
       updateKnowledge,
-      debug_getAllKnowledge,
-      registerChatTool: context.toolsStore.addToolDefinition,
-      unregisterChatTool: context.toolsStore.removeToolDefinition
+      registerTool: context.toolsStore.registerTool
     },
     kInternal,
     { enumerable: false }
@@ -4426,7 +4459,7 @@ function makeCreateSocketDelegateForAi(baseUrl, WebSocketPolyfill) {
     }
     const url2 = new URL(baseUrl);
     url2.protocol = url2.protocol === "http:" ? "ws" : "wss";
-    url2.pathname = "/ai/v1";
+    url2.pathname = "/ai/v4";
     if (authValue.type === "secret") {
       url2.searchParams.set("tok", authValue.token.raw);
     } else if (authValue.type === "public") {
@@ -7743,7 +7776,7 @@ var LiveblocksError = class _LiveblocksError extends Error {
   get roomId() {
     return this.context.roomId;
   }
-  /** @deprecated Prefer using `context.code` instead, to enable type narrowing */
+  /** @internal Use `context.code` instead, to enable type narrowing */
   get code() {
     return this.context.code;
   }
@@ -7813,11 +7846,9 @@ function defaultMessageFromContext(context) {
       return "Could not mark all inbox notifications as read";
     case "DELETE_ALL_INBOX_NOTIFICATIONS_ERROR":
       return "Could not delete all inbox notifications";
-    case "UPDATE_NOTIFICATION_SETTINGS_ERROR":
-      return "Could not update notification settings";
     case "UPDATE_ROOM_SUBSCRIPTION_SETTINGS_ERROR":
       return "Could not update room subscription settings";
-    case "UPDATE_USER_NOTIFICATION_SETTINGS_ERROR":
+    case "UPDATE_NOTIFICATION_SETTINGS_ERROR":
       return "Could not update notification settings";
     default:
       return assertNever(context, "Unhandled case");
@@ -8950,8 +8981,6 @@ ${Array.from(traces).join("\n\n")}`
     others: eventHub.others.observable,
     self: eventHub.self.observable,
     myPresence: eventHub.myPresence.observable,
-    /** @deprecated */
-    storage: eventHub.storageBatch.observable,
     storageBatch: eventHub.storageBatch.observable,
     history: eventHub.history.observable,
     storageDidLoad: eventHub.storageDidLoad.observable,
@@ -9413,8 +9442,26 @@ function createClient(options) {
         baseUrl,
         clientOptions.polyfills?.WebSocket
       ),
-      authenticate: makeAuthDelegateForRoom("default", authManager),
-      canZombie: () => true
+      authenticate: async () => {
+        const resp = await authManager.getAuthValue({
+          requestedScope: "room:read"
+        });
+        if (resp.type === "public") {
+          throw new StopRetrying(
+            "Cannot use AI Copilots with a public API key"
+          );
+        } else if (resp.token.parsed.k === "sec-legacy" /* SECRET_LEGACY */) {
+          throw new StopRetrying("AI Copilots requires an ID or Access token");
+        } else {
+          if (!resp.token.parsed.ai) {
+            throw new StopRetrying(
+              "AI Copilots is not yet enabled for this account. To get started, see https://liveblocks.io/docs/get-started/ai-copilots#Quickstart"
+            );
+          }
+        }
+        return resp;
+      },
+      canZombie: () => false
     }
   });
   function teardownRoom(room) {
@@ -9468,7 +9515,7 @@ function createClient(options) {
         enableDebugLogging: clientOptions.enableDebugLogging,
         baseUrl,
         errorEventSource: liveblocksErrorSource,
-        largeMessageStrategy: clientOptions.largeMessageStrategy ?? (clientOptions.unstable_fallbackToHTTP ? "experimental-fallback-to-http" : void 0),
+        largeMessageStrategy: clientOptions.largeMessageStrategy,
         unstable_streamData: !!clientOptions.unstable_streamData,
         roomHttpClient: httpClient,
         createSyncSource
@@ -9748,21 +9795,30 @@ function traverseCommentBody(body, elementOrVisitor, possiblyVisitor) {
     }
   }
 }
-function getMentionedIdsFromCommentBody(body) {
-  const mentionedIds = /* @__PURE__ */ new Set();
-  traverseCommentBody(
-    body,
-    "mention",
-    (mention) => mentionedIds.add(mention.id)
-  );
-  return Array.from(mentionedIds);
+function getMentionsFromCommentBody(body, predicate) {
+  const mentionIds = /* @__PURE__ */ new Set();
+  const mentions = [];
+  traverseCommentBody(body, "mention", (mention) => {
+    if (
+      // If this mention isn't already in the list
+      !mentionIds.has(mention.id) && // And the provided predicate is true
+      (predicate ? predicate(mention) : true)
+    ) {
+      mentionIds.add(mention.id);
+      mentions.push(mention);
+    }
+  });
+  return mentions;
 }
 async function resolveUsersInCommentBody(body, resolveUsers) {
   const resolvedUsers = /* @__PURE__ */ new Map();
   if (!resolveUsers) {
     return resolvedUsers;
   }
-  const userIds = getMentionedIdsFromCommentBody(body);
+  const userIds = getMentionsFromCommentBody(
+    body,
+    (mention) => mention.kind === "user"
+  ).map((mention) => mention.id);
   const users = await resolveUsers({
     userIds
   });
@@ -10525,11 +10581,8 @@ var TextEditorType = /* @__PURE__ */ ((TextEditorType2) => {
 
 // src/index.ts
 detectDupes(PKG_NAME, PKG_VERSION, PKG_FORMAT);
-var CommentsApiError = HttpError;
-var NotificationsApiError = HttpError;
 export {
   ClientMsgCode,
-  CommentsApiError,
   CrdtType,
   DefaultMap,
   Deque,
@@ -10540,7 +10593,6 @@ export {
   LiveObject,
   LiveblocksError,
   MutableSignal,
-  NotificationsApiError,
   OpCode,
   Permission,
   Promise_withResolvers,
@@ -10574,6 +10626,7 @@ export {
   createManagedPool,
   createNotificationSettings,
   createThreadId,
+  defineAiTool,
   deprecate,
   deprecateIf,
   detectDupes,
@@ -10581,7 +10634,7 @@ export {
   errorIf,
   freeze,
   generateCommentUrl,
-  getMentionedIdsFromCommentBody,
+  getMentionsFromCommentBody,
   getSubscriptionKey,
   html,
   htmlSafe,