feat(core): first-class file upload on operationResource (multipart, storage-adapter seam)
Nobody has claimed this yet.
- #94 by @tnramalho — closed without merging
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 28/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- typescript
Research direction
Start by reading the operationResource, RepositoryInterface, and SchemaEntityCompiler patterns, then review related issues #52, #77, and #83 to understand the existing route and transport boundaries. Confirm the adapter and operation design with maintainers before implementation. Done means typed multipart limits, adapter-backed storage, generated OpenAPI, standard errors, and composition with auth, acl, and transactional metadata.
Written by the indexing model from the issue text.
Description
Problem
File upload (multipart/form-data) has no first-class surface in Rockets. Every app that needs one leaves the generated paths and hand-writes a controller with @UseInterceptors(FileInterceptor(...)) — which is:
- Express/Multer-specific (breaks the adapter-agnostic discipline; Fastify needs a different stack);
- outside every Rockets guarantee — no generated validation, no OpenAPI
multipartdocumentation, noroutePolicyvisibility beyond auth metadata, and exposed to the hand-written traps already filed as #83; - another reason the hand-written surface exists at all, alongside streaming/SSE (#52). Same family: transport shapes
operationResourcev1 does not speak.
Ask
A generic upload primitive that follows the house patterns:
- Declared on the resource like any operation (e.g. an
op.upload(...)shape onoperationResource), with typed limits (size, count, accepted mime types) validated at the boundary and failing with the standard error envelope. - Storage behind an adapter seam, like persistence already is (
RepositoryInterface) and entity compilation already is (SchemaEntityCompiler): local disk / S3 / GCS are configuration, not code. Core stays free of any concrete storage SDK. - Generated OpenAPI:
multipart/form-datarequest body with the file field and any declared metadata fields, so clients and codegen see the truth. - Composes with everything a generated route already has: auth,
acl,transactionalmetadata handling, and the #77 route audit.
Non-goals (follow-ups)
- Download/streaming of stored files — that is #52's Range/stream territory; this issue is the inbound half.
- Image processing, virus scanning, resumable/chunked uploads — adapter or app concerns; the seam should not preclude them.
Related: #52 (streaming/SSE — the outbound half of the same gap), #83 (the traps waiting for whoever hand-writes these routes today), #46 (field report documenting how much surface stays hand-written).
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from btwld/rockets
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
question
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
bug
Difficulty 4/5 3-5 days Newbie friendliness 52/100
-
question
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
bug
Difficulty 5/5 Over a week Newbie friendliness 45/100
Similar issues
-
[MCP]: page snapshots in .playwright-mcp/ are not git-ignored (.playwright-cli/ is, since #42318)Open
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
microsoft/playwright#44289 ·
Maintainers usually reply within 1 day
-
good first issue
Difficulty 2/5 Half a day Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
blamechris/chroxy#9272 ·
Maintainers usually reply within 1 day
-
no-repo-link tool-submission
Difficulty 1/5 Under an hour Newbie friendliness 66/100
BraveOPotato/NoSignups#2458 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
drmrd/vernacular#1061 ·
Maintainers usually reply within 1 day