docs: add jwt string validator

[kotkoroid]

A JWT validator was introduced in Zod 3.24, but this change has not yet been reflected in the documentation. This pull request aims to rectify that by incorporating the release notes and adding a note that the JWT must include a type claim in the protected header for it to be successfully validated.

Summary by CodeRabbit

• Documentation
  • Introduced a new section detailing JSON Web Tokens and how to validate their format.
  • Updated the table of contents to include this new JWT section.
  • Provided a clear example demonstrating how to apply specific algorithm constraints.
  • Made minor formatting improvements for enhanced readability.

[coderabbitai[bot]]

Walkthrough

The documentation has been updated to include a new section on JSON Web Tokens (JWTs) in the README file. A new method, z.string().jwt(), is introduced with a detailed explanation about validating JWT strings—checking for the correct 3-part format and demonstrating how to constrain the token to a specific algorithm such as RS256. Additionally, some minor formatting adjustments (e.g., removal of extra spaces and line breaks) have been applied.

Changes

File	Summary
README.md	• Added a new JWT section with an entry in the Table of Contents • Introduced the z.string().jwt() method with usage examples and algorithm constraints • Applied minor formatting fixes (extra space removals and line break adjustments)

Poem

In the field of docs, I hop along,
Spreading tokens where they belong,
A sparkling method now in view,
With JWT magic shining through,
I, a happy rabbit, sing this song!

---

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.

[netlify[bot]]

✅ Deploy Preview for guileless-rolypoly-866f8a ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	6783fd586edcbdb9e16bd61660e26199f34e0c46
🔍 Latest deploy log	https://app.netlify.com/sites/guileless-rolypoly-866f8a/deploys/67ee801c48afbd0008f7574b
😎 Deploy Preview	https://deploy-preview-4069--guileless-rolypoly-866f8a.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[vercel[bot]]

Deployment failed with the following error:

Creating the Deployment Timed Out.