@effect/ai-openrouter 4.0.0-beta.70 → 4.0.0-beta.72

package/dist/OpenRouterClient.d.ts

@@ -69,7 +69,16 @@ export interface Service {
 export type ChatStreamingResponseChunkData = typeof Generated.ChatStreamingResponseChunk.fields.data.Type;
 declare const OpenRouterClient_base: Context.ServiceClass<OpenRouterClient, "@effect/ai-openrouter/OpenRouterClient", Service>;
 /**
- * Service identifier for the OpenRouter client.
+ * Service tag for the OpenRouter client.
+ *
+ * **When to use**
+ *
+ * Use when accessing or providing the OpenRouter client service through
+ * Effect's context.
+ *
+ * @see {@link make} for constructing an OpenRouter client effectfully
+ * @see {@link layer} for providing a client from explicit options
+ * @see {@link layerConfig} for providing a client from `Config`
  *
  * @category services
  * @since 4.0.0
@@ -77,7 +86,7 @@ declare const OpenRouterClient_base: Context.ServiceClass<OpenRouterClient, "@ef
 export declare class OpenRouterClient extends OpenRouterClient_base {
 }
 /**
- * Configuration options for creating an OpenRouter client.
+ * Configuration for creating an OpenRouter client.
  *
  * @category models
  * @since 4.0.0
@@ -98,12 +107,33 @@ export type Options = {
      *
      * **When to use**
      *
-     * Use this to add middleware, logging, or custom request/response handling.
+     * Use to add middleware, logging, or custom request/response handling.
      */
     readonly transformClient?: ((client: HttpClient.HttpClient) => HttpClient.HttpClient) | undefined;
 };
 /**
- * Creates an OpenRouter client service with the given options.
+ * Creates an OpenRouter client service from explicit options.
+ *
+ * **When to use**
+ *
+ * Use to construct the OpenRouter client service inside an effect when you need
+ * the service value directly.
+ *
+ * **Details**
+ *
+ * The returned service uses the current `HttpClient`, prepends `apiUrl` or
+ * `https://openrouter.ai/api/v1`, adds the bearer token and optional
+ * `HTTP-Referer` and `X-Title` headers, accepts JSON responses, and applies
+ * `transformClient` when provided.
+ *
+ * **Gotchas**
+ *
+ * Scoped `OpenRouterConfig.withClientTransform` applies to generated client
+ * request methods. Streaming chat completion requests are sent directly by this
+ * module and do not read that scoped transform.
+ *
+ * @see {@link layer} for providing this client from explicit options
+ * @see {@link layerConfig} for loading client settings from `Config`
  *
  * @category constructors
  * @since 4.0.0
@@ -112,13 +142,34 @@ export declare const make: (options: Options) => Effect.Effect<Service, never, H
 /**
  * Creates a layer for the OpenRouter client with the given options.
  *
+ * **When to use**
+ *
+ * Use when you already have the OpenRouter client options in code and want to
+ * provide `OpenRouterClient` as a layer.
+ *
+ * @see {@link make} for constructing the client service effectfully
+ * @see {@link layerConfig} for loading client settings from `Config`
+ *
  * @category layers
  * @since 4.0.0
  */
 export declare const layer: (options: Options) => Layer.Layer<OpenRouterClient, never, HttpClient.HttpClient>;
 /**
- * Creates a layer for the OpenRouter client, loading the requisite
- * configuration via Effect's `Config` module.
+ * Creates a layer for the OpenRouter client from provided `Config` values.
+ *
+ * **When to use**
+ *
+ * Use when OpenRouter client settings should be read from Effect `Config`
+ * values while providing `OpenRouterClient` as a layer.
+ *
+ * **Details**
+ *
+ * Only config values supplied in `options` are loaded. Omitted fields are
+ * passed to `make` as `undefined`, and `transformClient` is forwarded as a
+ * plain option.
+ *
+ * @see {@link make} for constructing the client service effectfully
+ * @see {@link layer} for providing the client from already-resolved options
  *
  * @category layers
  * @since 4.0.0

package/dist/OpenRouterClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenRouterClient.d.ts","sourceRoot":"","sources":["../src/OpenRouterClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAErC,OAAO,KAAK,KAAK,QAAQ,MAAM,iBAAiB,CAAA;AAEhD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,KAAK,OAAO,MAAM,4BAA4B,CAAA;AAG1D,OAAO,KAAK,UAAU,MAAM,iCAAiC,CAAA;AAE7D,OAAO,KAAK,KAAK,kBAAkB,MAAM,yCAAyC,CAAA;AAClF,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAQ3C;;;;;;;;;;GAUG;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,gBAAgB,CAAA;IAE3C,QAAQ,CAAC,oBAAoB,EAAE,CAC7B,OAAO,EAAE,OAAO,SAAS,CAAC,oBAAoB,CAAC,OAAO,KACnD,MAAM,CAAC,MAAM,CAChB;QAAC,IAAI,EAAE,OAAO,SAAS,CAAC,4BAA4B,CAAC,IAAI;QAAE,QAAQ,EAAE,kBAAkB,CAAC,kBAAkB;KAAC,EAC3G,OAAO,CAAC,OAAO,CAChB,CAAA;IAED,QAAQ,CAAC,0BAA0B,EAAE,CACnC,OAAO,EAAE,IAAI,CAAC,OAAO,SAAS,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,GAAG,gBAAgB,CAAC,KACtF,MAAM,CAAC,MAAM,CAChB;QACE,QAAQ,EAAE,kBAAkB,CAAC,kBAAkB;QAC/C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,8BAA8B,EAAE,OAAO,CAAC,OAAO,CAAC;KACvE,EACD,OAAO,CAAC,OAAO,CAChB,CAAA;CACF;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,8BAA8B,GAAG,OAAO,SAAS,CAAC,0BAA0B,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAA;;AAMzG;;;;;GAKG;AACH,qBAAa,gBAAiB,SAAQ,qBAGO;CAAG;AAMhD;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IAEvD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAEpC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE1C;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAEvC;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,KAAK,UAAU,CAAC,UAAU,CAAC,GAAG,SAAS,CAAA;CAClG,CAAA;AAMD;;;;;GAKG;AACH,eAAO,MAAM,IAAI,4EAqFhB,CAAA;AAMD;;;;;GAKG;AACH,eAAO,MAAM,KAAK,GAAI,SAAS,OAAO,KAAG,KAAK,CAAC,KAAK,CAAC,gBAAgB,EAAE,KAAK,EAAE,UAAU,CAAC,UAAU,CACpD,CAAA;AAE/C;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAI,UAAU;IACpC;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,SAAS,CAAA;IAElF;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IAEnD;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IAEzD;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IAEtD;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,KAAK,UAAU,CAAC,UAAU,CAAC,GAAG,SAAS,CAAA;CAClG,KAAG,KAAK,CAAC,KAAK,CAAC,gBAAgB,EAAE,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,UAAU,CAwBxE,CAAA"}
+{"version":3,"file":"OpenRouterClient.d.ts","sourceRoot":"","sources":["../src/OpenRouterClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;AAC5C,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAErC,OAAO,KAAK,KAAK,QAAQ,MAAM,iBAAiB,CAAA;AAEhD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,KAAK,OAAO,MAAM,4BAA4B,CAAA;AAG1D,OAAO,KAAK,UAAU,MAAM,iCAAiC,CAAA;AAE7D,OAAO,KAAK,KAAK,kBAAkB,MAAM,yCAAyC,CAAA;AAClF,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAQ3C;;;;;;;;;;GAUG;AACH,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,gBAAgB,CAAA;IAE3C,QAAQ,CAAC,oBAAoB,EAAE,CAC7B,OAAO,EAAE,OAAO,SAAS,CAAC,oBAAoB,CAAC,OAAO,KACnD,MAAM,CAAC,MAAM,CAChB;QAAC,IAAI,EAAE,OAAO,SAAS,CAAC,4BAA4B,CAAC,IAAI;QAAE,QAAQ,EAAE,kBAAkB,CAAC,kBAAkB;KAAC,EAC3G,OAAO,CAAC,OAAO,CAChB,CAAA;IAED,QAAQ,CAAC,0BAA0B,EAAE,CACnC,OAAO,EAAE,IAAI,CAAC,OAAO,SAAS,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,GAAG,gBAAgB,CAAC,KACtF,MAAM,CAAC,MAAM,CAChB;QACE,QAAQ,EAAE,kBAAkB,CAAC,kBAAkB;QAC/C,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,8BAA8B,EAAE,OAAO,CAAC,OAAO,CAAC;KACvE,EACD,OAAO,CAAC,OAAO,CAChB,CAAA;CACF;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,8BAA8B,GAAG,OAAO,SAAS,CAAC,0BAA0B,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAA;;AAMzG;;;;;;;;;;;;;;GAcG;AACH,qBAAa,gBAAiB,SAAQ,qBAGO;CAAG;AAMhD;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IAEvD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAEpC;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE1C;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAEvC;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,KAAK,UAAU,CAAC,UAAU,CAAC,GAAG,SAAS,CAAA;CAClG,CAAA;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,IAAI,4EAqFhB,CAAA;AAMD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,KAAK,GAAI,SAAS,OAAO,KAAG,KAAK,CAAC,KAAK,CAAC,gBAAgB,EAAE,KAAK,EAAE,UAAU,CAAC,UAAU,CACpD,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,WAAW,GAAI,UAAU;IACpC;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,GAAG,SAAS,CAAA;IAElF;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IAEnD;;OAEG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IAEzD;;OAEG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;IAEtD;;OAEG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,UAAU,KAAK,UAAU,CAAC,UAAU,CAAC,GAAG,SAAS,CAAA;CAClG,KAAG,KAAK,CAAC,KAAK,CAAC,gBAAgB,EAAE,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,UAAU,CAwBxE,CAAA"}

package/dist/OpenRouterClient.js

@@ -16,7 +16,16 @@ import { OpenRouterConfig } from "./OpenRouterConfig.js";
 // Service Identifier
 // =============================================================================
 /**
- * Service identifier for the OpenRouter client.
+ * Service tag for the OpenRouter client.
+ *
+ * **When to use**
+ *
+ * Use when accessing or providing the OpenRouter client service through
+ * Effect's context.
+ *
+ * @see {@link make} for constructing an OpenRouter client effectfully
+ * @see {@link layer} for providing a client from explicit options
+ * @see {@link layerConfig} for providing a client from `Config`
  *
  * @category services
  * @since 4.0.0
@@ -26,7 +35,28 @@ export class OpenRouterClient extends /*#__PURE__*/Context.Service()("@effect/ai
 // Constructor
 // =============================================================================
 /**
- * Creates an OpenRouter client service with the given options.
+ * Creates an OpenRouter client service from explicit options.
+ *
+ * **When to use**
+ *
+ * Use to construct the OpenRouter client service inside an effect when you need
+ * the service value directly.
+ *
+ * **Details**
+ *
+ * The returned service uses the current `HttpClient`, prepends `apiUrl` or
+ * `https://openrouter.ai/api/v1`, adds the bearer token and optional
+ * `HTTP-Referer` and `X-Title` headers, accepts JSON responses, and applies
+ * `transformClient` when provided.
+ *
+ * **Gotchas**
+ *
+ * Scoped `OpenRouterConfig.withClientTransform` applies to generated client
+ * request methods. Streaming chat completion requests are sent directly by this
+ * module and do not read that scoped transform.
+ *
+ * @see {@link layer} for providing this client from explicit options
+ * @see {@link layerConfig} for loading client settings from `Config`
  *
  * @category constructors
  * @since 4.0.0
@@ -87,13 +117,34 @@ export const make = /*#__PURE__*/Effect.fnUntraced(function* (options) {
 /**
  * Creates a layer for the OpenRouter client with the given options.
  *
+ * **When to use**
+ *
+ * Use when you already have the OpenRouter client options in code and want to
+ * provide `OpenRouterClient` as a layer.
+ *
+ * @see {@link make} for constructing the client service effectfully
+ * @see {@link layerConfig} for loading client settings from `Config`
+ *
  * @category layers
  * @since 4.0.0
  */
 export const layer = options => Layer.effect(OpenRouterClient, make(options));
 /**
- * Creates a layer for the OpenRouter client, loading the requisite
- * configuration via Effect's `Config` module.
+ * Creates a layer for the OpenRouter client from provided `Config` values.
+ *
+ * **When to use**
+ *
+ * Use when OpenRouter client settings should be read from Effect `Config`
+ * values while providing `OpenRouterClient` as a layer.
+ *
+ * **Details**
+ *
+ * Only config values supplied in `options` are loaded. Omitted fields are
+ * passed to `make` as `undefined`, and `transformClient` is forwarded as a
+ * plain option.
+ *
+ * @see {@link make} for constructing the client service effectfully
+ * @see {@link layer} for providing the client from already-resolved options
  *
  * @category layers
  * @since 4.0.0

package/dist/OpenRouterClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"OpenRouterClient.js","names":["Context","Effect","identity","Layer","Predicate","Schema","Stream","Sse","HttpBody","HttpClient","HttpClientRequest","Generated","Errors","OpenRouterConfig","OpenRouterClient","Service","make","fnUntraced","options","baseClient","httpClient","pipe","mapRequest","request","prependUrl","apiUrl","apiKey","bearerToken","siteReferrer","setHeader","siteTitle","acceptJson","transformClient","httpClientOk","filterStatusOk","client","config","getOrUndefined","isNotUndefined","createChatCompletion","payload","sendChatCompletionRequest","includeResponse","catchTags","SendChatCompletionRequest400","error","fail","mapClientError","SendChatCompletionRequest401","SendChatCompletionRequest429","SendChatCompletionRequest500","HttpClientError","mapHttpClientError","SchemaError","mapSchemaError","buildChatCompletionStream","response","stream","decodeText","pipeThroughChannel","decode","mapEffect","event","decodeChatCompletionSseData","data","takeWhile","Retry","die","fromEffect","createChatCompletionStream","execute","post","body","jsonUnsafe","stream_options","include_usage","map","catchTag","of","layer","effect","layerConfig","gen","undefined","ChatStreamingResponseChunkDataFromString","fromJsonString","ChatStreamingResponseChunk","fields","decodeChatStreamingResponseChunkData","decodeUnknownEffect","succeed"],"sources":["../src/OpenRouterClient.ts"],"sourcesContent":[null],"mappings":"AA0BA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,SAASC,QAAQ,QAAQ,iBAAiB;AAC1C,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,SAAS,MAAM,kBAAkB;AAE7C,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,MAAM,MAAM,eAAe;AAEvC,OAAO,KAAKC,GAAG,MAAM,8BAA8B;AACnD,OAAO,KAAKC,QAAQ,MAAM,+BAA+B;AACzD,OAAO,KAAKC,UAAU,MAAM,iCAAiC;AAC7D,OAAO,KAAKC,iBAAiB,MAAM,wCAAwC;AAE3E,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAC3C,OAAO,KAAKC,MAAM,MAAM,sBAAsB;AAC9C,SAASC,gBAAgB,QAAQ,uBAAuB;AAmDxD;AACA;AACA;AAEA;;;;;;AAMA,OAAM,MAAOC,gBAAiB,sBAAQd,OAAO,CAACe,OAAO,EAGlD,CAAC,wCAAwC,CAAC;AAqC7C;AACA;AACA;AAEA;;;;;;AAMA,OAAO,MAAMC,IAAI,gBAAGf,MAAM,CAACgB,UAAU,CACnC,WAAUC,OAAgB;EACxB,MAAMC,UAAU,GAAG,OAAOV,UAAU,CAACA,UAAU;EAE/C,MAAMW,UAAU,GAAGD,UAAU,CAACE,IAAI,CAChCZ,UAAU,CAACa,UAAU,CAAEC,OAAO,IAC5BA,OAAO,CAACF,IAAI,CACVX,iBAAiB,CAACc,UAAU,CAACN,OAAO,CAACO,MAAM,IAAI,8BAA8B,CAAC,EAC9EP,OAAO,CAACQ,MAAM,GAAGhB,iBAAiB,CAACiB,WAAW,CAACT,OAAO,CAACQ,MAAM,CAAC,GAAGxB,QAAQ,EACzEgB,OAAO,CAACU,YAAY,GAAGlB,iBAAiB,CAACmB,SAAS,CAAC,cAAc,EAAEX,OAAO,CAACU,YAAY,CAAC,GAAG1B,QAAQ,EACnGgB,OAAO,CAACY,SAAS,GAAGpB,iBAAiB,CAACmB,SAAS,CAAC,SAAS,EAAEX,OAAO,CAACY,SAAS,CAAC,GAAG5B,QAAQ,EACxFQ,iBAAiB,CAACqB,UAAU,CAC7B,CACF,EACDb,OAAO,CAACc,eAAe,IAAI9B,QAAQ,CACpC;EAED,MAAM+B,YAAY,GAAGxB,UAAU,CAACyB,cAAc,CAACd,UAAU,CAAC;EAE1D,MAAMe,MAAM,GAAGxB,SAAS,CAACK,IAAI,CAACI,UAAU,EAAE;IACxCY,eAAe,EAAE/B,MAAM,CAACgB,UAAU,CAAC,WAAUkB,MAAM;MACjD,MAAMC,MAAM,GAAG,OAAOvB,gBAAgB,CAACwB,cAAc;MACrD,IAAIjC,SAAS,CAACkC,cAAc,CAACF,MAAM,EAAEJ,eAAe,CAAC,EAAE;QACrD,OAAOI,MAAM,CAACJ,eAAe,CAACG,MAAM,CAAC;MACvC;MACA,OAAOA,MAAM;IACf,CAAC;GACF,CAAC;EAEF,MAAMI,oBAAoB,GAAqCC,OAAO,IACpEL,MAAM,CAACM,yBAAyB,CAAC;IAAED,OAAO;IAAEJ,MAAM,EAAE;MAAEM,eAAe,EAAE;IAAI;EAAE,CAAE,CAAC,CAACrB,IAAI,CACnFpB,MAAM,CAAC0C,SAAS,CAAC;IACfC,4BAA4B,EAAGC,KAAK,IAAK5C,MAAM,CAAC6C,IAAI,CAAClC,MAAM,CAACmC,cAAc,CAACF,KAAK,EAAE,sBAAsB,CAAC,CAAC;IAC1GG,4BAA4B,EAAGH,KAAK,IAAK5C,MAAM,CAAC6C,IAAI,CAAClC,MAAM,CAACmC,cAAc,CAACF,KAAK,EAAE,sBAAsB,CAAC,CAAC;IAC1GI,4BAA4B,EAAGJ,KAAK,IAAK5C,MAAM,CAAC6C,IAAI,CAAClC,MAAM,CAACmC,cAAc,CAACF,KAAK,EAAE,sBAAsB,CAAC,CAAC;IAC1GK,4BAA4B,EAAGL,KAAK,IAAK5C,MAAM,CAAC6C,IAAI,CAAClC,MAAM,CAACmC,cAAc,CAACF,KAAK,EAAE,sBAAsB,CAAC,CAAC;IAC1GM,eAAe,EAAGN,KAAK,IAAKjC,MAAM,CAACwC,kBAAkB,CAACP,KAAK,EAAE,sBAAsB,CAAC;IACpFQ,WAAW,EAAGR,KAAK,IAAK5C,MAAM,CAAC6C,IAAI,CAAClC,MAAM,CAAC0C,cAAc,CAACT,KAAK,EAAE,sBAAsB,CAAC;GACzF,CAAC,CACH;EAEH,MAAMU,yBAAyB,GAC7BC,QAA+C,IAI7C;IACF,MAAMC,MAAM,GAAGD,QAAQ,CAACC,MAAM,CAACpC,IAAI,CACjCf,MAAM,CAACoD,UAAU,EAAE,EACnBpD,MAAM,CAACqD,kBAAkB,CAACpD,GAAG,CAACqD,MAAM,EAAE,CAAC,EACvCtD,MAAM,CAACuD,SAAS,CAAEC,KAAK,IAAKC,2BAA2B,CAACD,KAAK,CAACE,IAAI,CAAC,CAAC,EACpE1D,MAAM,CAAC2D,SAAS,CAAED,IAAI,IAAKA,IAAI,KAAK,QAAQ,CAAC,EAC7C1D,MAAM,CAACqC,SAAS,CAAC;MACf;MACAuB,KAAK,EAAGrB,KAAK,IAAKvC,MAAM,CAAC6D,GAAG,CAACtB,KAAK,CAAC;MACnCM,eAAe,EAAGN,KAAK,IAAKvC,MAAM,CAAC8D,UAAU,CAACxD,MAAM,CAACwC,kBAAkB,CAACP,KAAK,EAAE,4BAA4B,CAAC,CAAC;MAC7GQ,WAAW,EAAGR,KAAK,IAAKvC,MAAM,CAACwC,IAAI,CAAClC,MAAM,CAAC0C,cAAc,CAACT,KAAK,EAAE,4BAA4B,CAAC;KAC/F,CAAC,CACI;IACR,OAAO,CAACW,QAAQ,EAAEC,MAAM,CAAC;EAC3B,CAAC;EAED,MAAMY,0BAA0B,GAA2C7B,OAAO,IAChFP,YAAY,CAACqC,OAAO,CAClB5D,iBAAiB,CAAC6D,IAAI,CAAC,mBAAmB,EAAE;IAC1CC,IAAI,EAAEhE,QAAQ,CAACiE,UAAU,CAAC;MACxB,GAAGjC,OAAO;MACViB,MAAM,EAAE,IAAI;MACZiB,cAAc,EAAE;QAAEC,aAAa,EAAE;MAAI;KACtC;GACF,CAAC,CACH,CAACtD,IAAI,CACJpB,MAAM,CAAC2E,GAAG,CAACrB,yBAAyB,CAAC,EACrCtD,MAAM,CAAC4E,QAAQ,CACb,iBAAiB,EAChBhC,KAAK,IAAKjC,MAAM,CAACwC,kBAAkB,CAACP,KAAK,EAAE,4BAA4B,CAAC,CAC1E,CACF;EAEH,OAAO/B,gBAAgB,CAACgE,EAAE,CAAC;IACzB3C,MAAM;IACNI,oBAAoB;IACpB8B;GACD,CAAC;AACJ,CAAC,CACF;AAED;AACA;AACA;AAEA;;;;;;AAMA,OAAO,MAAMU,KAAK,GAAI7D,OAAgB,IACpCf,KAAK,CAAC6E,MAAM,CAAClE,gBAAgB,EAAEE,IAAI,CAACE,OAAO,CAAC,CAAC;AAE/C;;;;;;;AAOA,OAAO,MAAM+D,WAAW,GAAI/D,OAyB3B,IACCf,KAAK,CAAC6E,MAAM,CACVlE,gBAAgB,EAChBb,MAAM,CAACiF,GAAG,CAAC,aAAS;EAClB,MAAMxD,MAAM,GAAGtB,SAAS,CAACkC,cAAc,CAACpB,OAAO,EAAEQ,MAAM,CAAC,GACpD,OAAOR,OAAO,CAACQ,MAAM,GACrByD,SAAS;EACb,MAAM1D,MAAM,GAAGrB,SAAS,CAACkC,cAAc,CAACpB,OAAO,EAAEO,MAAM,CAAC,GACpD,OAAOP,OAAO,CAACO,MAAM,GACrB0D,SAAS;EACb,MAAMvD,YAAY,GAAGxB,SAAS,CAACkC,cAAc,CAACpB,OAAO,EAAEU,YAAY,CAAC,GAChE,OAAOV,OAAO,CAACU,YAAY,GAC3BuD,SAAS;EACb,MAAMrD,SAAS,GAAG1B,SAAS,CAACkC,cAAc,CAACpB,OAAO,EAAEY,SAAS,CAAC,GAC1D,OAAOZ,OAAO,CAACY,SAAS,GACxBqD,SAAS;EACb,OAAO,OAAOnE,IAAI,CAAC;IACjBU,MAAM;IACND,MAAM;IACNG,YAAY;IACZE,SAAS;IACTE,eAAe,EAAEd,OAAO,EAAEc;GAC3B,CAAC;AACJ,CAAC,CAAC,CACH;AAEH;AACA;AACA;AAEA,MAAMoD,wCAAwC,gBAAG/E,MAAM,CAACgF,cAAc,CAAC1E,SAAS,CAAC2E,0BAA0B,CAACC,MAAM,CAACvB,IAAI,CAAC;AACxH,MAAMwB,oCAAoC,gBAAGnF,MAAM,CAACoF,mBAAmB,CAACL,wCAAwC,CAAC;AAEjH,MAAMrB,2BAA2B,GAC/BC,IAAY,IAEZA,IAAI,KAAK,QAAQ,GACb/D,MAAM,CAACyF,OAAO,CAAC1B,IAAI,CAAC,GACpBwB,oCAAoC,CAACxB,IAAI,CAAC","ignoreList":[]}
+{"version":3,"file":"OpenRouterClient.js","names":["Context","Effect","identity","Layer","Predicate","Schema","Stream","Sse","HttpBody","HttpClient","HttpClientRequest","Generated","Errors","OpenRouterConfig","OpenRouterClient","Service","make","fnUntraced","options","baseClient","httpClient","pipe","mapRequest","request","prependUrl","apiUrl","apiKey","bearerToken","siteReferrer","setHeader","siteTitle","acceptJson","transformClient","httpClientOk","filterStatusOk","client","config","getOrUndefined","isNotUndefined","createChatCompletion","payload","sendChatCompletionRequest","includeResponse","catchTags","SendChatCompletionRequest400","error","fail","mapClientError","SendChatCompletionRequest401","SendChatCompletionRequest429","SendChatCompletionRequest500","HttpClientError","mapHttpClientError","SchemaError","mapSchemaError","buildChatCompletionStream","response","stream","decodeText","pipeThroughChannel","decode","mapEffect","event","decodeChatCompletionSseData","data","takeWhile","Retry","die","fromEffect","createChatCompletionStream","execute","post","body","jsonUnsafe","stream_options","include_usage","map","catchTag","of","layer","effect","layerConfig","gen","undefined","ChatStreamingResponseChunkDataFromString","fromJsonString","ChatStreamingResponseChunk","fields","decodeChatStreamingResponseChunkData","decodeUnknownEffect","succeed"],"sources":["../src/OpenRouterClient.ts"],"sourcesContent":[null],"mappings":"AA0BA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,SAASC,QAAQ,QAAQ,iBAAiB;AAC1C,OAAO,KAAKC,KAAK,MAAM,cAAc;AACrC,OAAO,KAAKC,SAAS,MAAM,kBAAkB;AAE7C,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,OAAO,KAAKC,MAAM,MAAM,eAAe;AAEvC,OAAO,KAAKC,GAAG,MAAM,8BAA8B;AACnD,OAAO,KAAKC,QAAQ,MAAM,+BAA+B;AACzD,OAAO,KAAKC,UAAU,MAAM,iCAAiC;AAC7D,OAAO,KAAKC,iBAAiB,MAAM,wCAAwC;AAE3E,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAC3C,OAAO,KAAKC,MAAM,MAAM,sBAAsB;AAC9C,SAASC,gBAAgB,QAAQ,uBAAuB;AAmDxD;AACA;AACA;AAEA;;;;;;;;;;;;;;;AAeA,OAAM,MAAOC,gBAAiB,sBAAQd,OAAO,CAACe,OAAO,EAGlD,CAAC,wCAAwC,CAAC;AAqC7C;AACA;AACA;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,MAAMC,IAAI,gBAAGf,MAAM,CAACgB,UAAU,CACnC,WAAUC,OAAgB;EACxB,MAAMC,UAAU,GAAG,OAAOV,UAAU,CAACA,UAAU;EAE/C,MAAMW,UAAU,GAAGD,UAAU,CAACE,IAAI,CAChCZ,UAAU,CAACa,UAAU,CAAEC,OAAO,IAC5BA,OAAO,CAACF,IAAI,CACVX,iBAAiB,CAACc,UAAU,CAACN,OAAO,CAACO,MAAM,IAAI,8BAA8B,CAAC,EAC9EP,OAAO,CAACQ,MAAM,GAAGhB,iBAAiB,CAACiB,WAAW,CAACT,OAAO,CAACQ,MAAM,CAAC,GAAGxB,QAAQ,EACzEgB,OAAO,CAACU,YAAY,GAAGlB,iBAAiB,CAACmB,SAAS,CAAC,cAAc,EAAEX,OAAO,CAACU,YAAY,CAAC,GAAG1B,QAAQ,EACnGgB,OAAO,CAACY,SAAS,GAAGpB,iBAAiB,CAACmB,SAAS,CAAC,SAAS,EAAEX,OAAO,CAACY,SAAS,CAAC,GAAG5B,QAAQ,EACxFQ,iBAAiB,CAACqB,UAAU,CAC7B,CACF,EACDb,OAAO,CAACc,eAAe,IAAI9B,QAAQ,CACpC;EAED,MAAM+B,YAAY,GAAGxB,UAAU,CAACyB,cAAc,CAACd,UAAU,CAAC;EAE1D,MAAMe,MAAM,GAAGxB,SAAS,CAACK,IAAI,CAACI,UAAU,EAAE;IACxCY,eAAe,EAAE/B,MAAM,CAACgB,UAAU,CAAC,WAAUkB,MAAM;MACjD,MAAMC,MAAM,GAAG,OAAOvB,gBAAgB,CAACwB,cAAc;MACrD,IAAIjC,SAAS,CAACkC,cAAc,CAACF,MAAM,EAAEJ,eAAe,CAAC,EAAE;QACrD,OAAOI,MAAM,CAACJ,eAAe,CAACG,MAAM,CAAC;MACvC;MACA,OAAOA,MAAM;IACf,CAAC;GACF,CAAC;EAEF,MAAMI,oBAAoB,GAAqCC,OAAO,IACpEL,MAAM,CAACM,yBAAyB,CAAC;IAAED,OAAO;IAAEJ,MAAM,EAAE;MAAEM,eAAe,EAAE;IAAI;EAAE,CAAE,CAAC,CAACrB,IAAI,CACnFpB,MAAM,CAAC0C,SAAS,CAAC;IACfC,4BAA4B,EAAGC,KAAK,IAAK5C,MAAM,CAAC6C,IAAI,CAAClC,MAAM,CAACmC,cAAc,CAACF,KAAK,EAAE,sBAAsB,CAAC,CAAC;IAC1GG,4BAA4B,EAAGH,KAAK,IAAK5C,MAAM,CAAC6C,IAAI,CAAClC,MAAM,CAACmC,cAAc,CAACF,KAAK,EAAE,sBAAsB,CAAC,CAAC;IAC1GI,4BAA4B,EAAGJ,KAAK,IAAK5C,MAAM,CAAC6C,IAAI,CAAClC,MAAM,CAACmC,cAAc,CAACF,KAAK,EAAE,sBAAsB,CAAC,CAAC;IAC1GK,4BAA4B,EAAGL,KAAK,IAAK5C,MAAM,CAAC6C,IAAI,CAAClC,MAAM,CAACmC,cAAc,CAACF,KAAK,EAAE,sBAAsB,CAAC,CAAC;IAC1GM,eAAe,EAAGN,KAAK,IAAKjC,MAAM,CAACwC,kBAAkB,CAACP,KAAK,EAAE,sBAAsB,CAAC;IACpFQ,WAAW,EAAGR,KAAK,IAAK5C,MAAM,CAAC6C,IAAI,CAAClC,MAAM,CAAC0C,cAAc,CAACT,KAAK,EAAE,sBAAsB,CAAC;GACzF,CAAC,CACH;EAEH,MAAMU,yBAAyB,GAC7BC,QAA+C,IAI7C;IACF,MAAMC,MAAM,GAAGD,QAAQ,CAACC,MAAM,CAACpC,IAAI,CACjCf,MAAM,CAACoD,UAAU,EAAE,EACnBpD,MAAM,CAACqD,kBAAkB,CAACpD,GAAG,CAACqD,MAAM,EAAE,CAAC,EACvCtD,MAAM,CAACuD,SAAS,CAAEC,KAAK,IAAKC,2BAA2B,CAACD,KAAK,CAACE,IAAI,CAAC,CAAC,EACpE1D,MAAM,CAAC2D,SAAS,CAAED,IAAI,IAAKA,IAAI,KAAK,QAAQ,CAAC,EAC7C1D,MAAM,CAACqC,SAAS,CAAC;MACf;MACAuB,KAAK,EAAGrB,KAAK,IAAKvC,MAAM,CAAC6D,GAAG,CAACtB,KAAK,CAAC;MACnCM,eAAe,EAAGN,KAAK,IAAKvC,MAAM,CAAC8D,UAAU,CAACxD,MAAM,CAACwC,kBAAkB,CAACP,KAAK,EAAE,4BAA4B,CAAC,CAAC;MAC7GQ,WAAW,EAAGR,KAAK,IAAKvC,MAAM,CAACwC,IAAI,CAAClC,MAAM,CAAC0C,cAAc,CAACT,KAAK,EAAE,4BAA4B,CAAC;KAC/F,CAAC,CACI;IACR,OAAO,CAACW,QAAQ,EAAEC,MAAM,CAAC;EAC3B,CAAC;EAED,MAAMY,0BAA0B,GAA2C7B,OAAO,IAChFP,YAAY,CAACqC,OAAO,CAClB5D,iBAAiB,CAAC6D,IAAI,CAAC,mBAAmB,EAAE;IAC1CC,IAAI,EAAEhE,QAAQ,CAACiE,UAAU,CAAC;MACxB,GAAGjC,OAAO;MACViB,MAAM,EAAE,IAAI;MACZiB,cAAc,EAAE;QAAEC,aAAa,EAAE;MAAI;KACtC;GACF,CAAC,CACH,CAACtD,IAAI,CACJpB,MAAM,CAAC2E,GAAG,CAACrB,yBAAyB,CAAC,EACrCtD,MAAM,CAAC4E,QAAQ,CACb,iBAAiB,EAChBhC,KAAK,IAAKjC,MAAM,CAACwC,kBAAkB,CAACP,KAAK,EAAE,4BAA4B,CAAC,CAC1E,CACF;EAEH,OAAO/B,gBAAgB,CAACgE,EAAE,CAAC;IACzB3C,MAAM;IACNI,oBAAoB;IACpB8B;GACD,CAAC;AACJ,CAAC,CACF;AAED;AACA;AACA;AAEA;;;;;;;;;;;;;;AAcA,OAAO,MAAMU,KAAK,GAAI7D,OAAgB,IACpCf,KAAK,CAAC6E,MAAM,CAAClE,gBAAgB,EAAEE,IAAI,CAACE,OAAO,CAAC,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;AAoBA,OAAO,MAAM+D,WAAW,GAAI/D,OAyB3B,IACCf,KAAK,CAAC6E,MAAM,CACVlE,gBAAgB,EAChBb,MAAM,CAACiF,GAAG,CAAC,aAAS;EAClB,MAAMxD,MAAM,GAAGtB,SAAS,CAACkC,cAAc,CAACpB,OAAO,EAAEQ,MAAM,CAAC,GACpD,OAAOR,OAAO,CAACQ,MAAM,GACrByD,SAAS;EACb,MAAM1D,MAAM,GAAGrB,SAAS,CAACkC,cAAc,CAACpB,OAAO,EAAEO,MAAM,CAAC,GACpD,OAAOP,OAAO,CAACO,MAAM,GACrB0D,SAAS;EACb,MAAMvD,YAAY,GAAGxB,SAAS,CAACkC,cAAc,CAACpB,OAAO,EAAEU,YAAY,CAAC,GAChE,OAAOV,OAAO,CAACU,YAAY,GAC3BuD,SAAS;EACb,MAAMrD,SAAS,GAAG1B,SAAS,CAACkC,cAAc,CAACpB,OAAO,EAAEY,SAAS,CAAC,GAC1D,OAAOZ,OAAO,CAACY,SAAS,GACxBqD,SAAS;EACb,OAAO,OAAOnE,IAAI,CAAC;IACjBU,MAAM;IACND,MAAM;IACNG,YAAY;IACZE,SAAS;IACTE,eAAe,EAAEd,OAAO,EAAEc;GAC3B,CAAC;AACJ,CAAC,CAAC,CACH;AAEH;AACA;AACA;AAEA,MAAMoD,wCAAwC,gBAAG/E,MAAM,CAACgF,cAAc,CAAC1E,SAAS,CAAC2E,0BAA0B,CAACC,MAAM,CAACvB,IAAI,CAAC;AACxH,MAAMwB,oCAAoC,gBAAGnF,MAAM,CAACoF,mBAAmB,CAACL,wCAAwC,CAAC;AAEjH,MAAMrB,2BAA2B,GAC/BC,IAAY,IAEZA,IAAI,KAAK,QAAQ,GACb/D,MAAM,CAACyF,OAAO,CAAC1B,IAAI,CAAC,GACpBwB,oCAAoC,CAACxB,IAAI,CAAC","ignoreList":[]}

package/dist/OpenRouterConfig.d.ts

@@ -1,21 +1,34 @@
 /**
- * The `OpenRouterConfig` module provides contextual configuration for the
- * OpenRouter provider integration. It is used to customize the HTTP client that
- * backs OpenRouter requests without rebuilding the provider layer itself.
+ * 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.
  *
- * Use {@link withClientTransform} when a single effect, workflow, or scoped
- * portion of an application needs to add cross-cutting HTTP client behavior
- * such as request logging, retries, proxy routing, additional headers, or test
- * doubles. The configuration is read from the current Effect context, so the
- * transform only applies where the returned effect is run with that context.
+ * **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 call to {@link withClientTransform} replaces the current client
- *   transform for the provided effect; compose transforms manually when both
- *   behaviors should apply.
+ * - 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 client contract while adding behavior around it.
+ *   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
  */
@@ -24,9 +37,16 @@ import * as Effect from "effect/Effect";
 import type { HttpClient } from "effect/unstable/http/HttpClient";
 declare const OpenRouterConfig_base: Context.ServiceClass<OpenRouterConfig, "@effect/ai-openrouter/OpenRouterConfig", OpenRouterConfig.Service>;
 /**
- * Context service carrying scoped OpenRouter provider configuration for client
+ * Context service for scoped OpenRouter provider configuration used by 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
  */
@@ -59,6 +79,24 @@ export declare namespace OpenRouterConfig {
  * 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
  */
@@ -67,6 +105,24 @@ export declare const withClientTransform: {
      * 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
      */
@@ -75,6 +131,24 @@ export declare const withClientTransform: {
      * 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
      */

package/dist/OpenRouterConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenRouterConfig.d.ts","sourceRoot":"","sources":["../src/OpenRouterConfig.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;;AAEjE;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,qBAGO;IAC3C;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAGzF;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC;;;;;;OAMG;IACH,UAAiB,OAAO;QACtB,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,UAAU,KAAK,UAAU,CAAC,GAAG,SAAS,CAAA;KAC5E;CACF;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,EAAE;IAChC;;;;;;OAMG;IACH,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,UAAU,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAClH;;;;;;OAMG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACN,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAC5B,SAAS,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,UAAU,GAC5C,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;CA4B1B,CAAA"}
+{"version":3,"file":"OpenRouterConfig.d.ts","sourceRoot":"","sources":["../src/OpenRouterConfig.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;;AAEjE;;;;;;;;;;;;;GAaG;AACH,qBAAa,gBAAiB,SAAQ,qBAGO;IAC3C;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,gBAAgB,CAAC,OAAO,GAAG,SAAS,CAAC,CAGzF;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,gBAAgB,CAAC;IACxC;;;;;;OAMG;IACH,UAAiB,OAAO;QACtB,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,UAAU,KAAK,UAAU,CAAC,GAAG,SAAS,CAAA;KAC5E;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,mBAAmB,EAAE;IAChC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,SAAS,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,UAAU,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAClH;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EACN,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAC5B,SAAS,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,UAAU,GAC5C,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;CAgE1B,CAAA"}

package/dist/OpenRouterConfig.js

@@ -1,21 +1,34 @@
 /**
- * The `OpenRouterConfig` module provides contextual configuration for the
- * OpenRouter provider integration. It is used to customize the HTTP client that
- * backs OpenRouter requests without rebuilding the provider layer itself.
+ * 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.
  *
- * Use {@link withClientTransform} when a single effect, workflow, or scoped
- * portion of an application needs to add cross-cutting HTTP client behavior
- * such as request logging, retries, proxy routing, additional headers, or test
- * doubles. The configuration is read from the current Effect context, so the
- * transform only applies where the returned effect is run with that context.
+ * **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 call to {@link withClientTransform} replaces the current client
- *   transform for the provided effect; compose transforms manually when both
- *   behaviors should apply.
+ * - 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 client contract while adding behavior around it.
+ *   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
  */
@@ -23,9 +36,16 @@ import * as Context from "effect/Context";
 import * as Effect from "effect/Effect";
 import { dual } from "effect/Function";
 /**
- * Context service carrying scoped OpenRouter provider configuration for client
+ * Context service for scoped OpenRouter provider configuration used by 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
  */
@@ -41,6 +61,24 @@ export class OpenRouterConfig extends /*#__PURE__*/Context.Service()("@effect/ai
  * 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
  */

package/dist/OpenRouterConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"OpenRouterConfig.js","names":["Context","Effect","dual","OpenRouterConfig","Service","getOrUndefined","map","context","services","mapUnsafe","get","key","withClientTransform","self","transformClient","flatMap","config","provideService"],"sources":["../src/OpenRouterConfig.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,SAASC,IAAI,QAAQ,iBAAiB;AAGtC;;;;;;;AAOA,OAAM,MAAOC,gBAAiB,sBAAQH,OAAO,CAACI,OAAO,EAGlD,CAAC,wCAAwC,CAAC;EAC3C;;;;;EAKA,OAAgBC,cAAc,gBAA+DJ,MAAM,CAACK,GAAG,cACrGL,MAAM,CAACM,OAAO,EAAS,EACtBC,QAAQ,IAAKA,QAAQ,CAACC,SAAS,CAACC,GAAG,CAACP,gBAAgB,CAACQ,GAAG,CAAC,CAC3D;;AAqBH;;;;;;;AAOA,OAAO,MAAMC,mBAAmB,gBAoB5BV,IAAI,CAqBN,CAAC,EACD,CAACW,IAAI,EAAEC,eAAe,KACpBb,MAAM,CAACc,OAAO,CACZZ,gBAAgB,CAACE,cAAc,EAC9BW,MAAM,IAAKf,MAAM,CAACgB,cAAc,CAACJ,IAAI,EAAEV,gBAAgB,EAAE;EAAE,GAAGa,MAAM;EAAEF;AAAe,CAAE,CAAC,CAC1F,CACJ","ignoreList":[]}
+{"version":3,"file":"OpenRouterConfig.js","names":["Context","Effect","dual","OpenRouterConfig","Service","getOrUndefined","map","context","services","mapUnsafe","get","key","withClientTransform","self","transformClient","flatMap","config","provideService"],"sources":["../src/OpenRouterConfig.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,OAAO,KAAKA,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAKC,MAAM,MAAM,eAAe;AACvC,SAASC,IAAI,QAAQ,iBAAiB;AAGtC;;;;;;;;;;;;;;AAcA,OAAM,MAAOC,gBAAiB,sBAAQH,OAAO,CAACI,OAAO,EAGlD,CAAC,wCAAwC,CAAC;EAC3C;;;;;EAKA,OAAgBC,cAAc,gBAA+DJ,MAAM,CAACK,GAAG,cACrGL,MAAM,CAACM,OAAO,EAAS,EACtBC,QAAQ,IAAKA,QAAQ,CAACC,SAAS,CAACC,GAAG,CAACP,gBAAgB,CAACQ,GAAG,CAAC,CAC3D;;AAqBH;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,OAAO,MAAMC,mBAAmB,gBAwD5BV,IAAI,CAyDN,CAAC,EACD,CAACW,IAAI,EAAEC,eAAe,KACpBb,MAAM,CAACc,OAAO,CACZZ,gBAAgB,CAACE,cAAc,EAC9BW,MAAM,IAAKf,MAAM,CAACgB,cAAc,CAACJ,IAAI,EAAEV,gBAAgB,EAAE;EAAE,GAAGa,MAAM;EAAEF;AAAe,CAAE,CAAC,CAC1F,CACJ","ignoreList":[]}

package/dist/OpenRouterLanguageModel.d.ts

@@ -99,7 +99,14 @@ declare const Config_base: Context.ServiceClass<Config, "@effect/ai-openrouter/O
     readonly strictJsonSchema?: boolean | undefined | undefined;
 }>;
 /**
- * Service definition for OpenRouter language model configuration.
+ * Context service for OpenRouter language model configuration.
+ *
+ * **When to use**
+ *
+ * Use to provide scoped OpenRouter chat completion defaults or per-operation
+ * overrides for an OpenRouter language model service.
+ *
+ * @see {@link withConfigOverride} for scoping language model request overrides
  *
  * @category services
  * @since 4.0.0
@@ -222,7 +229,7 @@ declare module "effect/unstable/ai/Prompt" {
      *
      * **When to use**
      *
-     * Use these options to control how text content is sent to OpenRouter.
+     * Use when you use these options to control how text content is sent to OpenRouter.
      *
      * @category request
      * @since 4.0.0
@@ -486,14 +493,51 @@ declare module "effect/unstable/ai/Response" {
     }
 }
 /**
- * Creates an AI model descriptor for an OpenRouter language model.
+ * Creates an OpenRouter model descriptor that can be provided with
+ * `Effect.provide`.
+ *
+ * **When to use**
+ *
+ * Use when you want an OpenRouter language model value that carries provider
+ * and model metadata and can be supplied directly to an Effect program.
+ *
+ * **Details**
+ *
+ * The returned model requires `OpenRouterClient` and provides
+ * `LanguageModel.LanguageModel`.
+ *
+ * @see {@link layer} for creating a `LanguageModel.LanguageModel` layer directly
+ * @see {@link make} for constructing the language model service effectfully
+ * @see {@link withConfigOverride} for scoping OpenRouter request overrides
  *
  * @category constructors
  * @since 4.0.0
  */
 export declare const model: (model: string, config?: Omit<typeof Config.Service, "model">) => AiModel.Model<"openai", LanguageModel.LanguageModel, OpenRouterClient>;
 /**
- * Creates an OpenRouter language model service.
+ * Creates an OpenRouter `LanguageModel` service from a model identifier and
+ * optional request defaults.
+ *
+ * **When to use**
+ *
+ * Use when an Effect needs to construct a `LanguageModel.Service` value backed
+ * by `OpenRouterClient`.
+ *
+ * **Details**
+ *
+ * The returned effect requires `OpenRouterClient`. Request defaults from the
+ * `config` option are merged with any `Config` service in the context, with
+ * context values taking precedence. The service supports both `generateText`
+ * and `streamText`.
+ *
+ * **Gotchas**
+ *
+ * Provider-defined tools are not supported by this provider integration;
+ * requests that include them fail with an `InvalidUserInputError`.
+ *
+ * @see {@link layer} for providing the service as a `Layer`
+ * @see {@link model} for creating a model descriptor for `Effect.provide`
+ * @see {@link withConfigOverride} for scoping request defaults around operations
  *
  * @category constructors
  * @since 4.0.0
@@ -505,6 +549,15 @@ export declare const make: (args_0: {
 /**
  * Creates a layer for the OpenRouter language model.
  *
+ * **When to use**
+ *
+ * Use when composing application layers and you want OpenRouter to satisfy
+ * `LanguageModel.LanguageModel` while supplying `OpenRouterClient` from another
+ * layer.
+ *
+ * @see {@link make} for constructing the language model service effectfully
+ * @see {@link model} for creating a model descriptor for `Effect.provide`
+ *
  * @category layers
  * @since 4.0.0
  */
@@ -515,6 +568,20 @@ export declare const layer: (options: {
 /**
  * Provides config overrides for OpenRouter language model operations.
  *
+ * **When to use**
+ *
+ * Use to apply OpenRouter request configuration to one effect without changing
+ * the model's default configuration.
+ *
+ * **Details**
+ *
+ * The overrides are merged with any existing `Config` service for the duration
+ * of the supplied effect. Fields in `overrides` take precedence over existing
+ * config, and the helper supports both pipe form and
+ * `withConfigOverride(effect, overrides)`.
+ *
+ * @see {@link Config} for available OpenRouter request configuration fields
+ *
  * @category configuration
  * @since 4.0.0
  */
@@ -522,6 +589,20 @@ export declare const withConfigOverride: {
     /**
      * Provides config overrides for OpenRouter language model operations.
      *
+     * **When to use**
+     *
+     * Use to apply OpenRouter request configuration to one effect without changing
+     * the model's default configuration.
+     *
+     * **Details**
+     *
+     * The overrides are merged with any existing `Config` service for the duration
+     * of the supplied effect. Fields in `overrides` take precedence over existing
+     * config, and the helper supports both pipe form and
+     * `withConfigOverride(effect, overrides)`.
+     *
+     * @see {@link Config} for available OpenRouter request configuration fields
+     *
      * @category configuration
      * @since 4.0.0
      */
@@ -529,6 +610,20 @@ export declare const withConfigOverride: {
     /**
      * Provides config overrides for OpenRouter language model operations.
      *
+     * **When to use**
+     *
+     * Use to apply OpenRouter request configuration to one effect without changing
+     * the model's default configuration.
+     *
+     * **Details**
+     *
+     * The overrides are merged with any existing `Config` service for the duration
+     * of the supplied effect. Fields in `overrides` take precedence over existing
+     * config, and the helper supports both pipe form and
+     * `withConfigOverride(effect, overrides)`.
+     *
+     * @see {@link Config} for available OpenRouter request configuration fields
+     *
      * @category configuration
      * @since 4.0.0
      */