@opencode/ai 2.0.15 → 2.0.16

package/dist/protocols/openai-images.js

@@ -1,6 +1,7 @@
-import { Effect, Schema } from "effect";
-import { ImageModel, ImageResponse } from "../image.js";
+import { Effect, Schema, Stream } from "effect";
+import { ImageFinishEvent, ImageModel, ImageOutputEvent, ImagePartialEvent, } from "../image.js";
 import { Media } from "../media.js";
+import { Framing } from "../route/framing.js";
 import { MediaProtocol } from "../route/media-protocol.js";
 import { MediaRoute } from "../route/media.js";
 import { ProviderID, mergeJsonRecords } from "../schema/index.js";
@@ -15,6 +16,13 @@ export const EDIT_PATH = "/images/edits";
 // ---------------------------------------------------------------------------
 // 2. Response schema
 // ---------------------------------------------------------------------------
+const Usage = Schema.Struct({
+    input_tokens: Schema.optional(Schema.Number),
+    output_tokens: Schema.optional(Schema.Number),
+    total_tokens: Schema.optional(Schema.Number),
+    input_tokens_details: Schema.optional(Schema.Record(Schema.String, Schema.Unknown)),
+    output_tokens_details: Schema.optional(Schema.Record(Schema.String, Schema.Unknown)),
+});
 const OpenAIImageResponse = Schema.Struct({
     data: Schema.Array(Schema.Struct({
         b64_json: Schema.optional(Schema.String),
@@ -22,15 +30,28 @@ const OpenAIImageResponse = Schema.Struct({
         revised_prompt: Schema.optional(Schema.String),
     })),
     output_format: Schema.optional(Schema.String),
-    usage: Schema.optional(Schema.Struct({
-        input_tokens: Schema.optional(Schema.Number),
-        output_tokens: Schema.optional(Schema.Number),
-        total_tokens: Schema.optional(Schema.Number),
-        input_tokens_details: Schema.optional(Schema.Record(Schema.String, Schema.Unknown)),
-        output_tokens_details: Schema.optional(Schema.Record(Schema.String, Schema.Unknown)),
-    })),
+    usage: Schema.optional(Usage),
 });
 // ---------------------------------------------------------------------------
+// 3. Streaming event schema
+// ---------------------------------------------------------------------------
+const StreamEvent = Schema.Union([
+    Schema.Struct({
+        type: Schema.Literals(["image_generation.partial_image", "image_edit.partial_image"]),
+        b64_json: Schema.String,
+        partial_image_index: Schema.Number,
+        output_format: Schema.String,
+    }),
+    Schema.Struct({
+        type: Schema.Literals(["image_generation.completed", "image_edit.completed"]),
+        b64_json: Schema.String,
+        output_format: Schema.String,
+        usage: Schema.optional(Usage),
+    }),
+]);
+const decodeEvent = MediaProtocol.decodeFrame(ADAPTER, NAME, StreamEvent);
+const decodeDocument = Schema.decodeUnknownEffect(Schema.fromJsonString(OpenAIImageResponse));
+// ---------------------------------------------------------------------------
 // 5. Request body construction
 // ---------------------------------------------------------------------------
 /** Multipart field names the route owns; `http.body` overlays cannot smuggle replacements for them. */
@@ -38,34 +59,37 @@ const RESERVED_FORM_FIELDS = new Set(["model", "prompt", "image", "image[]", "im
 const nativeOptions = (options) => {
     if (!options)
         return undefined;
-    const { outputCompression, ...native } = options;
+    const { outputCompression, partialImages: _, ...native } = options;
     return { output_compression: outputCompression, ...native };
 };
-const isEdit = (request) => (request.images?.length ?? 0) > 0;
-const isInline = (asset) => asset.inline() !== undefined;
-const blob = (data, mediaType) => {
-    const buffer = new ArrayBuffer(data.byteLength);
-    new Uint8Array(buffer).set(data);
-    return new Blob([buffer], { type: mediaType });
-};
-const reference = (asset) => {
-    const inline = asset.inline();
-    if (inline)
-        return Effect.succeed({ image_url: inline.dataUrl });
-    const url = ProviderShared.mediaUrl(asset);
-    if (url)
-        return Effect.succeed({ image_url: url });
-    const id = MediaInput.refID(asset, PROVIDER);
-    if (id)
-        return Effect.succeed({ file_id: id });
-    return Effect.fail(ProviderShared.invalidRequest("OpenAI Images accepts image URLs, data URLs, bytes, and OpenAI file IDs"));
+const streamOptions = (request) => {
+    if (request.mode !== "stream")
+        return Effect.succeed(undefined);
+    if (request.model.id.startsWith("dall-e"))
+        return Effect.fail(ProviderShared.unsupportedOperation({
+            operation: "media.stream",
+            provider: PROVIDER,
+            route: ADAPTER,
+            message: `${request.model.id} does not stream; use Image.generate or a GPT image model`,
+        }));
+    if (request.n !== undefined && request.n > 1)
+        return Effect.fail(ProviderShared.unsupportedOperation({
+            operation: "media.n",
+            provider: PROVIDER,
+            route: ADAPTER,
+            message: `${NAME} streams one image; use Image.generate for n=${request.n}`,
+        }));
+    return Effect.succeed({ stream: true, partial_images: request.providerOptions?.partialImages ?? 2 });
 };
+const isEdit = (request) => (request.images?.length ?? 0) > 0;
+const isInline = (asset) => asset.source.type === "bytes" || asset.source.type === "base64";
+const reference = (asset) => ProviderShared.mediaReference(asset, PROVIDER, NAME).pipe(Effect.map((item) => (item.type === "ref" ? { file_id: item.value } : { image_url: item.value })));
 const fromRequest = Effect.fn("OpenAIImages.fromRequest")(function* (request) {
     const images = request.images ?? [];
     const mask = request.mask;
     if (mask !== undefined && images.length === 0)
         return yield* ProviderShared.invalidRequest("An OpenAI image mask requires at least one input image");
-    const fields = mergeJsonRecords({ n: request.n, size: request.size, output_format: request.format }, nativeOptions(request.providerOptions), request.http?.body);
+    const fields = mergeJsonRecords({ n: request.n, size: request.size, output_format: request.format, ...(yield* streamOptions(request)) }, nativeOptions(request.providerOptions), request.http?.body);
     // Owned bytes go through multipart edits; remote URLs and file IDs use the JSON edits body instead.
     if (images.length > 0 && images.every(isInline) && (mask === undefined || isInline(mask))) {
         const form = new FormData();
@@ -77,9 +101,9 @@ const fromRequest = Effect.fn("OpenAIImages.fromRequest")(function* (request) {
             form.append(key, typeof value === "string" ? value : ProviderShared.encodeJson(value));
         });
         const uploads = yield* Effect.forEach(images, (image) => MediaInput.inlineBytes(ADAPTER, image));
-        uploads.forEach((data, index) => form.append("image[]", blob(data, images[index].mediaType), `image-${index}`));
+        uploads.forEach((data, index) => form.append("image[]", MediaInput.blob(data, images[index].mediaType), `image-${index}`));
         if (mask !== undefined)
-            form.append("mask", blob(yield* MediaInput.inlineBytes(ADAPTER, mask), mask.mediaType), "mask");
+            form.append("mask", MediaInput.blob(yield* MediaInput.inlineBytes(ADAPTER, mask), mask.mediaType), "mask");
         return MediaProtocol.multipart(form);
     }
     const references = yield* Effect.forEach(images, reference);
@@ -92,53 +116,82 @@ const fromRequest = Effect.fn("OpenAIImages.fromRequest")(function* (request) {
     }, fields) ?? {});
 });
 // ---------------------------------------------------------------------------
-// 6. Response decoding
+// 6. Stream parsing
 // ---------------------------------------------------------------------------
 const requestedFormat = (body) => {
+    if (body.type === "binary")
+        return undefined;
     const value = body.type === "json" ? body.value.output_format : body.value.get("output_format");
     return typeof value === "string" ? value : undefined;
 };
-const decodeResponse = Effect.fn("OpenAIImages.decodeResponse")(function* (response, context) {
-    const output = yield* MediaProtocol.decodeJson(ADAPTER, NAME, OpenAIImageResponse)(response);
-    const decoded = output.value;
-    const format = decoded.output_format ?? requestedFormat(context.body) ?? "png";
+const usage = (value) => value === undefined
+    ? undefined
+    : {
+        type: "tokens",
+        input: value.input_tokens,
+        output: value.output_tokens,
+        total: value.total_tokens,
+        details: { openai: value },
+    };
+const eventImage = (frame, label, data, format) => MediaInput.decodedAsset((message, cause) => MediaProtocol.frameError(ADAPTER, message, frame, cause), label, data, `image/${format}`, { info: { format } });
+const onEvent = Effect.fn("OpenAIImages.onEvent")(function* (state, frame) {
+    const event = yield* decodeEvent(frame);
+    const format = event.output_format;
+    if ("partial_image_index" in event) {
+        const image = yield* eventImage(frame, `${NAME} partial image`, event.b64_json, format);
+        return [state, [ImagePartialEvent.make({ index: event.partial_image_index, image })]];
+    }
+    const image = yield* eventImage(frame, `${NAME} result ${state.completed}`, event.b64_json, format);
+    return [
+        { ...state, completed: state.completed + 1, format, usage: usage(event.usage) },
+        [ImageOutputEvent.make({ index: state.completed, image })],
+    ];
+});
+const onDocument = Effect.fn("OpenAIImages.onDocument")(function* (frame) {
+    const invalid = (message, cause) => MediaProtocol.frameError(ADAPTER, message, frame.document, cause);
+    const decoded = yield* decodeDocument(frame.document).pipe(Effect.mapError((cause) => invalid(`${NAME} returned an invalid response`, cause)));
+    const format = decoded.output_format ?? frame.requested ?? "png";
     const mediaType = `image/${format}`;
     const images = yield* Effect.forEach(decoded.data, (item, index) => {
         const providerMetadata = item.revised_prompt === undefined ? undefined : { openai: { revisedPrompt: item.revised_prompt } };
         if (item.b64_json)
-            return MediaInput.decodedAsset(output.invalid, `${NAME} result ${index}`, item.b64_json, mediaType, {
+            return MediaInput.decodedAsset(invalid, `${NAME} result ${index}`, item.b64_json, mediaType, {
                 info: { format },
                 providerMetadata,
             });
         if (item.url)
             return Effect.succeed(Media.url(item.url, { mediaType, info: { format }, providerMetadata }));
-        return Effect.fail(output.invalid(`${NAME} result ${index} has neither image data nor a URL`));
+        return Effect.fail(invalid(`${NAME} result ${index} has neither image data nor a URL`));
     });
     if (images.length === 0)
-        return yield* output.invalid(`${NAME} returned no images`);
-    return new ImageResponse({
-        images,
-        usage: decoded.usage === undefined
-            ? undefined
-            : {
-                type: "tokens",
-                input: decoded.usage.input_tokens,
-                output: decoded.usage.output_tokens,
-                total: decoded.usage.total_tokens,
-                details: { openai: decoded.usage },
-            },
-        providerMetadata: { openai: { outputFormat: format } },
-    });
+        return yield* invalid(`${NAME} returned no images`);
+    const state = { completed: images.length, format, usage: usage(decoded.usage) };
+    return [state, images.map((image, index) => ImageOutputEvent.make({ index, image }))];
 });
+const step = (state, frame) => (typeof frame === "string" ? onEvent(state, frame) : onDocument(frame));
+const finish = (state) => {
+    if (state.completed === 0)
+        return Effect.fail(MediaProtocol.incomplete(ADAPTER));
+    return Effect.succeed([
+        ImageFinishEvent.make({ usage: state.usage, providerMetadata: { openai: { outputFormat: state.format } } }),
+    ]);
+};
 // ---------------------------------------------------------------------------
 // 7. Protocol and route
 // ---------------------------------------------------------------------------
-export const protocol = MediaProtocol.inline({
+export const protocol = MediaProtocol.stream({
     id: ADAPTER,
     name: NAME,
     unsupported: ["aspectRatio", "seed"],
     body: { from: fromRequest },
-    response: { decode: decodeResponse },
+    frames: (bytes, context) => context.request.mode === "stream"
+        ? Framing.sse.frame(bytes)
+        : Framing.document
+            .frame(bytes)
+            .pipe(Stream.map((document) => ({ document, requested: requestedFormat(context.body) }))),
+    initial: () => ({ completed: 0 }),
+    step,
+    finish,
 });
 export const model = (input) => ImageModel.fromRoute({
     id: ADAPTER,

package/dist/protocols/openai-responses.d.ts

@@ -291,8 +291,8 @@ export declare const protocol: Protocol<{
         } | {
             readonly type: "input_file";
             readonly filename: string;
-            readonly detail?: string | undefined;
             readonly file_data?: string | undefined;
+            readonly detail?: string | undefined;
             readonly file_url?: string | undefined;
         } | {
             readonly type: "input_text";
@@ -328,8 +328,8 @@ export declare const protocol: Protocol<{
         } | {
             readonly type: "input_file";
             readonly filename: string;
-            readonly detail?: string | undefined;
             readonly file_data?: string | undefined;
+            readonly detail?: string | undefined;
             readonly file_url?: string | undefined;
         } | {
             readonly type: "input_text";
@@ -390,11 +390,11 @@ export declare const protocol: Protocol<{
         readonly size?: string | undefined;
         readonly action?: "generate" | "auto" | "edit" | undefined;
         readonly output_format?: "png" | "jpeg" | "webp" | undefined;
+        readonly partial_images?: number | undefined;
         readonly quality?: "auto" | "low" | "medium" | "high" | undefined;
         readonly background?: "auto" | "opaque" | "transparent" | undefined;
         readonly output_compression?: number | undefined;
         readonly input_fidelity?: "low" | "high" | undefined;
-        readonly partial_images?: number | undefined;
     } | {
         readonly type: "namespace";
         readonly name: string;
@@ -574,8 +574,8 @@ export declare const httpTransport: HttpTransport.HttpJsonTransport<{
         } | {
             readonly type: "input_file";
             readonly filename: string;
-            readonly detail?: string | undefined;
             readonly file_data?: string | undefined;
+            readonly detail?: string | undefined;
             readonly file_url?: string | undefined;
         } | {
             readonly type: "input_text";
@@ -611,8 +611,8 @@ export declare const httpTransport: HttpTransport.HttpJsonTransport<{
         } | {
             readonly type: "input_file";
             readonly filename: string;
-            readonly detail?: string | undefined;
             readonly file_data?: string | undefined;
+            readonly detail?: string | undefined;
             readonly file_url?: string | undefined;
         } | {
             readonly type: "input_text";
@@ -673,11 +673,11 @@ export declare const httpTransport: HttpTransport.HttpJsonTransport<{
         readonly size?: string | undefined;
         readonly action?: "generate" | "auto" | "edit" | undefined;
         readonly output_format?: "png" | "jpeg" | "webp" | undefined;
+        readonly partial_images?: number | undefined;
         readonly quality?: "auto" | "low" | "medium" | "high" | undefined;
         readonly background?: "auto" | "opaque" | "transparent" | undefined;
         readonly output_compression?: number | undefined;
         readonly input_fidelity?: "low" | "high" | undefined;
-        readonly partial_images?: number | undefined;
     } | {
         readonly type: "namespace";
         readonly name: string;
@@ -802,8 +802,8 @@ export declare const channelTransport: (options: import("./open-responses-channe
         } | {
             readonly type: "input_file";
             readonly filename: string;
-            readonly detail?: string | undefined;
             readonly file_data?: string | undefined;
+            readonly detail?: string | undefined;
             readonly file_url?: string | undefined;
         } | {
             readonly type: "input_text";
@@ -839,8 +839,8 @@ export declare const channelTransport: (options: import("./open-responses-channe
         } | {
             readonly type: "input_file";
             readonly filename: string;
-            readonly detail?: string | undefined;
             readonly file_data?: string | undefined;
+            readonly detail?: string | undefined;
             readonly file_url?: string | undefined;
         } | {
             readonly type: "input_text";
@@ -901,11 +901,11 @@ export declare const channelTransport: (options: import("./open-responses-channe
         readonly size?: string | undefined;
         readonly action?: "generate" | "auto" | "edit" | undefined;
         readonly output_format?: "png" | "jpeg" | "webp" | undefined;
+        readonly partial_images?: number | undefined;
         readonly quality?: "auto" | "low" | "medium" | "high" | undefined;
         readonly background?: "auto" | "opaque" | "transparent" | undefined;
         readonly output_compression?: number | undefined;
         readonly input_fidelity?: "low" | "high" | undefined;
-        readonly partial_images?: number | undefined;
     } | {
         readonly type: "namespace";
         readonly name: string;
@@ -1030,8 +1030,8 @@ export declare const transport: import("../route/transport/index.js").Transport<
         } | {
             readonly type: "input_file";
             readonly filename: string;
-            readonly detail?: string | undefined;
             readonly file_data?: string | undefined;
+            readonly detail?: string | undefined;
             readonly file_url?: string | undefined;
         } | {
             readonly type: "input_text";
@@ -1067,8 +1067,8 @@ export declare const transport: import("../route/transport/index.js").Transport<
         } | {
             readonly type: "input_file";
             readonly filename: string;
-            readonly detail?: string | undefined;
             readonly file_data?: string | undefined;
+            readonly detail?: string | undefined;
             readonly file_url?: string | undefined;
         } | {
             readonly type: "input_text";
@@ -1129,11 +1129,11 @@ export declare const transport: import("../route/transport/index.js").Transport<
         readonly size?: string | undefined;
         readonly action?: "generate" | "auto" | "edit" | undefined;
         readonly output_format?: "png" | "jpeg" | "webp" | undefined;
+        readonly partial_images?: number | undefined;
         readonly quality?: "auto" | "low" | "medium" | "high" | undefined;
         readonly background?: "auto" | "opaque" | "transparent" | undefined;
         readonly output_compression?: number | undefined;
         readonly input_fidelity?: "low" | "high" | undefined;
-        readonly partial_images?: number | undefined;
     } | {
         readonly type: "namespace";
         readonly name: string;
@@ -1258,8 +1258,8 @@ export declare const route: Route<{
         } | {
             readonly type: "input_file";
             readonly filename: string;
-            readonly detail?: string | undefined;
             readonly file_data?: string | undefined;
+            readonly detail?: string | undefined;
             readonly file_url?: string | undefined;
         } | {
             readonly type: "input_text";
@@ -1295,8 +1295,8 @@ export declare const route: Route<{
         } | {
             readonly type: "input_file";
             readonly filename: string;
-            readonly detail?: string | undefined;
             readonly file_data?: string | undefined;
+            readonly detail?: string | undefined;
             readonly file_url?: string | undefined;
         } | {
             readonly type: "input_text";
@@ -1357,11 +1357,11 @@ export declare const route: Route<{
         readonly size?: string | undefined;
         readonly action?: "generate" | "auto" | "edit" | undefined;
         readonly output_format?: "png" | "jpeg" | "webp" | undefined;
+        readonly partial_images?: number | undefined;
         readonly quality?: "auto" | "low" | "medium" | "high" | undefined;
         readonly background?: "auto" | "opaque" | "transparent" | undefined;
         readonly output_compression?: number | undefined;
         readonly input_fidelity?: "low" | "high" | undefined;
-        readonly partial_images?: number | undefined;
     } | {
         readonly type: "namespace";
         readonly name: string;

package/dist/protocols/openai-responses.js

@@ -5,7 +5,7 @@ import { Auth } from "../route/auth.js";
 import { Endpoint } from "../route/endpoint.js";
 import { Protocol } from "../route/protocol.js";
 import { HttpTransport } from "../route/transport/index.js";
-import { LLMRequest, mergeJsonRecords } from "../schema/index.js";
+import { LLMRequest, mergeJsonRecords, } from "../schema/index.js";
 import { resolveEffortUpdates } from "../effort-updates.js";
 import { OpenResponses } from "./open-responses.js";
 import { OpenResponsesOptions } from "./utils/open-responses-options.js";
@@ -137,16 +137,16 @@ const lowerTool = Effect.fn("OpenAIResponses.lowerTool")(function* (tool, inputS
 });
 // Native namespaces hold only function tools, so deeper levels flatten into
 // the leaf names the same way non-native protocols flatten the whole tree.
-const lowerToolEntry = Effect.fn("OpenAIResponses.lowerToolEntry")(function* (tool, compatibility) {
+const lowerToolEntry = Effect.fn("OpenAIResponses.lowerToolEntry")(function* (tool, model) {
     if (tool.type === "tool")
-        return yield* lowerTool(tool, ToolSchemaProjection.modelCompatibility(tool.inputSchema, compatibility));
+        return yield* lowerTool(tool, ToolSchemaProjection.modelCompatibility(tool.inputSchema, model));
     // OpenAI requires a namespace description; fall back to a generic one so a
     // missing description never blocks the request.
     return {
         type: "namespace",
         name: tool.name,
         description: tool.description ?? `Tools in the ${tool.name} namespace.`,
-        tools: yield* Effect.forEach(ProviderShared.flattenTools(tool.tools), (leaf) => OpenResponses.lowerTool(NAME, leaf, ToolSchemaProjection.modelCompatibility(leaf.inputSchema, compatibility))),
+        tools: yield* Effect.forEach(ProviderShared.flattenTools(tool.tools), (leaf) => OpenResponses.lowerTool(NAME, leaf, ToolSchemaProjection.modelCompatibility(leaf.inputSchema, model))),
     };
 });
 const lowerToolChoice = (toolChoice, tools) => ProviderShared.matchToolChoice(NAME, toolChoice, {
@@ -162,14 +162,13 @@ const fromRequest = Effect.fn("OpenAIResponses.fromRequest")(function* (request)
     const management = yield* ProviderShared.validateWith(Schema.decodeUnknownEffect(Schema.UndefinedOr(ContextManagement)))(request.providerOptions?.contextManagement);
     const options = OpenResponsesOptions.resolve(request);
     const updates = resolveEffortUpdates(request, options.reasoningEffort);
-    const toolSchemaCompatibility = request.model.compatibility?.toolSchema;
     return yield* decodeBody({
         ...(yield* OpenResponses.lowerConversation(updates.request, adapter)),
         ...OpenResponses.lowerGeneration(request, { ...options, reasoningEffort: updates.effort }),
         context_management: management?.map((edit) => ({ type: edit.type, compact_threshold: edit.compactThreshold })),
         tools: request.tools.length === 0
             ? undefined
-            : yield* Effect.forEach(request.tools, (tool) => lowerToolEntry(tool, toolSchemaCompatibility)),
+            : yield* Effect.forEach(request.tools, (tool) => lowerToolEntry(tool, request.model)),
         tool_choice: request.tools.length === 0
             ? undefined
             : (OpenResponses.allowedToolChoice(request) ??

package/dist/protocols/openai-speech.d.ts

@@ -0,0 +1,116 @@
+import { MediaProtocol } from "../route/media-protocol.js";
+import { MediaRoute } from "../route/media.js";
+import { type MediaUsage } from "../schema/index.js";
+import { SpeechModel, type SpeechRequestFor } from "../speech.js";
+import { SpeechStream } from "./utils/speech-stream.js";
+export declare const DEFAULT_BASE_URL = "https://api.openai.com/v1";
+export declare const PATH = "/audio/speech";
+export type OpenAISpeechOptions = Record<string, unknown>;
+export type Request = SpeechRequestFor<OpenAISpeechOptions>;
+interface State extends SpeechStream.Audio {
+    readonly done: boolean;
+    readonly usage?: MediaUsage;
+}
+export declare const protocol: MediaProtocol.Streamed<Request, {
+    readonly type: "audio-delta";
+    readonly chunk: Uint8Array<ArrayBufferLike>;
+} | {
+    readonly type: "timestamps";
+    readonly items: readonly {
+        readonly text: string;
+        readonly startSeconds: number;
+        readonly endSeconds: number;
+    }[];
+} | {
+    readonly type: "finish";
+    readonly audio: import("../media.js").Asset;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly usage?: {
+        readonly type: "tokens";
+        readonly input?: number | undefined;
+        readonly output?: number | undefined;
+        readonly total?: number | undefined;
+        readonly details?: {
+            readonly [x: string]: unknown;
+        } | undefined;
+    } | {
+        readonly type: "seconds";
+        readonly seconds: number;
+    } | {
+        readonly type: "characters";
+        readonly characters: number;
+    } | {
+        readonly type: "credits";
+        readonly credits: number;
+    } | {
+        readonly type: "compute";
+        readonly seconds: number;
+    } | undefined;
+    readonly notices?: readonly {
+        readonly type: "other" | "moderated" | "filtered";
+        readonly message: string;
+        readonly providerMetadata?: {
+            readonly [x: string]: {
+                readonly [x: string]: unknown;
+            };
+        } | undefined;
+    }[] | undefined;
+}, string | Uint8Array<ArrayBufferLike>, State>;
+export declare const model: (input: MediaRoute.ModelInput) => SpeechModel<OpenAISpeechOptions>;
+export declare const OpenAISpeech: {
+    readonly protocol: MediaProtocol.Streamed<Request, {
+        readonly type: "audio-delta";
+        readonly chunk: Uint8Array<ArrayBufferLike>;
+    } | {
+        readonly type: "timestamps";
+        readonly items: readonly {
+            readonly text: string;
+            readonly startSeconds: number;
+            readonly endSeconds: number;
+        }[];
+    } | {
+        readonly type: "finish";
+        readonly audio: import("../media.js").Asset;
+        readonly providerMetadata?: {
+            readonly [x: string]: {
+                readonly [x: string]: unknown;
+            };
+        } | undefined;
+        readonly usage?: {
+            readonly type: "tokens";
+            readonly input?: number | undefined;
+            readonly output?: number | undefined;
+            readonly total?: number | undefined;
+            readonly details?: {
+                readonly [x: string]: unknown;
+            } | undefined;
+        } | {
+            readonly type: "seconds";
+            readonly seconds: number;
+        } | {
+            readonly type: "characters";
+            readonly characters: number;
+        } | {
+            readonly type: "credits";
+            readonly credits: number;
+        } | {
+            readonly type: "compute";
+            readonly seconds: number;
+        } | undefined;
+        readonly notices?: readonly {
+            readonly type: "other" | "moderated" | "filtered";
+            readonly message: string;
+            readonly providerMetadata?: {
+                readonly [x: string]: {
+                    readonly [x: string]: unknown;
+                };
+            } | undefined;
+        }[] | undefined;
+    }, string | Uint8Array<ArrayBufferLike>, State>;
+    readonly model: (input: MediaRoute.ModelInput) => SpeechModel<OpenAISpeechOptions>;
+};
+export {};

package/dist/protocols/openai-speech.js

@@ -0,0 +1,98 @@
+import { Effect, Schema } from "effect";
+import { Framing } from "../route/framing.js";
+import { MediaProtocol } from "../route/media-protocol.js";
+import { MediaRoute } from "../route/media.js";
+import { ProviderID, mergeJsonRecords } from "../schema/index.js";
+import { SpeechModel } from "../speech.js";
+import { SpeechStream } from "./utils/speech-stream.js";
+const ADAPTER = "openai-speech";
+const NAME = "OpenAI Speech";
+const PROVIDER = ProviderID.make("openai");
+export const DEFAULT_BASE_URL = "https://api.openai.com/v1";
+export const PATH = "/audio/speech";
+/** `pcm` is raw 24 kHz, 16-bit signed little-endian mono samples without a header. */
+const PCM_SAMPLE_RATE = 24000;
+// ---------------------------------------------------------------------------
+// 3. Streaming event schema
+// ---------------------------------------------------------------------------
+const SpeechStreamEvent = Schema.Union([
+    Schema.Struct({ type: Schema.Literal("speech.audio.delta"), audio: Schema.Uint8ArrayFromBase64 }),
+    Schema.Struct({
+        type: Schema.Literal("speech.audio.done"),
+        usage: Schema.optional(Schema.Struct({
+            input_tokens: Schema.optional(Schema.Number),
+            output_tokens: Schema.optional(Schema.Number),
+            total_tokens: Schema.optional(Schema.Number),
+        })),
+    }),
+]);
+const decodeEvent = MediaProtocol.decodeFrame(ADAPTER, NAME, SpeechStreamEvent);
+// ---------------------------------------------------------------------------
+// 5. Request body construction
+// ---------------------------------------------------------------------------
+// `sse` is not supported for `tts-1` or `tts-1-hd`; those models stream the raw audio body instead.
+const supportsSse = (model) => !/^tts-1(-hd)?(-|$)/.test(model);
+const fromRequest = Effect.fn("OpenAISpeech.fromRequest")(function* (request) {
+    return MediaProtocol.json(mergeJsonRecords({
+        model: request.model.id,
+        input: request.text,
+        voice: request.voice,
+        instructions: request.instructions,
+        response_format: request.format,
+        speed: request.speed,
+        stream_format: request.mode === "stream" && supportsSse(request.model.id) ? "sse" : undefined,
+    }, request.providerOptions, request.http?.body) ?? {});
+});
+// ---------------------------------------------------------------------------
+// 6. Stream parsing
+// ---------------------------------------------------------------------------
+const isSse = (body) => body.type === "json" && body.value.stream_format === "sse";
+const onEvent = Effect.fn("OpenAISpeech.onEvent")(function* (state, frame) {
+    const event = yield* decodeEvent(frame);
+    if (event.type === "speech.audio.delta")
+        return SpeechStream.delta(state, event.audio);
+    const usage = event.usage;
+    return [
+        {
+            ...state,
+            done: true,
+            usage: usage === undefined
+                ? undefined
+                : {
+                    type: "tokens",
+                    input: usage.input_tokens,
+                    output: usage.output_tokens,
+                    total: usage.total_tokens,
+                    details: { openai: usage },
+                },
+        },
+        [],
+    ];
+});
+const finish = (state, context) => {
+    if (isSse(context.body) && !state.done)
+        return Effect.fail(MediaProtocol.incomplete(ADAPTER));
+    const format = context.request.format ?? "mp3";
+    return SpeechStream.finish(ADAPTER, state, {
+        ...(format === "pcm" ? SpeechStream.pcm("pcm_s16le", PCM_SAMPLE_RATE) : SpeechStream.container(format)),
+        usage: state.usage,
+    });
+};
+// ---------------------------------------------------------------------------
+// 7. Protocol and route
+// ---------------------------------------------------------------------------
+export const protocol = MediaProtocol.stream({
+    id: ADAPTER,
+    name: NAME,
+    unsupported: ["language", "timestamps"],
+    body: { from: fromRequest },
+    frames: (bytes, context) => (isSse(context.body) ? Framing.sse.frame(bytes) : bytes),
+    initial: () => ({ chunks: [], done: false }),
+    step: SpeechStream.step(onEvent),
+    finish,
+});
+export const model = (input) => SpeechModel.fromRoute({ id: ADAPTER, provider: PROVIDER, protocol, baseURL: DEFAULT_BASE_URL, path: PATH }, input);
+export const OpenAISpeech = {
+    protocol,
+    model,
+};