@copilotkit/react-textarea 1.51.4 → 1.51.5-next.1

package/dist/index.d.cts

@@ -0,0 +1,318 @@
+import React$1, { TextareaHTMLAttributes } from "react";
+import { DocumentPointer } from "@copilotkit/react-core";
+import { Message } from "@copilotkit/runtime-client-gql";
+
+//#region src/types/base/autosuggestions-bare-function.d.ts
+interface InsertionEditorState {
+  textBeforeCursor: string;
+  textAfterCursor: string;
+}
+interface EditingEditorState extends InsertionEditorState {
+  selectedText: string;
+}
+type AutosuggestionsBareFunction = (editorState: InsertionEditorState, abortSignal: AbortSignal) => Promise<string>;
+type Generator_InsertionOrEditingSuggestion = (editorState: EditingEditorState, prompt: string, documents: DocumentPointer[], abortSignal: AbortSignal) => Promise<ReadableStream<string>>;
+interface InsertionEditorApiConfig {
+  insertionOrEditingFunction: Generator_InsertionOrEditingSuggestion;
+}
+interface BaseCopilotTextareaApiConfig extends InsertionEditorApiConfig {
+  autosuggestionsFunction: AutosuggestionsBareFunction;
+}
+//#endregion
+//#region src/types/base/base-autosuggestions-config.d.ts
+/**
+ * @interface BaseAutosuggestionsConfig
+ *
+ * @property {string} textareaPurpose - The purpose of the textarea. This is used to guide the autosuggestions.
+ *
+ * @property {string[]} contextCategories - The categories of context to consider when providing autosuggestions.
+ *
+ * @property {number} debounceTime - The amount of time (in milliseconds) to wait before triggering autosuggestions after the user has stopped typing.
+ *
+ * @property {BaseCopilotTextareaApiConfig} apiConfig - The configuration for the API that provides the autosuggestions.
+ *
+ * @property {boolean} disableWhenEmpty - Whether to disable autosuggestions when the textarea is empty.
+ *
+ * @property {boolean} disabled - Whether to disable autosuggestions entirely.
+ *
+ * @property {boolean} temporarilyDisableWhenMovingCursorWithoutChangingText - Whether to temporarily disable autosuggestions when the user moves the cursor without changing the text.
+ *
+ * @property {boolean} temporarilyDisableNotTrustedEvents - Temporarily disable autosuggestions after change event from non-trusted sources (like text insertion from autocomplete plugins)
+ *
+ * @property {(event: React.KeyboardEvent<HTMLDivElement>) => boolean} shouldAcceptAutosuggestionOnKeyPress - A function that determines whether to accept the current autosuggestion based on a key press event. By default, the Tab key is used to accept the autosuggestion. Example code:
+ *
+ * ```typescript
+ * const defaultShouldAcceptAutosuggestionOnKeyPress =  (event: React.KeyboardEvent<HTMLDivElement>) => {
+ *   // if tab, accept the autosuggestion
+ *   if (event.key === "Tab") {
+ *     return true;
+ *   }
+ *   return false;
+ * }
+ * ```
+ *
+ * @property {(event: React.TouchEvent<HTMLDivElement>) => boolean} shouldAcceptAutosuggestionOnTouch - A function that determines whether to accept the current autosuggestion based on a mobile touch event. By default, the touching the end of a suggestion will accept it. Example code:
+ *
+ * ```typescript
+ * const shouldAcceptAutosuggestionOnTouch =  (event: React.TouchEvent<HTMLDivElement>) => {
+ *   // if tab, accept the autosuggestion
+ *   if (event.type === "touchstart") {
+ *     return true;
+ *   }
+ *   return false;
+ * }
+ * ```
+ *
+ * @property {(event: React.KeyboardEvent<HTMLDivElement>) => boolean} shouldToggleHoveringEditorOnKeyPress - A function that determines whether to toggle the hovering editor based on a key press event. By default, the Command + K key combination is used to toggle the hovering editor. Example code:
+ *
+ * ```typescript
+ * const defaultShouldToggleHoveringEditorOnKeyPress =  (event: React.KeyboardEvent<HTMLDivElement>) => {
+ *   // if command-k, toggle the hovering editor
+ *   if (event.key === "k" && event.metaKey) {
+ *     return true;
+ *   }
+ *   return false;
+ * }
+ * ```
+ */
+interface BaseAutosuggestionsConfig {
+  textareaPurpose: string;
+  contextCategories: string[];
+  debounceTime: number;
+  apiConfig: BaseCopilotTextareaApiConfig;
+  disableWhenEmpty: boolean;
+  disabled: boolean;
+  temporarilyDisableWhenMovingCursorWithoutChangingText: boolean;
+  temporarilyDisableNotTrustedEvents: boolean;
+  shouldAcceptAutosuggestionOnKeyPress: (event: React.KeyboardEvent<HTMLDivElement>) => boolean;
+  shouldAcceptAutosuggestionOnTouch: (event: React.TouchEvent<HTMLDivElement>) => boolean;
+  shouldToggleHoveringEditorOnKeyPress: (event: React.KeyboardEvent<HTMLDivElement>, shortcut: string) => boolean;
+}
+/**
+ * Default configuration for the BaseAutosuggestions.
+ *
+ * @property {number} debounceTime - The amount of time to wait before triggering the autosuggestions API call.
+ * @property {string[]} contextCategories - The categories to use for context when making the autosuggestions API call.
+ * @property {boolean} disableWhenEmpty - Whether to disable the autosuggestions when the textarea is empty.
+ * @property {boolean} disabled - Whether to disable the autosuggestions feature entirely.
+ * @property {boolean} temporarilyDisableWhenMovingCursorWithoutChangingText - Whether to temporarily disable the autosuggestions when the cursor is moved without changing the text.
+ * @property {boolean} temporarilyDisableNotTrustedEvents - Temporarily disable the autosuggestions after change event from non-trusted sources (like text insertion from autocomplete plugins)
+ * @property {(event: React.KeyboardEvent<HTMLDivElement>) => boolean} shouldToggleHoveringEditorOnKeyPress - A function that determines whether to toggle the hovering editor based on a key press event.
+ * @property {(event: React.KeyboardEvent<HTMLDivElement>) => boolean} shouldAcceptAutosuggestionOnKeyPress - A function that determines whether to accept the autosuggestion based on a key press event.
+ * @property {() => boolean} defaultShouldAcceptAutosuggestionOnTouch - A function that determines whether to accept the autosuggestion based on a mobile touch event.
+ */
+declare const defaultBaseAutosuggestionsConfig: Omit<BaseAutosuggestionsConfig, "textareaPurpose" | "apiConfig">;
+//#endregion
+//#region src/types/base/base-copilot-textarea-props.d.ts
+/**
+ * `BaseCopilotTextareaProps` defines the properties for the `BaseCopilotTextarea` component.
+ */
+interface BaseCopilotTextareaProps extends Omit<TextareaHTMLAttributes<HTMLDivElement>, "onChange"> {
+  /**
+   * Determines whether the CopilotKit branding should be disabled. Default is `false`.
+   */
+  disableBranding?: boolean;
+  /**
+   * Specifies the CSS styles to apply to the placeholder text.
+   */
+  placeholderStyle?: React.CSSProperties;
+  /**
+   * Specifies the CSS styles to apply to the suggestions list.
+   */
+  suggestionsStyle?: React.CSSProperties;
+  /**
+   * A class name to apply to the editor popover window.
+   */
+  hoverMenuClassname?: string;
+  /**
+   * The initial value of the textarea. Can be controlled via `onValueChange`.
+   */
+  value?: string;
+  /**
+   * Callback invoked when the value of the textarea changes.
+   */
+  onValueChange?: (value: string) => void;
+  /**
+   * Callback invoked when a `change` event is triggered on the textarea element.
+   */
+  onChange?: (event: React.ChangeEvent<HTMLTextAreaElement>) => void;
+  /**
+   * The shortcut to use to open the editor popover window. Default is `"Cmd-k"`.
+   */
+  shortcut?: string;
+  /**
+   * Configuration settings for the autosuggestions feature.
+   * Includes a mandatory `textareaPurpose` to guide the autosuggestions.
+   */
+  baseAutosuggestionsConfig: Partial<BaseAutosuggestionsConfig> & {
+    textareaPurpose: string;
+    apiConfig: BaseCopilotTextareaApiConfig;
+  };
+}
+//#endregion
+//#region src/components/base-copilot-textarea/base-copilot-textarea.d.ts
+/**
+ * Purpose: to be used as the `ref` type for `CopilotTextarea` and `BaseCopilotTextarea`.
+ *
+ * This interface extends `HTMLElement`, and is the subset of `HTMLTextAreaElement` that "actually matters".
+ * It provides the core functionality that consumers of `HTMLTextAreaElement` need 99.9% of the time:
+ * - `value`: the current value of the textarea
+ * - `focus`: make the textarea focused
+ * - `blur`: make the textarea unfocused
+ */
+interface HTMLCopilotTextAreaElement$1 extends HTMLElement {
+  /**
+   * The current value of the textarea.
+   */
+  value: string;
+  /**
+   * focus on the textarea
+   */
+  focus: () => void;
+  /**
+   * unfocus the textarea.
+   *
+   * Called `blur` for syntactic compatibility with `HTMLTextAreaElement`.
+   */
+  blur: () => void;
+}
+/**
+ * Not intended for direct use. Use CopilotTextarea instead.
+ *
+ * The `BaseCopilotTextarea` includes the basic UX component,
+ * without the business logic / AI logic that makes the content useful and coherent.
+ *
+ * It is useful if you want to build your own backend, with fully custom business logic
+ * for figuring out which contnet to fill in.
+ */
+declare const BaseCopilotTextarea: React$1.ForwardRefExoticComponent<BaseCopilotTextareaProps & React$1.RefAttributes<HTMLCopilotTextAreaElement$1>>;
+//#endregion
+//#region src/types/html-copilot-textarea-element.d.ts
+interface HTMLCopilotTextAreaElement extends HTMLElement {
+  value: string;
+  focus: () => void;
+  blur: () => void;
+}
+//#endregion
+//#region src/types/autosuggestions-config/subtypes/make-system-prompt.d.ts
+type MakeSystemPrompt = (textareaPurpose: string, contextString: string) => string;
+//#endregion
+//#region src/types/autosuggestions-config/suggestions-api-config.d.ts
+interface SuggestionsApiConfig {
+  makeSystemPrompt: MakeSystemPrompt;
+  fewShotMessages: Message[];
+  maxTokens?: number;
+  stop?: string[];
+  temperature?: number;
+}
+//#endregion
+//#region src/types/autosuggestions-config/insertions-api-config.d.ts
+interface InsertionsApiConfig {
+  makeSystemPrompt: MakeSystemPrompt;
+  fewShotMessages: Message[];
+  forwardedParams: {
+    [key: string]: any;
+  } | undefined;
+}
+//#endregion
+//#region src/types/autosuggestions-config/editing-api-config.d.ts
+interface EditingApiConfig {
+  makeSystemPrompt: MakeSystemPrompt;
+  fewShotMessages: Message[];
+  forwardedParams: {
+    [key: string]: any;
+  } | undefined;
+}
+//#endregion
+//#region src/types/autosuggestions-config/autosuggestions-config.d.ts
+interface AutosuggestionsConfig extends Omit<BaseAutosuggestionsConfig, "apiConfig"> {
+  contextCategories: string[];
+  chatApiConfigs: {
+    suggestionsApiConfig: SuggestionsApiConfig;
+    insertionApiConfig: InsertionsApiConfig;
+    editingApiConfig: EditingApiConfig;
+  };
+}
+declare const defaultAutosuggestionsConfig: Omit<AutosuggestionsConfig, "textareaPurpose" | "apiEndpoint">;
+//#endregion
+//#region src/types/autosuggestions-config/autosuggestions-config-user-specified.d.ts
+interface SuggestionsApiConfigUserSpecified extends Partial<SuggestionsApiConfig> {}
+interface InsertionsApiConfigUserSpecified extends Partial<InsertionsApiConfig> {}
+interface AutosuggestionsConfigUserSpecified extends Partial<Omit<AutosuggestionsConfig, "chatApiConfigs" | "textareaPurpose">> {
+  textareaPurpose: string;
+  chatApiConfigs: {
+    suggestionsApiConfig?: SuggestionsApiConfigUserSpecified;
+    insertionApiConfig?: InsertionsApiConfigUserSpecified;
+  };
+}
+//#endregion
+//#region src/components/copilot-textarea/copilot-textarea.d.ts
+interface CopilotTextareaProps extends Omit<BaseCopilotTextareaProps, "baseAutosuggestionsConfig"> {
+  /**
+   * Configuration settings for the autosuggestions feature.
+   * For full reference, [check the interface on GitHub](https://github.com/CopilotKit/CopilotKit/blob/main/src/v1.x/packages/react-textarea/src/types/base/base-copilot-textarea-props.tsx#L8).
+   *
+   * <PropertyReference name="textareaPurpose" type="string" required={true} >
+   *   The purpose of the text area in plain text.
+   *
+   *   Example: *"The body of the email response"*
+   * </PropertyReference>
+   *
+   * <PropertyReference name="chatApiConfigs" type="ChatApiConfigs" >
+   *   The chat API configurations.
+   *
+   *   <strong>NOTE:</strong> You must provide specify at least one of `suggestionsApiConfig` or `insertionApiConfig`.
+   *
+   *   <PropertyReference name="suggestionsApiConfig" type="SuggestionsApiConfig">
+   *       For full reference, please [click here](https://github.com/CopilotKit/CopilotKit/blob/main/src/v1.x/packages/react-textarea/src/types/autosuggestions-config/suggestions-api-config.tsx#L4).
+   *   </PropertyReference>
+   *   <PropertyReference name="insertionApiConfig" type="InsertionApiConfig">
+   *       For full reference, please [click here](https://github.com/CopilotKit/CopilotKit/blob/main/src/v1.x/packages/react-textarea/src/types/autosuggestions-config/insertions-api-config.tsx#L4).
+   *   </PropertyReference>
+   * </PropertyReference>
+   *
+   * <PropertyReference name="disabled" type="boolean" >
+   *   Whether the textarea is disabled.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="disableBranding" type="boolean" >
+   *   Whether to disable the CopilotKit branding.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="placeholderStyle" type="React.CSSProperties" >
+   *   Specifies the CSS styles to apply to the placeholder text.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="suggestionsStyle" type="React.CSSProperties" >
+   *   Specifies the CSS styles to apply to the suggestions list.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="hoverMenuClassname" type="string" >
+   *   A class name to apply to the editor popover window.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="value" type="string" >
+   *   The initial value of the textarea. Can be controlled via `onValueChange`.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="onValueChange" type="(value: string) => void" >
+   *   Callback invoked when the value of the textarea changes.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="onChange" type="(event: React.ChangeEvent<HTMLTextAreaElement>) => void" >
+   *   Callback invoked when a `change` event is triggered on the textarea element.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="shortcut" type="string" >
+   *   The shortcut to use to open the editor popover window. Default is `"Cmd-k"`.
+   * </PropertyReference>
+   */
+  autosuggestionsConfig: AutosuggestionsConfigUserSpecified;
+}
+/**
+ * A copilot textarea that uses the standard autosuggestions function.
+ */
+declare const CopilotTextarea: React$1.ForwardRefExoticComponent<CopilotTextareaProps & React$1.RefAttributes<HTMLCopilotTextAreaElement>>;
+//#endregion
+export { type AutosuggestionsBareFunction, type AutosuggestionsConfig, type AutosuggestionsConfigUserSpecified, type BaseAutosuggestionsConfig, BaseCopilotTextarea, type BaseCopilotTextareaProps, CopilotTextarea, type CopilotTextareaProps, HTMLCopilotTextAreaElement, type InsertionsApiConfigUserSpecified, type MakeSystemPrompt, type SuggestionsApiConfigUserSpecified, defaultAutosuggestionsConfig, defaultBaseAutosuggestionsConfig };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types/base/autosuggestions-bare-function.ts","../src/types/base/base-autosuggestions-config.tsx","../src/types/base/base-copilot-textarea-props.tsx","../src/components/base-copilot-textarea/base-copilot-textarea.tsx","../src/types/html-copilot-textarea-element.ts","../src/types/autosuggestions-config/subtypes/make-system-prompt.ts","../src/types/autosuggestions-config/suggestions-api-config.tsx","../src/types/autosuggestions-config/insertions-api-config.tsx","../src/types/autosuggestions-config/editing-api-config.tsx","../src/types/autosuggestions-config/autosuggestions-config.tsx","../src/types/autosuggestions-config/autosuggestions-config-user-specified.tsx","../src/components/copilot-textarea/copilot-textarea.tsx"],"mappings":";;;;;UAEiB,oBAAA;EACf,gBAAA;EACA,eAAA;AAAA;AAAA,UAGe,kBAAA,SAA2B,oBAAA;EAC1C,YAAA;AAAA;AAAA,KAGU,2BAAA,IACV,WAAA,EAAa,oBAAA,EACb,WAAA,EAAa,WAAA,KACV,OAAA;AAAA,KAEO,sCAAA,IACV,WAAA,EAAa,kBAAA,EACb,MAAA,UACA,SAAA,EAAW,eAAA,IACX,WAAA,EAAa,WAAA,KACV,OAAA,CAAQ,cAAA;AAAA,UAEI,wBAAA;EACf,0BAAA,EAA4B,sCAAA;AAAA;AAAA,UAGb,4BAAA,SAAqC,wBAAA;EACpD,uBAAA,EAAyB,2BAAA;AAAA;;;;;;;AA1B3B;;;;;AAKA;;;;;AAIA;;;;;;;;;;;;;;;AAKA;;;;;;;;;;;;;;;;;;;;;AAOA;;;;;UCoCiB,yBAAA;EACf,eAAA;EACA,iBAAA;EACA,YAAA;EACA,SAAA,EAAW,4BAAA;EAEX,gBAAA;EACA,QAAA;EACA,qDAAA;EACA,kCAAA;EACA,oCAAA,GACE,KAAA,EAAO,KAAA,CAAM,aAAA,CAAc,cAAA;EAE7B,iCAAA,GACE,KAAA,EAAO,KAAA,CAAM,UAAA,CAAW,cAAA;EAE1B,oCAAA,GACE,KAAA,EAAO,KAAA,CAAM,aAAA,CAAc,cAAA,GAC3B,QAAA;AAAA;;;;;;;;;;;;;;cAyCS,gCAAA,EAAkC,IAAA,CAC7C,yBAAA;;;;;ADrHF;UEKiB,wBAAA,SAAiC,IAAA,CAChD,sBAAA,CAAuB,cAAA;;;;EAMvB,eAAA;EFPkC;;;EEYlC,gBAAA,GAAmB,KAAA,CAAM,aAAA;EFRf;;;EEaV,gBAAA,GAAmB,KAAA,CAAM,aAAA;EFXZ;;;EEgBb,kBAAA;EFjBa;;;EEsBb,KAAA;EFpBG;;;EEyBH,aAAA,IAAiB,KAAA;EFvB+B;;;EE4BhD,QAAA,IAAY,KAAA,EAAO,KAAA,CAAM,WAAA,CAAY,mBAAA;EFxBxB;;;EE6Bb,QAAA;EF5BU;;;;EEkCV,yBAAA,EAA2B,OAAA,CAAQ,yBAAA;IACjC,eAAA;IACA,SAAA,EAAW,4BAAA;EAAA;AAAA;;;;;AFvDf;;;;;AAKA;;UGiCiB,4BAAA,SAAmC,WAAA;EHjCR;;AAI5C;EGiCE,KAAA;;;;EAKA,KAAA;EHnCU;;;;;EG0CV,IAAA;AAAA;;;AHxCF;;;;;;;cGoDa,mBAAA,EAAmB,OAAA,CAAA,yBAAA,CAAA,wBAAA,GAAA,OAAA,CAAA,aAAA,CAAA,4BAAA;;;UCpEf,0BAAA,SAAmC,WAAA;EAClD,KAAA;EACA,KAAA;EACA,IAAA;AAAA;;;KCHU,gBAAA,IACV,eAAA,UACA,aAAA;;;UCCe,oBAAA;EACf,gBAAA,EAAkB,gBAAA;EAClB,eAAA,EAAiB,OAAA;EACjB,SAAA;EACA,IAAA;EACA,WAAA;AAAA;;;UCLe,mBAAA;EACf,gBAAA,EAAkB,gBAAA;EAClB,eAAA,EAAiB,OAAA;EACjB,eAAA;IAAA,CAAoB,GAAA;EAAA;AAAA;;;UCHL,gBAAA;EACf,gBAAA,EAAkB,gBAAA;EAClB,eAAA,EAAiB,OAAA;EACjB,eAAA;IAAA,CAAoB,GAAA;EAAA;AAAA;;;UCeL,qBAAA,SAA8B,IAAA,CAC7C,yBAAA;EAGA,iBAAA;EACA,cAAA;IACE,oBAAA,EAAsB,oBAAA;IACtB,kBAAA,EAAoB,mBAAA;IACpB,gBAAA,EAAkB,gBAAA;EAAA;AAAA;AAAA,cAIT,4BAAA,EAA8B,IAAA,CACzC,qBAAA;;;UC7Be,iCAAA,SAA0C,OAAA,CAAQ,oBAAA;AAAA,UAGlD,gCAAA,SAAyC,OAAA,CAAQ,mBAAA;AAAA,UAGjD,kCAAA,SAA2C,OAAA,CAC1D,IAAA,CAAK,qBAAA;EAEL,eAAA;EACA,cAAA;IACE,oBAAA,GAAuB,iCAAA;IACvB,kBAAA,GAAqB,gCAAA;EAAA;AAAA;;;UCsFR,oBAAA,SAA6B,IAAA,CAC5C,wBAAA;EVlCE;;;;;;;;;;;;;;AAgDJ;;;;;;;;AC/GA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ES+JE,qBAAA,EAAuB,kCAAA;AAAA;;;;cAMZ,eAAA,EAAe,OAAA,CAAA,yBAAA,CAAA,oBAAA,GAAA,OAAA,CAAA,aAAA,CAAA,0BAAA"}

package/dist/index.d.mts

@@ -0,0 +1,318 @@
+import React$1, { TextareaHTMLAttributes } from "react";
+import { DocumentPointer } from "@copilotkit/react-core";
+import { Message } from "@copilotkit/runtime-client-gql";
+
+//#region src/types/base/autosuggestions-bare-function.d.ts
+interface InsertionEditorState {
+  textBeforeCursor: string;
+  textAfterCursor: string;
+}
+interface EditingEditorState extends InsertionEditorState {
+  selectedText: string;
+}
+type AutosuggestionsBareFunction = (editorState: InsertionEditorState, abortSignal: AbortSignal) => Promise<string>;
+type Generator_InsertionOrEditingSuggestion = (editorState: EditingEditorState, prompt: string, documents: DocumentPointer[], abortSignal: AbortSignal) => Promise<ReadableStream<string>>;
+interface InsertionEditorApiConfig {
+  insertionOrEditingFunction: Generator_InsertionOrEditingSuggestion;
+}
+interface BaseCopilotTextareaApiConfig extends InsertionEditorApiConfig {
+  autosuggestionsFunction: AutosuggestionsBareFunction;
+}
+//#endregion
+//#region src/types/base/base-autosuggestions-config.d.ts
+/**
+ * @interface BaseAutosuggestionsConfig
+ *
+ * @property {string} textareaPurpose - The purpose of the textarea. This is used to guide the autosuggestions.
+ *
+ * @property {string[]} contextCategories - The categories of context to consider when providing autosuggestions.
+ *
+ * @property {number} debounceTime - The amount of time (in milliseconds) to wait before triggering autosuggestions after the user has stopped typing.
+ *
+ * @property {BaseCopilotTextareaApiConfig} apiConfig - The configuration for the API that provides the autosuggestions.
+ *
+ * @property {boolean} disableWhenEmpty - Whether to disable autosuggestions when the textarea is empty.
+ *
+ * @property {boolean} disabled - Whether to disable autosuggestions entirely.
+ *
+ * @property {boolean} temporarilyDisableWhenMovingCursorWithoutChangingText - Whether to temporarily disable autosuggestions when the user moves the cursor without changing the text.
+ *
+ * @property {boolean} temporarilyDisableNotTrustedEvents - Temporarily disable autosuggestions after change event from non-trusted sources (like text insertion from autocomplete plugins)
+ *
+ * @property {(event: React.KeyboardEvent<HTMLDivElement>) => boolean} shouldAcceptAutosuggestionOnKeyPress - A function that determines whether to accept the current autosuggestion based on a key press event. By default, the Tab key is used to accept the autosuggestion. Example code:
+ *
+ * ```typescript
+ * const defaultShouldAcceptAutosuggestionOnKeyPress =  (event: React.KeyboardEvent<HTMLDivElement>) => {
+ *   // if tab, accept the autosuggestion
+ *   if (event.key === "Tab") {
+ *     return true;
+ *   }
+ *   return false;
+ * }
+ * ```
+ *
+ * @property {(event: React.TouchEvent<HTMLDivElement>) => boolean} shouldAcceptAutosuggestionOnTouch - A function that determines whether to accept the current autosuggestion based on a mobile touch event. By default, the touching the end of a suggestion will accept it. Example code:
+ *
+ * ```typescript
+ * const shouldAcceptAutosuggestionOnTouch =  (event: React.TouchEvent<HTMLDivElement>) => {
+ *   // if tab, accept the autosuggestion
+ *   if (event.type === "touchstart") {
+ *     return true;
+ *   }
+ *   return false;
+ * }
+ * ```
+ *
+ * @property {(event: React.KeyboardEvent<HTMLDivElement>) => boolean} shouldToggleHoveringEditorOnKeyPress - A function that determines whether to toggle the hovering editor based on a key press event. By default, the Command + K key combination is used to toggle the hovering editor. Example code:
+ *
+ * ```typescript
+ * const defaultShouldToggleHoveringEditorOnKeyPress =  (event: React.KeyboardEvent<HTMLDivElement>) => {
+ *   // if command-k, toggle the hovering editor
+ *   if (event.key === "k" && event.metaKey) {
+ *     return true;
+ *   }
+ *   return false;
+ * }
+ * ```
+ */
+interface BaseAutosuggestionsConfig {
+  textareaPurpose: string;
+  contextCategories: string[];
+  debounceTime: number;
+  apiConfig: BaseCopilotTextareaApiConfig;
+  disableWhenEmpty: boolean;
+  disabled: boolean;
+  temporarilyDisableWhenMovingCursorWithoutChangingText: boolean;
+  temporarilyDisableNotTrustedEvents: boolean;
+  shouldAcceptAutosuggestionOnKeyPress: (event: React.KeyboardEvent<HTMLDivElement>) => boolean;
+  shouldAcceptAutosuggestionOnTouch: (event: React.TouchEvent<HTMLDivElement>) => boolean;
+  shouldToggleHoveringEditorOnKeyPress: (event: React.KeyboardEvent<HTMLDivElement>, shortcut: string) => boolean;
+}
+/**
+ * Default configuration for the BaseAutosuggestions.
+ *
+ * @property {number} debounceTime - The amount of time to wait before triggering the autosuggestions API call.
+ * @property {string[]} contextCategories - The categories to use for context when making the autosuggestions API call.
+ * @property {boolean} disableWhenEmpty - Whether to disable the autosuggestions when the textarea is empty.
+ * @property {boolean} disabled - Whether to disable the autosuggestions feature entirely.
+ * @property {boolean} temporarilyDisableWhenMovingCursorWithoutChangingText - Whether to temporarily disable the autosuggestions when the cursor is moved without changing the text.
+ * @property {boolean} temporarilyDisableNotTrustedEvents - Temporarily disable the autosuggestions after change event from non-trusted sources (like text insertion from autocomplete plugins)
+ * @property {(event: React.KeyboardEvent<HTMLDivElement>) => boolean} shouldToggleHoveringEditorOnKeyPress - A function that determines whether to toggle the hovering editor based on a key press event.
+ * @property {(event: React.KeyboardEvent<HTMLDivElement>) => boolean} shouldAcceptAutosuggestionOnKeyPress - A function that determines whether to accept the autosuggestion based on a key press event.
+ * @property {() => boolean} defaultShouldAcceptAutosuggestionOnTouch - A function that determines whether to accept the autosuggestion based on a mobile touch event.
+ */
+declare const defaultBaseAutosuggestionsConfig: Omit<BaseAutosuggestionsConfig, "textareaPurpose" | "apiConfig">;
+//#endregion
+//#region src/types/base/base-copilot-textarea-props.d.ts
+/**
+ * `BaseCopilotTextareaProps` defines the properties for the `BaseCopilotTextarea` component.
+ */
+interface BaseCopilotTextareaProps extends Omit<TextareaHTMLAttributes<HTMLDivElement>, "onChange"> {
+  /**
+   * Determines whether the CopilotKit branding should be disabled. Default is `false`.
+   */
+  disableBranding?: boolean;
+  /**
+   * Specifies the CSS styles to apply to the placeholder text.
+   */
+  placeholderStyle?: React.CSSProperties;
+  /**
+   * Specifies the CSS styles to apply to the suggestions list.
+   */
+  suggestionsStyle?: React.CSSProperties;
+  /**
+   * A class name to apply to the editor popover window.
+   */
+  hoverMenuClassname?: string;
+  /**
+   * The initial value of the textarea. Can be controlled via `onValueChange`.
+   */
+  value?: string;
+  /**
+   * Callback invoked when the value of the textarea changes.
+   */
+  onValueChange?: (value: string) => void;
+  /**
+   * Callback invoked when a `change` event is triggered on the textarea element.
+   */
+  onChange?: (event: React.ChangeEvent<HTMLTextAreaElement>) => void;
+  /**
+   * The shortcut to use to open the editor popover window. Default is `"Cmd-k"`.
+   */
+  shortcut?: string;
+  /**
+   * Configuration settings for the autosuggestions feature.
+   * Includes a mandatory `textareaPurpose` to guide the autosuggestions.
+   */
+  baseAutosuggestionsConfig: Partial<BaseAutosuggestionsConfig> & {
+    textareaPurpose: string;
+    apiConfig: BaseCopilotTextareaApiConfig;
+  };
+}
+//#endregion
+//#region src/components/base-copilot-textarea/base-copilot-textarea.d.ts
+/**
+ * Purpose: to be used as the `ref` type for `CopilotTextarea` and `BaseCopilotTextarea`.
+ *
+ * This interface extends `HTMLElement`, and is the subset of `HTMLTextAreaElement` that "actually matters".
+ * It provides the core functionality that consumers of `HTMLTextAreaElement` need 99.9% of the time:
+ * - `value`: the current value of the textarea
+ * - `focus`: make the textarea focused
+ * - `blur`: make the textarea unfocused
+ */
+interface HTMLCopilotTextAreaElement$1 extends HTMLElement {
+  /**
+   * The current value of the textarea.
+   */
+  value: string;
+  /**
+   * focus on the textarea
+   */
+  focus: () => void;
+  /**
+   * unfocus the textarea.
+   *
+   * Called `blur` for syntactic compatibility with `HTMLTextAreaElement`.
+   */
+  blur: () => void;
+}
+/**
+ * Not intended for direct use. Use CopilotTextarea instead.
+ *
+ * The `BaseCopilotTextarea` includes the basic UX component,
+ * without the business logic / AI logic that makes the content useful and coherent.
+ *
+ * It is useful if you want to build your own backend, with fully custom business logic
+ * for figuring out which contnet to fill in.
+ */
+declare const BaseCopilotTextarea: React$1.ForwardRefExoticComponent<BaseCopilotTextareaProps & React$1.RefAttributes<HTMLCopilotTextAreaElement$1>>;
+//#endregion
+//#region src/types/html-copilot-textarea-element.d.ts
+interface HTMLCopilotTextAreaElement extends HTMLElement {
+  value: string;
+  focus: () => void;
+  blur: () => void;
+}
+//#endregion
+//#region src/types/autosuggestions-config/subtypes/make-system-prompt.d.ts
+type MakeSystemPrompt = (textareaPurpose: string, contextString: string) => string;
+//#endregion
+//#region src/types/autosuggestions-config/suggestions-api-config.d.ts
+interface SuggestionsApiConfig {
+  makeSystemPrompt: MakeSystemPrompt;
+  fewShotMessages: Message[];
+  maxTokens?: number;
+  stop?: string[];
+  temperature?: number;
+}
+//#endregion
+//#region src/types/autosuggestions-config/insertions-api-config.d.ts
+interface InsertionsApiConfig {
+  makeSystemPrompt: MakeSystemPrompt;
+  fewShotMessages: Message[];
+  forwardedParams: {
+    [key: string]: any;
+  } | undefined;
+}
+//#endregion
+//#region src/types/autosuggestions-config/editing-api-config.d.ts
+interface EditingApiConfig {
+  makeSystemPrompt: MakeSystemPrompt;
+  fewShotMessages: Message[];
+  forwardedParams: {
+    [key: string]: any;
+  } | undefined;
+}
+//#endregion
+//#region src/types/autosuggestions-config/autosuggestions-config.d.ts
+interface AutosuggestionsConfig extends Omit<BaseAutosuggestionsConfig, "apiConfig"> {
+  contextCategories: string[];
+  chatApiConfigs: {
+    suggestionsApiConfig: SuggestionsApiConfig;
+    insertionApiConfig: InsertionsApiConfig;
+    editingApiConfig: EditingApiConfig;
+  };
+}
+declare const defaultAutosuggestionsConfig: Omit<AutosuggestionsConfig, "textareaPurpose" | "apiEndpoint">;
+//#endregion
+//#region src/types/autosuggestions-config/autosuggestions-config-user-specified.d.ts
+interface SuggestionsApiConfigUserSpecified extends Partial<SuggestionsApiConfig> {}
+interface InsertionsApiConfigUserSpecified extends Partial<InsertionsApiConfig> {}
+interface AutosuggestionsConfigUserSpecified extends Partial<Omit<AutosuggestionsConfig, "chatApiConfigs" | "textareaPurpose">> {
+  textareaPurpose: string;
+  chatApiConfigs: {
+    suggestionsApiConfig?: SuggestionsApiConfigUserSpecified;
+    insertionApiConfig?: InsertionsApiConfigUserSpecified;
+  };
+}
+//#endregion
+//#region src/components/copilot-textarea/copilot-textarea.d.ts
+interface CopilotTextareaProps extends Omit<BaseCopilotTextareaProps, "baseAutosuggestionsConfig"> {
+  /**
+   * Configuration settings for the autosuggestions feature.
+   * For full reference, [check the interface on GitHub](https://github.com/CopilotKit/CopilotKit/blob/main/src/v1.x/packages/react-textarea/src/types/base/base-copilot-textarea-props.tsx#L8).
+   *
+   * <PropertyReference name="textareaPurpose" type="string" required={true} >
+   *   The purpose of the text area in plain text.
+   *
+   *   Example: *"The body of the email response"*
+   * </PropertyReference>
+   *
+   * <PropertyReference name="chatApiConfigs" type="ChatApiConfigs" >
+   *   The chat API configurations.
+   *
+   *   <strong>NOTE:</strong> You must provide specify at least one of `suggestionsApiConfig` or `insertionApiConfig`.
+   *
+   *   <PropertyReference name="suggestionsApiConfig" type="SuggestionsApiConfig">
+   *       For full reference, please [click here](https://github.com/CopilotKit/CopilotKit/blob/main/src/v1.x/packages/react-textarea/src/types/autosuggestions-config/suggestions-api-config.tsx#L4).
+   *   </PropertyReference>
+   *   <PropertyReference name="insertionApiConfig" type="InsertionApiConfig">
+   *       For full reference, please [click here](https://github.com/CopilotKit/CopilotKit/blob/main/src/v1.x/packages/react-textarea/src/types/autosuggestions-config/insertions-api-config.tsx#L4).
+   *   </PropertyReference>
+   * </PropertyReference>
+   *
+   * <PropertyReference name="disabled" type="boolean" >
+   *   Whether the textarea is disabled.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="disableBranding" type="boolean" >
+   *   Whether to disable the CopilotKit branding.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="placeholderStyle" type="React.CSSProperties" >
+   *   Specifies the CSS styles to apply to the placeholder text.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="suggestionsStyle" type="React.CSSProperties" >
+   *   Specifies the CSS styles to apply to the suggestions list.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="hoverMenuClassname" type="string" >
+   *   A class name to apply to the editor popover window.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="value" type="string" >
+   *   The initial value of the textarea. Can be controlled via `onValueChange`.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="onValueChange" type="(value: string) => void" >
+   *   Callback invoked when the value of the textarea changes.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="onChange" type="(event: React.ChangeEvent<HTMLTextAreaElement>) => void" >
+   *   Callback invoked when a `change` event is triggered on the textarea element.
+   * </PropertyReference>
+   *
+   * <PropertyReference name="shortcut" type="string" >
+   *   The shortcut to use to open the editor popover window. Default is `"Cmd-k"`.
+   * </PropertyReference>
+   */
+  autosuggestionsConfig: AutosuggestionsConfigUserSpecified;
+}
+/**
+ * A copilot textarea that uses the standard autosuggestions function.
+ */
+declare const CopilotTextarea: React$1.ForwardRefExoticComponent<CopilotTextareaProps & React$1.RefAttributes<HTMLCopilotTextAreaElement>>;
+//#endregion
+export { type AutosuggestionsBareFunction, type AutosuggestionsConfig, type AutosuggestionsConfigUserSpecified, type BaseAutosuggestionsConfig, BaseCopilotTextarea, type BaseCopilotTextareaProps, CopilotTextarea, type CopilotTextareaProps, HTMLCopilotTextAreaElement, type InsertionsApiConfigUserSpecified, type MakeSystemPrompt, type SuggestionsApiConfigUserSpecified, defaultAutosuggestionsConfig, defaultBaseAutosuggestionsConfig };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types/base/autosuggestions-bare-function.ts","../src/types/base/base-autosuggestions-config.tsx","../src/types/base/base-copilot-textarea-props.tsx","../src/components/base-copilot-textarea/base-copilot-textarea.tsx","../src/types/html-copilot-textarea-element.ts","../src/types/autosuggestions-config/subtypes/make-system-prompt.ts","../src/types/autosuggestions-config/suggestions-api-config.tsx","../src/types/autosuggestions-config/insertions-api-config.tsx","../src/types/autosuggestions-config/editing-api-config.tsx","../src/types/autosuggestions-config/autosuggestions-config.tsx","../src/types/autosuggestions-config/autosuggestions-config-user-specified.tsx","../src/components/copilot-textarea/copilot-textarea.tsx"],"mappings":";;;;;UAEiB,oBAAA;EACf,gBAAA;EACA,eAAA;AAAA;AAAA,UAGe,kBAAA,SAA2B,oBAAA;EAC1C,YAAA;AAAA;AAAA,KAGU,2BAAA,IACV,WAAA,EAAa,oBAAA,EACb,WAAA,EAAa,WAAA,KACV,OAAA;AAAA,KAEO,sCAAA,IACV,WAAA,EAAa,kBAAA,EACb,MAAA,UACA,SAAA,EAAW,eAAA,IACX,WAAA,EAAa,WAAA,KACV,OAAA,CAAQ,cAAA;AAAA,UAEI,wBAAA;EACf,0BAAA,EAA4B,sCAAA;AAAA;AAAA,UAGb,4BAAA,SAAqC,wBAAA;EACpD,uBAAA,EAAyB,2BAAA;AAAA;;;;;;;AA1B3B;;;;;AAKA;;;;;AAIA;;;;;;;;;;;;;;;AAKA;;;;;;;;;;;;;;;;;;;;;AAOA;;;;;UCoCiB,yBAAA;EACf,eAAA;EACA,iBAAA;EACA,YAAA;EACA,SAAA,EAAW,4BAAA;EAEX,gBAAA;EACA,QAAA;EACA,qDAAA;EACA,kCAAA;EACA,oCAAA,GACE,KAAA,EAAO,KAAA,CAAM,aAAA,CAAc,cAAA;EAE7B,iCAAA,GACE,KAAA,EAAO,KAAA,CAAM,UAAA,CAAW,cAAA;EAE1B,oCAAA,GACE,KAAA,EAAO,KAAA,CAAM,aAAA,CAAc,cAAA,GAC3B,QAAA;AAAA;;;;;;;;;;;;;;cAyCS,gCAAA,EAAkC,IAAA,CAC7C,yBAAA;;;;;ADrHF;UEKiB,wBAAA,SAAiC,IAAA,CAChD,sBAAA,CAAuB,cAAA;;;;EAMvB,eAAA;EFPkC;;;EEYlC,gBAAA,GAAmB,KAAA,CAAM,aAAA;EFRf;;;EEaV,gBAAA,GAAmB,KAAA,CAAM,aAAA;EFXZ;;;EEgBb,kBAAA;EFjBa;;;EEsBb,KAAA;EFpBG;;;EEyBH,aAAA,IAAiB,KAAA;EFvB+B;;;EE4BhD,QAAA,IAAY,KAAA,EAAO,KAAA,CAAM,WAAA,CAAY,mBAAA;EFxBxB;;;EE6Bb,QAAA;EF5BU;;;;EEkCV,yBAAA,EAA2B,OAAA,CAAQ,yBAAA;IACjC,eAAA;IACA,SAAA,EAAW,4BAAA;EAAA;AAAA;;;;;AFvDf;;;;;AAKA;;UGiCiB,4BAAA,SAAmC,WAAA;EHjCR;;AAI5C;EGiCE,KAAA;;;;EAKA,KAAA;EHnCU;;;;;EG0CV,IAAA;AAAA;;;AHxCF;;;;;;;cGoDa,mBAAA,EAAmB,OAAA,CAAA,yBAAA,CAAA,wBAAA,GAAA,OAAA,CAAA,aAAA,CAAA,4BAAA;;;UCpEf,0BAAA,SAAmC,WAAA;EAClD,KAAA;EACA,KAAA;EACA,IAAA;AAAA;;;KCHU,gBAAA,IACV,eAAA,UACA,aAAA;;;UCCe,oBAAA;EACf,gBAAA,EAAkB,gBAAA;EAClB,eAAA,EAAiB,OAAA;EACjB,SAAA;EACA,IAAA;EACA,WAAA;AAAA;;;UCLe,mBAAA;EACf,gBAAA,EAAkB,gBAAA;EAClB,eAAA,EAAiB,OAAA;EACjB,eAAA;IAAA,CAAoB,GAAA;EAAA;AAAA;;;UCHL,gBAAA;EACf,gBAAA,EAAkB,gBAAA;EAClB,eAAA,EAAiB,OAAA;EACjB,eAAA;IAAA,CAAoB,GAAA;EAAA;AAAA;;;UCeL,qBAAA,SAA8B,IAAA,CAC7C,yBAAA;EAGA,iBAAA;EACA,cAAA;IACE,oBAAA,EAAsB,oBAAA;IACtB,kBAAA,EAAoB,mBAAA;IACpB,gBAAA,EAAkB,gBAAA;EAAA;AAAA;AAAA,cAIT,4BAAA,EAA8B,IAAA,CACzC,qBAAA;;;UC7Be,iCAAA,SAA0C,OAAA,CAAQ,oBAAA;AAAA,UAGlD,gCAAA,SAAyC,OAAA,CAAQ,mBAAA;AAAA,UAGjD,kCAAA,SAA2C,OAAA,CAC1D,IAAA,CAAK,qBAAA;EAEL,eAAA;EACA,cAAA;IACE,oBAAA,GAAuB,iCAAA;IACvB,kBAAA,GAAqB,gCAAA;EAAA;AAAA;;;UCsFR,oBAAA,SAA6B,IAAA,CAC5C,wBAAA;EVlCE;;;;;;;;;;;;;;AAgDJ;;;;;;;;AC/GA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ES+JE,qBAAA,EAAuB,kCAAA;AAAA;;;;cAMZ,eAAA,EAAe,OAAA,CAAA,yBAAA,CAAA,oBAAA,GAAA,OAAA,CAAA,aAAA,CAAA,0BAAA"}