docs: release v2.9.0

[ymc9]

Summary by CodeRabbit

Release Notes

• Documentation Updates
  • Enhanced clarity on integrating with Clerk, emphasizing user model handling.
  • Improved guidance on using ZenStack with Prisma Client Extensions, including installation and method examples.
  • Expanded explanations for typing JSON fields, including validation and limitations.
  • Added new options for @zenstackhq/openapi and @zenstackhq/tanstack-query plugins, providing users with more control over output specifications.
  • Clarified the use of the auth() function in access policies, focusing on type resolution and user data handling.

[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 18, 2024 10:37pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request includes updates to various documentation files related to the ZenStack framework, focusing on user model handling, authentication, and the integration of plugins. Key changes involve replacing the User model with a User type in the authentication guide, enhancing clarity on JSON typing, and adding new options to plugins for better configuration. The updates aim to streamline the integration process and clarify the functionality of ZenStack with Prisma Client Extensions and plugins.

Changes

File Path	Change Summary
docs/guides/authentication/clerk.md	Updated user model handling to use type User instead of model User. Awaited auth() function. Conditional check for userId adjusted.
docs/guides/client-extensions.md	Streamlined introduction, expanded model-level methods and query-level overrides sections, added installation clarification for enhanced Prisma Client.
docs/guides/typing-json.md	Enhanced explanation of typing JSON fields, updated examples for Profile and Address, refined mutation payload validation.
docs/reference/plugins/openapi.mdx	Added new option omitInputDetails to the @zenstackhq/openapi plugin documentation.
docs/reference/plugins/tanstack-query.mdx	Introduced new portable option in the @zenstackhq/tanstack-query plugin documentation.
docs/the-complete-guide/part1/4-access-policy/4.3-current-user.md	Replaced "auth model" with "typing", clarified user data handling with external auth services. Updated examples for access control.

Possibly related PRs

• doc: updates about the check API #378: Enhances the explanation of the check API, relevant to user models and authentication processes.
• docs: doc changes for release 2.5.0 #361: Discusses the check API, related to user authentication and model handling.
• docs: release v2.3.0 #322: Introduces the check() function in the Z-Model language specification, relevant to user model management.
• Update polymorphism.md #371: Clarifies the use of types in relation to models, connecting to user type definitions.
• docs: permission checker documentation #303: Focuses on permission checking documentation, related to user model handling and authentication processes.

---

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.