@effect/ai-openrouter 4.0.0-beta.7 → 4.0.0-beta.71

package/src/OpenRouterConfig.ts

@@ -1,35 +1,83 @@
 /**
- * @since 1.0.0
+ * The `OpenRouterConfig` module provides scoped contextual configuration for
+ * OpenRouter request execution. It lets a workflow customize the HTTP client
+ * used by generated OpenRouter request methods without rebuilding the
+ * `OpenRouterClient` layer.
+ *
+ * **Mental model**
+ *
+ * - {@link OpenRouterConfig} is a context service carrying optional
+ *   OpenRouter-specific request configuration
+ * - {@link withClientTransform} provides that service around one effect
+ * - Generated request methods read the current context and apply the transform
+ *   to their `HttpClient`
+ * - The scoped configuration only applies while the returned effect is run
+ *
+ * **Common tasks**
+ *
+ * - Add request logging, retries, proxy routing, headers, or test doubles with
+ *   {@link withClientTransform}
+ * - Scope OpenRouter client customization to one workflow without changing the
+ *   shared client layer
+ *
+ * **Gotchas**
+ *
+ * - Each {@link withClientTransform} call replaces the current scoped
+ *   transform for the supplied effect; compose transforms manually when both
+ *   behaviors should apply
+ * - The transform receives and returns an `HttpClient`, so it should preserve
+ *   the OpenRouter request contract while adding behavior around it
+ * - Streaming chat completion requests are sent directly by `OpenRouterClient`
+ *   and do not read this scoped transform
+ *
+ * @since 4.0.0
  */
+import * as Context from "effect/Context"
 import * as Effect from "effect/Effect"
 import { dual } from "effect/Function"
-import * as ServiceMap from "effect/ServiceMap"
 import type { HttpClient } from "effect/unstable/http/HttpClient"
 
 /**
- * @since 1.0.0
+ * Context service carrying scoped OpenRouter provider configuration for client
+ * operations.
+ *
+ * **When to use**
+ *
+ * Use as the context service tag when manually providing or reading scoped
+ * OpenRouter provider configuration in an Effect context.
+ *
+ * @see {@link withClientTransform} for scoping an HTTP client transformation
+ *
  * @category services
+ * @since 4.0.0
  */
-export class OpenRouterConfig extends ServiceMap.Service<
+export class OpenRouterConfig extends Context.Service<
   OpenRouterConfig,
   OpenRouterConfig.Service
 >()("@effect/ai-openrouter/OpenRouterConfig") {
   /**
-   * @since 1.0.0
+   * Gets the configured OpenRouter service from the current context when present.
+   *
+   * @since 4.0.0
    */
   static readonly getOrUndefined: Effect.Effect<typeof OpenRouterConfig.Service | undefined> = Effect.map(
-    Effect.services<never>(),
+    Effect.context<never>(),
     (services) => services.mapUnsafe.get(OpenRouterConfig.key)
   )
 }
 
 /**
- * @since 1.0.0
+ * Types associated with the `OpenRouterConfig` context service.
+ *
+ * @since 4.0.0
  */
 export declare namespace OpenRouterConfig {
   /**
-   * @since 1.0.0
+   * Configuration values read by OpenRouter provider operations when resolving
+   * the generated HTTP client.
+   *
    * @category models
+   * @since 4.0.0
    */
   export interface Service {
     readonly transformClient?: ((client: HttpClient) => HttpClient) | undefined
@@ -37,18 +85,81 @@ export declare namespace OpenRouterConfig {
 }
 
 /**
- * @since 1.0.0
+ * Provides a scoped transform for the OpenRouter HTTP client used by provider
+ * operations.
+ *
+ * **When to use**
+ *
+ * Use when a single effect or workflow needs temporary OpenRouter HTTP client
+ * customization without rebuilding the client layer.
+ *
+ * **Details**
+ *
+ * Supports both data-first and data-last forms. The transform is stored in the
+ * scoped `OpenRouterConfig` service and read by generated OpenRouter request
+ * operations while running the supplied effect.
+ *
+ * **Gotchas**
+ *
+ * If a transform is already present in the scoped config, this helper replaces
+ * it. Compose transforms manually when both should apply. Streaming chat
+ * completion requests are sent directly by `OpenRouterClient.make` and do not
+ * read this scoped transform.
+ *
  * @category configuration
+ * @since 4.0.0
  */
 export const withClientTransform: {
   /**
-   * @since 1.0.0
+   * Provides a scoped transform for the OpenRouter HTTP client used by provider
+   * operations.
+   *
+   * **When to use**
+   *
+   * Use when a single effect or workflow needs temporary OpenRouter HTTP client
+   * customization without rebuilding the client layer.
+   *
+   * **Details**
+   *
+   * Supports both data-first and data-last forms. The transform is stored in the
+   * scoped `OpenRouterConfig` service and read by generated OpenRouter request
+   * operations while running the supplied effect.
+   *
+   * **Gotchas**
+   *
+   * If a transform is already present in the scoped config, this helper replaces
+   * it. Compose transforms manually when both should apply. Streaming chat
+   * completion requests are sent directly by `OpenRouterClient.make` and do not
+   * read this scoped transform.
+   *
    * @category configuration
+   * @since 4.0.0
    */
   (transform: (client: HttpClient) => HttpClient): <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
   /**
-   * @since 1.0.0
+   * Provides a scoped transform for the OpenRouter HTTP client used by provider
+   * operations.
+   *
+   * **When to use**
+   *
+   * Use when a single effect or workflow needs temporary OpenRouter HTTP client
+   * customization without rebuilding the client layer.
+   *
+   * **Details**
+   *
+   * Supports both data-first and data-last forms. The transform is stored in the
+   * scoped `OpenRouterConfig` service and read by generated OpenRouter request
+   * operations while running the supplied effect.
+   *
+   * **Gotchas**
+   *
+   * If a transform is already present in the scoped config, this helper replaces
+   * it. Compose transforms manually when both should apply. Streaming chat
+   * completion requests are sent directly by `OpenRouterClient.make` and do not
+   * read this scoped transform.
+   *
    * @category configuration
+   * @since 4.0.0
    */
   <A, E, R>(
     self: Effect.Effect<A, E, R>,
@@ -56,13 +167,55 @@ export const withClientTransform: {
   ): Effect.Effect<A, E, R>
 } = dual<
   /**
-   * @since 1.0.0
+   * Provides a scoped transform for the OpenRouter HTTP client used by provider
+   * operations.
+   *
+   * **When to use**
+   *
+   * Use when a single effect or workflow needs temporary OpenRouter HTTP client
+   * customization without rebuilding the client layer.
+   *
+   * **Details**
+   *
+   * Supports both data-first and data-last forms. The transform is stored in the
+   * scoped `OpenRouterConfig` service and read by generated OpenRouter request
+   * operations while running the supplied effect.
+   *
+   * **Gotchas**
+   *
+   * If a transform is already present in the scoped config, this helper replaces
+   * it. Compose transforms manually when both should apply. Streaming chat
+   * completion requests are sent directly by `OpenRouterClient.make` and do not
+   * read this scoped transform.
+   *
    * @category configuration
+   * @since 4.0.0
    */
   (transform: (client: HttpClient) => HttpClient) => <A, E, R>(self: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>,
   /**
-   * @since 1.0.0
+   * Provides a scoped transform for the OpenRouter HTTP client used by provider
+   * operations.
+   *
+   * **When to use**
+   *
+   * Use when a single effect or workflow needs temporary OpenRouter HTTP client
+   * customization without rebuilding the client layer.
+   *
+   * **Details**
+   *
+   * Supports both data-first and data-last forms. The transform is stored in the
+   * scoped `OpenRouterConfig` service and read by generated OpenRouter request
+   * operations while running the supplied effect.
+   *
+   * **Gotchas**
+   *
+   * If a transform is already present in the scoped config, this helper replaces
+   * it. Compose transforms manually when both should apply. Streaming chat
+   * completion requests are sent directly by `OpenRouterClient.make` and do not
+   * read this scoped transform.
+   *
    * @category configuration
+   * @since 4.0.0
    */
   <A, E, R>(
     self: Effect.Effect<A, E, R>,

package/src/OpenRouterError.ts

@@ -4,14 +4,14 @@
  * Provides OpenRouter-specific metadata fields for AI error types through
  * module augmentation, enabling typed access to OpenRouter error details.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 
 /**
  * OpenRouter-specific error metadata fields.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type OpenRouterErrorMetadata = {
   /**
@@ -31,8 +31,8 @@ export type OpenRouterErrorMetadata = {
 /**
  * OpenRouter-specific rate limit metadata fields.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type OpenRouterRateLimitMetadata = OpenRouterErrorMetadata & {
   readonly limit: string | null
@@ -42,51 +42,184 @@ export type OpenRouterRateLimitMetadata = OpenRouterErrorMetadata & {
 }
 
 declare module "effect/unstable/ai/AiError" {
-  export interface RateLimitError {
-    readonly metadata: {
-      readonly openrouter?: OpenRouterRateLimitMetadata | null
-    }
+  /**
+   * OpenRouter metadata attached to `RateLimitError` values.
+   *
+   * **Details**
+   *
+   * Captures OpenRouter error details together with rate limit header
+   * information from responses where the provider rejected the request because
+   * a limit was reached.
+   *
+   * @category configuration
+   * @since 4.0.0
+   */
+  export interface RateLimitErrorMetadata {
+    /**
+     * OpenRouter-specific details for the rate limit response.
+     */
+    readonly openrouter?: OpenRouterRateLimitMetadata | null
+  }
+
+  /**
+   * OpenRouter metadata attached to `QuotaExhaustedError` values.
+   *
+   * **Details**
+   *
+   * Preserves provider error details for failures caused by exhausted account,
+   * billing, or usage quota.
+   *
+   * @category configuration
+   * @since 4.0.0
+   */
+  export interface QuotaExhaustedErrorMetadata {
+    /**
+     * OpenRouter-specific details for the quota exhaustion response.
+     */
+    readonly openrouter?: OpenRouterErrorMetadata | null
   }
 
-  export interface QuotaExhaustedError {
-    readonly metadata: {
-      readonly openrouter?: OpenRouterErrorMetadata | null
-    }
+  /**
+   * OpenRouter metadata attached to `AuthenticationError` values.
+   *
+   * **Details**
+   *
+   * Preserves provider error details for failed API key, authorization, or
+   * permission checks.
+   *
+   * @category configuration
+   * @since 4.0.0
+   */
+  export interface AuthenticationErrorMetadata {
+    /**
+     * OpenRouter-specific details for the authentication failure.
+     */
+    readonly openrouter?: OpenRouterErrorMetadata | null
+  }
+
+  /**
+   * OpenRouter metadata attached to `ContentPolicyError` values.
+   *
+   * **Details**
+   *
+   * Preserves provider error details when OpenRouter rejects input or output
+   * because it violates a content policy.
+   *
+   * @category configuration
+   * @since 4.0.0
+   */
+  export interface ContentPolicyErrorMetadata {
+    /**
+     * OpenRouter-specific details for the content policy response.
+     */
+    readonly openrouter?: OpenRouterErrorMetadata | null
   }
 
-  export interface AuthenticationError {
-    readonly metadata: {
-      readonly openrouter?: OpenRouterErrorMetadata | null
-    }
+  /**
+   * OpenRouter metadata attached to `InvalidRequestError` values.
+   *
+   * **Details**
+   *
+   * Preserves provider error details for malformed requests, unsupported
+   * parameters, or other request validation failures reported by OpenRouter.
+   *
+   * @category configuration
+   * @since 4.0.0
+   */
+  export interface InvalidRequestErrorMetadata {
+    /**
+     * OpenRouter-specific details for the invalid request response.
+     */
+    readonly openrouter?: OpenRouterErrorMetadata | null
   }
 
-  export interface ContentPolicyError {
-    readonly metadata: {
-      readonly openrouter?: OpenRouterErrorMetadata | null
-    }
+  /**
+   * OpenRouter metadata attached to `InternalProviderError` values.
+   *
+   * **Details**
+   *
+   * Preserves provider error details for OpenRouter-side failures such as
+   * transient server errors or overload responses.
+   *
+   * @category configuration
+   * @since 4.0.0
+   */
+  export interface InternalProviderErrorMetadata {
+    /**
+     * OpenRouter-specific details for the internal provider response.
+     */
+    readonly openrouter?: OpenRouterErrorMetadata | null
   }
 
-  export interface InvalidRequestError {
-    readonly metadata: {
-      readonly openrouter?: OpenRouterErrorMetadata | null
-    }
+  /**
+   * OpenRouter metadata attached to `InvalidOutputError` values.
+   *
+   * **Details**
+   *
+   * Preserves provider error details when an OpenRouter response cannot be
+   * parsed or validated as the expected output.
+   *
+   * @category configuration
+   * @since 4.0.0
+   */
+  export interface InvalidOutputErrorMetadata {
+    /**
+     * OpenRouter-specific details for the invalid output response.
+     */
+    readonly openrouter?: OpenRouterErrorMetadata | null
   }
 
-  export interface InternalProviderError {
-    readonly metadata: {
-      readonly openrouter?: OpenRouterErrorMetadata | null
-    }
+  /**
+   * OpenRouter metadata attached to `StructuredOutputError` values.
+   *
+   * **Details**
+   *
+   * Preserves provider error details when OpenRouter returns content that does
+   * not satisfy the requested structured output schema.
+   *
+   * @category configuration
+   * @since 4.0.0
+   */
+  export interface StructuredOutputErrorMetadata {
+    /**
+     * OpenRouter-specific details for the structured output failure.
+     */
+    readonly openrouter?: OpenRouterErrorMetadata | null
   }
 
-  export interface InvalidOutputError {
-    readonly metadata: {
-      readonly openrouter?: OpenRouterErrorMetadata | null
-    }
+  /**
+   * OpenRouter metadata attached to `UnsupportedSchemaError` values.
+   *
+   * **Details**
+   *
+   * Preserves provider error details when an unsupported schema failure is
+   * associated with an OpenRouter response.
+   *
+   * @category configuration
+   * @since 4.0.0
+   */
+  export interface UnsupportedSchemaErrorMetadata {
+    /**
+     * OpenRouter-specific details for the unsupported schema failure.
+     */
+    readonly openrouter?: OpenRouterErrorMetadata | null
   }
 
-  export interface UnknownError {
-    readonly metadata: {
-      readonly openrouter?: OpenRouterErrorMetadata | null
-    }
+  /**
+   * OpenRouter metadata attached to `UnknownError` values.
+   *
+   * **Details**
+   *
+   * Preserves provider error details for OpenRouter failures that do not map
+   * cleanly to a more specific AI error category.
+   *
+   * @category configuration
+   * @since 4.0.0
+   */
+  export interface UnknownErrorMetadata {
+    /**
+     * OpenRouter-specific details for the unclassified provider failure.
+     */
+    readonly openrouter?: OpenRouterErrorMetadata | null
   }
 }