Types: replacing ReadableStream and WritableStream

[GTFalcao]

Follow-up to #18511

Note: I pointed all packages that import types to a symlink to build them with these changes applied. The build was successful.

Summary by CodeRabbit

• Refactor
  • Updated public type definitions to use Node.js stream types for HTTP bodies and file streaming operations, standardizing read/write stream behavior across the API.
• Chores
  • Bumped package version to 0.3.4.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

2 Skipped Deployments

Project	Deployment	Preview	Comments	Updated (UTC)
pipedream-docs	Ignored			Oct 7, 2025 5:12pm
pipedream-docs-redirect-do-not-edit	Ignored			Oct 7, 2025 5:12pm

[coderabbitai]

Walkthrough

Version in types/package.json is bumped to 0.3.4. Public type declarations in types/src/index.ts switch from Web Streams (ReadableStream/WritableStream) to Node.js Readable/Writable for HTTPResponse.body and IFile methods; corresponding node:stream imports are added.

Changes

Cohort / File(s)	Summary of changes
Version bump types/package.json	Update version from "0.3.3" to "0.3.4".
Stream type migration types/src/index.ts	Replace Web Streams with Node.js streams: HTTPResponse.body type changed to `string

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

I thump my paw—types freshly scored,
Web streams swapped for Node’s own hoard.
A small version hop, bump to four,
Readable tunnels, Writable door.
I twitch my nose, the code feels right. 🐇✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The pull request description does not follow the repository’s template because it lacks the required “## WHY” section and instead provides an informal follow-up note and build confirmation without explaining the rationale for the changes.	Please update the PR description to include the “## WHY” heading from the template and provide the motivation and context for replacing ReadableStream and WritableStream types.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title clearly and concisely summarizes the main change of replacing ReadableStream and WritableStream types, matching the modifications in the type definitions without extraneous details or noise.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch types-update

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[js07]

Thanks for testing the TS build. I just made a formatting suggestion to fix a lint error. Otherwise it looks good to me.

[js07]

LGTM!

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

types/src/index.ts (2)

1-3: Consider using "node:stream" import and addressing formatting suggestion.

The import statement is functional, but you could improve it by:

1. Using the node: prefix for built-in modules (modern Node.js best practice)
2. Addressing the previous review comment about formatting

Apply this diff:

-import {
-  Readable, Writable,
-} from "stream";
+import {
+  Readable,
+  Writable,
+} from "node:stream";

---

127-127: Consider method naming consistency (optional).

The parameter type change from ReadableStream to Readable is correct. Optionally, you might consider renaming the method from fromReadableStream to fromReadable or similar to avoid confusion, since it now accepts Node.js Readable streams rather than Web API ReadableStream. However, this would be a breaking change and may not be worth the disruption.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 52ca47c and d2a361b.

📒 Files selected for processing (1)

• types/src/index.ts (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: Lint Code Base
• GitHub Check: pnpm publish

🔇 Additional comments (2)

types/src/index.ts (2)

121-122: LGTM!

The migration from Web Streams to Node.js streams for createReadStream() and createWriteStream() is correct and consistent with the overall changes in this PR.

---

76-76: Document and verify Node.js Readable streams breaking change. HTTPResponse.body now uses Node.js Readable instead of Web Streams—ensure any runtime handlers or examples consuming this property are updated accordingly and note this breaking change in the CHANGELOG.