@rulvar/openai 1.0.0 → 1.2.0

package/dist/index.d.ts

@@ -4,10 +4,10 @@ import { CanonicalId, ChatEvent, ChatRequest, Effort, ModelCaps, ProviderAdapter
 interface OpenAiModelInfo {
   caps: ModelCaps;
   api: "responses" | "chat";
-  /** Reasoning models reject non-default sampling parameters (docs/04, section 5.1). */
+  /** Reasoning models reject non-default sampling parameters. */
   reasoning: boolean;
 }
-/** Static seed table; docs/04 section 5 names the current model set. */
+/** Static seed table of the current model set. */
 declare const OPENAI_MODELS: Record<string, OpenAiModelInfo>;
 /** Unknown OpenAI models are assumed current-generation Responses models. */
 declare function openAiModelInfo(model: string): OpenAiModelInfo;
@@ -40,8 +40,8 @@ declare function openai(options?: OpenAiAdapterOptions): ProviderAdapter;
 //#region src/compatible.d.ts
 /**
 * Gateways cannot be introspected reliably: when caps are not supplied
-* the factory assumes the most conservative capability set (docs/04,
-* section 6). Callers SHOULD supply caps for anything beyond it; the
+* the factory assumes the most conservative capability set. Callers
+* SHOULD supply caps for anything beyond it; the
 * window and output floors here are deliberately small so an unprobed
 * endpoint is never overcommitted. Absent pricing is legitimate for
 * local models: they surface as unpriced in CostReport.
@@ -61,7 +61,7 @@ interface OpenAiCompatibleConfig {
 declare function openaiCompatible(cfg: OpenAiCompatibleConfig): ProviderAdapter;
 //#endregion
 //#region src/wire.d.ts
-/** Bijective canonical-to-wire (call_*) id map (docs/04, section 1.2). */
+/** Bijective canonical-to-wire (call_*) id map. */
 declare class OpenAiIdMap {
   private readonly toWire;
   private readonly toCanonical;
@@ -71,7 +71,7 @@ declare class OpenAiIdMap {
   wireFor(canonicalId: CanonicalId): string;
 }
 /**
-* Canonical-to-wire effort (docs/04, sections 3.3 and 5.5): low through
+* Canonical-to-wire effort: low through
 * xhigh pass through; canonical max downmaps to xhigh (documented lossy;
 * recorded in providerMetadata); provider 'none' is reachable only via
 * providerOptions.openai.reasoningEffort.
@@ -84,7 +84,7 @@ declare function mapOpenAiEffort(effort: Effort): {
 * Builds Responses API params. Manual item replay ONLY: store: false plus
 * include reasoning.encrypted_content; previous_response_id and the
 * Conversations API place state server-side, break replay identity, and
-* are REJECTED as a typed ConfigError (docs/04, section 5.1). Role
+* are REJECTED as a typed ConfigError. Role
 * 'system' messages project into top-level instructions on every request.
 */
 declare function buildResponsesParams(req: ChatRequest, ids: OpenAiIdMap): {
@@ -98,8 +98,8 @@ type ResponsesStreamEvent = Record<string, unknown> & {
 /** Normalizes Responses usage: input_tokens already includes cached reads. */
 declare function normalizeOpenAiUsage(raw: Record<string, unknown> | undefined): Usage;
 /**
-* Maps the typed Responses SSE stream to ChatEvents per the docs/04
-* section 5.4 table. Canonical parts come from the typed output array,
+* Maps the typed Responses SSE stream to ChatEvents.
+* Canonical parts come from the typed output array,
 * never the output_text aggregate. Raw output items ride
 * finish.providerMetadata.openai.outputItems so the runtime can retain
 * reasoning items as provider-raw parts.
@@ -110,7 +110,7 @@ declare function mapResponsesStream(stream: AsyncIterable<ResponsesStreamEvent>,
 /** Projects SDK/API errors into the retryable WireError vocabulary. */
 declare function openAiErrorToWire(error: unknown): WireError;
 /**
-* The Chat Completions degraded path (docs/04, section 5.6): delta-patched
+* The Chat Completions degraded path: delta-patched
 * chunk assembly instead of typed SSE, nested function tools with explicit
 * strict where supported, response_format instead of text.format, no
 * reasoning item replay. Selected by caps (api: 'chat'), visible in

package/dist/index.js

@@ -26,7 +26,7 @@ function responses(contextWindow, maxOutputTokens, pricing) {
 		reasoning: true
 	};
 }
-/** Static seed table; docs/04 section 5 names the current model set. */
+/** Static seed table of the current model set. */
 const OPENAI_MODELS = {
 	"gpt-5.5": responses(4e5, 128e3, {
 		in: 10,
@@ -70,10 +70,10 @@ function openAiModelInfo(model) {
 * mapped to ChatEvent, effort mapping with the documented lossy max
 * downmap, and usage normalization.
 *
-* Owning spec: docs/04-model-layer-spec.md, section "@rulvar/openai
-* (Responses API)". Pure functions; adapter.ts owns the SDK client.
+* Full contract: https://docs.rulvar.com/guide/providers
+* Pure functions; adapter.ts owns the SDK client.
 */
-/** Bijective canonical-to-wire (call_*) id map (docs/04, section 1.2). */
+/** Bijective canonical-to-wire (call_*) id map. */
 var OpenAiIdMap = class {
 	toWire = /* @__PURE__ */ new Map();
 	toCanonical = /* @__PURE__ */ new Map();
@@ -99,7 +99,7 @@ var OpenAiIdMap = class {
 	}
 };
 /**
-* Canonical-to-wire effort (docs/04, sections 3.3 and 5.5): low through
+* Canonical-to-wire effort: low through
 * xhigh pass through; canonical max downmaps to xhigh (documented lossy;
 * recorded in providerMetadata); provider 'none' is reachable only via
 * providerOptions.openai.reasoningEffort.
@@ -118,7 +118,7 @@ function mapOpenAiEffort(effort) {
 * Builds Responses API params. Manual item replay ONLY: store: false plus
 * include reasoning.encrypted_content; previous_response_id and the
 * Conversations API place state server-side, break replay identity, and
-* are REJECTED as a typed ConfigError (docs/04, section 5.1). Role
+* are REJECTED as a typed ConfigError. Role
 * 'system' messages project into top-level instructions on every request.
 */
 function buildResponsesParams(req, ids) {
@@ -244,8 +244,8 @@ function normalizeOpenAiUsage(raw) {
 	return usage;
 }
 /**
-* Maps the typed Responses SSE stream to ChatEvents per the docs/04
-* section 5.4 table. Canonical parts come from the typed output array,
+* Maps the typed Responses SSE stream to ChatEvents.
+* Canonical parts come from the typed output array,
 * never the output_text aggregate. Raw output items ride
 * finish.providerMetadata.openai.outputItems so the runtime can retain
 * reasoning items as provider-raw parts.
@@ -405,7 +405,7 @@ function openAiErrorToWire(error) {
 	};
 }
 /**
-* The Chat Completions degraded path (docs/04, section 5.6): delta-patched
+* The Chat Completions degraded path: delta-patched
 * chunk assembly instead of typed SSE, nested function tools with explicit
 * strict where supported, response_format instead of text.format, no
 * reasoning item replay. Selected by caps (api: 'chat'), visible in
@@ -575,8 +575,8 @@ async function mapChatCompletionsStream(stream, ids, emit) {
 * Completions as the caps-selected degraded path, SDK autoretries
 * disabled.
 *
-* Owning spec: docs/04-model-layer-spec.md, section "@rulvar/openai
-* (Responses API)". The openaiCompatible factory ships in M3.
+* Docs: https://docs.rulvar.com/guide/providers
+* The openaiCompatible factory ships in M3.
 */
 /** Creates the first-class OpenAI adapter (id 'openai'); maxRetries 0. */
 function openai(options = {}) {
@@ -633,13 +633,12 @@ function openai(options = {}) {
 * engine; a duplicate adapterId at createEngine is a typed ConfigError
 * raised by the adapter registry.
 *
-* Owning spec: docs/04-model-layer-spec.md, section "openaiCompatible
-* factory".
+* Guide: https://docs.rulvar.com/guide/providers
 */
 /**
 * Gateways cannot be introspected reliably: when caps are not supplied
-* the factory assumes the most conservative capability set (docs/04,
-* section 6). Callers SHOULD supply caps for anything beyond it; the
+* the factory assumes the most conservative capability set. Callers
+* SHOULD supply caps for anything beyond it; the
 * window and output floors here are deliberately small so an unprobed
 * endpoint is never overcommitted. Absent pricing is legitimate for
 * local models: they surface as unpriced in CostReport.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rulvar/openai",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "rulvar first-class provider adapter for the OpenAI Responses API, plus the openaiCompatible factory.",
   "type": "module",
   "license": "Apache-2.0",
@@ -23,7 +23,7 @@
   },
   "dependencies": {
     "openai": "^6.45.0",
-    "@rulvar/core": "1.0.0"
+    "@rulvar/core": "1.2.0"
   },
   "devDependencies": {
     "@types/node": "^22.20.0",