Separate zod dependency from express

[mpppk]

Summary by CodeRabbit

• New Features

  • Introduced a new module for Zod validation integration with Express.js, enhancing type safety and validation capabilities.
  • Added new types and functions to facilitate the transformation of Zod API specifications into Express request handlers.

• Refactor

  • Restructured existing type definitions and imports to improve flexibility and maintainability of the API handling.
  • Updated validation middleware to accept generic validators, streamlining the validation process.

• Bug Fixes

  • Removed outdated test cases and imports to reflect the current validation strategy and improve test clarity.

• Documentation

  • Updated export names to emphasize Zod integration, clarifying the module's interface for end-users.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve a restructuring of the import paths and type definitions across several files, particularly focusing on the integration of Zod validation with Express.js. Key modifications include the removal of specific Zod types and the introduction of new types and functions to enhance validation mechanisms. The package.json has been updated to reflect these changes, facilitating better module accessibility. Overall, the updates streamline the handling of API specifications and validation within the project.

Changes

Files	Change Summary
examples/express/express.ts	Updated import statements to remove ToHandlers and typed from ../../src/express and added them from ../../src/express/zod.
package.json	Added new entry for ./express/zod module with paths for JavaScript and TypeScript definitions.
src/common/validate.ts	Enhanced type definitions for validators, introducing Method, redefining AnyValidators, and adding ValidatorsMap for improved validation structure.
src/express/index.test.ts	Modified test file to integrate newZodValidator, updated imports, and refactored the ZodValidateLocals type. Removed a test case for the /users endpoint.
src/express/index.ts	Removed ZodApiEndpoints and ZodApiSpec types, updated ToHandler and ToHandlers types for improved flexibility, and refactored validatorMiddleware. Removed the typed function.
src/express/zod.ts	Introduced new file with types and functions for integrating Zod validation with Express, including ToHandler, ToValidators, and typed function.
src/index.ts	Updated exports to reflect new Zod-specific handlers and renamed typed to expressZodTyped, streamlining the module's interface.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Express
    participant Zod

    Client->>Express: Send request
    Express->>Zod: Validate request
    Zod-->>Express: Return validation result
    Express-->>Client: Send response

Loading

🐇 "In the garden, I hop with glee,
New paths and types, oh what a spree!
With Zod by my side, so bright and clear,
Validations dance, bringing cheer!
Let's celebrate this joyful change,
In code we trust, our dreams arrange!" 🐇

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 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.