Tighten reasoning model types and simplify adapter test stubs

Author: nick-potts

packages/typescript/ai-openai/src/models/text.ts

@@ -36,20 +36,39 @@ export interface TextProviderFeatureMap {
   streaming: OpenAIStreamingOptions
 }
 
-type NonReasoningTextProviderFeatureMap = Omit<
-  TextProviderFeatureMap,
+type TextProviderFeature = keyof TextProviderFeatureMap
+type TextProviderNonReasoningFeature = Exclude<
+  TextProviderFeature,
   'reasoning' | 'reasoningConcise'
 >
+type TextProviderNonBaseFeature = Exclude<TextProviderNonReasoningFeature, 'base'>
+type NonReasoningTextProviderFeatures = readonly [
+  'base',
+  ...ReadonlyArray<TextProviderNonBaseFeature>,
+]
+type ReasoningTextProviderFeatures = readonly [
+  'base',
+  'reasoning',
+  ...ReadonlyArray<TextProviderNonBaseFeature>,
+]
+type ReasoningConciseTextProviderFeatures = readonly [
+  'base',
+  'reasoningConcise',
+  ...ReadonlyArray<TextProviderNonBaseFeature>,
+]
 
-type TextProviderFeature = keyof TextProviderFeatureMap
-
-interface TextReasoningSpec {
+interface TextReasoningSpec<
+  TSummary extends OpenAIReasoningSummaryWithConcise = OpenAIReasoningSummaryWithConcise,
+> {
   efforts: ReadonlyArray<OpenAIReasoningEffort>
-  summaries: ReadonlyArray<OpenAIReasoningSummaryWithConcise>
+  summaries: ReadonlyArray<TSummary>
 }
 
-interface TextModelSpec<
-  TFeatures extends ReadonlyArray<TextProviderFeature>,
+interface TextModelSpecBase<
+  TFeatures extends
+    | NonReasoningTextProviderFeatures
+    | ReasoningTextProviderFeatures
+    | ReasoningConciseTextProviderFeatures,
   TInput extends ReadonlyArray<OpenAIRegistryInput>,
   TOutput extends ReadonlyArray<OpenAIRegistryOutput>,
 > {
@@ -65,6 +84,54 @@ interface TextModelSpec<
   docs?: OpenAIRegistryDocs
 }
 
+type NonReasoningTextModelSpec<
+  TFeatures extends NonReasoningTextProviderFeatures,
+  TInput extends ReadonlyArray<OpenAIRegistryInput>,
+  TOutput extends ReadonlyArray<OpenAIRegistryOutput>,
+> = TextModelSpecBase<TFeatures, TInput, TOutput> & {
+  reasoning?: never
+}
+
+type ReasoningTextModelSpec<
+  TFeatures extends ReasoningTextProviderFeatures,
+  TInput extends ReadonlyArray<OpenAIRegistryInput>,
+  TOutput extends ReadonlyArray<OpenAIRegistryOutput>,
+> = TextModelSpecBase<TFeatures, TInput, TOutput> & {
+  reasoning: TextReasoningSpec<OpenAIReasoningSummary>
+}
+
+type ReasoningConciseTextModelSpec<
+  TFeatures extends ReasoningConciseTextProviderFeatures,
+  TInput extends ReadonlyArray<OpenAIRegistryInput>,
+  TOutput extends ReadonlyArray<OpenAIRegistryOutput>,
+> = TextModelSpecBase<TFeatures, TInput, TOutput> & {
+  reasoning: TextReasoningSpec<OpenAIReasoningSummaryWithConcise>
+}
+
+type TextModelSpec<
+  TFeatures extends
+    | NonReasoningTextProviderFeatures
+    | ReasoningTextProviderFeatures
+    | ReasoningConciseTextProviderFeatures,
+  TInput extends ReadonlyArray<OpenAIRegistryInput>,
+  TOutput extends ReadonlyArray<OpenAIRegistryOutput>,
+> =
+  | NonReasoningTextModelSpec<
+      Extract<TFeatures, NonReasoningTextProviderFeatures>,
+      TInput,
+      TOutput
+    >
+  | ReasoningTextModelSpec<
+      Extract<TFeatures, ReasoningTextProviderFeatures>,
+      TInput,
+      TOutput
+    >
+  | ReasoningConciseTextModelSpec<
+      Extract<TFeatures, ReasoningConciseTextProviderFeatures>,
+      TInput,
+      TOutput
+    >
+
 const COMMON_TOOLS = [
   'web_search',
   'file_search',
@@ -107,8 +174,8 @@ export type TextProviderOptionsForEntry<
   TEntry extends { features: ReadonlyArray<string> },
 > =
   UnionToIntersection<
-    NonReasoningTextProviderFeatureMap[
-      Extract<TEntry['features'][number], keyof NonReasoningTextProviderFeatureMap>
+    TextProviderFeatureMap[
+      Extract<TEntry['features'][number], TextProviderNonReasoningFeature>
     ]
   > &
     TextReasoningOptionsForEntry<TEntry>
@@ -746,7 +813,9 @@ export const TEXT_MODELS = {
 } as const satisfies Record<
   string,
   TextModelSpec<
-    ReadonlyArray<TextProviderFeature>,
+    | NonReasoningTextProviderFeatures
+    | ReasoningTextProviderFeatures
+    | ReasoningConciseTextProviderFeatures,
     ReadonlyArray<OpenAIRegistryInput>,
     ReadonlyArray<OpenAIRegistryOutput>
   >

packages/typescript/ai-openai/tests/model-meta.test.ts

@@ -51,7 +51,6 @@ import type {
   GptImage1ProviderOptions,
 } from '../src/image/image-provider-options'
 import type {
-  OpenAIReasoningOptions,
   OpenAIReasoningOptionsWithConcise,
   OpenAIStreamingOptions,
   OpenAIStructuredOutputOptions,
@@ -66,6 +65,8 @@ describe('OpenAI registries', () => {
   const expectUnique = (ids: ReadonlyArray<string>) => {
     expect(new Set(ids).size).toBe(ids.length)
   }
+  const hasOwn = (object: object, key: PropertyKey) =>
+    Object.prototype.hasOwnProperty.call(object, key)
 
   it('derives public arrays from the keyed registries', () => {
     expect(OPENAI_CHAT_MODELS).toEqual(supportedIds(TEXT_MODELS))
@@ -99,19 +100,19 @@ describe('OpenAI registries', () => {
     )
     for (const id of OPENAI_CHAT_SNAPSHOT_MODELS) {
       expect(OPENAI_CHAT_MODELS).toContain(id)
-      expect(TEXT_MODELS).not.toHaveProperty(id)
+      expect(hasOwn(TEXT_MODELS, id)).toBe(false)
     }
     for (const id of OPENAI_IMAGE_SNAPSHOT_MODELS) {
       expect(OPENAI_IMAGE_MODELS).toContain(id)
-      expect(IMAGE_MODELS).not.toHaveProperty(id)
+      expect(hasOwn(IMAGE_MODELS, id)).toBe(false)
     }
     for (const id of OPENAI_TTS_SNAPSHOT_MODELS) {
       expect(OPENAI_TTS_MODELS).toContain(id)
-      expect(TTS_MODELS).not.toHaveProperty(id)
+      expect(hasOwn(TTS_MODELS, id)).toBe(false)
     }
     for (const id of OPENAI_TRANSCRIPTION_SNAPSHOT_MODELS) {
       expect(OPENAI_TRANSCRIPTION_MODELS).toContain(id)
-      expect(TRANSCRIPTION_MODELS).not.toHaveProperty(id)
+      expect(hasOwn(TRANSCRIPTION_MODELS, id)).toBe(false)
     }
   })
 

packages/typescript/ai-openai/tests/transcription-adapter.test.ts

@@ -1,6 +1,21 @@
 import { afterEach, describe, expect, it, vi } from 'vitest'
 import { createOpenaiTranscription } from '../src/adapters/transcription'
 
+const stubAdapterClient = (
+  adapter: ReturnType<typeof createOpenaiTranscription>,
+  create: unknown,
+) => {
+  ;(adapter as unknown as {
+    client: { audio: { transcriptions: { create: unknown } } }
+  }).client = {
+    audio: {
+      transcriptions: {
+        create,
+      },
+    },
+  }
+}
+
 describe('OpenAI transcription adapter', () => {
   afterEach(() => {
     vi.restoreAllMocks()
@@ -24,14 +39,7 @@ describe('OpenAI transcription adapter', () => {
     })
 
     const adapter = createOpenaiTranscription('gpt-4o-transcribe', 'test-api-key')
-    ;(adapter as unknown as { client: { audio: { transcriptions: { create: unknown } } } }).client =
-      {
-        audio: {
-          transcriptions: {
-            create,
-          },
-        },
-      }
+    stubAdapterClient(adapter, create)
 
     const result = await adapter.transcribe({
       model: 'gpt-4o-transcribe',
@@ -64,14 +72,7 @@ describe('OpenAI transcription adapter', () => {
     const create = vi.fn().mockResolvedValueOnce('plain transcript')
 
     const adapter = createOpenaiTranscription('whisper-1', 'test-api-key')
-    ;(adapter as unknown as { client: { audio: { transcriptions: { create: unknown } } } }).client =
-      {
-        audio: {
-          transcriptions: {
-            create,
-          },
-        },
-      }
+    stubAdapterClient(adapter, create)
 
     const result = await adapter.transcribe({
       model: 'whisper-1',
@@ -98,14 +99,7 @@ describe('OpenAI transcription adapter', () => {
     const create = vi.fn().mockResolvedValueOnce({ segments: [] })
 
     const adapter = createOpenaiTranscription('gpt-4o-transcribe', 'test-api-key')
-    ;(adapter as unknown as { client: { audio: { transcriptions: { create: unknown } } } }).client =
-      {
-        audio: {
-          transcriptions: {
-            create,
-          },
-        },
-      }
+    stubAdapterClient(adapter, create)
 
     const result = await adapter.transcribe({
       model: 'gpt-4o-transcribe',
@@ -133,14 +127,7 @@ describe('OpenAI transcription adapter', () => {
     })
 
     const adapter = createOpenaiTranscription('gpt-4o-transcribe', 'test-api-key')
-    ;(adapter as unknown as { client: { audio: { transcriptions: { create: unknown } } } }).client =
-      {
-        audio: {
-          transcriptions: {
-            create,
-          },
-        },
-      }
+    stubAdapterClient(adapter, create)
 
     await adapter.transcribe({
       model: 'gpt-4o-transcribe',

packages/typescript/ai-openai/tests/tts-adapter.test.ts

@@ -1,21 +1,29 @@
 import { describe, expect, it, vi } from 'vitest'
 import { createOpenaiSpeech } from '../src/adapters/tts'
 
+const stubAdapterClient = (
+  adapter: ReturnType<typeof createOpenaiSpeech>,
+  create: unknown,
+) => {
+  ;(adapter as unknown as {
+    client: { audio: { speech: { create: unknown } } }
+  }).client = {
+    audio: {
+      speech: {
+        create,
+      },
+    },
+  }
+}
+
 describe('OpenAI TTS adapter', () => {
   it('passes supported instructions through and returns mp3 output metadata', async () => {
     const create = vi
       .fn()
       .mockResolvedValueOnce(new Response(Uint8Array.from([1, 2, 3])))
 
     const adapter = createOpenaiSpeech('gpt-4o-mini-tts', 'test-api-key')
-    ;(adapter as unknown as { client: { audio: { speech: { create: unknown } } } }).client =
-      {
-        audio: {
-          speech: {
-            create,
-          },
-        },
-      }
+    stubAdapterClient(adapter, create)
 
     const result = await adapter.generateSpeech({
       model: 'gpt-4o-mini-tts',
@@ -43,14 +51,7 @@ describe('OpenAI TTS adapter', () => {
     const create = vi.fn()
 
     const adapter = createOpenaiSpeech('tts-1', 'test-api-key')
-    ;(adapter as unknown as { client: { audio: { speech: { create: unknown } } } }).client =
-      {
-        audio: {
-          speech: {
-            create,
-          },
-        },
-      }
+    stubAdapterClient(adapter, create)
 
     await expect(
       adapter.generateSpeech({