@providerprotocol/ai 0.0.1 → 0.0.3

package/src/providers/openrouter/index.ts

@@ -0,0 +1,173 @@
+import type {
+  Provider,
+  ModelReference,
+  LLMHandler,
+  LLMProvider,
+} from '../../types/provider.ts';
+import { createCompletionsLLMHandler } from './llm.completions.ts';
+import { createResponsesLLMHandler } from './llm.responses.ts';
+import type { OpenRouterLLMParams, OpenRouterConfig } from './types.ts';
+
+/**
+ * OpenRouter provider options
+ */
+export interface OpenRouterProviderOptions {
+  /**
+   * Which API to use:
+   * - 'completions': Chat Completions API (default, recommended)
+   * - 'responses': Responses API (beta)
+   */
+  api?: 'completions' | 'responses';
+}
+
+/**
+ * OpenRouter provider with configurable API mode
+ *
+ * @example
+ * // Using the Chat Completions API (default)
+ * const model = openrouter('openai/gpt-4o');
+ *
+ * @example
+ * // Using the Responses API (beta)
+ * const model = openrouter('openai/gpt-4o', { api: 'responses' });
+ *
+ * @example
+ * // Explicit Completions API
+ * const model = openrouter('anthropic/claude-3.5-sonnet', { api: 'completions' });
+ */
+export interface OpenRouterProvider extends Provider<OpenRouterProviderOptions> {
+  /**
+   * Create a model reference
+   * @param modelId - The model identifier (e.g., 'openai/gpt-4o', 'anthropic/claude-3.5-sonnet', 'meta-llama/llama-3.1-70b-instruct')
+   * @param options - Provider options including API selection
+   */
+  (modelId: string, options?: OpenRouterProviderOptions): ModelReference<OpenRouterProviderOptions>;
+
+  /** Provider name */
+  readonly name: 'openrouter';
+
+  /** Provider version */
+  readonly version: string;
+
+  /** Supported modalities */
+  readonly modalities: {
+    llm: LLMHandler<OpenRouterLLMParams>;
+  };
+}
+
+/**
+ * Create the OpenRouter provider
+ */
+function createOpenRouterProvider(): OpenRouterProvider {
+  // Track which API mode is currently active for the modalities
+  // Default to 'completions' (unlike OpenAI which defaults to 'responses')
+  let currentApiMode: 'completions' | 'responses' = 'completions';
+
+  // Create handlers eagerly so we can inject provider reference
+  const completionsHandler = createCompletionsLLMHandler();
+  const responsesHandler = createResponsesLLMHandler();
+
+  const fn = function (
+    modelId: string,
+    options?: OpenRouterProviderOptions
+  ): ModelReference<OpenRouterProviderOptions> {
+    const apiMode = options?.api ?? 'completions';
+    currentApiMode = apiMode;
+    return { modelId, provider };
+  };
+
+  // Create a dynamic modalities object that returns the correct handler
+  const modalities = {
+    get llm(): LLMHandler<OpenRouterLLMParams> {
+      return currentApiMode === 'responses'
+        ? responsesHandler
+        : completionsHandler;
+    },
+  };
+
+  // Define properties
+  Object.defineProperties(fn, {
+    name: {
+      value: 'openrouter',
+      writable: false,
+      configurable: true,
+    },
+    version: {
+      value: '1.0.0',
+      writable: false,
+      configurable: true,
+    },
+    modalities: {
+      value: modalities,
+      writable: false,
+      configurable: true,
+    },
+  });
+
+  const provider = fn as OpenRouterProvider;
+
+  // Inject provider reference into both handlers (spec compliance)
+  completionsHandler._setProvider?.(provider as unknown as LLMProvider<OpenRouterLLMParams>);
+  responsesHandler._setProvider?.(provider as unknown as LLMProvider<OpenRouterLLMParams>);
+
+  return provider;
+}
+
+/**
+ * OpenRouter provider
+ *
+ * Supports both the Chat Completions API (default) and Responses API (beta).
+ *
+ * OpenRouter is a unified API that provides access to hundreds of AI models
+ * through a single endpoint, including models from OpenAI, Anthropic, Google,
+ * Meta, Mistral, and many others.
+ *
+ * @example
+ * ```ts
+ * import { openrouter } from './providers/openrouter';
+ * import { llm } from './core/llm';
+ *
+ * // Using Chat Completions API (default, recommended)
+ * const model = llm({
+ *   model: openrouter('openai/gpt-4o'),
+ *   params: { max_tokens: 1000 }
+ * });
+ *
+ * // Using Responses API (beta)
+ * const betaModel = llm({
+ *   model: openrouter('openai/gpt-4o', { api: 'responses' }),
+ *   params: { max_output_tokens: 1000 }
+ * });
+ *
+ * // Using OpenRouter-specific features
+ * const routedModel = llm({
+ *   model: openrouter('openai/gpt-4o'),
+ *   params: {
+ *     max_tokens: 1000,
+ *     // Fallback routing
+ *     models: ['openai/gpt-4o', 'anthropic/claude-3.5-sonnet'],
+ *     route: 'fallback',
+ *     // Provider preferences
+ *     provider: {
+ *       allow_fallbacks: true,
+ *       require_parameters: true,
+ *     },
+ *   }
+ * });
+ *
+ * // Generate
+ * const turn = await model.generate('Hello!');
+ * console.log(turn.response.text);
+ * ```
+ */
+export const openrouter = createOpenRouterProvider();
+
+// Re-export types
+export type {
+  OpenRouterLLMParams,
+  OpenRouterConfig,
+  OpenRouterAPIMode,
+  OpenRouterModelOptions,
+  OpenRouterModelReference,
+  OpenRouterProviderPreferences,
+} from './types.ts';

package/src/providers/openrouter/llm.completions.ts

@@ -0,0 +1,201 @@
+import type { LLMHandler, BoundLLMModel, LLMRequest, LLMResponse, LLMStreamResult, LLMCapabilities } from '../../types/llm.ts';
+import type { StreamEvent } from '../../types/stream.ts';
+import type { LLMProvider } from '../../types/provider.ts';
+import { UPPError } from '../../types/errors.ts';
+import { resolveApiKey } from '../../http/keys.ts';
+import { doFetch, doStreamFetch } from '../../http/fetch.ts';
+import { parseSSEStream } from '../../http/sse.ts';
+import { normalizeHttpError } from '../../http/errors.ts';
+import type { OpenRouterLLMParams, OpenRouterCompletionsResponse, OpenRouterCompletionsStreamChunk } from './types.ts';
+import {
+  transformRequest,
+  transformResponse,
+  transformStreamEvent,
+  createStreamState,
+  buildResponseFromState,
+} from './transform.completions.ts';
+
+const OPENROUTER_API_URL = 'https://openrouter.ai/api/v1/chat/completions';
+
+/**
+ * OpenRouter API capabilities
+ */
+const OPENROUTER_CAPABILITIES: LLMCapabilities = {
+  streaming: true,
+  tools: true,
+  structuredOutput: true,
+  imageInput: true,
+  videoInput: false,
+  audioInput: false,
+};
+
+/**
+ * Create OpenRouter Chat Completions LLM handler
+ */
+export function createCompletionsLLMHandler(): LLMHandler<OpenRouterLLMParams> {
+  // Provider reference injected by createProvider() or OpenRouter's custom factory
+  let providerRef: LLMProvider<OpenRouterLLMParams> | null = null;
+
+  return {
+    _setProvider(provider: LLMProvider<OpenRouterLLMParams>) {
+      providerRef = provider;
+    },
+
+    bind(modelId: string): BoundLLMModel<OpenRouterLLMParams> {
+      // Use the injected provider reference
+      if (!providerRef) {
+        throw new UPPError(
+          'Provider reference not set. Handler must be used with createProvider() or have _setProvider called.',
+          'INVALID_REQUEST',
+          'openrouter',
+          'llm'
+        );
+      }
+
+      const model: BoundLLMModel<OpenRouterLLMParams> = {
+        modelId,
+        capabilities: OPENROUTER_CAPABILITIES,
+
+        get provider(): LLMProvider<OpenRouterLLMParams> {
+          return providerRef!;
+        },
+
+        async complete(request: LLMRequest<OpenRouterLLMParams>): Promise<LLMResponse> {
+          const apiKey = await resolveApiKey(
+            request.config,
+            'OPENROUTER_API_KEY',
+            'openrouter',
+            'llm'
+          );
+
+          const baseUrl = request.config.baseUrl ?? OPENROUTER_API_URL;
+          const body = transformRequest(request, modelId);
+
+          const response = await doFetch(
+            baseUrl,
+            {
+              method: 'POST',
+              headers: {
+                'Content-Type': 'application/json',
+                Authorization: `Bearer ${apiKey}`,
+              },
+              body: JSON.stringify(body),
+              signal: request.signal,
+            },
+            request.config,
+            'openrouter',
+            'llm'
+          );
+
+          const data = (await response.json()) as OpenRouterCompletionsResponse;
+          return transformResponse(data);
+        },
+
+        stream(request: LLMRequest<OpenRouterLLMParams>): LLMStreamResult {
+          const state = createStreamState();
+          let responseResolve: (value: LLMResponse) => void;
+          let responseReject: (error: Error) => void;
+
+          const responsePromise = new Promise<LLMResponse>((resolve, reject) => {
+            responseResolve = resolve;
+            responseReject = reject;
+          });
+
+          async function* generateEvents(): AsyncGenerator<StreamEvent, void, unknown> {
+            try {
+              const apiKey = await resolveApiKey(
+                request.config,
+                'OPENROUTER_API_KEY',
+                'openrouter',
+                'llm'
+              );
+
+              const baseUrl = request.config.baseUrl ?? OPENROUTER_API_URL;
+              const body = transformRequest(request, modelId);
+              body.stream = true;
+              body.stream_options = { include_usage: true };
+
+              const response = await doStreamFetch(
+                baseUrl,
+                {
+                  method: 'POST',
+                  headers: {
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${apiKey}`,
+                  },
+                  body: JSON.stringify(body),
+                  signal: request.signal,
+                },
+                request.config,
+                'openrouter',
+                'llm'
+              );
+
+              if (!response.ok) {
+                const error = await normalizeHttpError(response, 'openrouter', 'llm');
+                responseReject(error);
+                throw error;
+              }
+
+              if (!response.body) {
+                const error = new UPPError(
+                  'No response body for streaming request',
+                  'PROVIDER_ERROR',
+                  'openrouter',
+                  'llm'
+                );
+                responseReject(error);
+                throw error;
+              }
+
+              for await (const data of parseSSEStream(response.body)) {
+                // Skip [DONE] marker
+                if (data === '[DONE]') {
+                  continue;
+                }
+
+                // Check for OpenRouter error event
+                if (typeof data === 'object' && data !== null) {
+                  const chunk = data as OpenRouterCompletionsStreamChunk;
+
+                  // Check for error in chunk
+                  if ('error' in chunk && chunk.error) {
+                    const errorData = chunk.error as { message?: string; type?: string };
+                    const error = new UPPError(
+                      errorData.message ?? 'Unknown error',
+                      'PROVIDER_ERROR',
+                      'openrouter',
+                      'llm'
+                    );
+                    responseReject(error);
+                    throw error;
+                  }
+
+                  const uppEvents = transformStreamEvent(chunk, state);
+                  for (const event of uppEvents) {
+                    yield event;
+                  }
+                }
+              }
+
+              // Build final response
+              responseResolve(buildResponseFromState(state));
+            } catch (error) {
+              responseReject(error as Error);
+              throw error;
+            }
+          }
+
+          return {
+            [Symbol.asyncIterator]() {
+              return generateEvents();
+            },
+            response: responsePromise,
+          };
+        },
+      };
+
+      return model;
+    },
+  };
+}

package/src/providers/openrouter/llm.responses.ts

@@ -0,0 +1,211 @@
+import type { LLMHandler, BoundLLMModel, LLMRequest, LLMResponse, LLMStreamResult, LLMCapabilities } from '../../types/llm.ts';
+import type { StreamEvent } from '../../types/stream.ts';
+import type { LLMProvider } from '../../types/provider.ts';
+import { UPPError } from '../../types/errors.ts';
+import { resolveApiKey } from '../../http/keys.ts';
+import { doFetch, doStreamFetch } from '../../http/fetch.ts';
+import { parseSSEStream } from '../../http/sse.ts';
+import { normalizeHttpError } from '../../http/errors.ts';
+import type { OpenRouterLLMParams, OpenRouterResponsesResponse, OpenRouterResponsesStreamEvent, OpenRouterResponseErrorEvent } from './types.ts';
+import {
+  transformRequest,
+  transformResponse,
+  transformStreamEvent,
+  createStreamState,
+  buildResponseFromState,
+} from './transform.responses.ts';
+
+const OPENROUTER_RESPONSES_API_URL = 'https://openrouter.ai/api/v1/responses';
+
+/**
+ * OpenRouter API capabilities
+ */
+const OPENROUTER_CAPABILITIES: LLMCapabilities = {
+  streaming: true,
+  tools: true,
+  structuredOutput: true,
+  imageInput: true,
+  videoInput: false,
+  audioInput: false,
+};
+
+/**
+ * Create OpenRouter Responses API LLM handler
+ */
+export function createResponsesLLMHandler(): LLMHandler<OpenRouterLLMParams> {
+  // Provider reference injected by createProvider() or OpenRouter's custom factory
+  let providerRef: LLMProvider<OpenRouterLLMParams> | null = null;
+
+  return {
+    _setProvider(provider: LLMProvider<OpenRouterLLMParams>) {
+      providerRef = provider;
+    },
+
+    bind(modelId: string): BoundLLMModel<OpenRouterLLMParams> {
+      // Use the injected provider reference
+      if (!providerRef) {
+        throw new UPPError(
+          'Provider reference not set. Handler must be used with createProvider() or have _setProvider called.',
+          'INVALID_REQUEST',
+          'openrouter',
+          'llm'
+        );
+      }
+
+      const model: BoundLLMModel<OpenRouterLLMParams> = {
+        modelId,
+        capabilities: OPENROUTER_CAPABILITIES,
+
+        get provider(): LLMProvider<OpenRouterLLMParams> {
+          return providerRef!;
+        },
+
+        async complete(request: LLMRequest<OpenRouterLLMParams>): Promise<LLMResponse> {
+          const apiKey = await resolveApiKey(
+            request.config,
+            'OPENROUTER_API_KEY',
+            'openrouter',
+            'llm'
+          );
+
+          const baseUrl = request.config.baseUrl ?? OPENROUTER_RESPONSES_API_URL;
+          const body = transformRequest(request, modelId);
+
+          const response = await doFetch(
+            baseUrl,
+            {
+              method: 'POST',
+              headers: {
+                'Content-Type': 'application/json',
+                Authorization: `Bearer ${apiKey}`,
+              },
+              body: JSON.stringify(body),
+              signal: request.signal,
+            },
+            request.config,
+            'openrouter',
+            'llm'
+          );
+
+          const data = (await response.json()) as OpenRouterResponsesResponse;
+
+          // Check for error in response
+          if (data.status === 'failed' && data.error) {
+            throw new UPPError(
+              data.error.message,
+              'PROVIDER_ERROR',
+              'openrouter',
+              'llm'
+            );
+          }
+
+          return transformResponse(data);
+        },
+
+        stream(request: LLMRequest<OpenRouterLLMParams>): LLMStreamResult {
+          const state = createStreamState();
+          let responseResolve: (value: LLMResponse) => void;
+          let responseReject: (error: Error) => void;
+
+          const responsePromise = new Promise<LLMResponse>((resolve, reject) => {
+            responseResolve = resolve;
+            responseReject = reject;
+          });
+
+          async function* generateEvents(): AsyncGenerator<StreamEvent, void, unknown> {
+            try {
+              const apiKey = await resolveApiKey(
+                request.config,
+                'OPENROUTER_API_KEY',
+                'openrouter',
+                'llm'
+              );
+
+              const baseUrl = request.config.baseUrl ?? OPENROUTER_RESPONSES_API_URL;
+              const body = transformRequest(request, modelId);
+              body.stream = true;
+
+              const response = await doStreamFetch(
+                baseUrl,
+                {
+                  method: 'POST',
+                  headers: {
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${apiKey}`,
+                  },
+                  body: JSON.stringify(body),
+                  signal: request.signal,
+                },
+                request.config,
+                'openrouter',
+                'llm'
+              );
+
+              if (!response.ok) {
+                const error = await normalizeHttpError(response, 'openrouter', 'llm');
+                responseReject(error);
+                throw error;
+              }
+
+              if (!response.body) {
+                const error = new UPPError(
+                  'No response body for streaming request',
+                  'PROVIDER_ERROR',
+                  'openrouter',
+                  'llm'
+                );
+                responseReject(error);
+                throw error;
+              }
+
+              for await (const data of parseSSEStream(response.body)) {
+                // Skip [DONE] marker
+                if (data === '[DONE]') {
+                  continue;
+                }
+
+                // Check for OpenRouter error event
+                if (typeof data === 'object' && data !== null) {
+                  const event = data as OpenRouterResponsesStreamEvent;
+
+                  // Check for error event
+                  if (event.type === 'error') {
+                    const errorEvent = event as OpenRouterResponseErrorEvent;
+                    const error = new UPPError(
+                      errorEvent.error.message,
+                      'PROVIDER_ERROR',
+                      'openrouter',
+                      'llm'
+                    );
+                    responseReject(error);
+                    throw error;
+                  }
+
+                  const uppEvents = transformStreamEvent(event, state);
+                  for (const uppEvent of uppEvents) {
+                    yield uppEvent;
+                  }
+                }
+              }
+
+              // Build final response
+              responseResolve(buildResponseFromState(state));
+            } catch (error) {
+              responseReject(error as Error);
+              throw error;
+            }
+          }
+
+          return {
+            [Symbol.asyncIterator]() {
+              return generateEvents();
+            },
+            response: responsePromise,
+          };
+        },
+      };
+
+      return model;
+    },
+  };
+}