Add base64url

[colinhacks]

Summary by CodeRabbit

• New Features

  • Added comprehensive support for Base64 URL string validation.
  • Expanded the library’s string validation capabilities to include Base64 URL and additional CIDR formats.

• Documentation

  • Updated API guides and changelogs to reflect the new Base64 URL validation method.

• Tests

  • Introduced test cases to verify accurate validation of Base64 URL-encoded strings.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request adds comprehensive support for Base64 URL encoding throughout the codebase. It extends type definitions, regex validations, and schema constructors within core modules, updates documentation and tests, and streamlines some auxiliary functions. Changes also include consolidating type parameters in mini schemas and removing unused properties from various generate calls.

Changes

Files	Change Summary
packages/core/src/{checks.ts,regexes.ts,schemas.ts} packages/core/src/locales/{en-GB.ts,en.ts}	Added Base64 URL support: updated string format types ($ZodStringFormats, $ZodStringFormatChecks), introduced regex for Base64 URL, new interfaces and constructors for Base64 URL encoding, and new locale entries (with additional CIDR entries in en.ts).
packages/docs/content/{api.mdx,json-schema.mdx,packages/core.mdx,v4/changelog.mdx,v4/index.mdx)	Updated documentation with the new z.base64url() method and noted inclusion of Base64 URL in type unions.
packages/mini/src/schemas.ts	Updated parameter types to reference core module types and added a new interface and function for Base64 URL handling.
packages/tsc/{bench/object-with-extend.ts,bench/string.ts,bisect.ts,generate.ts}	Removed the path property (and other unused/commented properties) from objects passed to the generate function calls.
packages/zod/src/schemas.ts	Introduced new interface (ZodBase64URL), constructor, and helper function for Base64 URL validation; updated related method signatures in string validation.
packages/zod/tests/string.test.ts	Added tests specifically validating Base64 URL encoded strings using the new z.string().base64url() method.

Sequence Diagram(s)

sequenceDiagram
  participant Client
  participant ZodString
  participant ZodBase64URL
  participant Core
  participant RegexEngine

  Client->>ZodString: Invoke base64url()
  ZodString->>ZodBase64URL: Create Base64 URL instance
  ZodBase64URL->>Core: Initialize with base64url regex & settings
  Core->>RegexEngine: Validate string using Base64 URL RegExp
  RegexEngine-->>Core: Return validation result
  Core-->>ZodBase64URL: Pass validation outcome
  ZodBase64URL-->>ZodString: Return validated instance
  ZodString-->>Client: Provide final validated schema

Loading

Possibly Related PRs

• Implement CIDR, drop .and(), update docs #4080: Introduced new CIDR validation formats in core type definitions, closely aligning with the Base64 URL enhancements in this PR.

Poem

I’m a rabbit in the code field, hopping so free,
Bringing Base64 URL magic for all to see.
New types and regex bloom like carrots in spring,
With fresh tests and docs, hear the happy code sing!
🥕 Hop on, fellow coders—enjoy these changes with glee!

---

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

[colinhacks]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[colinhacks]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.