search

pingdotgg / uploadthing

File uploads for modern web devs
https://uploadthing.com
MIT License
4.26k stars 315 forks source link

fix: support input transformers #1043

Closed juliusmarminge closed 2 weeks ago

juliusmarminge commented 2 weeks ago

Closes #1040

Summary by CodeRabbit

vercel[bot] commented 2 weeks 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 5, 2024 2:26pm
1 Skipped Deployment | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **legacy-docs-uploadthing** | ⬜️ Ignored ([Inspect](https://vercel.com/pinglabs/legacy-docs-uploadthing/DteGLq2RXLdSQR9HL4FZoqE9muNf)) | [Visit Preview](https://legacy-docs-uploadthing-git-input-transformers-pinglabs.vercel.app) | | Nov 5, 2024 2:26pm |
changeset-bot[bot] commented 2 weeks ago

🦋 Changeset detected

Latest commit: 7efc672e1871cf31dfb8ac618c06d427fcf94247

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

This PR includes changesets to release 1 package | Name | Type | | ----------- | ----- | | uploadthing | Patch |

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

coderabbitai[bot] commented 2 weeks ago

Walkthrough

The pull request introduces a new route, withTransformedInput, to the router object, which processes an input object with a bar property, transforming it from a number to a string using the zod library for validation. Additionally, significant modifications are made to the AnyParams interface and related types, enhancing type safety and clarity in the upload functionality. The changes also include updates to test cases to validate the new route and ensure correct type inference.

Changes

File Path Change Summary
packages/react/test/client-generator.test.ts Added new route withTransformedInput for input transformation and updated test cases for validation.
packages/uploadthing/src/internal/types.ts Modified AnyParams interface: _input changed to an object with in and out properties; updated related methods.
packages/uploadthing/src/internal/upload-builder.ts Updated _input type in internalCreateBuilder and createBuilder to an object with in and out properties.
.changeset/large-flowers-allow.md Added patch to enhance "uploadthing" functionality to support input transformers.

Assessment against linked issues

Objective Addressed Explanation
Fix input type inference for zod transforms (#1040) ✅

Possibly related PRs

Suggested labels

uploadthing/client

Suggested reviewers

Poem

In the realm of code, a new route does bloom,
withTransformedInput dispels the gloom.
From number to string, the data does flow,
With zod's gentle touch, watch the types grow!
Tests now confirm all's well in the land,
A hop and a skip, we code hand in hand! 🐰✨

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://coderabbit.ai/docs) 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 2 weeks ago

📦 Bundle size comparison

Bundle Size (gzip) Visualization
Main 27.50KB See Treemap 📊
PR (6d78b570c8861c275929f39fe575572e00f782c9) 27.50KB See Treemap 📊
Diff No change
pkg-pr-new[bot] commented 2 weeks ago

Open in Stackblitz

More templates

- [@example/minimal-astro-react](https://pkg.pr.new/template/f9eec76f-f27f-460e-8c14-9c19cbf21c4f) - [@example/minimal-appdir](https://pkg.pr.new/template/9fa1d116-9d1f-4474-8915-b112961d3ef3) - [@example/minimal-expo](https://pkg.pr.new/template/556c8e71-880d-415c-9717-13d293ad013c) - [@example/minimal-nuxt](https://pkg.pr.new/template/1f9ab2bb-0cee-4d02-a14e-cf51003a3512) - [@example/minimal-pagedir](https://pkg.pr.new/template/6b598b56-27fc-480c-b3f8-a2552ec8aac8) - [@example/minimal-solidstart](https://pkg.pr.new/template/d9a321db-6c30-4d4a-8360-8a63ef69bd8d) - [@example/minimal-sveltekit](https://pkg.pr.new/template/6ef6f7bf-fc04-4ae2-a8f4-2d8cace2ff3d) - [@example/minimal-tanstack-start](https://pkg.pr.new/template/f00aa497-821e-4b5c-80d8-6c35eec000a9) 

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

commit: 7efc672