@workglow/openai 0.4.9 → 0.5.0

package/dist/web-search/OpenAiWebSearchProvider.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @license
+ * Copyright 2026 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { IExecuteContext } from "@workglow/task-graph";
+import type { IWebSearchProvider, WebSearchCapabilities, WebSearchRequest, WebSearchResponse } from "@workglow/web-search";
+import OpenAI from "openai";
+export interface OpenAiWebSearchOptions {
+    readonly client?: OpenAI | undefined;
+    readonly apiKey?: string | undefined;
+    readonly model?: string | undefined;
+    /** How much context window the search may spend. */
+    readonly searchContextSize?: "low" | "medium" | "high" | undefined;
+}
+export declare class OpenAiWebSearchProvider implements IWebSearchProvider {
+    readonly name = "openai";
+    /** Reached through the vendor SDK, not a fetch this package owns. */
+    readonly endpoint: undefined;
+    /** The SDK carries the key; `credentialKey` never reaches this request. */
+    readonly acceptsCredentialKey = false;
+    readonly capabilities: WebSearchCapabilities;
+    private client;
+    private readonly apiKey;
+    private readonly model;
+    private readonly searchContextSize;
+    constructor(options?: OpenAiWebSearchOptions);
+    /**
+     * Built on first search, not in the constructor, so registering the provider
+     * cannot throw out of the vendor SDK on a machine that has no key yet, and a
+     * missing key reports through this repo's named error rather than the SDK's.
+     */
+    private getClient;
+    search(request: WebSearchRequest, context: IExecuteContext): Promise<WebSearchResponse>;
+}
+//# sourceMappingURL=OpenAiWebSearchProvider.d.ts.map

package/dist/web-search/OpenAiWebSearchProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenAiWebSearchProvider.d.ts","sourceRoot":"","sources":["../../src/web-search/OpenAiWebSearchProvider.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,OAAO,KAAK,EACV,kBAAkB,EAElB,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EAClB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,MAAM,MAAM,QAAQ,CAAC;AAI5B,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,oDAAoD;IACpD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;CACpE;AAQD,qBAAa,uBAAwB,YAAW,kBAAkB;IAChE,SAAgB,IAAI,YAAY;IAChC,qEAAqE;IACrE,SAAgB,QAAQ,YAAa;IACrC,2EAA2E;IAC3E,SAAgB,oBAAoB,SAAS;IAC7C,SAAgB,YAAY,EAAE,qBAAqB,CASjD;IAEF,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAqB;IAC5C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAwC;IAE1E,YAAY,OAAO,GAAE,sBAA2B,EAK/C;IAED;;;;OAIG;IACH,OAAO,CAAC,SAAS;IAWX,MAAM,CAAC,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAqE5F;CACF"}

package/dist/web-search.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @license
+ * Copyright 2026 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { OpenAiWebSearchOptions } from "./web-search/OpenAiWebSearchProvider";
+export * from "./web-search/OpenAiWebSearchProvider";
+export declare function registerOpenAiWebSearchProvider(options?: OpenAiWebSearchOptions): void;
+//# sourceMappingURL=web-search.d.ts.map

package/dist/web-search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-search.d.ts","sourceRoot":"","sources":["../src/web-search.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAGnF,cAAc,sCAAsC,CAAC;AAErD,wBAAgB,+BAA+B,CAAC,OAAO,GAAE,sBAA2B,GAAG,IAAI,CAE1F"}

package/dist/web-search.js

@@ -0,0 +1,108 @@
+// src/web-search.ts
+import { registerWebSearchProvider } from "@workglow/web-search";
+
+// src/web-search/OpenAiWebSearchProvider.ts
+import { resolveApiKey } from "@workglow/ai/provider-utils";
+import { TaskFailedError } from "@workglow/task-graph";
+import { limitResults } from "@workglow/web-search";
+import OpenAI from "openai";
+var DEFAULT_MODEL = "gpt-5.5";
+
+class OpenAiWebSearchProvider {
+  name = "openai";
+  endpoint = undefined;
+  acceptsCredentialKey = false;
+  capabilities = {
+    answer: true,
+    content: false,
+    domainFilter: "native",
+    excludeDomainFilter: false,
+    dateFilter: false,
+    maxResultsCap: undefined
+  };
+  client;
+  apiKey;
+  model;
+  searchContextSize;
+  constructor(options = {}) {
+    this.client = options.client;
+    this.apiKey = options.apiKey;
+    this.model = options.model ?? DEFAULT_MODEL;
+    this.searchContextSize = options.searchContextSize;
+  }
+  getClient() {
+    this.client ??= new OpenAI({
+      apiKey: resolveApiKey({
+        config: { api_key: this.apiKey },
+        envVar: "OPENAI_API_KEY",
+        providerLabel: "OpenAI"
+      })
+    });
+    return this.client;
+  }
+  async search(request, context) {
+    context.signal.throwIfAborted();
+    const client = this.getClient();
+    const tool = { type: "web_search" };
+    if (this.searchContextSize !== undefined)
+      tool.search_context_size = this.searchContextSize;
+    if (request.includeDomains?.length) {
+      tool.filters = { allowed_domains: [...request.includeDomains] };
+    }
+    const response = await client.responses.create({
+      model: this.model,
+      input: request.query,
+      tools: [tool]
+    }, { signal: context.signal });
+    if (!Array.isArray(response.output)) {
+      throw new TaskFailedError("OpenAiWebSearchProvider: response carried no output array.");
+    }
+    const results = [];
+    const answerParts = [];
+    const seen = new Set;
+    for (const item of response.output) {
+      if (item.type !== "message")
+        continue;
+      for (const part of item.content ?? []) {
+        if (typeof part.text === "string")
+          answerParts.push(part.text);
+        for (const annotation of part.annotations ?? []) {
+          if (annotation.type !== "url_citation" || annotation.url === undefined)
+            continue;
+          if (seen.has(annotation.url))
+            continue;
+          seen.add(annotation.url);
+          results.push({
+            title: annotation.title ?? annotation.url,
+            url: annotation.url,
+            snippet: undefined,
+            content: undefined,
+            publishedDate: undefined,
+            score: undefined,
+            favicon: undefined
+          });
+        }
+      }
+    }
+    return {
+      results: limitResults(results, request.maxResults),
+      answer: request.includeAnswer === true && answerParts.length > 0 ? answerParts.join("") : undefined,
+      query: request.query,
+      usage: {
+        inputTokens: response.usage?.input_tokens,
+        outputTokens: response.usage?.output_tokens
+      }
+    };
+  }
+}
+
+// src/web-search.ts
+function registerOpenAiWebSearchProvider(options = {}) {
+  registerWebSearchProvider(new OpenAiWebSearchProvider(options));
+}
+export {
+  OpenAiWebSearchProvider,
+  registerOpenAiWebSearchProvider
+};
+
+//# debugId=F0A7BFD02699B47064756E2164756E21

package/dist/web-search.js.map

@@ -0,0 +1,11 @@
+{
+  "version": 3,
+  "sources": ["../src/web-search.ts", "../src/web-search/OpenAiWebSearchProvider.ts"],
+  "sourcesContent": [
+    "/**\n * @license\n * Copyright 2026 Steven Roussey <sroussey@gmail.com>\n * SPDX-License-Identifier: Apache-2.0\n */\n\nimport { registerWebSearchProvider } from \"@workglow/web-search\";\nimport type { OpenAiWebSearchOptions } from \"./web-search/OpenAiWebSearchProvider\";\nimport { OpenAiWebSearchProvider } from \"./web-search/OpenAiWebSearchProvider\";\n\nexport * from \"./web-search/OpenAiWebSearchProvider\";\n\nexport function registerOpenAiWebSearchProvider(options: OpenAiWebSearchOptions = {}): void {\n  registerWebSearchProvider(new OpenAiWebSearchProvider(options));\n}\n",
+    "/**\n * @license\n * Copyright 2026 Steven Roussey <sroussey@gmail.com>\n * SPDX-License-Identifier: Apache-2.0\n */\n\nimport { resolveApiKey } from \"@workglow/ai/provider-utils\";\nimport type { IExecuteContext } from \"@workglow/task-graph\";\nimport { TaskFailedError } from \"@workglow/task-graph\";\nimport type {\n  IWebSearchProvider,\n  SearchResult,\n  WebSearchCapabilities,\n  WebSearchRequest,\n  WebSearchResponse,\n} from \"@workglow/web-search\";\nimport { limitResults } from \"@workglow/web-search\";\nimport OpenAI from \"openai\";\n\nconst DEFAULT_MODEL = \"gpt-5.5\";\n\nexport interface OpenAiWebSearchOptions {\n  readonly client?: OpenAI | undefined;\n  readonly apiKey?: string | undefined;\n  readonly model?: string | undefined;\n  /** How much context window the search may spend. */\n  readonly searchContextSize?: \"low\" | \"medium\" | \"high\" | undefined;\n}\n\ninterface UrlCitation {\n  readonly type?: string;\n  readonly url?: string;\n  readonly title?: string;\n}\n\nexport class OpenAiWebSearchProvider implements IWebSearchProvider {\n  public readonly name = \"openai\";\n  /** Reached through the vendor SDK, not a fetch this package owns. */\n  public readonly endpoint = undefined;\n  /** The SDK carries the key; `credentialKey` never reaches this request. */\n  public readonly acceptsCredentialKey = false;\n  public readonly capabilities: WebSearchCapabilities = {\n    answer: true,\n    content: false,\n    domainFilter: \"native\",\n    // `filters` carries allowed_domains only — there is no blocked equivalent,\n    // so exclusion is refused rather than accepted and quietly dropped.\n    excludeDomainFilter: false,\n    dateFilter: false,\n    maxResultsCap: undefined,\n  };\n\n  private client: OpenAI | undefined;\n  private readonly apiKey: string | undefined;\n  private readonly model: string;\n  private readonly searchContextSize: \"low\" | \"medium\" | \"high\" | undefined;\n\n  constructor(options: OpenAiWebSearchOptions = {}) {\n    this.client = options.client;\n    this.apiKey = options.apiKey;\n    this.model = options.model ?? DEFAULT_MODEL;\n    this.searchContextSize = options.searchContextSize;\n  }\n\n  /**\n   * Built on first search, not in the constructor, so registering the provider\n   * cannot throw out of the vendor SDK on a machine that has no key yet, and a\n   * missing key reports through this repo's named error rather than the SDK's.\n   */\n  private getClient(): OpenAI {\n    this.client ??= new OpenAI({\n      apiKey: resolveApiKey({\n        config: { api_key: this.apiKey },\n        envVar: \"OPENAI_API_KEY\",\n        providerLabel: \"OpenAI\",\n      }),\n    });\n    return this.client;\n  }\n\n  async search(request: WebSearchRequest, context: IExecuteContext): Promise<WebSearchResponse> {\n    context.signal.throwIfAborted();\n    const client = this.getClient();\n\n    const tool: Record<string, unknown> = { type: \"web_search\" };\n    if (this.searchContextSize !== undefined) tool.search_context_size = this.searchContextSize;\n    if (request.includeDomains?.length) {\n      tool.filters = { allowed_domains: [...request.includeDomains] };\n    }\n\n    const response = (await client.responses.create(\n      {\n        model: this.model,\n        input: request.query,\n        tools: [tool] as never,\n      } as never,\n      { signal: context.signal }\n    )) as {\n      output?: readonly {\n        type?: string;\n        content?: readonly { type?: string; text?: string; annotations?: readonly UrlCitation[] }[];\n      }[];\n      usage?: { input_tokens?: number; output_tokens?: number };\n    };\n\n    if (!Array.isArray(response.output)) {\n      throw new TaskFailedError(\"OpenAiWebSearchProvider: response carried no output array.\");\n    }\n\n    const results: SearchResult[] = [];\n    const answerParts: string[] = [];\n    const seen = new Set<string>();\n\n    for (const item of response.output) {\n      if (item.type !== \"message\") continue;\n      for (const part of item.content ?? []) {\n        if (typeof part.text === \"string\") answerParts.push(part.text);\n        for (const annotation of part.annotations ?? []) {\n          if (annotation.type !== \"url_citation\" || annotation.url === undefined) continue;\n          // One source is cited at every span it supports, so the annotation\n          // list repeats it; results are a source list, not a citation list.\n          if (seen.has(annotation.url)) continue;\n          seen.add(annotation.url);\n          results.push({\n            title: annotation.title ?? annotation.url,\n            url: annotation.url,\n            snippet: undefined,\n            content: undefined,\n            publishedDate: undefined,\n            score: undefined,\n            favicon: undefined,\n          });\n        }\n      }\n    }\n\n    return {\n      // The Responses API takes no result limit of its own — a grounded turn\n      // can cite fifteen sources for a caller who asked for three — so the\n      // bound is applied here rather than dropped.\n      results: limitResults(results, request.maxResults),\n      answer:\n        request.includeAnswer === true && answerParts.length > 0 ? answerParts.join(\"\") : undefined,\n      query: request.query,\n      usage: {\n        inputTokens: response.usage?.input_tokens,\n        outputTokens: response.usage?.output_tokens,\n      },\n    };\n  }\n}\n"
+  ],
+  "mappings": ";AAMA;;;ACAA;AAEA;AAQA;AACA;AAEA,IAAM,gBAAgB;AAAA;AAgBf,MAAM,wBAAsD;AAAA,EACjD,OAAO;AAAA,EAEP,WAAW;AAAA,EAEX,uBAAuB;AAAA,EACvB,eAAsC;AAAA,IACpD,QAAQ;AAAA,IACR,SAAS;AAAA,IACT,cAAc;AAAA,IAGd,qBAAqB;AAAA,IACrB,YAAY;AAAA,IACZ,eAAe;AAAA,EACjB;AAAA,EAEQ;AAAA,EACS;AAAA,EACA;AAAA,EACA;AAAA,EAEjB,WAAW,CAAC,UAAkC,CAAC,GAAG;AAAA,IAChD,KAAK,SAAS,QAAQ;AAAA,IACtB,KAAK,SAAS,QAAQ;AAAA,IACtB,KAAK,QAAQ,QAAQ,SAAS;AAAA,IAC9B,KAAK,oBAAoB,QAAQ;AAAA;AAAA,EAQ3B,SAAS,GAAW;AAAA,IAC1B,KAAK,WAAW,IAAI,OAAO;AAAA,MACzB,QAAQ,cAAc;AAAA,QACpB,QAAQ,EAAE,SAAS,KAAK,OAAO;AAAA,QAC/B,QAAQ;AAAA,QACR,eAAe;AAAA,MACjB,CAAC;AAAA,IACH,CAAC;AAAA,IACD,OAAO,KAAK;AAAA;AAAA,OAGR,OAAM,CAAC,SAA2B,SAAsD;AAAA,IAC5F,QAAQ,OAAO,eAAe;AAAA,IAC9B,MAAM,SAAS,KAAK,UAAU;AAAA,IAE9B,MAAM,OAAgC,EAAE,MAAM,aAAa;AAAA,IAC3D,IAAI,KAAK,sBAAsB;AAAA,MAAW,KAAK,sBAAsB,KAAK;AAAA,IAC1E,IAAI,QAAQ,gBAAgB,QAAQ;AAAA,MAClC,KAAK,UAAU,EAAE,iBAAiB,CAAC,GAAG,QAAQ,cAAc,EAAE;AAAA,IAChE;AAAA,IAEA,MAAM,WAAY,MAAM,OAAO,UAAU,OACvC;AAAA,MACE,OAAO,KAAK;AAAA,MACZ,OAAO,QAAQ;AAAA,MACf,OAAO,CAAC,IAAI;AAAA,IACd,GACA,EAAE,QAAQ,QAAQ,OAAO,CAC3B;AAAA,IAQA,IAAI,CAAC,MAAM,QAAQ,SAAS,MAAM,GAAG;AAAA,MACnC,MAAM,IAAI,gBAAgB,4DAA4D;AAAA,IACxF;AAAA,IAEA,MAAM,UAA0B,CAAC;AAAA,IACjC,MAAM,cAAwB,CAAC;AAAA,IAC/B,MAAM,OAAO,IAAI;AAAA,IAEjB,WAAW,QAAQ,SAAS,QAAQ;AAAA,MAClC,IAAI,KAAK,SAAS;AAAA,QAAW;AAAA,MAC7B,WAAW,QAAQ,KAAK,WAAW,CAAC,GAAG;AAAA,QACrC,IAAI,OAAO,KAAK,SAAS;AAAA,UAAU,YAAY,KAAK,KAAK,IAAI;AAAA,QAC7D,WAAW,cAAc,KAAK,eAAe,CAAC,GAAG;AAAA,UAC/C,IAAI,WAAW,SAAS,kBAAkB,WAAW,QAAQ;AAAA,YAAW;AAAA,UAGxE,IAAI,KAAK,IAAI,WAAW,GAAG;AAAA,YAAG;AAAA,UAC9B,KAAK,IAAI,WAAW,GAAG;AAAA,UACvB,QAAQ,KAAK;AAAA,YACX,OAAO,WAAW,SAAS,WAAW;AAAA,YACtC,KAAK,WAAW;AAAA,YAChB,SAAS;AAAA,YACT,SAAS;AAAA,YACT,eAAe;AAAA,YACf,OAAO;AAAA,YACP,SAAS;AAAA,UACX,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,IAEA,OAAO;AAAA,MAIL,SAAS,aAAa,SAAS,QAAQ,UAAU;AAAA,MACjD,QACE,QAAQ,kBAAkB,QAAQ,YAAY,SAAS,IAAI,YAAY,KAAK,EAAE,IAAI;AAAA,MACpF,OAAO,QAAQ;AAAA,MACf,OAAO;AAAA,QACL,aAAa,SAAS,OAAO;AAAA,QAC7B,cAAc,SAAS,OAAO;AAAA,MAChC;AAAA,IACF;AAAA;AAEJ;;;AD1IO,SAAS,+BAA+B,CAAC,UAAkC,CAAC,GAAS;AAAA,EAC1F,0BAA0B,IAAI,wBAAwB,OAAO,CAAC;AAAA;",
+  "debugId": "F0A7BFD02699B47064756E2164756E21",
+  "names": []
+}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@workglow/openai",
   "type": "module",
   "sideEffects": false,
-  "version": "0.4.9",
+  "version": "0.5.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -16,15 +16,16 @@
   "homepage": "https://workglow.dev",
   "scripts": {
     "watch": "concurrently -c 'auto' 'bun:watch-*'",
-    "watch-code": "bun build --watch --no-clear-screen --sourcemap=external --packages=external --root ./src --outdir ./dist ./src/ai.ts ./src/ai-runtime.ts",
+    "watch-code": "bun build --watch --no-clear-screen --sourcemap=external --packages=external --root ./src --outdir ./dist ./src/ai.ts ./src/ai-runtime.ts ./src/web-search.ts",
     "watch-browser": "bun build --watch --no-clear-screen --target=browser --sourcemap=external --packages=external --outdir ./dist ./src/ai.browser.ts ./src/ai-runtime.browser.ts",
     "watch-types": "tsc --watch --preserveWatchOutput",
     "build-package": "concurrently -c 'auto' -n 'code,browser,types' 'bun run build-code' 'bun run build-browser' 'bun run build-types'",
     "build-js": "concurrently -m 12 --timings -c 'auto' -n 'code,browser' 'bun run build-code' 'bun run build-browser'",
     "build-clean": "rm -fr dist/* tsconfig.tsbuildinfo",
-    "build-code": "bun build --sourcemap=external --packages=external --root ./src --outdir ./dist ./src/ai.ts ./src/ai-runtime.ts",
+    "build-code": "bun build --sourcemap=external --packages=external --root ./src --outdir ./dist ./src/ai.ts ./src/ai-runtime.ts ./src/web-search.ts",
     "build-browser": "bun build --target=browser --sourcemap=external --packages=external --outdir ./dist ./src/ai.browser.ts ./src/ai-runtime.browser.ts",
-    "build-types": "rm -f tsconfig.tsbuildinfo && tsc"
+    "build-types": "rm -f tsconfig.tsbuildinfo && tsc",
+    "test": "vitest run --config ../../vitest.config.ts --project openai"
   },
   "exports": {
     "./ai": {
@@ -42,6 +43,10 @@
       },
       "types": "./dist/ai-runtime.d.ts",
       "import": "./dist/ai-runtime.js"
+    },
+    "./web-search": {
+      "types": "./dist/web-search.d.ts",
+      "import": "./dist/web-search.js"
     }
   },
   "dependencies": {
@@ -50,11 +55,12 @@
     "js-tiktoken": "^1.0.21"
   },
   "peerDependencies": {
-    "@workglow/ai": "0.4.9",
-    "@workglow/job-queue": "0.4.9",
-    "@workglow/storage": "0.4.9",
-    "@workglow/task-graph": "0.4.9",
-    "@workglow/util": "0.4.9"
+    "@workglow/ai": "0.5.0",
+    "@workglow/job-queue": "0.5.0",
+    "@workglow/storage": "0.5.0",
+    "@workglow/task-graph": "0.5.0",
+    "@workglow/util": "0.5.0",
+    "@workglow/web-search": "0.5.0"
   },
   "peerDependenciesMeta": {
     "@workglow/ai": {
@@ -71,14 +77,18 @@
     },
     "@workglow/util": {
       "optional": false
+    },
+    "@workglow/web-search": {
+      "optional": true
     }
   },
   "devDependencies": {
-    "@workglow/ai": "0.4.9",
-    "@workglow/job-queue": "0.4.9",
-    "@workglow/storage": "0.4.9",
-    "@workglow/task-graph": "0.4.9",
-    "@workglow/util": "0.4.9"
+    "@workglow/ai": "0.5.0",
+    "@workglow/job-queue": "0.5.0",
+    "@workglow/storage": "0.5.0",
+    "@workglow/task-graph": "0.5.0",
+    "@workglow/util": "0.5.0",
+    "@workglow/web-search": "0.5.0"
   },
   "files": [
     "dist",