@docyrus/ui-pro-ai-assistant 0.5.8 → 0.6.1

package/dist/lib/client-tools.d.ts

@@ -0,0 +1,39 @@
+import { type ReactNode } from 'react';
+import { type ClientTool, type ClientToolExecuteContext } from '../types';
+export type ClientToolMap = Map<string, ClientTool>;
+export declare function ClientToolsProvider({ tools, children }: {
+    tools: ClientToolMap;
+    children: ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+/** Returns the full registered client-tool map. */
+export declare function useClientToolMap(): ClientToolMap;
+/** Builds a name → tool lookup, ignoring duplicates (first wins). */
+export declare function buildClientToolMap(tools?: ClientTool[]): ClientToolMap;
+/** Serializable tool definitions sent to the chat endpoint as `clientTools`. */
+export declare function serializeClientTools(tools?: ClientTool[]): {
+    name: string;
+    description: string;
+    parameters: Record<string, unknown>;
+}[];
+export type ClientToolResult = {
+    success: true;
+    result: unknown;
+} | {
+    success: false;
+    error: string;
+};
+/** Executes a client tool, normalizing the outcome into a result envelope. */
+export declare function runClientTool(tool: ClientTool, input: unknown, context: ClientToolExecuteContext): Promise<ClientToolResult>;
+interface ClientToolCallProps {
+    tool: ClientTool;
+    part: {
+        state?: string;
+        input?: any;
+        output?: any;
+        errorText?: string;
+        toolCallId: string;
+    };
+}
+/** Compact card rendered for a client-tool call, driven by host-provided copy. */
+export declare function ClientToolCall({ tool, part }: ClientToolCallProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/styles.css

@@ -2471,6 +2471,12 @@
     border-color: color-mix(in oklab, var(--destructive) 20%, transparent);
   }
 }
+.border-destructive\/40 {
+  border-color: var(--destructive);
+  @supports (color: color-mix(in lab, red, red)) {
+    border-color: color-mix(in oklab, var(--destructive) 40%, transparent);
+  }
+}
 .border-destructive\/50 {
   border-color: var(--destructive);
   @supports (color: color-mix(in lab, red, red)) {
@@ -2690,6 +2696,12 @@
 .bg-destructive {
   background-color: var(--destructive);
 }
+.bg-destructive\/5 {
+  background-color: var(--destructive);
+  @supports (color: color-mix(in lab, red, red)) {
+    background-color: color-mix(in oklab, var(--destructive) 5%, transparent);
+  }
+}
 .bg-destructive\/10 {
   background-color: var(--destructive);
   @supports (color: color-mix(in lab, red, red)) {
@@ -10122,6 +10134,11 @@
     color: var(--color-blue-400);
   }
 }
+.dark\:text-emerald-500 {
+  @media (prefers-color-scheme: dark) {
+    color: var(--color-emerald-500);
+  }
+}
 .dark\:text-gray-400 {
   @media (prefers-color-scheme: dark) {
     color: var(--color-gray-400);

package/dist/types/index.d.ts

@@ -1,9 +1,44 @@
+import { type ReactNode } from 'react';
 export interface ToolActionEvent {
     tool: string;
     toolCallId: string;
     decision: string;
     input: any;
 }
+export interface ClientToolExecuteContext {
+    /** The id of the tool call being fulfilled. */
+    toolCallId: string;
+}
+/**
+ * A host-provided tool the agent can call and have executed client-side.
+ *
+ * The serializable parts (`name`, `description`, `parameters`) are forwarded
+ * to the chat endpoint as `clientTools` so the backend can expose them to the
+ * agent. When the agent calls one, `execute` runs in the browser and its
+ * resolved value is sent back to the agent as the tool result.
+ */
+export interface ClientTool<TInput = any, TOutput = any> {
+    /** Unique tool name. Must match the name the agent uses to call it. */
+    name: string;
+    /** Natural-language description the agent uses to decide when to call it. */
+    description: string;
+    /** JSON Schema (draft-07) describing the tool input. Forwarded to the backend. */
+    parameters?: Record<string, unknown>;
+    /**
+     * Runs client-side when the agent calls this tool. The resolved value is
+     * serialized and sent back to the agent as the tool result. Throwing (or
+     * rejecting) reports the error back to the agent.
+     */
+    execute: (input: TInput, context: ClientToolExecuteContext) => TOutput | Promise<TOutput>;
+    /** Icon rendered in the tool-call card. */
+    icon?: ReactNode;
+    /** Message shown while the tool is executing. */
+    progressMessage?: string;
+    /** Message shown when the tool resolves successfully. */
+    successMessage?: string;
+    /** Message shown when the tool throws or rejects. */
+    failMessage?: string;
+}
 export interface ApiResponse<T = unknown> {
     success: boolean;
     data?: T;
@@ -315,4 +350,11 @@ export interface DocyAssistantProps {
      * Common values: 'web' | 'desktop' | 'chrome' | 'word' | 'excel' | 'powerpoint' | 'outlook'.
      */
     hostEnvironment?: string;
+    /**
+     * Host-provided tools the agent can call and have executed client-side.
+     * Their definitions are forwarded to the chat endpoint as `clientTools`;
+     * when the agent calls one, its `execute` runs in the browser and the
+     * result is sent back to the agent automatically.
+     */
+    clientTools?: ClientTool[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docyrus/ui-pro-ai-assistant",
-  "version": "0.5.8",
+  "version": "0.6.1",
   "description": "Docyrus AI Assistant component — full-featured chat UI with canvas, projects, and i18n support.",
   "type": "module",
   "main": "./dist/index.js",
@@ -30,7 +30,6 @@
   ],
   "dependencies": {
     "@ai-sdk/react": "^3.0.161",
-    "@tanstack/react-form": "^1.28.4",
     "@ariakit/react": "0.4.21",
     "@codesandbox/sandpack-react": "2.20.0",
     "@emoji-mart/data": "1.2.1",
@@ -67,6 +66,7 @@
     "@platejs/table": "52.0.11",
     "@platejs/toc": "52.0.11",
     "@platejs/toggle": "52.0.11",
+    "@tanstack/react-form": "^1.28.4",
     "@univerjs/core": "0.16.1",
     "@univerjs/design": "0.16.1",
     "@univerjs/docs": "0.16.1",