docs: improve "Router to Contract"

[tresorama]

I haven't tested it.
Only written the result of this Github Discussion https://github.com/unnoq/orpc/discussions/696

Closes: https://github.com/unnoq/orpc/issues/732

Summary by CodeRabbit

• Documentation
  • Improved guidance on TypeScript typing for imported contract JSON, including a safer example that preserves type inference and type safety when using contracts on the client side.
  • Added a warning note explaining the necessity of manual casting due to JSON serialization limitations of standard schema types.

[vercel]

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	Jul 11, 2025 9:49am

[coderabbitai]

Walkthrough

The documentation for "Router to Contract" was updated to clarify and improve guidance on TypeScript typing when importing contract JSON on the client side. The new content explains why casting to any is unsafe and demonstrates how to use the router type for better type inference and safety.

Changes

File(s)	Change Summary
apps/content/docs/contract-first/router-to-contract.md	Expanded documentation with explanations and examples for type-safe TypeScript contract imports, replacing any casts with typeof router and adding a warning note about serialization limitations.

Possibly related PRs

• unnoq/orpc#184: Adds utilities for inferring input/output types from the contract router, complementing the improved type safety documentation.
• unnoq/orpc#578: Introduces the original "Router to Contract" guide and related utilities, which the current PR extends with enhanced typing guidance.

Poem

🐇
A hop through docs with types in tow,
From any fields we now outgrow.
With router types, our contracts gleam,
Type safety reigns, a coder’s dream!
So onward bound, with types in hand—
The safest code across the land!

---

📜 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 fe8d6de and 2b81635.

📒 Files selected for processing (1)

• apps/content/docs/contract-first/router-to-contract.md (1 hunks)

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

• apps/content/docs/contract-first/router-to-contract.md

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

[gemini-code-assist]

Summary of Changes

Hello @tresorama, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the documentation to provide a clearer, type-safe example for initializing clients when deriving contracts from routers. The aim is to guide users towards better TypeScript practices by demonstrating how to avoid as any for contract casting, enhancing code reliability and maintainability.

Highlights

• Documentation Update: Added a new example to the router to contract documentation, illustrating how to achieve type-safe client initialization using as typeof router and import type for improved TypeScript inference.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds a documentation example for creating a type-safe client from a router-derived contract. The review focuses on clarifying the type-casting process and ensuring the example uses the more precise typeof router pattern for type safety.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

apps/content/docs/contract-first/router-to-contract.md (1)

52-54: Tighten language for clarity & correctness

Grammar/wording tweaks improve readability:

1. Use the 3-person singular: “bypasses”.
2. Capitalise “TypeScript”.
3. Prefer the more specific “typeof router” phrasing.

-This usage doesn't make the client type-safe, because `as any` bypass any typescript inference, so you can use `as typeof router` if you want better types
+`as any` disables type safety because it bypasses TypeScript inference.  
+Cast to `typeof router` (or an alias of it) to preserve proper types:

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f356b86 and 8f96553.

📒 Files selected for processing (1)

• apps/content/docs/contract-first/router-to-contract.md (1 hunks)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

[pkg-pr-new]

More templates

• @orpc/astro-playground
• @orpc/browser-extension-playground
• @orpc/cloudflare-worker-playground
• @orpc/contract-first-playground
• @orpc/electron-playground
• @orpc/nest-playground
• @orpc/next-playground
• @orpc/nuxt-playground
• @orpc/solid-start-playground
• @orpc/svelte-kit-playground
• @orpc/tanstack-start-playground

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@752

@orpc/client

npm i https://pkg.pr.new/@orpc/client@752

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@752

@orpc/experimental-durable-event-iterator

npm i https://pkg.pr.new/@orpc/experimental-durable-event-iterator@752

@orpc/hey-api

npm i https://pkg.pr.new/@orpc/hey-api@752

@orpc/json-schema

npm i https://pkg.pr.new/@orpc/json-schema@752

@orpc/nest

npm i https://pkg.pr.new/@orpc/nest@752

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@752

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@752

@orpc/react

npm i https://pkg.pr.new/@orpc/react@752

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@752

@orpc/server

npm i https://pkg.pr.new/@orpc/server@752

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@752

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@752

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@752

@orpc/standard-server-aws-lambda

npm i https://pkg.pr.new/@orpc/standard-server-aws-lambda@752

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@752

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@752

@orpc/standard-server-peer

npm i https://pkg.pr.new/@orpc/standard-server-peer@752

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@752

@orpc/tanstack-query

npm i https://pkg.pr.new/@orpc/tanstack-query@752

@orpc/trpc

npm i https://pkg.pr.new/@orpc/trpc@752

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@752

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@752

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@752

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@752

commit: 2b81635