extra types (#97)

.changeset/stale-parents-rhyme.md

@@ -0,0 +1,5 @@
+---
+"@instructor-ai/instructor": patch
+---
+
+Fixing inference on stream types when using npm or pnpm

package.json

@@ -19,7 +19,7 @@
   "files": [
     "dist/**"
   ],
-  "typings": "./dist/index.d.ts",
+  "types": "./dist/index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsup",

src/instructor.ts

@@ -202,7 +202,9 @@ class Instructor {
       ): Promise<ReturnTypeBasedOnParams<P>> => {
         if (this.isChatCompletionCreateParamsWithModel(params)) {
           if (params.stream) {
-            return this.chatCompletionStream(params) as ReturnTypeBasedOnParams<P>
+            return this.chatCompletionStream(params) as ReturnTypeBasedOnParams<
+              P & { stream: true }
+            >
           } else {
             return this.chatCompletionStandard(params) as ReturnTypeBasedOnParams<P>
           }

src/types/index.ts

@@ -1,6 +1,5 @@
 import OpenAI from "openai"
-import type { ChatCompletionCreateParams } from "openai/resources/index.mjs"
-import { Stream } from "openai/streaming.mjs"
+import { Stream } from "openai/streaming"
 import { z } from "zod"
 
 import { MODE } from "@/constants/modes"
@@ -27,10 +26,10 @@ export type InstructorChatCompletionParams<T extends z.AnyZodObject> = {
 }
 
 export type ChatCompletionCreateParamsWithModel<T extends z.AnyZodObject> =
-  InstructorChatCompletionParams<T> & ChatCompletionCreateParams
+  InstructorChatCompletionParams<T> & OpenAI.ChatCompletionCreateParams
 
 export type ReturnWithoutModel<P> =
-  P extends { stream: true } ? Stream<OpenAI.Chat.Completions.ChatCompletionChunk>
+  P extends { stream: true } ? OpenAI.Chat.Completions.ChatCompletion
   : OpenAI.Chat.Completions.ChatCompletion
 
 export type ReturnTypeBasedOnParams<P> =

tests/inference.test.ts

@@ -9,7 +9,7 @@
 import Instructor from "@/instructor"
 import { describe, expect, test } from "bun:test"
 import OpenAI from "openai"
-import { Stream } from "openai/streaming.mjs"
+import { Stream } from "openai/streaming"
 import { type } from "ts-inference-check"
 import { z } from "zod"