@proteinjs/conversation 2.5.0 → 2.6.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.6.0](https://github.com/proteinjs/conversation/compare/@proteinjs/conversation@2.5.0...@proteinjs/conversation@2.6.0) (2026-01-16)
+
+
+### Features
+
+* Added `OpenAiResponses` as a wrapper around the responses api. ([8fa7470](https://github.com/proteinjs/conversation/commit/8fa7470265cc5157e980600a910e96225ba8c43f))
+
+
+
+
+
 # [2.5.0](https://github.com/proteinjs/conversation/compare/@proteinjs/conversation@2.4.2...@proteinjs/conversation@2.5.0) (2026-01-16)
 
 

package/dist/index.d.ts

@@ -12,6 +12,7 @@ export * from './src/history/MessageHistory';
 export * from './src/ChatCompletionMessageParamFactory';
 export { AssistantResponseStreamChunk } from './src/OpenAiStreamProcessor';
 export { UsageData, TokenUsage } from './src/UsageData';
+export * from './src/OpenAiResponses';
 export * from './src/fs/conversation_fs/ConversationFsModule';
 export * from './src/fs/conversation_fs/FsFunctions';
 export * from './src/fs/git/GitModule';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,kCAAkC,CAAC;AACjD,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yCAAyC,CAAC;AACxD,OAAO,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAGxD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sCAAsC,CAAC;AACrD,cAAc,wBAAwB,CAAC;AACvC,cAAc,2DAA2D,CAAC;AAC1E,cAAc,8DAA8D,CAAC;AAC7E,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,kCAAkC,CAAC;AACjD,cAAc,oBAAoB,CAAC;AACnC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gCAAgC,CAAC;AAC/C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yCAAyC,CAAC;AACxD,OAAO,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AACxD,cAAc,uBAAuB,CAAC;AAGtC,cAAc,+CAA+C,CAAC;AAC9D,cAAc,sCAAsC,CAAC;AACrD,cAAc,wBAAwB,CAAC;AACvC,cAAc,2DAA2D,CAAC;AAC1E,cAAc,8DAA8D,CAAC;AAC7E,cAAc,gCAAgC,CAAC;AAC/C,cAAc,mCAAmC,CAAC"}

package/dist/index.js

@@ -26,6 +26,7 @@ __exportStar(require("./src/Function"), exports);
 __exportStar(require("./src/history/MessageModerator"), exports);
 __exportStar(require("./src/history/MessageHistory"), exports);
 __exportStar(require("./src/ChatCompletionMessageParamFactory"), exports);
+__exportStar(require("./src/OpenAiResponses"), exports);
 // Conversation modules
 __exportStar(require("./src/fs/conversation_fs/ConversationFsModule"), exports);
 __exportStar(require("./src/fs/conversation_fs/FsFunctions"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,kDAAgC;AAChC,+CAA6B;AAC7B,mEAAiD;AACjD,qDAAmC;AACnC,4DAA0C;AAC1C,2DAAyC;AACzC,2DAAyC;AACzC,iDAA+B;AAC/B,iEAA+C;AAC/C,+DAA6C;AAC7C,0EAAwD;AAIxD,uBAAuB;AACvB,gFAA8D;AAC9D,uEAAqD;AACrD,yDAAuC;AACvC,4FAA0E;AAC1E,+FAA6E;AAC7E,iEAA+C;AAC/C,oEAAkD"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B;AAC/B,kDAAgC;AAChC,+CAA6B;AAC7B,mEAAiD;AACjD,qDAAmC;AACnC,4DAA0C;AAC1C,2DAAyC;AACzC,2DAAyC;AACzC,iDAA+B;AAC/B,iEAA+C;AAC/C,+DAA6C;AAC7C,0EAAwD;AAGxD,wDAAsC;AAEtC,uBAAuB;AACvB,gFAA8D;AAC9D,uEAAqD;AACrD,yDAAuC;AACvC,4FAA0E;AAC1E,+FAA6E;AAC7E,iEAA+C;AAC/C,oEAAkD"}

package/dist/src/OpenAiResponses.d.ts

@@ -0,0 +1,121 @@
+import { OpenAI as OpenAIApi } from 'openai';
+import type { ChatCompletionMessageParam } from 'openai/resources/chat';
+import { LogLevel } from '@proteinjs/logger';
+import type { ConversationModule } from './ConversationModule';
+import { UsageData } from './UsageData';
+import type { GenerateResponseReturn, ToolInvocationProgressEvent } from './OpenAi';
+export declare const DEFAULT_RESPONSES_MODEL = "gpt-5.2";
+export declare const DEFAULT_MAX_TOOL_CALLS = 50;
+export type OpenAiResponsesParams = {
+    modules?: ConversationModule[];
+    /** If provided, only these functions will be exposed to the model. */
+    allowedFunctionNames?: string[];
+    logLevel?: LogLevel;
+    /** Default model when none is provided per call. */
+    defaultModel?: string;
+    /** Default cap for tool calls (per call). */
+    maxToolCalls?: number;
+};
+export type GenerateTextParams = {
+    messages: (string | ChatCompletionMessageParam)[];
+    model?: string;
+    abortSignal?: AbortSignal;
+    /** Sampling & limits */
+    temperature?: number;
+    topP?: number;
+    maxTokens?: number;
+    /** Optional realtime hook for tool-call lifecycle (started/finished). */
+    onToolInvocation?: (evt: ToolInvocationProgressEvent) => void;
+    /** Usage callback */
+    onUsageData?: (usageData: UsageData) => Promise<void>;
+    /** Per-call override for reasoning effort (reasoning models only). */
+    reasoningEffort?: OpenAIApi.Chat.Completions.ChatCompletionReasoningEffort;
+    /** Hard cap for custom function tool calls executed by this wrapper. */
+    maxToolCalls?: number;
+    /** If true, run using Responses API background mode (polling). */
+    backgroundMode?: boolean;
+};
+export type ResponsesGenerateObjectParams<S> = {
+    messages: (string | ChatCompletionMessageParam)[];
+    model?: string;
+    abortSignal?: AbortSignal;
+    /** Zod schema or JSON Schema */
+    schema: S;
+    /** Sampling & limits */
+    temperature?: number;
+    topP?: number;
+    maxTokens?: number;
+    /** Optional realtime hook for tool-call lifecycle (started/finished). */
+    onToolInvocation?: (evt: ToolInvocationProgressEvent) => void;
+    /** Usage callback */
+    onUsageData?: (usageData: UsageData) => Promise<void>;
+    /** Per-call override for reasoning effort (reasoning models only). */
+    reasoningEffort?: OpenAIApi.Chat.Completions.ChatCompletionReasoningEffort;
+    /** Hard cap for custom function tool calls executed by this wrapper. */
+    maxToolCalls?: number;
+    /** If true, run using Responses API background mode (polling). */
+    backgroundMode?: boolean;
+};
+/**
+ * OpenAI Responses API wrapper (tool-loop + usage tracking + ConversationModules).
+ * - Uses Responses API directly
+ * - Supports custom function tools (tool calling loop)
+ * - Supports structured outputs (JSON schema / Zod)
+ * - Tracks usage + tool calls using existing types
+ * - Supports background mode (polling)
+ * - Supports ConversationModules (system messages + tool registration)
+ */
+export declare class OpenAiResponses {
+    private readonly client;
+    private readonly logger;
+    private readonly modules;
+    private readonly allowedFunctionNames?;
+    private readonly defaultModel;
+    private readonly defaultMaxToolCalls;
+    private modulesProcessed;
+    private processingModulesPromise;
+    private systemMessages;
+    private functions;
+    constructor(opts?: OpenAiResponsesParams);
+    /** Plain text generation (supports tool calling). */
+    generateText(args: GenerateTextParams): Promise<GenerateResponseReturn>;
+    /** Back-compat alias for callers that use `generateResponse`. */
+    generateResponse(args: GenerateTextParams): Promise<GenerateResponseReturn>;
+    /** Structured object generation (supports tool calling). */
+    generateObject<T>(args: ResponsesGenerateObjectParams<unknown>): Promise<{
+        object: T;
+        usageData: UsageData;
+    }>;
+    private run;
+    private createResponseAndMaybeWait;
+    private waitForCompletion;
+    private buildResponseTools;
+    private extractFunctionCalls;
+    private executeFunctionCalls;
+    private executeFunctionCall;
+    private formatToolReturn;
+    private addUsageFromResponse;
+    private extractAssistantText;
+    private buildTextFormat;
+    private parseAndValidateStructuredOutput;
+    private isZodSchema;
+    private parseJson;
+    /**
+     * Strictifies a plain JSON Schema for OpenAI Structured Outputs (strict mode):
+     *  - Ensures every object has `additionalProperties: false`
+     *  - Ensures every object has a `required` array that includes **all** keys in `properties`
+     *  - Adds missing `type: "object"` / `type: "array"` where implied by keywords
+     */
+    private strictifyJsonSchema;
+    private buildInstructionsAndInput;
+    private extractTextContent;
+    private ensureModulesProcessed;
+    private processModules;
+    private filterFunctions;
+    private buildFunctionInstructionsMessage;
+    private resolveModel;
+    private resolveBackgroundMode;
+    private isProModel;
+    private isHighReasoningEffort;
+}
+//# sourceMappingURL=OpenAiResponses.d.ts.map

package/dist/src/OpenAiResponses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OpenAiResponses.d.ts","sourceRoot":"","sources":["../../src/OpenAiResponses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,SAAS,EAAE,MAAM,QAAQ,CAAC;AAC7C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AACxE,OAAO,EAAU,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,OAAO,EAAE,SAAS,EAAwB,MAAM,aAAa,CAAC;AAE9D,OAAO,KAAK,EAAE,sBAAsB,EAAE,2BAA2B,EAAwB,MAAM,UAAU,CAAC;AAG1G,eAAO,MAAM,uBAAuB,YAAY,CAAC;AACjD,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC/B,sEAAsE;IACtE,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,oDAAoD;IACpD,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,6CAA6C;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,CAAC,MAAM,GAAG,0BAA0B,CAAC,EAAE,CAAC;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,2BAA2B,KAAK,IAAI,CAAC;IAE9D,qBAAqB;IACrB,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD,sEAAsE;IACtE,eAAe,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,6BAA6B,CAAC;IAE3E,wEAAwE;IACxE,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kEAAkE;IAClE,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,6BAA6B,CAAC,CAAC,IAAI;IAC7C,QAAQ,EAAE,CAAC,MAAM,GAAG,0BAA0B,CAAC,EAAE,CAAC;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B,gCAAgC;IAChC,MAAM,EAAE,CAAC,CAAC;IAEV,wBAAwB;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,2BAA2B,KAAK,IAAI,CAAC;IAE9D,qBAAqB;IACrB,WAAW,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtD,sEAAsE;IACtE,eAAe,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,6BAA6B,CAAC;IAE3E,wEAAwE;IACxE,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kEAAkE;IAClE,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF;;;;;;;;GAQG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAY;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAuB;IAC/C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAW;IACjD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAS;IAE7C,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,wBAAwB,CAA8B;IAE9D,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,SAAS,CAAkB;gBAEvB,IAAI,GAAE,qBAA0B;IAW5C,qDAAqD;IAC/C,YAAY,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAiC7E,iEAAiE;IAC3D,gBAAgB,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAIjF,4DAA4D;IACtD,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,6BAA6B,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,CAAC,CAAC;QAAC,SAAS,EAAE,SAAS,CAAA;KAAE,CAAC;YA6CrG,GAAG;YAsFH,0BAA0B;YAyF1B,iBAAiB;IA6C/B,OAAO,CAAC,kBAAkB;IAiC1B,OAAO,CAAC,oBAAoB;YAgCd,oBAAoB;YAwBpB,mBAAmB;YA2GnB,gBAAgB;IAwB9B,OAAO,CAAC,oBAAoB;IAmC5B,OAAO,CAAC,oBAAoB;IAoD5B,OAAO,CAAC,eAAe;IAgBvB,OAAO,CAAC,gCAAgC;IAcxC,OAAO,CAAC,WAAW;IAOnB,OAAO,CAAC,SAAS;IA2BjB;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;IAgF3B,OAAO,CAAC,yBAAyB;IA6CjC,OAAO,CAAC,kBAAkB;YAuBZ,sBAAsB;YAkBtB,cAAc;IA4B5B,OAAO,CAAC,eAAe;IAgBvB,OAAO,CAAC,gCAAgC;IA8BxC,OAAO,CAAC,YAAY;IAKpB,OAAO,CAAC,qBAAqB;IAiB7B,OAAO,CAAC,UAAU;IAKlB,OAAO,CAAC,qBAAqB;CAI9B"}