@x12i/ai-dispatcher 2.3.0 → 2.3.2

package/README.md

@@ -4,7 +4,7 @@ One request shape for OpenRouter, AWS Bedrock, the OpenAI Responses API, and Clo
 
 **Implemented providers:** `openrouter`, `bedrock`, `openai`, `cloudflare`. Any other provider throws `PROVIDER_NOT_IMPLEMENTED`.
 
-The package is `@x12i/ai-dispatcher` 2.3.0. It runs on Node 20 or newer and publishes ESM and CommonJS from the same entry.
+The package is `@x12i/ai-dispatcher` 2.3.1. It runs on Node 20 or newer and publishes ESM and CommonJS from the same entry.
 
 Connected MCP servers can be passed to `createAiDispatcher`. `run()` and `compile()` expose those tools to the model. `executeStreamingChat` does not. Details are in [MCP tools](#mcp-tools).
 
@@ -177,7 +177,7 @@ const record = decodeProviderMetadata(logMetadata);
 
 `metadata` is the one record. When `rawOpenRouterOverrides` only repeats `metadata`, the dispatcher folds it in. `metadata` wins when the same key is in both places. String, number, and boolean values are stored, including a JSON string. Objects and arrays stay on the normalized response and the tool context.
 
-Every provider writes that record as `m.0`, `m.1`, and so on: one base64 string, 256 characters per piece, at most 16 pieces. The base64 is the UTF-8 JSON object of the string map, with keys sorted. `decodeProviderMetadata` reads those pieces from OpenRouter body `metadata`, OpenAI Responses `metadata`, Bedrock `requestMetadata`, or Cloudflare body `metadata` and `cf-aig-metadata`. The pieces are the same on every provider. The dispatcher trims on every call. Pass `metadataPriority` (highest priority first) to choose what stays. The default keeps `agentId`, `orgId`, `stepId`, `skillId`, `role`, `roleLayer`, `roleDigest`, `profileChoice`, `recordId`, and `objectType`. A trimmed call adds a `METADATA_RECORD_TRIMMED` warning.
+Every provider writes that record as `m.0`, `m.1`, and so on: one base64 string, 256 characters per piece, at most 16 pieces. The base64 is the UTF-8 JSON object of the string map, with keys sorted. `decodeProviderMetadata` reads those pieces from OpenRouter body `metadata`, OpenAI Responses `metadata`, Bedrock `requestMetadata`, or Cloudflare body `metadata`. Pass the Cloudflare `cf-aig-metadata` header as that same object or as the raw JSON string. The pieces are the same on every provider. The dispatcher trims on every call. Pass `metadataPriority` (highest priority first) to choose what stays. The default keeps `agentId`, `orgId`, `stepId`, `skillId`, `role`, `roleLayer`, `roleDigest`, `profileChoice`, `recordId`, and `objectType`. A trimmed call adds a `METADATA_RECORD_TRIMMED` warning.
 
 Repeating vendor fields normalize to one key. Prefer `metadata.api_key_name` over `metadata.openrouter.api_key_name`. `normalizeMetadata` and `decodeProviderMetadata` promote known aliases and keep the vendor key. Grow `METADATA_NORMALIZATION_MAP` as more shared fields appear.
 
@@ -446,6 +446,17 @@ await dispatcher.run({
 
 Cloudflare supports the same `run`, `compile`, and `executeStreamingChat` entrypoints. `executeStreamingChat` rejects `/ai/run`. `reasoningEffort` uses the OpenAI or OpenRouter catalog, as described above. `cache` sets AI Gateway headers and, for GPT on Responses and Claude on Messages, the native breakpoint. Local function tools and MCP tools follow the OpenAI loop. OpenRouter server tools are rejected. `rawOpenRouterOverrides` is rejected except for a `metadata` object, which is folded into `metadata`. `responseFormat` is `text` on Responses, `response_format` on chat, and rejected on messages and run.
 
+## Credentials
+
+A provider is available when the dispatcher can resolve the credential it sends. `compile` and `run` throw when a required value is missing.
+
+| Provider | Option | Environment |
+| --- | --- | --- |
+| OpenRouter | `openrouter.apiKey` | `OPENROUTER_API_KEY`, then `OPEN_ROUTER_KEY` |
+| Bedrock | `bedrock.region` and optional `bedrock.credentials` | `AWS_REGION` or `AWS_DEFAULT_REGION`. When `credentials` is omitted, the AWS SDK default chain is used. An explicit credential is `accessKeyId`, `secretAccessKey`, and optional `sessionToken`. |
+| OpenAI | `openai.apiKey` | `OPENAI_API_KEY` |
+| Cloudflare | `cloudflare.apiToken` and `cloudflare.accountId` | `CLOUDFLARE_API_TOKEN` and `CLOUDFLARE_ACCOUNT_ID` |
+
 ## Errors
 
 Catalog failures throw `AiDispatcherError` with `code`, `message`, and the catalog `details`. Dispatcher codes include:
@@ -466,7 +477,7 @@ Catalog failures throw `AiDispatcherError` with `code`, `message`, and the catal
 | `PROVIDER_AUTH_FAILED` | OpenAI or Cloudflare HTTP `401` or `403` |
 | `PROVIDER_MODEL_NOT_FOUND` | OpenAI or Cloudflare HTTP `404` |
 | `PROVIDER_REQUEST_FAILED` | Other OpenAI or Cloudflare HTTP failures |
-| `PROVIDER_RATE_LIMITED` | Cloudflare HTTP `429` after retries |
+| `PROVIDER_RATE_LIMITED` | OpenAI or Cloudflare HTTP `429` after retries |
 | `PROVIDER_RETRYABLE` / `PROVIDER_GATEWAY_UNREACHABLE` | OpenAI or Cloudflare transport failures after retries, including timeout |
 | `FUNCTION_TOOL_LIMIT` | Function-tool calls exceed `maxFunctionToolCalls` |
 | `UNSUPPORTED_CONTENT` | Bedrock received an image URL or content part it cannot send |

package/dist/index.cjs

@@ -3280,8 +3280,7 @@ async function readFailure2(response) {
 function classifyStatus2(status) {
   if (status === 401 || status === 403) return "PROVIDER_AUTH_FAILED";
   if (status === 404) return "PROVIDER_MODEL_NOT_FOUND";
-  if (status === 429) return "PROVIDER_RATE_LIMITED";
-  if (status === 408 || status >= 500) return "PROVIDER_RETRYABLE";
+  if (status === 429 || status === 408 || status >= 500) return "PROVIDER_RETRYABLE";
   return "PROVIDER_REQUEST_FAILED";
 }
 function isConfigError2(code) {
@@ -3289,6 +3288,8 @@ function isConfigError2(code) {
 }
 function asTerminalError2(error) {
   if (error instanceof AiDispatcherError && error.code === "PROVIDER_RETRYABLE") {
+    const status = isRecord7(error.details) ? error.details.status : void 0;
+    if (status === 429) return new AiDispatcherError("PROVIDER_RATE_LIMITED", error.message, error.details);
     return new AiDispatcherError("PROVIDER_GATEWAY_UNREACHABLE", error.message, error.details);
   }
   if (error instanceof AiDispatcherError) return error;