@amaster.ai/client 1.1.0-beta.30 → 1.1.0-beta.32

package/types/copilot.d.ts

@@ -1,9 +1,5 @@
 /**
- * ============================================================================
- * Copilot AI Assistant - Type Definitions
- * ============================================================================
- * 
- * AI-powered assistant for interactive conversations and task assistance.
+ *  * AI-powered assistant for interactive conversations and task assistance.
  * 
  * @module copilot
  */
@@ -105,26 +101,7 @@ export interface DeleteSurfaceMessage {
  * 
  * 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;
@@ -187,27 +164,7 @@ 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 */
@@ -241,51 +198,9 @@ export interface ChatOptions {  /** Task ID for conversation continuity */
 /**
  * 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
- * }
- * ```
+ * @since 1.0.0
  */
-export interface CopilotA2UIClient {
+export interface CopilotClientAPI {
   /**
    * Start a streaming chat session with the AI assistant
    * 
@@ -297,41 +212,43 @@ export interface CopilotA2UIClient {
    * @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?' }
+   * // Simple chat
+   * const chatStream = client.copilot.chat([
+   *   { role: 'user', content: 'Hello, how can you help me?' }
    * ]);
    * 
-   * for await (const messages of stream) {
-   *   // Process A2UI updates
+   * for await (const messages of chatStream) {
+   *   messages.forEach(msg => {
+   *     if (msg.surfaceUpdate) {
+   *       console.log('UI update:', msg.surfaceUpdate);
+   *     }
+   *   });
    * }
-   * ```
    * 
    * @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?' }
-   * ]);
-   * ```
+   * // With conversation history
+   * const chatStream = client.copilot.chat([
+   *   { role: 'system', content: 'You are a helpful assistant.' },
+   *   { role: 'user', content: 'What is TypeScript?' },
+   *   { role: 'assistant', content: 'TypeScript is...' },
+   *   { role: 'user', content: 'Can you give an example?' }
+   * ], {
+   *   taskId: 'conversation-123'
+   * });
    * 
    * @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
-   *         }
-   *       }
-   *     }
+   * // With image content
+   * const chatStream = client.copilot.chat([
+   *   {
+   *     role: 'user',
+   *     content: [
+   *       { type: 'text', text: 'What is in this image?' },
+   *       { type: 'image', imageUrl: 'https://example.com/image.jpg' }
+   *     ]
    *   }
-   * }
-   * ```
+   * ]);
+   * 
+   * @since 1.0.0
    */
   chat(
     messages: ChatMessage[],
@@ -343,6 +260,14 @@ export interface CopilotA2UIClient {
    * 
    * @param taskId - Task ID to cancel
    * @returns Cancellation result
+   * 
+   * @example
+   * const result = await client.copilot.cancelChat('task-123');
+   * if (result.success) {
+   *   console.log('Chat cancelled');
+   * }
+   * 
+   * @since 1.0.0
    */
   cancelChat(taskId: string): Promise<ClientResult<unknown>>;
 
@@ -351,6 +276,14 @@ export interface CopilotA2UIClient {
    * 
    * @param taskId - Task ID to query
    * @returns Task status information
+   * 
+   * @example
+   * const result = await client.copilot.getChatStatus('task-123');
+   * if (result.success) {
+   *   console.log('Status:', result.data);
+   * }
+   * 
+   * @since 1.0.0
    */
   getChatStatus(taskId: string): Promise<ClientResult<unknown>>;
 }