feat: support more input parsers

juliusmarminge commented 5 days ago

Add support for @standard-schema/spec as input parsers. This will support Valibot >=1, Zod >=3.24, ArkType and more I believe. Also adds (parital) support for effect/Schema

Summary by CodeRabbit

Release Notes

New Features
- Added support for asynchronous input parsing in the upload functionality.
- Introduced the valibot library for enhanced input validation alongside existing validation methods.
- Integrated @standard-schema/spec for improved schema handling.
- Updated documentation to reflect support for multiple schema validators, including Effect/Schema and Valibot.
Bug Fixes
- Improved error handling during input parsing to ensure more reliable feedback on invalid inputs.
Tests
- Expanded test suite to include new validation scenarios using valibot and effect/Schema.
- Enhanced coverage for input validation, including checks for various invalid inputs and middleware functions.
- Introduced a new test file for comprehensive unit tests on input validation across multiple libraries.

changeset-bot[bot] commented 5 days ago

🦋 Changeset detected

Latest commit: 8b92ab01234e922a35c25c17e2cdcd37172df857

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

| Name | Type | | ----------- | ----- | | uploadthing | Minor |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel[bot] commented 5 days ago

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

Name	Status	Preview	Comments	Updated (UTC)
docs-uploadthing	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 22, 2024 9:21am

1 Skipped Deployment

coderabbitai[bot] commented 5 days ago

Walkthrough

The pull request introduces several modifications to the uploadthing package, primarily focusing on dependency updates and changes to input parsing logic. New dependencies, @standard-schema/spec and valibot, are added to the package.json. The input parsing functionality is updated to support asynchronous operations, including changes to method signatures in various files, enhancing type safety and error handling. Additionally, the test suite is expanded to incorporate validation using the new valibot library alongside existing tests.

Changes

File Path	Change Summary
`packages/uploadthing/package.json`	Added dependencies: `@standard-schema/spec` (v1.0.0-beta.3) and `valibot` (v1.0.0-beta.7).
`packages/uploadthing/src/internal/handler.ts`	Modified `handleUploadAction` to change input parsing from asynchronous to synchronous, simplifying error handling.
`packages/uploadthing/src/internal/parser.ts`	Updated `ParseFn` to return `Promise<TType>`, renamed `parse` to `parseAsync`, added `JsonParser` type.
`packages/uploadthing/src/internal/types.ts`	Updated `UploadBuilder` interface to enhance type safety for `input` method signatures.
`packages/uploadthing/src/internal/upload-builder.ts`	Changed `parse` method to `parseAsync`, allowing for asynchronous input parsing.
`packages/uploadthing/test/upload-builder.test.ts`	Expanded tests to include `valibot` for validation, added new test cases, and renamed existing tests for clarity.
`docs/src/app/(docs)/file-routes/page.mdx`	Updated documentation to reflect support for multiple schema validators, including `valibot` and `Effect/Schema`.
`packages/uploadthing/test/input.test.ts`	Introduced new tests for input validation using Zod, Valibot, and Effect Schema, covering various input scenarios.

Possibly related PRs

#978: This PR enhances the upload process by returning a file hash after upload, which is related to the modifications in the uploadthing package's functionality.
#997: This PR involves updates to the package.json file, which may indirectly relate to the main PR's dependency updates, although it does not directly affect the core functionality.
#1013: This PR addresses compatibility issues with the @uploadthing/mime-types package, which may relate to the overall upload functionality but does not directly connect to the changes in the main PR.
#1016: This PR updates documentation and examples, which may provide context for the changes in the main PR but does not directly relate to the code changes.
#1030: This PR updates dependency versions, which is relevant to the main PR's focus on updating the package.json file.
#1041: This PR is a release PR that includes version updates for the uploadthing package, which aligns with the changes made in the main PR.
#1043: This PR introduces support for input transformers, which is relevant to the changes in input handling in the main PR.
#1056: This PR addresses issues with Nuxt module options, which may relate to the overall functionality of the uploadthing package but does not directly connect to the main PR's changes.

Suggested labels

sdk, examples

Suggested reviewers

markflorkowski
t3dotgg

🐰 In the land of code, where rabbits hop,
New dependencies added, we won't stop!
Parsing's now async, oh what a delight,
With valibot in tests, we'll code through the night!
Type safety's enhanced, our inputs are clear,
Hopping through changes, we have nothing to fear! 🌟

[!WARNING]

Rate limit exceeded

@juliusmarminge has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 35 seconds before requesting another review.

⌛ How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://docs.coderabbit.ai/faq) for further information.

📥 Commits
Reviewing files that changed from the base of the PR and between 36acdf3448d8f3bdad35ecb5da3cc1525574af56 and 8b92ab01234e922a35c25c17e2cdcd37172df857.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

github-actions[bot] commented 5 days ago

📦 Bundle size comparison

Bundle	Size (gzip)	Visualization
Main	27.59KB	See Treemap 📊
PR (b93fc4af895ba5fac9e4ce5d5bf3836bba4758bd)	27.59KB	See Treemap 📊
Diff	No change

pkg-pr-new[bot] commented 5 days ago

Open in Stackblitz

More templates

- [@example/minimal-astro-react](https://pkg.pr.new/template/209e68f3-e357-4488-92a1-32d45dcf1365) - [@example/minimal-appdir](https://pkg.pr.new/template/67a2f679-4f18-4854-b327-ec7b683b47b7) - [@example/minimal-nuxt](https://pkg.pr.new/template/328c3d6f-a09e-4204-96de-b7bb37312014) - [@example/minimal-pagedir](https://pkg.pr.new/template/c98901de-0e44-4197-9388-9087cae384b1) - [@example/minimal-expo](https://pkg.pr.new/template/4166c481-d722-474b-a952-5616b1fffe01) - [@example/minimal-solidstart](https://pkg.pr.new/template/d8799a69-6532-41db-bf9c-504280a1f6f0) - [@example/minimal-sveltekit](https://pkg.pr.new/template/958d47db-f21a-4030-a264-e7e21be7c0e7) - [@example/minimal-tanstack-start](https://pkg.pr.new/template/5458732b-e9d9-4f83-9c08-932dfb3f80ef)

pnpm add https://pkg.pr.new/pingdotgg/uploadthing@1061

commit: 8b92ab0

pingdotgg / uploadthing