feat(core): SSE and Range transport primitives for operationResource
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Active
- Tech stack
- typescript
- Domain
- api, backend-api-design
Research direction
Start by reading the operationResource work in #43/#50, ACL expectations in #51, and the field report in #46. Define and document authoring for one SSE operation and one Range path, preserve auth/public/ACL behavior, add happy-path and unauthenticated E2E coverage plus an in-repo sample or fixture, and update CONFIGURATION.md.
Written by the indexing model from the issue text.
Description
Summary
Add first-class SSE and HTTP Range support so long-lived / media streams are not forced into handwritten Nest controllers.
From the field report (#46): chat, video, and PDF domains stayed fully app-owned in both rebuilds because Rockets has zero transport primitives beyond request/response JSON. OpenAPI can describe the route and DTOs; framing (SSE event stream, Accept-Ranges / partial content) cannot be fully expressed there — but the route, auth, ACL, and input validation still can live on operationResource.
Motivation
- ~2/3 of a real product surface is not owned-entity CRUD (#46).
operationResource(#43 / #50) covers RPC-style JSON; streaming/binary is the next compression gap.- Without this, Stargate micro-apps keep escaping to raw Nest for the highest-value UX paths.
Proposal (sketch)
- Extend
operationResource(or a sibling op kind) with explicit output modes, e.g.output: 'sse' | 'range' | schema(exact API TBD). - Keep Zod
inputvalidation + auth/acl(#51) on the same bundle. - Document what OpenAPI can and cannot represent; ship a sample (chat-style SSE and/or file Range).
Non-goals
- Full OpenAPI fidelity for SSE event schemas.
- Replacing app-owned stream business logic (tokens, backpressure policy) — only the Nest transport wiring.
Acceptance criteria
- Documented authoring for at least one SSE operation and one Range/partial response path.
- Auth / public / ACL behave like other operations (boot fail-fast where applicable).
- E2E covers happy path + unauthenticated rejection.
- Sample or fixture in-repo;
CONFIGURATION.mdupdated.
References
- Parent: #46 (Transport primitives: SSE and Range)
- Related: #43 / #50 (
operationResource), #51 (ACL first-class)
- 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
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 92/100
lingdojo/kana-dojo#34449 · 1 comment · 5 reactions ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
drizzle-team/drizzle-orm#6726 ·
Maintainers usually reply within 2 days
-
bug platform-desktop platform-windows
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Termix-SSH/Termix#1951 · 2 comments ·
Maintainers usually reply within 1 day
-
Grok provider voice list shows 5 of xAI's 28 built-in voicesPossibly taken @hkjarral claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
hkjarral/AVA-AI-Voice-Agent-for-Asterisk#883 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100