fix: nuxt module options

juliusmarminge commented 6 days ago

Closes #1047

Incorporates https://github.com/Effect-TS/effect/pull/3833 + manual destruction of module options to work with static analysis

Summary by CodeRabbit

New Features
- Enhanced configuration options for the Nuxt module, including new properties for improved customization.
- Introduced a utility function to improve configuration handling by converting empty strings to undefined.
Bug Fixes
- Resolved an issue in the @uploadthing/nuxt module where specified options were not being honored.
Dependency Updates
- Updated various dependencies across multiple packages to improve stability and performance, including effect and @effect/platform.
Documentation
- Minor corrections in type definitions for consistency across modules.

changeset-bot[bot] commented 6 days ago

🦋 Changeset detected

Latest commit: e7484abe8f99ca0b11751c733bdac4b817eda001

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

This PR includes changesets to release 8 packages

| Name | Type | | ------------------- | ----- | | uploadthing | Patch | | @uploadthing/shared | Patch | | @uploadthing/nuxt | Patch | | @uploadthing/expo | Patch | | @uploadthing/react | Patch | | @uploadthing/solid | Patch | | @uploadthing/svelte | Patch | | @uploadthing/vue | 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

vercel[bot] commented 6 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 18, 2024 1:29pm

1 Skipped Deployment

coderabbitai[bot] commented 6 days ago

Walkthrough

This pull request introduces several updates primarily focused on version management across multiple packages, including uploadthing, @uploadthing/shared, and @uploadthing/nuxt. Key changes include dependency version increments and enhancements to module options, particularly for the Nuxt module. Additionally, a new utility function is added to improve configuration handling, and several methods in the UTApi class are modified for better input validation and error handling.

Changes

File Path	Change Summary
.changeset/healthy-experts-exist.md	Patched `uploadthing` and `@uploadthing/shared` packages; updated internal effect version.
.changeset/six-dodos-brush.md	Patched `@uploadthing/nuxt` to respect module options correctly.
examples/backend-adapters/server/package.json	Updated dependencies: `@effect/platform`, `@effect/platform-node`, `effect`; added `@sinclair/typebox`.
package.json	Updated dependency `@effect/vitest` version.
packages/nuxt/src/module.ts	Enhanced `ModuleOptions` type; added new properties for configuration.
packages/nuxt/src/runtime/server/api/uploadthing.ts	Introduced `emptyStringToUndefined` utility function; improved type safety and configuration handling.
packages/shared/package.json	Updated dependency `effect` version; corrected type definition path.
packages/uploadthing/package.json	Updated dependencies: `@effect/platform`, `effect`.
packages/uploadthing/src/sdk/index.ts	Modified methods in `UTApi` class for improved input handling and error management.
playground-v6/package.json	Updated dependency `effect` version.
playground/package.json	Updated dependency `effect` version.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure correct handling of environment variables (1047)	❌	The changes do not address the documentation discrepancy regarding environment variable prefixes.

Possibly related PRs

#951: Updates for the uploadthing package, directly related to this PR.
#953: Modifies Tailwind CSS configuration for @uploadthing/react, relevant to this PR.
#1001: Updates the UTApi class in the uploadthing SDK, related to changes in this PR.
#1005: Updates the uploadthing package for API changes, aligns with this PR's focus.
#1009: Updates the uploadthing package and dependencies, directly related to this PR.
#1013: Addresses compatibility issues with @uploadthing/mime-types, relevant to this PR.
#1030: Fixes a bug related to the callbackUrl in UploadThing configuration, relevant to this PR.
#1033: Enhances Nuxt module compatibility with Tailwind CSS, related to this PR.
#1041: Facilitates the release of updated packages including uploadthing, directly related to this PR.

Suggested labels

📚 documentation

Suggested reviewers

markflorkowski

Poem

🐇 In the garden where code does bloom,
New versions sprout, dispelling gloom.
With options added, the Nuxt shines bright,
Uploads now dance in the soft moonlight.
A hop, a skip, through changes we prance,
In the world of code, we take our chance! 🌼

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.

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

Open in Stackblitz

More templates

- [@example/minimal-appdir](https://pkg.pr.new/template/9f3479d9-3d19-475e-abac-1fffd89e3e36) - [@example/minimal-astro-react](https://pkg.pr.new/template/b746f050-55b8-4995-9584-93cadac177d2) - [@example/minimal-expo](https://pkg.pr.new/template/d6016159-68e5-489c-ad73-c685141ef53c) - [@example/minimal-nuxt](https://pkg.pr.new/template/c37cdb13-14b7-4f38-bd06-1881ba05a9e7) - [@example/minimal-pagedir](https://pkg.pr.new/template/d8bbce4d-ec06-4609-8f48-75e564aa6e0c) - [@example/minimal-solidstart](https://pkg.pr.new/template/f6d331f0-6671-4e1e-a324-41d1faf99a57) - [@example/minimal-sveltekit](https://pkg.pr.new/template/ff30fa37-22e8-4bb9-922e-cb5727cd3768) - [@example/minimal-tanstack-start](https://pkg.pr.new/template/751b3444-88f0-4cbd-818b-837365a79fa8)

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

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

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

commit: e7484ab

github-actions[bot] commented 6 days ago

📦 Bundle size comparison

Bundle	Size (gzip)	Visualization
Main	27.51KB	See Treemap 📊
PR (cd82c7a854c2e0141e7f7ab0a579e15110ab1dcc)	27.59KB	See Treemap 📊
Diff	↑87.00B

pingdotgg / uploadthing