@zhivex-ai/openai 0.8.1 → 0.9.0

package/README.md

@@ -67,6 +67,69 @@ Multi-turn Responses normally continue through `previous_response_id`. With `pro
 
 Use `providerOptions.safety_identifier` for a stable, non-PII identifier for the end user. It is sent as an OpenAI request field; do not put email addresses, names, or other direct personal data in it.
 
+## GPT Image 2 and hosted image generation
+
+Use the shared image contract for direct Image API generations. `gpt-image-2` supports the current square, portrait, landscape, and wide output sizes exposed by OpenAI. See the official [GPT Image 2 model page](https://developers.openai.com/api/docs/models/gpt-image-2) and [image generation guide](https://developers.openai.com/api/docs/guides/image-generation).
+
+```ts
+import { generateImage } from "@zhivex-ai/core";
+import { createOpenAI } from "@zhivex-ai/openai";
+
+const openai = createOpenAI({ apiKey: process.env.OPENAI_API_KEY });
+
+const result = await generateImage({
+  model: openai.imageGenerationModel!("gpt-image-2"),
+  prompt: "A clean editorial illustration of a distributed system",
+  aspectRatio: "16:9",
+  outputMimeType: "image/webp",
+  providerOptions: {
+    quality: "high"
+  }
+});
+
+console.log(result.images[0]?.mediaType);
+```
+
+For conversational generation, edits, reference images, or progressive previews, use the provider-hosted Responses tool. Buffered and collected text calls expose final media on `result.steps.at(-1)?.response.images`; streaming calls emit typed `image-generation` events:
+
+```ts
+import { streamText } from "@zhivex-ai/core";
+import {
+  openAIImageGenerationTool,
+  openAIImageGenerationToolChoice
+} from "@zhivex-ai/openai";
+
+const stream = await streamText({
+  model: openai("gpt-5.6"),
+  prompt: "Generate a wide product concept, then refine its lighting.",
+  tools: {
+    image: openAIImageGenerationTool({
+      action: "auto",
+      output_format: "webp",
+      partial_images: 2,
+      size: "1536x864"
+    })
+  },
+  providerOptions: {
+    tool_choice: openAIImageGenerationToolChoice()
+  }
+});
+
+for await (const event of stream) {
+  if (event.type === "image-generation") {
+    console.log(event.partial, event.image.mediaType, event.image.data?.byteLength);
+  }
+}
+```
+
+Partial images are transient live stream events: they are not copied into collected messages or replayed to consumers that subscribe after generation. The shared `ImageGenerationModel` path is buffered; use the Responses tool when you need partial-image streaming or image edits.
+
+## Realtime 2.1 and remote MCP
+
+`gpt-realtime-2.1` and `gpt-realtime-2.1-mini` use the GA Realtime tool shape and support image input. A stable `providerOptions.safety_identifier` is sent as the `OpenAI-Safety-Identifier` header for both server WebSocket sessions and browser client-secret creation.
+
+Remote MCP lifecycle, calls, failures, and approval requests arrive as `realtime-provider-data` events so provider-executed MCP is not confused with an app-executed function tool. Return an approval with `openAIRealtimeMcpApprovalResult()` through `session.sendToolResult()`. See OpenAI's [Realtime MCP guide](https://developers.openai.com/api/docs/guides/realtime-mcp).
+
 ## Prompt caching
 
 OpenAI prompt cache controls pass through `providerOptions`. Explicit breakpoints can be attached directly to a cacheable text, image, or file part through `providerMetadata`, or inserted immediately after a cacheable part with `openAIPromptCacheBreakpoint()`.

package/dist/image-generation.d.ts

@@ -0,0 +1,109 @@
+import { type GeneratedMedia, type ImageGenerationModel, type ImageGenerationModelInput, type ImageGenerationResult, type JsonValue, type ModelCapabilities } from "@zhivex-ai/core";
+export type OpenAIImageOutputFormat = "png" | "jpeg" | "webp";
+export type OpenAIImageSize = "auto" | `${number}x${number}`;
+export type OpenAIImageQuality = "auto" | "low" | "medium" | "high" | "standard" | "hd";
+export type OpenAIImageGenerationOptions = Record<string, unknown> & {
+    background?: "auto" | "opaque" | "transparent";
+    moderation?: "auto" | "low";
+    output_compression?: number;
+    output_format?: OpenAIImageOutputFormat;
+    quality?: OpenAIImageQuality;
+    response_format?: "url" | "b64_json";
+    style?: "vivid" | "natural";
+    user?: string;
+    /** Extra HTTP headers. Authorization and content-type remain SDK-controlled. */
+    headers?: Record<string, string>;
+    /** Maximum JSON response size, including base64 image data. Defaults to 128 MiB. */
+    responseMaxBytes?: number;
+    /** Maximum error response body retained for diagnostics. Defaults to 64 KiB. */
+    errorBodyMaxBytes?: number;
+    /** Streaming belongs to the Responses/Image streaming APIs, not ImageGenerationModel. */
+    stream?: false;
+    partial_images?: never;
+};
+export interface OpenAIImageGenerationToolConfig {
+    action?: "auto" | "generate" | "edit";
+    background?: "auto" | "opaque" | "transparent";
+    input_fidelity?: "low" | "high";
+    output_compression?: number;
+    output_format?: OpenAIImageOutputFormat;
+    partial_images?: 0 | 1 | 2 | 3;
+    quality?: "auto" | "low" | "medium" | "high";
+    size?: OpenAIImageSize;
+}
+export interface OpenAIImageGenerationToolChoice {
+    type: "image_generation";
+}
+export interface OpenAIImageGenerationModelConfig {
+    modelId: string;
+    apiKey: string;
+    baseURL?: string;
+    fetch?: typeof globalThis.fetch;
+    responseMaxBytes?: number;
+    errorBodyMaxBytes?: number;
+}
+export interface OpenAIImageGenerationCall {
+    type: "image_generation_call";
+    id?: string;
+    status?: string;
+    revised_prompt?: string | null;
+    result?: string | null;
+    output_format?: OpenAIImageOutputFormat;
+    [key: string]: unknown;
+}
+export interface NormalizedOpenAIImageGenerationCall {
+    id?: string;
+    status?: string;
+    revisedPrompt?: string;
+    image?: GeneratedMedia;
+    providerMetadata: Record<string, unknown>;
+}
+export type OpenAIImageGenerationPartialImageEvent = {
+    type: "response.image_generation_call.partial_image";
+    partial_image_b64: string;
+    partial_image_index: number;
+    item_id?: string;
+    output_index?: number;
+    sequence_number?: number;
+    output_format?: OpenAIImageOutputFormat;
+    [key: string]: unknown;
+} | {
+    type: "image_generation.partial_image";
+    b64_json: string;
+    partial_image_index: number;
+    output_format?: OpenAIImageOutputFormat;
+    [key: string]: unknown;
+};
+export interface NormalizedOpenAIImageGenerationPartialImage {
+    source: "responses" | "images";
+    callId?: string;
+    partialImageIndex: number;
+    outputIndex?: number;
+    sequenceNumber?: number;
+    image: GeneratedMedia;
+    providerMetadata: Record<string, unknown>;
+}
+/** Creates the hosted Responses API image_generation tool definition. */
+export declare const openAIImageGenerationTool: (config?: OpenAIImageGenerationToolConfig) => import("@zhivex-ai/core").HostedToolDefinition<JsonValue>;
+/** Forces the hosted Responses image_generation tool for the current turn. */
+export declare const openAIImageGenerationToolChoice: () => OpenAIImageGenerationToolChoice;
+export declare const isOpenAIImageGenerationCall: (value: unknown) => value is OpenAIImageGenerationCall;
+/** Decodes a Responses image_generation_call without retaining a second base64 copy in metadata. */
+export declare const normalizeOpenAIImageGenerationCall: (value: unknown, fallbackOutputFormat?: OpenAIImageOutputFormat, maxImageBytes?: number) => NormalizedOpenAIImageGenerationCall | undefined;
+export declare const isOpenAIImageGenerationPartialImageEvent: (value: unknown) => value is OpenAIImageGenerationPartialImageEvent;
+/** Normalizes partial images from both Responses and the streaming Image API. */
+export declare const normalizeOpenAIImageGenerationPartialImage: (value: unknown, fallbackOutputFormat?: OpenAIImageOutputFormat, maxImageBytes?: number) => NormalizedOpenAIImageGenerationPartialImage | undefined;
+export declare class OpenAIImageGenerationModel implements ImageGenerationModel<OpenAIImageGenerationOptions> {
+    readonly provider = "openai";
+    readonly capabilities: ModelCapabilities;
+    readonly modelId: string;
+    private readonly apiKey;
+    private readonly baseURL;
+    private readonly fetcher;
+    private readonly responseMaxBytes;
+    private readonly errorBodyMaxBytes;
+    constructor(config: OpenAIImageGenerationModelConfig);
+    generateImage(input: ImageGenerationModelInput<OpenAIImageGenerationOptions>): Promise<ImageGenerationResult>;
+}
+export declare const createOpenAIImageGenerationModel: (config: OpenAIImageGenerationModelConfig) => OpenAIImageGenerationModel;
+//# sourceMappingURL=image-generation.d.ts.map

package/dist/image-generation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-generation.d.ts","sourceRoot":"","sources":["../src/image-generation.ts"],"names":[],"mappings":"AAEA,OAAO,EAWL,KAAK,cAAc,EACnB,KAAK,oBAAoB,EACzB,KAAK,yBAAyB,EAC9B,KAAK,qBAAqB,EAC1B,KAAK,SAAS,EACd,KAAK,iBAAiB,EACvB,MAAM,iBAAiB,CAAC;AAMzB,MAAM,MAAM,uBAAuB,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAC9D,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAC7D,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,GAAG,IAAI,CAAC;AAExF,MAAM,MAAM,4BAA4B,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG;IACnE,UAAU,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,aAAa,CAAC;IAC/C,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACxC,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,eAAe,CAAC,EAAE,KAAK,GAAG,UAAU,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gFAAgF;IAChF,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,oFAAoF;IACpF,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gFAAgF;IAChF,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,yFAAyF;IACzF,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,cAAc,CAAC,EAAE,KAAK,CAAC;CACxB,CAAC;AAEF,MAAM,WAAW,+BAA+B;IAC9C,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,MAAM,CAAC;IACtC,UAAU,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,aAAa,CAAC;IAC/C,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAChC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACxC,cAAc,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IAC7C,IAAI,CAAC,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,+BAA+B;IAC9C,IAAI,EAAE,kBAAkB,CAAC;CAC1B;AAED,MAAM,WAAW,gCAAgC;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,uBAAuB,CAAC;IAC9B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACxC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,mCAAmC;IAClD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,cAAc,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC3C;AAED,MAAM,MAAM,sCAAsC,GAC9C;IACE,IAAI,EAAE,8CAA8C,CAAC;IACrD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACxC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,GACD;IACE,IAAI,EAAE,gCAAgC,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,uBAAuB,CAAC;IACxC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAEN,MAAM,WAAW,2CAA2C;IAC1D,MAAM,EAAE,WAAW,GAAG,QAAQ,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,cAAc,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC3C;AAyHD,yEAAyE;AACzE,eAAO,MAAM,yBAAyB,GAAI,SAAQ,+BAAoC,8DASrF,CAAC;AAEF,8EAA8E;AAC9E,eAAO,MAAM,+BAA+B,QAAO,+BAEjD,CAAC;AAEH,eAAO,MAAM,2BAA2B,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,yBAC8C,CAAC;AAErH,oGAAoG;AACpG,eAAO,MAAM,kCAAkC,GAC7C,OAAO,OAAO,EACd,uBAAsB,uBAA+B,EACrD,gBAAgB,MAAM,KACrB,mCAAmC,GAAG,SA0BxC,CAAC;AAEF,eAAO,MAAM,wCAAwC,GACnD,OAAO,OAAO,KACb,KAAK,IAAI,sCAOX,CAAC;AAEF,iFAAiF;AACjF,eAAO,MAAM,0CAA0C,GACrD,OAAO,OAAO,EACd,uBAAsB,uBAA+B,EACrD,gBAAgB,MAAM,KACrB,2CAA2C,GAAG,SAwBhD,CAAC;AAEF,qBAAa,0BAA2B,YAAW,oBAAoB,CAAC,4BAA4B,CAAC;IACnG,QAAQ,CAAC,QAAQ,YAAY;IAC7B,QAAQ,CAAC,YAAY,oBAA+B;IAEpD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAClD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;gBAE/B,MAAM,EAAE,gCAAgC;IAe9C,aAAa,CACjB,KAAK,EAAE,yBAAyB,CAAC,4BAA4B,CAAC,GAC7D,OAAO,CAAC,qBAAqB,CAAC;CAqLlC;AAED,eAAO,MAAM,gCAAgC,GAAI,QAAQ,gCAAgC,+BACjD,CAAC"}

package/dist/image-generation.js

@@ -0,0 +1,343 @@
+import { Buffer } from "node:buffer";
+import { ParseError, ProviderHTTPError, UnsupportedFeatureError, ValidationError, decodeBase64WithLimit, hostedTool, readErrorBodyWithLimit, readJsonWithLimit, withRetry, withTimeoutSignal } from "@zhivex-ai/core";
+const MIB = 1024 * 1024;
+const DEFAULT_RESPONSE_MAX_BYTES = 128 * MIB;
+const DEFAULT_ERROR_BODY_MAX_BYTES = 64 * 1024;
+const imageGenerationCapabilities = {
+    streaming: false,
+    tools: false,
+    structuredOutput: false,
+    jsonMode: false,
+    toolChoice: false,
+    parallelToolCalls: false,
+    vision: false,
+    files: false,
+    audioInput: false,
+    audioOutput: false,
+    embeddings: false,
+    imageGeneration: true,
+    reasoning: false,
+    webSearch: false
+};
+const normalizePositiveLimit = (value, name) => {
+    if (!Number.isSafeInteger(value) || value <= 0) {
+        throw new ValidationError(`The OpenAI image generation "${name}" option must be a positive safe integer.`);
+    }
+    return value;
+};
+const validateIntegerRange = (value, name, minimum, maximum) => {
+    if (value === undefined) {
+        return;
+    }
+    if (!Number.isSafeInteger(value) || value < minimum || value > maximum) {
+        throw new ValidationError(`The OpenAI image generation "${name}" option must be an integer from ${minimum} to ${maximum}.`);
+    }
+};
+const outputFormatFromMimeType = (mediaType) => {
+    if (mediaType === undefined)
+        return undefined;
+    const normalized = mediaType.trim().toLowerCase();
+    if (normalized === "image/png")
+        return "png";
+    if (normalized === "image/jpeg" || normalized === "image/jpg")
+        return "jpeg";
+    if (normalized === "image/webp")
+        return "webp";
+    throw new UnsupportedFeatureError(`Provider "openai" does not support image output MIME type "${mediaType}".`);
+};
+const mediaTypeFromOutputFormat = (format) => format === "jpeg" ? "image/jpeg" : format === "webp" ? "image/webp" : "image/png";
+const normalizedModelId = (modelId) => modelId.trim().toLowerCase();
+const isGPTImageModel = (modelId) => /^gpt-image(?:-|$)/.test(normalizedModelId(modelId));
+const isGPTImage2Model = (modelId) => /^gpt-image-2(?:-|$)/.test(normalizedModelId(modelId));
+const isDallE2Model = (modelId) => /^dall-e-2(?:-|$)/.test(normalizedModelId(modelId));
+const isDallE3Model = (modelId) => /^dall-e-3(?:-|$)/.test(normalizedModelId(modelId));
+const promptLimitForModel = (modelId) => {
+    if (isDallE2Model(modelId))
+        return 1_000;
+    if (isDallE3Model(modelId))
+        return 4_000;
+    if (isGPTImageModel(modelId))
+        return 32_000;
+    return undefined;
+};
+const sizeFromAspectRatio = (aspectRatio, modelId) => {
+    if (!aspectRatio)
+        return undefined;
+    const normalized = aspectRatio.replaceAll(" ", "");
+    if (isDallE2Model(modelId)) {
+        if (normalized === "1:1")
+            return "1024x1024";
+        throw new UnsupportedFeatureError(`Provider "openai" model "dall-e-2" cannot map aspect ratio "${aspectRatio}" because it only supports square output.`);
+    }
+    if (isDallE3Model(modelId)) {
+        if (normalized === "1:1")
+            return "1024x1024";
+        if (normalized === "16:9")
+            return "1792x1024";
+        if (normalized === "9:16")
+            return "1024x1792";
+        throw new UnsupportedFeatureError(`Provider "openai" cannot map aspect ratio "${aspectRatio}" to a supported size for model "dall-e-3". Pass an explicit "size" instead.`);
+    }
+    const standard = {
+        "1:1": "1024x1024",
+        "3:2": "1536x1024",
+        "2:3": "1024x1536"
+    };
+    if (standard[normalized])
+        return standard[normalized];
+    if (isGPTImage2Model(modelId)) {
+        if (normalized === "16:9")
+            return "1536x864";
+        if (normalized === "9:16")
+            return "864x1536";
+    }
+    throw new UnsupportedFeatureError(`Provider "openai" cannot map aspect ratio "${aspectRatio}" to a supported size for model "${modelId}". Pass an explicit "size" instead.`);
+};
+const sanitizeMetadata = (value, base64Keys) => {
+    const sanitized = { ...value };
+    for (const key of base64Keys)
+        delete sanitized[key];
+    return sanitized;
+};
+const validateToolConfig = (config) => {
+    validateIntegerRange(config.partial_images, "partial_images", 0, 3);
+    validateIntegerRange(config.output_compression, "output_compression", 0, 100);
+    if (config.background === "transparent" && config.output_format === "jpeg") {
+        throw new ValidationError('OpenAI image generation requires "png" or "webp" output for a transparent background.');
+    }
+};
+/** Creates the hosted Responses API image_generation tool definition. */
+export const openAIImageGenerationTool = (config = {}) => {
+    validateToolConfig(config);
+    return hostedTool({
+        name: "image_generation",
+        provider: "openai",
+        type: "image_generation",
+        toolClass: "custom",
+        config: config
+    });
+};
+/** Forces the hosted Responses image_generation tool for the current turn. */
+export const openAIImageGenerationToolChoice = () => ({
+    type: "image_generation"
+});
+export const isOpenAIImageGenerationCall = (value) => Boolean(value && typeof value === "object" && value.type === "image_generation_call");
+/** Decodes a Responses image_generation_call without retaining a second base64 copy in metadata. */
+export const normalizeOpenAIImageGenerationCall = (value, fallbackOutputFormat = "png", maxImageBytes) => {
+    if (!isOpenAIImageGenerationCall(value))
+        return undefined;
+    const revisedPrompt = typeof value.revised_prompt === "string" ? value.revised_prompt : undefined;
+    const outputFormat = value.output_format ?? fallbackOutputFormat;
+    const providerMetadata = sanitizeMetadata(value, ["result"]);
+    const result = typeof value.result === "string" && value.result ? value.result : undefined;
+    return {
+        id: typeof value.id === "string" ? value.id : undefined,
+        status: typeof value.status === "string" ? value.status : undefined,
+        revisedPrompt,
+        image: result
+            ? {
+                data: maxImageBytes === undefined
+                    ? Uint8Array.from(Buffer.from(result, "base64"))
+                    : decodeBase64WithLimit(result, {
+                        maxBytes: maxImageBytes,
+                        provider: "openai",
+                        endpoint: "hosted image generation event"
+                    }),
+                mediaType: mediaTypeFromOutputFormat(outputFormat),
+                text: revisedPrompt,
+                providerMetadata
+            }
+            : undefined,
+        providerMetadata
+    };
+};
+export const isOpenAIImageGenerationPartialImageEvent = (value) => {
+    if (!value || typeof value !== "object")
+        return false;
+    const event = value;
+    return ((event.type === "response.image_generation_call.partial_image" && typeof event.partial_image_b64 === "string") ||
+        (event.type === "image_generation.partial_image" && typeof event.b64_json === "string")) && Number.isSafeInteger(event.partial_image_index);
+};
+/** Normalizes partial images from both Responses and the streaming Image API. */
+export const normalizeOpenAIImageGenerationPartialImage = (value, fallbackOutputFormat = "png", maxImageBytes) => {
+    if (!isOpenAIImageGenerationPartialImageEvent(value))
+        return undefined;
+    const isResponses = value.type === "response.image_generation_call.partial_image";
+    const base64 = isResponses ? value.partial_image_b64 : value.b64_json;
+    const providerMetadata = sanitizeMetadata(value, ["partial_image_b64", "b64_json"]);
+    return {
+        source: isResponses ? "responses" : "images",
+        callId: isResponses && typeof value.item_id === "string" ? value.item_id : undefined,
+        partialImageIndex: value.partial_image_index,
+        outputIndex: isResponses && typeof value.output_index === "number" ? value.output_index : undefined,
+        sequenceNumber: isResponses && typeof value.sequence_number === "number" ? value.sequence_number : undefined,
+        image: {
+            data: maxImageBytes === undefined
+                ? Uint8Array.from(Buffer.from(base64, "base64"))
+                : decodeBase64WithLimit(base64, {
+                    maxBytes: maxImageBytes,
+                    provider: "openai",
+                    endpoint: "hosted image generation event"
+                }),
+            mediaType: mediaTypeFromOutputFormat(value.output_format ?? fallbackOutputFormat),
+            providerMetadata
+        },
+        providerMetadata
+    };
+};
+export class OpenAIImageGenerationModel {
+    provider = "openai";
+    capabilities = imageGenerationCapabilities;
+    modelId;
+    apiKey;
+    baseURL;
+    fetcher;
+    responseMaxBytes;
+    errorBodyMaxBytes;
+    constructor(config) {
+        this.modelId = config.modelId;
+        this.apiKey = config.apiKey;
+        this.baseURL = (config.baseURL ?? "https://api.openai.com/v1").replace(/\/$/, "");
+        this.fetcher = config.fetch ?? globalThis.fetch;
+        this.responseMaxBytes = normalizePositiveLimit(config.responseMaxBytes ?? DEFAULT_RESPONSE_MAX_BYTES, "responseMaxBytes");
+        this.errorBodyMaxBytes = normalizePositiveLimit(config.errorBodyMaxBytes ?? DEFAULT_ERROR_BODY_MAX_BYTES, "errorBodyMaxBytes");
+    }
+    async generateImage(input) {
+        if (!input.prompt.trim()) {
+            throw new ValidationError('The OpenAI image generation "prompt" field is required.');
+        }
+        const promptLimit = promptLimitForModel(this.modelId);
+        if (promptLimit !== undefined && input.prompt.length > promptLimit) {
+            throw new ValidationError(`The OpenAI image generation prompt exceeds the ${promptLimit}-character limit for model "${this.modelId}".`);
+        }
+        if (input.images?.length) {
+            throw new UnsupportedFeatureError('Provider "openai" image generations do not accept input images. Use the Responses image_generation tool for conversational edits.');
+        }
+        if (input.negativePrompt) {
+            throw new UnsupportedFeatureError('Provider "openai" image generations do not support a separate negative prompt.');
+        }
+        validateIntegerRange(input.count, "count", 1, 10);
+        if (isDallE3Model(this.modelId) && input.count !== undefined && input.count !== 1) {
+            throw new UnsupportedFeatureError('Provider "openai" model "dall-e-3" only supports one image per request.');
+        }
+        const providerOptions = { ...(input.providerOptions ?? {}) };
+        if (providerOptions.stream !== undefined && providerOptions.stream !== false) {
+            throw new UnsupportedFeatureError('OpenAI Image API streaming is not supported through ImageGenerationModel. Use the Responses streaming API for partial images.');
+        }
+        if (providerOptions.partial_images !== undefined) {
+            throw new UnsupportedFeatureError('The OpenAI "partial_images" option requires streaming and is not supported through ImageGenerationModel.');
+        }
+        const customHeaders = providerOptions.headers;
+        if (customHeaders !== undefined && (!customHeaders || typeof customHeaders !== "object" || Array.isArray(customHeaders))) {
+            throw new ValidationError('The OpenAI image generation "headers" option must be an object.');
+        }
+        const safeCustomHeaders = Object.fromEntries(Object.entries((customHeaders ?? {})).filter(([key]) => !["authorization", "content-type"].includes(key.toLowerCase())));
+        delete providerOptions.headers;
+        delete providerOptions.stream;
+        delete providerOptions.partial_images;
+        const responseMaxBytes = normalizePositiveLimit(typeof providerOptions.responseMaxBytes === "number" ? providerOptions.responseMaxBytes : this.responseMaxBytes, "responseMaxBytes");
+        const errorBodyMaxBytes = normalizePositiveLimit(typeof providerOptions.errorBodyMaxBytes === "number" ? providerOptions.errorBodyMaxBytes : this.errorBodyMaxBytes, "errorBodyMaxBytes");
+        delete providerOptions.responseMaxBytes;
+        delete providerOptions.errorBodyMaxBytes;
+        validateIntegerRange(typeof providerOptions.output_compression === "number" ? providerOptions.output_compression : undefined, "output_compression", 0, 100);
+        const mimeOutputFormat = outputFormatFromMimeType(input.outputMimeType);
+        let outputFormat = mimeOutputFormat ??
+            providerOptions.output_format;
+        if (outputFormat !== undefined && !["png", "jpeg", "webp"].includes(outputFormat)) {
+            throw new ValidationError(`The OpenAI image generation "output_format" option "${String(outputFormat)}" is invalid.`);
+        }
+        if (isDallE2Model(this.modelId) || isDallE3Model(this.modelId)) {
+            if (mimeOutputFormat !== undefined && mimeOutputFormat !== "png") {
+                throw new UnsupportedFeatureError(`Provider "openai" model "${this.modelId}" only supports PNG image output.`);
+            }
+            if (providerOptions.output_format !== undefined) {
+                throw new UnsupportedFeatureError(`Provider "openai" model "${this.modelId}" does not support the "output_format" option.`);
+            }
+            outputFormat = undefined;
+        }
+        if (isGPTImageModel(this.modelId) && providerOptions.response_format !== undefined) {
+            throw new UnsupportedFeatureError(`Provider "openai" model "${this.modelId}" always returns base64 images and does not support "response_format".`);
+        }
+        const background = providerOptions.background;
+        if (background === "transparent" && outputFormat === "jpeg") {
+            throw new ValidationError('OpenAI image generation requires "png" or "webp" output for a transparent background.');
+        }
+        if (isGPTImage2Model(this.modelId) && background === "transparent") {
+            throw new UnsupportedFeatureError('Provider "openai" model "gpt-image-2" does not support transparent backgrounds.');
+        }
+        if (providerOptions.output_compression !== undefined && outputFormat !== "jpeg" && outputFormat !== "webp") {
+            throw new ValidationError('OpenAI image generation only supports "output_compression" with "jpeg" or "webp" output.');
+        }
+        const size = input.size ?? sizeFromAspectRatio(input.aspectRatio, this.modelId);
+        const { signal, cleanup, abort } = withTimeoutSignal(input);
+        try {
+            const json = await withRetry(async () => {
+                const response = await this.fetcher(`${this.baseURL}/images/generations`, {
+                    method: "POST",
+                    headers: {
+                        ...safeCustomHeaders,
+                        "content-type": "application/json",
+                        authorization: `Bearer ${this.apiKey}`
+                    },
+                    signal,
+                    body: JSON.stringify({
+                        ...providerOptions,
+                        model: this.modelId,
+                        prompt: input.prompt,
+                        n: input.count,
+                        size,
+                        output_format: outputFormat
+                    })
+                });
+                if (!response.ok) {
+                    const responseBody = await readErrorBodyWithLimit(response, errorBodyMaxBytes);
+                    throw new ProviderHTTPError(`OpenAI image generation failed with status ${response.status}.`, response.status, {
+                        responseBody
+                    });
+                }
+                return readJsonWithLimit(response, {
+                    maxBytes: responseMaxBytes,
+                    provider: "openai",
+                    endpoint: "images/generations",
+                    abort
+                });
+            }, input);
+            if (!Array.isArray(json.data)) {
+                throw new ParseError("OpenAI image generation response did not contain an image data array.");
+            }
+            const mediaType = mediaTypeFromOutputFormat(outputFormat);
+            const images = json.data.map((item, index) => {
+                if (!item || typeof item !== "object") {
+                    throw new ParseError(`OpenAI image generation response item ${index} was invalid.`);
+                }
+                const providerMetadata = sanitizeMetadata(item, ["b64_json"]);
+                const hasData = typeof item.b64_json === "string" && item.b64_json.length > 0;
+                const hasUri = typeof item.url === "string" && item.url.length > 0;
+                if (!hasData && !hasUri) {
+                    throw new ParseError(`OpenAI image generation response item ${index} contained neither image data nor a URL.`);
+                }
+                return {
+                    data: hasData ? Uint8Array.from(Buffer.from(item.b64_json, "base64")) : undefined,
+                    uri: hasUri ? item.url : undefined,
+                    mediaType,
+                    text: typeof item.revised_prompt === "string" ? item.revised_prompt : undefined,
+                    providerMetadata
+                };
+            });
+            const revisedPrompts = images.flatMap((image) => image.text ? [image.text] : []);
+            return {
+                images,
+                text: revisedPrompts.length ? revisedPrompts.join("\n") : undefined,
+                rawResponse: {
+                    ...json,
+                    data: json.data.map((item) => sanitizeMetadata(item, ["b64_json"]))
+                }
+            };
+        }
+        finally {
+            cleanup();
+        }
+    }
+}
+export const createOpenAIImageGenerationModel = (config) => new OpenAIImageGenerationModel(config);
+//# sourceMappingURL=image-generation.js.map

package/dist/image-generation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-generation.js","sourceRoot":"","sources":["../src/image-generation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,uBAAuB,EACvB,eAAe,EACf,qBAAqB,EACrB,UAAU,EACV,sBAAsB,EACtB,iBAAiB,EACjB,SAAS,EACT,iBAAiB,EAOlB,MAAM,iBAAiB,CAAC;AAEzB,MAAM,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;AACxB,MAAM,0BAA0B,GAAG,GAAG,GAAG,GAAG,CAAC;AAC7C,MAAM,4BAA4B,GAAG,EAAE,GAAG,IAAI,CAAC;AA6G/C,MAAM,2BAA2B,GAAsB;IACrD,SAAS,EAAE,KAAK;IAChB,KAAK,EAAE,KAAK;IACZ,gBAAgB,EAAE,KAAK;IACvB,QAAQ,EAAE,KAAK;IACf,UAAU,EAAE,KAAK;IACjB,iBAAiB,EAAE,KAAK;IACxB,MAAM,EAAE,KAAK;IACb,KAAK,EAAE,KAAK;IACZ,UAAU,EAAE,KAAK;IACjB,WAAW,EAAE,KAAK;IAClB,UAAU,EAAE,KAAK;IACjB,eAAe,EAAE,IAAI;IACrB,SAAS,EAAE,KAAK;IAChB,SAAS,EAAE,KAAK;CACjB,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,KAAa,EAAE,IAAY,EAAE,EAAE;IAC7D,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QAC/C,MAAM,IAAI,eAAe,CAAC,gCAAgC,IAAI,2CAA2C,CAAC,CAAC;IAC7G,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,KAAyB,EAAE,IAAY,EAAE,OAAe,EAAE,OAAe,EAAE,EAAE;IACzG,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO;IACT,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,OAAO,IAAI,KAAK,GAAG,OAAO,EAAE,CAAC;QACvE,MAAM,IAAI,eAAe,CAAC,gCAAgC,IAAI,oCAAoC,OAAO,OAAO,OAAO,GAAG,CAAC,CAAC;IAC9H,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,SAA6B,EAAuC,EAAE;IACtG,IAAI,SAAS,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC9C,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAClD,IAAI,UAAU,KAAK,WAAW;QAAE,OAAO,KAAK,CAAC;IAC7C,IAAI,UAAU,KAAK,YAAY,IAAI,UAAU,KAAK,WAAW;QAAE,OAAO,MAAM,CAAC;IAC7E,IAAI,UAAU,KAAK,YAAY;QAAE,OAAO,MAAM,CAAC;IAC/C,MAAM,IAAI,uBAAuB,CAAC,8DAA8D,SAAS,IAAI,CAAC,CAAC;AACjH,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,CAAC,MAA2C,EAAE,EAAE,CAChF,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC;AAEpF,MAAM,iBAAiB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;AAC5E,MAAM,eAAe,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;AAClG,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;AACrG,MAAM,aAAa,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;AAC/F,MAAM,aAAa,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;AAE/F,MAAM,mBAAmB,GAAG,CAAC,OAAe,EAAE,EAAE;IAC9C,IAAI,aAAa,CAAC,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IACzC,IAAI,aAAa,CAAC,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IACzC,IAAI,eAAe,CAAC,OAAO,CAAC;QAAE,OAAO,MAAM,CAAC;IAC5C,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,WAA+B,EAAE,OAAe,EAA+B,EAAE;IAC5G,IAAI,CAAC,WAAW;QAAE,OAAO,SAAS,CAAC;IACnC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACnD,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,IAAI,UAAU,KAAK,KAAK;YAAE,OAAO,WAAW,CAAC;QAC7C,MAAM,IAAI,uBAAuB,CAC/B,+DAA+D,WAAW,2CAA2C,CACtH,CAAC;IACJ,CAAC;IACD,IAAI,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;QAC3B,IAAI,UAAU,KAAK,KAAK;YAAE,OAAO,WAAW,CAAC;QAC7C,IAAI,UAAU,KAAK,MAAM;YAAE,OAAO,WAAW,CAAC;QAC9C,IAAI,UAAU,KAAK,MAAM;YAAE,OAAO,WAAW,CAAC;QAC9C,MAAM,IAAI,uBAAuB,CAC/B,8CAA8C,WAAW,8EAA8E,CACxI,CAAC;IACJ,CAAC;IAED,MAAM,QAAQ,GAAoC;QAChD,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,WAAW;QAClB,KAAK,EAAE,WAAW;KACnB,CAAC;IACF,IAAI,QAAQ,CAAC,UAAU,CAAC;QAAE,OAAO,QAAQ,CAAC,UAAU,CAAC,CAAC;IAEtD,IAAI,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;QAC9B,IAAI,UAAU,KAAK,MAAM;YAAE,OAAO,UAAU,CAAC;QAC7C,IAAI,UAAU,KAAK,MAAM;YAAE,OAAO,UAAU,CAAC;IAC/C,CAAC;IAED,MAAM,IAAI,uBAAuB,CAC/B,8CAA8C,WAAW,oCAAoC,OAAO,qCAAqC,CAC1I,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,KAA8B,EAAE,UAAoB,EAAE,EAAE;IAChF,MAAM,SAAS,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC;IAC/B,KAAK,MAAM,GAAG,IAAI,UAAU;QAAE,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC;IACpD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,MAAuC,EAAE,EAAE;IACrE,oBAAoB,CAAC,MAAM,CAAC,cAAc,EAAE,gBAAgB,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACpE,oBAAoB,CAAC,MAAM,CAAC,kBAAkB,EAAE,oBAAoB,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;IAC9E,IAAI,MAAM,CAAC,UAAU,KAAK,aAAa,IAAI,MAAM,CAAC,aAAa,KAAK,MAAM,EAAE,CAAC;QAC3E,MAAM,IAAI,eAAe,CAAC,uFAAuF,CAAC,CAAC;IACrH,CAAC;AACH,CAAC,CAAC;AAEF,yEAAyE;AACzE,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,SAA0C,EAAE,EAAE,EAAE;IACxF,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC3B,OAAO,UAAU,CAAC;QAChB,IAAI,EAAE,kBAAkB;QACxB,QAAQ,EAAE,QAAQ;QAClB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,QAAQ;QACnB,MAAM,EAAE,MAA8B;KACvC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,8EAA8E;AAC9E,MAAM,CAAC,MAAM,+BAA+B,GAAG,GAAoC,EAAE,CAAC,CAAC;IACrF,IAAI,EAAE,kBAAkB;CACzB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,KAAc,EAAsC,EAAE,CAChG,OAAO,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAK,KAAiC,CAAC,IAAI,KAAK,uBAAuB,CAAC,CAAC;AAErH,oGAAoG;AACpG,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAChD,KAAc,EACd,uBAAgD,KAAK,EACrD,aAAsB,EAC2B,EAAE;IACnD,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC1D,MAAM,aAAa,GAAG,OAAO,KAAK,CAAC,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;IAClG,MAAM,YAAY,GAAG,KAAK,CAAC,aAAa,IAAI,oBAAoB,CAAC;IACjE,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7D,MAAM,MAAM,GAAG,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3F,OAAO;QACL,EAAE,EAAE,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS;QACvD,MAAM,EAAE,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;QACnE,aAAa;QACb,KAAK,EAAE,MAAM;YACX,CAAC,CAAC;gBACE,IAAI,EAAE,aAAa,KAAK,SAAS;oBAC/B,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;oBAChD,CAAC,CAAC,qBAAqB,CAAC,MAAM,EAAE;wBAC5B,QAAQ,EAAE,aAAa;wBACvB,QAAQ,EAAE,QAAQ;wBAClB,QAAQ,EAAE,+BAA+B;qBAC1C,CAAC;gBACN,SAAS,EAAE,yBAAyB,CAAC,YAAY,CAAC;gBAClD,IAAI,EAAE,aAAa;gBACnB,gBAAgB;aACjB;YACH,CAAC,CAAC,SAAS;QACb,gBAAgB;KACjB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wCAAwC,GAAG,CACtD,KAAc,EACmC,EAAE;IACnD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IACtD,MAAM,KAAK,GAAG,KAAgC,CAAC;IAC/C,OAAO,CACL,CAAC,KAAK,CAAC,IAAI,KAAK,8CAA8C,IAAI,OAAO,KAAK,CAAC,iBAAiB,KAAK,QAAQ,CAAC;QAC9G,CAAC,KAAK,CAAC,IAAI,KAAK,gCAAgC,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CACxF,IAAI,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;AACvD,CAAC,CAAC;AAEF,iFAAiF;AACjF,MAAM,CAAC,MAAM,0CAA0C,GAAG,CACxD,KAAc,EACd,uBAAgD,KAAK,EACrD,aAAsB,EACmC,EAAE;IAC3D,IAAI,CAAC,wCAAwC,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACvE,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,KAAK,8CAA8C,CAAC;IAClF,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;IACtE,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,KAAK,EAAE,CAAC,mBAAmB,EAAE,UAAU,CAAC,CAAC,CAAC;IACpF,OAAO;QACL,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ;QAC5C,MAAM,EAAE,WAAW,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;QACpF,iBAAiB,EAAE,KAAK,CAAC,mBAAmB;QAC5C,WAAW,EAAE,WAAW,IAAI,OAAO,KAAK,CAAC,YAAY,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;QACnG,cAAc,EAAE,WAAW,IAAI,OAAO,KAAK,CAAC,eAAe,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS;QAC5G,KAAK,EAAE;YACL,IAAI,EAAE,aAAa,KAAK,SAAS;gBAC/B,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;gBAChD,CAAC,CAAC,qBAAqB,CAAC,MAAM,EAAE;oBAC5B,QAAQ,EAAE,aAAa;oBACvB,QAAQ,EAAE,QAAQ;oBAClB,QAAQ,EAAE,+BAA+B;iBAC1C,CAAC;YACN,SAAS,EAAE,yBAAyB,CAAC,KAAK,CAAC,aAAa,IAAI,oBAAoB,CAAC;YACjF,gBAAgB;SACjB;QACD,gBAAgB;KACjB,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,OAAO,0BAA0B;IAC5B,QAAQ,GAAG,QAAQ,CAAC;IACpB,YAAY,GAAG,2BAA2B,CAAC;IAE3C,OAAO,CAAS;IACR,MAAM,CAAS;IACf,OAAO,CAAS;IAChB,OAAO,CAA0B;IACjC,gBAAgB,CAAS;IACzB,iBAAiB,CAAS;IAE3C,YAAY,MAAwC;QAClD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,2BAA2B,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAClF,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC;QAChD,IAAI,CAAC,gBAAgB,GAAG,sBAAsB,CAC5C,MAAM,CAAC,gBAAgB,IAAI,0BAA0B,EACrD,kBAAkB,CACnB,CAAC;QACF,IAAI,CAAC,iBAAiB,GAAG,sBAAsB,CAC7C,MAAM,CAAC,iBAAiB,IAAI,4BAA4B,EACxD,mBAAmB,CACpB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,KAA8D;QAE9D,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;YACzB,MAAM,IAAI,eAAe,CAAC,yDAAyD,CAAC,CAAC;QACvF,CAAC;QAED,MAAM,WAAW,GAAG,mBAAmB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtD,IAAI,WAAW,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,WAAW,EAAE,CAAC;YACnE,MAAM,IAAI,eAAe,CACvB,kDAAkD,WAAW,+BAA+B,IAAI,CAAC,OAAO,IAAI,CAC7G,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;YACzB,MAAM,IAAI,uBAAuB,CAC/B,mIAAmI,CACpI,CAAC;QACJ,CAAC;QACD,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;YACzB,MAAM,IAAI,uBAAuB,CAAC,gFAAgF,CAAC,CAAC;QACtH,CAAC;QAED,oBAAoB,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAClD,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;YAClF,MAAM,IAAI,uBAAuB,CAAC,yEAAyE,CAAC,CAAC;QAC/G,CAAC;QAED,MAAM,eAAe,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,EAAE,CAAC,EAAE,CAAC;QAC7D,IAAI,eAAe,CAAC,MAAM,KAAK,SAAS,IAAI,eAAe,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YAC7E,MAAM,IAAI,uBAAuB,CAC/B,+HAA+H,CAChI,CAAC;QACJ,CAAC;QACD,IAAI,eAAe,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACjD,MAAM,IAAI,uBAAuB,CAC/B,0GAA0G,CAC3G,CAAC;QACJ,CAAC;QAED,MAAM,aAAa,GAAG,eAAe,CAAC,OAAO,CAAC;QAC9C,IAAI,aAAa,KAAK,SAAS,IAAI,CAAC,CAAC,aAAa,IAAI,OAAO,aAAa,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC;YACzH,MAAM,IAAI,eAAe,CAAC,iEAAiE,CAAC,CAAC;QAC/F,CAAC;QACD,MAAM,iBAAiB,GAAG,MAAM,CAAC,WAAW,CAC1C,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,IAAI,EAAE,CAA2B,CAAC,CAAC,MAAM,CACpE,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,EAAE,cAAc,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAC1E,CACF,CAAC;QACF,OAAO,eAAe,CAAC,OAAO,CAAC;QAC/B,OAAO,eAAe,CAAC,MAAM,CAAC;QAC9B,OAAO,eAAe,CAAC,cAAc,CAAC;QAEtC,MAAM,gBAAgB,GAAG,sBAAsB,CAC7C,OAAO,eAAe,CAAC,gBAAgB,KAAK,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,EAC/G,kBAAkB,CACnB,CAAC;QACF,MAAM,iBAAiB,GAAG,sBAAsB,CAC9C,OAAO,eAAe,CAAC,iBAAiB,KAAK,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,EAClH,mBAAmB,CACpB,CAAC;QACF,OAAO,eAAe,CAAC,gBAAgB,CAAC;QACxC,OAAO,eAAe,CAAC,iBAAiB,CAAC;QAEzC,oBAAoB,CAClB,OAAO,eAAe,CAAC,kBAAkB,KAAK,QAAQ,CAAC,CAAC,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,EACvG,oBAAoB,EACpB,CAAC,EACD,GAAG,CACJ,CAAC;QAEF,MAAM,gBAAgB,GAAG,wBAAwB,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACxE,IAAI,YAAY,GAAG,gBAAgB;YAChC,eAAe,CAAC,aAAqD,CAAC;QACzE,IAAI,YAAY,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YAClF,MAAM,IAAI,eAAe,CAAC,uDAAuD,MAAM,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QACxH,CAAC;QAED,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/D,IAAI,gBAAgB,KAAK,SAAS,IAAI,gBAAgB,KAAK,KAAK,EAAE,CAAC;gBACjE,MAAM,IAAI,uBAAuB,CAAC,4BAA4B,IAAI,CAAC,OAAO,mCAAmC,CAAC,CAAC;YACjH,CAAC;YACD,IAAI,eAAe,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;gBAChD,MAAM,IAAI,uBAAuB,CAC/B,4BAA4B,IAAI,CAAC,OAAO,gDAAgD,CACzF,CAAC;YACJ,CAAC;YACD,YAAY,GAAG,SAAS,CAAC;QAC3B,CAAC;QACD,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,eAAe,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACnF,MAAM,IAAI,uBAAuB,CAC/B,4BAA4B,IAAI,CAAC,OAAO,wEAAwE,CACjH,CAAC;QACJ,CAAC;QAED,MAAM,UAAU,GAAG,eAAe,CAAC,UAAU,CAAC;QAC9C,IAAI,UAAU,KAAK,aAAa,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;YAC5D,MAAM,IAAI,eAAe,CAAC,uFAAuF,CAAC,CAAC;QACrH,CAAC;QACD,IAAI,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,UAAU,KAAK,aAAa,EAAE,CAAC;YACnE,MAAM,IAAI,uBAAuB,CAAC,iFAAiF,CAAC,CAAC;QACvH,CAAC;QACD,IAAI,eAAe,CAAC,kBAAkB,KAAK,SAAS,IAAI,YAAY,KAAK,MAAM,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;YAC3G,MAAM,IAAI,eAAe,CACvB,0FAA0F,CAC3F,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,mBAAmB,CAAC,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAChF,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAE5D,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,KAAK,IAAI,EAAE;gBACtC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,qBAAqB,EAAE;oBACxE,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACP,GAAG,iBAAiB;wBACpB,cAAc,EAAE,kBAAkB;wBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;qBACvC;oBACD,MAAM;oBACN,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;wBACnB,GAAG,eAAe;wBAClB,KAAK,EAAE,IAAI,CAAC,OAAO;wBACnB,MAAM,EAAE,KAAK,CAAC,MAAM;wBACpB,CAAC,EAAE,KAAK,CAAC,KAAK;wBACd,IAAI;wBACJ,aAAa,EAAE,YAAY;qBAC5B,CAAC;iBACH,CAAC,CAAC;gBAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,MAAM,YAAY,GAAG,MAAM,sBAAsB,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;oBAC/E,MAAM,IAAI,iBAAiB,CAAC,8CAA8C,QAAQ,CAAC,MAAM,GAAG,EAAE,QAAQ,CAAC,MAAM,EAAE;wBAC7G,YAAY;qBACb,CAAC,CAAC;gBACL,CAAC;gBAED,OAAO,iBAAiB,CAAuB,QAAQ,EAAE;oBACvD,QAAQ,EAAE,gBAAgB;oBAC1B,QAAQ,EAAE,QAAQ;oBAClB,QAAQ,EAAE,oBAAoB;oBAC9B,KAAK;iBACN,CAAC,CAAC;YACL,CAAC,EAAE,KAAK,CAAC,CAAC;YAEV,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,MAAM,IAAI,UAAU,CAAC,uEAAuE,CAAC,CAAC;YAChG,CAAC;YAED,MAAM,SAAS,GAAG,yBAAyB,CAAC,YAAY,CAAC,CAAC;YAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAkB,EAAE;gBAC3D,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACtC,MAAM,IAAI,UAAU,CAAC,yCAAyC,KAAK,eAAe,CAAC,CAAC;gBACtF,CAAC;gBACD,MAAM,gBAAgB,GAAG,gBAAgB,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC9D,MAAM,OAAO,GAAG,OAAO,IAAI,CAAC,QAAQ,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;gBAC9E,MAAM,MAAM,GAAG,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;gBACnE,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;oBACxB,MAAM,IAAI,UAAU,CAAC,yCAAyC,KAAK,0CAA0C,CAAC,CAAC;gBACjH,CAAC;gBACD,OAAO;oBACL,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;oBAClF,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS;oBAClC,SAAS;oBACT,IAAI,EAAE,OAAO,IAAI,CAAC,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS;oBAC/E,gBAAgB;iBACjB,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACjF,OAAO;gBACL,MAAM;gBACN,IAAI,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;gBACnE,WAAW,EAAE;oBACX,GAAG,IAAI;oBACP,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;iBACpE;aACF,CAAC;QACJ,CAAC;gBAAS,CAAC;YACT,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;CACF;AAED,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,MAAwC,EAAE,EAAE,CAC3F,IAAI,0BAA0B,CAAC,MAAM,CAAC,CAAC"}

package/dist/index.d.ts

@@ -1,5 +1,11 @@
 import { z } from "zod";
-import { type AudioResponseLimits, type CallableProviderAdapter, type JsonValue, type ProviderAdapter, type RealtimeConnectionFactory, type ToolDefinition } from "@zhivex-ai/core";
+import { type AudioResponseLimits, type CallableProviderAdapter, type JsonValue, type ProviderAdapter, type RealtimeConnectionFactory, type ToolDefinition, type ToolExecutionResult } from "@zhivex-ai/core";
+export interface OpenAIResponseLimits extends AudioResponseLimits {
+    /** Maximum decoded bytes in one hosted image partial or final SSE event. Defaults to 32 MiB. */
+    hostedImageEventBytes?: number;
+    /** Maximum decoded hosted image bytes across one Responses SSE stream. Defaults to 128 MiB. */
+    hostedImageTotalBytes?: number;
+}
 export interface OpenAIProviderOptions {
     apiKey?: string;
     baseURL?: string;
@@ -7,7 +13,20 @@ export interface OpenAIProviderOptions {
     realtimeURL?: string;
     browserTokenURL?: string;
     realtimeConnectionFactory?: RealtimeConnectionFactory;
-    responseLimits?: AudioResponseLimits;
+    responseLimits?: OpenAIResponseLimits;
+}
+export interface OpenAIRealtimeProviderOptions {
+    /** Additional headers for the Realtime connection or client-secret request. */
+    headers?: Record<string, string>;
+    /** Stable, privacy-preserving end-user identifier sent as OpenAI-Safety-Identifier. */
+    safety_identifier?: string;
+    /** Override the WebSocket URL for this session. */
+    realtime_url?: string;
+    /** Additional query parameters for the Realtime WebSocket URL. */
+    realtime_query?: Record<string, string | number | boolean>;
+    /** Client-secret expiration settings passed at the request top level. */
+    expires_after?: Record<string, unknown>;
+    [key: string]: unknown;
 }
 export interface OpenAIWebSearchToolConfig {
     type?: "web_search" | "web_search_2025_08_26";
@@ -220,6 +239,30 @@ export interface OpenAIMcpListTools {
     server_label?: string;
     tools?: JsonValue;
 }
+export declare const openAIRealtimeMcpMetadataKey = "openai.realtime_mcp";
+export interface OpenAIRealtimeMcpMetadata {
+    type: "mcp_list_tools" | "mcp_approval_request" | "mcp_approval_response" | "mcp_call";
+    status: "in_progress" | "completed" | "failed" | "approval_required" | "approved" | "rejected" | "arguments_delta" | "arguments_done";
+    item_id?: string;
+    approval_request_id?: string;
+    server_label?: string;
+    name?: string;
+    approve?: boolean;
+    reason?: string;
+    arguments?: JsonValue;
+    delta?: JsonValue;
+    tools?: JsonValue;
+    output?: JsonValue;
+    error?: JsonValue;
+    raw_event?: JsonValue;
+}
+export interface OpenAIRealtimeMcpApprovalResultOptions {
+    approvalRequestId: string;
+    name: string;
+    approve: boolean;
+    reason?: string;
+    itemId?: string;
+}
 export interface OpenAIPromptCacheBreakpointData {
     type: "prompt_cache_breakpoint";
     mode: "explicit";
@@ -253,6 +296,11 @@ export interface OpenAILanguageModelOptions {
         function: {
             name: string;
         };
+    } | {
+        type: "function";
+        name: string;
+    } | {
+        type: "image_generation";
     };
     [key: string]: unknown;
 }
@@ -267,11 +315,12 @@ export declare const openAIProgrammaticToolCallingTool: () => import("@zhivex-ai
 export declare const openAIProgrammaticTool: <TSchema extends z.ZodTypeAny, TResult>(definition: ToolDefinition<TSchema, TResult>, options?: OpenAIProgrammaticToolOptions) => ToolDefinition<TSchema, TResult>;
 export declare const openAIRemoteMcpTool: (config: OpenAIRemoteMcpToolConfig) => import("@zhivex-ai/core").HostedToolDefinition<JsonValue>;
 export declare const openAIMcpApprovalResponse: (response: Omit<OpenAIMcpApprovalResponse, "type">) => import("@zhivex-ai/core").ContentPart;
+export declare const openAIRealtimeMcpApprovalResult: (response: OpenAIRealtimeMcpApprovalResultOptions) => ToolExecutionResult;
 export declare const openAIPromptCacheBreakpoint: () => import("@zhivex-ai/core").ContentPart;
 export declare const openAIComputerUseTool: (config: OpenAIComputerUseToolConfig) => import("@zhivex-ai/core").HostedToolDefinition<JsonValue>;
 export declare const openAIComputerTool: (config: OpenAIComputerToolConfig) => ToolDefinition<z.ZodType<OpenAIComputerCallInput>, JsonValue>;
 export declare const openAIHostedShellTool: (config: OpenAIHostedShellToolConfig) => import("@zhivex-ai/core").HostedToolDefinition<JsonValue>;
 export declare const openAIShellTool: (config?: OpenAIShellToolConfig) => ToolDefinition<z.ZodType<OpenAIShellToolInput>, JsonValue>;
 export declare const openAIApplyPatchTool: (config: OpenAIApplyPatchToolConfig) => ToolDefinition<z.ZodType<OpenAIApplyPatchToolInput>, JsonValue>;
-export {};
+export * from "./image-generation.js";
 //# sourceMappingURL=index.d.ts.map