@copilotkit/react-ui 1.3.16-mme-copilot-suggestions.1 → 1.3.16-mme-reset-chat.2

package/dist/index.mjs

@@ -4,45 +4,42 @@ import "./chunk-JD7BAH7U.mjs";
 import "./chunk-MRFF7GSQ.mjs";
 import {
   CopilotSidebar
-} from "./chunk-T7DQWLTN.mjs";
+} from "./chunk-3JNDMHS4.mjs";
 import "./chunk-WB3YULQ4.mjs";
 import {
   CopilotPopup
-} from "./chunk-PIK3RYPJ.mjs";
-import "./chunk-DTI5DZSK.mjs";
+} from "./chunk-AX7CAT7V.mjs";
+import "./chunk-3EYL2DRG.mjs";
 import "./chunk-YAGE7RCE.mjs";
 import "./chunk-VEC45H6Q.mjs";
 import "./chunk-RQNJNK2W.mjs";
 import {
   CopilotChat
-} from "./chunk-UYT3USIS.mjs";
+} from "./chunk-NLIDKNNS.mjs";
 import "./chunk-V7W6IM2V.mjs";
 import "./chunk-OMTPWC7T.mjs";
 import "./chunk-ZABXREBH.mjs";
 import "./chunk-6INMITFA.mjs";
 import "./chunk-RU73BEZM.mjs";
-import "./chunk-3XAXY2Z3.mjs";
 import "./chunk-RJCZRKTV.mjs";
-import "./chunk-W3TDOLUY.mjs";
-import "./chunk-OTPAZXVR.mjs";
+import "./chunk-RS6UPR5N.mjs";
 import "./chunk-4FIGRRFS.mjs";
+import "./chunk-OTPAZXVR.mjs";
 import "./chunk-4LUMV4YO.mjs";
 import "./chunk-YQFVRDNC.mjs";
 import "./chunk-YQ3D5IQV.mjs";
-import "./chunk-UPTB2MVO.mjs";
 import "./chunk-CPMIEVKK.mjs";
+import "./chunk-3XAXY2Z3.mjs";
 import {
   useChatContext
 } from "./chunk-CBBFRI3Q.mjs";
+import "./chunk-UPTB2MVO.mjs";
 import "./chunk-FZC7X5PK.mjs";
 import "./chunk-IU3WTXLQ.mjs";
-import "./chunk-RJ54B6VE.mjs";
+import "./chunk-T26KLXLH.mjs";
 import {
   useCopilotChatSuggestions
-} from "./chunk-HGQFDT5I.mjs";
-import {
-  useCopilotSuggestions
-} from "./chunk-G7A3YV3L.mjs";
+} from "./chunk-Z2UZSN3K.mjs";
 import "./chunk-54JAUBUJ.mjs";
 import "./chunk-S5MBUNGN.mjs";
 import "./chunk-MRXNTQOX.mjs";
@@ -51,7 +48,6 @@ export {
   CopilotPopup,
   CopilotSidebar,
   useChatContext,
-  useCopilotChatSuggestions,
-  useCopilotSuggestions
+  useCopilotChatSuggestions
 };
 //# sourceMappingURL=index.mjs.map

package/package.json

@@ -9,7 +9,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.3.16-mme-copilot-suggestions.1",
+  "version": "1.3.16-mme-reset-chat.2",
   "sideEffects": [
     "**/*.css"
   ],
@@ -40,9 +40,9 @@
     "ts-jest": "^29.1.1",
     "tsup": "^6.7.0",
     "typescript": "^5.2.3",
-    "eslint-config-custom": "1.3.16-mme-copilot-suggestions.1",
-    "tailwind-config": "1.3.16-mme-copilot-suggestions.1",
-    "tsconfig": "1.3.16-mme-copilot-suggestions.1"
+    "eslint-config-custom": "1.3.16-mme-reset-chat.2",
+    "tailwind-config": "1.3.16-mme-reset-chat.2",
+    "tsconfig": "1.3.16-mme-reset-chat.2"
   },
   "dependencies": {
     "@headlessui/react": "^2.1.3",
@@ -50,9 +50,9 @@
     "react-syntax-highlighter": "^15.5.0",
     "remark-gfm": "^3.0.1",
     "remark-math": "^5.1.1",
-    "@copilotkit/react-core": "1.3.16-mme-copilot-suggestions.1",
-    "@copilotkit/runtime-client-gql": "1.3.16-mme-copilot-suggestions.1",
-    "@copilotkit/shared": "1.3.16-mme-copilot-suggestions.1"
+    "@copilotkit/react-core": "1.3.16-mme-reset-chat.2",
+    "@copilotkit/runtime-client-gql": "1.3.16-mme-reset-chat.2",
+    "@copilotkit/shared": "1.3.16-mme-reset-chat.2"
   },
   "keywords": [
     "copilotkit",

package/src/hooks/index.ts

@@ -1,2 +1 @@
 export * from "./use-copilot-chat-suggestions";
-export * from "./use-copilot-suggestions";

package/src/hooks/use-copilot-chat-suggestions.tsx

@@ -4,7 +4,9 @@
  *   can change without notice.
  * </Callout>
  *
- * `useCopilotChatSuggestions` is a React hook that provides auto-suggestions in the Copilot chat.
+ * `useCopilotReadable` is a React hook that provides app-state and other information
+ * to the Copilot. Optionally, the hook can also handle hierarchical state within your
+ * application, passing these parent-child relationships to the Copilot.
  *
  * <br/>
  * <img src="/images/use-copilot-chat-suggestions/use-copilot-chat-suggestions.gif" width="500" />

package/dist/chunk-G7A3YV3L.mjs

@@ -1,109 +0,0 @@
-import {
-  __async,
-  __spreadProps,
-  __spreadValues
-} from "./chunk-MRXNTQOX.mjs";
-
-// src/hooks/use-copilot-suggestions.ts
-import { useEffect, useState, useRef, useCallback } from "react";
-import {
-  extract,
-  useCopilotContext,
-  useCopilotMessagesContext
-} from "@copilotkit/react-core";
-import { CopilotRequestType } from "@copilotkit/runtime-client-gql";
-function useCopilotSuggestions({
-  instructions,
-  parameters,
-  value,
-  enabled = true,
-  debounceTime = 1e3
-}, dependencies = []) {
-  const suggestionsAbortControllerRef = useRef(null);
-  const debounceTimerRef = useRef();
-  const [suggestions, setSuggestions] = useState({
-    suggestions: void 0,
-    isAvailable: false,
-    isLoading: false
-  });
-  const isFirstRunRef = useRef(true);
-  const abortSuggestions = useCallback(() => {
-    var _a;
-    (_a = suggestionsAbortControllerRef.current) == null ? void 0 : _a.abort();
-    suggestionsAbortControllerRef.current = null;
-  }, []);
-  const generalContext = useCopilotContext();
-  const messagesContext = useCopilotMessagesContext();
-  const context = __spreadValues(__spreadValues({}, generalContext), messagesContext);
-  useEffect(() => {
-    abortSuggestions();
-    if (!enabled) {
-      setSuggestions({ suggestions: void 0, isAvailable: false, isLoading: false });
-      return;
-    }
-    if (JSON.stringify(value) === JSON.stringify(suggestions.suggestions)) {
-      return;
-    }
-    debounceTimerRef.current = setTimeout(
-      () => __async(this, null, function* () {
-        isFirstRunRef.current = false;
-        suggestionsAbortControllerRef.current = new AbortController();
-        setSuggestions(__spreadProps(__spreadValues({}, suggestions), { isLoading: true }));
-        yield reloadSuggestions(
-          context,
-          instructions,
-          parameters,
-          value,
-          suggestionsAbortControllerRef,
-          setSuggestions
-        );
-      }),
-      isFirstRunRef.current === true ? 0 : debounceTime
-    );
-    return () => {
-      clearTimeout(debounceTimerRef.current);
-    };
-  }, [
-    instructions,
-    JSON.stringify(parameters),
-    JSON.stringify(value),
-    enabled,
-    debounceTime,
-    ...dependencies
-  ]);
-  return suggestions;
-}
-function reloadSuggestions(context, instructions, parameters, value, abortControllerRef, setSuggestions) {
-  return __async(this, null, function* () {
-    const abortController = abortControllerRef.current;
-    let fullInstructions = `It's your task to generate suggestions based on the application context.`;
-    if (instructions) {
-      fullInstructions += `
-
-In addition, follow these specific instructions: ${instructions}`;
-    }
-    if (value) {
-      fullInstructions += `
-
-The current value of the parameter is: ${JSON.stringify(value)}.If it makes sense to complete the existing data, i.e. expand string values, add new elements to arrays, etc., do so. Otherwise, generate a new value.`;
-    }
-    yield extract({
-      context,
-      instructions: instructions || "",
-      data: fullInstructions,
-      parameters,
-      abortSignal: abortController == null ? void 0 : abortController.signal,
-      requestType: CopilotRequestType.Task,
-      stream({ args, status }) {
-        if (status === "complete") {
-          setSuggestions({ suggestions: args, isAvailable: true, isLoading: false });
-        }
-      }
-    });
-  });
-}
-
-export {
-  useCopilotSuggestions
-};
-//# sourceMappingURL=chunk-G7A3YV3L.mjs.map

package/dist/chunk-G7A3YV3L.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/hooks/use-copilot-suggestions.ts"],"sourcesContent":["/**\n * <Callout type=\"warning\">\n *   useCopilotSuggestions is experimental. The interface is not final and\n *   can change without notice.\n * </Callout>\n *\n * `useCopilotSuggestions` is a React hook that provides auto-suggestions that can be added to any\n * UI component.\n *\n * ## Usage\n *\n * ### Install Dependencies\n *\n * This component is part of the [@copilotkit/react-ui](https://npmjs.com/package/@copilotkit/react-ui) package.\n *\n * ```shell npm2yarn \\\"@copilotkit/react-ui\"\\\n * npm install @copilotkit/react-core @copilotkit/react-ui\n * ```\n *\n * ### Simple Usage\n *\n * ```tsx\n * TODO\n * ```\n *\n * ### Dependency Management\n *\n * ```tsx\n * TODO\n * }\n * ```\n *\n * In the example above, the suggestions are generated based on the given instructions.\n * The hook monitors `appState`, and updates suggestions accordingly whenever it changes.\n *\n * ### Behavior and Lifecycle\n *\n * The hook registers the configuration with the chat context upon component mount and\n * removes it on unmount, ensuring a clean and efficient lifecycle management.\n */\n\nimport { useEffect, useState, useRef, useCallback } from \"react\";\nimport {\n  CopilotContextParams,\n  CopilotMessagesContextParams,\n  extract,\n  useCopilotContext,\n  useCopilotMessagesContext,\n} from \"@copilotkit/react-core\";\nimport { MappedParameterTypes, Parameter, randomId } from \"@copilotkit/shared\";\nimport { CopilotRequestType } from \"@copilotkit/runtime-client-gql\";\n\nexport interface UseCopilotSuggestionsConfiguration<T extends Parameter[] = []> {\n  /**\n   * A prompt or instructions for the GPT to generate suggestions.\n   */\n  instructions?: string;\n\n  /**\n   * The data to pass to the suggestions.\n   */\n  parameters: T;\n\n  /**\n   * The current value of the parameter.\n   */\n  value?: Partial<MappedParameterTypes<T>>;\n\n  /**\n   * Whether the suggestions are enabled.\n   * @default true\n   */\n  enabled?: boolean;\n\n  /**\n   * The debounce time in milliseconds.\n   * @default 1000\n   */\n  debounceTime?: number;\n}\nexport type SuggestionsResult<T extends Parameter[]> =\n  | { suggestions: undefined; isAvailable: false; isLoading: boolean }\n  | { suggestions: MappedParameterTypes<T>; isAvailable: true; isLoading: boolean };\n\nexport function useCopilotSuggestions<const T extends Parameter[]>(\n  {\n    instructions,\n    parameters,\n    value,\n    enabled = true,\n    debounceTime = 1000,\n  }: UseCopilotSuggestionsConfiguration<T>,\n  dependencies: any[] = [],\n): SuggestionsResult<T> {\n  const suggestionsAbortControllerRef = useRef<AbortController | null>(null);\n  const debounceTimerRef = useRef<any>();\n  const [suggestions, setSuggestions] = useState<SuggestionsResult<T>>({\n    suggestions: undefined,\n    isAvailable: false,\n    isLoading: false,\n  });\n  const isFirstRunRef = useRef(true);\n\n  const abortSuggestions = useCallback(() => {\n    suggestionsAbortControllerRef.current?.abort();\n    suggestionsAbortControllerRef.current = null;\n  }, []);\n\n  const generalContext = useCopilotContext();\n  const messagesContext = useCopilotMessagesContext();\n  const context = { ...generalContext, ...messagesContext };\n\n  useEffect(() => {\n    abortSuggestions();\n    if (!enabled) {\n      setSuggestions({ suggestions: undefined, isAvailable: false, isLoading: false });\n      return;\n    }\n\n    // if value is the same as the last suggestions, don't reload\n    if (JSON.stringify(value) === JSON.stringify(suggestions.suggestions)) {\n      return;\n    }\n\n    debounceTimerRef.current = setTimeout(\n      async () => {\n        isFirstRunRef.current = false;\n        suggestionsAbortControllerRef.current = new AbortController();\n        setSuggestions({ ...suggestions, isLoading: true });\n        await reloadSuggestions(\n          context,\n          instructions,\n          parameters,\n          value,\n          suggestionsAbortControllerRef,\n          setSuggestions,\n        );\n      },\n      isFirstRunRef.current === true ? 0 : debounceTime,\n    );\n\n    return () => {\n      clearTimeout(debounceTimerRef.current);\n    };\n  }, [\n    instructions,\n    JSON.stringify(parameters),\n    JSON.stringify(value),\n    enabled,\n    debounceTime,\n    ...dependencies,\n  ]);\n\n  return suggestions;\n}\n\nasync function reloadSuggestions(\n  context: CopilotContextParams & CopilotMessagesContextParams,\n  instructions: string | undefined,\n  parameters: Parameter[],\n  value: any,\n  abortControllerRef: React.MutableRefObject<AbortController | null>,\n  setSuggestions: (suggestions: any) => void,\n) {\n  const abortController = abortControllerRef.current;\n  let fullInstructions = `It's your task to generate suggestions based on the application context.`;\n  if (instructions) {\n    fullInstructions += `\\n\\nIn addition, follow these specific instructions: ${instructions}`;\n  }\n  if (value) {\n    fullInstructions +=\n      `\\n\\nThe current value of the parameter is: ${JSON.stringify(value)}.` +\n      `If it makes sense to complete the existing data, i.e. expand string values, add new elements to arrays, etc., do so. ` +\n      `Otherwise, generate a new value.`;\n  }\n\n  await extract({\n    context,\n    instructions: instructions || \"\",\n    data: fullInstructions,\n    parameters,\n    abortSignal: abortController?.signal,\n    requestType: CopilotRequestType.Task,\n    stream({ args, status }) {\n      if (status === \"complete\") {\n        setSuggestions({ suggestions: args, isAvailable: true, isLoading: false });\n      }\n    },\n  });\n}\n"],"mappings":";;;;;;;AAyCA,SAAS,WAAW,UAAU,QAAQ,mBAAmB;AACzD;AAAA,EAGE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,0BAA0B;AAkC5B,SAAS,sBACd;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA,UAAU;AAAA,EACV,eAAe;AACjB,GACA,eAAsB,CAAC,GACD;AACtB,QAAM,gCAAgC,OAA+B,IAAI;AACzE,QAAM,mBAAmB,OAAY;AACrC,QAAM,CAAC,aAAa,cAAc,IAAI,SAA+B;AAAA,IACnE,aAAa;AAAA,IACb,aAAa;AAAA,IACb,WAAW;AAAA,EACb,CAAC;AACD,QAAM,gBAAgB,OAAO,IAAI;AAEjC,QAAM,mBAAmB,YAAY,MAAM;AAvG7C;AAwGI,wCAA8B,YAA9B,mBAAuC;AACvC,kCAA8B,UAAU;AAAA,EAC1C,GAAG,CAAC,CAAC;AAEL,QAAM,iBAAiB,kBAAkB;AACzC,QAAM,kBAAkB,0BAA0B;AAClD,QAAM,UAAU,kCAAK,iBAAmB;AAExC,YAAU,MAAM;AACd,qBAAiB;AACjB,QAAI,CAAC,SAAS;AACZ,qBAAe,EAAE,aAAa,QAAW,aAAa,OAAO,WAAW,MAAM,CAAC;AAC/E;AAAA,IACF;AAGA,QAAI,KAAK,UAAU,KAAK,MAAM,KAAK,UAAU,YAAY,WAAW,GAAG;AACrE;AAAA,IACF;AAEA,qBAAiB,UAAU;AAAA,MACzB,MAAY;AACV,sBAAc,UAAU;AACxB,sCAA8B,UAAU,IAAI,gBAAgB;AAC5D,uBAAe,iCAAK,cAAL,EAAkB,WAAW,KAAK,EAAC;AAClD,cAAM;AAAA,UACJ;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAAA,MACA,cAAc,YAAY,OAAO,IAAI;AAAA,IACvC;AAEA,WAAO,MAAM;AACX,mBAAa,iBAAiB,OAAO;AAAA,IACvC;AAAA,EACF,GAAG;AAAA,IACD;AAAA,IACA,KAAK,UAAU,UAAU;AAAA,IACzB,KAAK,UAAU,KAAK;AAAA,IACpB;AAAA,IACA;AAAA,IACA,GAAG;AAAA,EACL,CAAC;AAED,SAAO;AACT;AAEA,SAAe,kBACb,SACA,cACA,YACA,OACA,oBACA,gBACA;AAAA;AACA,UAAM,kBAAkB,mBAAmB;AAC3C,QAAI,mBAAmB;AACvB,QAAI,cAAc;AAChB,0BAAoB;AAAA;AAAA,mDAAwD;AAAA,IAC9E;AACA,QAAI,OAAO;AACT,0BACE;AAAA;AAAA,yCAA8C,KAAK,UAAU,KAAK;AAAA,IAGtE;AAEA,UAAM,QAAQ;AAAA,MACZ;AAAA,MACA,cAAc,gBAAgB;AAAA,MAC9B,MAAM;AAAA,MACN;AAAA,MACA,aAAa,mDAAiB;AAAA,MAC9B,aAAa,mBAAmB;AAAA,MAChC,OAAO,EAAE,MAAM,OAAO,GAAG;AACvB,YAAI,WAAW,YAAY;AACzB,yBAAe,EAAE,aAAa,MAAM,aAAa,MAAM,WAAW,MAAM,CAAC;AAAA,QAC3E;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA;","names":[]}

package/dist/chunk-HGQFDT5I.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/hooks/use-copilot-chat-suggestions.tsx"],"sourcesContent":["/**\n * <Callout type=\"warning\">\n *   useCopilotChatSuggestions is experimental. The interface is not final and\n *   can change without notice.\n * </Callout>\n *\n * `useCopilotChatSuggestions` is a React hook that provides auto-suggestions in the Copilot chat.\n *\n * <br/>\n * <img src=\"/images/use-copilot-chat-suggestions/use-copilot-chat-suggestions.gif\" width=\"500\" />\n *\n * ## Usage\n *\n * ### Install Dependencies\n *\n * This component is part of the [@copilotkit/react-ui](https://npmjs.com/package/@copilotkit/react-ui) package.\n *\n * ```shell npm2yarn \\\"@copilotkit/react-ui\"\\\n * npm install @copilotkit/react-core @copilotkit/react-ui\n * ```\n *\n * ### Simple Usage\n *\n * ```tsx\n * import { useCopilotChatSuggestions } from \"@copilotkit/react-ui\";\n *\n * export function MyComponent() {\n *   const [employees, setEmployees] = useState([]);\n *\n *   useCopilotChatSuggestions({\n *     instructions: `The following employees are on duty: ${JSON.stringify(employees)}`,\n *   });\n * }\n * ```\n *\n * ### Dependency Management\n *\n * ```tsx\n * import { useCopilotChatSuggestions } from \"@copilotkit/react-ui\";\n *\n * export function MyComponent() {\n *   useCopilotChatSuggestions(\n *     {\n *       instructions: \"Suggest the most relevant next actions.\",\n *     },\n *     [appState],\n *   );\n * }\n * ```\n *\n * In the example above, the suggestions are generated based on the given instructions.\n * The hook monitors `appState`, and updates suggestions accordingly whenever it changes.\n *\n * ### Behavior and Lifecycle\n *\n * The hook registers the configuration with the chat context upon component mount and\n * removes it on unmount, ensuring a clean and efficient lifecycle management.\n */\n\nimport { useEffect } from \"react\";\nimport { useCopilotContext } from \"@copilotkit/react-core\";\nimport { randomId } from \"@copilotkit/shared\";\n\ninterface UseCopilotChatSuggestionsConfiguration {\n  /**\n   * A prompt or instructions for the GPT to generate suggestions.\n   */\n  instructions: string;\n  /**\n   * The minimum number of suggestions to generate. Defaults to `1`.\n   * @default 1\n   */\n  minSuggestions?: number;\n  /**\n   * The maximum number of suggestions to generate. Defaults to `3`.\n   * @default 1\n   */\n  maxSuggestions?: number;\n  /**\n   * An optional class name to apply to the suggestions.\n   */\n  className?: string;\n}\n\nexport function useCopilotChatSuggestions(\n  {\n    instructions,\n    className,\n    minSuggestions = 1,\n    maxSuggestions = 3,\n  }: UseCopilotChatSuggestionsConfiguration,\n  dependencies: any[] = [],\n) {\n  const context = useCopilotContext();\n\n  useEffect(() => {\n    const id = randomId();\n\n    context.addChatSuggestionConfiguration(id, {\n      instructions,\n      minSuggestions,\n      maxSuggestions,\n      className,\n    });\n\n    return () => {\n      context.removeChatSuggestionConfiguration(id);\n    };\n  }, [...dependencies, instructions, minSuggestions, maxSuggestions, className]);\n}\n"],"mappings":";AA2DA,SAAS,iBAAiB;AAC1B,SAAS,yBAAyB;AAClC,SAAS,gBAAgB;AAuBlB,SAAS,0BACd;AAAA,EACE;AAAA,EACA;AAAA,EACA,iBAAiB;AAAA,EACjB,iBAAiB;AACnB,GACA,eAAsB,CAAC,GACvB;AACA,QAAM,UAAU,kBAAkB;AAElC,YAAU,MAAM;AACd,UAAM,KAAK,SAAS;AAEpB,YAAQ,+BAA+B,IAAI;AAAA,MACzC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,WAAO,MAAM;AACX,cAAQ,kCAAkC,EAAE;AAAA,IAC9C;AAAA,EACF,GAAG,CAAC,GAAG,cAAc,cAAc,gBAAgB,gBAAgB,SAAS,CAAC;AAC/E;","names":[]}

package/dist/chunk-RJ54B6VE.mjs

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

package/dist/hooks/use-copilot-suggestions.d.ts

@@ -1,79 +0,0 @@
-import { Parameter, MappedParameterTypes } from '@copilotkit/shared';
-
-/**
- * <Callout type="warning">
- *   useCopilotSuggestions is experimental. The interface is not final and
- *   can change without notice.
- * </Callout>
- *
- * `useCopilotSuggestions` is a React hook that provides auto-suggestions that can be added to any
- * UI component.
- *
- * ## Usage
- *
- * ### Install Dependencies
- *
- * This component is part of the [@copilotkit/react-ui](https://npmjs.com/package/@copilotkit/react-ui) package.
- *
- * ```shell npm2yarn \"@copilotkit/react-ui"\
- * npm install @copilotkit/react-core @copilotkit/react-ui
- * ```
- *
- * ### Simple Usage
- *
- * ```tsx
- * TODO
- * ```
- *
- * ### Dependency Management
- *
- * ```tsx
- * TODO
- * }
- * ```
- *
- * In the example above, the suggestions are generated based on the given instructions.
- * The hook monitors `appState`, and updates suggestions accordingly whenever it changes.
- *
- * ### Behavior and Lifecycle
- *
- * The hook registers the configuration with the chat context upon component mount and
- * removes it on unmount, ensuring a clean and efficient lifecycle management.
- */
-
-interface UseCopilotSuggestionsConfiguration<T extends Parameter[] = []> {
-    /**
-     * A prompt or instructions for the GPT to generate suggestions.
-     */
-    instructions?: string;
-    /**
-     * The data to pass to the suggestions.
-     */
-    parameters: T;
-    /**
-     * The current value of the parameter.
-     */
-    value?: Partial<MappedParameterTypes<T>>;
-    /**
-     * Whether the suggestions are enabled.
-     * @default true
-     */
-    enabled?: boolean;
-    /**
-     * The debounce time in milliseconds.
-     * @default 1000
-     */
-    debounceTime?: number;
-}
-type SuggestionsResult<T extends Parameter[]> = {
-    suggestions: undefined;
-    isAvailable: false;
-    isLoading: boolean;
-} | {
-    suggestions: MappedParameterTypes<T>;
-    isAvailable: true;
-    isLoading: boolean;
-};
-declare function useCopilotSuggestions<const T extends Parameter[]>({ instructions, parameters, value, enabled, debounceTime, }: UseCopilotSuggestionsConfiguration<T>, dependencies?: any[]): SuggestionsResult<T>;
-
-export { SuggestionsResult, UseCopilotSuggestionsConfiguration, useCopilotSuggestions };

package/dist/hooks/use-copilot-suggestions.js

@@ -1,160 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-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/hooks/use-copilot-suggestions.ts
-var use_copilot_suggestions_exports = {};
-__export(use_copilot_suggestions_exports, {
-  useCopilotSuggestions: () => useCopilotSuggestions
-});
-module.exports = __toCommonJS(use_copilot_suggestions_exports);
-var import_react = require("react");
-var import_react_core = require("@copilotkit/react-core");
-var import_runtime_client_gql = require("@copilotkit/runtime-client-gql");
-function useCopilotSuggestions({
-  instructions,
-  parameters,
-  value,
-  enabled = true,
-  debounceTime = 1e3
-}, dependencies = []) {
-  const suggestionsAbortControllerRef = (0, import_react.useRef)(null);
-  const debounceTimerRef = (0, import_react.useRef)();
-  const [suggestions, setSuggestions] = (0, import_react.useState)({
-    suggestions: void 0,
-    isAvailable: false,
-    isLoading: false
-  });
-  const isFirstRunRef = (0, import_react.useRef)(true);
-  const abortSuggestions = (0, import_react.useCallback)(() => {
-    var _a;
-    (_a = suggestionsAbortControllerRef.current) == null ? void 0 : _a.abort();
-    suggestionsAbortControllerRef.current = null;
-  }, []);
-  const generalContext = (0, import_react_core.useCopilotContext)();
-  const messagesContext = (0, import_react_core.useCopilotMessagesContext)();
-  const context = __spreadValues(__spreadValues({}, generalContext), messagesContext);
-  (0, import_react.useEffect)(() => {
-    abortSuggestions();
-    if (!enabled) {
-      setSuggestions({ suggestions: void 0, isAvailable: false, isLoading: false });
-      return;
-    }
-    if (JSON.stringify(value) === JSON.stringify(suggestions.suggestions)) {
-      return;
-    }
-    debounceTimerRef.current = setTimeout(
-      () => __async(this, null, function* () {
-        isFirstRunRef.current = false;
-        suggestionsAbortControllerRef.current = new AbortController();
-        setSuggestions(__spreadProps(__spreadValues({}, suggestions), { isLoading: true }));
-        yield reloadSuggestions(
-          context,
-          instructions,
-          parameters,
-          value,
-          suggestionsAbortControllerRef,
-          setSuggestions
-        );
-      }),
-      isFirstRunRef.current === true ? 0 : debounceTime
-    );
-    return () => {
-      clearTimeout(debounceTimerRef.current);
-    };
-  }, [
-    instructions,
-    JSON.stringify(parameters),
-    JSON.stringify(value),
-    enabled,
-    debounceTime,
-    ...dependencies
-  ]);
-  return suggestions;
-}
-function reloadSuggestions(context, instructions, parameters, value, abortControllerRef, setSuggestions) {
-  return __async(this, null, function* () {
-    const abortController = abortControllerRef.current;
-    let fullInstructions = `It's your task to generate suggestions based on the application context.`;
-    if (instructions) {
-      fullInstructions += `
-
-In addition, follow these specific instructions: ${instructions}`;
-    }
-    if (value) {
-      fullInstructions += `
-
-The current value of the parameter is: ${JSON.stringify(value)}.If it makes sense to complete the existing data, i.e. expand string values, add new elements to arrays, etc., do so. Otherwise, generate a new value.`;
-    }
-    yield (0, import_react_core.extract)({
-      context,
-      instructions: instructions || "",
-      data: fullInstructions,
-      parameters,
-      abortSignal: abortController == null ? void 0 : abortController.signal,
-      requestType: import_runtime_client_gql.CopilotRequestType.Task,
-      stream({ args, status }) {
-        if (status === "complete") {
-          setSuggestions({ suggestions: args, isAvailable: true, isLoading: false });
-        }
-      }
-    });
-  });
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  useCopilotSuggestions
-});
-//# sourceMappingURL=use-copilot-suggestions.js.map

package/dist/hooks/use-copilot-suggestions.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../src/hooks/use-copilot-suggestions.ts"],"sourcesContent":["/**\n * <Callout type=\"warning\">\n *   useCopilotSuggestions is experimental. The interface is not final and\n *   can change without notice.\n * </Callout>\n *\n * `useCopilotSuggestions` is a React hook that provides auto-suggestions that can be added to any\n * UI component.\n *\n * ## Usage\n *\n * ### Install Dependencies\n *\n * This component is part of the [@copilotkit/react-ui](https://npmjs.com/package/@copilotkit/react-ui) package.\n *\n * ```shell npm2yarn \\\"@copilotkit/react-ui\"\\\n * npm install @copilotkit/react-core @copilotkit/react-ui\n * ```\n *\n * ### Simple Usage\n *\n * ```tsx\n * TODO\n * ```\n *\n * ### Dependency Management\n *\n * ```tsx\n * TODO\n * }\n * ```\n *\n * In the example above, the suggestions are generated based on the given instructions.\n * The hook monitors `appState`, and updates suggestions accordingly whenever it changes.\n *\n * ### Behavior and Lifecycle\n *\n * The hook registers the configuration with the chat context upon component mount and\n * removes it on unmount, ensuring a clean and efficient lifecycle management.\n */\n\nimport { useEffect, useState, useRef, useCallback } from \"react\";\nimport {\n  CopilotContextParams,\n  CopilotMessagesContextParams,\n  extract,\n  useCopilotContext,\n  useCopilotMessagesContext,\n} from \"@copilotkit/react-core\";\nimport { MappedParameterTypes, Parameter, randomId } from \"@copilotkit/shared\";\nimport { CopilotRequestType } from \"@copilotkit/runtime-client-gql\";\n\nexport interface UseCopilotSuggestionsConfiguration<T extends Parameter[] = []> {\n  /**\n   * A prompt or instructions for the GPT to generate suggestions.\n   */\n  instructions?: string;\n\n  /**\n   * The data to pass to the suggestions.\n   */\n  parameters: T;\n\n  /**\n   * The current value of the parameter.\n   */\n  value?: Partial<MappedParameterTypes<T>>;\n\n  /**\n   * Whether the suggestions are enabled.\n   * @default true\n   */\n  enabled?: boolean;\n\n  /**\n   * The debounce time in milliseconds.\n   * @default 1000\n   */\n  debounceTime?: number;\n}\nexport type SuggestionsResult<T extends Parameter[]> =\n  | { suggestions: undefined; isAvailable: false; isLoading: boolean }\n  | { suggestions: MappedParameterTypes<T>; isAvailable: true; isLoading: boolean };\n\nexport function useCopilotSuggestions<const T extends Parameter[]>(\n  {\n    instructions,\n    parameters,\n    value,\n    enabled = true,\n    debounceTime = 1000,\n  }: UseCopilotSuggestionsConfiguration<T>,\n  dependencies: any[] = [],\n): SuggestionsResult<T> {\n  const suggestionsAbortControllerRef = useRef<AbortController | null>(null);\n  const debounceTimerRef = useRef<any>();\n  const [suggestions, setSuggestions] = useState<SuggestionsResult<T>>({\n    suggestions: undefined,\n    isAvailable: false,\n    isLoading: false,\n  });\n  const isFirstRunRef = useRef(true);\n\n  const abortSuggestions = useCallback(() => {\n    suggestionsAbortControllerRef.current?.abort();\n    suggestionsAbortControllerRef.current = null;\n  }, []);\n\n  const generalContext = useCopilotContext();\n  const messagesContext = useCopilotMessagesContext();\n  const context = { ...generalContext, ...messagesContext };\n\n  useEffect(() => {\n    abortSuggestions();\n    if (!enabled) {\n      setSuggestions({ suggestions: undefined, isAvailable: false, isLoading: false });\n      return;\n    }\n\n    // if value is the same as the last suggestions, don't reload\n    if (JSON.stringify(value) === JSON.stringify(suggestions.suggestions)) {\n      return;\n    }\n\n    debounceTimerRef.current = setTimeout(\n      async () => {\n        isFirstRunRef.current = false;\n        suggestionsAbortControllerRef.current = new AbortController();\n        setSuggestions({ ...suggestions, isLoading: true });\n        await reloadSuggestions(\n          context,\n          instructions,\n          parameters,\n          value,\n          suggestionsAbortControllerRef,\n          setSuggestions,\n        );\n      },\n      isFirstRunRef.current === true ? 0 : debounceTime,\n    );\n\n    return () => {\n      clearTimeout(debounceTimerRef.current);\n    };\n  }, [\n    instructions,\n    JSON.stringify(parameters),\n    JSON.stringify(value),\n    enabled,\n    debounceTime,\n    ...dependencies,\n  ]);\n\n  return suggestions;\n}\n\nasync function reloadSuggestions(\n  context: CopilotContextParams & CopilotMessagesContextParams,\n  instructions: string | undefined,\n  parameters: Parameter[],\n  value: any,\n  abortControllerRef: React.MutableRefObject<AbortController | null>,\n  setSuggestions: (suggestions: any) => void,\n) {\n  const abortController = abortControllerRef.current;\n  let fullInstructions = `It's your task to generate suggestions based on the application context.`;\n  if (instructions) {\n    fullInstructions += `\\n\\nIn addition, follow these specific instructions: ${instructions}`;\n  }\n  if (value) {\n    fullInstructions +=\n      `\\n\\nThe current value of the parameter is: ${JSON.stringify(value)}.` +\n      `If it makes sense to complete the existing data, i.e. expand string values, add new elements to arrays, etc., do so. ` +\n      `Otherwise, generate a new value.`;\n  }\n\n  await extract({\n    context,\n    instructions: instructions || \"\",\n    data: fullInstructions,\n    parameters,\n    abortSignal: abortController?.signal,\n    requestType: CopilotRequestType.Task,\n    stream({ args, status }) {\n      if (status === \"complete\") {\n        setSuggestions({ suggestions: args, isAvailable: true, isLoading: false });\n      }\n    },\n  });\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAyCA,mBAAyD;AACzD,wBAMO;AAEP,gCAAmC;AAkC5B,SAAS,sBACd;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA,UAAU;AAAA,EACV,eAAe;AACjB,GACA,eAAsB,CAAC,GACD;AACtB,QAAM,oCAAgC,qBAA+B,IAAI;AACzE,QAAM,uBAAmB,qBAAY;AACrC,QAAM,CAAC,aAAa,cAAc,QAAI,uBAA+B;AAAA,IACnE,aAAa;AAAA,IACb,aAAa;AAAA,IACb,WAAW;AAAA,EACb,CAAC;AACD,QAAM,oBAAgB,qBAAO,IAAI;AAEjC,QAAM,uBAAmB,0BAAY,MAAM;AAvG7C;AAwGI,wCAA8B,YAA9B,mBAAuC;AACvC,kCAA8B,UAAU;AAAA,EAC1C,GAAG,CAAC,CAAC;AAEL,QAAM,qBAAiB,qCAAkB;AACzC,QAAM,sBAAkB,6CAA0B;AAClD,QAAM,UAAU,kCAAK,iBAAmB;AAExC,8BAAU,MAAM;AACd,qBAAiB;AACjB,QAAI,CAAC,SAAS;AACZ,qBAAe,EAAE,aAAa,QAAW,aAAa,OAAO,WAAW,MAAM,CAAC;AAC/E;AAAA,IACF;AAGA,QAAI,KAAK,UAAU,KAAK,MAAM,KAAK,UAAU,YAAY,WAAW,GAAG;AACrE;AAAA,IACF;AAEA,qBAAiB,UAAU;AAAA,MACzB,MAAY;AACV,sBAAc,UAAU;AACxB,sCAA8B,UAAU,IAAI,gBAAgB;AAC5D,uBAAe,iCAAK,cAAL,EAAkB,WAAW,KAAK,EAAC;AAClD,cAAM;AAAA,UACJ;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAAA,MACA,cAAc,YAAY,OAAO,IAAI;AAAA,IACvC;AAEA,WAAO,MAAM;AACX,mBAAa,iBAAiB,OAAO;AAAA,IACvC;AAAA,EACF,GAAG;AAAA,IACD;AAAA,IACA,KAAK,UAAU,UAAU;AAAA,IACzB,KAAK,UAAU,KAAK;AAAA,IACpB;AAAA,IACA;AAAA,IACA,GAAG;AAAA,EACL,CAAC;AAED,SAAO;AACT;AAEA,SAAe,kBACb,SACA,cACA,YACA,OACA,oBACA,gBACA;AAAA;AACA,UAAM,kBAAkB,mBAAmB;AAC3C,QAAI,mBAAmB;AACvB,QAAI,cAAc;AAChB,0BAAoB;AAAA;AAAA,mDAAwD;AAAA,IAC9E;AACA,QAAI,OAAO;AACT,0BACE;AAAA;AAAA,yCAA8C,KAAK,UAAU,KAAK;AAAA,IAGtE;AAEA,cAAM,2BAAQ;AAAA,MACZ;AAAA,MACA,cAAc,gBAAgB;AAAA,MAC9B,MAAM;AAAA,MACN;AAAA,MACA,aAAa,mDAAiB;AAAA,MAC9B,aAAa,6CAAmB;AAAA,MAChC,OAAO,EAAE,MAAM,OAAO,GAAG;AACvB,YAAI,WAAW,YAAY;AACzB,yBAAe,EAAE,aAAa,MAAM,aAAa,MAAM,WAAW,MAAM,CAAC;AAAA,QAC3E;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA;","names":[]}

package/dist/hooks/use-copilot-suggestions.mjs

@@ -1,8 +0,0 @@
-import {
-  useCopilotSuggestions
-} from "../chunk-G7A3YV3L.mjs";
-import "../chunk-MRXNTQOX.mjs";
-export {
-  useCopilotSuggestions
-};
-//# sourceMappingURL=use-copilot-suggestions.mjs.map

package/dist/hooks/use-copilot-suggestions.mjs.map

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