chore: add size and uploadedAt fields for listFiles

[juliusmarminge]

Closes #899
Closes #927

Summary by CodeRabbit

• New Features

  • Enhanced file management API with additional properties for file size and upload timestamp in the file listing response.
  • Improved validation for the signed URL generation, ensuring a valid expiration time and maximum duration.

• Bug Fixes

  • Consistent error handling and logging across various file management methods.

• Chores

  • Updated turbo dependency version in package.json.
  • Added new development scripts for the next-playground and docs directories.
  • Updated eslint-config-turbo dependency version in the ESLint configuration package.

[changeset-bot]

⚠️ No Changeset found

Latest commit: b294561

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[vercel]

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	Dec 3, 2024 4:57pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
legacy-docs-uploadthing	⬜️ Ignored (Inspect)	Visit Preview		Dec 3, 2024 4:57pm

[coderabbitai]

Walkthrough

The changes in this pull request enhance the UTApi class in the packages/uploadthing/src/sdk/index.ts file, specifically improving the listFiles method by adding size and uploadedAt properties to the ListFileResponse schema. Other methods, including deleteFiles, getFileUrls, and getSignedURL, have been updated to align with the new response schemas and include enhanced error handling. The getSignedURL method now validates the expiresIn parameter, ensuring it meets specified criteria.

Changes

File Path	Change Summary
packages/uploadthing/src/sdk/index.ts	Updated listFiles to include size and uploadedAt in ListFileResponse. Modified several methods to use new response schema and improved error handling in getSignedURL method.
package.json	Added new script entry "dev:pg" and updated turbo dependency version from 2.1.3 to 2.3.3.
tooling/eslint-config/package.json	Updated eslint-config-turbo dependency version from 2.1.3 to 2.3.3.
docs/src/app/(docs)/api-reference/openapi-spec/scalar-client.tsx	Commented out line changing specUrl to a new URL for OpenAPI specification.

Assessment against linked issues

Objective	Addressed	Explanation
Enhance listFiles API to return additional fields (#899)	✅
Include metadata field for file size in listFiles (#927)	✅

Possibly related PRs

• fix: dropzone behavior #980: The changes in the main PR regarding the UTApi class and its methods for file management and metadata handling are related to the fixes made in this PR, which addresses issues with file uploads in various frameworks, including React, Solid, and Vue.
• feat: support more input parsers #1061: The addition of support for more input parsers in this PR aligns with the changes in the main PR that enhance the functionality of the UTApi class, particularly in how inputs are handled and validated.
• docs: add callout for listFiles #1066: The documentation updates regarding the listFiles method in this PR complement the changes in the main PR, which modifies the method's functionality and response structure, emphasizing the importance of proper usage and performance considerations.

Suggested labels

📚 documentation

Suggested reviewers

• markflorkowski
• t3dotgg

Poem

🐰 In the land of files, where data does play,
Size and time now join in a bright array.
With each upload, new details unfold,
A clearer view of stories told.
Hooray for the changes, let’s hop and cheer,
For the API's magic is finally here! ✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3320ebd and b294561.

📒 Files selected for processing (2)

• docs/src/app/(docs)/api-reference/openapi-spec/scalar-client.tsx (1 hunks)
• package.json (2 hunks)

✅ Files skipped from review due to trivial changes (1)

• docs/src/app/(docs)/api-reference/openapi-spec/scalar-client.tsx

🚧 Files skipped from review as they are similar to previous changes (1)

• package.json

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

packages/uploadthing/src/sdk/index.ts (1)

319-319: LGTM! Consider adding JSDoc comments for the new fields.

The addition of size and uploadedAt fields to the ListFileResponse schema aligns well with the PR objectives.

Consider adding JSDoc comments to document:

• size: The file size in bytes
• uploadedAt: The Unix timestamp of when the file was uploaded

Also applies to: 326-326

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9aa5db8 and 9ec46dc.

📒 Files selected for processing (1)

• packages/uploadthing/src/sdk/index.ts (1 hunks)

🔇 Additional comments (1)

packages/uploadthing/src/sdk/index.ts (1)

319-326: Successfully implements the requested features from issues #899 and #927.

The schema changes effectively address the requirements by:

1. Adding file size information as requested in both issues
2. Maintaining the upload status field for tracking file state
3. Adding upload timestamp as a bonus feature for better file management

This implementation will improve user experience by providing essential metadata before file downloads.

[github-actions]

📦 Bundle size comparison

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

[pkg-pr-new]

Open in Stackblitz

More templates

• @example/minimal-appdir
• @example/minimal-astro-react
• @example/minimal-nuxt
• @example/minimal-expo
• @example/minimal-pagedir
• @example/minimal-sveltekit
• @example/minimal-solidstart
• @example/minimal-tanstack-start

npm i https://pkg.pr.new/pingdotgg/uploadthing@1080

commit: b294561