feat: add TypeBox support #454

Not-Jayden · 2025-04-27T18:59:05Z

Adds support for TypeBox types

Summary by CodeRabbit

New Features
- Introduced the @orpc/typebox package, providing a converter for generating OpenAPI specifications from TypeBox schemas.
- Extended schema inference in contracts to support TypeBox schemas alongside existing schema types.
Documentation
- Added a comprehensive README for the new package, including usage examples and feature highlights.
Tests
- Added tests to verify correct conversion and schema type detection.
Chores
- Added configuration files and .gitignore for the new package.
- Updated dependencies to support TypeBox schemas in contracts.

vercel · 2025-04-27T18:59:09Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
orpc	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 27, 2025 7:19pm

coderabbitai · 2025-04-27T18:59:11Z

Walkthrough

This set of changes introduces support for the TypeBox schema library within the oRPC framework. It expands the accepted schema types in the contract package to include TypeBox schemas, adds a new @orpc/typebox package with its own configuration, converter implementation, and tests, and provides documentation and package metadata. The new converter allows TypeBox schemas to be treated as JSON Schemas for OpenAPI generation. Supporting files such as .gitignore, README.md, and tsconfig.json are also included for the new package.

Changes

File(s)	Change Summary
`packages/contract/package.json`	Added `@sinclair/typebox` as a dev dependency.
`packages/contract/src/schema.ts`	Expanded the `AnySchema` type alias to include `TSchema` from TypeBox, allowing both `StandardSchemaV1` and TypeBox schemas. Updated `InferSchemaInput` and `InferSchemaOutput` to infer types from both schema kinds.
`packages/typebox/.gitignore`	Added `.gitignore` specifying patterns for files and directories to ignore in the `typebox` package.
`packages/typebox/README.md`	Added a README introducing the `@orpc/typebox` package, its purpose, usage example, related packages, and metadata.
`packages/typebox/package.json`	Created a new package manifest for `@orpc/typebox` (v1.1.1) with metadata, scripts, peer dependencies, and export configuration.
`packages/typebox/src/converter.test.ts`	Added tests for the `TypeBoxToJsonSchemaConverter`, verifying correct conversion and schema type detection.
`packages/typebox/src/converter.ts`	Implemented the `experimental_TypeBoxToJsonSchemaConverter` class and options interface, enabling TypeBox schemas to be used as JSON Schemas.
`packages/typebox/src/index.ts`	Added re-export of all exports from `./converter`.
`packages/typebox/tsconfig.json`	Added TypeScript configuration for the `typebox` package, referencing related packages and specifying source and test file inclusion/exclusion.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Contract
    participant TypeBoxConverter
    participant OpenAPIGenerator

    User->>Contract: Define contract with TypeBox schema
    Contract->>TypeBoxConverter: Pass TypeBox schema for conversion
    TypeBoxConverter->>TypeBoxConverter: Check if schema is TypeBox (Kind property)
    TypeBoxConverter-->>Contract: Return JSON Schema (direct from TypeBox)
    Contract->>OpenAPIGenerator: Provide JSON Schema
    OpenAPIGenerator-->>User: Generate OpenAPI spec

Possibly related PRs

unnoq/orpc#261: Adds a converter for the Valibot schema library, similar in purpose to this PR's TypeBox support, as both implement schema converters for different schema libraries.
unnoq/orpc#216: Refactors schema type constraints and removes a type parameter in contract and server packages; related at the type system level but focuses on different schema typing aspects.

Poem

In TypeBox fields the schemas grow,
Now oRPC can let them flow!
With converters new and tests in tow,
JSON dreams begin to show.
Contracts flex with schema might—
Hop, hop, hooray, it works just right!
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1594511 and e015a29.

📒 Files selected for processing (1)

packages/contract/src/schema.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/contract/src/schema.ts

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

🔭 Outside diff range comments (1)

packages/typebox/src/converter.ts (1)
1-22: 💡 Verification agent
🧩 Analysis chain

Verify the implementation with different TypeBox schema types

The converter assumes all TypeBox schemas are directly usable as JSON Schema without transformation. Verify this works correctly with various TypeBox schema types.

🏁 Script executed:
#!/bin/bash
# Look for TypeBox schema usage in tests to verify compatibility
rg -A 3 "Kind\s+in\s+schema" --type ts
Length of output: 399
Add comprehensive tests for TypeBox schema conversion

The converter currently assumes every TypeBox schema can be spread directly into a JSON Schema. To gain confidence that this holds for all schema constructs, please add unit tests covering:

Primitive types: Type.String(), Type.Number(), Type.Boolean(), Type.Null()

Complex types: Type.Array(Type.String()), Type.Object({ … })

Composite types: Type.Union([ … ]), Type.Intersect([ … ]), Type.Tuple([ … ])

Other constructs: Type.Literal('foo'), Type.Enum(...), Type.Dict(...), etc.

These tests should instantiate each schema via the converter and verify the output matches the expected JSON Schema (e.g. by JSON-stringifying and comparing). This will ensure no special handling is required for any TypeBox feature.

🧰 Tools

🪛 Biome (1.9.4)

[error] 6-6: An empty interface is equivalent to {}.

Safe fix: Use a type alias instead.

(lint/suspicious/noEmptyInterface)

[error] 9-11: This constructor is unnecessary.

Unsafe fix: Remove the unnecessary constructor.

(lint/complexity/noUselessConstructor)

🧹 Nitpick comments (7)

packages/typebox/.gitignore (1)

16-23: Add OS and editor-specific ignores
Consider extending ignore patterns to include OS artifacts (.DS_Store, Thumbs.db) and common editor/IDE dirs (e.g., .vscode/, .idea/) to reduce accidental commits of such files.
packages/typebox/src/converter.test.ts (1)
1-28: Missing tests for more complex TypeBox schemas

While the current tests cover basic TypeBox schemas, consider adding tests for more complex schema features like arrays, unions, intersections, and nested objects to ensure comprehensive coverage.

Example additional test cases:
it('typeBoxToJsonSchemaConverter handles complex schemas', async () => {
  const converter = new TypeBoxToJsonSchemaConverter()
  
  // Test array
  expect(converter.convert(Type.Array(Type.String()), { strategy: 'input' }))
    .toMatchObject([true, { type: 'array', items: { type: 'string' } }])
  
  // Test union
  expect(converter.convert(Type.Union([Type.String(), Type.Number()]), { strategy: 'input' }))
    .toMatchObject([true, { oneOf: [{ type: 'string' }, { type: 'number' }] }])
  
  // Test nested object
  expect(converter.convert(
    Type.Object({ 
      user: Type.Object({ 
        name: Type.String(),
        age: Type.Number()
      })
    }), 
    { strategy: 'input' }
  )).toMatchObject([
    true, 
    {
      type: 'object',
      properties: { 
        user: { 
          type: 'object',
          properties: {
            name: { type: 'string' },
            age: { type: 'number' }
          },
          required: ['name', 'age']
        } 
      },
      required: ['user']
    }
  ])
})
packages/typebox/README.md (2)
97-100: Add alt text to the sponsors image

For better accessibility, add alternative text to the sponsors image.
-  <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
-    <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
+  <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
+    <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg' alt="oRPC Sponsors"/>
🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

99-99: Images should have alternate text (alt text)
null

(MD045, no-alt-text)

70-93: Inconsistency between code example and documentation

The example uses experimental_TypeBoxToJsonSchemaConverter while the documentation text on line 66 refers to it as just TypeBoxToJsonSchemaConverter. Ensure consistency in naming.

Either update line 66 to include the experimental_ prefix or update the import in line 72 to use the non-prefixed name, depending on the actual exported name.
packages/typebox/src/converter.ts (3)
5-6: Consider using a type alias for empty interface

An empty interface is equivalent to {}. Using a type alias would be more appropriate here.
-export interface experimental_TypeBoxToJsonSchemaConverterOptions {}
+export type experimental_TypeBoxToJsonSchemaConverterOptions = {}
🧰 Tools

🪛 Biome (1.9.4)

[error] 6-6: An empty interface is equivalent to {}.

Safe fix: Use a type alias instead.

(lint/suspicious/noEmptyInterface)

8-11: Simplify constructor implementation

The constructor doesn't perform any operations but serves as a placeholder for future options.
-  constructor(_options: experimental_TypeBoxToJsonSchemaConverterOptions = {}) {
-    // No options currently needed
-  }
+  constructor(_options: experimental_TypeBoxToJsonSchemaConverterOptions = {}) {}
🧰 Tools

🪛 Biome (1.9.4)

[error] 9-11: This constructor is unnecessary.

Unsafe fix: Remove the unnecessary constructor.

(lint/complexity/noUselessConstructor)

17-20: Type assertion could be improved

The convert method uses a type assertion with as any. Consider using a more specific type.
-    return [true, { ...schema } as any]
+    return [true, { ...schema } as Exclude<JSONSchema, boolean>]

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7a6598d and 1594511.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (9)

packages/contract/package.json (1 hunks)
packages/contract/src/schema.ts (1 hunks)
packages/typebox/.gitignore (1 hunks)
packages/typebox/README.md (1 hunks)
packages/typebox/package.json (1 hunks)
packages/typebox/src/converter.test.ts (1 hunks)
packages/typebox/src/converter.ts (1 hunks)
packages/typebox/src/index.ts (1 hunks)
packages/typebox/tsconfig.json (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/typebox/src/converter.ts (3)

packages/openapi/src/schema-converter.ts (2)

ConditionalSchemaConverter (13-15)

SchemaConvertOptions (5-7)

packages/contract/src/schema.ts (1)

AnySchema (8-8)

packages/openapi/src/schema.ts (1)

JSONSchema (6-6)

🪛 LanguageTool

packages/typebox/README.md

[misspelling] ~33-~33: Possible spelling mistakes found.
Context: ...tack Query (React, Vue, Solid, Svelte), Pinia Colada, and more. - 🚀 Server Actions: Ful...

(EN_MULTITOKEN_SPELLING_TWO)

[style] ~51-~51: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... your API or implement API contract. - [@orpc/client](https://www.npmjs.com/package/@...