Add TypeBox Protocol Types #1
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Hello!
This PR includes a TypeBox port for the current Zod protocol types where the protocol structures are modeled using pure JSON Schema representations. These updates are written to make protocol structures directly compatible with Ajv without schema translation.
I have also included a
typebox.types.test.tswhich implements Ajv and TypeBox versions of the currentz.safeParsetests.Updates
src/typebox/types.tssrc/typebox.spec.types.test.tssrc/typebox.types.test.tssrc/spec.types.test.tssrc/zod.spec.types.test.tssrc/types.test.tssrc/zod.types.test.tsNotes:
TypeBox can generate Zod and TypeScript-aligned JSON Schemas while ensuring that the resulting schematics remain specification-compliant and fully compatible with Ajv.
This PR is not necessarily proposing that the SDK replace Zod with TypeBox (although that is an option), but rather introduces a path for the SDK to achieve internal JSON Schema compliance. Using TypeBox, it would be possible to model protocol types that can be serialized as JSON Schema documents and published alongside the SDK.
This approach would allow the SDK to decouple from external libraries, including TypeBox itself, and rely internally on standardized JSON Schema definitions validated through Ajv.
Submitting for review and consideration