@copilotkit/react-core 1.10.0-next.12 → 1.10.0-next.13

package/dist/hooks/use-copilot-chat-headless_c.mjs

@@ -1,14 +1,14 @@
 import {
   useCopilotChatHeadless_c
-} from "../chunk-MO2BUFJD.mjs";
+} from "../chunk-F26O2HTO.mjs";
 import {
   defaultSystemMessage
-} from "../chunk-7TFJCTYY.mjs";
+} from "../chunk-JY3STRON.mjs";
 import "../chunk-IN7GE4NO.mjs";
 import "../chunk-KH27ZS4Y.mjs";
 import "../chunk-4CEQJ2X6.mjs";
-import "../chunk-2PL3WCKM.mjs";
-import "../chunk-IKWGQG5V.mjs";
+import "../chunk-5P46WS5M.mjs";
+import "../chunk-N4VN2B5S.mjs";
 import "../chunk-MUDXTKXE.mjs";
 import "../chunk-3BASANUO.mjs";
 import "../chunk-WSXTUD36.mjs";
@@ -22,7 +22,7 @@ import "../chunk-ICIK2BSB.mjs";
 import "../chunk-N4WEHORG.mjs";
 import "../chunk-O7ARI5CV.mjs";
 import "../chunk-EFL5OBKN.mjs";
-import "../chunk-OKRZF3DD.mjs";
+import "../chunk-6ZLPNY7X.mjs";
 import "../chunk-YPSGKPDA.mjs";
 import "../chunk-TEMLWRRT.mjs";
 import "../chunk-ZLQVRPDS.mjs";

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

@@ -17,20 +17,20 @@ import '../index-08c43df1.js';
  * `useCopilotChat` is a lightweight React hook for headless chat interactions.
  * Perfect for controlling the prebuilt chat components programmatically.
  *
- * **Open Source Friendly** - Works without requiring a free subscription key.
+ * **Open Source Friendly** - Works without requiring a free public license key.
  *
  * <Callout title="Looking for fully headless UI?">
  * Get started with [useCopilotChatHeadless_c](https://docs.copilotkit.ai/reference/hooks/useCopilotChatHeadless_c).
  * </Callout>
  *
- * ## Use Cases:
+ * ## Use Cases
  *
  * - **Programmatic Messaging**: Send messages without displaying chat UI
  * - **Programmatic control**: Control prebuilt component programmatically
  * - **Background Operations**: Trigger AI interactions in the background
  * - **Fire-and-Forget**: Send messages without needing to read responses
  *
- * ## Usage:
+ * ## Usage
  *
  * ```tsx
  * import { TextMessage, MessageRole } from "@copilotkit/runtime-client-gql";
@@ -47,6 +47,45 @@ import '../index-08c43df1.js';
  *   );
  * };
  * ```
+ *
+ * ## Return Values
+ * The following properties are returned from the hook:
+ *
+ * <PropertyReference name="visibleMessages" type="DeprecatedGqlMessage[]" deprecated>
+ * Array of messages in old non-AG-UI format, use for compatibility only
+ * </PropertyReference>
+ *
+ * <PropertyReference name="appendMessage" type="(message: DeprecatedGqlMessage, options?) => Promise<void>" deprecated>
+ * Append message using old format, use `sendMessage` instead
+ * </PropertyReference>
+ *
+ * <PropertyReference name="reloadMessages" type="(messageId: string) => Promise<void>">
+ * Regenerate the response for a specific message by ID
+ * </PropertyReference>
+ *
+ * <PropertyReference name="stopGeneration" type="() => void">
+ * Stop the current message generation process
+ * </PropertyReference>
+ *
+ * <PropertyReference name="reset" type="() => void">
+ * Clear all messages and reset chat state completely
+ * </PropertyReference>
+ *
+ * <PropertyReference name="isLoading" type="boolean">
+ * Whether the chat is currently generating a response
+ * </PropertyReference>
+ *
+ * <PropertyReference name="runChatCompletion" type="() => Promise<Message[]>">
+ * Manually trigger chat completion for advanced usage
+ * </PropertyReference>
+ *
+ * <PropertyReference name="mcpServers" type="MCPServerConfig[]">
+ * Array of Model Context Protocol server configurations
+ * </PropertyReference>
+ *
+ * <PropertyReference name="setMcpServers" type="(servers: MCPServerConfig[]) => void">
+ * Update MCP server configurations for enhanced context
+ * </PropertyReference>
  */
 
 type UseCopilotChatReturn = Omit<UseCopilotChatReturn$1, "messages" | "sendMessage" | "suggestions" | "setSuggestions" | "generateSuggestions" | "isLoadingSuggestions" | "resetSuggestions" | "interrupt" | "setMessages" | "deleteMessage">;