@aizu-chat/react 0.1.3 → 0.1.4

package/dist/index.d.mts

@@ -39,162 +39,16 @@ declare enum TypeResponse {
     START_SHOPPING = "start_shopping"
 }
 
-/**
- * Aizu Chat API Client
- *
- * A client for interacting with the Aizu Chat API. Handles authentication,
- * request timeouts, and error handling automatically.
- *
- * @example
- * ```typescript
- * const client = new AizuClient({
- *   hostUrl: 'https://api.aizu.chat',
- *   apiKey: 'your-api-key',
- *   timeout: 30000
- * });
- *
- * const response = await client.chat({
- *   query: 'Hello, how are you?',
- *   conversationId: 'optional-conversation-id'
- * });
- * ```
- */
 declare class AizuClient {
     private hostUrl;
     private apiKey;
     private timeout;
-    /**
-     * Creates a new AizuClient instance
-     *
-     * @param config - Configuration options for the client
-     * @param config.hostUrl - The base URL of the Aizu API (e.g., 'https://api.aizu.chat')
-     * @param config.apiKey - Your API key for authentication
-     * @param config.timeout - Request timeout in milliseconds (default: 30000)
-     *
-     * @throws {Error} If hostUrl is not a non-empty string
-     * @throws {Error} If apiKey is not a non-empty string
-     *
-     * @example
-     * ```typescript
-     * const client = new AizuClient({
-     *   hostUrl: 'https://api.aizu.chat',
-     *   apiKey: 'sk_test_123456',
-     *   timeout: 60000 // 60 seconds
-     * });
-     * ```
-     */
     constructor(config: AizuClientConfig);
-    /**
-     * Internal method for making HTTP requests to the API
-     *
-     * Handles timeout management, abort signal combination, and error handling.
-     * Supports both user-initiated cancellation and automatic timeout.
-     *
-     * @template T - The expected response type
-     * @template TBody - The request body type
-     *
-     * @param path - API endpoint path (e.g., '/chat/query')
-     * @param options - Request options including body and signal
-     *
-     * @returns Promise resolving to the API response
-     *
-     * @throws {Error} "Request cancelled by user" - If the request is cancelled via AbortSignal
-     * @throws {Error} "Request timeout: The server took too long to respond" - If the request exceeds the timeout
-     * @throws {Error} "API Error: {status} {statusText}" - If the API returns an error status
-     *
-     * @private
-     */
     private request;
-    /**
-     * Sends a chat query to the Aizu API
-     *
-     * @param params - Chat request parameters
-     * @param params.query - The user's message/question (required, non-empty)
-     * @param params.conversationId - Optional conversation ID to continue an existing conversation
-     * @param options - Additional options
-     * @param options.signal - Optional AbortSignal to cancel the request
-     *
-     * @returns Promise resolving to the chat response from the API
-     *
-     * @throws {Error} "Query is required" - If query is empty or whitespace only
-     * @throws {Error} "Request cancelled by user" - If the request is cancelled
-     * @throws {Error} "Request timeout: The server took too long to respond" - If the request times out
-     * @throws {Error} "API Error: {status} {statusText}" - If the API returns an error
-     *
-     * @example
-     * ```typescript
-     * // Simple query
-     * const response = await client.chat({
-     *   query: 'What is the weather today?'
-     * });
-     * console.log(response.answer);
-     * ```
-     *
-     * @example
-     * ```typescript
-     * // Continue conversation
-     * const response1 = await client.chat({
-     *   query: 'What is the weather today?'
-     * });
-     *
-     * const response2 = await client.chat({
-     *   query: 'And tomorrow?',
-     *   conversationId: response1.conversationId
-     * });
-     * ```
-     *
-     * @example
-     * ```typescript
-     * // With cancellation support
-     * const controller = new AbortController();
-     *
-     * const promise = client.chat(
-     *   { query: 'Long running query...' },
-     *   { signal: controller.signal }
-     * );
-     *
-     * // Cancel after 5 seconds
-     * setTimeout(() => controller.abort(), 5000);
-     *
-     * try {
-     *   const response = await promise;
-     * } catch (error) {
-     *   console.error('Request was cancelled:', error);
-     * }
-     * ```
-     */
     chat(params: ChatRequest, options?: {
         signal?: AbortSignal;
     }): Promise<ChatResponse>;
 }
-/**
- * Factory function to create a new AizuClient instance
- *
- * This is a convenience function that wraps the AizuClient constructor.
- * Use this when you prefer a functional approach over instantiating the class directly.
- *
- * @param config - Configuration options for the client
- * @param config.hostUrl - The base URL of the Aizu API
- * @param config.apiKey - Your API key for authentication
- * @param config.timeout - Optional request timeout in milliseconds (default: 30000)
- *
- * @returns A new AizuClient instance
- *
- * @throws {Error} If hostUrl or apiKey are invalid
- *
- * @example
- * ```typescript
- * const client = createAizuClient({
- *   hostUrl: process.env.AIZU_HOST_URL!,
- *   apiKey: process.env.AIZU_API_KEY!,
- *   timeout: 45000
- * });
- *
- * const response = await client.chat({
- *   query: 'Hello!'
- * });
- * ```
- */
 declare const createAizuClient: ({ hostUrl, apiKey, timeout, }: {
     hostUrl: string;
     apiKey: string;

package/dist/index.d.ts

@@ -39,162 +39,16 @@ declare enum TypeResponse {
     START_SHOPPING = "start_shopping"
 }
 
-/**
- * Aizu Chat API Client
- *
- * A client for interacting with the Aizu Chat API. Handles authentication,
- * request timeouts, and error handling automatically.
- *
- * @example
- * ```typescript
- * const client = new AizuClient({
- *   hostUrl: 'https://api.aizu.chat',
- *   apiKey: 'your-api-key',
- *   timeout: 30000
- * });
- *
- * const response = await client.chat({
- *   query: 'Hello, how are you?',
- *   conversationId: 'optional-conversation-id'
- * });
- * ```
- */
 declare class AizuClient {
     private hostUrl;
     private apiKey;
     private timeout;
-    /**
-     * Creates a new AizuClient instance
-     *
-     * @param config - Configuration options for the client
-     * @param config.hostUrl - The base URL of the Aizu API (e.g., 'https://api.aizu.chat')
-     * @param config.apiKey - Your API key for authentication
-     * @param config.timeout - Request timeout in milliseconds (default: 30000)
-     *
-     * @throws {Error} If hostUrl is not a non-empty string
-     * @throws {Error} If apiKey is not a non-empty string
-     *
-     * @example
-     * ```typescript
-     * const client = new AizuClient({
-     *   hostUrl: 'https://api.aizu.chat',
-     *   apiKey: 'sk_test_123456',
-     *   timeout: 60000 // 60 seconds
-     * });
-     * ```
-     */
     constructor(config: AizuClientConfig);
-    /**
-     * Internal method for making HTTP requests to the API
-     *
-     * Handles timeout management, abort signal combination, and error handling.
-     * Supports both user-initiated cancellation and automatic timeout.
-     *
-     * @template T - The expected response type
-     * @template TBody - The request body type
-     *
-     * @param path - API endpoint path (e.g., '/chat/query')
-     * @param options - Request options including body and signal
-     *
-     * @returns Promise resolving to the API response
-     *
-     * @throws {Error} "Request cancelled by user" - If the request is cancelled via AbortSignal
-     * @throws {Error} "Request timeout: The server took too long to respond" - If the request exceeds the timeout
-     * @throws {Error} "API Error: {status} {statusText}" - If the API returns an error status
-     *
-     * @private
-     */
     private request;
-    /**
-     * Sends a chat query to the Aizu API
-     *
-     * @param params - Chat request parameters
-     * @param params.query - The user's message/question (required, non-empty)
-     * @param params.conversationId - Optional conversation ID to continue an existing conversation
-     * @param options - Additional options
-     * @param options.signal - Optional AbortSignal to cancel the request
-     *
-     * @returns Promise resolving to the chat response from the API
-     *
-     * @throws {Error} "Query is required" - If query is empty or whitespace only
-     * @throws {Error} "Request cancelled by user" - If the request is cancelled
-     * @throws {Error} "Request timeout: The server took too long to respond" - If the request times out
-     * @throws {Error} "API Error: {status} {statusText}" - If the API returns an error
-     *
-     * @example
-     * ```typescript
-     * // Simple query
-     * const response = await client.chat({
-     *   query: 'What is the weather today?'
-     * });
-     * console.log(response.answer);
-     * ```
-     *
-     * @example
-     * ```typescript
-     * // Continue conversation
-     * const response1 = await client.chat({
-     *   query: 'What is the weather today?'
-     * });
-     *
-     * const response2 = await client.chat({
-     *   query: 'And tomorrow?',
-     *   conversationId: response1.conversationId
-     * });
-     * ```
-     *
-     * @example
-     * ```typescript
-     * // With cancellation support
-     * const controller = new AbortController();
-     *
-     * const promise = client.chat(
-     *   { query: 'Long running query...' },
-     *   { signal: controller.signal }
-     * );
-     *
-     * // Cancel after 5 seconds
-     * setTimeout(() => controller.abort(), 5000);
-     *
-     * try {
-     *   const response = await promise;
-     * } catch (error) {
-     *   console.error('Request was cancelled:', error);
-     * }
-     * ```
-     */
     chat(params: ChatRequest, options?: {
         signal?: AbortSignal;
     }): Promise<ChatResponse>;
 }
-/**
- * Factory function to create a new AizuClient instance
- *
- * This is a convenience function that wraps the AizuClient constructor.
- * Use this when you prefer a functional approach over instantiating the class directly.
- *
- * @param config - Configuration options for the client
- * @param config.hostUrl - The base URL of the Aizu API
- * @param config.apiKey - Your API key for authentication
- * @param config.timeout - Optional request timeout in milliseconds (default: 30000)
- *
- * @returns A new AizuClient instance
- *
- * @throws {Error} If hostUrl or apiKey are invalid
- *
- * @example
- * ```typescript
- * const client = createAizuClient({
- *   hostUrl: process.env.AIZU_HOST_URL!,
- *   apiKey: process.env.AIZU_API_KEY!,
- *   timeout: 45000
- * });
- *
- * const response = await client.chat({
- *   query: 'Hello!'
- * });
- * ```
- */
 declare const createAizuClient: ({ hostUrl, apiKey, timeout, }: {
     hostUrl: string;
     apiKey: string;