@fgv/ts-extras 5.1.0-4 → 5.1.0-40

package/dist/packlets/ai-assist/streamingAdapters/openaiChat.js

@@ -0,0 +1,170 @@
+// Copyright (c) 2026 Erik Fortune
+//
+// 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.
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
+    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+/**
+ * Streaming adapter for OpenAI Chat Completions (also used for Groq, Mistral,
+ * and other Chat-Completions-compatible providers when no tools are
+ * requested).
+ *
+ * @packageDocumentation
+ */
+import { succeed, Validators } from '@fgv/ts-utils';
+import { buildMessages, buildOpenAiChatUserContent } from '../chatRequestBuilders';
+import { bearerAuthHeader } from '../endpoint';
+import { parseSseEventJson, readSseEvents } from '../sseParser';
+import { openSseConnection, validateEventPayload } from './common';
+// eslint-disable-next-line @rushstack/no-new-null
+const stringOrNull = Validators.isA('string-or-null', 
+// eslint-disable-next-line @rushstack/no-new-null
+(v) => typeof v === 'string' || v === null);
+const openAiChatStreamChoice = Validators.object({
+    delta: Validators.object({ content: Validators.string }, { options: { optionalFields: ['content'] } }).optional(),
+    finish_reason: stringOrNull.optional()
+}, { options: { optionalFields: ['delta', 'finish_reason'] } });
+const openAiChatStreamChunk = Validators.object({
+    choices: Validators.arrayOf(openAiChatStreamChoice)
+});
+// ============================================================================
+// Stream translator
+// ============================================================================
+/**
+ * Translates an OpenAI Chat Completions SSE stream into unified events.
+ *
+ * @internal
+ */
+function translateOpenAiChatStream(response) {
+    return __asyncGenerator(this, arguments, function* translateOpenAiChatStream_1() {
+        var _a, e_1, _b, _c;
+        var _d;
+        let fullText = '';
+        let truncated = false;
+        let receivedDone = false;
+        try {
+            /* c8 ignore next - body is non-null at this point per openSseConnection */
+            if (!response.body)
+                return yield __await(void 0);
+            try {
+                for (var _e = true, _f = __asyncValues(readSseEvents(response.body)), _g; _g = yield __await(_f.next()), _a = _g.done, !_a; _e = true) {
+                    _c = _g.value;
+                    _e = false;
+                    const message = _c;
+                    const json = parseSseEventJson(message.data);
+                    if (json === undefined) {
+                        // [DONE] sentinel or unparseable; skip
+                        continue;
+                    }
+                    const chunk = validateEventPayload(json, openAiChatStreamChunk);
+                    /* c8 ignore next 1 - defensive: chunk?.choices optional chain unreachable after validation */
+                    const choice = chunk === null || chunk === void 0 ? void 0 : chunk.choices[0];
+                    /* c8 ignore next 3 - defensive: SSE events without choices are skipped */
+                    if (!choice) {
+                        continue;
+                    }
+                    /* c8 ignore next 1 - defensive: choice.delta?.content optional chain unreachable after validation */
+                    const delta = (_d = choice.delta) === null || _d === void 0 ? void 0 : _d.content;
+                    if (typeof delta === 'string' && delta.length > 0) {
+                        fullText += delta;
+                        yield yield __await({ type: 'text-delta', delta });
+                    }
+                    const finish = choice.finish_reason;
+                    if (typeof finish === 'string' && finish.length > 0) {
+                        truncated = finish === 'length';
+                        receivedDone = true;
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_e && !_a && (_b = _f.return)) yield __await(_b.call(_f));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        }
+        catch (err) /* c8 ignore start - defensive: stream errors are always Error instances */ {
+            yield yield __await({ type: 'error', message: err instanceof Error ? err.message : String(err) });
+            return yield __await(void 0);
+        } /* c8 ignore stop */
+        if (receivedDone) {
+            yield yield __await({ type: 'done', truncated, fullText });
+        }
+        else {
+            yield yield __await({ type: 'error', message: 'OpenAI stream ended without a finish_reason' });
+        }
+    });
+}
+// ============================================================================
+// Per-format request caller
+// ============================================================================
+/**
+ * Issues a streaming Chat Completions request and returns the unified-event
+ * iterable on success.
+ *
+ * @internal
+ */
+export async function callOpenAiChatStream(config, prompt, messagesBefore, temperature, logger, signal, resolvedThinking) {
+    var _a;
+    const url = `${config.baseUrl}/chat/completions`;
+    const messages = buildMessages(prompt.system, buildOpenAiChatUserContent(prompt), {
+        head: messagesBefore
+    });
+    const effort = (_a = resolvedThinking === null || resolvedThinking === void 0 ? void 0 : resolvedThinking.openAiEffort) !== null && _a !== void 0 ? _a : resolvedThinking === null || resolvedThinking === void 0 ? void 0 : resolvedThinking.xaiEffort;
+    const supportsReasoning = config.model !== 'grok-4';
+    const body = { model: config.model, messages, stream: true };
+    if (effort !== undefined && supportsReasoning) {
+        body.reasoning_effort = effort;
+    }
+    // Temperature is sent only when the caller explicitly provided one; omitting it lets the
+    // provider apply its own default (current-gen models reject a caller-supplied default). This
+    // adapter is reached only via the conflict-guarded streaming entry point — the client-tool path
+    // routes OpenAI through the Responses adapter, not chat — so, like callOpenAiCompletion, no
+    // effort gate is needed: temperature is present here only when the effort is undefined/'none'.
+    if (temperature !== undefined) {
+        body.temperature = temperature;
+    }
+    if ((resolvedThinking === null || resolvedThinking === void 0 ? void 0 : resolvedThinking.otherParams) !== undefined) {
+        Object.assign(body, resolvedThinking.otherParams);
+    }
+    const headers = bearerAuthHeader(config.apiKey);
+    /* c8 ignore next 1 - optional logger */
+    logger === null || logger === void 0 ? void 0 : logger.info(`OpenAI streaming completion: model=${config.model}`);
+    const conn = await openSseConnection(url, headers, body, logger, signal);
+    return conn.onSuccess((response) => succeed(translateOpenAiChatStream(response)));
+}
+//# sourceMappingURL=openaiChat.js.map

package/dist/packlets/ai-assist/streamingAdapters/openaiChat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openaiChat.js","sourceRoot":"","sources":["../../../../src/packlets/ai-assist/streamingAdapters/openaiChat.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAClC,EAAE;AACF,+EAA+E;AAC/E,gFAAgF;AAChF,+EAA+E;AAC/E,4EAA4E;AAC5E,wEAAwE;AACxE,2DAA2D;AAC3D,EAAE;AACF,iFAAiF;AACjF,kDAAkD;AAClD,EAAE;AACF,6EAA6E;AAC7E,2EAA2E;AAC3E,8EAA8E;AAC9E,yEAAyE;AACzE,gFAAgF;AAChF,gFAAgF;AAChF,YAAY;;;;;;;;;;;;;;;;;;;;;AAEZ;;;;;;GAMG;AAEH,OAAO,EAAwB,OAAO,EAAkB,UAAU,EAAE,MAAM,eAAe,CAAC;AAE1F,OAAO,EAAE,aAAa,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AACnF,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAEhE,OAAO,EAAoB,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AA+BrF,kDAAkD;AAClD,MAAM,YAAY,GAA6B,UAAU,CAAC,GAAG,CAC3D,gBAAgB;AAChB,kDAAkD;AAClD,CAAC,CAAU,EAAsB,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,CACxE,CAAC;AAEF,MAAM,sBAAsB,GAAuC,UAAU,CAAC,MAAM,CAClF;IACE,KAAK,EAAE,UAAU,CAAC,MAAM,CACtB,EAAE,OAAO,EAAE,UAAU,CAAC,MAAM,EAAE,EAC9B,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,CAAC,SAAS,CAAC,EAAE,EAAE,CAC7C,CAAC,QAAQ,EAAE;IACZ,aAAa,EAAE,YAAY,CAAC,QAAQ,EAAE;CACvC,EACD,EAAE,OAAO,EAAE,EAAE,cAAc,EAAE,CAAC,OAAO,EAAE,eAAe,CAAC,EAAE,EAAE,CAC5D,CAAC;AAEF,MAAM,qBAAqB,GAAsC,UAAU,CAAC,MAAM,CAAyB;IACzG,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,sBAAsB,CAAC;CACpD,CAAC,CAAC;AAEH,+EAA+E;AAC/E,oBAAoB;AACpB,+EAA+E;AAE/E;;;;GAIG;AACH,SAAgB,yBAAyB,CAAC,QAAkB;;;;QAC1D,IAAI,QAAQ,GAAG,EAAE,CAAC;QAClB,IAAI,SAAS,GAAG,KAAK,CAAC;QACtB,IAAI,YAAY,GAAG,KAAK,CAAC;QAEzB,IAAI,CAAC;YACH,2EAA2E;YAC3E,IAAI,CAAC,QAAQ,CAAC,IAAI;gBAAE,6BAAO;;gBAC3B,KAA4B,eAAA,KAAA,cAAA,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA,IAAA,+DAAE,CAAC;oBAA/B,cAA4B;oBAA5B,WAA4B;oBAA7C,MAAM,OAAO,KAAA,CAAA;oBACtB,MAAM,IAAI,GAAG,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBAC7C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;wBACvB,uCAAuC;wBACvC,SAAS;oBACX,CAAC;oBACD,MAAM,KAAK,GAAG,oBAAoB,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;oBAChE,8FAA8F;oBAC9F,MAAM,MAAM,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,CAAC,CAAC,CAAC,CAAC;oBACjC,0EAA0E;oBAC1E,IAAI,CAAC,MAAM,EAAE,CAAC;wBACZ,SAAS;oBACX,CAAC;oBACD,qGAAqG;oBACrG,MAAM,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,CAAC;oBACpC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAClD,QAAQ,IAAI,KAAK,CAAC;wBAClB,oBAAM,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,CAAA,CAAC;oBACtC,CAAC;oBACD,MAAM,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC;oBACpC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBACpD,SAAS,GAAG,MAAM,KAAK,QAAQ,CAAC;wBAChC,YAAY,GAAG,IAAI,CAAC;oBACtB,CAAC;gBACH,CAAC;;;;;;;;;QACH,CAAC;QAAC,OAAO,GAAY,EAAE,2EAA2E,CAAC,CAAC;YAClG,oBAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAA,CAAC;YACnF,6BAAO;QACT,CAAC,CAAC,oBAAoB;QAEtB,IAAI,YAAY,EAAE,CAAC;YACjB,oBAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAA,CAAC;QAC9C,CAAC;aAAM,CAAC;YACN,oBAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,6CAA6C,EAAE,CAAA,CAAC;QAClF,CAAC;IACH,CAAC;CAAA;AAED,+EAA+E;AAC/E,4BAA4B;AAC5B,+EAA+E;AAE/E;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,MAAwB,EACxB,MAAgB,EAChB,cAAuD,EACvD,WAA+B,EAC/B,MAAwB,EACxB,MAAoB,EACpB,gBAA0C;;IAE1C,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,OAAO,mBAAmB,CAAC;IACjD,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,EAAE,0BAA0B,CAAC,MAAM,CAAC,EAAE;QAChF,IAAI,EAAE,cAAc;KACrB,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,YAAY,mCAAI,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,SAAS,CAAC;IAC7E,MAAM,iBAAiB,GAAG,MAAM,CAAC,KAAK,KAAK,QAAQ,CAAC;IACpD,MAAM,IAAI,GAA4B,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IACtF,IAAI,MAAM,KAAK,SAAS,IAAI,iBAAiB,EAAE,CAAC;QAC9C,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC;IACjC,CAAC;IACD,yFAAyF;IACzF,6FAA6F;IAC7F,gGAAgG;IAChG,4FAA4F;IAC5F,+FAA+F;IAC/F,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IACD,IAAI,CAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,WAAW,MAAK,SAAS,EAAE,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,gBAAgB,CAAC,WAAW,CAAC,CAAC;IACpD,CAAC;IACD,MAAM,OAAO,GAA2B,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACxE,wCAAwC;IACxC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,CAAC,sCAAsC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;IACnE,MAAM,IAAI,GAAG,MAAM,iBAAiB,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACzE,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;AACpF,CAAC","sourcesContent":["// Copyright (c) 2026 Erik Fortune\n//\n// Permission is hereby granted, free of charge, to any person obtaining a copy\n// of this software and associated documentation files (the \"Software\"), to deal\n// in the Software without restriction, including without limitation the rights\n// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n// copies of the Software, and to permit persons to whom the Software is\n// furnished to do so, subject to the following conditions:\n//\n// The above copyright notice and this permission notice shall be included in all\n// copies or substantial portions of the Software.\n//\n// THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n// SOFTWARE.\n\n/**\n * Streaming adapter for OpenAI Chat Completions (also used for Groq, Mistral,\n * and other Chat-Completions-compatible providers when no tools are\n * requested).\n *\n * @packageDocumentation\n */\n\nimport { type Logging, Result, succeed, type Validator, Validators } from '@fgv/ts-utils';\n\nimport { buildMessages, buildOpenAiChatUserContent } from '../chatRequestBuilders';\nimport { bearerAuthHeader } from '../endpoint';\nimport { AiPrompt, type IAiStreamEvent, type IChatMessage } from '../model';\nimport { parseSseEventJson, readSseEvents } from '../sseParser';\nimport { type IResolvedThinkingConfig } from '../thinkingOptionsResolver';\nimport { IStreamApiConfig, openSseConnection, validateEventPayload } from './common';\n\n// ============================================================================\n// Event payload shapes\n// ============================================================================\n\n/**\n * The shape of `choices[0]` in an OpenAI Chat Completions streaming chunk.\n * Both `delta.content` and `finish_reason` are optional — content arrives in\n * intermediate chunks, finish_reason in the terminal chunk. The wire sends\n * `finish_reason: null` (literal null, not absent) on intermediate chunks,\n * so the validator must accept null alongside string.\n *\n * @internal\n */\ninterface IOpenAiChatStreamChoice {\n  readonly delta?: { readonly content?: string };\n  // eslint-disable-next-line @rushstack/no-new-null\n  readonly finish_reason?: string | null;\n}\n\n/**\n * One streaming chunk from the OpenAI Chat Completions endpoint. Always has\n * a `choices` array with one element in the streaming mode.\n *\n * @internal\n */\ninterface IOpenAiChatStreamChunk {\n  readonly choices: ReadonlyArray<IOpenAiChatStreamChoice>;\n}\n\n// eslint-disable-next-line @rushstack/no-new-null\nconst stringOrNull: Validator<string | null> = Validators.isA<string | null>(\n  'string-or-null',\n  // eslint-disable-next-line @rushstack/no-new-null\n  (v: unknown): v is string | null => typeof v === 'string' || v === null\n);\n\nconst openAiChatStreamChoice: Validator<IOpenAiChatStreamChoice> = Validators.object<IOpenAiChatStreamChoice>(\n  {\n    delta: Validators.object<{ content?: string }>(\n      { content: Validators.string },\n      { options: { optionalFields: ['content'] } }\n    ).optional(),\n    finish_reason: stringOrNull.optional()\n  },\n  { options: { optionalFields: ['delta', 'finish_reason'] } }\n);\n\nconst openAiChatStreamChunk: Validator<IOpenAiChatStreamChunk> = Validators.object<IOpenAiChatStreamChunk>({\n  choices: Validators.arrayOf(openAiChatStreamChoice)\n});\n\n// ============================================================================\n// Stream translator\n// ============================================================================\n\n/**\n * Translates an OpenAI Chat Completions SSE stream into unified events.\n *\n * @internal\n */\nasync function* translateOpenAiChatStream(response: Response): AsyncGenerator<IAiStreamEvent> {\n  let fullText = '';\n  let truncated = false;\n  let receivedDone = false;\n\n  try {\n    /* c8 ignore next - body is non-null at this point per openSseConnection */\n    if (!response.body) return;\n    for await (const message of readSseEvents(response.body)) {\n      const json = parseSseEventJson(message.data);\n      if (json === undefined) {\n        // [DONE] sentinel or unparseable; skip\n        continue;\n      }\n      const chunk = validateEventPayload(json, openAiChatStreamChunk);\n      /* c8 ignore next 1 - defensive: chunk?.choices optional chain unreachable after validation */\n      const choice = chunk?.choices[0];\n      /* c8 ignore next 3 - defensive: SSE events without choices are skipped */\n      if (!choice) {\n        continue;\n      }\n      /* c8 ignore next 1 - defensive: choice.delta?.content optional chain unreachable after validation */\n      const delta = choice.delta?.content;\n      if (typeof delta === 'string' && delta.length > 0) {\n        fullText += delta;\n        yield { type: 'text-delta', delta };\n      }\n      const finish = choice.finish_reason;\n      if (typeof finish === 'string' && finish.length > 0) {\n        truncated = finish === 'length';\n        receivedDone = true;\n      }\n    }\n  } catch (err: unknown) /* c8 ignore start - defensive: stream errors are always Error instances */ {\n    yield { type: 'error', message: err instanceof Error ? err.message : String(err) };\n    return;\n  } /* c8 ignore stop */\n\n  if (receivedDone) {\n    yield { type: 'done', truncated, fullText };\n  } else {\n    yield { type: 'error', message: 'OpenAI stream ended without a finish_reason' };\n  }\n}\n\n// ============================================================================\n// Per-format request caller\n// ============================================================================\n\n/**\n * Issues a streaming Chat Completions request and returns the unified-event\n * iterable on success.\n *\n * @internal\n */\nexport async function callOpenAiChatStream(\n  config: IStreamApiConfig,\n  prompt: AiPrompt,\n  messagesBefore: ReadonlyArray<IChatMessage> | undefined,\n  temperature: number | undefined,\n  logger?: Logging.ILogger,\n  signal?: AbortSignal,\n  resolvedThinking?: IResolvedThinkingConfig\n): Promise<Result<AsyncIterable<IAiStreamEvent>>> {\n  const url = `${config.baseUrl}/chat/completions`;\n  const messages = buildMessages(prompt.system, buildOpenAiChatUserContent(prompt), {\n    head: messagesBefore\n  });\n  const effort = resolvedThinking?.openAiEffort ?? resolvedThinking?.xaiEffort;\n  const supportsReasoning = config.model !== 'grok-4';\n  const body: Record<string, unknown> = { model: config.model, messages, stream: true };\n  if (effort !== undefined && supportsReasoning) {\n    body.reasoning_effort = effort;\n  }\n  // Temperature is sent only when the caller explicitly provided one; omitting it lets the\n  // provider apply its own default (current-gen models reject a caller-supplied default). This\n  // adapter is reached only via the conflict-guarded streaming entry point — the client-tool path\n  // routes OpenAI through the Responses adapter, not chat — so, like callOpenAiCompletion, no\n  // effort gate is needed: temperature is present here only when the effort is undefined/'none'.\n  if (temperature !== undefined) {\n    body.temperature = temperature;\n  }\n  if (resolvedThinking?.otherParams !== undefined) {\n    Object.assign(body, resolvedThinking.otherParams);\n  }\n  const headers: Record<string, string> = bearerAuthHeader(config.apiKey);\n  /* c8 ignore next 1 - optional logger */\n  logger?.info(`OpenAI streaming completion: model=${config.model}`);\n  const conn = await openSseConnection(url, headers, body, logger, signal);\n  return conn.onSuccess((response) => succeed(translateOpenAiChatStream(response)));\n}\n"]}

package/dist/packlets/ai-assist/streamingAdapters/openaiResponses.js

@@ -0,0 +1,386 @@
+// Copyright (c) 2026 Erik Fortune
+//
+// 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.
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = Object.create((typeof AsyncIterator === "function" ? AsyncIterator : Object).prototype), verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
+    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
+/**
+ * Streaming adapter for the OpenAI / xAI Responses API. This is the format
+ * used when server-side tools (e.g. web_search) are requested — Chat
+ * Completions doesn't support tool progress events, but the Responses API
+ * does.
+ *
+ * Client-defined tools (`function_call` type) are accumulated per call ID
+ * and emitted as `client-tool-call-done` events when complete.
+ *
+ * @packageDocumentation
+ */
+import { succeed, Validators } from '@fgv/ts-utils';
+import { buildMessages, buildOpenAiResponsesUserContent } from '../chatRequestBuilders';
+import { bearerAuthHeader } from '../endpoint';
+import { parseSseEventJson, readSseEvents } from '../sseParser';
+import { toResponsesApiTools } from '../toolFormats';
+import { UNRECOGNIZED_EVENT_WARN_TAG, formatUnrecognizedEventPayloadPreview, openSseConnection, validateEventPayload } from './common';
+const responsesDeltaPayload = Validators.object({
+    delta: Validators.string
+});
+const responsesOutputItemInner = Validators.object({
+    type: Validators.string.optional(),
+    id: Validators.string.optional(),
+    name: Validators.string.optional(),
+    call_id: Validators.string.optional()
+}, { options: { optionalFields: ['type', 'id', 'name', 'call_id'] } });
+const responsesOutputItemAddedPayload = Validators.object({ item: responsesOutputItemInner });
+const responsesFunctionCallArgsDeltaPayload = Validators.object({
+    item_id: Validators.string,
+    delta: Validators.string
+});
+const responsesFunctionCallArgsDonePayload = Validators.object({
+    item_id: Validators.string,
+    arguments: Validators.string
+});
+const responsesIncompleteDetails = Validators.object({ reason: Validators.string.optional() }, { options: { optionalFields: ['reason'] } });
+const responsesCompletedPayload = Validators.object({
+    response: Validators.object({
+        status: Validators.string.optional(),
+        incomplete_details: responsesIncompleteDetails.optional()
+    }, { options: { optionalFields: ['status', 'incomplete_details'] } })
+});
+const responsesErrorInner = Validators.object({ message: Validators.string.optional() }, { options: { optionalFields: ['message'] } });
+const responsesErrorPayload = Validators.object({
+    error: responsesErrorInner.optional(),
+    message: Validators.string.optional()
+}, { options: { optionalFields: ['error', 'message'] } });
+// ============================================================================
+// Stream translator
+// ============================================================================
+/**
+ * Recognized OpenAI / xAI Responses API SSE event names. An event in this set is either
+ * handled below or intentionally ignored (lifecycle / reasoning content discarded by design /
+ * server-tool channels not yet surfaced). Any event whose name is NOT in this set surfaces
+ * a one-time `logger.warn` per stream — making provider drift (new event types from a model
+ * update) visible empirically instead of silently no-op'd.
+ *
+ * Source: official `openai-node` SDK source (`src/resources/responses/responses.ts`)
+ * event-type literal-string sweep, plus the xAI Responses superset. Add to this set when a
+ * new event type is observed and confirmed safe to ignore.
+ *
+ * @internal
+ */
+const RECOGNIZED_OPENAI_RESPONSES_EVENTS = new Set([
+    // ---- handled by the translator ----
+    'response.output_text.delta',
+    'response.web_search_call.in_progress',
+    'response.web_search_call.completed',
+    'response.output_item.added',
+    'response.function_call_arguments.delta',
+    'response.function_call_arguments.done',
+    'response.completed',
+    'response.failed',
+    'error',
+    // ---- lifecycle events: intentionally silent ----
+    'response.created',
+    'response.in_progress',
+    'response.queued',
+    'response.incomplete',
+    // ---- text content lifecycle: handled implicitly via delta accumulation ----
+    'response.output_text.done',
+    'response.output_text.annotation.added',
+    'response.content_part.added',
+    'response.content_part.done',
+    'response.output_item.done',
+    // ---- reasoning content: discarded by design (see ai-assist-thinking-events follow-on) ----
+    'response.reasoning_summary_part.added',
+    'response.reasoning_summary_part.done',
+    'response.reasoning_summary_text.delta',
+    'response.reasoning_summary_text.done',
+    'response.reasoning_text.delta',
+    'response.reasoning_text.done',
+    // ---- refusals: caller currently sees these via the model's final text ----
+    'response.refusal.delta',
+    'response.refusal.done',
+    // ---- server-tool channels not surfaced as tool-event yet ----
+    'response.web_search_call.searching',
+    'response.file_search_call.in_progress',
+    'response.file_search_call.searching',
+    'response.file_search_call.completed',
+    'response.code_interpreter_call.in_progress',
+    'response.code_interpreter_call.interpreting',
+    'response.code_interpreter_call.completed',
+    'response.code_interpreter_call_code.delta',
+    'response.code_interpreter_call_code.done',
+    'response.image_generation_call.in_progress',
+    'response.image_generation_call.generating',
+    'response.image_generation_call.completed',
+    'response.image_generation_call.partial_image',
+    'response.mcp_call.in_progress',
+    'response.mcp_call.completed',
+    'response.mcp_call.failed',
+    'response.mcp_call_arguments.delta',
+    'response.mcp_call_arguments.done',
+    'response.mcp_list_tools.in_progress',
+    'response.mcp_list_tools.completed',
+    'response.mcp_list_tools.failed',
+    'response.custom_tool_call_input.delta',
+    'response.custom_tool_call_input.done',
+    // ---- audio (not used in chat/tool flows here) ----
+    'response.audio.delta',
+    'response.audio.done',
+    'response.audio.transcript.delta',
+    'response.audio.transcript.done'
+]);
+/**
+ * Translates an OpenAI Responses API SSE stream into unified events.
+ *
+ * Maintains a per-call-ID accumulation map for client-defined function calls.
+ * The map is exposed via the passed-in `functionCallMap` parameter for the
+ * C3 continuation builder to read after the stream completes.
+ *
+ * Unrecognized event names are reported once per stream via `logger?.warn` —
+ * see {@link RECOGNIZED_OPENAI_RESPONSES_EVENTS}.
+ *
+ * @internal
+ */
+function translateOpenAiResponsesStream(response, functionCallMap, logger) {
+    return __asyncGenerator(this, arguments, function* translateOpenAiResponsesStream_1() {
+        var _a, e_1, _b, _c;
+        var _d, _e, _f, _g, _h;
+        let fullText = '';
+        let truncated = false;
+        let completed = false;
+        let incompleteReason;
+        // OpenAI / xAI Responses API emits function_call_arguments.{delta,done} events keyed by
+        // `item_id` (the fc_* output-item id). The harness and continuation builder key by
+        // `call_id` (the call_* id). This map correlates the two — populated when the
+        // function_call item is announced in `response.output_item.added`.
+        const itemIdToCallId = new Map();
+        // Track unrecognized event names we have already warned about, so a hot stream of
+        // an unknown event type produces exactly one log line per name per stream.
+        const warnedEvents = new Set();
+        try {
+            /* c8 ignore next - body is non-null at this point per openSseConnection */
+            if (!response.body)
+                return yield __await(void 0);
+            try {
+                for (var _j = true, _k = __asyncValues(readSseEvents(response.body)), _l; _l = yield __await(_k.next()), _a = _l.done, !_a; _j = true) {
+                    _c = _l.value;
+                    _j = false;
+                    const message = _c;
+                    const eventName = message.event;
+                    if (eventName === 'response.output_text.delta') {
+                        const payload = validateEventPayload(parseSseEventJson(message.data), responsesDeltaPayload);
+                        /* c8 ignore next 1 - defensive: payload?.delta null branch unreachable after validation */
+                        const delta = payload === null || payload === void 0 ? void 0 : payload.delta;
+                        if (typeof delta === 'string' && delta.length > 0) {
+                            fullText += delta;
+                            yield yield __await({ type: 'text-delta', delta });
+                        }
+                    }
+                    else if (eventName === 'response.web_search_call.in_progress') {
+                        yield yield __await({ type: 'tool-event', toolType: 'web_search', phase: 'started' });
+                    }
+                    else if (eventName === 'response.web_search_call.completed') {
+                        yield yield __await({ type: 'tool-event', toolType: 'web_search', phase: 'completed' });
+                    }
+                    else if (eventName === 'response.output_item.added') {
+                        const payload = validateEventPayload(parseSseEventJson(message.data), responsesOutputItemAddedPayload);
+                        /* c8 ignore next 1 - defensive: payload null branch unreachable after validation */
+                        const item = payload === null || payload === void 0 ? void 0 : payload.item;
+                        /* c8 ignore next 1 - defensive: falsy call_id/name branches are protocol violations */
+                        if ((item === null || item === void 0 ? void 0 : item.type) === 'function_call' && item.call_id && item.name) {
+                            functionCallMap.set(item.call_id, { id: item.call_id, name: item.name, argsBuffer: '' });
+                            // Reasoning models (and the standard flow) reference this function_call in subsequent
+                            // arguments.{delta,done} events by `item_id`, never by `call_id`. Record the mapping
+                            // so the arg-accumulation handlers can resolve the call.
+                            if (item.id) {
+                                itemIdToCallId.set(item.id, item.call_id);
+                            }
+                            yield yield __await({ type: 'client-tool-call-start', toolName: item.name, callId: item.call_id });
+                        }
+                    }
+                    else if (eventName === 'response.function_call_arguments.delta') {
+                        const payload = validateEventPayload(parseSseEventJson(message.data), responsesFunctionCallArgsDeltaPayload);
+                        /* c8 ignore next 1 - defensive: payload null branch unreachable after validation */
+                        const itemId = payload === null || payload === void 0 ? void 0 : payload.item_id;
+                        if (itemId !== undefined) {
+                            const callId = itemIdToCallId.get(itemId);
+                            /* c8 ignore next 1 - defensive: orphan delta (no preceding output_item.added) is a protocol violation */
+                            const call = callId !== undefined ? functionCallMap.get(callId) : undefined;
+                            /* c8 ignore next 1 - defensive: call always present and delta always string in valid stream */
+                            if (call && typeof (payload === null || payload === void 0 ? void 0 : payload.delta) === 'string') {
+                                call.argsBuffer += payload.delta;
+                            }
+                        }
+                    }
+                    else if (eventName === 'response.function_call_arguments.done') {
+                        const payload = validateEventPayload(parseSseEventJson(message.data), responsesFunctionCallArgsDonePayload);
+                        /* c8 ignore next 1 - defensive: payload null branch unreachable after validation */
+                        const itemId = payload === null || payload === void 0 ? void 0 : payload.item_id;
+                        if (itemId !== undefined) {
+                            const callId = itemIdToCallId.get(itemId);
+                            /* c8 ignore next 1 - defensive: orphan done (no preceding output_item.added) is a protocol violation */
+                            const call = callId !== undefined ? functionCallMap.get(callId) : undefined;
+                            if (call && callId !== undefined) {
+                                /* c8 ignore next 1 - defensive: payload?.arguments null branch unreachable after validation */
+                                const canonicalArgs = (_d = payload === null || payload === void 0 ? void 0 : payload.arguments) !== null && _d !== void 0 ? _d : '{}';
+                                // Sync the accumulation entry with the canonical arguments from the .done event.
+                                // Delta events may carry partial/empty payloads; the .done event carries the
+                                // authoritative final arguments string used by the continuation builder.
+                                call.argsBuffer = canonicalArgs;
+                                let args;
+                                try {
+                                    const parsed = JSON.parse(canonicalArgs);
+                                    /* c8 ignore start - defensive: non-object/malformed parse defaults to empty object */
+                                    args =
+                                        parsed !== null && typeof parsed === 'object' && !Array.isArray(parsed)
+                                            ? parsed
+                                            : {};
+                                }
+                                catch (_m) {
+                                    args = {};
+                                }
+                                /* c8 ignore stop */
+                                yield yield __await({ type: 'client-tool-call-done', toolName: call.name, callId, args });
+                            }
+                        }
+                    }
+                    else if (eventName === 'response.completed') {
+                        const payload = validateEventPayload(parseSseEventJson(message.data), responsesCompletedPayload);
+                        /* c8 ignore next 1 - defensive: payload null branch unreachable after validation */
+                        if (payload) {
+                            truncated = payload.response.status === 'incomplete';
+                            // Per IAiStreamDone.incompleteReason's contract, the reason is meaningful only
+                            // when the response was truncated. Move both fields together on every completed
+                            // event so a stray incomplete_details on a non-incomplete payload never leaks
+                            // through, and a later (defensive) completed event can't leave a stale reason.
+                            incompleteReason = truncated ? (_e = payload.response.incomplete_details) === null || _e === void 0 ? void 0 : _e.reason : undefined;
+                        }
+                        completed = true;
+                        /* c8 ignore next 1 - defensive: eventName === 'error' alternative not exercised in tests */
+                    }
+                    else if (eventName === 'response.failed' || eventName === 'error') {
+                        const payload = validateEventPayload(parseSseEventJson(message.data), responsesErrorPayload);
+                        /* c8 ignore next 1 - defensive: payload?.error and payload?.message null branches unreachable */
+                        const errMsg = (_h = (_g = (_f = payload === null || payload === void 0 ? void 0 : payload.error) === null || _f === void 0 ? void 0 : _f.message) !== null && _g !== void 0 ? _g : payload === null || payload === void 0 ? void 0 : payload.message) !== null && _h !== void 0 ? _h : 'Responses API stream failed';
+                        yield yield __await({ type: 'error', message: errMsg });
+                        return yield __await(void 0);
+                    }
+                    else if (typeof eventName === 'string' &&
+                        !RECOGNIZED_OPENAI_RESPONSES_EVENTS.has(eventName) &&
+                        !warnedEvents.has(eventName)) {
+                        // Empirical drift instrument: an unrecognized SSE event from the Responses API
+                        // surfaces as a one-time warning per stream. If a provider adds a new event type
+                        // (or changes an existing event's name), the warning fires the first time the
+                        // event arrives. Update RECOGNIZED_OPENAI_RESPONSES_EVENTS once the new event is
+                        // either handled or confirmed safe to ignore.
+                        warnedEvents.add(eventName);
+                        logger === null || logger === void 0 ? void 0 : logger.warn(`${UNRECOGNIZED_EVENT_WARN_TAG} OpenAI Responses adapter: unrecognized SSE event ` +
+                            `'${eventName}'. ` +
+                            `payload preview: ${formatUnrecognizedEventPayloadPreview(message.data)}. ` +
+                            `This may indicate provider drift — if the new event carries data the adapter ` +
+                            `should surface, add a handler; otherwise add the name to ` +
+                            `RECOGNIZED_OPENAI_RESPONSES_EVENTS.`);
+                    }
+                }
+            }
+            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            finally {
+                try {
+                    if (!_j && !_a && (_b = _k.return)) yield __await(_b.call(_k));
+                }
+                finally { if (e_1) throw e_1.error; }
+            }
+        }
+        catch (err) /* c8 ignore start - defensive: stream errors are always Error instances */ {
+            yield yield __await({ type: 'error', message: err instanceof Error ? err.message : String(err) });
+            return yield __await(void 0);
+        } /* c8 ignore stop */
+        if (completed) {
+            yield yield __await({ type: 'done', truncated, fullText, incompleteReason });
+        }
+        else {
+            yield yield __await({ type: 'error', message: 'Responses API stream ended without a completed event' });
+        }
+    });
+}
+// ============================================================================
+// Per-format request caller
+// ============================================================================
+/**
+ * Issues a streaming Responses API request (with tools) and returns the
+ * unified-event iterable on success.
+ *
+ * @internal
+ */
+export async function callOpenAiResponsesStream(config, prompt, tools = [], messagesBefore, temperature, logger, signal, resolvedThinking, functionCallMap, continuationMessages) {
+    var _a;
+    const url = `${config.baseUrl}/responses`;
+    const input = buildMessages(prompt.system, buildOpenAiResponsesUserContent(prompt), {
+        head: messagesBefore,
+        rawTail: continuationMessages
+    });
+    const effort = (_a = resolvedThinking === null || resolvedThinking === void 0 ? void 0 : resolvedThinking.openAiEffort) !== null && _a !== void 0 ? _a : resolvedThinking === null || resolvedThinking === void 0 ? void 0 : resolvedThinking.xaiEffort;
+    const supportsReasoning = config.model !== 'grok-4';
+    const body = {
+        model: config.model,
+        input,
+        stream: true
+    };
+    // `tools` is omitted entirely when none are requested — a Responses-only model routed
+    // here for tier/model reasons (not tools) must not send an empty tools array.
+    if (tools.length > 0) {
+        body.tools = toResponsesApiTools(tools);
+    }
+    if (effort !== undefined && supportsReasoning) {
+        body.reasoning = { effort };
+    }
+    // Temperature is sent only when the caller explicitly provided one (see callOpenAiChatStream).
+    if (effort === undefined || effort === 'none') {
+        if (temperature !== undefined) {
+            body.temperature = temperature;
+        }
+    }
+    if ((resolvedThinking === null || resolvedThinking === void 0 ? void 0 : resolvedThinking.otherParams) !== undefined) {
+        Object.assign(body, resolvedThinking.otherParams);
+    }
+    const headers = bearerAuthHeader(config.apiKey);
+    /* c8 ignore next 3 - optional logger */
+    logger === null || logger === void 0 ? void 0 : logger.info(`OpenAI Responses streaming: model=${config.model}, tools=${tools.map((t) => t.type).join(',')}`);
+    const callMap = functionCallMap !== null && functionCallMap !== void 0 ? functionCallMap : new Map();
+    const conn = await openSseConnection(url, headers, body, logger, signal);
+    return conn.onSuccess((response) => succeed(translateOpenAiResponsesStream(response, callMap, logger)));
+}
+//# sourceMappingURL=openaiResponses.js.map