@bantai-dev/openai 1.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 Jun
+
+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,112 @@
+# @bantai-dev/openai
+
+OpenAI provider for [@bantai-dev/llm](../llm). Uses the OpenAI Responses API with optional Zod-based structured output.
+
+## Features
+
+- **OpenAI Responses API** – Uses `openai.responses.create()` for chat and structured output.
+- **Zod structured output** – Pass `outputSchema` in the LLM input; responses are validated and typed.
+- **Policy & token quotas** – Use with `generateText()` from `@bantai-dev/llm` and policies/context from core.
+
+## Installation
+
+```bash
+pnpm add @bantai-dev/openai @bantai-dev/llm openai zod
+```
+
+## Peer dependencies
+
+- `zod` ^4.3.5
+
+## Usage
+
+### Basic
+
+```ts
+import { openai } from "@bantai-dev/openai";
+import { generateText, withLLMContext } from "@bantai-dev/llm";
+import { defineContext, definePolicy } from "@bantai-dev/core";
+import { z } from "zod";
+
+const appContext = defineContext(
+  z.object({
+    userId: z.string().optional(),
+    tier: z.enum(["free", "premium"]),
+  })
+);
+
+const llmContext = withLLMContext(appContext, { storage }); // storage: see @bantai-dev/llm README
+const policy = definePolicy(llmContext, "My Policy", [/* rules */]);
+
+const provider = openai("gpt-4o");
+
+const result = await generateText({
+  provider,
+  policies: [policy],
+  input: {
+    llm: {
+      prompt: [{ role: "user", content: "Hello" }],
+      maxTokensPerRequest: 512,
+      outputSchema: z.object({ answer: z.string() }),
+    },
+    tier: "free",
+    userId: "user-1",
+  },
+});
+
+console.log(result.output); // { answer: "..." }
+console.log(result.usage);  // { inputTokens, outputTokens, totalTokens }
+```
+
+### With client options
+
+```ts
+import { openai } from "@bantai-dev/openai";
+
+const provider = openai("gpt-4o", {
+  providerOptions: {
+    apiKey: process.env.OPENAI_API_KEY,
+    // other OpenAI ClientOptions
+  },
+});
+```
+
+### Prompt formats
+
+- **String** – Converted to a single user message: `prompt: "Hello"`.
+- **Messages** – Array of `{ role: "user" | "system" | "assistant", content: string }` passed to the Responses API.
+
+## API
+
+### `openai(model, options?)`
+
+Creates an `LLMProvider` for the OpenAI Responses API.
+
+- **model** – OpenAI chat model id (e.g. `"gpt-4o"`, `"gpt-4o-mini"`). See [OpenAI models](https://platform.openai.com/docs/models).
+- **options**
+  - **providerOptions** – Optional [OpenAI ClientOptions](https://github.com/openai/openai-node#configuration) (e.g. `apiKey`, `baseURL`).
+
+Returns an adapter with:
+
+- `providerName`: `"openai"`
+- `defaultModel`: the given `model`
+- `generateText(input, options)` – Calls `openai.responses.create()` with:
+  - `input` from `convertPromptToOpenAIMessages(input.llm.prompt)`
+  - Optional `text: { format: zodTextFormat(outputSchema, "output") }` when `input.llm.outputSchema` is set
+
+### `convertPromptToOpenAIMessages(prompt)`
+
+Utility to convert the LLM prompt (string or message array) to the format expected by `openai.responses.create()` input. Re-exported for use in custom wrappers if needed.
+
+## Environment
+
+- `OPENAI_API_KEY` – Set for the OpenAI client (or pass via `providerOptions.apiKey`).
+
+## Related
+
+- [@bantai-dev/llm](../llm) – Context, token quota rules, `generateText`/`streamText`.
+- [OpenAI Node SDK](https://github.com/openai/openai-node) – Underlying client.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import * as zod from 'zod';
+import * as zod_v4_core from 'zod/v4/core';
+import { LLMProvider, WithLLMContext } from '@bantai-dev/llm';
+import { ClientOptions } from 'openai';
+import { ChatModel } from 'openai/resources/shared';
+
+type OpenAiOptions = {
+    providerOptions?: ClientOptions;
+};
+declare const openai: (model: ChatModel, options?: OpenAiOptions) => LLMProvider<WithLLMContext, unknown, zod.ZodObject<Readonly<{
+    [k: string]: zod_v4_core.$ZodType<unknown, unknown, zod_v4_core.$ZodTypeInternals<unknown, unknown>>;
+}>, zod_v4_core.$strip>, unknown>;
+
+export { type OpenAiOptions, openai };

package/dist/index.js

@@ -0,0 +1,49 @@
+import { OpenAI } from 'openai';
+import { zodTextFormat } from 'openai/helpers/zod.mjs';
+
+// src/provider.ts
+
+// src/utils.ts
+function convertPromptToOpenAIMessages(prompt) {
+  return typeof prompt === "string" ? [{ role: "user", content: prompt }] : prompt.map((p) => ({
+    role: p.role,
+    content: p.content
+  }));
+}
+
+// src/provider.ts
+var openai = (model, options) => {
+  const openaiClient = new OpenAI({
+    ...options?.providerOptions || {}
+  });
+  const adapter = {
+    providerName: "openai",
+    defaultModel: model,
+    generateText: async (input) => {
+      const messages = convertPromptToOpenAIMessages(input.llm.prompt);
+      const response = await openaiClient.responses.create({
+        model: input.llm.model || model,
+        input: messages,
+        ...input.llm.outputSchema && {
+          text: {
+            format: zodTextFormat(input.llm.outputSchema, "output")
+          }
+        }
+      });
+      return {
+        output: response.output_text,
+        usage: {
+          inputTokens: response.usage?.input_tokens || 0,
+          outputTokens: response.usage?.output_tokens || 0,
+          totalTokens: response.usage?.total_tokens || 0
+        },
+        providerResponse: response
+      };
+    }
+  };
+  return adapter;
+};
+
+export { openai };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils.ts","../src/provider.ts"],"names":[],"mappings":";;;;;;AAGO,SAAS,8BACZ,MAAA,EACa;AACb,EAAA,OAAO,OAAO,MAAA,KAAW,QAAA,GACnB,CAAC,EAAE,IAAA,EAAM,MAAA,EAAQ,OAAA,EAAS,MAAA,EAAQ,CAAA,GAClC,MAAA,CAAO,GAAA,CAAI,CAAC,CAAA,MAAO;AAAA,IACf,MAAM,CAAA,CAAE,IAAA;AAAA,IACR,SAAS,CAAA,CAAE;AAAA,GACf,CAAE,CAAA;AACZ;;;ACFO,IAAM,MAAA,GAAS,CAAC,KAAA,EAAkB,OAAA,KAA4B;AACjE,EAAA,MAAM,YAAA,GAAe,IAAI,MAAA,CAAO;AAAA,IAC5B,GAAI,OAAA,EAAS,eAAA,IAAmB;AAAC,GACpC,CAAA;AAED,EAAA,MAAM,OAAA,GAAuC;AAAA,IACzC,YAAA,EAAc,QAAA;AAAA,IACd,YAAA,EAAc,KAAA;AAAA,IACd,YAAA,EAAc,OAAO,KAAA,KAAU;AAC3B,MAAA,MAAM,QAAA,GAA0B,6BAAA,CAA8B,KAAA,CAAM,GAAA,CAAI,MAAM,CAAA;AAE9E,MAAA,MAAM,QAAA,GAAW,MAAM,YAAA,CAAa,SAAA,CAAU,MAAA,CAAO;AAAA,QACjD,KAAA,EAAO,KAAA,CAAM,GAAA,CAAI,KAAA,IAAS,KAAA;AAAA,QAC1B,KAAA,EAAO,QAAA;AAAA,QACP,GAAI,KAAA,CAAM,GAAA,CAAI,YAAA,IAAgB;AAAA,UAC1B,IAAA,EAAM;AAAA,YACF,MAAA,EAAQ,aAAA,CAAc,KAAA,CAAM,GAAA,CAAI,cAAc,QAAQ;AAAA;AAC1D;AACJ,OACH,CAAA;AAED,MAAA,OAAO;AAAA,QACH,QAAQ,QAAA,CAAS,WAAA;AAAA,QACjB,KAAA,EAAO;AAAA,UACH,WAAA,EAAa,QAAA,CAAS,KAAA,EAAO,YAAA,IAAgB,CAAA;AAAA,UAC7C,YAAA,EAAc,QAAA,CAAS,KAAA,EAAO,aAAA,IAAiB,CAAA;AAAA,UAC/C,WAAA,EAAa,QAAA,CAAS,KAAA,EAAO,YAAA,IAAgB;AAAA,SACjD;AAAA,QACA,gBAAA,EAAkB;AAAA,OACtB;AAAA,IACJ;AAAA,GACJ;AACA,EAAA,OAAO,OAAA;AACX","file":"index.js","sourcesContent":["import { LLMGenerateTextInput } from \"@bantai-dev/llm\";\nimport { ResponseInput } from \"openai/resources/responses/responses.js\";\n\nexport function convertPromptToOpenAIMessages(\n    prompt: LLMGenerateTextInput[\"prompt\"]\n): ResponseInput {\n    return typeof prompt === \"string\"\n        ? [{ role: \"user\", content: prompt }]\n        : prompt.map((p) => ({\n              role: p.role,\n              content: p.content,\n          }));\n}\n","import { LLMProvider, WithLLMContext } from \"@bantai-dev/llm\";\nimport { ClientOptions, OpenAI } from \"openai\";\nimport { zodTextFormat } from \"openai/helpers/zod.mjs\";\nimport { ResponseInput } from \"openai/resources/responses/responses.js\";\nimport { ChatModel } from \"openai/resources/shared\";\nimport { convertPromptToOpenAIMessages } from \"./utils.js\";\n\nexport type OpenAiOptions = {\n    providerOptions?: ClientOptions;\n};\nexport const openai = (model: ChatModel, options?: OpenAiOptions) => {\n    const openaiClient = new OpenAI({\n        ...(options?.providerOptions || {}),\n    });\n\n    const adapter: LLMProvider<WithLLMContext> = {\n        providerName: \"openai\",\n        defaultModel: model,\n        generateText: async (input) => {\n            const messages: ResponseInput = convertPromptToOpenAIMessages(input.llm.prompt);\n\n            const response = await openaiClient.responses.create({\n                model: input.llm.model || model,\n                input: messages,\n                ...(input.llm.outputSchema && {\n                    text: {\n                        format: zodTextFormat(input.llm.outputSchema, \"output\"),\n                    },\n                }),\n            });\n\n            return {\n                output: response.output_text,\n                usage: {\n                    inputTokens: response.usage?.input_tokens || 0,\n                    outputTokens: response.usage?.output_tokens || 0,\n                    totalTokens: response.usage?.total_tokens || 0,\n                },\n                providerResponse: response,\n            };\n        },\n    };\n    return adapter;\n};\n"]}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@bantai-dev/openai",
+  "version": "1.0.0",
+  "description": "OpenAI provider for @bantai-dev/llm",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bosquejun/bantai.git",
+    "directory": "packages/ai/openai"
+  },
+  "homepage": "https://bantai.vercel.app/",
+  "bugs": {
+    "url": "https://github.com/bosquejun/bantai/issues"
+  },
+  "keywords": [
+    "openai",
+    "openai-extension",
+    "ai",
+    "ai-extension",
+    "llm",
+    "policy-engine",
+    "policy-library",
+    "token-control",
+    "token-quota",
+    "bantai"
+  ],
+  "author": {
+    "name": "Jun",
+    "email": "bosquejun@gmail.com"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "tsconfig-paths": "^4.2.0",
+    "tsup": "^8.5.1",
+    "typescript": "5.9.2",
+    "vitest": "^2.1.8",
+    "@bantai-dev/typescript-config": "0.0.0",
+    "@bantai-dev/storage-redis": "1.2.0"
+  },
+  "dependencies": {
+    "openai": "^6.18.0",
+    "zod": "^4.3.5",
+    "@bantai-dev/core": "1.2.0",
+    "@bantai-dev/llm": "1.0.0",
+    "@bantai-dev/with-rate-limit": "1.2.0"
+  },
+  "peerDependencies": {
+    "zod": "^4.3.5"
+  },
+  "scripts": {
+    "build": "tsup",
+    "check-types": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest --coverage"
+  }
+}