@robota-sdk/agent-provider-openai 3.0.0-beta.55

package/dist/node/index.cjs

@@ -0,0 +1,2 @@
+'use strict';var C=require('openai'),agentCore=require('@robota-sdk/agent-core'),agentProviderOpenaiCompatible=require('@robota-sdk/agent-provider-openai-compatible');function _interopDefault(e){return e&&e.__esModule?e:{default:e}}var C__default=/*#__PURE__*/_interopDefault(C);var p=class{parser;constructor(e){this.parser=new agentProviderOpenaiCompatible.OpenAICompatibleResponseParser({logger:e});}parseResponse(e){try{return this.parser.parseResponse(e)}catch(t){let r=d(t instanceof Error?t.message:"OpenAI response parsing failed");throw new Error(`OpenAI response parsing failed: ${r}`)}}parseStreamingChunk(e){try{return this.parser.parseStreamingChunk(e)}catch(t){let r=d(t instanceof Error?t.message:"OpenAI chunk parsing failed");throw new Error(`OpenAI chunk parsing failed: ${r}`)}}};function d(a){return a.replace(/^OpenAI-compatible response parsing failed: /,"").replace(/^OpenAI-compatible chunk parsing failed: /,"").replace("OpenAI-compatible response","OpenAI response")}function c(a){return agentProviderOpenaiCompatible.convertToOpenAICompatibleMessages(a)}function m(a){return agentProviderOpenaiCompatible.convertToOpenAICompatibleTools(a)}var i=class extends agentCore.AbstractAIProvider{name="openai";version="1.0.0";client;options;payloadLogger;responseParser;onTextDelta;constructor(e){if(super(e.logger||agentCore.SilentLogger),this.options=e,e.executor&&(this.executor=e.executor),!this.executor)if(e.client)this.client=e.client;else if(e.apiKey)this.client=new C__default.default({apiKey:e.apiKey,...e.organization&&{organization:e.organization},...e.timeout&&{timeout:e.timeout},...e.baseURL&&{baseURL:e.baseURL}});else throw new Error("Either OpenAI client, apiKey, or executor is required");this.responseParser=new p(this.logger),this.payloadLogger=e.payloadLogger;}async chat(e,t){if(this.validateMessages(e),this.executor)try{return await this.executeViaExecutorOrDirect(e,t)}catch(r){throw this.logger.error("OpenAI Provider executor chat error:",r instanceof Error?r.message:String(r)),r}if(!this.client)throw new Error("OpenAI client not available. Either provide a client/apiKey or use an executor.");try{let r=c(e),o=t;if(!o?.model)throw new Error("Model is required in chat options. Please specify a model in defaultModel configuration.");let s={model:o.model,messages:r,...o.temperature!==void 0&&{temperature:o.temperature},...o.maxTokens&&{max_tokens:o.maxTokens},...o.tools&&{tools:m(o.tools),tool_choice:"auto"}},n=o.onTextDelta??this.onTextDelta;if(n)return await this.chatWithStreamingAssembly({...s,stream:!0},{...o,onTextDelta:n});if(this.payloadLogger?.isEnabled()){let I={model:s.model,messagesCount:r.length,hasTools:!!s.tools,temperature:s.temperature??void 0,maxTokens:s.max_tokens??void 0,timestamp:new Date().toISOString()};await this.payloadLogger.logPayload(I,"chat");}let l=await this.client.chat.completions.create(s);return this.responseParser.parseResponse(l)}catch(r){let s=r.message||"OpenAI API request failed";throw new Error(`OpenAI chat failed: ${s}`)}}async chatWithStreamingAssembly(e,t){if(!this.client)throw new Error("OpenAI client not available. Either provide a client/apiKey or use an executor.");try{if(this.payloadLogger?.isEnabled()){let o={model:e.model,messagesCount:e.messages.length,hasTools:!!e.tools,temperature:e.temperature??void 0,maxTokens:e.max_tokens??void 0,timestamp:new Date().toISOString()};await this.payloadLogger.logPayload(o,"stream");}let r=await this.client.chat.completions.create(e,t.signal?{signal:t.signal}:void 0);return agentProviderOpenaiCompatible.assembleOpenAICompatibleStream({stream:r,onTextDelta:t.onTextDelta,signal:t.signal})}catch(r){let s=r.message||"OpenAI streaming request failed";throw new Error(`OpenAI stream failed: ${s}`)}}async*chatStream(e,t){if(this.executor)try{yield*this.executeStreamViaExecutorOrDirect(e,t);return}catch(r){throw this.logger.error("OpenAI Provider executor stream error:",r instanceof Error?r.message:String(r)),r}if(!this.client)throw new Error("OpenAI client not available. Either provide a client/apiKey or use an executor.");try{let r=c(e);if(!t?.model)throw new Error("Model is required in chat options. Please specify a model in defaultModel configuration.");let o={model:t.model,messages:r,stream:!0,...t?.temperature!==void 0&&{temperature:t.temperature},...t?.maxTokens&&{max_tokens:t.maxTokens},...t?.tools&&{tools:m(t.tools),tool_choice:"auto"}};if(this.payloadLogger?.isEnabled()){let n={model:o.model,messagesCount:r.length,hasTools:!!o.tools,temperature:o.temperature??void 0,maxTokens:o.max_tokens??void 0,timestamp:new Date().toISOString()};await this.payloadLogger.logPayload(n,"stream");}let s=await this.client.chat.completions.create(o);for await(let n of s){let l=this.responseParser.parseStreamingChunk(n);l&&(yield l);}}catch(r){let s=r.message||"OpenAI API request failed";throw new Error(`OpenAI stream failed: ${s}`)}}supportsTools(){return  true}validateConfig(){return !!this.client&&!!this.options}async dispose(){}validateMessages(e){super.validateMessages(e);for(let t of e)if(t.role==="assistant"){let r=t;if(r.toolCalls&&r.toolCalls.length>0&&r.content==="")continue}}};var g=class{static filterMessagesForOpenAI(e){return e.filter(t=>t.role==="user"||t.role==="assistant"||t.role==="system"?true:t.role==="tool"?!!(t.toolCallId&&t.toolCallId.trim()!==""&&t.toolCallId!=="unknown"):false)}static toOpenAIFormat(e){return this.filterMessagesForOpenAI(e).map(r=>this.convertMessage(r))}static convertMessage(e){let t=e.role;if(t==="user")return {role:"user",content:e.content};if(t==="assistant"){let o=e;return o.toolCalls&&o.toolCalls.length>0?{role:"assistant",content:o.content===""?null:o.content||null,tool_calls:o.toolCalls.map(n=>({id:n.id,type:"function",function:{name:n.function.name,arguments:n.function.arguments}}))}:{role:"assistant",content:o.content===null||o.content===""?null:o.content||""}}if(t==="system")return {role:"system",content:e.content};if(t==="tool"){if(!e.toolCallId||e.toolCallId.trim()==="")throw new Error(`Tool message missing toolCallId: ${JSON.stringify(e)}`);return {role:"tool",content:e.content,tool_call_id:e.toolCallId}}let r=t;throw new Error(`Unsupported message role: ${r}`)}static addSystemPromptIfNeeded(e,t){return !t||e.some(o=>o.role==="system")?e:[{role:"system",content:t},...e]}};var N=void 0,h="lm-studio",f="http://localhost:1234/v1";function z(){return {type:"openai",defaults:{apiKey:h,baseURL:f},setupSteps:[{key:"baseURL",title:"OpenAI-compatible base URL",defaultValue:f},{key:"model",title:"OpenAI-compatible model",required:true},{key:"apiKey",title:"OpenAI-compatible API key",defaultValue:h,masked:true}],requiresApiKey:true,probeProfile:agentProviderOpenaiCompatible.probeOpenAICompatibleProfile,createProvider:a=>new i({apiKey:x(a.apiKey),...a.baseURL!==void 0&&{baseURL:a.baseURL},...a.timeout!==void 0&&{timeout:a.timeout},defaultModel:a.model})}}function x(a){if(!a)throw new Error("Provider openai requires apiKey");return a}
+exports.DEFAULT_OPENAI_COMPATIBLE_PROVIDER_API_KEY=h;exports.DEFAULT_OPENAI_COMPATIBLE_PROVIDER_BASE_URL=f;exports.DEFAULT_OPENAI_PROVIDER_MODEL=N;exports.OpenAIConversationAdapter=g;exports.OpenAIProvider=i;exports.createOpenAIProviderDefinition=z;

package/dist/node/index.d.cts

@@ -0,0 +1,239 @@
+import OpenAI from 'openai';
+import { ILogger, IExecutor, TProviderOptionValueBase, AbstractAIProvider, TTextDeltaCallback, TUniversalMessage, IChatOptions, IProviderDefinition } from '@robota-sdk/agent-core';
+
+/**
+ * Payload logging data structure
+ */
+interface IOpenAILogData {
+    model: string;
+    messagesCount: number;
+    hasTools: boolean;
+    temperature?: number | undefined;
+    maxTokens?: number | undefined;
+    timestamp: string;
+    requestId?: string | undefined;
+}
+
+/**
+ * IPayloadLogger interface for logging OpenAI API payloads
+ *
+ * This interface provides a contract for different logging implementations:
+ * - FilePayloadLogger: Node.js file-based logging
+ * - ConsolePayloadLogger: Browser console-based logging
+ * - Custom implementations: User-defined loggers
+ */
+interface IPayloadLogger {
+    /**
+     * Check if logging is enabled
+     * @returns true if logging is active, false otherwise
+     */
+    isEnabled(): boolean;
+    /**
+     * Log API payload data
+     * @param payload - The API request/response payload data
+     * @param type - Type of operation ('chat' or 'stream')
+     */
+    logPayload(payload: IOpenAILogData, type: 'chat' | 'stream'): Promise<void>;
+}
+/**
+ * Configuration options for payload loggers
+ */
+interface IPayloadLoggerOptions {
+    /**
+     * Whether logging is enabled
+     * @defaultValue true
+     */
+    enabled?: boolean;
+    /**
+     * Include timestamp in log entries
+     * @defaultValue true
+     */
+    includeTimestamp?: boolean;
+    /**
+     * Logger instance for console output
+     * @defaultValue SilentLogger
+     */
+    logger?: ILogger;
+}
+
+/**
+ * Valid provider option value types
+ */
+type TOpenAIProviderOptionValue = string | number | boolean | undefined | null | OpenAI | IPayloadLogger | ILogger | IExecutor | TProviderOptionValueBase | TOpenAIProviderOptionValue[] | {
+    [key: string]: TOpenAIProviderOptionValue;
+};
+/**
+ * OpenAI provider options
+ */
+interface IOpenAIProviderOptions {
+    /**
+     * Additional provider-specific options
+     */
+    [key: string]: TOpenAIProviderOptionValue;
+    /**
+     * OpenAI API key (required when client is not provided)
+     */
+    apiKey?: string;
+    /**
+     * OpenAI organization ID (optional)
+     */
+    organization?: string;
+    /**
+     * API request timeout (milliseconds)
+     */
+    timeout?: number;
+    /**
+     * API base URL (default: 'https://api.openai.com/v1')
+     */
+    baseURL?: string;
+    /**
+     * Response format (default: 'text')
+     * - 'text': Plain text response
+     * - 'json_object': JSON object mode (requires system message)
+     * - 'json_schema': Structured Outputs with schema validation
+     */
+    responseFormat?: 'text' | 'json_object' | 'json_schema';
+    /**
+     * JSON schema for structured outputs (required when responseFormat is 'json_schema')
+     */
+    jsonSchema?: {
+        name: string;
+        description?: string;
+        schema?: Record<string, TOpenAIProviderOptionValue>;
+        strict?: boolean;
+    };
+    /**
+     * OpenAI client instance (optional: will be created from apiKey if not provided)
+     */
+    client?: OpenAI;
+    /**
+     * Payload logger instance for debugging API requests/responses
+     *
+     * Use different implementations based on your environment:
+     * - FilePayloadLogger: Node.js file-based logging
+     * - ConsolePayloadLogger: Browser console-based logging
+     * - Custom: Implement IPayloadLogger interface
+     *
+     * @example
+     * ```typescript
+     * // Node.js
+     * import { FilePayloadLogger } from '@robota-sdk/agent-provider-openai/loggers/file';
+     * const provider = new OpenAIProvider({
+     *   client: openaiClient,
+     *   payloadLogger: new FilePayloadLogger({ logDir: './logs/openai' })
+     * });
+     *
+     * // Browser
+     * import { ConsolePayloadLogger } from '@robota-sdk/agent-provider-openai/loggers/console';
+     * const provider = new OpenAIProvider({
+     *   client: openaiClient,
+     *   payloadLogger: new ConsolePayloadLogger()
+     * });
+     * ```
+     */
+    payloadLogger?: IPayloadLogger;
+    /**
+     * Optional executor for handling AI requests
+     *
+     * When provided, the provider will delegate all chat operations to this executor
+     * instead of making direct API calls. This enables remote execution capabilities.
+     *
+     * @example
+     * ```typescript
+     * import { LocalExecutor, RemoteExecutor } from '@robota-sdk/agent-core';
+     *
+     * // Local execution (registers this provider)
+     * const localExecutor = new LocalExecutor();
+     * localExecutor.registerProvider('openai', new OpenAIProvider({ apiKey: 'sk-...' }));
+     *
+     * // Remote execution
+     * const remoteExecutor = new RemoteExecutor({
+     *   serverUrl: 'https://api.robota.io',
+     *   userApiKey: 'user-token-123'
+     * });
+     *
+     * const provider = new OpenAIProvider({
+     *   executor: remoteExecutor // No direct API key needed
+     * });
+     * ```
+     */
+    executor?: IExecutor;
+    /**
+     * Logger instance for internal OpenAI provider logging
+     * @defaultValue SilentLogger
+     */
+    logger?: ILogger;
+}
+
+/**
+ * OpenAI provider implementation for Robota
+ *
+ * Provides integration with OpenAI's GPT models following BaseAIProvider guidelines.
+ * Uses OpenAI SDK native types internally for optimal performance and feature support.
+ *
+ * @public
+ */
+declare class OpenAIProvider extends AbstractAIProvider {
+    readonly name = "openai";
+    readonly version = "1.0.0";
+    private readonly client?;
+    private readonly options;
+    private readonly payloadLogger;
+    private readonly responseParser;
+    /**
+     * Optional callback for text deltas during streaming.
+     * Set by the consumer (e.g., Session) to receive real-time text chunks.
+     * When set, chat() uses streaming internally while still returning
+     * the complete assembled message.
+     */
+    onTextDelta?: TTextDeltaCallback;
+    constructor(options: IOpenAIProviderOptions);
+    chat(messages: TUniversalMessage[], options?: IChatOptions): Promise<TUniversalMessage>;
+    private chatWithStreamingAssembly;
+    chatStream(messages: TUniversalMessage[], options?: IChatOptions): AsyncIterable<TUniversalMessage>;
+    supportsTools(): boolean;
+    validateConfig(): boolean;
+    dispose(): Promise<void>;
+    protected validateMessages(messages: TUniversalMessage[]): void;
+}
+
+/**
+ * OpenAI Conversation Adapter
+ *
+ * Converts between TUniversalMessage format and OpenAI native types.
+ * Provides bidirectional conversion for seamless integration.
+ *
+ * @public
+ */
+declare class OpenAIConversationAdapter {
+    /**
+     * Filter messages for OpenAI compatibility
+     *
+     * OpenAI has specific requirements:
+     * - Tool messages must have valid toolCallId
+     * - Messages must be in proper sequence
+     * - Tool messages without toolCallId should be excluded
+     */
+    static filterMessagesForOpenAI(messages: TUniversalMessage[]): TUniversalMessage[];
+    /**
+     * Convert TUniversalMessage array to OpenAI message format
+     * Now properly handles tool messages for OpenAI's tool calling feature
+     */
+    static toOpenAIFormat(messages: TUniversalMessage[]): OpenAI.Chat.ChatCompletionMessageParam[];
+    /**
+     * Convert a single TUniversalMessage to OpenAI format
+     * Handles all message types including tool messages
+     */
+    static convertMessage(msg: TUniversalMessage): OpenAI.Chat.ChatCompletionMessageParam;
+    /**
+     * Add system prompt to message array if needed
+     */
+    static addSystemPromptIfNeeded(messages: OpenAI.Chat.ChatCompletionMessageParam[], systemPrompt?: string): OpenAI.Chat.ChatCompletionMessageParam[];
+}
+
+declare const DEFAULT_OPENAI_PROVIDER_MODEL: string | undefined;
+declare const DEFAULT_OPENAI_COMPATIBLE_PROVIDER_API_KEY = "lm-studio";
+declare const DEFAULT_OPENAI_COMPATIBLE_PROVIDER_BASE_URL = "http://localhost:1234/v1";
+declare function createOpenAIProviderDefinition(): IProviderDefinition;
+
+export { DEFAULT_OPENAI_COMPATIBLE_PROVIDER_API_KEY, DEFAULT_OPENAI_COMPATIBLE_PROVIDER_BASE_URL, DEFAULT_OPENAI_PROVIDER_MODEL, type IOpenAIProviderOptions, type IPayloadLogger, type IPayloadLoggerOptions, OpenAIConversationAdapter, OpenAIProvider, type TOpenAIProviderOptionValue, createOpenAIProviderDefinition };

package/dist/node/index.d.ts

@@ -0,0 +1,239 @@
+import OpenAI from 'openai';
+import { ILogger, IExecutor, TProviderOptionValueBase, AbstractAIProvider, TTextDeltaCallback, TUniversalMessage, IChatOptions, IProviderDefinition } from '@robota-sdk/agent-core';
+
+/**
+ * Payload logging data structure
+ */
+interface IOpenAILogData {
+    model: string;
+    messagesCount: number;
+    hasTools: boolean;
+    temperature?: number | undefined;
+    maxTokens?: number | undefined;
+    timestamp: string;
+    requestId?: string | undefined;
+}
+
+/**
+ * IPayloadLogger interface for logging OpenAI API payloads
+ *
+ * This interface provides a contract for different logging implementations:
+ * - FilePayloadLogger: Node.js file-based logging
+ * - ConsolePayloadLogger: Browser console-based logging
+ * - Custom implementations: User-defined loggers
+ */
+interface IPayloadLogger {
+    /**
+     * Check if logging is enabled
+     * @returns true if logging is active, false otherwise
+     */
+    isEnabled(): boolean;
+    /**
+     * Log API payload data
+     * @param payload - The API request/response payload data
+     * @param type - Type of operation ('chat' or 'stream')
+     */
+    logPayload(payload: IOpenAILogData, type: 'chat' | 'stream'): Promise<void>;
+}
+/**
+ * Configuration options for payload loggers
+ */
+interface IPayloadLoggerOptions {
+    /**
+     * Whether logging is enabled
+     * @defaultValue true
+     */
+    enabled?: boolean;
+    /**
+     * Include timestamp in log entries
+     * @defaultValue true
+     */
+    includeTimestamp?: boolean;
+    /**
+     * Logger instance for console output
+     * @defaultValue SilentLogger
+     */
+    logger?: ILogger;
+}
+
+/**
+ * Valid provider option value types
+ */
+type TOpenAIProviderOptionValue = string | number | boolean | undefined | null | OpenAI | IPayloadLogger | ILogger | IExecutor | TProviderOptionValueBase | TOpenAIProviderOptionValue[] | {
+    [key: string]: TOpenAIProviderOptionValue;
+};
+/**
+ * OpenAI provider options
+ */
+interface IOpenAIProviderOptions {
+    /**
+     * Additional provider-specific options
+     */
+    [key: string]: TOpenAIProviderOptionValue;
+    /**
+     * OpenAI API key (required when client is not provided)
+     */
+    apiKey?: string;
+    /**
+     * OpenAI organization ID (optional)
+     */
+    organization?: string;
+    /**
+     * API request timeout (milliseconds)
+     */
+    timeout?: number;
+    /**
+     * API base URL (default: 'https://api.openai.com/v1')
+     */
+    baseURL?: string;
+    /**
+     * Response format (default: 'text')
+     * - 'text': Plain text response
+     * - 'json_object': JSON object mode (requires system message)
+     * - 'json_schema': Structured Outputs with schema validation
+     */
+    responseFormat?: 'text' | 'json_object' | 'json_schema';
+    /**
+     * JSON schema for structured outputs (required when responseFormat is 'json_schema')
+     */
+    jsonSchema?: {
+        name: string;
+        description?: string;
+        schema?: Record<string, TOpenAIProviderOptionValue>;
+        strict?: boolean;
+    };
+    /**
+     * OpenAI client instance (optional: will be created from apiKey if not provided)
+     */
+    client?: OpenAI;
+    /**
+     * Payload logger instance for debugging API requests/responses
+     *
+     * Use different implementations based on your environment:
+     * - FilePayloadLogger: Node.js file-based logging
+     * - ConsolePayloadLogger: Browser console-based logging
+     * - Custom: Implement IPayloadLogger interface
+     *
+     * @example
+     * ```typescript
+     * // Node.js
+     * import { FilePayloadLogger } from '@robota-sdk/agent-provider-openai/loggers/file';
+     * const provider = new OpenAIProvider({
+     *   client: openaiClient,
+     *   payloadLogger: new FilePayloadLogger({ logDir: './logs/openai' })
+     * });
+     *
+     * // Browser
+     * import { ConsolePayloadLogger } from '@robota-sdk/agent-provider-openai/loggers/console';
+     * const provider = new OpenAIProvider({
+     *   client: openaiClient,
+     *   payloadLogger: new ConsolePayloadLogger()
+     * });
+     * ```
+     */
+    payloadLogger?: IPayloadLogger;
+    /**
+     * Optional executor for handling AI requests
+     *
+     * When provided, the provider will delegate all chat operations to this executor
+     * instead of making direct API calls. This enables remote execution capabilities.
+     *
+     * @example
+     * ```typescript
+     * import { LocalExecutor, RemoteExecutor } from '@robota-sdk/agent-core';
+     *
+     * // Local execution (registers this provider)
+     * const localExecutor = new LocalExecutor();
+     * localExecutor.registerProvider('openai', new OpenAIProvider({ apiKey: 'sk-...' }));
+     *
+     * // Remote execution
+     * const remoteExecutor = new RemoteExecutor({
+     *   serverUrl: 'https://api.robota.io',
+     *   userApiKey: 'user-token-123'
+     * });
+     *
+     * const provider = new OpenAIProvider({
+     *   executor: remoteExecutor // No direct API key needed
+     * });
+     * ```
+     */
+    executor?: IExecutor;
+    /**
+     * Logger instance for internal OpenAI provider logging
+     * @defaultValue SilentLogger
+     */
+    logger?: ILogger;
+}
+
+/**
+ * OpenAI provider implementation for Robota
+ *
+ * Provides integration with OpenAI's GPT models following BaseAIProvider guidelines.
+ * Uses OpenAI SDK native types internally for optimal performance and feature support.
+ *
+ * @public
+ */
+declare class OpenAIProvider extends AbstractAIProvider {
+    readonly name = "openai";
+    readonly version = "1.0.0";
+    private readonly client?;
+    private readonly options;
+    private readonly payloadLogger;
+    private readonly responseParser;
+    /**
+     * Optional callback for text deltas during streaming.
+     * Set by the consumer (e.g., Session) to receive real-time text chunks.
+     * When set, chat() uses streaming internally while still returning
+     * the complete assembled message.
+     */
+    onTextDelta?: TTextDeltaCallback;
+    constructor(options: IOpenAIProviderOptions);
+    chat(messages: TUniversalMessage[], options?: IChatOptions): Promise<TUniversalMessage>;
+    private chatWithStreamingAssembly;
+    chatStream(messages: TUniversalMessage[], options?: IChatOptions): AsyncIterable<TUniversalMessage>;
+    supportsTools(): boolean;
+    validateConfig(): boolean;
+    dispose(): Promise<void>;
+    protected validateMessages(messages: TUniversalMessage[]): void;
+}
+
+/**
+ * OpenAI Conversation Adapter
+ *
+ * Converts between TUniversalMessage format and OpenAI native types.
+ * Provides bidirectional conversion for seamless integration.
+ *
+ * @public
+ */
+declare class OpenAIConversationAdapter {
+    /**
+     * Filter messages for OpenAI compatibility
+     *
+     * OpenAI has specific requirements:
+     * - Tool messages must have valid toolCallId
+     * - Messages must be in proper sequence
+     * - Tool messages without toolCallId should be excluded
+     */
+    static filterMessagesForOpenAI(messages: TUniversalMessage[]): TUniversalMessage[];
+    /**
+     * Convert TUniversalMessage array to OpenAI message format
+     * Now properly handles tool messages for OpenAI's tool calling feature
+     */
+    static toOpenAIFormat(messages: TUniversalMessage[]): OpenAI.Chat.ChatCompletionMessageParam[];
+    /**
+     * Convert a single TUniversalMessage to OpenAI format
+     * Handles all message types including tool messages
+     */
+    static convertMessage(msg: TUniversalMessage): OpenAI.Chat.ChatCompletionMessageParam;
+    /**
+     * Add system prompt to message array if needed
+     */
+    static addSystemPromptIfNeeded(messages: OpenAI.Chat.ChatCompletionMessageParam[], systemPrompt?: string): OpenAI.Chat.ChatCompletionMessageParam[];
+}
+
+declare const DEFAULT_OPENAI_PROVIDER_MODEL: string | undefined;
+declare const DEFAULT_OPENAI_COMPATIBLE_PROVIDER_API_KEY = "lm-studio";
+declare const DEFAULT_OPENAI_COMPATIBLE_PROVIDER_BASE_URL = "http://localhost:1234/v1";
+declare function createOpenAIProviderDefinition(): IProviderDefinition;
+
+export { DEFAULT_OPENAI_COMPATIBLE_PROVIDER_API_KEY, DEFAULT_OPENAI_COMPATIBLE_PROVIDER_BASE_URL, DEFAULT_OPENAI_PROVIDER_MODEL, type IOpenAIProviderOptions, type IPayloadLogger, type IPayloadLoggerOptions, OpenAIConversationAdapter, OpenAIProvider, type TOpenAIProviderOptionValue, createOpenAIProviderDefinition };

package/dist/node/index.js

@@ -0,0 +1,2 @@
+import C from'openai';import {AbstractAIProvider,SilentLogger}from'@robota-sdk/agent-core';import {assembleOpenAICompatibleStream,probeOpenAICompatibleProfile,OpenAICompatibleResponseParser,convertToOpenAICompatibleMessages,convertToOpenAICompatibleTools}from'@robota-sdk/agent-provider-openai-compatible';var p=class{parser;constructor(e){this.parser=new OpenAICompatibleResponseParser({logger:e});}parseResponse(e){try{return this.parser.parseResponse(e)}catch(t){let r=d(t instanceof Error?t.message:"OpenAI response parsing failed");throw new Error(`OpenAI response parsing failed: ${r}`)}}parseStreamingChunk(e){try{return this.parser.parseStreamingChunk(e)}catch(t){let r=d(t instanceof Error?t.message:"OpenAI chunk parsing failed");throw new Error(`OpenAI chunk parsing failed: ${r}`)}}};function d(a){return a.replace(/^OpenAI-compatible response parsing failed: /,"").replace(/^OpenAI-compatible chunk parsing failed: /,"").replace("OpenAI-compatible response","OpenAI response")}function c(a){return convertToOpenAICompatibleMessages(a)}function m(a){return convertToOpenAICompatibleTools(a)}var i=class extends AbstractAIProvider{name="openai";version="1.0.0";client;options;payloadLogger;responseParser;onTextDelta;constructor(e){if(super(e.logger||SilentLogger),this.options=e,e.executor&&(this.executor=e.executor),!this.executor)if(e.client)this.client=e.client;else if(e.apiKey)this.client=new C({apiKey:e.apiKey,...e.organization&&{organization:e.organization},...e.timeout&&{timeout:e.timeout},...e.baseURL&&{baseURL:e.baseURL}});else throw new Error("Either OpenAI client, apiKey, or executor is required");this.responseParser=new p(this.logger),this.payloadLogger=e.payloadLogger;}async chat(e,t){if(this.validateMessages(e),this.executor)try{return await this.executeViaExecutorOrDirect(e,t)}catch(r){throw this.logger.error("OpenAI Provider executor chat error:",r instanceof Error?r.message:String(r)),r}if(!this.client)throw new Error("OpenAI client not available. Either provide a client/apiKey or use an executor.");try{let r=c(e),o=t;if(!o?.model)throw new Error("Model is required in chat options. Please specify a model in defaultModel configuration.");let s={model:o.model,messages:r,...o.temperature!==void 0&&{temperature:o.temperature},...o.maxTokens&&{max_tokens:o.maxTokens},...o.tools&&{tools:m(o.tools),tool_choice:"auto"}},n=o.onTextDelta??this.onTextDelta;if(n)return await this.chatWithStreamingAssembly({...s,stream:!0},{...o,onTextDelta:n});if(this.payloadLogger?.isEnabled()){let I={model:s.model,messagesCount:r.length,hasTools:!!s.tools,temperature:s.temperature??void 0,maxTokens:s.max_tokens??void 0,timestamp:new Date().toISOString()};await this.payloadLogger.logPayload(I,"chat");}let l=await this.client.chat.completions.create(s);return this.responseParser.parseResponse(l)}catch(r){let s=r.message||"OpenAI API request failed";throw new Error(`OpenAI chat failed: ${s}`)}}async chatWithStreamingAssembly(e,t){if(!this.client)throw new Error("OpenAI client not available. Either provide a client/apiKey or use an executor.");try{if(this.payloadLogger?.isEnabled()){let o={model:e.model,messagesCount:e.messages.length,hasTools:!!e.tools,temperature:e.temperature??void 0,maxTokens:e.max_tokens??void 0,timestamp:new Date().toISOString()};await this.payloadLogger.logPayload(o,"stream");}let r=await this.client.chat.completions.create(e,t.signal?{signal:t.signal}:void 0);return assembleOpenAICompatibleStream({stream:r,onTextDelta:t.onTextDelta,signal:t.signal})}catch(r){let s=r.message||"OpenAI streaming request failed";throw new Error(`OpenAI stream failed: ${s}`)}}async*chatStream(e,t){if(this.executor)try{yield*this.executeStreamViaExecutorOrDirect(e,t);return}catch(r){throw this.logger.error("OpenAI Provider executor stream error:",r instanceof Error?r.message:String(r)),r}if(!this.client)throw new Error("OpenAI client not available. Either provide a client/apiKey or use an executor.");try{let r=c(e);if(!t?.model)throw new Error("Model is required in chat options. Please specify a model in defaultModel configuration.");let o={model:t.model,messages:r,stream:!0,...t?.temperature!==void 0&&{temperature:t.temperature},...t?.maxTokens&&{max_tokens:t.maxTokens},...t?.tools&&{tools:m(t.tools),tool_choice:"auto"}};if(this.payloadLogger?.isEnabled()){let n={model:o.model,messagesCount:r.length,hasTools:!!o.tools,temperature:o.temperature??void 0,maxTokens:o.max_tokens??void 0,timestamp:new Date().toISOString()};await this.payloadLogger.logPayload(n,"stream");}let s=await this.client.chat.completions.create(o);for await(let n of s){let l=this.responseParser.parseStreamingChunk(n);l&&(yield l);}}catch(r){let s=r.message||"OpenAI API request failed";throw new Error(`OpenAI stream failed: ${s}`)}}supportsTools(){return  true}validateConfig(){return !!this.client&&!!this.options}async dispose(){}validateMessages(e){super.validateMessages(e);for(let t of e)if(t.role==="assistant"){let r=t;if(r.toolCalls&&r.toolCalls.length>0&&r.content==="")continue}}};var g=class{static filterMessagesForOpenAI(e){return e.filter(t=>t.role==="user"||t.role==="assistant"||t.role==="system"?true:t.role==="tool"?!!(t.toolCallId&&t.toolCallId.trim()!==""&&t.toolCallId!=="unknown"):false)}static toOpenAIFormat(e){return this.filterMessagesForOpenAI(e).map(r=>this.convertMessage(r))}static convertMessage(e){let t=e.role;if(t==="user")return {role:"user",content:e.content};if(t==="assistant"){let o=e;return o.toolCalls&&o.toolCalls.length>0?{role:"assistant",content:o.content===""?null:o.content||null,tool_calls:o.toolCalls.map(n=>({id:n.id,type:"function",function:{name:n.function.name,arguments:n.function.arguments}}))}:{role:"assistant",content:o.content===null||o.content===""?null:o.content||""}}if(t==="system")return {role:"system",content:e.content};if(t==="tool"){if(!e.toolCallId||e.toolCallId.trim()==="")throw new Error(`Tool message missing toolCallId: ${JSON.stringify(e)}`);return {role:"tool",content:e.content,tool_call_id:e.toolCallId}}let r=t;throw new Error(`Unsupported message role: ${r}`)}static addSystemPromptIfNeeded(e,t){return !t||e.some(o=>o.role==="system")?e:[{role:"system",content:t},...e]}};var N=void 0,h="lm-studio",f="http://localhost:1234/v1";function z(){return {type:"openai",defaults:{apiKey:h,baseURL:f},setupSteps:[{key:"baseURL",title:"OpenAI-compatible base URL",defaultValue:f},{key:"model",title:"OpenAI-compatible model",required:true},{key:"apiKey",title:"OpenAI-compatible API key",defaultValue:h,masked:true}],requiresApiKey:true,probeProfile:probeOpenAICompatibleProfile,createProvider:a=>new i({apiKey:x(a.apiKey),...a.baseURL!==void 0&&{baseURL:a.baseURL},...a.timeout!==void 0&&{timeout:a.timeout},defaultModel:a.model})}}function x(a){if(!a)throw new Error("Provider openai requires apiKey");return a}
+export{h as DEFAULT_OPENAI_COMPATIBLE_PROVIDER_API_KEY,f as DEFAULT_OPENAI_COMPATIBLE_PROVIDER_BASE_URL,N as DEFAULT_OPENAI_PROVIDER_MODEL,g as OpenAIConversationAdapter,i as OpenAIProvider,z as createOpenAIProviderDefinition};

package/package.json

@@ -0,0 +1,111 @@
+{
+  "name": "@robota-sdk/agent-provider-openai",
+  "version": "3.0.0-beta.55",
+  "description": "OpenAI integration for Robota SDK - GPT-4, GPT-3.5, function calling, and tool integration with OpenAI's API",
+  "type": "module",
+  "main": "dist/node/index.js",
+  "module": "dist/node/index.mjs",
+  "types": "dist/node/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/node/index.d.ts",
+      "node": {
+        "import": "./dist/node/index.js",
+        "require": "./dist/node/index.cjs"
+      },
+      "browser": {
+        "import": "./dist/browser/index.js"
+      },
+      "default": {
+        "import": "./dist/node/index.js",
+        "require": "./dist/node/index.cjs"
+      }
+    },
+    "./loggers/file": {
+      "types": "./dist/loggers/file.d.ts",
+      "import": "./dist/loggers/file.js",
+      "require": "./dist/loggers/file.cjs"
+    },
+    "./loggers/console": {
+      "types": "./dist/loggers/console.d.ts",
+      "import": "./dist/loggers/console.js",
+      "require": "./dist/loggers/console.cjs"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/woojubb/robota.git",
+    "directory": "packages/agent-provider-openai"
+  },
+  "homepage": "https://robota.io/",
+  "bugs": {
+    "url": "https://github.com/woojubb/robota/issues"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "keywords": [
+    "ai",
+    "agent",
+    "llm",
+    "openai",
+    "gpt",
+    "gpt-4",
+    "gpt-3.5",
+    "chatgpt",
+    "function-calling",
+    "typescript",
+    "javascript",
+    "chatbot",
+    "conversational-ai",
+    "artificial-intelligence",
+    "machine-learning",
+    "nlp",
+    "natural-language-processing",
+    "sdk",
+    "library",
+    "tool-integration",
+    "robota",
+    "openai-api",
+    "ai-integration"
+  ],
+  "author": "Robota SDK Team",
+  "license": "MIT",
+  "dependencies": {
+    "openai": "^4.98.0",
+    "@robota-sdk/agent-provider-openai-compatible": "3.0.0-beta.55"
+  },
+  "peerDependencies": {
+    "@robota-sdk/agent-core": "3.0.0-beta.55"
+  },
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^6.18.0",
+    "@typescript-eslint/parser": "^6.18.0",
+    "eslint": "^8.56.0",
+    "rimraf": "^5.0.5",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
+    "vitest": "^1.1.0",
+    "@robota-sdk/agent-core": "3.0.0-beta.55"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "build:js": "tsup --no-dts",
+    "build:types": "tsup --dts-only",
+    "dev": "tsup --watch",
+    "clean": "rimraf dist",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src --ext .ts,.tsx",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "lint:fix": "eslint src --ext .ts,.tsx --fix",
+    "scenario:verify": "pnpm --filter @robota-sdk/agent-core build && pnpm exec tsx examples/verify-executor.ts",
+    "scenario:record": "node ../../scripts/harness/record-owner-scenario.mjs --scope packages/agent-provider-openai --output examples/scenarios/executor-verify.record.json -- pnpm scenario:verify"
+  }
+}