@amaster.ai/client 1.1.0-beta.6 → 1.1.0-beta.61

package/types/copilot.d.ts

@@ -1,355 +1,80 @@
-/**
- * ============================================================================
- * Copilot AI Assistant - Type Definitions
- * ============================================================================
- * 
- * AI-powered assistant for interactive conversations and task assistance.
- * 
- * @module copilot
- */
-
-import type { ClientResult } from './common';
-
-// ============================================================================
-// A2UI Protocol Types (for streaming UI)
-// ============================================================================
-
-/**
- * String value with data binding support
- */
-export interface StringValue {
-  path?: string;
-  literalString?: string;
-  literal?: string;
-}
-
-/**
- * Number value with data binding support
- */
-export interface NumberValue {
-  path?: string;
-  literalNumber?: number;
-  literal?: number;
-}
-
-/**
- * Boolean value with data binding support
- */
-export interface BooleanValue {
-  path?: string;
-  literalBoolean?: boolean;
-  literal?: boolean;
-}
-
-/**
- * Component properties in A2UI protocol
- */
-export type ComponentProperties = Record<string, unknown>;
-
-/**
- * Component instance from server
- */
-export interface ComponentInstance {
-  id: string;
-  weight?: number;
-  component?: ComponentProperties;
-}
-
-/**
- * Value map for data model updates
- */
-export interface ValueMap {
-  key: string;
-  valueString?: string;
-  valueNumber?: number;
-  valueBoolean?: boolean;
-  valueMap?: ValueMap[];
-  [k: string]: unknown;
-}
-
-/**
- * Begin rendering message - initializes a new UI surface
- */
-export interface BeginRenderingMessage {
-  surfaceId: string;
-  root: string;
-  styles?: Record<string, string>;
-}
-
-/**
- * Surface update message - updates UI components
- */
-export interface SurfaceUpdateMessage {
-  surfaceId: string;
-  components: ComponentInstance[];
-}
-
-/**
- * Data model update message - updates data bindings
- */
-export interface DataModelUpdate {
-  surfaceId: string;
-  path?: string;
-  contents: ValueMap[];
-}
-
-/**
- * Delete surface message - removes a UI surface
- */
-export interface DeleteSurfaceMessage {
-  surfaceId: string;
-}
-
-/**
- * Server-to-client message in A2UI protocol
- * 
- * Used by the chat() streaming API to send UI updates.
- * Each message can contain one of several update types.
- * 
- * @example
- * ```typescript
- * const stream = client.copilot.chat([
- *   { role: 'user', content: 'Show me a chart' }
- * ]);
- * 
- * for await (const messages of stream) {
- *   for (const msg of messages) {
- *     if (msg.surfaceUpdate) {
- *       // Render UI components
- *       renderComponents(msg.surfaceUpdate.components);
- *     }
- *     if (msg.dataModelUpdate) {
- *       // Update data bindings
- *       updateData(msg.dataModelUpdate.contents);
- *     }
- *   }
- * }
- * ```
- */
-export interface ServerToClientMessage {
-  beginRendering?: BeginRenderingMessage;
-  surfaceUpdate?: SurfaceUpdateMessage;
-  dataModelUpdate?: DataModelUpdate;
-  deleteSurface?: DeleteSurfaceMessage;
-}
-
-/**
- * Complete UI surface state
- */
-export interface Surface {
-  rootComponentId: string | null;
-  componentTree: unknown | null;
-  dataModel: Record<string, unknown>;
-  components: Map<string, ComponentInstance>;
-  styles: Record<string, string>;
-}
-
-/**
- * Message processor for handling A2UI updates
- */
-export interface MessageProcessor {
-  getSurfaces(): ReadonlyMap<string, Surface>;
-  clearSurfaces(): void;
-  processMessages(messages: ServerToClientMessage[]): void;
-  resolvePath(path: string, dataContextPath?: string): string;
-}
-
-/**
- * Text content in a message
- */
-export interface TextContent {
-  type: 'text';
+import type {
+  SendStreamingMessageResponse,
+  CancelTaskResponse,
+  GetTaskResponse,
+} from "@a2a-js/sdk";
+import type { ClientResult } from "./common";
+
+interface TextContent {
+  type: "text";
   text: string;
 }
-
-/**
- * Image content in a message
- */
-export interface ImageContent {
-  type: 'image';
-  imageUrl: string;
+interface ImageContent {
+  type: "image";
+  data?: string;
+  url?: string;
+  mimeType?: string;
 }
-
-/**
- * File content in a message
- */
-export interface FileContent {
-  type: 'file';
-  fileUrl: string;
-  fileName?: string;
+interface FileContent {
+  type: "file";
+  data?: string;
+  url?: string;
   mimeType?: string;
+  name?: string;
 }
-
-/**
- * Message content (text, image, or file)
- */
-export type MessageContent = TextContent | ImageContent | FileContent;
-
-/**
- * Chat message
- * 
- * @example
- * Text message:
- * ```typescript
- * const message: ChatMessage = {
- *   role: 'user',
- *   content: 'Hello, how can you help me?'
- * };
- * ```
- * 
- * @example
- * Message with image:
- * ```typescript
- * const message: ChatMessage = {
- *   role: 'user',
- *   content: [
- *     { type: 'text', text: 'What is in this image?' },
- *     { type: 'image', imageUrl: 'https://example.com/image.jpg' }
- *   ]
- * };
- * ```
- */
-export interface ChatMessage {
-  /** Message role */
-  role: 'system' | 'user' | 'assistant';
-  
-  /** Message content (string or structured content) */
+type MessageContent = TextContent | ImageContent | FileContent;
+interface ChatMessage {
+  role: "system" | "user" | "assistant";
   content: string | MessageContent[];
 }
-
-/**
- * Chat options
- */
-export interface ChatOptions {
-  /** Stream response */
-  stream?: boolean;
-  
-  /** Temperature (0-1) */
-  temperature?: number;
-  
-  /** Maximum tokens to generate */
-  maxTokens?: number;
-  
-  /** Callback for streamed chunks */
-  onChunk?: (chunk: string) => void;
-  
-  /** Callback when streaming completes */
-  onComplete?: (fullResponse: string) => void;
+interface ChatOptions {
+  taskId?: string;
 }
-
-/**
- * Copilot AI Assistant Client API
- * 
- * @example
- * Basic chat:
- * ```typescript
- * const client = createClient({ baseURL: 'https://api.amaster.ai' });
- * 
- * const stream = client.copilot.chat([
- *   { role: 'user', content: 'Hello, how are you?' }
- * ]);
- * 
- * for await (const messages of stream) {
- *   // Process A2UI messages
- * }
- * ```
- * 
- * @example
- * With task ID for conversation continuity:
- * ```typescript
- * const stream = client.copilot.chat(
- *   [{ role: 'user', content: 'Tell me a story' }],
- *   { taskId: 'conv-123' }
- * );
- * 
- * for await (const messages of stream) {
- *   for (const msg of messages) {
- *     if (msg.dataModelUpdate) {
- *       // Extract and display text content
- *     }
- *   }
- * }
- * ```
- * 
- * @example
- * Multi-turn conversation:
- * ```typescript
- * const conversation: ChatMessage[] = [
- *   { role: 'system', content: 'You are a helpful assistant' },
- *   { role: 'user', content: 'What is TypeScript?' }
- * ];
- * 
- * for await (const messages of client.copilot.chat(conversation)) {
- *   // Process streaming response
- * }
- * ```
- */
-export interface CopilotA2UIClient {
+type CopilotClientAPI = {
   /**
-   * Start a streaming chat session with the AI assistant
-   * 
-   * Returns an async generator that yields A2UI ServerToClientMessage arrays.
-   * Each yielded array contains UI updates that should be processed by an A2UI renderer.
-   * 
-   * @param messages - Conversation messages (system, user, assistant)
-   * @param options - Chat options (taskId for conversation continuity)
-   * @returns AsyncGenerator yielding arrays of A2UI messages
-   * 
-   * @example
-   * Simple chat:
-   * ```typescript
-   * const stream = client.copilot.chat([
-   *   { role: 'user', content: 'What is the capital of France?' }
-   * ]);
-   * 
-   * for await (const messages of stream) {
-   *   // Process A2UI updates
-   * }
-   * ```
-   * 
-   * @example
-   * With system prompt:
-   * ```typescript
-   * const stream = client.copilot.chat([
-   *   { role: 'system', content: 'You are a helpful coding assistant' },
-   *   { role: 'user', content: 'How do I reverse a string in JavaScript?' }
-   * ]);
-   * ```
-   * 
+   * Stream messages from Copilot Agent.
+   *
    * @example
-   * Extracting text content from A2UI messages:
    * ```typescript
-   * for await (const messages of stream) {
-   *   for (const msg of messages) {
-   *     if (msg.dataModelUpdate?.contents) {
-   *       for (const content of msg.dataModelUpdate.contents) {
-   *         if (content.valueString) {
-   *           console.log(content.valueString); // Display text
-   *         }
-   *       }
-   *     }
-   *   }
+   * import { createCopilotClient, Data } from "@amaster.ai/copilot-client";
+   *
+   * const client = createCopilotClient();
+   *
+   * for await (const response of client.chat([{ role: "user", content: "Hello" }])) {
+   *   // deal response
    * }
    * ```
    */
   chat(
     messages: ChatMessage[],
     options?: ChatOptions
-  ): AsyncGenerator<ServerToClientMessage[], void, unknown>;
-
-  /**
-   * Cancel an ongoing chat session
-   * 
-   * @param taskId - Task ID to cancel
-   * @returns Cancellation result
-   */
-  cancelChat(taskId: string): Promise<ClientResult<unknown>>;
-
-  /**
-   * Get the status of a chat session
-   * 
-   * @param taskId - Task ID to query
-   * @returns Task status information
-   */
-  getChatStatus(taskId: string): Promise<ClientResult<unknown>>;
-}
+  ): AsyncGenerator<SendStreamingMessageResponse, void, unknown>;
+  cancelChat(taskId: string): Promise<ClientResult<CancelTaskResponse>>;
+  getChatStatus(taskId?: string): Promise<{
+    working: boolean;
+    taskId?: string;
+    error?: string;
+  }>;
+  getHistory(
+    limit?: number,
+    next?: string
+  ): Promise<
+    | {
+        messages: SendStreamingMessageResponse[];
+        next: string;
+        hasMore: boolean;
+      }
+    | undefined
+  >;
+  newConversation(): Promise<void>;
+};
+
+export {
+  type ChatMessage,
+  type ChatOptions,
+  type CopilotClientAPI,
+  type FileContent,
+  type ImageContent,
+  type MessageContent,
+  type TextContent,
+};