@copilotkit/react-core 0.19.0 → 0.20.0-alpha.3

package/dist/hooks/use-make-copilot-actionable.mjs

@@ -1,8 +1,8 @@
 "use client";
 import {
   useMakeCopilotActionable
-} from "../chunk-DGUVNY3V.mjs";
-import "../chunk-4CFJ6A6A.mjs";
+} from "../chunk-K2LVBFRY.mjs";
+import "../chunk-4OWTRVNI.mjs";
 import "../chunk-MRXNTQOX.mjs";
 export {
   useMakeCopilotActionable

package/dist/hooks/use-make-copilot-document-readable.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/hooks/use-make-copilot-document-readable.ts","../../src/context/copilot-context.tsx"],"sourcesContent":["\"use client\";\n\nimport { useContext, useEffect, useRef } from \"react\";\nimport { CopilotContext } from \"../context/copilot-context\";\nimport { DocumentPointer } from \"../types\";\n\n/**\n * Makes a document readable by Copilot.\n * @param document The document to make readable.\n * @param categories The categories to associate with the document.\n * @param dependencies The dependencies to use for the effect.\n * @returns The id of the document.\n */\nexport function useMakeCopilotDocumentReadable(\n  document: DocumentPointer,\n  categories?: string[],\n  dependencies: any[] = [],\n): string | undefined {\n  const { addDocumentContext, removeDocumentContext } = useContext(CopilotContext);\n  const idRef = useRef<string>();\n\n  useEffect(() => {\n    const id = addDocumentContext(document, categories);\n    idRef.current = id;\n\n    return () => {\n      removeDocumentContext(id);\n    };\n  }, [addDocumentContext, removeDocumentContext, ...dependencies]);\n\n  return idRef.current;\n}\n","\"use client\";\n\nimport { FunctionCallHandler, AnnotatedFunction, Function } from \"@copilotkit/shared\";\nimport React from \"react\";\nimport { TreeNodeId } from \"../hooks/use-tree\";\nimport { DocumentPointer } from \"../types\";\n\n/**\n * Interface for the configuration of the Copilot API.\n */\nexport interface CopilotApiConfig {\n  /**\n   * The endpoint for the chat API.\n   */\n  chatApiEndpoint: string;\n\n  /**\n   * The endpoint for the chat API v2.\n   */\n  chatApiEndpointV2: string;\n\n  /**\n   * additional headers to be sent with the request\n   * @default {}\n   * @example\n   * ```\n   * {\n   *   'Authorization': 'Bearer your_token_here'\n   * }\n   * ```\n   */\n  headers: Record<string, string>;\n\n  /**\n   * Additional body params to be sent with the request\n   * @default {}\n   * @example\n   * ```\n   * {\n   *   'message': 'Hello, world!'\n   * }\n   * ```\n   */\n  body: Record<string, any>;\n}\n\nexport interface CopilotContextParams {\n  // function-calling\n  entryPoints: Record<string, AnnotatedFunction<any[]>>;\n  setEntryPoint: (id: string, entryPoint: AnnotatedFunction<any[]>) => void;\n  removeEntryPoint: (id: string) => void;\n  getChatCompletionFunctionDescriptions: () => Function[];\n  getFunctionCallHandler: () => FunctionCallHandler;\n\n  // text context\n  addContext: (context: string, parentId?: string, categories?: string[]) => TreeNodeId;\n  removeContext: (id: TreeNodeId) => void;\n  getContextString: (documents: DocumentPointer[], categories: string[]) => string;\n\n  // document context\n  addDocumentContext: (documentPointer: DocumentPointer, categories?: string[]) => TreeNodeId;\n  removeDocumentContext: (documentId: string) => void;\n  getDocumentsContext: (categories: string[]) => DocumentPointer[];\n\n  // api endpoints\n  copilotApiConfig: CopilotApiConfig;\n}\n\nconst emptyCopilotContext: CopilotContextParams = {\n  entryPoints: {},\n  setEntryPoint: () => {},\n  removeEntryPoint: () => {},\n  getChatCompletionFunctionDescriptions: () => returnAndThrowInDebug([]),\n  getFunctionCallHandler: () => returnAndThrowInDebug(async () => {}),\n\n  getContextString: (documents: DocumentPointer[], categories: string[]) =>\n    returnAndThrowInDebug(\"\"),\n  addContext: () => \"\",\n  removeContext: () => {},\n\n  getDocumentsContext: (categories: string[]) => returnAndThrowInDebug([]),\n  addDocumentContext: () => returnAndThrowInDebug(\"\"),\n  removeDocumentContext: () => {},\n\n  copilotApiConfig: new (class implements CopilotApiConfig {\n    get chatApiEndpoint(): string {\n      throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n    }\n    get chatApiEndpointV2(): string {\n      throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n    }\n    get headers(): Record<string, string> {\n      return {};\n    }\n    get body(): Record<string, any> {\n      return {};\n    }\n  })(),\n};\n\nexport const CopilotContext = React.createContext<CopilotContextParams>(emptyCopilotContext);\n\nfunction returnAndThrowInDebug<T>(value: T): T {\n  throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n  return value;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,IAAAA,gBAA8C;;;ACC9C,mBAAkB;AAiElB,IAAM,sBAA4C;AAAA,EAChD,aAAa,CAAC;AAAA,EACd,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,kBAAkB,MAAM;AAAA,EAAC;AAAA,EACzB,uCAAuC,MAAM,sBAAsB,CAAC,CAAC;AAAA,EACrE,wBAAwB,MAAM,sBAAsB,MAAY;AAAA,EAAC,EAAC;AAAA,EAElE,kBAAkB,CAAC,WAA8B,eAC/C,sBAAsB,EAAE;AAAA,EAC1B,YAAY,MAAM;AAAA,EAClB,eAAe,MAAM;AAAA,EAAC;AAAA,EAEtB,qBAAqB,CAAC,eAAyB,sBAAsB,CAAC,CAAC;AAAA,EACvE,oBAAoB,MAAM,sBAAsB,EAAE;AAAA,EAClD,uBAAuB,MAAM;AAAA,EAAC;AAAA,EAE9B,kBAAkB,IAAK,MAAkC;AAAA,IACvD,IAAI,kBAA0B;AAC5B,YAAM,IAAI,MAAM,uEAAuE;AAAA,IACzF;AAAA,IACA,IAAI,oBAA4B;AAC9B,YAAM,IAAI,MAAM,uEAAuE;AAAA,IACzF;AAAA,IACA,IAAI,UAAkC;AACpC,aAAO,CAAC;AAAA,IACV;AAAA,IACA,IAAI,OAA4B;AAC9B,aAAO,CAAC;AAAA,IACV;AAAA,EACF,EAAG;AACL;AAEO,IAAM,iBAAiB,aAAAC,QAAM,cAAoC,mBAAmB;AAE3F,SAAS,sBAAyB,OAAa;AAC7C,QAAM,IAAI,MAAM,uEAAuE;AACvF,SAAO;AACT;;;AD5FO,SAAS,+BACd,UACA,YACA,eAAsB,CAAC,GACH;AACpB,QAAM,EAAE,oBAAoB,sBAAsB,QAAI,0BAAW,cAAc;AAC/E,QAAM,YAAQ,sBAAe;AAE7B,+BAAU,MAAM;AACd,UAAM,KAAK,mBAAmB,UAAU,UAAU;AAClD,UAAM,UAAU;AAEhB,WAAO,MAAM;AACX,4BAAsB,EAAE;AAAA,IAC1B;AAAA,EACF,GAAG,CAAC,oBAAoB,uBAAuB,GAAG,YAAY,CAAC;AAE/D,SAAO,MAAM;AACf;","names":["import_react","React"]}
+{"version":3,"sources":["../../src/hooks/use-make-copilot-document-readable.ts","../../src/context/copilot-context.tsx"],"sourcesContent":["\"use client\";\n\nimport { useContext, useEffect, useRef } from \"react\";\nimport { CopilotContext } from \"../context/copilot-context\";\nimport { DocumentPointer } from \"../types\";\n\n/**\n * Makes a document readable by Copilot.\n * @param document The document to make readable.\n * @param categories The categories to associate with the document.\n * @param dependencies The dependencies to use for the effect.\n * @returns The id of the document.\n */\nexport function useMakeCopilotDocumentReadable(\n  document: DocumentPointer,\n  categories?: string[],\n  dependencies: any[] = [],\n): string | undefined {\n  const { addDocumentContext, removeDocumentContext } = useContext(CopilotContext);\n  const idRef = useRef<string>();\n\n  useEffect(() => {\n    const id = addDocumentContext(document, categories);\n    idRef.current = id;\n\n    return () => {\n      removeDocumentContext(id);\n    };\n  }, [addDocumentContext, removeDocumentContext, ...dependencies]);\n\n  return idRef.current;\n}\n","\"use client\";\n\nimport { FunctionCallHandler, AnnotatedFunction, ToolDefinition } from \"@copilotkit/shared\";\nimport React from \"react\";\nimport { TreeNodeId } from \"../hooks/use-tree\";\nimport { DocumentPointer } from \"../types\";\n\n/**\n * Interface for the configuration of the Copilot API.\n */\nexport interface CopilotApiConfig {\n  /**\n   * The endpoint for the chat API.\n   */\n  chatApiEndpoint: string;\n\n  /**\n   * The endpoint for the chat API v2.\n   */\n  chatApiEndpointV2: string;\n\n  /**\n   * additional headers to be sent with the request\n   * @default {}\n   * @example\n   * ```\n   * {\n   *   'Authorization': 'Bearer your_token_here'\n   * }\n   * ```\n   */\n  headers: Record<string, string>;\n\n  /**\n   * Additional body params to be sent with the request\n   * @default {}\n   * @example\n   * ```\n   * {\n   *   'message': 'Hello, world!'\n   * }\n   * ```\n   */\n  body: Record<string, any>;\n}\n\nexport interface CopilotContextParams {\n  // function-calling\n  entryPoints: Record<string, AnnotatedFunction<any[]>>;\n  setEntryPoint: (id: string, entryPoint: AnnotatedFunction<any[]>) => void;\n  removeEntryPoint: (id: string) => void;\n  getChatCompletionFunctionDescriptions: (\n    customEntryPoints?: Record<string, AnnotatedFunction<any[]>>,\n  ) => ToolDefinition[];\n  getFunctionCallHandler: (\n    customEntryPoints?: Record<string, AnnotatedFunction<any[]>>,\n  ) => FunctionCallHandler;\n\n  // text context\n  addContext: (context: string, parentId?: string, categories?: string[]) => TreeNodeId;\n  removeContext: (id: TreeNodeId) => void;\n  getContextString: (documents: DocumentPointer[], categories: string[]) => string;\n\n  // document context\n  addDocumentContext: (documentPointer: DocumentPointer, categories?: string[]) => TreeNodeId;\n  removeDocumentContext: (documentId: string) => void;\n  getDocumentsContext: (categories: string[]) => DocumentPointer[];\n\n  // api endpoints\n  copilotApiConfig: CopilotApiConfig;\n}\n\nconst emptyCopilotContext: CopilotContextParams = {\n  entryPoints: {},\n  setEntryPoint: () => {},\n  removeEntryPoint: () => {},\n  getChatCompletionFunctionDescriptions: () => returnAndThrowInDebug([]),\n  getFunctionCallHandler: () => returnAndThrowInDebug(async () => {}),\n\n  getContextString: (documents: DocumentPointer[], categories: string[]) =>\n    returnAndThrowInDebug(\"\"),\n  addContext: () => \"\",\n  removeContext: () => {},\n\n  getDocumentsContext: (categories: string[]) => returnAndThrowInDebug([]),\n  addDocumentContext: () => returnAndThrowInDebug(\"\"),\n  removeDocumentContext: () => {},\n\n  copilotApiConfig: new (class implements CopilotApiConfig {\n    get chatApiEndpoint(): string {\n      throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n    }\n    get chatApiEndpointV2(): string {\n      throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n    }\n    get headers(): Record<string, string> {\n      return {};\n    }\n    get body(): Record<string, any> {\n      return {};\n    }\n  })(),\n};\n\nexport const CopilotContext = React.createContext<CopilotContextParams>(emptyCopilotContext);\n\nexport function useCopilotContext(): CopilotContextParams {\n  return React.useContext(CopilotContext);\n}\n\nfunction returnAndThrowInDebug<T>(value: T): T {\n  throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n  return value;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,IAAAA,gBAA8C;;;ACC9C,mBAAkB;AAqElB,IAAM,sBAA4C;AAAA,EAChD,aAAa,CAAC;AAAA,EACd,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,kBAAkB,MAAM;AAAA,EAAC;AAAA,EACzB,uCAAuC,MAAM,sBAAsB,CAAC,CAAC;AAAA,EACrE,wBAAwB,MAAM,sBAAsB,MAAY;AAAA,EAAC,EAAC;AAAA,EAElE,kBAAkB,CAAC,WAA8B,eAC/C,sBAAsB,EAAE;AAAA,EAC1B,YAAY,MAAM;AAAA,EAClB,eAAe,MAAM;AAAA,EAAC;AAAA,EAEtB,qBAAqB,CAAC,eAAyB,sBAAsB,CAAC,CAAC;AAAA,EACvE,oBAAoB,MAAM,sBAAsB,EAAE;AAAA,EAClD,uBAAuB,MAAM;AAAA,EAAC;AAAA,EAE9B,kBAAkB,IAAK,MAAkC;AAAA,IACvD,IAAI,kBAA0B;AAC5B,YAAM,IAAI,MAAM,uEAAuE;AAAA,IACzF;AAAA,IACA,IAAI,oBAA4B;AAC9B,YAAM,IAAI,MAAM,uEAAuE;AAAA,IACzF;AAAA,IACA,IAAI,UAAkC;AACpC,aAAO,CAAC;AAAA,IACV;AAAA,IACA,IAAI,OAA4B;AAC9B,aAAO,CAAC;AAAA,IACV;AAAA,EACF,EAAG;AACL;AAEO,IAAM,iBAAiB,aAAAC,QAAM,cAAoC,mBAAmB;AAM3F,SAAS,sBAAyB,OAAa;AAC7C,QAAM,IAAI,MAAM,uEAAuE;AACvF,SAAO;AACT;;;ADpGO,SAAS,+BACd,UACA,YACA,eAAsB,CAAC,GACH;AACpB,QAAM,EAAE,oBAAoB,sBAAsB,QAAI,0BAAW,cAAc;AAC/E,QAAM,YAAQ,sBAAe;AAE7B,+BAAU,MAAM;AACd,UAAM,KAAK,mBAAmB,UAAU,UAAU;AAClD,UAAM,UAAU;AAEhB,WAAO,MAAM;AACX,4BAAsB,EAAE;AAAA,IAC1B;AAAA,EACF,GAAG,CAAC,oBAAoB,uBAAuB,GAAG,YAAY,CAAC;AAE/D,SAAO,MAAM;AACf;","names":["import_react","React"]}

package/dist/hooks/use-make-copilot-document-readable.mjs

@@ -1,8 +1,8 @@
 "use client";
 import {
   useMakeCopilotDocumentReadable
-} from "../chunk-IQH5AQQC.mjs";
-import "../chunk-4CFJ6A6A.mjs";
+} from "../chunk-XBLCD24W.mjs";
+import "../chunk-4OWTRVNI.mjs";
 import "../chunk-MRXNTQOX.mjs";
 export {
   useMakeCopilotDocumentReadable

package/dist/hooks/use-make-copilot-readable.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/hooks/use-make-copilot-readable.ts","../../src/context/copilot-context.tsx"],"sourcesContent":["\"use client\";\n\nimport { useContext, useEffect, useRef } from \"react\";\nimport { CopilotContext } from \"../context/copilot-context\";\n\n/**\n * Adds the given information to the Copilot context to make it readable by Copilot.\n * @param information - The information to be added to the Copilot context.\n * @param parentId - The ID of the parent context, if any.\n * @param categories - An array of categories to control which context are visible where. Particularly useful with CopilotTextarea (see `useMakeAutosuggestionFunction`)\n * @returns The ID of the added context.\n */\nexport function useMakeCopilotReadable(\n  information: string,\n  parentId?: string,\n  categories?: string[],\n): string | undefined {\n  const { addContext, removeContext } = useContext(CopilotContext);\n  const idRef = useRef<string>();\n\n  useEffect(() => {\n    const id = addContext(information, parentId, categories);\n    idRef.current = id;\n\n    return () => {\n      removeContext(id);\n    };\n  }, [information, parentId, addContext, removeContext]);\n\n  return idRef.current;\n}\n","\"use client\";\n\nimport { FunctionCallHandler, AnnotatedFunction, Function } from \"@copilotkit/shared\";\nimport React from \"react\";\nimport { TreeNodeId } from \"../hooks/use-tree\";\nimport { DocumentPointer } from \"../types\";\n\n/**\n * Interface for the configuration of the Copilot API.\n */\nexport interface CopilotApiConfig {\n  /**\n   * The endpoint for the chat API.\n   */\n  chatApiEndpoint: string;\n\n  /**\n   * The endpoint for the chat API v2.\n   */\n  chatApiEndpointV2: string;\n\n  /**\n   * additional headers to be sent with the request\n   * @default {}\n   * @example\n   * ```\n   * {\n   *   'Authorization': 'Bearer your_token_here'\n   * }\n   * ```\n   */\n  headers: Record<string, string>;\n\n  /**\n   * Additional body params to be sent with the request\n   * @default {}\n   * @example\n   * ```\n   * {\n   *   'message': 'Hello, world!'\n   * }\n   * ```\n   */\n  body: Record<string, any>;\n}\n\nexport interface CopilotContextParams {\n  // function-calling\n  entryPoints: Record<string, AnnotatedFunction<any[]>>;\n  setEntryPoint: (id: string, entryPoint: AnnotatedFunction<any[]>) => void;\n  removeEntryPoint: (id: string) => void;\n  getChatCompletionFunctionDescriptions: () => Function[];\n  getFunctionCallHandler: () => FunctionCallHandler;\n\n  // text context\n  addContext: (context: string, parentId?: string, categories?: string[]) => TreeNodeId;\n  removeContext: (id: TreeNodeId) => void;\n  getContextString: (documents: DocumentPointer[], categories: string[]) => string;\n\n  // document context\n  addDocumentContext: (documentPointer: DocumentPointer, categories?: string[]) => TreeNodeId;\n  removeDocumentContext: (documentId: string) => void;\n  getDocumentsContext: (categories: string[]) => DocumentPointer[];\n\n  // api endpoints\n  copilotApiConfig: CopilotApiConfig;\n}\n\nconst emptyCopilotContext: CopilotContextParams = {\n  entryPoints: {},\n  setEntryPoint: () => {},\n  removeEntryPoint: () => {},\n  getChatCompletionFunctionDescriptions: () => returnAndThrowInDebug([]),\n  getFunctionCallHandler: () => returnAndThrowInDebug(async () => {}),\n\n  getContextString: (documents: DocumentPointer[], categories: string[]) =>\n    returnAndThrowInDebug(\"\"),\n  addContext: () => \"\",\n  removeContext: () => {},\n\n  getDocumentsContext: (categories: string[]) => returnAndThrowInDebug([]),\n  addDocumentContext: () => returnAndThrowInDebug(\"\"),\n  removeDocumentContext: () => {},\n\n  copilotApiConfig: new (class implements CopilotApiConfig {\n    get chatApiEndpoint(): string {\n      throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n    }\n    get chatApiEndpointV2(): string {\n      throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n    }\n    get headers(): Record<string, string> {\n      return {};\n    }\n    get body(): Record<string, any> {\n      return {};\n    }\n  })(),\n};\n\nexport const CopilotContext = React.createContext<CopilotContextParams>(emptyCopilotContext);\n\nfunction returnAndThrowInDebug<T>(value: T): T {\n  throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n  return value;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,IAAAA,gBAA8C;;;ACC9C,mBAAkB;AAiElB,IAAM,sBAA4C;AAAA,EAChD,aAAa,CAAC;AAAA,EACd,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,kBAAkB,MAAM;AAAA,EAAC;AAAA,EACzB,uCAAuC,MAAM,sBAAsB,CAAC,CAAC;AAAA,EACrE,wBAAwB,MAAM,sBAAsB,MAAY;AAAA,EAAC,EAAC;AAAA,EAElE,kBAAkB,CAAC,WAA8B,eAC/C,sBAAsB,EAAE;AAAA,EAC1B,YAAY,MAAM;AAAA,EAClB,eAAe,MAAM;AAAA,EAAC;AAAA,EAEtB,qBAAqB,CAAC,eAAyB,sBAAsB,CAAC,CAAC;AAAA,EACvE,oBAAoB,MAAM,sBAAsB,EAAE;AAAA,EAClD,uBAAuB,MAAM;AAAA,EAAC;AAAA,EAE9B,kBAAkB,IAAK,MAAkC;AAAA,IACvD,IAAI,kBAA0B;AAC5B,YAAM,IAAI,MAAM,uEAAuE;AAAA,IACzF;AAAA,IACA,IAAI,oBAA4B;AAC9B,YAAM,IAAI,MAAM,uEAAuE;AAAA,IACzF;AAAA,IACA,IAAI,UAAkC;AACpC,aAAO,CAAC;AAAA,IACV;AAAA,IACA,IAAI,OAA4B;AAC9B,aAAO,CAAC;AAAA,IACV;AAAA,EACF,EAAG;AACL;AAEO,IAAM,iBAAiB,aAAAC,QAAM,cAAoC,mBAAmB;AAE3F,SAAS,sBAAyB,OAAa;AAC7C,QAAM,IAAI,MAAM,uEAAuE;AACvF,SAAO;AACT;;;AD7FO,SAAS,uBACd,aACA,UACA,YACoB;AACpB,QAAM,EAAE,YAAY,cAAc,QAAI,0BAAW,cAAc;AAC/D,QAAM,YAAQ,sBAAe;AAE7B,+BAAU,MAAM;AACd,UAAM,KAAK,WAAW,aAAa,UAAU,UAAU;AACvD,UAAM,UAAU;AAEhB,WAAO,MAAM;AACX,oBAAc,EAAE;AAAA,IAClB;AAAA,EACF,GAAG,CAAC,aAAa,UAAU,YAAY,aAAa,CAAC;AAErD,SAAO,MAAM;AACf;","names":["import_react","React"]}
+{"version":3,"sources":["../../src/hooks/use-make-copilot-readable.ts","../../src/context/copilot-context.tsx"],"sourcesContent":["\"use client\";\n\nimport { useContext, useEffect, useRef } from \"react\";\nimport { CopilotContext } from \"../context/copilot-context\";\n\n/**\n * Adds the given information to the Copilot context to make it readable by Copilot.\n * @param information - The information to be added to the Copilot context.\n * @param parentId - The ID of the parent context, if any.\n * @param categories - An array of categories to control which context are visible where. Particularly useful with CopilotTextarea (see `useMakeAutosuggestionFunction`)\n * @returns The ID of the added context.\n */\nexport function useMakeCopilotReadable(\n  information: string,\n  parentId?: string,\n  categories?: string[],\n): string | undefined {\n  const { addContext, removeContext } = useContext(CopilotContext);\n  const idRef = useRef<string>();\n\n  useEffect(() => {\n    const id = addContext(information, parentId, categories);\n    idRef.current = id;\n\n    return () => {\n      removeContext(id);\n    };\n  }, [information, parentId, addContext, removeContext]);\n\n  return idRef.current;\n}\n","\"use client\";\n\nimport { FunctionCallHandler, AnnotatedFunction, ToolDefinition } from \"@copilotkit/shared\";\nimport React from \"react\";\nimport { TreeNodeId } from \"../hooks/use-tree\";\nimport { DocumentPointer } from \"../types\";\n\n/**\n * Interface for the configuration of the Copilot API.\n */\nexport interface CopilotApiConfig {\n  /**\n   * The endpoint for the chat API.\n   */\n  chatApiEndpoint: string;\n\n  /**\n   * The endpoint for the chat API v2.\n   */\n  chatApiEndpointV2: string;\n\n  /**\n   * additional headers to be sent with the request\n   * @default {}\n   * @example\n   * ```\n   * {\n   *   'Authorization': 'Bearer your_token_here'\n   * }\n   * ```\n   */\n  headers: Record<string, string>;\n\n  /**\n   * Additional body params to be sent with the request\n   * @default {}\n   * @example\n   * ```\n   * {\n   *   'message': 'Hello, world!'\n   * }\n   * ```\n   */\n  body: Record<string, any>;\n}\n\nexport interface CopilotContextParams {\n  // function-calling\n  entryPoints: Record<string, AnnotatedFunction<any[]>>;\n  setEntryPoint: (id: string, entryPoint: AnnotatedFunction<any[]>) => void;\n  removeEntryPoint: (id: string) => void;\n  getChatCompletionFunctionDescriptions: (\n    customEntryPoints?: Record<string, AnnotatedFunction<any[]>>,\n  ) => ToolDefinition[];\n  getFunctionCallHandler: (\n    customEntryPoints?: Record<string, AnnotatedFunction<any[]>>,\n  ) => FunctionCallHandler;\n\n  // text context\n  addContext: (context: string, parentId?: string, categories?: string[]) => TreeNodeId;\n  removeContext: (id: TreeNodeId) => void;\n  getContextString: (documents: DocumentPointer[], categories: string[]) => string;\n\n  // document context\n  addDocumentContext: (documentPointer: DocumentPointer, categories?: string[]) => TreeNodeId;\n  removeDocumentContext: (documentId: string) => void;\n  getDocumentsContext: (categories: string[]) => DocumentPointer[];\n\n  // api endpoints\n  copilotApiConfig: CopilotApiConfig;\n}\n\nconst emptyCopilotContext: CopilotContextParams = {\n  entryPoints: {},\n  setEntryPoint: () => {},\n  removeEntryPoint: () => {},\n  getChatCompletionFunctionDescriptions: () => returnAndThrowInDebug([]),\n  getFunctionCallHandler: () => returnAndThrowInDebug(async () => {}),\n\n  getContextString: (documents: DocumentPointer[], categories: string[]) =>\n    returnAndThrowInDebug(\"\"),\n  addContext: () => \"\",\n  removeContext: () => {},\n\n  getDocumentsContext: (categories: string[]) => returnAndThrowInDebug([]),\n  addDocumentContext: () => returnAndThrowInDebug(\"\"),\n  removeDocumentContext: () => {},\n\n  copilotApiConfig: new (class implements CopilotApiConfig {\n    get chatApiEndpoint(): string {\n      throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n    }\n    get chatApiEndpointV2(): string {\n      throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n    }\n    get headers(): Record<string, string> {\n      return {};\n    }\n    get body(): Record<string, any> {\n      return {};\n    }\n  })(),\n};\n\nexport const CopilotContext = React.createContext<CopilotContextParams>(emptyCopilotContext);\n\nexport function useCopilotContext(): CopilotContextParams {\n  return React.useContext(CopilotContext);\n}\n\nfunction returnAndThrowInDebug<T>(value: T): T {\n  throw new Error(\"Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!\");\n  return value;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,IAAAA,gBAA8C;;;ACC9C,mBAAkB;AAqElB,IAAM,sBAA4C;AAAA,EAChD,aAAa,CAAC;AAAA,EACd,eAAe,MAAM;AAAA,EAAC;AAAA,EACtB,kBAAkB,MAAM;AAAA,EAAC;AAAA,EACzB,uCAAuC,MAAM,sBAAsB,CAAC,CAAC;AAAA,EACrE,wBAAwB,MAAM,sBAAsB,MAAY;AAAA,EAAC,EAAC;AAAA,EAElE,kBAAkB,CAAC,WAA8B,eAC/C,sBAAsB,EAAE;AAAA,EAC1B,YAAY,MAAM;AAAA,EAClB,eAAe,MAAM;AAAA,EAAC;AAAA,EAEtB,qBAAqB,CAAC,eAAyB,sBAAsB,CAAC,CAAC;AAAA,EACvE,oBAAoB,MAAM,sBAAsB,EAAE;AAAA,EAClD,uBAAuB,MAAM;AAAA,EAAC;AAAA,EAE9B,kBAAkB,IAAK,MAAkC;AAAA,IACvD,IAAI,kBAA0B;AAC5B,YAAM,IAAI,MAAM,uEAAuE;AAAA,IACzF;AAAA,IACA,IAAI,oBAA4B;AAC9B,YAAM,IAAI,MAAM,uEAAuE;AAAA,IACzF;AAAA,IACA,IAAI,UAAkC;AACpC,aAAO,CAAC;AAAA,IACV;AAAA,IACA,IAAI,OAA4B;AAC9B,aAAO,CAAC;AAAA,IACV;AAAA,EACF,EAAG;AACL;AAEO,IAAM,iBAAiB,aAAAC,QAAM,cAAoC,mBAAmB;AAM3F,SAAS,sBAAyB,OAAa;AAC7C,QAAM,IAAI,MAAM,uEAAuE;AACvF,SAAO;AACT;;;ADrGO,SAAS,uBACd,aACA,UACA,YACoB;AACpB,QAAM,EAAE,YAAY,cAAc,QAAI,0BAAW,cAAc;AAC/D,QAAM,YAAQ,sBAAe;AAE7B,+BAAU,MAAM;AACd,UAAM,KAAK,WAAW,aAAa,UAAU,UAAU;AACvD,UAAM,UAAU;AAEhB,WAAO,MAAM;AACX,oBAAc,EAAE;AAAA,IAClB;AAAA,EACF,GAAG,CAAC,aAAa,UAAU,YAAY,aAAa,CAAC;AAErD,SAAO,MAAM;AACf;","names":["import_react","React"]}

package/dist/hooks/use-make-copilot-readable.mjs

@@ -1,8 +1,8 @@
 "use client";
 import {
   useMakeCopilotReadable
-} from "../chunk-YOXWT7I6.mjs";
-import "../chunk-4CFJ6A6A.mjs";
+} from "../chunk-CPEUPJQJ.mjs";
+import "../chunk-4OWTRVNI.mjs";
 import "../chunk-MRXNTQOX.mjs";
 export {
   useMakeCopilotReadable

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { CopilotKit, defaultCopilotContextCategories } from './components/copilot-provider/copilotkit.js';
 export { CopilotKitProps } from './components/copilot-provider/copilotkit-props.js';
-export { CopilotApiConfig, CopilotContext, CopilotContextParams } from './context/copilot-context.js';
+export { CopilotApiConfig, CopilotContext, CopilotContextParams, useCopilotContext } from './context/copilot-context.js';
 export { UseCopilotChatOptions, UseCopilotChatReturn, useCopilotChat } from './hooks/use-copilot-chat.js';
 export { useMakeCopilotActionable } from './hooks/use-make-copilot-actionable.js';
 export { useMakeCopilotReadable } from './hooks/use-make-copilot-readable.js';
@@ -10,6 +10,7 @@ export { DocumentPointer } from './types/document-pointer.js';
 export { SystemMessageFunction } from './types/system-message.js';
 export { AssistantStatus, RequestForwardingOptions, UseCopilotChatOptionsV2, UseCopilotChatV2Result, useCopilotChatV2 } from './openai-assistants/hooks/use-copilot-chat-v2.js';
 export { processMessageStream } from './openai-assistants/utils/process-message-stream.js';
+export { CopilotTask, CopilotTaskConfig } from './lib/copilot-task.js';
 export { FetchChatCompletionParams, fetchAndDecodeChatCompletion, fetchAndDecodeChatCompletionAsText, fetchChatCompletion } from './utils/fetch-chat-completion.js';
 import 'react';
 import '@copilotkit/shared';

package/dist/index.js

@@ -81,6 +81,7 @@ var src_exports = {};
 __export(src_exports, {
   CopilotContext: () => CopilotContext,
   CopilotKit: () => CopilotKit,
+  CopilotTask: () => CopilotTask,
   defaultCopilotContextCategories: () => defaultCopilotContextCategories,
   fetchAndDecodeChatCompletion: () => fetchAndDecodeChatCompletion,
   fetchAndDecodeChatCompletionAsText: () => fetchAndDecodeChatCompletionAsText,
@@ -88,6 +89,7 @@ __export(src_exports, {
   processMessageStream: () => processMessageStream,
   useCopilotChat: () => useCopilotChat,
   useCopilotChatV2: () => useCopilotChatV2,
+  useCopilotContext: () => useCopilotContext,
   useMakeCopilotActionable: () => useMakeCopilotActionable,
   useMakeCopilotDocumentReadable: () => useMakeCopilotDocumentReadable,
   useMakeCopilotReadable: () => useMakeCopilotReadable
@@ -132,6 +134,9 @@ var emptyCopilotContext = {
   }()
 };
 var CopilotContext = import_react.default.createContext(emptyCopilotContext);
+function useCopilotContext() {
+  return import_react.default.useContext(CopilotContext);
+}
 function returnAndThrowInDebug(value) {
   throw new Error("Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!");
   return value;
@@ -397,12 +402,18 @@ ${nonDocumentStrings}`;
     },
     [removeElement]
   );
-  const getChatCompletionFunctionDescriptions = (0, import_react4.useCallback)(() => {
-    return entryPointsToChatCompletionFunctions(Object.values(entryPoints));
-  }, [entryPoints]);
-  const getFunctionCallHandler = (0, import_react4.useCallback)(() => {
-    return entryPointsToFunctionCallHandler(Object.values(entryPoints));
-  }, [entryPoints]);
+  const getChatCompletionFunctionDescriptions = (0, import_react4.useCallback)(
+    (customEntryPoints) => {
+      return entryPointsToChatCompletionFunctions(Object.values(customEntryPoints || entryPoints));
+    },
+    [entryPoints]
+  );
+  const getFunctionCallHandler = (0, import_react4.useCallback)(
+    (customEntryPoints) => {
+      return entryPointsToFunctionCallHandler(Object.values(customEntryPoints || entryPoints));
+    },
+    [entryPoints]
+  );
   const getDocumentsContext = (0, import_react4.useCallback)(
     (categories) => {
       return allDocuments(categories);
@@ -480,6 +491,7 @@ var import_react6 = require("react");
 
 // src/hooks/use-chat.ts
 var import_react5 = require("react");
+var import_shared3 = require("@copilotkit/shared");
 var import_nanoid3 = require("nanoid");
 
 // src/utils/fetch-chat-completion.ts
@@ -489,14 +501,14 @@ function fetchChatCompletion(_0) {
     copilotConfig,
     model,
     messages,
-    functions,
+    tools,
     temperature,
     headers,
     body,
     signal
   }) {
     temperature || (temperature = 0.5);
-    functions || (functions = []);
+    tools || (tools = []);
     const cleanedMessages = messages.map((message) => {
       const { content, role, name, function_call } = message;
       return { content, role, name, function_call };
@@ -510,7 +522,7 @@ function fetchChatCompletion(_0) {
         model,
         messages: cleanedMessages,
         stream: true
-      }, functions.length ? { functions } : {}), temperature ? { temperature } : {}), functions.length != 0 ? { function_call: "auto" } : {}), copilotConfig.body), body ? __spreadValues({}, body) : {})),
+      }, tools.length ? { tools } : {}), temperature ? { temperature } : {}), tools.length != 0 ? { tool_choice: "auto" } : {}), copilotConfig.body), body ? __spreadValues({}, body) : {})),
       signal
     });
     return response;
@@ -547,20 +559,22 @@ function useChat(options) {
   const abortControllerRef = (0, import_react5.useRef)();
   const runChatCompletion = (messages2) => __async(this, null, function* () {
     setIsLoading(true);
-    const assistantMessage = {
-      id: (0, import_nanoid3.nanoid)(),
-      createdAt: /* @__PURE__ */ new Date(),
-      content: "",
-      role: "assistant"
-    };
+    const newMessages = [
+      {
+        id: (0, import_nanoid3.nanoid)(),
+        createdAt: /* @__PURE__ */ new Date(),
+        content: "",
+        role: "assistant"
+      }
+    ];
     const abortController = new AbortController();
     abortControllerRef.current = abortController;
-    setMessages([...messages2, __spreadValues({}, assistantMessage)]);
+    setMessages([...messages2, ...newMessages]);
     const messagesWithContext = [...options.initialMessages || [], ...messages2];
     const response = yield fetchAndDecodeChatCompletion({
       copilotConfig: options.copilotConfig,
       messages: messagesWithContext,
-      functions: options.functions,
+      tools: options.tools,
       headers: options.headers,
       signal: abortController.signal
     });
@@ -568,36 +582,83 @@ function useChat(options) {
       throw new Error("Failed to fetch chat completion");
     }
     const reader = response.events.getReader();
-    while (true) {
-      try {
+    let feedback = false;
+    try {
+      while (true) {
         const { done, value } = yield reader.read();
         if (done) {
-          setIsLoading(false);
-          return __spreadValues({}, assistantMessage);
+          break;
         }
+        let currentMessage = Object.assign({}, newMessages[newMessages.length - 1]);
         if (value.type === "content") {
-          assistantMessage.content += value.content;
-          setMessages([...messages2, __spreadValues({}, assistantMessage)]);
+          if (currentMessage.function_call || currentMessage.role === "function") {
+            currentMessage = {
+              id: (0, import_nanoid3.nanoid)(),
+              createdAt: /* @__PURE__ */ new Date(),
+              content: "",
+              role: "assistant"
+            };
+            newMessages.push(currentMessage);
+          }
+          currentMessage.content += value.content;
+          newMessages[newMessages.length - 1] = currentMessage;
+          setMessages([...messages2, ...newMessages]);
+        } else if (value.type === "result") {
+          currentMessage = {
+            id: (0, import_nanoid3.nanoid)(),
+            role: "function",
+            content: value.content,
+            name: value.name
+          };
+          newMessages.push(currentMessage);
+          setMessages([...messages2, ...newMessages]);
+          feedback = true;
         } else if (value.type === "function") {
-          assistantMessage.function_call = {
+          if (currentMessage.content != "" || currentMessage.function_call || currentMessage.role == "function") {
+            currentMessage = {
+              id: (0, import_nanoid3.nanoid)(),
+              createdAt: /* @__PURE__ */ new Date(),
+              content: "",
+              role: "assistant"
+            };
+            newMessages.push(currentMessage);
+          }
+          currentMessage.function_call = {
             name: value.name,
-            arguments: JSON.stringify(value.arguments)
+            arguments: JSON.stringify(value.arguments),
+            scope: value.scope
           };
-          setMessages([...messages2, __spreadValues({}, assistantMessage)]);
-          setIsLoading(false);
-          return __spreadValues({}, assistantMessage);
+          newMessages[newMessages.length - 1] = currentMessage;
+          setMessages([...messages2, ...newMessages]);
+          try {
+            if (options.onFunctionCall && value.scope === "client") {
+              const result = yield options.onFunctionCall(messages2, currentMessage.function_call);
+              currentMessage = {
+                id: (0, import_nanoid3.nanoid)(),
+                role: "function",
+                content: (0, import_shared3.encodeResult)(result),
+                name: currentMessage.function_call.name
+              };
+              newMessages.push(currentMessage);
+              setMessages([...messages2, ...newMessages]);
+              feedback = true;
+            }
+          } catch (error) {
+            console.error("Failed to execute function call", error);
+          }
         }
-      } catch (error) {
-        setIsLoading(false);
-        throw error;
       }
+      if (feedback) {
+        return yield runChatCompletion([...messages2, ...newMessages]);
+      } else {
+        return newMessages.slice();
+      }
+    } finally {
+      setIsLoading(false);
     }
   });
   const runChatCompletionAndHandleFunctionCall = (messages2) => __async(this, null, function* () {
-    const message = yield runChatCompletion(messages2);
-    if (message.function_call && options.onFunctionCall) {
-      yield options.onFunctionCall(messages2, message.function_call);
-    }
+    yield runChatCompletion(messages2);
   });
   const append = (message) => __async(this, null, function* () {
     if (isLoading) {
@@ -665,7 +726,7 @@ function useCopilotChat(_a) {
     copilotConfig: copilotApiConfig,
     id: options.id,
     initialMessages: [systemMessage].concat(options.initialMessages || []),
-    functions: functionDescriptions,
+    tools: functionDescriptions,
     onFunctionCall: getFunctionCallHandler(),
     headers: __spreadValues({}, options.headers),
     body: __spreadValues({}, options.body)
@@ -787,7 +848,7 @@ function processMessageStream(reader, processMessage) {
 }
 
 // src/openai-assistants/hooks/use-copilot-chat-v2.ts
-var import_shared3 = require("@copilotkit/shared");
+var import_shared4 = require("@copilotkit/shared");
 function useCopilotChatV2(options) {
   const {
     getContextString,
@@ -839,7 +900,7 @@ function useCopilotChatV2(options) {
     }
     yield processMessageStream(result.body.getReader(), (message) => {
       try {
-        const { type, value } = (0, import_shared3.parseStreamPart)(message);
+        const { type, value } = (0, import_shared4.parseStreamPart)(message);
         switch (type) {
           case "assistant_message": {
             setMessages((messages2) => [
@@ -902,10 +963,99 @@ You can ask them for clarifying questions if needed, but don't be annoying about
 If you would like to call a function, call it without saying anything else.
 `;
 }
+
+// src/lib/copilot-task.ts
+var CopilotTask = class {
+  constructor(config) {
+    this.instructions = config.instructions;
+    this.functions = config.functions || [];
+    this.includeCopilotReadable = config.includeCopilotReadable || true;
+    this.includeCopilotActionable = config.includeCopilotActionable || true;
+  }
+  run(context, data) {
+    return __async(this, null, function* () {
+      const entryPoints = this.includeCopilotActionable ? Object.assign({}, context.entryPoints) : {};
+      for (const fn of this.functions) {
+        entryPoints[fn.name] = fn;
+      }
+      let contextString = "";
+      if (data) {
+        contextString = (typeof data === "string" ? data : JSON.stringify(data)) + "\n\n";
+      }
+      if (this.includeCopilotReadable) {
+        contextString += context.getContextString([], defaultCopilotContextCategories);
+      }
+      const systemMessage = {
+        id: "system",
+        content: taskSystemMessage(contextString, this.instructions),
+        role: "system"
+      };
+      const messages = [systemMessage];
+      const response = yield fetchAndDecodeChatCompletion({
+        copilotConfig: context.copilotApiConfig,
+        messages,
+        tools: context.getChatCompletionFunctionDescriptions(entryPoints),
+        headers: context.copilotApiConfig.headers,
+        body: context.copilotApiConfig.body
+      });
+      if (!response.events) {
+        throw new Error("Failed to execute task");
+      }
+      const reader = response.events.getReader();
+      let functionCalls = [];
+      while (true) {
+        const { done, value } = yield reader.read();
+        if (done) {
+          break;
+        }
+        if (value.type === "function") {
+          functionCalls.push({
+            name: value.name,
+            arguments: JSON.stringify(value.arguments)
+          });
+          break;
+        }
+      }
+      if (!functionCalls.length) {
+        throw new Error("No function call occurred");
+      }
+      const functionCallHandler = context.getFunctionCallHandler(entryPoints);
+      for (const functionCall of functionCalls) {
+        yield functionCallHandler(messages, functionCall);
+      }
+    });
+  }
+};
+function taskSystemMessage(contextString, instructions) {
+  return `
+Please act as an efficient, competent, conscientious, and industrious professional assistant.
+
+Help the user achieve their goals, and you do so in a way that is as efficient as possible, without unnecessary fluff, but also without sacrificing professionalism.
+Always be polite and respectful, and prefer brevity over verbosity.
+
+The user has provided you with the following context:
+\`\`\`
+${contextString}
+\`\`\`
+
+They have also provided you with functions you can call to initiate actions on their behalf.
+
+Please assist them as best you can.
+
+This is not a conversation, so please do not ask questions. Just call a function without saying anything else.
+
+The user has given you the following task to complete:
+
+\`\`\`
+${instructions}
+\`\`\`
+`;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CopilotContext,
   CopilotKit,
+  CopilotTask,
   defaultCopilotContextCategories,
   fetchAndDecodeChatCompletion,
   fetchAndDecodeChatCompletionAsText,
@@ -913,6 +1063,7 @@ If you would like to call a function, call it without saying anything else.
   processMessageStream,
   useCopilotChat,
   useCopilotChatV2,
+  useCopilotContext,
   useMakeCopilotActionable,
   useMakeCopilotDocumentReadable,
   useMakeCopilotReadable