chore(orm): simplify typing of client constructor

[ymc9]

Summary by CodeRabbit

• Refactor
  • Enhanced ORM client API usability by introducing default type parameters for the Options generic type. Developers can now instantiate clients more concisely without requiring explicit type annotations, while preserving full backward compatibility with all existing implementations. This simplifies client configuration and reduces boilerplate code needed for many common use cases.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The ClientConstructor interface in the ORM client module now provides a default type parameter for Options, enabling consumers to omit the second generic type argument while maintaining backward compatibility with existing constructor signatures.

Changes

Cohort / File(s)	Change Summary
TypeScript Type Parameter Default packages/orm/src/client/contract.ts	Added default type parameter = ClientOptions<Schema> to the Options generic in the ClientConstructor constructor signature, allowing the second type argument to be inferred or omitted.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Verify the default type parameter aligns with the intended inference behavior and doesn't inadvertently break existing type-safe patterns.
• Confirm that omitting the Options type argument still produces correct type narrowing in client instantiation scenarios.

Poem

🐰 A default type now graces the way,
Where Options can hide, come what may,
Less typing, less fuss, the schema stays true,
The ClientConstructor hops forward anew! 🌱

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'chore(orm): simplify typing of client constructor' clearly and concisely describes the main change: adding a default generic type parameter to the ClientConstructor to simplify its type usage.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/simplify-constructor

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 351780c and fff1b4c.

📒 Files selected for processing (1)

• packages/orm/src/client/contract.ts

🧰 Additional context used

🧬 Code graph analysis (1)

packages/orm/src/client/contract.ts (2)

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

• SchemaDef (11-19)

packages/orm/src/client/options.ts (1)

• ClientOptions (45-110)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: Upload results
• GitHub Check: build-test (20.x, sqlite)
• GitHub Check: build-test (20.x, postgresql)

🔇 Additional comments (1)

packages/orm/src/client/contract.ts (1)

246-249: LGTM! Cleaner type inference for constructor usage.

The addition of the default type parameter improves ergonomics by allowing consumers to omit the Options type argument when instantiating the client. This is consistent with the ClientContract interface (line 63) and maintains full backward compatibility.

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[claude]

Claude finished @ymc9's task —— View job

---

Code Review for PR #525

Reviewing the changes to simplify typing of client constructor.

Todo List:

• Read the changed file to understand the modification
• Analyze code quality and typing improvements
• Check for potential bugs or issues
• Review performance and security considerations
• Verify test coverage implications
• Check consistency with existing patterns

---

Review Summary

This is a good, focused change that improves TypeScript ergonomics for the ClientConstructor interface. The modification adds a default type parameter to make the Options parameter optional with a sensible default.

Changes Made

The change is in packages/orm/src/client/contract.ts:246:

-    new <Schema extends SchemaDef, Options extends ClientOptions<Schema>>(
+    new <Schema extends SchemaDef, Options extends ClientOptions<Schema> = ClientOptions<Schema>>(

Code Quality & Best Practices ✅

• Excellent: The change follows TypeScript best practices by providing a sensible default for generic type parameters
• Consistent: This pattern is already used in the main ClientContract type (line 63), so this change brings consistency to the constructor interface
• Clean: Simple, focused change that doesn't introduce unnecessary complexity

Potential Issues ✅

• No bugs identified: The change is purely additive and maintains backward compatibility
• Type safety preserved: The constraint Options extends ClientOptions<Schema> ensures type safety is maintained
• No breaking changes: Existing code will continue to work exactly as before

Performance Considerations ✅

• No impact: This is a compile-time only change that affects TypeScript inference but has no runtime performance implications
• Improved DX: Developers won't need to explicitly specify the Options type parameter in most cases

Security Concerns ✅

• No security implications: Type-only change with no runtime behavior modifications

Test Coverage Considerations ✅

• Low risk: Since this is a type-only change that maintains backward compatibility, existing tests should continue to pass
• No new test coverage needed: The change doesn't introduce new functionality that would require additional tests

Recommendation: ✅ APPROVE

This is a well-crafted improvement that enhances the developer experience by making the Options type parameter optional while maintaining full type safety and backward compatibility. The change aligns with existing patterns in the codebase and follows TypeScript best practices.

---

[Copilot]

Pull request overview

This PR simplifies the typing of the client constructor by adding a default type parameter to the Options generic. The change makes the ClientConstructor interface more convenient to use when the specific options type is not explicitly needed.

• Adds a default type parameter = ClientOptions<Schema> to the Options generic in ClientConstructor

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.