ai.matey.frontend 0.2.0 → 0.3.0

package/dist/types/adapters/gemini.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gemini.d.ts","sourceRoot":"","sources":["../../../src/adapters/gemini.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAa,MAAM,gBAAgB,CAAC;AAC9F,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAM9D,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,UAAU,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC,CAAC;CACrF;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,iBAAiB,CAAC,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC;IACvD,gBAAgB,CAAC,EAAE;QACjB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;KAC1B,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,KAAK,CAAC;QAChB,OAAO,EAAE,aAAa,CAAC;QACvB,YAAY,EAAE,MAAM,GAAG,YAAY,GAAG,QAAQ,GAAG,YAAY,GAAG,OAAO,CAAC;KACzE,CAAC,CAAC;IACH,aAAa,CAAC,EAAE;QACd,gBAAgB,EAAE,MAAM,CAAC;QACzB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED,qBAAa,qBAAsB,YAAW,eAAe,CAAC,aAAa,EAAE,cAAc,CAAC;IAC1F,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAWhC;IAEF,IAAI,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAkCpD,MAAM,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IA8BlD,YAAY,CACjB,MAAM,EAAE,cAAc,CAAC,aAAa,CAAC,EACrC,QAAQ,CAAC,EAAE,uBAAuB,GACjC,cAAc,CAAC,MAAM,CAAC;CAS1B"}
+{"version":3,"file":"gemini.d.ts","sourceRoot":"","sources":["../../../src/adapters/gemini.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAa,MAAM,gBAAgB,CAAC;AAC9F,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAM9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,aAAa;IAC5B,qEAAqE;IACrE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAEvB,qEAAqE;IACrE,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,UAAU,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC,CAAC;CACrF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,WAAW,aAAa;IAC5B,+DAA+D;IAC/D,QAAQ,EAAE,aAAa,EAAE,CAAC;IAE1B,yDAAyD;IACzD,iBAAiB,CAAC,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC;IAEvD,oDAAoD;IACpD,gBAAgB,CAAC,EAAE;QACjB,0DAA0D;QAC1D,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,qCAAqC;QACrC,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,+BAA+B;QAC/B,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd,iCAAiC;QACjC,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB,yDAAyD;QACzD,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;KAC1B,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,WAAW,cAAc;IAC7B,sDAAsD;IACtD,UAAU,EAAE,KAAK,CAAC;QAChB,uCAAuC;QACvC,OAAO,EAAE,aAAa,CAAC;QAEvB,iGAAiG;QACjG,YAAY,EAAE,MAAM,GAAG,YAAY,GAAG,QAAQ,GAAG,YAAY,GAAG,OAAO,CAAC;KACzE,CAAC,CAAC;IAEH,6BAA6B;IAC7B,aAAa,CAAC,EAAE;QACd,qCAAqC;QACrC,gBAAgB,EAAE,MAAM,CAAC;QAEzB,yCAAyC;QACzC,oBAAoB,EAAE,MAAM,CAAC;QAE7B,8CAA8C;QAC9C,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH;AAED,qBAAa,qBAAsB,YAAW,eAAe,CAAC,aAAa,EAAE,cAAc,CAAC;IAC1F,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAWhC;IAEF;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAkCpD;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IA8BzD;;;;;;;;;;;;;;;;;;OAkBG;IACI,YAAY,CACjB,MAAM,EAAE,cAAc,CAAC,aAAa,CAAC,EACrC,QAAQ,CAAC,EAAE,uBAAuB,GACjC,cAAc,CAAC,MAAM,CAAC;CAS1B"}

package/dist/types/adapters/generic.d.ts

@@ -83,17 +83,69 @@ export declare class GenericFrontendAdapter implements FrontendAdapter<IRChatReq
     private readonly config;
     constructor(config?: GenericFrontendConfig);
     /**
-     * Pass through IR request (no conversion needed).
+     * Pass through Universal IR request without conversion.
      *
-     * Optionally adds provenance tracking if enabled.
+     * This method accepts an IR request and returns it directly, as this is
+     * a passthrough adapter. When provenance tracking is enabled (default),
+     * it adds the frontend adapter name to the provenance metadata for
+     * tracking purposes, but otherwise performs no transformations.
+     *
+     * @param request - Universal IR chat request
+     * @returns Promise resolving to the same IR request (with optional provenance)
+     *
+     * @example
+     * ```typescript
+     * const adapter = new GenericFrontendAdapter();
+     * const irRequest = await adapter.toIR({
+     *   messages: [{ role: 'user', content: 'Hello!' }],
+     *   parameters: { model: 'gpt-4', temperature: 0.7 },
+     *   metadata: { requestId: 'req_123', timestamp: Date.now(), provenance: {} }
+     * });
+     * // Returns the same request with provenance.frontend = 'generic-frontend'
+     * ```
      */
     toIR(request: IRChatRequest): Promise<IRChatRequest>;
     /**
-     * Pass through IR response (no conversion needed).
+     * Pass through Universal IR response without conversion.
+     *
+     * This method accepts an IR response and returns it directly without
+     * any transformation. Since this is a passthrough adapter, the response
+     * remains in IR format, allowing applications to work directly with
+     * the universal format.
+     *
+     * @param response - Universal IR chat response
+     * @returns Promise resolving to the same IR response
+     *
+     * @example
+     * ```typescript
+     * const adapter = new GenericFrontendAdapter();
+     * const irResponse = await adapter.fromIR(irResponse);
+     * // Returns the exact same response unchanged
+     * console.log(irResponse.message.content);
+     * ```
      */
     fromIR(response: IRChatResponse): Promise<IRChatResponse>;
     /**
-     * Pass through IR stream chunks (no conversion needed).
+     * Pass through Universal IR stream chunks without conversion.
+     *
+     * This async generator method accepts an IR stream and yields each chunk
+     * directly without any transformation. Unlike other frontend adapters that
+     * convert to provider-specific formats (SSE, JSON, etc.), this maintains
+     * the raw IR chunk structure for direct consumption.
+     *
+     * @param stream - Universal IR chat stream
+     * @param _options - Optional stream conversion options (currently unused)
+     * @yields IR stream chunks unchanged
+     *
+     * @example
+     * ```typescript
+     * const adapter = new GenericFrontendAdapter();
+     * for await (const chunk of adapter.fromIRStream(irStream)) {
+     *   if (chunk.type === 'content') {
+     *     console.log(chunk.delta); // Access IR structure directly
+     *   }
+     * }
+     * ```
      */
     fromIRStream(stream: IRChatStream, _options?: StreamConversionOptions): AsyncGenerator<IRStreamChunk, void, undefined>;
     /**

package/dist/types/adapters/generic.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generic.d.ts","sourceRoot":"","sources":["../../../src/adapters/generic.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,YAAY,EACZ,aAAa,EACb,uBAAuB,EACxB,MAAM,gBAAgB,CAAC;AAMxB;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAEpC;;;OAGG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC9C;AAMD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,sBAAuB,YAAW,eAAe,CAC5D,aAAa,EACb,cAAc,EACd,aAAa,CACd;IACC,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;gBAEnC,MAAM,GAAE,qBAA0B;IAyB9C;;;;OAIG;IACH,IAAI,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAkBpD;;OAEG;IACH,MAAM,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzD;;OAEG;IACI,YAAY,CACjB,MAAM,EAAE,YAAY,EACpB,QAAQ,CAAC,EAAE,uBAAuB,GACjC,cAAc,CAAC,aAAa,EAAE,IAAI,EAAE,SAAS,CAAC;IAMjD;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;CAoBhD;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,sBAAsB,CAE5F;AAMD,eAAe,sBAAsB,CAAC"}
+{"version":3,"file":"generic.d.ts","sourceRoot":"","sources":["../../../src/adapters/generic.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,KAAK,EACV,aAAa,EACb,cAAc,EACd,YAAY,EACZ,aAAa,EACb,uBAAuB,EACxB,MAAM,gBAAgB,CAAC;AAMxB;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAEpC;;;OAGG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC9C;AAMD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,sBAAuB,YAAW,eAAe,CAC5D,aAAa,EACb,cAAc,EACd,aAAa,CACd;IACC,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;gBAEnC,MAAM,GAAE,qBAA0B;IAyB9C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAkBpD;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAIzD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,YAAY,CACjB,MAAM,EAAE,YAAY,EACpB,QAAQ,CAAC,EAAE,uBAAuB,GACjC,cAAc,CAAC,aAAa,EAAE,IAAI,EAAE,SAAS,CAAC;IAMjD;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;CAoBhD;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,sBAAsB,CAE5F;AAMD,eAAe,sBAAsB,CAAC"}

package/dist/types/adapters/mistral.d.ts

@@ -8,40 +8,183 @@
 import type { FrontendAdapter, AdapterMetadata } from 'ai.matey.types';
 import type { IRChatRequest, IRChatResponse, IRStreamChunk } from 'ai.matey.types';
 import type { StreamConversionOptions } from 'ai.matey.types';
+/**
+ * Mistral message structure.
+ *
+ * Mistral uses a straightforward message format similar to OpenAI with
+ * system, user, and assistant roles. Content is always a simple string.
+ *
+ * @see MistralRequest
+ */
 export interface MistralMessage {
+    /** Message role: system, user, or assistant */
     role: 'system' | 'user' | 'assistant';
+    /** Message content as plain text */
     content: string;
 }
+/**
+ * Mistral AI API request structure.
+ *
+ * Follows OpenAI-compatible format with some Mistral-specific features like
+ * safe_mode and random_seed. Compatible with Mistral's chat completion endpoint.
+ *
+ * @see MistralMessage
+ * @see MistralResponse
+ * @see https://docs.mistral.ai/api/
+ *
+ * @example
+ * ```typescript
+ * const request: MistralRequest = {
+ *   model: 'mistral-small',
+ *   messages: [
+ *     { role: 'user', content: 'Hello!' }
+ *   ],
+ *   temperature: 0.7,
+ *   max_tokens: 150
+ * };
+ * ```
+ */
 export interface MistralRequest {
+    /** Model ID (e.g., 'mistral-small', 'mistral-medium', 'mistral-large') */
     model: string;
+    /** Array of conversation messages */
     messages: MistralMessage[];
+    /** Sampling temperature 0-1. Higher = more random */
     temperature?: number;
+    /** Maximum tokens to generate */
     max_tokens?: number;
+    /** Nucleus sampling parameter 0-1 */
     top_p?: number;
+    /** Enable streaming responses */
     stream?: boolean;
+    /** Enable Mistral's content safety filter */
     safe_mode?: boolean;
+    /** Deterministic sampling seed */
     random_seed?: number;
 }
+/**
+ * Mistral AI API response structure.
+ *
+ * OpenAI-compatible response format with Mistral-specific finish reasons.
+ * Includes generated message and token usage statistics.
+ *
+ * @see MistralRequest
+ * @see MistralMessage
+ *
+ * @example
+ * ```typescript
+ * const response: MistralResponse = {
+ *   id: 'cmpl-123',
+ *   object: 'chat.completion',
+ *   created: 1677652288,
+ *   model: 'mistral-small',
+ *   choices: [{
+ *     index: 0,
+ *     message: {
+ *       role: 'assistant',
+ *       content: 'Hello! How can I help?'
+ *     },
+ *     finish_reason: 'stop'
+ *   }],
+ *   usage: {
+ *     prompt_tokens: 10,
+ *     completion_tokens: 6,
+ *     total_tokens: 16
+ *   }
+ * };
+ * ```
+ */
 export interface MistralResponse {
+    /** Unique completion identifier */
     id: string;
+    /** Object type - always 'chat.completion' */
     object: 'chat.completion';
+    /** Unix timestamp of creation */
     created: number;
+    /** Model used for generation */
     model: string;
+    /** Array of completion choices (usually one) */
     choices: Array<{
+        /** Choice index */
         index: number;
+        /** Generated message */
         message: MistralMessage;
+        /** Stop reason: 'stop', 'length', 'model_length', or null */
         finish_reason: 'stop' | 'length' | 'model_length' | null;
     }>;
+    /** Token usage statistics */
     usage: {
+        /** Tokens in prompt */
         prompt_tokens: number;
+        /** Tokens in completion */
         completion_tokens: number;
+        /** Total tokens used */
         total_tokens: number;
     };
 }
 export declare class MistralFrontendAdapter implements FrontendAdapter<MistralRequest, MistralResponse> {
     readonly metadata: AdapterMetadata;
+    /**
+     * Convert Mistral API request to Universal IR format.
+     *
+     * This method transforms a Mistral-formatted request into the standardized
+     * Intermediate Representation (IR) format. Since Mistral's format is similar
+     * to OpenAI and close to IR, this is largely a pass-through adapter with
+     * field name mapping (e.g., random_seed → seed).
+     *
+     * @param request - Mistral API request
+     * @returns Promise resolving to IR chat request
+     *
+     * @example
+     * ```typescript
+     * const adapter = new MistralFrontendAdapter();
+     * const irRequest = await adapter.toIR({
+     *   model: 'mistral-small',
+     *   messages: [{ role: 'user', content: 'Hello!' }],
+     *   temperature: 0.7
+     * });
+     * ```
+     */
     toIR(request: MistralRequest): Promise<IRChatRequest>;
+    /**
+     * Convert Universal IR response back to Mistral API format.
+     *
+     * This method transforms the standardized IR response into the format
+     * expected by Mistral's API. It handles message conversion, finish reason
+     * mapping (stop, length, model_length), and usage statistics formatting
+     * specific to Mistral's response structure.
+     *
+     * @param response - Universal IR chat response
+     * @returns Promise resolving to Mistral API response
+     *
+     * @example
+     * ```typescript
+     * const adapter = new MistralFrontendAdapter();
+     * const mistralResponse = await adapter.fromIR(irResponse);
+     * console.log(mistralResponse.choices[0].message.content);
+     * ```
+     */
     fromIR(response: IRChatResponse): Promise<MistralResponse>;
+    /**
+     * Convert Universal IR stream to Mistral Server-Sent Events format.
+     *
+     * This async generator method transforms a stream of IR chunks into
+     * Mistral-formatted SSE responses. It yields Server-Sent Event strings
+     * with the "data: " prefix containing JSON with delta content, and
+     * emits "data: [DONE]" when the stream completes.
+     *
+     * @param stream - Universal IR chat stream
+     * @param _options - Optional stream conversion options (currently unused)
+     * @yields Server-Sent Event formatted strings
+     *
+     * @example
+     * ```typescript
+     * const adapter = new MistralFrontendAdapter();
+     * for await (const sseData of adapter.fromIRStream(irStream)) {
+     *   console.log(sseData); // "data: {...}\n\n" or "data: [DONE]\n\n"
+     * }
+     * ```
+     */
     fromIRStream(stream: AsyncGenerator<IRStreamChunk>, _options?: StreamConversionOptions): AsyncGenerator<string>;
 }
 //# sourceMappingURL=mistral.d.ts.map

package/dist/types/adapters/mistral.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mistral.d.ts","sourceRoot":"","sources":["../../../src/adapters/mistral.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAa,MAAM,gBAAgB,CAAC;AAC9F,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAG9D,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,iBAAiB,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,KAAK,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,cAAc,CAAC;QACxB,aAAa,EAAE,MAAM,GAAG,QAAQ,GAAG,cAAc,GAAG,IAAI,CAAC;KAC1D,CAAC,CAAC;IACH,KAAK,EAAE;QACL,aAAa,EAAE,MAAM,CAAC;QACtB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED,qBAAa,sBAAuB,YAAW,eAAe,CAAC,cAAc,EAAE,eAAe,CAAC;IAC7F,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAWhC;IAEF,IAAI,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAwBrD,MAAM,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IA+BnD,YAAY,CACjB,MAAM,EAAE,cAAc,CAAC,aAAa,CAAC,EACrC,QAAQ,CAAC,EAAE,uBAAuB,GACjC,cAAc,CAAC,MAAM,CAAC;CAS1B"}
+{"version":3,"file":"mistral.d.ts","sourceRoot":"","sources":["../../../src/adapters/mistral.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAa,MAAM,gBAAgB,CAAC;AAC9F,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAG9D;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,+CAA+C;IAC/C,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;IAEtC,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,cAAc;IAC7B,0EAA0E;IAC1E,KAAK,EAAE,MAAM,CAAC;IAEd,qCAAqC;IACrC,QAAQ,EAAE,cAAc,EAAE,CAAC;IAE3B,qDAAqD;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,qCAAqC;IACrC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,iCAAiC;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,6CAA6C;IAC7C,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,WAAW,eAAe;IAC9B,mCAAmC;IACnC,EAAE,EAAE,MAAM,CAAC;IAEX,6CAA6C;IAC7C,MAAM,EAAE,iBAAiB,CAAC;IAE1B,iCAAiC;IACjC,OAAO,EAAE,MAAM,CAAC;IAEhB,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IAEd,gDAAgD;IAChD,OAAO,EAAE,KAAK,CAAC;QACb,mBAAmB;QACnB,KAAK,EAAE,MAAM,CAAC;QAEd,wBAAwB;QACxB,OAAO,EAAE,cAAc,CAAC;QAExB,6DAA6D;QAC7D,aAAa,EAAE,MAAM,GAAG,QAAQ,GAAG,cAAc,GAAG,IAAI,CAAC;KAC1D,CAAC,CAAC;IAEH,6BAA6B;IAC7B,KAAK,EAAE;QACL,uBAAuB;QACvB,aAAa,EAAE,MAAM,CAAC;QAEtB,2BAA2B;QAC3B,iBAAiB,EAAE,MAAM,CAAC;QAE1B,wBAAwB;QACxB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED,qBAAa,sBAAuB,YAAW,eAAe,CAAC,cAAc,EAAE,eAAe,CAAC;IAC7F,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAWhC;IAEF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAwBrD;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IA+B1D;;;;;;;;;;;;;;;;;;;OAmBG;IACI,YAAY,CACjB,MAAM,EAAE,cAAc,CAAC,aAAa,CAAC,EACrC,QAAQ,CAAC,EAAE,uBAAuB,GACjC,cAAc,CAAC,MAAM,CAAC;CAS1B"}

package/dist/types/adapters/ollama.d.ts

@@ -9,36 +9,168 @@
 import type { FrontendAdapter, AdapterMetadata } from 'ai.matey.types';
 import type { IRChatRequest, IRChatResponse, IRStreamChunk } from 'ai.matey.types';
 import type { StreamConversionOptions } from 'ai.matey.types';
+/**
+ * Ollama message structure.
+ *
+ * Simple message format for local Ollama models with standard roles.
+ *
+ * @see OllamaRequest
+ */
 export interface OllamaMessage {
+    /** Message role */
     role: 'system' | 'user' | 'assistant';
+    /** Message content */
     content: string;
 }
+/**
+ * Ollama API request structure for local models.
+ *
+ * Ollama provides a local server for running LLMs. Parameters are nested
+ * in an `options` object, and uses `num_predict` instead of `max_tokens`.
+ *
+ * @see OllamaMessage
+ * @see OllamaResponse
+ * @see https://github.com/ollama/ollama/blob/main/docs/api.md
+ *
+ * @example
+ * ```typescript
+ * const request: OllamaRequest = {
+ *   model: 'llama2',
+ *   messages: [{ role: 'user', content: 'Hello!' }],
+ *   options: {
+ *     temperature: 0.7,
+ *     num_predict: 100
+ *   }
+ * };
+ * ```
+ */
 export interface OllamaRequest {
+    /** Local model name (e.g., 'llama2', 'mistral', 'codellama') */
     model: string;
+    /** Conversation messages */
     messages: OllamaMessage[];
+    /** Model parameters nested in options object */
     options?: {
+        /** Sampling temperature */
         temperature?: number;
+        /** Nucleus sampling */
         top_p?: number;
+        /** Top-K sampling */
         top_k?: number;
+        /** Maximum tokens to predict (Ollama uses 'predict' not 'tokens') */
         num_predict?: number;
+        /** Stop sequences */
         stop?: string[];
     };
+    /** Enable streaming responses */
     stream?: boolean;
 }
+/**
+ * Ollama API response structure.
+ *
+ * Includes the generated message plus performance metrics like duration
+ * and token counts specific to local model execution.
+ *
+ * @see OllamaRequest
+ * @see OllamaMessage
+ *
+ * @example
+ * ```typescript
+ * const response: OllamaResponse = {
+ *   model: 'llama2',
+ *   created_at: '2024-01-15T12:00:00Z',
+ *   message: {
+ *     role: 'assistant',
+ *     content: 'Hello! How can I help?'
+ *   },
+ *   done: true,
+ *   total_duration: 1500000000,
+ *   prompt_eval_count: 10,
+ *   eval_count: 6
+ * };
+ * ```
+ */
 export interface OllamaResponse {
+    /** Model that generated the response */
     model: string;
+    /** ISO 8601 timestamp */
     created_at: string;
+    /** Generated message */
     message: OllamaMessage;
+    /** Whether generation is complete */
     done: boolean;
+    /** Total inference duration in nanoseconds */
     total_duration?: number;
+    /** Model loading duration in nanoseconds */
     load_duration?: number;
+    /** Number of tokens in prompt evaluation */
     prompt_eval_count?: number;
+    /** Number of tokens in generation */
     eval_count?: number;
 }
 export declare class OllamaFrontendAdapter implements FrontendAdapter<OllamaRequest, OllamaResponse> {
     readonly metadata: AdapterMetadata;
+    /**
+     * Convert Ollama API request to Universal IR format.
+     *
+     * This method transforms an Ollama-formatted request into the standardized
+     * Intermediate Representation (IR) format. It handles Ollama's unique
+     * structure where parameters are nested in an `options` object, and maps
+     * Ollama-specific field names (e.g., num_predict → maxTokens).
+     *
+     * @param request - Ollama API request
+     * @returns Promise resolving to IR chat request
+     *
+     * @example
+     * ```typescript
+     * const adapter = new OllamaFrontendAdapter();
+     * const irRequest = await adapter.toIR({
+     *   model: 'llama2',
+     *   messages: [{ role: 'user', content: 'Hello!' }],
+     *   options: { temperature: 0.7, num_predict: 100 }
+     * });
+     * ```
+     */
     toIR(request: OllamaRequest): Promise<IRChatRequest>;
+    /**
+     * Convert Universal IR response back to Ollama API format.
+     *
+     * This method transforms the standardized IR response into the format
+     * expected by Ollama's API. It handles message conversion, formats the
+     * timestamp as ISO string, and maps usage statistics to Ollama's format
+     * (prompt_eval_count and eval_count instead of token counts).
+     *
+     * @param response - Universal IR chat response
+     * @returns Promise resolving to Ollama API response
+     *
+     * @example
+     * ```typescript
+     * const adapter = new OllamaFrontendAdapter();
+     * const ollamaResponse = await adapter.fromIR(irResponse);
+     * console.log(ollamaResponse.message.content);
+     * ```
+     */
     fromIR(response: IRChatResponse): Promise<OllamaResponse>;
+    /**
+     * Convert Universal IR stream to Ollama streaming format.
+     *
+     * This async generator method transforms a stream of IR chunks into
+     * Ollama-formatted responses. It yields newline-delimited JSON objects
+     * (not SSE format) with each chunk containing a message and done flag,
+     * emitting `done: true` when the stream completes.
+     *
+     * @param stream - Universal IR chat stream
+     * @param _options - Optional stream conversion options (currently unused)
+     * @yields Newline-delimited JSON strings
+     *
+     * @example
+     * ```typescript
+     * const adapter = new OllamaFrontendAdapter();
+     * for await (const jsonLine of adapter.fromIRStream(irStream)) {
+     *   console.log(jsonLine); // '{"message":{"content":"text"},"done":false}\n'
+     * }
+     * ```
+     */
     fromIRStream(stream: AsyncGenerator<IRStreamChunk>, _options?: StreamConversionOptions): AsyncGenerator<string>;
 }
 //# sourceMappingURL=ollama.d.ts.map

package/dist/types/adapters/ollama.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ollama.d.ts","sourceRoot":"","sources":["../../../src/adapters/ollama.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAa,MAAM,gBAAgB,CAAC;AAC9F,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAM9D,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,OAAO,CAAC,EAAE;QACR,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IACF,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,aAAa,CAAC;IACvB,IAAI,EAAE,OAAO,CAAC;IACd,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,qBAAa,qBAAsB,YAAW,eAAe,CAAC,aAAa,EAAE,cAAc,CAAC;IAC1F,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAWhC;IAEF,IAAI,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAyBpD,MAAM,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAclD,YAAY,CACjB,MAAM,EAAE,cAAc,CAAC,aAAa,CAAC,EACrC,QAAQ,CAAC,EAAE,uBAAuB,GACjC,cAAc,CAAC,MAAM,CAAC;CAS1B"}
+{"version":3,"file":"ollama.d.ts","sourceRoot":"","sources":["../../../src/adapters/ollama.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAa,MAAM,gBAAgB,CAAC;AAC9F,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAM9D;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,mBAAmB;IACnB,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,WAAW,CAAC;IAEtC,sBAAsB;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,aAAa;IAC5B,gEAAgE;IAChE,KAAK,EAAE,MAAM,CAAC;IAEd,4BAA4B;IAC5B,QAAQ,EAAE,aAAa,EAAE,CAAC;IAE1B,gDAAgD;IAChD,OAAO,CAAC,EAAE;QACR,2BAA2B;QAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,uBAAuB;QACvB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,qBAAqB;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf,qEAAqE;QACrE,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB,qBAAqB;QACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC;IAEF,iCAAiC;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,cAAc;IAC7B,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;IAEd,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IAEnB,wBAAwB;IACxB,OAAO,EAAE,aAAa,CAAC;IAEvB,qCAAqC;IACrC,IAAI,EAAE,OAAO,CAAC;IAEd,8CAA8C;IAC9C,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,4CAA4C;IAC5C,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,4CAA4C;IAC5C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,qCAAqC;IACrC,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,qBAAa,qBAAsB,YAAW,eAAe,CAAC,aAAa,EAAE,cAAc,CAAC;IAC1F,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAWhC;IAEF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;IAyBpD;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;IAczD;;;;;;;;;;;;;;;;;;;OAmBG;IACI,YAAY,CACjB,MAAM,EAAE,cAAc,CAAC,aAAa,CAAC,EACrC,QAAQ,CAAC,EAAE,uBAAuB,GACjC,cAAc,CAAC,MAAM,CAAC;CAS1B"}