@copilotkit/react-core 0.16.0 → 0.17.0-alpha.0

package/dist/openai-assistants/utils/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":""}
+{"version":3,"sources":["../../../src/openai-assistants/utils/process-message-stream.ts"],"sourcesContent":["export async function processMessageStream(\n  reader: ReadableStreamDefaultReader<Uint8Array>,\n  processMessage: (message: string) => void | Promise<void>,\n) {\n  const decoder = new TextDecoder();\n  let buffer = \"\";\n  while (true) {\n    const { done, value } = await reader.read();\n\n    if (done) {\n      if (buffer.length > 0) {\n        processMessage(buffer);\n      }\n      break;\n    }\n\n    buffer += decoder.decode(value, { stream: true });\n\n    let endIndex: number;\n    while ((endIndex = buffer.indexOf(\"\\n\")) !== -1) {\n      processMessage(buffer.substring(0, endIndex).trim());\n      buffer = buffer.substring(endIndex + 1); // Remove the processed instruction + delimiter\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,SAAsB,qBACpB,QACA,gBACA;AAAA;AACA,UAAM,UAAU,IAAI,YAAY;AAChC,QAAI,SAAS;AACb,WAAO,MAAM;AACX,YAAM,EAAE,MAAM,MAAM,IAAI,MAAM,OAAO,KAAK;AAE1C,UAAI,MAAM;AACR,YAAI,OAAO,SAAS,GAAG;AACrB,yBAAe,MAAM;AAAA,QACvB;AACA;AAAA,MACF;AAEA,gBAAU,QAAQ,OAAO,OAAO,EAAE,QAAQ,KAAK,CAAC;AAEhD,UAAI;AACJ,cAAQ,WAAW,OAAO,QAAQ,IAAI,OAAO,IAAI;AAC/C,uBAAe,OAAO,UAAU,GAAG,QAAQ,EAAE,KAAK,CAAC;AACnD,iBAAS,OAAO,UAAU,WAAW,CAAC;AAAA,MACxC;AAAA,IACF;AAAA,EACF;AAAA;","names":[]}

package/dist/openai-assistants/utils/process-message-stream.mjs

@@ -1,4 +1,47 @@
-export { processMessageStream } from '../../chunk-MZ5UN3BY.mjs';
-import '../../chunk-MRXNTQOX.mjs';
-//# sourceMappingURL=out.js.map
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/openai-assistants/utils/process-message-stream.ts
+function processMessageStream(reader, processMessage) {
+  return __async(this, null, function* () {
+    const decoder = new TextDecoder();
+    let buffer = "";
+    while (true) {
+      const { done, value } = yield reader.read();
+      if (done) {
+        if (buffer.length > 0) {
+          processMessage(buffer);
+        }
+        break;
+      }
+      buffer += decoder.decode(value, { stream: true });
+      let endIndex;
+      while ((endIndex = buffer.indexOf("\n")) !== -1) {
+        processMessage(buffer.substring(0, endIndex).trim());
+        buffer = buffer.substring(endIndex + 1);
+      }
+    }
+  });
+}
+export {
+  processMessageStream
+};
 //# sourceMappingURL=process-message-stream.mjs.map

package/dist/openai-assistants/utils/process-message-stream.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":""}
+{"version":3,"sources":["../../../src/openai-assistants/utils/process-message-stream.ts"],"sourcesContent":["export async function processMessageStream(\n  reader: ReadableStreamDefaultReader<Uint8Array>,\n  processMessage: (message: string) => void | Promise<void>,\n) {\n  const decoder = new TextDecoder();\n  let buffer = \"\";\n  while (true) {\n    const { done, value } = await reader.read();\n\n    if (done) {\n      if (buffer.length > 0) {\n        processMessage(buffer);\n      }\n      break;\n    }\n\n    buffer += decoder.decode(value, { stream: true });\n\n    let endIndex: number;\n    while ((endIndex = buffer.indexOf(\"\\n\")) !== -1) {\n      processMessage(buffer.substring(0, endIndex).trim());\n      buffer = buffer.substring(endIndex + 1); // Remove the processed instruction + delimiter\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,SAAsB,qBACpB,QACA,gBACA;AAAA;AACA,UAAM,UAAU,IAAI,YAAY;AAChC,QAAI,SAAS;AACb,WAAO,MAAM;AACX,YAAM,EAAE,MAAM,MAAM,IAAI,MAAM,OAAO,KAAK;AAE1C,UAAI,MAAM;AACR,YAAI,OAAO,SAAS,GAAG;AACrB,yBAAe,MAAM;AAAA,QACvB;AACA;AAAA,MACF;AAEA,gBAAU,QAAQ,OAAO,OAAO,EAAE,QAAQ,KAAK,CAAC;AAEhD,UAAI;AACJ,cAAQ,WAAW,OAAO,QAAQ,IAAI,OAAO,IAAI;AAC/C,uBAAe,OAAO,UAAU,GAAG,QAAQ,EAAE,KAAK,CAAC;AACnD,iBAAS,OAAO,UAAU,WAAW,CAAC;AAAA,MACxC;AAAA,IACF;AAAA,EACF;AAAA;","names":[]}

package/dist/types/annotated-function.mjs

@@ -1,3 +1 @@
-
-//# sourceMappingURL=out.js.map
 //# sourceMappingURL=annotated-function.mjs.map

package/dist/types/annotated-function.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":""}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/base.d.ts

@@ -0,0 +1,56 @@
+type Role = "system" | "user" | "assistant" | "function";
+interface Message {
+    id: string;
+    createdAt?: Date;
+    content: string;
+    role: Role;
+    /**
+     * If the message has a role of `function`, the `name` field is the name of the function.
+     * Otherwise, the name field should not be set.
+     */
+    name?: string;
+    /**
+     * If the assistant role makes a function call, the `function_call` field
+     * contains the function call name and arguments. Otherwise, the field should
+     * not be set.
+     */
+    function_call?: FunctionCall;
+}
+interface FunctionCall {
+    /**
+     * The arguments to call the function with, as generated by the model in JSON
+     * format. Note that the model does not always generate valid JSON, and may
+     * hallucinate parameters not defined by your function schema. Validate the
+     * arguments in your code before calling your function.
+     */
+    arguments?: string;
+    /**
+     * The name of the function to call.
+     */
+    name?: string;
+}
+interface Function {
+    /**
+     * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain
+     * underscores and dashes, with a maximum length of 64.
+     */
+    name: string;
+    /**
+     * The parameters the functions accepts, described as a JSON Schema object. See the
+     * [guide](/docs/guides/gpt/function-calling) for examples, and the
+     * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
+     * documentation about the format.
+     *
+     * To describe a function that accepts no parameters, provide the value
+     * `{"type": "object", "properties": {}}`.
+     */
+    parameters: Record<string, unknown>;
+    /**
+     * A description of what the function does, used by the model to choose when and
+     * how to call the function.
+     */
+    description?: string;
+}
+type FunctionCallHandler = (chatMessages: Message[], functionCall: FunctionCall) => Promise<void>;
+
+export { Function, FunctionCall, FunctionCallHandler, Message, Role };

package/dist/types/base.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=base.mjs.map

package/dist/types/base.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/document-pointer.mjs

@@ -1,3 +1 @@
-
-//# sourceMappingURL=out.js.map
 //# sourceMappingURL=document-pointer.mjs.map

package/dist/types/document-pointer.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":""}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export { AnnotatedFunction, AnnotatedFunctionArgument } from './annotated-function.js';
 export { DocumentPointer } from './document-pointer.js';
+export { Function, FunctionCall, FunctionCallHandler, Message, Role } from './base.js';

package/dist/types/index.mjs

@@ -1,3 +1 @@
-import '../chunk-EFZPSZWO.mjs';
-//# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.mjs.map

package/dist/types/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":""}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types/message.d.ts

@@ -0,0 +1,2 @@
+
+export { }

package/dist/types/message.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=message.mjs.map

package/dist/types/message.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/utils/utils.mjs

@@ -1,3 +1 @@
-
-//# sourceMappingURL=out.js.map
 //# sourceMappingURL=utils.mjs.map

package/dist/utils/utils.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":[],"names":[],"mappings":""}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/utils/utils.test.mjs

@@ -4,5 +4,4 @@ describe("emptyTest", () => {
     expect(true).toBeTruthy();
   });
 });
-//# sourceMappingURL=out.js.map
 //# sourceMappingURL=utils.test.mjs.map

package/dist/utils/utils.test.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/utils.test.ts"],"names":[],"mappings":";AAEA,SAAS,aAAa,MAAM;AAC1B,KAAG,oBAAoB,MAAM;AAC3B,WAAO,IAAI,EAAE,WAAW;AAAA,EAC1B,CAAC;AACH,CAAC","sourcesContent":["import * as utils from \"./utils\";\n\ndescribe(\"emptyTest\", () => {\n  it(\"should be truthy\", () => {\n    expect(true).toBeTruthy();\n  });\n});\n"]}
+{"version":3,"sources":["../../src/utils/utils.test.ts"],"sourcesContent":["import * as utils from \"./utils\";\n\ndescribe(\"emptyTest\", () => {\n  it(\"should be truthy\", () => {\n    expect(true).toBeTruthy();\n  });\n});\n"],"mappings":";AAEA,SAAS,aAAa,MAAM;AAC1B,KAAG,oBAAoB,MAAM;AAC3B,WAAO,IAAI,EAAE,WAAW;AAAA,EAC1B,CAAC;AACH,CAAC;","names":[]}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.16.0",
+  "version": "0.17.0-alpha.0",
   "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -23,11 +23,11 @@
     "ts-jest": "^29.1.1",
     "tsup": "^6.7.0",
     "typescript": "^5.1.3",
-    "eslint-config-custom": "0.2.0",
-    "tsconfig": "0.6.0"
+    "tsconfig": "0.6.0",
+    "eslint-config-custom": "0.2.0"
   },
   "dependencies": {
-    "ai": "^2.2.23",
+    "eventemitter3": "^5.0.1",
     "nanoid": "^4.0.2",
     "openai": "^4.6.0",
     "@copilotkit/shared": "0.1.0"

package/src/components/copilot-provider/copilot-provider.tsx

@@ -1,12 +1,11 @@
 "use client";
 
-import { FunctionCallHandler } from "ai";
 import { useCallback, useState } from "react";
 import { CopilotContext, CopilotApiConfig } from "../../context/copilot-context";
 import useTree from "../../hooks/use-tree";
 import { AnnotatedFunction } from "../../types/annotated-function";
 import { ChatCompletionCreateParams } from "openai/resources/chat";
-import { DocumentPointer } from "../../types";
+import { DocumentPointer, FunctionCallHandler } from "../../types";
 import useFlatCategoryStore from "../../hooks/use-flat-category-store";
 import { StandardCopilotApiConfig } from "./standard-copilot-api-config";
 import { CopilotProviderProps } from "./copilot-provider-props";
@@ -189,15 +188,15 @@ function entryPointsToFunctionCallHandler(
 
     const entryPointFunction = entrypointsByFunctionName[functionCall.name || ""];
     if (entryPointFunction) {
-      let parsedFunctionCallArguments: Record<string, any>[] = [];
+      let functionCallArguments: Record<string, any>[] = [];
       if (functionCall.arguments) {
-        parsedFunctionCallArguments = JSON.parse(functionCall.arguments);
+        functionCallArguments = JSON.parse(functionCall.arguments);
       }
 
       const paramsInCorrectOrder: any[] = [];
       for (let arg of entryPointFunction.argumentAnnotations) {
         paramsInCorrectOrder.push(
-          parsedFunctionCallArguments[arg.name as keyof typeof parsedFunctionCallArguments],
+          functionCallArguments[arg.name as keyof typeof functionCallArguments],
         );
       }
 

package/src/context/copilot-context.tsx

@@ -1,6 +1,6 @@
 "use client";
 
-import { FunctionCallHandler } from "ai";
+import { FunctionCallHandler } from "../types";
 import React from "react";
 import { TreeNodeId } from "../hooks/use-tree";
 import { AnnotatedFunction } from "../types/annotated-function";
@@ -46,17 +46,6 @@ export interface CopilotApiConfig {
   body: Record<string, any>;
 }
 
-export function copilotApiConfigExtrapolator(config: CopilotApiConfig) {
-  return {
-    get chatApiEndpoint(): string {
-      return `${config.chatApiEndpoint}`;
-    },
-    get chatApiEndpointV2(): string {
-      return `${config.chatApiEndpointV2}`;
-    },
-  };
-}
-
 export interface CopilotContextParams {
   // function-calling
   entryPoints: Record<string, AnnotatedFunction<any[]>>;

package/src/context/index.ts

@@ -1,4 +1,3 @@
 export { CopilotContext } from "./copilot-context";
 export type { CopilotContextParams } from "./copilot-context";
 export type { CopilotApiConfig } from "./copilot-context";
-export { copilotApiConfigExtrapolator } from "./copilot-context";

package/src/hooks/index.ts

@@ -5,3 +5,4 @@ export type { UseCopilotChatReturn } from "./use-copilot-chat";
 export { useMakeCopilotActionable } from "./use-make-copilot-actionable";
 export { useMakeCopilotReadable } from "./use-make-copilot-readable";
 export { useMakeCopilotDocumentReadable } from "./use-make-copilot-document-readable";
+export { type UseChatHelpers } from "./use-chat";

package/src/hooks/use-chat.ts

@@ -0,0 +1,197 @@
+import { useState } from "react";
+import { Message, Function, FunctionCallHandler } from "../types";
+import { nanoid } from "nanoid";
+import { ChatCompletionClient } from "../openai/chat-completion-client";
+import { CopilotApiConfig } from "../context";
+
+export type UseChatOptions = {
+  /**
+   * The API endpoint that accepts a `{ messages: Message[] }` object and returns
+   * a stream of tokens of the AI chat response. Defaults to `/api/chat`.
+   */
+  api?: string;
+  /**
+   * A unique identifier for the chat. If not provided, a random one will be
+   * generated. When provided, the `useChat` hook with the same `id` will
+   * have shared states across components.
+   */
+  id?: string;
+  /**
+   * System messages of the chat. Defaults to an empty array.
+   */
+  initialMessages?: Message[];
+  /**
+   * Callback function to be called when a function call is received.
+   * If the function returns a `ChatRequest` object, the request will be sent
+   * automatically to the API and will be used to update the chat.
+   */
+  onFunctionCall?: FunctionCallHandler;
+  /**
+   * HTTP headers to be sent with the API request.
+   */
+  headers?: Record<string, string> | Headers;
+  /**
+   * Extra body object to be sent with the API request.
+   * @example
+   * Send a `sessionId` to the API along with the messages.
+   * ```js
+   * useChat({
+   *   body: {
+   *     sessionId: '123',
+   *   }
+   * })
+   * ```
+   */
+  body?: object;
+  /**
+   * Function definitions to be sent to the API.
+   */
+  functions?: Function[];
+};
+
+export type UseChatHelpers = {
+  /** Current messages in the chat */
+  messages: Message[];
+  /**
+   * Append a user message to the chat list. This triggers the API call to fetch
+   * the assistant's response.
+   * @param message The message to append
+   */
+  append: (message: Message) => Promise<void>;
+  /**
+   * Reload the last AI chat response for the given chat history. If the last
+   * message isn't from the assistant, it will request the API to generate a
+   * new response.
+   */
+  reload: () => Promise<void>;
+  /**
+   * Abort the current request immediately, keep the generated tokens if any.
+   */
+  stop: () => void;
+  /** The current value of the input */
+  input: string;
+  /** setState-powered method to update the input value */
+  setInput: React.Dispatch<React.SetStateAction<string>>;
+  /** Whether the API request is in progress */
+  isLoading: boolean;
+};
+
+export type UseChatOptionsWithCopilotConfig = UseChatOptions & {
+  copilotConfig: CopilotApiConfig;
+};
+
+export function useChat(options: UseChatOptionsWithCopilotConfig): UseChatHelpers {
+  const [messages, setMessages] = useState<Message[]>([]);
+  const [input, setInput] = useState("");
+  const [isLoading, setIsLoading] = useState(false);
+
+  const runChatCompletion = async (messages: Message[]): Promise<Message> => {
+    return new Promise<Message>((resolve, reject) => {
+      setIsLoading(true);
+
+      const assistantMessage: Message = {
+        id: nanoid(),
+        createdAt: new Date(),
+        content: "",
+        role: "assistant",
+      };
+
+      // Assistant messages are always copied when using setState
+      setMessages([...messages, { ...assistantMessage }]);
+
+      const messagesWithContext = [...(options.initialMessages || []), ...messages];
+
+      const client = new ChatCompletionClient({
+        url: options.api || "/api/copilotkit/openai",
+      });
+
+      const cleanup = () => {
+        client.off("content");
+        client.off("end");
+        client.off("error");
+        client.off("function");
+      };
+
+      client.on("content", (content) => {
+        assistantMessage.content += content;
+        setMessages([...messages, { ...assistantMessage }]);
+      });
+
+      client.on("end", () => {
+        setIsLoading(false);
+        cleanup();
+        resolve({ ...assistantMessage });
+      });
+
+      client.on("error", (error) => {
+        setIsLoading(false);
+        cleanup();
+        reject(error);
+      });
+
+      client.on("function", async (functionCall) => {
+        assistantMessage.function_call = {
+          name: functionCall.name,
+          arguments: JSON.stringify(functionCall.arguments),
+        };
+        setMessages([...messages, { ...assistantMessage }]);
+        // quit early if we get a function call
+        setIsLoading(false);
+        cleanup();
+        resolve({ ...assistantMessage });
+      });
+
+      client.fetch({
+        messages: messagesWithContext,
+        functions: options.functions,
+        headers: options.headers,
+        copilotConfig: options.copilotConfig,
+      });
+    });
+  };
+
+  const runChatCompletionAndHandleFunctionCall = async (messages: Message[]): Promise<void> => {
+    const message = await runChatCompletion(messages);
+    if (message.function_call && options.onFunctionCall) {
+      await options.onFunctionCall(messages, message.function_call);
+    }
+  };
+
+  const append = async (message: Message): Promise<void> => {
+    if (isLoading) {
+      return;
+    }
+    const newMessages = [...messages, message];
+    setMessages(newMessages);
+    return runChatCompletionAndHandleFunctionCall(newMessages);
+  };
+
+  const reload = async (): Promise<void> => {
+    if (isLoading || messages.length === 0) {
+      return;
+    }
+    let newMessages = [...messages];
+    const lastMessage = messages[messages.length - 1];
+
+    if (lastMessage.role === "assistant") {
+      newMessages = newMessages.slice(0, -1);
+    }
+    setMessages(newMessages);
+
+    return runChatCompletionAndHandleFunctionCall(newMessages);
+  };
+
+  const stop = (): void => {
+    throw new Error("Not implemented");
+  };
+
+  return {
+    messages,
+    append,
+    reload,
+    stop,
+    isLoading,
+    input,
+    setInput,
+  };
+}

package/src/hooks/use-copilot-chat.ts

@@ -1,12 +1,7 @@
 import { useMemo, useContext } from "react";
-import {
-  CopilotContext,
-  CopilotContextParams,
-  copilotApiConfigExtrapolator,
-} from "../context/copilot-context";
-import { useChat } from "ai/react";
-import { ChatRequestOptions, CreateMessage, Message } from "ai";
-import { UseChatOptions } from "ai";
+import { CopilotContext, CopilotContextParams } from "../context/copilot-context";
+import { Message } from "../types";
+import { UseChatOptions, useChat } from "./use-chat";
 import { defaultCopilotContextCategories } from "../components";
 import { ChatCompletionCreateParams } from "openai/resources/chat";
 
@@ -16,11 +11,8 @@ export interface UseCopilotChatOptions extends UseChatOptions {
 
 export interface UseCopilotChatReturn {
   visibleMessages: Message[];
-  append: (
-    message: Message | CreateMessage,
-    chatRequestOptions?: ChatRequestOptions,
-  ) => Promise<string | null | undefined>;
-  reload: (chatRequestOptions?: ChatRequestOptions) => Promise<string | null | undefined>;
+  append: (message: Message) => Promise<void>;
+  reload: () => Promise<void>;
   stop: () => void;
   isLoading: boolean;
   input: string;
@@ -49,23 +41,19 @@ export function useCopilotChat({
     };
   }, [getContextString, makeSystemMessage]);
 
-  const initialMessagesWithContext = [systemMessage].concat(options.initialMessages || []);
-
   const functionDescriptions: ChatCompletionCreateParams.Function[] = useMemo(() => {
     return getChatCompletionFunctionDescriptions();
   }, [getChatCompletionFunctionDescriptions]);
 
   const { messages, append, reload, stop, isLoading, input, setInput } = useChat({
     ...options,
-    api: copilotApiConfigExtrapolator(copilotApiConfig).chatApiEndpoint,
+    copilotConfig: copilotApiConfig,
     id: options.id,
-    initialMessages: initialMessagesWithContext,
-    experimental_onFunctionCall: getFunctionCallHandler(),
-    headers: { ...copilotApiConfig.headers, ...options.headers },
+    initialMessages: [systemMessage].concat(options.initialMessages || []),
+    functions: functionDescriptions,
+    onFunctionCall: getFunctionCallHandler(),
+    headers: { ...options.headers },
     body: {
-      id: options.id,
-      ...(functionDescriptions.length > 0 && { functions: functionDescriptions }),
-      ...copilotApiConfig.body,
       ...options.body,
     },
   });

package/src/index.tsx

@@ -3,3 +3,4 @@ export * from "./context";
 export * from "./hooks";
 export * from "./types";
 export * from "./openai-assistants";
+export * from "./openai";