@kjerneverk/execution-openai 1.0.5-dev.0

package/.kodrdriv-test-cache.json

@@ -0,0 +1,6 @@
+{
+  "/Users/tobrien/gitw/kjerneverk/execution-openai": {
+    "lastTestRun": 1768074156142,
+    "lastCommitHash": "7948ae0dfcf8860fcbcc9965dff01f047e52a5c2"
+  }
+}

package/LICENSE

@@ -0,0 +1,18 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2025 Tim O'Brien
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -0,0 +1,80 @@
+# execution-openai
+
+OpenAI provider implementation for LLM execution. Implements the `Provider` interface from the `execution` package.
+
+## Installation
+
+```bash
+npm install execution-openai openai
+```
+
+## Usage
+
+```typescript
+import { OpenAIProvider, createOpenAIProvider } from 'execution-openai';
+
+// Create provider
+const provider = createOpenAIProvider();
+
+// Or use the class directly
+const provider = new OpenAIProvider();
+
+// Execute a request
+const response = await provider.execute(
+  {
+    model: 'gpt-4o',
+    messages: [
+      { role: 'system', content: 'You are helpful.' },
+      { role: 'user', content: 'Hello!' }
+    ],
+    addMessage: () => {},
+  },
+  {
+    apiKey: process.env.OPENAI_API_KEY,
+    temperature: 0.7,
+    maxTokens: 1000,
+  }
+);
+
+console.log(response.content);
+console.log(response.usage); // { inputTokens: X, outputTokens: Y }
+```
+
+## Supported Models
+
+The provider supports all OpenAI models:
+- GPT-4 family (gpt-4, gpt-4o, gpt-4-turbo, etc.)
+- O-series (o1, o1-preview, o1-mini, o3, etc.)
+- GPT-3.5 family
+
+## API Key
+
+Set via:
+1. `options.apiKey` parameter
+2. `OPENAI_API_KEY` environment variable
+
+## Response Format
+
+```typescript
+interface ProviderResponse {
+  content: string;
+  model: string;
+  usage?: {
+    inputTokens: number;
+    outputTokens: number;
+  };
+  toolCalls?: ToolCall[];
+}
+```
+
+## Related Packages
+
+- `execution` - Core interfaces (no SDK dependencies)
+- `execution-anthropic` - Anthropic provider
+- `execution-gemini` - Google Gemini provider
+
+## License
+
+Apache-2.0
+
+<!-- v1.0.0 -->

package/dist/index.d.ts

@@ -0,0 +1,85 @@
+/**
+ * Execution OpenAI Package
+ *
+ * OpenAI provider implementation for LLM execution.
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * Create a new OpenAI provider instance
+ */
+export declare function createOpenAIProvider(): OpenAIProvider;
+
+export declare interface ExecutionOptions {
+    apiKey?: string;
+    model?: string;
+    temperature?: number;
+    maxTokens?: number;
+    timeout?: number;
+    retries?: number;
+}
+
+export declare interface Message {
+    role: 'user' | 'assistant' | 'system' | 'developer' | 'tool';
+    content: string | string[] | null;
+    name?: string;
+}
+
+export declare type Model = string;
+
+/**
+ * OpenAI Provider implementation
+ */
+declare class OpenAIProvider implements Provider {
+    readonly name = "openai";
+    /**
+     * Check if this provider supports a given model
+     */
+    supportsModel(model: Model): boolean;
+    /**
+     * Execute a request against OpenAI
+     */
+    execute(request: Request_2, options?: ExecutionOptions): Promise<ProviderResponse>;
+}
+export { OpenAIProvider }
+export default OpenAIProvider;
+
+export declare interface Provider {
+    readonly name: string;
+    execute(request: Request_2, options?: ExecutionOptions): Promise<ProviderResponse>;
+    supportsModel?(model: Model): boolean;
+}
+
+export declare interface ProviderResponse {
+    content: string;
+    model: string;
+    usage?: {
+        inputTokens: number;
+        outputTokens: number;
+    };
+    toolCalls?: Array<{
+        id: string;
+        type: 'function';
+        function: {
+            name: string;
+            arguments: string;
+        };
+    }>;
+}
+
+declare interface Request_2 {
+    messages: Message[];
+    model: Model;
+    responseFormat?: any;
+    validator?: any;
+    addMessage(message: Message): void;
+}
+export { Request_2 as Request }
+
+/**
+ * Package version
+ */
+export declare const VERSION = "0.0.1";
+
+export { }

package/dist/index.js

@@ -0,0 +1,103 @@
+import OpenAI from "openai";
+import { getRedactor } from "@utilarium/offrecord";
+import { configureErrorSanitizer, configureSecretGuard, createSafeError } from "@utilarium/spotclean";
+const redactor = getRedactor();
+redactor.register({
+  name: "openai",
+  patterns: [
+    /sk-[a-zA-Z0-9]{20,}/g,
+    /sk-proj-[a-zA-Z0-9_-]+/g
+  ],
+  validator: (key) => /^sk-(proj-)?[a-zA-Z0-9_-]{20,}$/.test(key),
+  envVar: "OPENAI_API_KEY",
+  description: "OpenAI API keys"
+});
+configureErrorSanitizer({
+  enabled: true,
+  environment: process.env.NODE_ENV === "production" ? "production" : "development",
+  includeCorrelationId: true,
+  sanitizeStackTraces: process.env.NODE_ENV === "production",
+  maxMessageLength: 500
+});
+configureSecretGuard({
+  enabled: true,
+  redactionText: "[REDACTED]",
+  preservePartial: false,
+  preserveLength: 0,
+  customPatterns: [
+    { name: "openai", pattern: /sk-[a-zA-Z0-9]{20,}/g, description: "OpenAI API key" },
+    { name: "openai-proj", pattern: /sk-proj-[a-zA-Z0-9_-]+/g, description: "OpenAI project key" }
+  ]
+});
+class OpenAIProvider {
+  name = "openai";
+  /**
+   * Check if this provider supports a given model
+   */
+  supportsModel(model) {
+    if (!model) return true;
+    return model.startsWith("gpt") || model.startsWith("o1") || model.startsWith("o3") || model.startsWith("o4");
+  }
+  /**
+   * Execute a request against OpenAI
+   */
+  async execute(request, options = {}) {
+    const apiKey = options.apiKey || process.env.OPENAI_API_KEY;
+    if (!apiKey) {
+      throw new Error("OpenAI API key is required. Set OPENAI_API_KEY environment variable.");
+    }
+    const validation = redactor.validateKey(apiKey, "openai");
+    if (!validation.valid) {
+      throw new Error("Invalid OpenAI API key format");
+    }
+    try {
+      const client = new OpenAI({ apiKey });
+      const model = options.model || request.model || "gpt-4";
+      const messages = request.messages.map((msg) => {
+        const role = msg.role === "developer" ? "system" : msg.role;
+        return {
+          role,
+          content: typeof msg.content === "string" ? msg.content : JSON.stringify(msg.content),
+          name: msg.name
+        };
+      });
+      const response = await client.chat.completions.create({
+        model,
+        messages,
+        temperature: options.temperature,
+        max_tokens: options.maxTokens,
+        response_format: request.responseFormat
+      });
+      const choice = response.choices[0];
+      return {
+        content: choice.message.content || "",
+        model: response.model,
+        usage: response.usage ? {
+          inputTokens: response.usage.prompt_tokens,
+          outputTokens: response.usage.completion_tokens
+        } : void 0,
+        toolCalls: choice.message.tool_calls?.filter((tc) => tc.type === "function").map((tc) => ({
+          id: tc.id,
+          type: "function",
+          function: {
+            name: tc.function.name,
+            arguments: tc.function.arguments
+          }
+        }))
+      };
+    } catch (error) {
+      throw createSafeError(error, { provider: "openai" });
+    }
+  }
+}
+function createOpenAIProvider() {
+  return new OpenAIProvider();
+}
+const VERSION = "0.0.1";
+export {
+  OpenAIProvider,
+  VERSION,
+  createOpenAIProvider,
+  OpenAIProvider as default
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["/**\n * Execution OpenAI Package\n *\n * OpenAI provider implementation for LLM execution.\n *\n * @packageDocumentation\n */\n\nimport OpenAI from 'openai';\nimport { getRedactor } from '@utilarium/offrecord';\nimport { \n    createSafeError, \n    configureErrorSanitizer,\n    configureSecretGuard,\n} from '@utilarium/spotclean';\n\n// Register OpenAI API key patterns on module load\nconst redactor = getRedactor();\nredactor.register({\n    name: 'openai',\n    patterns: [\n        /sk-[a-zA-Z0-9]{20,}/g,\n        /sk-proj-[a-zA-Z0-9_-]+/g,\n    ],\n    validator: (key: string) => /^sk-(proj-)?[a-zA-Z0-9_-]{20,}$/.test(key),\n    envVar: 'OPENAI_API_KEY',\n    description: 'OpenAI API keys',\n});\n\n// Configure spotclean for error sanitization\nconfigureErrorSanitizer({\n    enabled: true,\n    environment: process.env.NODE_ENV === 'production' ? 'production' : 'development',\n    includeCorrelationId: true,\n    sanitizeStackTraces: process.env.NODE_ENV === 'production',\n    maxMessageLength: 500,\n});\n\nconfigureSecretGuard({\n    enabled: true,\n    redactionText: '[REDACTED]',\n    preservePartial: false,\n    preserveLength: 0,\n    customPatterns: [\n        { name: 'openai', pattern: /sk-[a-zA-Z0-9]{20,}/g, description: 'OpenAI API key' },\n        { name: 'openai-proj', pattern: /sk-proj-[a-zA-Z0-9_-]+/g, description: 'OpenAI project key' },\n    ],\n});\n\n// ===== INLINE TYPES (from 'execution' package) =====\n// These types are duplicated here for build independence.\n// When 'execution' is published, these can be imported from there.\n\nexport type Model = string;\n\nexport interface Message {\n    role: 'user' | 'assistant' | 'system' | 'developer' | 'tool';\n    content: string | string[] | null;\n    name?: string;\n}\n\nexport interface Request {\n    messages: Message[];\n    model: Model;\n    responseFormat?: any;\n    validator?: any;\n    addMessage(message: Message): void;\n}\n\nexport interface ProviderResponse {\n    content: string;\n    model: string;\n    usage?: {\n        inputTokens: number;\n        outputTokens: number;\n    };\n    toolCalls?: Array<{\n        id: string;\n        type: 'function';\n        function: {\n            name: string;\n            arguments: string;\n        };\n    }>;\n}\n\nexport interface ExecutionOptions {\n    apiKey?: string;\n    model?: string;\n    temperature?: number;\n    maxTokens?: number;\n    timeout?: number;\n    retries?: number;\n}\n\nexport interface Provider {\n    readonly name: string;\n    execute(request: Request, options?: ExecutionOptions): Promise<ProviderResponse>;\n    supportsModel?(model: Model): boolean;\n}\n\n/**\n * OpenAI Provider implementation\n */\nexport class OpenAIProvider implements Provider {\n    readonly name = 'openai';\n\n    /**\n     * Check if this provider supports a given model\n     */\n    supportsModel(model: Model): boolean {\n        if (!model) return true; // Default to OpenAI\n        return (\n            model.startsWith('gpt') ||\n            model.startsWith('o1') ||\n            model.startsWith('o3') ||\n            model.startsWith('o4')\n        );\n    }\n\n    /**\n     * Execute a request against OpenAI\n     */\n    async execute(\n        request: Request,\n        options: ExecutionOptions = {}\n    ): Promise<ProviderResponse> {\n        const apiKey = options.apiKey || process.env.OPENAI_API_KEY;\n        \n        if (!apiKey) {\n            throw new Error('OpenAI API key is required. Set OPENAI_API_KEY environment variable.');\n        }\n\n        // Validate key format\n        const validation = redactor.validateKey(apiKey, 'openai');\n        if (!validation.valid) {\n            throw new Error('Invalid OpenAI API key format');\n        }\n\n        try {\n            const client = new OpenAI({ apiKey });\n\n            const model = options.model || request.model || 'gpt-4';\n\n            // Convert messages to OpenAI format\n            const messages = request.messages.map((msg) => {\n                const role =\n                    msg.role === 'developer' ? 'system' : msg.role;\n\n                return {\n                    role: role,\n                    content:\n                        typeof msg.content === 'string'\n                            ? msg.content\n                            : JSON.stringify(msg.content),\n                    name: msg.name,\n                } as any;\n            });\n\n            const response = await client.chat.completions.create({\n                model: model,\n                messages: messages,\n                temperature: options.temperature,\n                max_tokens: options.maxTokens,\n                response_format: request.responseFormat,\n            });\n\n            const choice = response.choices[0];\n\n            return {\n                content: choice.message.content || '',\n                model: response.model,\n                usage: response.usage\n                    ? {\n                        inputTokens: response.usage.prompt_tokens,\n                        outputTokens: response.usage.completion_tokens,\n                    }\n                    : undefined,\n                toolCalls: choice.message.tool_calls\n                    ?.filter((tc) => tc.type === 'function')\n                    .map((tc) => ({\n                        id: tc.id,\n                        type: 'function' as const,\n                        function: {\n                            name: (tc as any).function.name,\n                            arguments: (tc as any).function.arguments,\n                        },\n                    })),\n            };\n        } catch (error) {\n            // Sanitize error to remove any API keys from error messages\n            // Use spotclean for comprehensive error sanitization\n            throw createSafeError(error as Error, { provider: 'openai' });\n        }\n    }\n}\n\n/**\n * Create a new OpenAI provider instance\n */\nexport function createOpenAIProvider(): OpenAIProvider {\n    return new OpenAIProvider();\n}\n\n/**\n * Package version\n */\nexport const VERSION = '0.0.1';\n\nexport default OpenAIProvider;\n"],"names":[],"mappings":";;;AAiBA,MAAM,WAAW,YAAA;AACjB,SAAS,SAAS;AAAA,EACd,MAAM;AAAA,EACN,UAAU;AAAA,IACN;AAAA,IACA;AAAA,EAAA;AAAA,EAEJ,WAAW,CAAC,QAAgB,kCAAkC,KAAK,GAAG;AAAA,EACtE,QAAQ;AAAA,EACR,aAAa;AACjB,CAAC;AAGD,wBAAwB;AAAA,EACpB,SAAS;AAAA,EACT,aAAa,QAAQ,IAAI,aAAa,eAAe,eAAe;AAAA,EACpE,sBAAsB;AAAA,EACtB,qBAAqB,QAAQ,IAAI,aAAa;AAAA,EAC9C,kBAAkB;AACtB,CAAC;AAED,qBAAqB;AAAA,EACjB,SAAS;AAAA,EACT,eAAe;AAAA,EACf,iBAAiB;AAAA,EACjB,gBAAgB;AAAA,EAChB,gBAAgB;AAAA,IACZ,EAAE,MAAM,UAAU,SAAS,wBAAwB,aAAa,iBAAA;AAAA,IAChE,EAAE,MAAM,eAAe,SAAS,2BAA2B,aAAa,qBAAA;AAAA,EAAqB;AAErG,CAAC;AAyDM,MAAM,eAAmC;AAAA,EACnC,OAAO;AAAA;AAAA;AAAA;AAAA,EAKhB,cAAc,OAAuB;AACjC,QAAI,CAAC,MAAO,QAAO;AACnB,WACI,MAAM,WAAW,KAAK,KACtB,MAAM,WAAW,IAAI,KACrB,MAAM,WAAW,IAAI,KACrB,MAAM,WAAW,IAAI;AAAA,EAE7B;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,QACF,SACA,UAA4B,IACH;AACzB,UAAM,SAAS,QAAQ,UAAU,QAAQ,IAAI;AAE7C,QAAI,CAAC,QAAQ;AACT,YAAM,IAAI,MAAM,sEAAsE;AAAA,IAC1F;AAGA,UAAM,aAAa,SAAS,YAAY,QAAQ,QAAQ;AACxD,QAAI,CAAC,WAAW,OAAO;AACnB,YAAM,IAAI,MAAM,+BAA+B;AAAA,IACnD;AAEA,QAAI;AACA,YAAM,SAAS,IAAI,OAAO,EAAE,QAAQ;AAEpC,YAAM,QAAQ,QAAQ,SAAS,QAAQ,SAAS;AAGhD,YAAM,WAAW,QAAQ,SAAS,IAAI,CAAC,QAAQ;AAC3C,cAAM,OACF,IAAI,SAAS,cAAc,WAAW,IAAI;AAE9C,eAAO;AAAA,UACH;AAAA,UACA,SACI,OAAO,IAAI,YAAY,WACjB,IAAI,UACJ,KAAK,UAAU,IAAI,OAAO;AAAA,UACpC,MAAM,IAAI;AAAA,QAAA;AAAA,MAElB,CAAC;AAED,YAAM,WAAW,MAAM,OAAO,KAAK,YAAY,OAAO;AAAA,QAClD;AAAA,QACA;AAAA,QACA,aAAa,QAAQ;AAAA,QACrB,YAAY,QAAQ;AAAA,QACpB,iBAAiB,QAAQ;AAAA,MAAA,CAC5B;AAED,YAAM,SAAS,SAAS,QAAQ,CAAC;AAEjC,aAAO;AAAA,QACH,SAAS,OAAO,QAAQ,WAAW;AAAA,QACnC,OAAO,SAAS;AAAA,QAChB,OAAO,SAAS,QACV;AAAA,UACE,aAAa,SAAS,MAAM;AAAA,UAC5B,cAAc,SAAS,MAAM;AAAA,QAAA,IAE/B;AAAA,QACN,WAAW,OAAO,QAAQ,YACpB,OAAO,CAAC,OAAO,GAAG,SAAS,UAAU,EACtC,IAAI,CAAC,QAAQ;AAAA,UACV,IAAI,GAAG;AAAA,UACP,MAAM;AAAA,UACN,UAAU;AAAA,YACN,MAAO,GAAW,SAAS;AAAA,YAC3B,WAAY,GAAW,SAAS;AAAA,UAAA;AAAA,QACpC,EACF;AAAA,MAAA;AAAA,IAEd,SAAS,OAAO;AAGZ,YAAM,gBAAgB,OAAgB,EAAE,UAAU,UAAU;AAAA,IAChE;AAAA,EACJ;AACJ;AAKO,SAAS,uBAAuC;AACnD,SAAO,IAAI,eAAA;AACf;AAKO,MAAM,UAAU;"}