@copilotkit/react-core 0.13.0 → 0.15.0-alpha.0

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

@@ -0,0 +1,47 @@
+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

@@ -0,0 +1 @@
+{"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/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.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/utils/utils.d.ts

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

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.d.ts

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

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.13.0",
+  "version": "0.15.0-alpha.0",
   "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -21,15 +21,16 @@
     "jest": "^29.6.4",
     "react": "^18.2.0",
     "ts-jest": "^29.1.1",
-    "tsup": "^6.5.0",
-    "typescript": "^4.9.4",
+    "tsup": "^6.7.0",
+    "typescript": "^5.1.3",
     "eslint-config-custom": "0.2.0",
-    "tsconfig": "0.5.0"
+    "tsconfig": "0.6.0-alpha.0"
   },
   "dependencies": {
-    "ai": "^2.2.12",
+    "ai": "^2.2.23",
     "nanoid": "^4.0.2",
-    "openai": "^4.6.0"
+    "openai": "^4.6.0",
+    "@copilotkit/shared": "0.1.0-alpha.0"
   },
   "scripts": {
     "build": "tsup --treeshake",

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

@@ -0,0 +1,50 @@
+"use client";
+import { ReactNode } from "react";
+import { CopilotApiConfig } from "../../context/copilot-context";
+
+/**
+ * Props for the CopilotProvider when using a chat API endpoint.
+ */
+
+export interface CopilotProviderApiEndpointProps {
+  /**
+   * The endpoint for the chat API.
+   */
+  chatApiEndpoint: string;
+
+  /**
+   * The endpoint for the chat API v2.
+   * If not provided, defaults to chatApiEndpoint + "/v2".
+   * This is used for the chat API v2.
+   * If you are not using the chat API v2, you can ignore this.
+   * @default chatApiEndpoint + "/v2"
+   * @optional
+   */
+  chatApiEndpointV2?: string;
+
+  /**
+   * The children to be rendered within the CopilotProvider.
+   */
+  children: ReactNode;
+}
+/**
+ * Props for the CopilotProvider when using a CopilotApiConfig.
+ */
+
+export interface CopilotProviderApiConfigProps {
+  /**
+   * The configuration for the Copilot API.
+   */
+  chatApiConfig: CopilotApiConfig;
+
+  /**
+   * The children to be rendered within the CopilotProvider.
+   */
+  children: ReactNode;
+}
+/**
+ * Props for the CopilotProvider component.
+ * Can be either CopilotProviderApiEndpointProps or CopilotProviderApiConfigProps.
+ */
+
+export type CopilotProviderProps = CopilotProviderApiEndpointProps | CopilotProviderApiConfigProps;

package/src/components/{copilot-provider.tsx → copilot-provider/copilot-provider.tsx}

@@ -1,27 +1,53 @@
 "use client";
+
 import { FunctionCallHandler } from "ai";
-import { ReactNode, useCallback, useState } from "react";
-import { CopilotContext, CopilotApiConfig } from "../context/copilot-context";
-import useTree from "../hooks/use-tree";
-import { AnnotatedFunction } from "../types/annotated-function";
+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 useFlatCategoryStore from "../hooks/use-flat-category-store";
-
-export function CopilotProvider({
-  chatApiEndpoint,
-  headers,
-  body,
-  children,
-}: {
-  chatApiEndpoint: string;
-  headers?: Record<string, string>;
-  body?: Record<string, any>;
-  children: ReactNode;
-}): JSX.Element {
-  const [entryPoints, setEntryPoints] = useState<
-    Record<string, AnnotatedFunction<any[]>>
-  >({});
+import { DocumentPointer } from "../../types";
+import useFlatCategoryStore from "../../hooks/use-flat-category-store";
+import { StandardCopilotApiConfig } from "./standard-cpilot-api-config";
+import { CopilotProviderProps } from "./copilot-provider-props";
+
+/**
+ * The CopilotProvider component.
+ * This component provides the Copilot context to its children.
+ * It can be configured either with a chat API endpoint or a CopilotApiConfig.
+ *
+ * Example usage:
+ * ```
+ * <CopilotProvider chatApiEndpoint="https://api.copilot.chat">
+ *    <App />
+ * </CopilotProvider>
+ * ```
+ *
+ * or
+ *
+ * ```
+ * const copilotApiConfig = new StandardCopilotApiConfig(
+ *  "https://api.copilot.chat",
+ *  "https://api.copilot.chat/v2",
+ *  {},
+ *  {}
+ *  );
+ *
+ * // ...
+ *
+ * <CopilotProvider chatApiConfig={copilotApiConfig}>
+ *    <App />
+ * </CopilotProvider>
+ * ```
+ *
+ * @param props - The props for the component.
+ * @returns The CopilotProvider component.
+ */
+export function CopilotProvider({ children, ...props }: CopilotProviderProps): JSX.Element {
+  // Compute all the functions and properties that we need to pass
+  // to the CopilotContext.
+
+  const [entryPoints, setEntryPoints] = useState<Record<string, AnnotatedFunction<any[]>>>({});
 
   const { addElement, removeElement, printTree } = useTree();
   const {
@@ -30,17 +56,14 @@ export function CopilotProvider({
     allElements: allDocuments,
   } = useFlatCategoryStore<DocumentPointer>();
 
-  const setEntryPoint = useCallback(
-    (id: string, entryPoint: AnnotatedFunction<any[]>) => {
-      setEntryPoints((prevPoints) => {
-        return {
-          ...prevPoints,
-          [id]: entryPoint,
-        };
-      });
-    },
-    []
-  );
+  const setEntryPoint = useCallback((id: string, entryPoint: AnnotatedFunction<any[]>) => {
+    setEntryPoints((prevPoints) => {
+      return {
+        ...prevPoints,
+        [id]: entryPoint,
+      };
+    });
+  }, []);
 
   const removeEntryPoint = useCallback((id: string) => {
     setEntryPoints((prevPoints) => {
@@ -54,9 +77,7 @@ export function CopilotProvider({
     (documents: DocumentPointer[], categories: string[]) => {
       const documentsString = documents
         .map((document) => {
-          return `${document.name} (${
-            document.sourceApplication
-          }):\n${document.getContents()}`;
+          return `${document.name} (${document.sourceApplication}):\n${document.getContents()}`;
         })
         .join("\n\n");
 
@@ -64,25 +85,25 @@ export function CopilotProvider({
 
       return `${documentsString}\n\n${nonDocumentStrings}`;
     },
-    [printTree]
+    [printTree],
   );
 
   const addContext = useCallback(
     (
       context: string,
       parentId?: string,
-      categories: string[] = defaultCopilotContextCategories
+      categories: string[] = defaultCopilotContextCategories,
     ) => {
       return addElement(context, categories, parentId);
     },
-    [addElement]
+    [addElement],
   );
 
   const removeContext = useCallback(
     (id: string) => {
       removeElement(id);
     },
-    [removeElement]
+    [removeElement],
   );
 
   const getChatCompletionFunctionDescriptions = useCallback(() => {
@@ -97,26 +118,36 @@ export function CopilotProvider({
     (categories: string[]) => {
       return allDocuments(categories);
     },
-    [allDocuments]
+    [allDocuments],
   );
 
   const addDocumentContext = useCallback(
-    (
-      documentPointer: DocumentPointer,
-      categories: string[] = defaultCopilotContextCategories
-    ) => {
+    (documentPointer: DocumentPointer, categories: string[] = defaultCopilotContextCategories) => {
       return addDocument(documentPointer, categories);
     },
-    [addDocument]
+    [addDocument],
   );
 
   const removeDocumentContext = useCallback(
     (documentId: string) => {
       removeDocument(documentId);
     },
-    [removeDocument]
+    [removeDocument],
   );
 
+  // get the appropriate CopilotApiConfig from the props
+  let copilotApiConfig: CopilotApiConfig;
+  if ("chatApiEndpoint" in props) {
+    copilotApiConfig = new StandardCopilotApiConfig(
+      props.chatApiEndpoint,
+      props.chatApiEndpointV2 || `${props.chatApiEndpoint}/v2`,
+      {},
+      {},
+    );
+  } else {
+    copilotApiConfig = props.chatApiConfig;
+  }
+
   return (
     <CopilotContext.Provider
       value={{
@@ -131,11 +162,7 @@ export function CopilotProvider({
         getDocumentsContext,
         addDocumentContext,
         removeDocumentContext,
-        copilotApiConfig: {
-          chatApiEndpoint,
-          headers: headers || {},
-          body: body || {},
-        },
+        copilotApiConfig: copilotApiConfig,
       }}
     >
       {children}
@@ -146,19 +173,15 @@ export function CopilotProvider({
 export const defaultCopilotContextCategories = ["global"];
 
 function entryPointsToFunctionCallHandler(
-  entryPoints: AnnotatedFunction<any[]>[]
+  entryPoints: AnnotatedFunction<any[]>[],
 ): FunctionCallHandler {
   return async (chatMessages, functionCall) => {
-    let entrypointsByFunctionName: Record<
-      string,
-      AnnotatedFunction<any[]>
-    > = {};
+    let entrypointsByFunctionName: Record<string, AnnotatedFunction<any[]>> = {};
     for (let entryPoint of entryPoints) {
       entrypointsByFunctionName[entryPoint.name] = entryPoint;
     }
 
-    const entryPointFunction =
-      entrypointsByFunctionName[functionCall.name || ""];
+    const entryPointFunction = entrypointsByFunctionName[functionCall.name || ""];
     if (entryPointFunction) {
       let parsedFunctionCallArguments: Record<string, any>[] = [];
       if (functionCall.arguments) {
@@ -168,9 +191,7 @@ function entryPointsToFunctionCallHandler(
       const paramsInCorrectOrder: any[] = [];
       for (let arg of entryPointFunction.argumentAnnotations) {
         paramsInCorrectOrder.push(
-          parsedFunctionCallArguments[
-            arg.name as keyof typeof parsedFunctionCallArguments
-          ]
+          parsedFunctionCallArguments[arg.name as keyof typeof parsedFunctionCallArguments],
         );
       }
 
@@ -198,13 +219,13 @@ function entryPointsToFunctionCallHandler(
 }
 
 function entryPointsToChatCompletionFunctions(
-  entryPoints: AnnotatedFunction<any[]>[]
+  entryPoints: AnnotatedFunction<any[]>[],
 ): ChatCompletionCreateParams.Function[] {
   return entryPoints.map(annotatedFunctionToChatCompletionFunction);
 }
 
 function annotatedFunctionToChatCompletionFunction(
-  annotatedFunction: AnnotatedFunction<any[]>
+  annotatedFunction: AnnotatedFunction<any[]>,
 ): ChatCompletionCreateParams.Function {
   // Create the parameters object based on the argumentAnnotations
   let parameters: { [key: string]: any } = {};

package/src/components/copilot-provider/index.ts

@@ -0,0 +1,7 @@
+export { CopilotProvider, defaultCopilotContextCategories } from "./copilot-provider";
+
+export type {
+  CopilotProviderApiEndpointProps,
+  CopilotProviderApiConfigProps,
+  CopilotProviderProps,
+} from "./copilot-provider-props";

package/src/components/copilot-provider/standard-cpilot-api-config.tsx

@@ -0,0 +1,28 @@
+import { CopilotApiConfig } from "../../context/copilot-context";
+
+/**
+ * A standard implementation of the CopilotApiConfig interface.
+ *
+ * Pass in the base URL of the chat API, the headers to be sent with each request, and the body to be sent with each request.
+ * The rest of the CopilotApiConfig interface is implemented by default.
+ *
+ */
+
+export class StandardCopilotApiConfig implements CopilotApiConfig {
+  chatApiEndpoint: string;
+  chatApiEndpointV2: string;
+  headers: Record<string, string>;
+  body: Record<string, any>;
+
+  constructor(
+    chatApiEndpoint: string,
+    chatApiEndpointV2: string,
+    headers: Record<string, string>,
+    body: Record<string, any>,
+  ) {
+    this.chatApiEndpoint = chatApiEndpoint;
+    this.chatApiEndpointV2 = chatApiEndpointV2;
+    this.headers = headers;
+    this.body = body;
+  }
+}

package/src/components/index.ts

@@ -1,4 +1 @@
-export {
-  CopilotProvider,
-  defaultCopilotContextCategories,
-} from "./copilot-provider";
+export * from "./copilot-provider";

package/src/context/copilot-context.tsx

@@ -16,6 +16,11 @@ export interface CopilotApiConfig {
    */
   chatApiEndpoint: string;
 
+  /**
+   * The endpoint for the chat API v2.
+   */
+  chatApiEndpointV2: string;
+
   /**
    * additional headers to be sent with the request
    * @default {}
@@ -46,6 +51,9 @@ export function copilotApiConfigExtrapolator(config: CopilotApiConfig) {
     get chatApiEndpoint(): string {
       return `${config.chatApiEndpoint}`;
     },
+    get chatApiEndpointV2(): string {
+      return `${config.chatApiEndpointV2}`;
+    },
   };
 }
 
@@ -58,23 +66,13 @@ export interface CopilotContextParams {
   getFunctionCallHandler: () => FunctionCallHandler;
 
   // text context
-  getContextString: (
-    documents: DocumentPointer[],
-    categories: string[]
-  ) => string;
-  addContext: (
-    context: string,
-    parentId?: string,
-    categories?: string[]
-  ) => TreeNodeId;
+  getContextString: (documents: DocumentPointer[], categories: string[]) => string;
+  addContext: (context: string, parentId?: string, categories?: string[]) => TreeNodeId;
   removeContext: (id: TreeNodeId) => void;
 
   // document context
   getDocumentsContext: (categories: string[]) => DocumentPointer[];
-  addDocumentContext: (
-    documentPointer: DocumentPointer,
-    categories?: string[]
-  ) => TreeNodeId;
+  addDocumentContext: (documentPointer: DocumentPointer, categories?: string[]) => TreeNodeId;
   removeDocumentContext: (documentId: string) => void;
 
   // api endpoints
@@ -100,7 +98,12 @@ const emptyCopilotContext: CopilotContextParams = {
   copilotApiConfig: new (class implements CopilotApiConfig {
     get chatApiEndpoint(): string {
       throw new Error(
-        "Remember to wrap your app in a `<CopilotProvider> {...} </CopilotProvider>` !!!"
+        "Remember to wrap your app in a `<CopilotProvider> {...} </CopilotProvider>` !!!",
+      );
+    }
+    get chatApiEndpointV2(): string {
+      throw new Error(
+        "Remember to wrap your app in a `<CopilotProvider> {...} </CopilotProvider>` !!!",
       );
     }
     get headers(): Record<string, string> {
@@ -112,12 +115,11 @@ const emptyCopilotContext: CopilotContextParams = {
   })(),
 };
 
-export const CopilotContext =
-  React.createContext<CopilotContextParams>(emptyCopilotContext);
+export const CopilotContext = React.createContext<CopilotContextParams>(emptyCopilotContext);
 
 function returnAndThrowInDebug<T>(value: T): T {
   throw new Error(
-    "Remember to wrap your app in a `<CopilotProvider> {...} </CopilotProvider>` !!!"
+    "Remember to wrap your app in a `<CopilotProvider> {...} </CopilotProvider>` !!!",
   );
   return value;
 }

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

@@ -17,11 +17,9 @@ export interface UseCopilotChatReturn {
   visibleMessages: Message[];
   append: (
     message: Message | CreateMessage,
-    chatRequestOptions?: ChatRequestOptions
-  ) => Promise<string | null | undefined>;
-  reload: (
-    chatRequestOptions?: ChatRequestOptions
+    chatRequestOptions?: ChatRequestOptions,
   ) => Promise<string | null | undefined>;
+  reload: (chatRequestOptions?: ChatRequestOptions) => Promise<string | null | undefined>;
   stop: () => void;
   isLoading: boolean;
   input: string;
@@ -50,32 +48,29 @@ export function useCopilotChat({
     };
   }, [getContextString, makeSystemMessage]);
 
-  const initialMessagesWithContext = [systemMessage].concat(
-    options.initialMessages || []
-  );
+  const initialMessagesWithContext = [systemMessage].concat(options.initialMessages || []);
 
   const functionDescriptions = useMemo(() => {
     return getChatCompletionFunctionDescriptions();
   }, [getChatCompletionFunctionDescriptions]);
 
-  const { messages, append, reload, stop, isLoading, input, setInput } =
-    useChat({
-      ...options,
-      api: copilotApiConfigExtrapolator(copilotApiConfig).chatApiEndpoint,
+  const { messages, append, reload, stop, isLoading, input, setInput } = useChat({
+    ...options,
+    api: copilotApiConfigExtrapolator(copilotApiConfig).chatApiEndpoint,
+    id: options.id,
+    initialMessages: initialMessagesWithContext,
+    experimental_onFunctionCall: getFunctionCallHandler(),
+    headers: { ...copilotApiConfig.headers, ...options.headers },
+    body: {
       id: options.id,
-      initialMessages: initialMessagesWithContext,
-      experimental_onFunctionCall: getFunctionCallHandler(),
-      headers: { ...copilotApiConfig.headers, ...options.headers },
-      body: {
-        id: options.id,
-        functions: functionDescriptions,
-        ...copilotApiConfig.body,
-        ...options.body,
-      },
-    });
+      functions: functionDescriptions,
+      ...copilotApiConfig.body,
+      ...options.body,
+    },
+  });
 
   const visibleMessages = messages.filter(
-    (message) => message.role === "user" || message.role === "assistant"
+    (message) => message.role === "user" || message.role === "assistant",
   );
 
   return {