@amaster.ai/client 1.1.0-beta.4 → 1.1.0-beta.41

package/types/common.d.ts

@@ -1,12 +1,38 @@
 /**
- * ============================================================================
- * Common Types - Shared across all modules
- * ============================================================================
+ * Error information structure
  * 
- * This file contains shared type definitions used by all Amaster client modules.
- * 
- * @packageDocumentation
+ * @since 1.1.0
  */
+export interface ClientError {
+  /**
+   * HTTP status code
+   */
+  status: number;
+  
+  /**
+   * Error message
+   */
+  message: string;
+  
+  /**
+   * Application-specific error code (e.g., 'INVALID_TOKEN', 'PERMISSION_DENIED')
+   * 
+   * @since 1.1.0
+   */
+  code?: string;
+  
+  /**
+   * Additional error details (optional)
+   */
+  details?: unknown;
+  
+  /**
+   * Error timestamp (ISO 8601 format)
+   * 
+   * @since 1.1.0
+   */
+  timestamp?: string;
+}
 
 /**
  * Standard API response wrapper
@@ -17,33 +43,21 @@
  * @template T - The type of the successful response data
  * 
  * @example
- * Success response:
- * ```typescript
- * const result: ClientResult<User> = await client.auth.getMe();
- * if (result.data) {
- *   console.log('User:', result.data);  // Type: User
- * }
- * ```
- * 
- * @example
- * Error handling:
- * ```typescript
- * const result = await client.entity.get('default', 'users', '123');
- * if (result.error) {
- *   console.error(`Error ${result.error.status}:`, result.error.message);
+ * // Success case
+ * const result = await client.entity.list('default', 'users');
+ * if (result.success) {
+ *   console.log('Data:', result.data);
  * }
- * ```
  * 
  * @example
- * Check by HTTP status:
- * ```typescript
+ * // Error case
  * const result = await client.auth.login({ email, password });
- * if (result.status === 200 && result.data) {
- *   // Success
- * } else if (result.status === 401) {
- *   // Unauthorized
+ * if (!result.success) {
+ *   console.error('Error:', result.error.message);
+ *   console.error('Code:', result.error.code);
  * }
- * ```
+ * 
+ * @since 1.0.0
  */
 export interface ClientResult<T> {
   /**
@@ -54,27 +68,21 @@ export interface ClientResult<T> {
   /**
    * Error information (null if successful)
    */
-  error: {
-    /**
-     * HTTP status code
-     */
-    status: number;
-    
-    /**
-     * Error message
-     */
-    message: string;
-    
-    /**
-     * Additional error details (optional)
-     */
-    details?: unknown;
-  } | null;
+  error: ClientError | null;
   
   /**
    * HTTP response status code
    */
   status: number;
+  
+  /**
+   * Convenience flag for checking if request was successful
+   * 
+   * Equivalent to `error === null`
+   * 
+   * @since 1.1.0
+   */
+  success: boolean;
 }
 
 /**

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 */
@@ -220,8 +177,9 @@ export interface ChatMessage {
 /**
  * Chat options
  */
-export interface ChatOptions {
-  /** Stream response */
+export interface ChatOptions {  /** Task ID for conversation continuity */
+  taskId?: string;
+    /** Stream response */
   stream?: boolean;
   
   /** Temperature (0-1) */
@@ -240,96 +198,92 @@ export interface ChatOptions {
 /**
  * Copilot AI Assistant Client API
  * 
- * @example
- * Basic chat:
- * ```typescript
- * const client = createClient({ baseURL: 'https://api.amaster.ai' });
- * 
- * const result = await client.copilot.sendMessage([
- *   { role: 'user', content: 'Hello, how are you?' }
- * ]);
- * 
- * if (result.data) {
- *   console.log('AI Response:', result.data.content);
- * }
- * ```
- * 
- * @example
- * Streaming response:
- * ```typescript
- * await client.copilot.sendMessage(
- *   [{ role: 'user', content: 'Tell me a story' }],
- *   {
- *     stream: true,
- *     onChunk: (chunk) => {
- *       process.stdout.write(chunk);
- *     },
- *     onComplete: (fullResponse) => {
- *       console.log('\n\nFull response:', fullResponse);
- *     }
- *   }
- * );
- * ```
- * 
- * @example
- * Multi-turn conversation:
- * ```typescript
- * const conversation: ChatMessage[] = [
- *   { role: 'user', content: 'What is TypeScript?' },
- *   { role: 'assistant', content: 'TypeScript is a typed superset of JavaScript...' },
- *   { role: 'user', content: 'How do I define interfaces?' }
- * ];
- * 
- * const result = await client.copilot.sendMessage(conversation);
- * ```
+ * @since 1.0.0
  */
-export interface CopilotA2UIClient {
+export interface CopilotClientAPI {
   /**
-   * Send a message to the AI assistant
+   * Start a streaming chat session with the AI assistant
    * 
-   * @param messages - Conversation messages
-   * @param options - Chat options (streaming, temperature, etc.)
-   * @returns AI response
+   * 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 question:
-   * ```typescript
-   * const result = await client.copilot.sendMessage([
-   *   { 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?' }
    * ]);
    * 
-   * console.log(result.data.content); // "Paris"
-   * ```
+   * for await (const messages of chatStream) {
+   *   messages.forEach(msg => {
+   *     if (msg.surfaceUpdate) {
+   *       console.log('UI update:', msg.surfaceUpdate);
+   *     }
+   *   });
+   * }
    * 
    * @example
-   * With system prompt:
-   * ```typescript
-   * const result = await client.copilot.sendMessage([
-   *   { 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
-   * Streaming response:
-   * ```typescript
-   * await client.copilot.sendMessage(
-   *   [{ role: 'user', content: 'Explain async/await' }],
+   * // With image content
+   * const chatStream = client.copilot.chat([
    *   {
-   *     stream: true,
-   *     onChunk: (chunk) => {
-   *       // Update UI with each chunk
-   *       appendToChat(chunk);
-   *     },
-   *     onComplete: (fullText) => {
-   *       console.log('Complete response received');
-   *     }
+   *     role: 'user',
+   *     content: [
+   *       { type: 'text', text: 'What is in this image?' },
+   *       { type: 'image', imageUrl: 'https://example.com/image.jpg' }
+   *     ]
    *   }
-   * );
-   * ```
+   * ]);
+   * 
+   * @since 1.0.0
    */
-  sendMessage(
+  chat(
     messages: ChatMessage[],
     options?: ChatOptions
-  ): Promise<ClientResult<{ content: string; role: 'assistant' }>>;
+  ): AsyncGenerator<ServerToClientMessage[], void, unknown>;
+
+  /**
+   * Cancel an ongoing chat session
+   * 
+   * @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>>;
+
+  /**
+   * Get the status of a chat session
+   * 
+   * @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>>;
 }