feat(client, server): allow numbers and symbols as context keys

[dinwwwh]

Summary by CodeRabbit

• Refactor
  • Improved context data type definitions to support a wider range of key formats (including numbers and symbols) for enhanced flexibility.

[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	Mar 31, 2025 2:46am

[coderabbitai]

Walkthrough

The changes update the type definitions in the client and server packages by broadening the allowed key types. In both the ClientContext and Context types, Record<string, any> is replaced with Record<PropertyKey, any>. This alteration allows keys not limited to strings but also includes numbers and symbols, adhering to the full set of valid property keys in TypeScript. The rest of the code remains unchanged.

Changes

Files	Change Summary
packages/client/src/types.ts packages/server/src/context.ts	Updated type definitions from Record<string, any> to Record<PropertyKey, any>, expanding allowed key types to include strings, symbols, and numbers.

Poem

I’m a rabbit hopping with delight,
Codes now sparkle with keys so bright,
Strings, symbols, numbers join the parade,
In type changes where flexibility is made,
With a nibble of joy, I cheer the update’s might!

---

📜 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 d1f8ea3 and f11f1a1.

📒 Files selected for processing (2)

• packages/client/src/types.ts (1 hunks)
• packages/server/src/context.ts (1 hunks)

🧰 Additional context used

🧬 Code Definitions (1)

packages/client/src/types.ts (1)

packages/client/tests/helpers.ts (1)

• ClientContext (130-130)

🔇 Additional comments (2)

packages/server/src/context.ts (1)

1-1: LGTM! More flexible context key type.

The change from Record<string, any> to Record<PropertyKey, any> allows for a more flexible context object that can use string, number, and symbol keys. This aligns well with JavaScript's property key types and maintains backward compatibility while providing more options for developers.

packages/client/src/types.ts (1)

6-6:

Details

❓ Verification inconclusive

LGTM! Consistent with server context type.

This change aligns the ClientContext type with the Context type in the server package, allowing for string, number, and symbol keys. This provides a consistent API across the codebase and enhances flexibility for developers.

Note that there's a more specific ClientContext type defined in packages/client/tests/helpers.ts that may need to be reviewed for consistency with this broader definition.

---

🏁 Script executed:

#!/bin/bash
# Check if there are any direct uses of ClientContext that might be affected by this change
rg "ClientContext" packages/client/src --type typescript -A 2 -B 2 | grep -v "extends ClientContext" | grep -v "Record<PropertyKey, any>"

# Check if there are any tests that might be affected by this change
rg "ClientContext" packages/client/tests --type typescript -A 2 -B 2

Length of output: 276

---

ClientContext Type Update – Manual Verification Recommended

The update in packages/client/src/types.ts to use Record<PropertyKey, any> makes the client context consistent with the server’s context type, supporting string, number, and symbol keys. This improves API consistency across the codebase. However, please note the following:

• The tests (in particular, the more specific ClientContext in packages/client/tests/helpers.ts) have not been re-verified for consistency with this broader definition.
• The initial search for usages of ClientContext using the --type typescript flag produced errors (“unrecognized file type: typescript”). I recommend re-running the verification with updated commands such as:

  rg "ClientContext" packages/client/src -g '*.ts' -A 2 -B 2 | grep -v "extends ClientContext" | grep -v "Record<PropertyKey, any>"
  rg "ClientContext" packages/client/tests -g '*.ts' -A 2 -B 2

  This should help ensure that no unintended issues have been introduced.

Please manually verify these points to confirm that all usages align with the new type definition.

✨ 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

• 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.
  • 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

[pkg-pr-new]

Open in Stackblitz

More templates

• @orpc/contract-first-playground
• @orpc/nextjs-playground
• @orpc/nuxt-playground
• @orpc/solid-start-playground
• @orpc/svelte-kit-playground

@orpc/arktype

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

@orpc/client

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

@orpc/contract

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

@orpc/openapi

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

@orpc/react

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

@orpc/react-query

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

@orpc/openapi-client

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

@orpc/server

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

@orpc/shared

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

@orpc/solid-query

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

@orpc/standard-server

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

@orpc/standard-server-fetch

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

@orpc/standard-server-node

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

@orpc/svelte-query

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

@orpc/valibot

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

@orpc/vue-colada

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

@orpc/vue-query

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

@orpc/zod

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

commit: f11f1a1