Force Name Parameter

[ethanleifer]

• Change responseModel<T>.name to be required
• Add the response_model.name parameter to all examples and tests
• Make generic types extend z.ZodTypeAny to force schemas to error
• Remove async from chatCompletion to remove a layer of nested Promise's

Is there anyway to test these cases of typechecking? @roodboi

response_model.name is undefined:

If you just have max_retires it also errors (so if you have max_retries you also need response_model but not the other way around)

Type inference still works:

[changeset-bot]

🦋 Changeset detected

Latest commit: bac8740

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@instructor-ai/instructor	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[roodboi]

This looks sick - do the stream results show the right ones too?

[ethanleifer]

Worth double checking. All tests pass.

I think we need to figure out how to make sure we or someone else doesn't break these inferences moving forward

[roodboi]

Re: testing types - even though bun will run typescript it won't do any runtime typechecking - so im not sure what good ways to check might be - maybe have a test file that sets something up in a way that depends on the inference, such that if it was wrong the build would fail or something?

[ethanleifer]

How is there no way to test types other than with vitetest which doesn't support bun

Feel like this would be super common for maintain a level of dx

[ethanleifer]

THIS WORKS!!! https://github.com/loreanvictor/ts-inference-check

I don't get how this isn't a common use case with library authors

Pretty clean too: expect(type(completionOpenAI).is<OpenAI.Chat.ChatCompletion>(true)).toBeTrue()

Left an issue to make sure there is a reason to not use this...

[roodboi]

https://github.com/instructor-ai/instructor-js/blob/main/src/constants/modes.ts#L9

maybe i did it wrong but I thought keyof typeof gave you the equivalent union type

[roodboi]

Or maybe it's just a naming collision, Mode maybe for the type?