@ai-gui/openai 0.3.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Liang Li
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+# @ai-gui/openai
+
+Convert OpenAI Responses API or Chat Completions streams into AIGUI's provider-neutral `ModelStreamEvent` protocol. No OpenAI SDK is required.
+
+```ts
+import { contentDeltas } from "@ai-gui/core"
+import { openAIStream } from "@ai-gui/openai"
+
+const response = await fetch("/api/openai")
+await renderer.feed(contentDeltas(openAIStream(response)))
+```
+
+`openAIStream(source, { signal, onMalformed })` accepts a fetch `Response`, `ReadableStream<Uint8Array>`, SSE byte `AsyncIterable`, or an SDK-shaped `AsyncIterable` of Responses/Chat Completions events. It emits content, reasoning, citations, usage, and errors. Tool calls are ignored and never executed.

package/dist/index.cjs

@@ -0,0 +1,225 @@
+"use strict";
+//#region rolldown:runtime
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+
+//#endregion
+const __ai_gui_core = __toESM(require("@ai-gui/core"));
+
+//#region src/index.ts
+async function* openAIStream(source, options = {}) {
+	for await (const value of events(source, options)) yield* convert(value);
+}
+async function* events(source, options) {
+	if (isTransport(source)) {
+		for await (const event of (0, __ai_gui_core.parseSSE)(source, {
+			...options,
+			parseJSON: true
+		})) yield event.data;
+		return;
+	}
+	const iterator = source[Symbol.asyncIterator]();
+	let done = false;
+	let delegated = false;
+	try {
+		const first = await next(iterator, options.signal);
+		if (first.done) {
+			done = true;
+			return;
+		}
+		if (typeof first.value === "string" || first.value instanceof Uint8Array) {
+			delegated = true;
+			for await (const event of (0, __ai_gui_core.parseSSE)(prepend(first.value, iterator), {
+				...options,
+				parseJSON: true
+			})) yield event.data;
+			return;
+		}
+		yield first.value;
+		for (;;) {
+			const result = await next(iterator, options.signal);
+			if (result.done) {
+				done = true;
+				return;
+			}
+			yield result.value;
+		}
+	} finally {
+		if (!done && !delegated) await iterator.return?.();
+	}
+}
+async function* convert(value) {
+	const event = object(value);
+	if (!event) return;
+	if (event.error !== void 0) {
+		yield {
+			type: "error",
+			error: event.error
+		};
+		return;
+	}
+	const type = text(event.type);
+	if (type === "error" || type === "response.failed" || type === "response.incomplete") yield {
+		type: "error",
+		error: event.error ?? event.response ?? event
+	};
+	else if (type === "response.output_text.delta" || type === "response.refusal.delta") {
+		if (text(event.delta)) yield {
+			type: "content",
+			delta: text(event.delta)
+		};
+	} else if (type === "response.reasoning_summary_text.delta" || type === "response.reasoning_text.delta") {
+		if (text(event.delta)) yield {
+			type: "reasoning",
+			delta: text(event.delta)
+		};
+	} else if (type === "response.output_text.annotation.added") {
+		const data = normalizeCitation(event.annotation);
+		if (data) yield {
+			type: "citation",
+			data
+		};
+	} else if (type === "response.completed") {
+		const data = normalizeUsage(object(event.response)?.usage);
+		if (data) yield {
+			type: "usage",
+			data
+		};
+	} else {
+		for (const choice of Array.isArray(event.choices) ? event.choices : []) {
+			const delta = object(object(choice)?.delta);
+			const reasoning = text(delta?.reasoning_content) ?? text(delta?.reasoning);
+			if (reasoning) yield {
+				type: "reasoning",
+				delta: reasoning
+			};
+			const content = contentText(delta?.content);
+			if (content) yield {
+				type: "content",
+				delta: content
+			};
+			for (const annotation of Array.isArray(delta?.annotations) ? delta.annotations : []) {
+				const data$1 = normalizeCitation(annotation);
+				if (data$1) yield {
+					type: "citation",
+					data: data$1
+				};
+			}
+		}
+		const data = normalizeUsage(event.usage);
+		if (data) yield {
+			type: "usage",
+			data
+		};
+	}
+}
+function normalizeUsage(value) {
+	const usage = object(value);
+	if (!usage) return void 0;
+	const inputTokens = numeric(usage.input_tokens) ?? numeric(usage.prompt_tokens);
+	const outputTokens = numeric(usage.output_tokens) ?? numeric(usage.completion_tokens);
+	const totalTokens = numeric(usage.total_tokens) ?? total(inputTokens, outputTokens);
+	return inputTokens === void 0 && outputTokens === void 0 && totalTokens === void 0 ? void 0 : defined({
+		inputTokens,
+		outputTokens,
+		totalTokens
+	});
+}
+function normalizeCitation(value) {
+	const outer = object(value);
+	if (!outer) return void 0;
+	const nested = object(outer.url_citation);
+	const source = nested ?? outer;
+	const result = defined({
+		type: text(source.type) ?? (nested ? "url_citation" : void 0),
+		id: text(source.id),
+		url: text(source.url),
+		title: text(source.title),
+		citedText: text(source.cited_text)
+	});
+	return Object.keys(result).length ? result : void 0;
+}
+function contentText(value) {
+	if (typeof value === "string") return value;
+	if (!Array.isArray(value)) return void 0;
+	return value.map((part) => text(object(part)?.text) ?? "").join("") || void 0;
+}
+function isTransport(value) {
+	return typeof Response !== "undefined" && value instanceof Response || typeof value === "object" && value !== null && "getReader" in value;
+}
+async function* prepend(first, iterator) {
+	let done = false;
+	try {
+		yield first;
+		for (;;) {
+			const result = await iterator.next();
+			if (result.done) {
+				done = true;
+				return;
+			}
+			if (typeof result.value !== "string" && !(result.value instanceof Uint8Array)) throw new TypeError("Mixed OpenAI stream chunk types");
+			yield result.value;
+		}
+	} finally {
+		if (!done) await iterator.return?.();
+	}
+}
+async function next(iterator, signal) {
+	if (!signal) return iterator.next();
+	if (signal.aborted) throw abortReason(signal);
+	const pending = Promise.resolve(iterator.next());
+	let abort;
+	const aborted = new Promise((_resolve, reject) => {
+		abort = () => reject(abortReason(signal));
+		signal.addEventListener("abort", abort, { once: true });
+	});
+	try {
+		const result = await Promise.race([pending, aborted]);
+		if (signal.aborted) throw abortReason(signal);
+		return result;
+	} finally {
+		signal.removeEventListener("abort", abort);
+	}
+}
+function abortReason(signal) {
+	if (signal.reason !== void 0) return signal.reason;
+	const error = new Error("The operation was aborted");
+	error.name = "AbortError";
+	return error;
+}
+function object(value) {
+	return typeof value === "object" && value !== null ? value : void 0;
+}
+function text(value) {
+	return typeof value === "string" ? value : void 0;
+}
+function numeric(value) {
+	return typeof value === "number" && Number.isFinite(value) ? value : void 0;
+}
+function total(a, b) {
+	return a === void 0 || b === void 0 ? void 0 : a + b;
+}
+function defined(value) {
+	return Object.fromEntries(Object.entries(value).filter(([, item]) => item !== void 0));
+}
+
+//#endregion
+exports.openAIStream = openAIStream

package/dist/index.d.cts

@@ -0,0 +1,9 @@
+import { ByteStreamSource, ModelStreamEvent, StreamParseOptions } from "@ai-gui/core";
+
+//#region src/index.d.ts
+type OpenAIStreamSource = ByteStreamSource | AsyncIterable<unknown>;
+type OpenAIStreamOptions = StreamParseOptions;
+declare function openAIStream(source: OpenAIStreamSource, options?: OpenAIStreamOptions): AsyncGenerator<ModelStreamEvent>;
+
+//#endregion
+export { OpenAIStreamOptions, OpenAIStreamSource, openAIStream };

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import { ByteStreamSource, ModelStreamEvent, StreamParseOptions } from "@ai-gui/core";
+
+//#region src/index.d.ts
+type OpenAIStreamSource = ByteStreamSource | AsyncIterable<unknown>;
+type OpenAIStreamOptions = StreamParseOptions;
+declare function openAIStream(source: OpenAIStreamSource, options?: OpenAIStreamOptions): AsyncGenerator<ModelStreamEvent>;
+
+//#endregion
+export { OpenAIStreamOptions, OpenAIStreamSource, openAIStream };

package/dist/index.js

@@ -0,0 +1,201 @@
+import { parseSSE } from "@ai-gui/core";
+
+//#region src/index.ts
+async function* openAIStream(source, options = {}) {
+	for await (const value of events(source, options)) yield* convert(value);
+}
+async function* events(source, options) {
+	if (isTransport(source)) {
+		for await (const event of parseSSE(source, {
+			...options,
+			parseJSON: true
+		})) yield event.data;
+		return;
+	}
+	const iterator = source[Symbol.asyncIterator]();
+	let done = false;
+	let delegated = false;
+	try {
+		const first = await next(iterator, options.signal);
+		if (first.done) {
+			done = true;
+			return;
+		}
+		if (typeof first.value === "string" || first.value instanceof Uint8Array) {
+			delegated = true;
+			for await (const event of parseSSE(prepend(first.value, iterator), {
+				...options,
+				parseJSON: true
+			})) yield event.data;
+			return;
+		}
+		yield first.value;
+		for (;;) {
+			const result = await next(iterator, options.signal);
+			if (result.done) {
+				done = true;
+				return;
+			}
+			yield result.value;
+		}
+	} finally {
+		if (!done && !delegated) await iterator.return?.();
+	}
+}
+async function* convert(value) {
+	const event = object(value);
+	if (!event) return;
+	if (event.error !== void 0) {
+		yield {
+			type: "error",
+			error: event.error
+		};
+		return;
+	}
+	const type = text(event.type);
+	if (type === "error" || type === "response.failed" || type === "response.incomplete") yield {
+		type: "error",
+		error: event.error ?? event.response ?? event
+	};
+	else if (type === "response.output_text.delta" || type === "response.refusal.delta") {
+		if (text(event.delta)) yield {
+			type: "content",
+			delta: text(event.delta)
+		};
+	} else if (type === "response.reasoning_summary_text.delta" || type === "response.reasoning_text.delta") {
+		if (text(event.delta)) yield {
+			type: "reasoning",
+			delta: text(event.delta)
+		};
+	} else if (type === "response.output_text.annotation.added") {
+		const data = normalizeCitation(event.annotation);
+		if (data) yield {
+			type: "citation",
+			data
+		};
+	} else if (type === "response.completed") {
+		const data = normalizeUsage(object(event.response)?.usage);
+		if (data) yield {
+			type: "usage",
+			data
+		};
+	} else {
+		for (const choice of Array.isArray(event.choices) ? event.choices : []) {
+			const delta = object(object(choice)?.delta);
+			const reasoning = text(delta?.reasoning_content) ?? text(delta?.reasoning);
+			if (reasoning) yield {
+				type: "reasoning",
+				delta: reasoning
+			};
+			const content = contentText(delta?.content);
+			if (content) yield {
+				type: "content",
+				delta: content
+			};
+			for (const annotation of Array.isArray(delta?.annotations) ? delta.annotations : []) {
+				const data$1 = normalizeCitation(annotation);
+				if (data$1) yield {
+					type: "citation",
+					data: data$1
+				};
+			}
+		}
+		const data = normalizeUsage(event.usage);
+		if (data) yield {
+			type: "usage",
+			data
+		};
+	}
+}
+function normalizeUsage(value) {
+	const usage = object(value);
+	if (!usage) return void 0;
+	const inputTokens = numeric(usage.input_tokens) ?? numeric(usage.prompt_tokens);
+	const outputTokens = numeric(usage.output_tokens) ?? numeric(usage.completion_tokens);
+	const totalTokens = numeric(usage.total_tokens) ?? total(inputTokens, outputTokens);
+	return inputTokens === void 0 && outputTokens === void 0 && totalTokens === void 0 ? void 0 : defined({
+		inputTokens,
+		outputTokens,
+		totalTokens
+	});
+}
+function normalizeCitation(value) {
+	const outer = object(value);
+	if (!outer) return void 0;
+	const nested = object(outer.url_citation);
+	const source = nested ?? outer;
+	const result = defined({
+		type: text(source.type) ?? (nested ? "url_citation" : void 0),
+		id: text(source.id),
+		url: text(source.url),
+		title: text(source.title),
+		citedText: text(source.cited_text)
+	});
+	return Object.keys(result).length ? result : void 0;
+}
+function contentText(value) {
+	if (typeof value === "string") return value;
+	if (!Array.isArray(value)) return void 0;
+	return value.map((part) => text(object(part)?.text) ?? "").join("") || void 0;
+}
+function isTransport(value) {
+	return typeof Response !== "undefined" && value instanceof Response || typeof value === "object" && value !== null && "getReader" in value;
+}
+async function* prepend(first, iterator) {
+	let done = false;
+	try {
+		yield first;
+		for (;;) {
+			const result = await iterator.next();
+			if (result.done) {
+				done = true;
+				return;
+			}
+			if (typeof result.value !== "string" && !(result.value instanceof Uint8Array)) throw new TypeError("Mixed OpenAI stream chunk types");
+			yield result.value;
+		}
+	} finally {
+		if (!done) await iterator.return?.();
+	}
+}
+async function next(iterator, signal) {
+	if (!signal) return iterator.next();
+	if (signal.aborted) throw abortReason(signal);
+	const pending = Promise.resolve(iterator.next());
+	let abort;
+	const aborted = new Promise((_resolve, reject) => {
+		abort = () => reject(abortReason(signal));
+		signal.addEventListener("abort", abort, { once: true });
+	});
+	try {
+		const result = await Promise.race([pending, aborted]);
+		if (signal.aborted) throw abortReason(signal);
+		return result;
+	} finally {
+		signal.removeEventListener("abort", abort);
+	}
+}
+function abortReason(signal) {
+	if (signal.reason !== void 0) return signal.reason;
+	const error = new Error("The operation was aborted");
+	error.name = "AbortError";
+	return error;
+}
+function object(value) {
+	return typeof value === "object" && value !== null ? value : void 0;
+}
+function text(value) {
+	return typeof value === "string" ? value : void 0;
+}
+function numeric(value) {
+	return typeof value === "number" && Number.isFinite(value) ? value : void 0;
+}
+function total(a, b) {
+	return a === void 0 || b === void 0 ? void 0 : a + b;
+}
+function defined(value) {
+	return Object.fromEntries(Object.entries(value).filter(([, item]) => item !== void 0));
+}
+
+//#endregion
+export { openAIStream };

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@ai-gui/openai",
+  "version": "0.3.0",
+  "description": "OpenAI model stream adapter for AIGUI.",
+  "keywords": [
+    "openai",
+    "llm",
+    "streaming",
+    "sse",
+    "aigui"
+  ],
+  "license": "MIT",
+  "author": "Liang Li <ll_faw@hotmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/liliang-cn/aigui.git",
+    "directory": "packages/openai"
+  },
+  "homepage": "https://github.com/liliang-cn/aigui#readme",
+  "bugs": "https://github.com/liliang-cn/aigui/issues",
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@ai-gui/core": "0.3.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "pnpm --dir ../.. exec vitest run --project openai",
+    "typecheck": "tsc --noEmit"
+  }
+}