docs: new page about enhanced PrismaClient types

[ymc9]

Summary by CodeRabbit

• New Features

  • Introduced enhanced types for PrismaClient using the enhance API, improving runtime behavior and simplifying typing.
  • Added a new check API for model-level permission verification within PrismaClient.

• Documentation

  • Updated error handling documentation to include a new error type, PrismaClientKnownRequestError, with detailed context.
  • Enhanced clarity on the usage of the check API and its limitations on edge runtimes.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
zenstack-new-site	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 1, 2024 9:37pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces updates to the documentation regarding enhanced types generated by Prisma when using the enhance API from ZenStack. It details how these enhancements affect runtime behavior and typing for PrismaClient, particularly in managing polymorphic models. Additionally, it updates the error handling documentation to include a new error type and clarifies how errors are managed. The documentation for the check API in PrismaClient is also updated, providing details on its usage and limitations.

Changes

File Path	Change Summary
docs/reference/enhanced-types.md	New documentation section added for enhanced types generated by Prisma using the enhance API.
docs/reference/error-handling.md	Updated error handling documentation; introduced PrismaClientKnownRequestError with details.
docs/reference/prisma-client-ext.md	Updated to include a new check API for model permission verification; added method and type.

Possibly related PRs

• docs: permission checker documentation #303: The documentation for the permission checker is related as it discusses the check API, which is also mentioned in the main PR regarding enhanced types and the PrismaClient.
• doc: updates about the check API #378: This PR updates the documentation for the check API, which is directly relevant to the enhancements made in the main PR regarding the PrismaClient and its types.
• Update polymorphism.md #371: This PR discusses polymorphic relations and the use of enhanced types in ZenStack, which connects to the main PR's focus on enhanced types generated by Prisma when using the enhance API.

---

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 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.