Add type compatibility test between SDK and spec types #729
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Test that the TS SDK types are in sync w/ the Spec types
Note: ModelHint, ModelPreferences, Annotations are not in the SDK yet, incubating them in a63aeeb
Motivation and Context
#727 cc/ @ihrpr
How Has This Been Tested?
Checked that
npm run test
failes w/ human-readable message before Rename reject to decline #727Did spot tests of editing either the sdk types or the spec types, e.g. switching fields between optional & required, renaming, altering strings
Breaking Changes
None
Types of changes
Checklist
Additional context
Types in the TS SDK are derived from Zod schemas, while the ones in the specs are written by hand. This causes a few type discrepancies, which are temptatively ironed out using ham-handed type mappings:
ZodObject.passthrough()
feature introduces{[key: string]: unknown}
passthroughs: we undo this w/RemovePassthrough<T>
z.unknown()
are treated as optional; we undo this w/MakeUnknownsNotOptional<T>
, with the exception of_meta
fields