@automattic/agenttic-client 0.1.0 → 0.1.2

package/dist/react/useAgentChat.d.ts

@@ -0,0 +1,97 @@
+import type React from 'react';
+import type { ReactNode } from 'react';
+import { type MarkdownComponents, type MarkdownExtensions } from '../utils/markdownParser';
+import type { AuthProvider, ContextProvider, ToolProvider } from '../client/types/index';
+import type { createFeedbackActions } from '../message-actions/factories';
+export interface Suggestion {
+    id: string;
+    label: string;
+    prompt: string;
+}
+export type { MarkdownComponents, MarkdownExtensions, } from '../utils/markdownParser';
+export interface UIMessage {
+    id: string;
+    role: 'user' | 'agent';
+    content: Array<{
+        type: 'text' | 'image_url' | 'component';
+        text?: string;
+        image_url?: string;
+        component?: React.ComponentType;
+        componentProps?: any;
+    }>;
+    timestamp: number;
+    archived: boolean;
+    showIcon: boolean;
+    icon?: string;
+    actions?: UIMessageAction[];
+}
+export interface UIMessageAction {
+    id: string;
+    label: string;
+    icon: React.ReactNode;
+    onClick: (message: UIMessage) => void | Promise<void>;
+    disabled?: boolean;
+    tooltip?: string;
+}
+export interface MessageActionDefinition {
+    id: string;
+    label: string;
+    icon: ReactNode;
+    onClick: (message: UIMessage) => void | Promise<void>;
+    condition?: (message: UIMessage) => boolean;
+    disabled?: boolean;
+    tooltip?: string;
+}
+export interface MessageActionsRegistration {
+    id: string;
+    actions: MessageActionDefinition[] | ((message: UIMessage) => MessageActionDefinition[]);
+}
+export interface FeedbackActionsConfig {
+    onFeedback: (messageId: string, feedback: 'up' | 'down') => void | Promise<void>;
+    condition?: (message: UIMessage) => boolean;
+    icons: {
+        up: ReactNode;
+        down: ReactNode;
+    };
+}
+export interface UseMessageActionsReturn {
+    registerMessageActions: (registration: MessageActionsRegistration) => void;
+    unregisterMessageActions: (id: string) => void;
+    clearAllMessageActions: () => void;
+    createFeedbackActions: typeof createFeedbackActions;
+}
+export interface UseAgentChatConfig {
+    agentId: string;
+    agentUrl: string;
+    sessionId: string;
+    contextProvider?: ContextProvider;
+    toolProvider?: ToolProvider;
+    authProvider?: AuthProvider;
+}
+export interface UseAgentChatReturn {
+    messages: UIMessage[];
+    isProcessing: boolean;
+    error: string | null;
+    onSubmit: (message: string) => Promise<void>;
+    suggestions: Suggestion[];
+    messageRenderer?: React.ComponentType<{
+        children: string;
+    }>;
+    registerSuggestions: (suggestions: Suggestion[]) => void;
+    clearSuggestions: () => void;
+    registerMarkdownComponents: (components: MarkdownComponents) => void;
+    registerMarkdownExtensions: (extensions: MarkdownExtensions) => void;
+    registerMessageActions: (registration: MessageActionsRegistration) => void;
+    unregisterMessageActions: (id: string) => void;
+    clearAllMessageActions: () => void;
+    createFeedbackActions: typeof createFeedbackActions;
+    addMessage: (message: UIMessage) => void;
+}
+/**
+ * React hook for agent chat functionality
+ * Provides all necessary data and methods for AgentUI component
+ * @param config
+ */
+export declare function useAgentChat(config: UseAgentChatConfig): UseAgentChatReturn;
+export default useAgentChat;
+//# sourceMappingURL=useAgentChat.d.ts.map

package/dist/react/useClientContext.d.ts

@@ -0,0 +1,17 @@
+import type { ClientContext, ContextProvider } from '../client/types/index';
+/**
+ * Callback function type for getting client context
+ */
+export type GetClientContextCallback = () => ClientContext;
+/**
+ * Hook for creating a context provider from a user-provided callback
+ *
+ * This hook abstracts the ContextProvider interface and allows users to simply
+ * provide a callback function that returns fresh context data each time a message
+ * is sent to the agent.
+ *
+ * @param getClientContextCallback - Function that returns fresh client context data
+ * @return ContextProvider instance or undefined if no callback provided
+ */
+export declare function useClientContext(getClientContextCallback?: GetClientContextCallback): ContextProvider | undefined;
+//# sourceMappingURL=useClientContext.d.ts.map

package/dist/react/useClientContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useClientContext.d.ts","sourceRoot":"","sources":["../../src/react/useClientContext.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE5E;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,aAAa,CAAC;AAE3D;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAC/B,wBAAwB,CAAC,EAAE,wBAAwB,GACjD,eAAe,GAAG,SAAS,CA2B7B"}

package/dist/react/useClientTools.d.ts

@@ -0,0 +1,23 @@
+import type { Tool, ToolProvider } from '../client/types/index';
+/**
+ * Callback function type for getting tools
+ */
+export type GetClientToolsCallback = () => Promise<Tool[]>;
+/**
+ * Callback function type for executing tools
+ */
+export type ExecuteToolCallback = (toolId: string, args: any) => Promise<any>;
+/**
+ * React hook that creates a ToolProvider
+ *
+ * This hook takes separate callback functions for getting tools and executing tools.
+ * It wraps them in the ToolProvider interface expected by the agenttic client.
+ * The callbacks are called fresh each time, ensuring dynamic tool availability and execution.
+ * Tool results are automatically handled by the A2A client.
+ *
+ * @param getClientTools - Function that returns available tools as an array of Tool objects
+ * @param executeTool    - Function that executes a tool with the arguments returned by the agent
+ * @return ToolProvider instance or undefined if no getClientTools callback provided
+ */
+export declare function useClientTools(getClientTools?: GetClientToolsCallback, executeTool?: ExecuteToolCallback): ToolProvider | undefined;
+//# sourceMappingURL=useClientTools.d.ts.map

package/dist/react/useClientTools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useClientTools.d.ts","sourceRoot":"","sources":["../../src/react/useClientTools.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,OAAO,CAAE,IAAI,EAAE,CAAE,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,CACjC,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,GAAG,KACL,OAAO,CAAE,GAAG,CAAE,CAAC;AAEpB;;;;;;;;;;;GAWG;AACH,wBAAgB,cAAc,CAC7B,cAAc,CAAC,EAAE,sBAAsB,EACvC,WAAW,CAAC,EAAE,mBAAmB,GAC/B,YAAY,GAAG,SAAS,CA6C1B"}

package/dist/utils/createMessageRenderer.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Creates a configured message renderer component
+ *
+ * This factory creates a React component that renders markdown content
+ * with the specified extensions and custom components.
+ */
+import React from 'react';
+import type { Components } from 'react-markdown';
+import type { PluggableList } from 'unified';
+import type { MarkdownExtensions } from '../markdown-extensions/types';
+interface CreateMessageRendererOptions {
+    components?: Components;
+    extensions?: MarkdownExtensions;
+    remarkPlugins?: PluggableList;
+}
+/**
+ * Creates a message renderer component with pre-configured markdown settings
+ * @param options - Configuration options for markdown rendering
+ * @return A React component that renders markdown with the specified configuration
+ */
+export declare function createMessageRenderer(options?: CreateMessageRendererOptions): React.ComponentType<{
+    children: string;
+}>;
+export {};
+//# sourceMappingURL=createMessageRenderer.d.ts.map

package/dist/utils/createMessageRenderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createMessageRenderer.d.ts","sourceRoot":"","sources":["../../src/utils/createMessageRenderer.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAK7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,UAAU,4BAA4B;IACrC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,aAAa,CAAC,EAAE,aAAa,CAAC;CAC9B;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CACpC,OAAO,GAAE,4BAAiC,GACxC,KAAK,CAAC,aAAa,CAAE;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAE,CA0B7C"}

package/dist/utils/markdownParser.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Markdown Parser Utility
+ *
+ * Converts markdown text to React components using react-markdown
+ * with custom components and extensions support.
+ */
+import React from 'react';
+import type { Components } from 'react-markdown';
+import type { PluggableList } from 'unified';
+import type { MarkdownExtensions } from '../markdown-extensions/types';
+export type MarkdownComponents = Components;
+export type { MarkdownExtensions } from '../markdown-extensions/types';
+interface ParseMarkdownOptions {
+    components?: MarkdownComponents;
+    extensions?: MarkdownExtensions;
+    remarkPlugins?: PluggableList;
+}
+/**
+ * Parses markdown text into a React component using react-markdown
+ * @param text    - The markdown text to parse
+ * @param options - Custom components and extensions to use
+ * @return React element containing the parsed markdown
+ */
+export declare function parseMarkdownToComponent(text: string, options?: ParseMarkdownOptions): React.ReactElement;
+//# sourceMappingURL=markdownParser.d.ts.map

package/dist/utils/markdownParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdownParser.d.ts","sourceRoot":"","sources":["../../src/utils/markdownParser.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAK7C,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAGvE,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC;AAG5C,YAAY,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,UAAU,oBAAoB;IAC7B,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,UAAU,CAAC,EAAE,kBAAkB,CAAC;IAChC,aAAa,CAAC,EAAE,aAAa,CAAC;CAC9B;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACvC,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,oBAAyB,GAChC,KAAK,CAAC,YAAY,CAuBpB"}

package/dist/utils/theme.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Utility to get CSS variable values
+ * Note: OKLCH colors are automatically converted to RGB by the browser
+ * @param variableName
+ * @param fallback
+ */
+export declare const getCSSVariable: (variableName: string, fallback?: string) => string;
+//# sourceMappingURL=theme.d.ts.map

package/dist/utils/theme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../../src/utils/theme.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAC1B,cAAc,MAAM,EACpB,WAAU,MAAW,KACnB,MAYF,CAAC"}

package/package.json

@@ -1,74 +1,82 @@
 {
-  "name": "@automattic/agenttic-client",
-  "version": "0.1.0",
-  "type": "module",
-  "description": "A TypeScript client library for A2A (Agent2Agent) protocol communication",
-  "main": "dist/index.js",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    },
-    "./mocks": {
-      "types": "./dist/mocks/index.d.ts",
-      "import": "./dist/mocks/index.js"
-    }
-  },
-  "files": [
-    "dist",
-    "README.md"
-  ],
-  "keywords": [
-    "a2a",
-    "agent2agent",
-    "agenttic",
-    "client",
-    "typescript",
-    "ai",
-    "agent",
-    "protocol"
-  ],
-  "author": "Automattic",
-  "license": "MIT",
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "devDependencies": {
-    "tsup": "^8.0.0",
-    "typescript": "^5.0.0",
-    "unified": "^11.0.5",
-    "vitest": "^1.0.0"
-  },
-  "dependencies": {
-    "@automattic/charts": "^0.14.0",
-    "@types/react": "^18.0.0",
-    "@visx/xychart": "^3.12.0",
-    "@wordpress/element": "^6.2.0",
-    "@wordpress/i18n": "^6.1.0",
-    "react": "^18.0.0",
-    "react-markdown": "^10.1.0",
-    "remark-gfm": "^4.0.1"
-  },
-  "peerDependencies": {
-    "react": "^18.0.0"
-  },
-  "publishConfig": {
-    "access": "public",
-    "branch": "trunk"
-  },
-  "scripts": {
-    "build": "pnpm run clean && tsup src/index.ts src/mocks/index.ts --format esm --target node18 && tsc --emitDeclarationOnly",
-    "build:no-splitting": "pnpm run clean && tsup src/index.ts --format esm --target node18 --splitting=false && tsc --emitDeclarationOnly",
-    "dev": "tsup src/index.ts --format esm --watch",
-    "dev:no-splitting": "tsup src/index.ts --format esm --target node18 --splitting=false --watch",
-    "clean": "rm -rf dist",
-    "type-check": "tsc --noEmit",
-    "lint": "wp-scripts lint-js src --ext .ts,.tsx",
-    "lint:fix": "wp-scripts lint-js src --ext .ts,.tsx --fix",
-    "test": "vitest run",
-    "i18n:extract": "npx --no-install @wordpress/i18n-command make-pot src --output=languages/a8c-agenttic.pot --domain=a8c-agenttic",
-    "i18n:update": "npx --no-install @wordpress/i18n-command make-json languages --domain=a8c-agenttic"
-  }
-}
+	"name": "@automattic/agenttic-client",
+	"version": "0.1.2",
+	"type": "module",
+	"description": "A TypeScript client library for A2A (Agent2Agent) protocol communication",
+	"main": "dist/index.js",
+	"module": "dist/index.js",
+	"types": "dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js"
+		},
+		"./mocks": {
+			"types": "./dist/mocks/index.d.ts",
+			"import": "./dist/mocks/index.js"
+		}
+	},
+	"files": [
+		"dist",
+		"README.md"
+	],
+	"scripts": {
+		"build": "pnpm run clean && tsup src/index.ts src/mocks/index.ts --format esm --target node18 && tsc --project tsconfig.json --emitDeclarationOnly",
+		"build:no-splitting": "pnpm run clean && tsup src/index.ts --format esm --target node18 --splitting=false && tsc --project tsconfig.json --emitDeclarationOnly",
+		"dev": "tsup src/index.ts --format esm --watch",
+		"dev:no-splitting": "tsup src/index.ts --format esm --target node18 --splitting=false --watch",
+		"clean": "rm -rf dist",
+		"type-check": "tsc --noEmit",
+		"lint": "wp-scripts lint-js src --ext .ts,.tsx",
+		"lint:fix": "wp-scripts lint-js src --ext .ts,.tsx --fix",
+		"test": "vitest run",
+		"prepublishOnly": "pnpm run build",
+		"i18n:extract": "npx --no-install @wordpress/i18n-command make-pot src --output=languages/a8c-agenttic.pot --domain=a8c-agenttic",
+		"i18n:update": "npx --no-install @wordpress/i18n-command make-json languages --domain=a8c-agenttic"
+	},
+	"keywords": [
+		"a2a",
+		"agent2agent",
+		"agenttic",
+		"client",
+		"typescript",
+		"ai",
+		"agent",
+		"protocol"
+	],
+	"author": "Automattic",
+	"license": "MIT",
+	"engines": {
+		"node": ">=18.0.0"
+	},
+	"devDependencies": {
+		"@wordpress/api-fetch": "^7.0.0",
+		"tsup": "^8.0.0",
+		"typescript": "^5.0.0",
+		"unified": "^11.0.5",
+		"vitest": "^1.0.0"
+	},
+	"dependencies": {
+		"@automattic/charts": "^0.14.0",
+		"@types/react": "^18.0.0",
+		"@visx/xychart": "^3.12.0",
+		"@wordpress/element": "^6.2.0",
+		"@wordpress/i18n": "^6.1.0",
+		"react": "^18.0.0",
+		"react-markdown": "^10.1.0",
+		"remark-gfm": "^4.0.1"
+	},
+	"peerDependencies": {
+		"@wordpress/api-fetch": "^6.0.0 || ^7.0.0",
+		"react": "^18.0.0"
+	},
+	"peerDependenciesMeta": {
+		"@wordpress/api-fetch": {
+			"optional": true
+		}
+	},
+	"publishConfig": {
+		"access": "public",
+		"branch": "trunk"
+	}
+}