llm-stream-assemble 1.2.0 → 1.3.6

package/README.md

@@ -1,28 +1,37 @@
 # llm-stream-assemble
 
-![core](https://img.shields.io/badge/core-1.2.0-blue)
+![core](https://img.shields.io/badge/core-1.3.6-blue)
 ![node](https://img.shields.io/badge/node-%3E%3D18-339933)
 ![runtime deps](https://img.shields.io/badge/runtime_deps-0-brightgreen)
-![tests](https://img.shields.io/badge/tests-755%2B_passing-brightgreen)
+![tests](https://img.shields.io/badge/tests-1019%2B_passing-brightgreen)
 [![ci](https://github.com/01laky/llm-stream-assemble/actions/workflows/ci.yml/badge.svg)](https://github.com/01laky/llm-stream-assemble/actions/workflows/ci.yml)
-![status](https://img.shields.io/badge/status-stable_1.2.0-brightgreen)
+![status](https://img.shields.io/badge/status-stable_1.3.6-brightgreen)
 
 **One typed event model for every LLM stream** — text, tool calls, reasoning, JSON, usage, refusals, errors, and non-streaming responses.
 
 > A zero-dependency TypeScript layer for assembling **OpenAI**, **Anthropic**, **Google Gemini**, and **OpenAI-compatible** LLM streams into unified events — so you can stop hand-rolling provider parsers and keep one clean, typed event model across chat UIs, agents, proxies, and backends.
 
-**Status:** Stable `1.2.0`. Five built-in adapters, twelve OpenAI-compatible host presets (including **Azure OpenAI**), transforms, replay helpers, and examples are production-ready. Pin semver ranges as usual and review [CHANGELOG.md](./CHANGELOG.md) before major upgrades.
+Turn provider SSE fragments into typed events — **not another `+=` loop**.
+
+**Status:** Stable `1.3.6`. Five built-in adapters, thirteen OpenAI-compatible host presets (including **Azure OpenAI** and **Cloudflare Workers AI**), transforms, replay helpers, and examples are production-ready. Pin semver ranges as usual and review [CHANGELOG.md](./CHANGELOG.md) before major upgrades.
 
 ---
 
 ## Contents
 
+- [Why not just concatenate?](#why-not-just-concatenate)
+- [Edge-case showcase](#edge-case-showcase)
 - [Why use this](#why-use-this)
 - [Architecture](#architecture)
 - [Providers at a glance](#providers-at-a-glance)
 - [Install](#install)
+- [First success in 30 seconds](#first-success-in-30-seconds)
 - [Quickstart](#quickstart)
+- [Quick decision guide](#quick-decision-guide)
 - [Documentation](#documentation)
+- [How this compares](#how-this-compares)
+- [Examples](#examples)
+- [Integration cookbook](#integration-cookbook)
 - [Usage guides](#usage-guides)
 - [Transforms & replay](#transforms--replay)
 - [Examples & proxy safety](#examples--proxy-safety)
@@ -31,13 +40,67 @@
 
 ---
 
+## Why not just concatenate?
+
+Raw LLM streams look like text, but **simple string concatenation or naive `JSON.parse` per chunk fails** in production. Providers emit **protocol events**, not finished messages.
+
+1. **SSE mid-line splits** — TCP chunks can break `data: {"choices":[...]}\n` across reads; you need a line buffer (`parse-sse.ts`, fixtures **LSA-C**).
+2. **Tool argument fragmentation** — function parameters arrive as partial JSON across dozens of deltas; only assembly produces valid `tool_call.done` args.
+3. **Anthropic id/index ordering** — `tool_use` blocks may stream `index` before `id`; fine-grained `input_json_delta` is invalid JSON until the block ends.
+4. **Reasoning vs user text** — DeepSeek R1, Claude thinking, and OpenAI reasoning models interleave hidden reasoning that must map to `reasoning.*`, not `text.*`.
+5. **JSON mode streaming** — structured output streams as deltas; you do not receive a parsed object until completion (`json.delta` / `json.done`).
+6. **Stream lifecycle** — `[DONE]` markers, usage-only tail chunks, and incomplete streams without explicit finish need consistent terminal handling.
+7. **Mid-stream errors** — provider error payloads must not leak raw internals to browsers; use `sanitizeErrors` when proxying (**LSA-X23**).
+8. **Dual code paths** — the same `StreamEvent` union should work for `stream: true` SSE and non-stream JSON (`assembleStream` vs `assembleResponse`).
+
+This library is the **assembly layer** between those raw bytes and your UI, agent, or proxy.
+
+### Why not `text += chunk`?
+
+The first reaction is often: “Why not `message += chunk`?” Provider streams are **protocol events**, not finished message strings.
+
+| Failure mode                      | What breaks with `+=` / naive parse                 | This library                                      |
+| --------------------------------- | --------------------------------------------------- | ------------------------------------------------- |
+| **Chunk boundaries**              | SSE `data:` line split mid-payload across TCP reads | Line buffer — `parse-sse.ts`                      |
+| **Incomplete structures**         | One SSE payload ≠ one complete JSON message         | Adapter per payload; assembler until `.done`      |
+| **State management**              | Parallel tools, reasoning vs text channels          | `EventAssembler` per stream                       |
+| **Parser invalidity mid-stream**  | Anthropic `input_json_delta`, partial tool args     | Partial preview; valid at `.done`                 |
+| **JSON partials**                 | Structured output streams as fragments              | `json.*`, `tool_call.args.delta`                  |
+| **Markdown fences in model text** | ` ```json ` split across **text tokens**            | **Out of scope** — render `text.delta` in your UI |
+
+See [Edge-case showcase](#edge-case-showcase) for concrete chunk examples.
+
+---
+
+## Edge-case showcase
+
+Raw streams break in predictable ways. Three layers — **SSE framing**, **tool/JSON assembly**, **UI text** — fail differently:
+
+![Chunk assembly: SSE fragments to unified events](https://raw.githubusercontent.com/01laky/llm-stream-assemble/main/docs/img/chunk-assembly.svg)
+
+- **SSE mid-line split** — TCP reads break `data: {...}\n` across buffers; line parser required.
+- **Tool JSON partials** — args stream as `{`, `"city":`, `"Paris"}` before `tool_call.done`.
+- **JSON mode** — structured output arrives as `json.delta` strings, not a parsed object.
+
+**[Full edge-case walkthrough →](./docs/edge-cases.md)** — DIY vs `assembleStream`, fixture replay, test IDs (**LSA-C04**, **LSA-C52**, golden fixtures).
+
+---
+
 ## Why use this
 
 - **Zero runtime dependencies** — thin adapters + core assembly, no provider SDKs.
 - **Stream and non-stream parity** — same `StreamEvent` union from SSE chunks or JSON bodies.
-- **Provider presets, not forks** — Groq, Azure, Perplexity, xAI, and others reuse one compatible parser with dialect options.
+- **Provider presets, not forks** — Groq, Azure, Cloudflare, Perplexity, xAI, and others reuse one compatible parser with dialect options.
 - **Proxy-ready transforms** — `toSSE({ sanitizeErrors: true })`, `tapEvents`, `collectStream`, fixture replay.
 
+### Performance at a glance
+
+- **Zero runtime dependencies** — verified in CI (`pnpm verify:deps`)
+- **Incremental SSE parsing** — line buffer; no full-stream re-parse
+- **Single-pass O(n) assembly** — **LSA-C52** smoke test on 10k chunks
+- **Bounded buffers** — `maxBufferBytes` for untrusted streams
+- **Local repro:** `pnpm bench:smoke` — see [performance](./docs/performance.md)
+
 ---
 
 ## Architecture
@@ -58,19 +121,30 @@ Every adapter maps provider-specific fragments into the same **`StreamEvent`** u
 
 **Design constraints:** adapters never accumulate cross-chunk state beyond id/index reconciliation; assembly, buffering, and `.done` emission live in core. No HTTP client, no tool execution, no UI — just the stream layer.
 
+### Lifecycle & concurrency
+
+- **`EventAssembler` is stateful per stream** — it buffers text, reasoning, JSON, refusals, and open tool calls until `.done` / `finish`.
+- **Public APIs create a new assembler per call** — `assembleStream`, `assembleFromPayloads`, `assembleResponse`, and `createAssemblyTransform` each construct their own instance.
+- **One assembler = one stream/response** — do not share an instance across concurrent requests.
+- **`EventAssembler.reset()`** clears state for tests or explicit reuse after a stream completes.
+- **Adapters are thin** — one payload in, `RawChunk[]` out; create **one adapter instance per request/stream** (minimal id/index map only).
+- **Transforms are stateless** — `tapEvents`, `toSSE`, and `collectStream` operate on the unified event stream.
+
+![Stateful assembler vs stateless adapters](https://raw.githubusercontent.com/01laky/llm-stream-assemble/main/docs/img/assembler-lifecycle.svg)
+
 Diagram sources: [`docs/img/`](./docs/img/) (Mermaid `.mmd` + committed SVG). Regenerate with `pnpm diagrams:build`.
 
 ---
 
 ## Providers at a glance
 
-| Adapter                                 | Provider / API                                                                                                          | Import                                      |
-| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
-| `openaiChatAdapter()`                   | OpenAI Chat Completions                                                                                                 | `llm-stream-assemble`                       |
-| `openaiCompatibleAdapter({ provider })` | Groq, DeepSeek, Mistral, Ollama, LM Studio, Together, Fireworks, OpenRouter, Perplexity, xAI, **Azure OpenAI**, generic | `llm-stream-assemble`                       |
-| `anthropicAdapter()`                    | Anthropic Messages                                                                                                      | `llm-stream-assemble`                       |
-| `openaiResponsesAdapter()`              | OpenAI Responses API                                                                                                    | `llm-stream-assemble`                       |
-| `geminiAdapter()`                       | Google AI Gemini                                                                                                        | `llm-stream-assemble` or `/adapters/gemini` |
+| Adapter                                 | Provider / API                                                                                                                                     | Import                                      |
+| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
+| `openaiChatAdapter()`                   | OpenAI Chat Completions                                                                                                                            | `llm-stream-assemble`                       |
+| `openaiCompatibleAdapter({ provider })` | Groq, DeepSeek, Mistral, Ollama, LM Studio, Together, Fireworks, OpenRouter, Perplexity, xAI, **Azure OpenAI**, **Cloudflare Workers AI**, generic | `llm-stream-assemble`                       |
+| `anthropicAdapter()`                    | Anthropic Messages                                                                                                                                 | `llm-stream-assemble`                       |
+| `openaiResponsesAdapter()`              | OpenAI Responses API                                                                                                                               | `llm-stream-assemble`                       |
+| `geminiAdapter()`                       | Google AI Gemini                                                                                                                                   | `llm-stream-assemble` or `/adapters/gemini` |
 
 Full feature flags and quirks: [compatibility matrix](./docs/compatibility.md).
 
@@ -87,6 +161,23 @@ pnpm add llm-stream-assemble
 
 ---
 
+## First success in 30 seconds
+
+Minimal loop once you have a streaming `response.body` — see [Quickstart](#quickstart) for full `fetch` setup:
+
+```ts
+import { assembleStream, openaiChatAdapter } from "llm-stream-assemble";
+
+for await (const event of assembleStream(response.body!, openaiChatAdapter())) {
+	if (event.type === "text.delta") process.stdout.write(event.text);
+	if (event.type === "text.done") console.log("\n--- done:", event.text);
+}
+```
+
+Swap `openaiChatAdapter()` for `anthropicAdapter()`, `geminiAdapter()`, or `openaiCompatibleAdapter({ provider: "ollama" })` — [Quick decision guide](#quick-decision-guide).
+
+---
+
 ## Quickstart
 
 ```ts
@@ -99,10 +190,32 @@ for await (const event of assembleStream(response.body!, openaiChatAdapter())) {
 
 ---
 
+## Quick decision guide
+
+Pick an adapter in ~30 seconds:
+
+![Quick decision guide](https://raw.githubusercontent.com/01laky/llm-stream-assemble/main/docs/img/quick-decision.svg)
+
+- **OpenAI Chat Completions SSE** → `openaiChatAdapter()`
+- **OpenAI Responses API** → `openaiResponsesAdapter()`
+- **Anthropic Messages** → `anthropicAdapter()`
+- **Google Gemini** → `geminiAdapter()`
+- **Groq, Ollama, Azure, Cloudflare, OpenRouter, …** → `openaiCompatibleAdapter({ provider })`
+- **Non-streaming JSON body** → `assembleResponse(body, adapter)`
+- **React chat UI / full agent framework** → not this package — see [comparison](./docs/comparison.md)
+- **XML/markdown tag parsing from model text** → out of scope — see [Non-goals](#non-goals)
+
+---
+
 ## Documentation
 
 - [Provider compatibility matrix](./docs/compatibility.md)
 - [Adapter author guide](./docs/adapter-guide.md)
+- [Performance & runtime behavior](./docs/performance.md)
+- [Edge-case showcase](./docs/edge-cases.md)
+- [Integration cookbook](./docs/integration-cookbook.md)
+- [How this compares](./docs/comparison.md)
+- [FAQ](./docs/faq.md)
 - [Architecture diagrams](./docs/img/README.md)
 - [Live smoke checklist (maintainers)](./docs/live-smoke.md)
 - [Post-1.0 provider roadmap](./docs/post-1.0-provider-roadmap.md)
@@ -110,6 +223,90 @@ for await (const event of assembleStream(response.body!, openaiChatAdapter())) {
 
 ---
 
+## How this compares
+
+|              | llm-stream-assemble   | Full-stack AI SDK  | Provider SDK   | DIY concat   |
+| ------------ | --------------------- | ------------------ | -------------- | ------------ |
+| Scope        | Stream assembly only  | HTTP + UI + agents | Vendor RPC     | Manual parse |
+| Events       | Unified `StreamEvent` | Framework types    | Vendor types   | Ad hoc       |
+| Dependencies | Zero runtime          | Many               | Vendor package | None         |
+
+Full matrix, when-not-to-use, and alternatives: **[docs/comparison.md](./docs/comparison.md)**.
+
+---
+
+## Examples
+
+Curated index — full snippets live in [Usage guides](#usage-guides) and [`examples/`](./examples/README.md).
+
+### OpenAI Chat
+
+```ts
+import { assembleStream, openaiChatAdapter } from "llm-stream-assemble";
+// fetch(..., { stream: true }) then:
+for await (const event of assembleStream(response.body!, openaiChatAdapter())) {
+	if (event.type === "text.delta") process.stdout.write(event.text);
+}
+```
+
+→ [`examples/node-fetch/openai-chat.ts`](./examples/node-fetch/openai-chat.ts)
+
+### Ollama (local)
+
+```ts
+import { assembleStream, openaiCompatibleAdapter } from "llm-stream-assemble";
+const adapter = openaiCompatibleAdapter({ provider: "ollama" });
+for await (const event of assembleStream(response.body!, adapter)) {
+	if (event.type === "text.delta") process.stdout.write(event.text);
+}
+```
+
+→ [`examples/node-fetch/openai-compatible.ts`](./examples/node-fetch/openai-compatible.ts) · Usage: [OpenAI-Compatible](#openai-compatible-usage)
+
+### Anthropic Messages
+
+→ [`examples/node-fetch/anthropic.ts`](./examples/node-fetch/anthropic.ts) · Usage: [Anthropic Messages](#anthropic-messages-usage)
+
+### Google Gemini
+
+→ [`examples/node-fetch/gemini.ts`](./examples/node-fetch/gemini.ts) · Usage: [Gemini](#gemini-usage)
+
+### Streaming JSON (structured output)
+
+```ts
+for await (const event of assembleStream(response.body!, openaiChatAdapter({ jsonMode: true }))) {
+	if (event.type === "json.delta") process.stdout.write(event.delta);
+	if (event.type === "json.done") console.log(event.json);
+}
+```
+
+### Tool calling
+
+```ts
+for await (const event of assembleStream(response.body!, openaiChatAdapter())) {
+	if (event.type === "tool_call.args.delta") process.stdout.write(event.delta);
+	if (event.type === "tool_call.done") console.log(event.name, event.args);
+}
+```
+
+### Chat UI / markdown rendering
+
+Stream `text.delta` into your renderer — this library does **not** parse markdown/XML tags from model output (see [Non-goals](#non-goals)).
+
+### SSE proxy to browser
+
+→ [`examples/proxy-safety/`](./examples/proxy-safety/) — `toSSE(events, { sanitizeErrors: true })`
+
+### Fixture replay
+
+→ [`examples/node-fetch/replay-fixture.ts`](./examples/node-fetch/replay-fixture.ts)
+
+### Integration cookbook
+
+Wire unified events into **Hono**, **Express**, **Cloudflare Workers**, **LiteLLM**, **Next.js App Router**, AI SDK mapping, and LangChain callbacks — [`examples/integrations/`](./examples/integrations/) · **[Full cookbook →](./docs/integration-cookbook.md)**
+
+---
+
 ## Usage guides
 
 ### Core Usage
@@ -193,8 +390,9 @@ Provider presets:
 | `perplexity` | Perplexity API                | Search-grounded answers; citations in `metadata.raw`                                        |
 | `xai`        | xAI Grok API                  | OpenAI-compatible; `reasoning_content` mapped when present                                  |
 | `azure`      | Azure OpenAI Chat Completions | Stricter preset; deployment URL + `api-key` auth; content filter metadata in `metadata.raw` |
+| `cloudflare` | Cloudflare Workers AI REST    | OpenAI-compatible `/v1/chat/completions`; Bearer + account id; loose preset like Groq       |
 
-Base URL examples: Groq `https://api.groq.com/openai/v1`, DeepSeek `https://api.deepseek.com`, Mistral `https://api.mistral.ai/v1`, Ollama `http://localhost:11434/v1`, LM Studio `http://localhost:1234/v1`, Together `https://api.together.xyz/v1`, Fireworks `https://api.fireworks.ai/inference/v1`, OpenRouter `https://openrouter.ai/api/v1`, Perplexity `https://api.perplexity.ai`, xAI `https://api.x.ai/v1`, Azure OpenAI `https://{resource}.openai.azure.com/openai/deployments/{deployment}/chat/completions?api-version={version}`.
+Base URL examples: Groq `https://api.groq.com/openai/v1`, DeepSeek `https://api.deepseek.com`, Mistral `https://api.mistral.ai/v1`, Ollama `http://localhost:11434/v1`, LM Studio `http://localhost:1234/v1`, Together `https://api.together.xyz/v1`, Fireworks `https://api.fireworks.ai/inference/v1`, OpenRouter `https://openrouter.ai/api/v1`, Perplexity `https://api.perplexity.ai`, xAI `https://api.x.ai/v1`, Azure OpenAI `https://{resource}.openai.azure.com/openai/deployments/{deployment}/chat/completions?api-version={version}`, Cloudflare Workers AI `https://api.cloudflare.com/client/v4/accounts/{account_id}/ai/v1/chat/completions`.
 
 Strict vs loose configuration:
 
@@ -256,6 +454,44 @@ Use `openaiCompatibleAdapter({ provider: "azure", jsonMode: true })` when struct
 
 See `examples/node-fetch/azure-openai.ts` for a URL builder helper and `examples/proxy-safety/README.md` for server-side proxy notes.
 
+### Cloudflare Workers AI Usage
+
+Cloudflare Workers AI exposes an OpenAI-compatible REST endpoint at `/v1/chat/completions` under your account. Use the **`cloudflare`** preset — not `generic` — when you want fixture-tested defaults for Workers AI REST (loose metadata tolerance like Groq).
+
+```ts
+import { assembleStream, openaiCompatibleAdapter } from "llm-stream-assemble";
+
+const accountId = process.env.CLOUDFLARE_ACCOUNT_ID!;
+const url = `https://api.cloudflare.com/client/v4/accounts/${accountId}/ai/v1/chat/completions`;
+
+const response = await fetch(url, {
+	method: "POST",
+	headers: {
+		Authorization: `Bearer ${process.env.CLOUDFLARE_API_TOKEN!}`,
+		"Content-Type": "application/json",
+	},
+	body: JSON.stringify({
+		model: "@cf/meta/llama-3.1-8b-instruct",
+		messages: [{ role: "user", content: "Hello" }],
+		stream: true,
+		stream_options: { include_usage: true },
+	}),
+});
+
+for await (const event of assembleStream(
+	response.body!,
+	openaiCompatibleAdapter({ provider: "cloudflare" }),
+)) {
+	if (event.type === "text.delta") process.stdout.write(event.text);
+}
+```
+
+Streaming usage requires `stream_options: { include_usage: true }` on the request. Use `openaiCompatibleAdapter({ provider: "cloudflare", jsonMode: true })` when JSON output should map to `json.*` events.
+
+The **`env.AI.run(model, { stream: true })`** Worker binding can return SSE bytes compatible with `assembleStream` when the model streams Chat Completions-shaped payloads — account binding and auth stay in your Worker; this library only parses the bytes.
+
+See `examples/workers-ai/rest-chat-completions.ts` and `examples/proxy-safety/README.md` (Bearer token + account id must never reach the browser).
+
 ### Anthropic Messages Usage
 
 `anthropicAdapter()` parses Anthropic Messages streaming events and non-streaming responses. Create one adapter instance per request/stream.
@@ -377,17 +613,18 @@ for await (const event of assembleFromFile(
 
 ## Examples & proxy safety
 
-| Example                                                                                  | Description                             |
-| ---------------------------------------------------------------------------------------- | --------------------------------------- |
-| [`examples/node-fetch/openai-chat.ts`](./examples/node-fetch/openai-chat.ts)             | OpenAI Chat Completions streaming       |
-| [`examples/node-fetch/openai-compatible.ts`](./examples/node-fetch/openai-compatible.ts) | OpenAI-compatible presets               |
-| [`examples/node-fetch/azure-openai.ts`](./examples/node-fetch/azure-openai.ts)           | Azure OpenAI deployment URL + `api-key` |
-| [`examples/node-fetch/perplexity.ts`](./examples/node-fetch/perplexity.ts)               | Perplexity streaming                    |
-| [`examples/node-fetch/xai.ts`](./examples/node-fetch/xai.ts)                             | xAI Grok streaming                      |
-| [`examples/node-fetch/anthropic.ts`](./examples/node-fetch/anthropic.ts)                 | Anthropic Messages                      |
-| [`examples/node-fetch/gemini.ts`](./examples/node-fetch/gemini.ts)                       | Google Gemini SSE                       |
-| [`examples/node-fetch/replay-fixture.ts`](./examples/node-fetch/replay-fixture.ts)       | Local fixture replay                    |
-| [`examples/proxy-safety/`](./examples/proxy-safety/)                                     | Proxy + browser client patterns         |
+| Example                                                                                          | Description                                      |
+| ------------------------------------------------------------------------------------------------ | ------------------------------------------------ |
+| [`examples/node-fetch/openai-chat.ts`](./examples/node-fetch/openai-chat.ts)                     | OpenAI Chat Completions streaming                |
+| [`examples/node-fetch/openai-compatible.ts`](./examples/node-fetch/openai-compatible.ts)         | OpenAI-compatible presets                        |
+| [`examples/node-fetch/azure-openai.ts`](./examples/node-fetch/azure-openai.ts)                   | Azure OpenAI deployment URL + `api-key`          |
+| [`examples/workers-ai/rest-chat-completions.ts`](./examples/workers-ai/rest-chat-completions.ts) | Cloudflare Workers AI REST + `cloudflare` preset |
+| [`examples/node-fetch/perplexity.ts`](./examples/node-fetch/perplexity.ts)                       | Perplexity streaming                             |
+| [`examples/node-fetch/xai.ts`](./examples/node-fetch/xai.ts)                                     | xAI Grok streaming                               |
+| [`examples/node-fetch/anthropic.ts`](./examples/node-fetch/anthropic.ts)                         | Anthropic Messages                               |
+| [`examples/node-fetch/gemini.ts`](./examples/node-fetch/gemini.ts)                               | Google Gemini SSE                                |
+| [`examples/node-fetch/replay-fixture.ts`](./examples/node-fetch/replay-fixture.ts)               | Local fixture replay                             |
+| [`examples/proxy-safety/`](./examples/proxy-safety/)                                             | Proxy + browser client patterns                  |
 
 Proxy safety:
 
@@ -420,6 +657,7 @@ pnpm verify
 | `pnpm verify:deps`    | fail if runtime dependencies are added              |
 | `pnpm release:prep`   | pre-tag checks (version, CHANGELOG, dist, npm pack) |
 | `pnpm diagrams:build` | regenerate README SVGs from Mermaid sources         |
+| `pnpm bench:smoke`    | local LSA-C52 timing script (requires build first)  |
 | `pnpm test`           | Vitest smoke tests                                  |
 | `pnpm build`          | tsup → ESM + CJS + declarations                     |
 

package/dist/adapters/openai-compatible.cjs

@@ -484,7 +484,34 @@ function createOpenAIChatLikeAdapter(options) {
   });
 }
 
-// src/adapters/openai-compatible.ts
+// src/adapters/openai-compatible-presets.ts
+var OPENAI_COMPATIBLE_PROVIDERS = [
+  "generic",
+  "openrouter",
+  "groq",
+  "deepseek",
+  "mistral",
+  "ollama",
+  "lmstudio",
+  "together",
+  "fireworks",
+  "perplexity",
+  "xai",
+  "azure",
+  "cloudflare"
+];
+var HOST_COMPATIBLE_PRESETS = OPENAI_COMPATIBLE_PROVIDERS.filter(
+  (p) => p !== "generic"
+);
+var STRICT_COMPATIBLE_PRESETS = [
+  "azure"
+];
+function isStrictCompatiblePreset(provider) {
+  return STRICT_COMPATIBLE_PRESETS.includes(provider);
+}
+var LOOSE_HOST_PRESETS = HOST_COMPATIBLE_PRESETS.filter(
+  (p) => !isStrictCompatiblePreset(p)
+);
 var DEFAULT_PRESET = {
   looseErrorShape: true,
   allowMissingMetadata: true,
@@ -502,33 +529,66 @@ var PRESET_OVERRIDES = {
     reasoningFieldAliases: []
   }
 };
-function openaiCompatibleAdapter(options = {}) {
+var PRESET_OVERRIDE_KEYS = Object.keys(PRESET_OVERRIDES);
+function hasPresetOverride(provider) {
+  return provider in PRESET_OVERRIDES;
+}
+function providerPreset(provider) {
+  return {
+    ...DEFAULT_PRESET,
+    ...PRESET_OVERRIDES[provider]
+  };
+}
+
+// src/adapters/openai-compatible-resolve.ts
+function resolveCompatibleAdapterConfig(options = {}) {
   const preset = providerPreset(options.provider ?? "generic");
-  const resolvedAllowMissingMetadata = options.allowMissingMetadata ?? preset.allowMissingMetadata ?? DEFAULT_PRESET.allowMissingMetadata;
-  const resolvedLooseErrorShape = options.looseErrorShape ?? preset.looseErrorShape ?? DEFAULT_PRESET.looseErrorShape;
-  const resolvedUseChoicePositionFallback = options.useChoicePositionFallback ?? preset.useChoicePositionFallback ?? DEFAULT_PRESET.useChoicePositionFallback;
+  const allowMissingMetadata = options.allowMissingMetadata ?? preset.allowMissingMetadata ?? DEFAULT_PRESET.allowMissingMetadata;
+  const looseErrorShape = options.looseErrorShape ?? preset.looseErrorShape ?? DEFAULT_PRESET.looseErrorShape;
+  const useChoicePositionFallback = options.useChoicePositionFallback ?? preset.useChoicePositionFallback ?? DEFAULT_PRESET.useChoicePositionFallback;
+  return {
+    looseErrorShape,
+    allowMissingMetadata,
+    useChoicePositionFallback,
+    rejectUnrecognizedPayloads: allowMissingMetadata === false,
+    reasoningFieldAliases: [
+      ...preset.reasoningFieldAliases ?? [],
+      ...options.reasoningFieldAliases ?? []
+    ]
+  };
+}
+function compatibleProviderLabel(provider) {
+  return provider ?? "generic";
+}
+
+// src/adapters/openai-compatible.ts
+function openaiCompatibleAdapter(options = {}) {
+  const resolved = resolveCompatibleAdapterConfig(options);
   return createOpenAIChatLikeAdapter({
     ...options,
-    looseErrorShape: resolvedLooseErrorShape,
-    allowMissingMetadata: resolvedAllowMissingMetadata,
-    useChoicePositionFallback: resolvedUseChoicePositionFallback,
+    looseErrorShape: resolved.looseErrorShape,
+    allowMissingMetadata: resolved.allowMissingMetadata,
+    useChoicePositionFallback: resolved.useChoicePositionFallback,
     errorPrefix: "openaiCompatibleAdapter",
     usageInputTokenFields: ["prompt_tokens", "input_tokens"],
     usageOutputTokenFields: ["completion_tokens", "output_tokens"],
-    rejectUnrecognizedPayloads: resolvedAllowMissingMetadata === false,
-    reasoningFieldAliases: [
-      ...preset.reasoningFieldAliases ?? [],
-      ...options.reasoningFieldAliases ?? []
-    ]
+    rejectUnrecognizedPayloads: resolved.rejectUnrecognizedPayloads,
+    reasoningFieldAliases: resolved.reasoningFieldAliases
   });
 }
-function providerPreset(provider) {
-  return {
-    ...DEFAULT_PRESET,
-    ...PRESET_OVERRIDES[provider]
-  };
-}
 
+exports.DEFAULT_PRESET = DEFAULT_PRESET;
+exports.HOST_COMPATIBLE_PRESETS = HOST_COMPATIBLE_PRESETS;
+exports.LOOSE_HOST_PRESETS = LOOSE_HOST_PRESETS;
+exports.OPENAI_COMPATIBLE_PROVIDERS = OPENAI_COMPATIBLE_PROVIDERS;
+exports.PRESET_OVERRIDES = PRESET_OVERRIDES;
+exports.PRESET_OVERRIDE_KEYS = PRESET_OVERRIDE_KEYS;
+exports.STRICT_COMPATIBLE_PRESETS = STRICT_COMPATIBLE_PRESETS;
+exports.compatibleProviderLabel = compatibleProviderLabel;
+exports.hasPresetOverride = hasPresetOverride;
+exports.isStrictCompatiblePreset = isStrictCompatiblePreset;
 exports.openaiCompatibleAdapter = openaiCompatibleAdapter;
+exports.providerPreset = providerPreset;
+exports.resolveCompatibleAdapterConfig = resolveCompatibleAdapterConfig;
 //# sourceMappingURL=openai-compatible.cjs.map
 //# sourceMappingURL=openai-compatible.cjs.map