Bundle `sdk` for browser (no polyfills required!), and for Node.js #3358

mondoreale · 2026-01-19T20:07:10Z

Summary

Introduces a Rollup-based bundling system for the SDK, enabling proper platform-specific builds for both Node.js and browser environments with architectural refactoring to support environment-specific code via the @/ path alias pattern.

Key Changes

Rollup bundling pipeline - Added rollup.config.mts producing multiple output formats:
- Node.js: ESM (.js) and CJS (.cjs)
- Browser: ESM (.js) and CJS (.cjs)
- UMD: Regular and minified builds for <script> tag usage
Platform-specific code organization - Introduced _browser/ and _nodejs/ directories with @/ path alias that resolves to the correct platform at build time:
- Persistence: Browser uses IndexedDB, Node.js uses SQLite
- createRSAKeyPair: Browser uses WebCrypto, Node.js uses native crypto
TypeScript configuration refactor - Split into tsconfig.node.json and tsconfig.browser.json for separate compilation targets
Browser compatibility improvements:
- Replaced crypto.randomBytes with @noble/post-quantum/utils
- Added publicEncrypt and privateDecrypt to @streamr/utils
- Aliased stream → readable-stream and timers → timers-browserify

Known Limitations

Persistence.exists() is not implemented for browser (throws error) - this functionality is Node.js only

Future Considerations

In the SDK, browser-specific code lives in src/_browser/ and Node.js-specific code in src/_nodejs/. This underscore-prefixed directory pattern could be applied to other packages in the monorepo that need platform-specific implementations.

…tils - Move Persistence interface from Persistence.ts to types.ts - Update import in PersistenceManager to use type-only import

…directories - Move `BrowserPersistence` and `ServerPersistence` to `_browser` and `_nodejs` directories respectively. - Rename both classes to `Persistence` with named exports, enabling consistent imports via the `@/` path alias that resolves to the appropriate platform directory at build time.

Switch from Node.js `crypto.randomBytes` to `@noble/post-quantum/utils` `randomBytes` for browser compatibility across encryption utilities and test files.

…files

Replace migrationsPath with migrationsUrl to use import.meta.url in shared code, avoiding path/url imports. Node.js Persistence converts URL to path using fileURLToPath.

The new name matches the pattern.

¯\_(ツ)_/¯

Funny how drilling for them deps turn the whole thing into a maze.

This will, potentially, resolve the issues with `nightwatch`.

Copilot

Pull request overview

This PR introduces a comprehensive Rollup-based bundling system to replace Webpack, enabling platform-specific builds for both Node.js and browser environments without requiring polyfills. The refactoring separates platform-specific code using the @/ path alias pattern that resolves to _browser/ or _nodejs/ directories at build time.

Changes:

Replaced Webpack with Rollup for SDK and utils packages, producing ESM, CJS, and UMD outputs
Split TypeScript configurations into browser and Node.js targets with separate compilation
Migrated from crypto.randomBytes to @noble/post-quantum/utils and added publicEncrypt/privateDecrypt wrappers

Reviewed changes

Copilot reviewed 73 out of 77 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`packages/sdk/rollup.config.mts`	New Rollup configuration for SDK with platform-specific builds
`packages/utils/rollup.config.mts`	Updated external dependencies for browser bundle
`packages/sdk/tsconfig.*.json`	Split TypeScript configs for browser/Node.js compilation
`packages/sdk/src/_browser/Persistence.ts`	Browser-specific IndexedDB persistence implementation
`packages/sdk/src/_nodejs/Persistence.ts`	Node.js-specific SQLite persistence implementation
`packages/utils/src/browser/crypto.ts`	Browser crypto utilities with public-encrypt integration
`packages/sdk/webpack.config.js`	Removed Webpack configuration
`release.sh`	Removed separate SDK browser build step
Various test files	Updated imports to use explicit paths instead of barrel exports

Comments suppressed due to low confidence (1)

packages/sdk/src/_browser/Persistence.ts:39

The browser Persistence throws an error for the exists() method with message "Method not implemented in browser Persistence." However, the PersistenceContext interface requires this method. This could cause runtime errors if code tries to call exists() on browser persistence. Consider either implementing a browser-compatible version (e.g., checking IndexedDB database existence) or making the method optional in the interface with clear documentation about platform support.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/sdk/test/browser-smoke-test/nightwatch.conf.js

packages/utils/rollup.config.mts

Both work but empty string is confusing.

Copilot

Pull request overview

Copilot reviewed 73 out of 77 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

packages/sdk/src/_browser/Persistence.ts:39

The browser Persistence implementation throws an error for the exists() method, but this could cause issues if code tries to use it. Consider returning a stub implementation (e.g., always return true or false) rather than throwing an error, as this would be more resilient to future usage patterns. The Node.js implementation at packages/sdk/src/_nodejs/Persistence.ts:46 provides a real implementation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

packages/utils/src/browser/crypto.ts

github-actions bot added cli-tools Related to CLI Tools Package utils sdk node labels Jan 19, 2026

mondoreale force-pushed the bundle-sdk branch from 415cec0 to 1cf013c Compare January 21, 2026 10:33

github-actions bot added network Related to Network Package test-utils Related to Test Utils Package dht Related to DHT package proto-rpc labels Jan 22, 2026

mondoreale added 21 commits January 23, 2026 14:57

Bundle sdk

6245753

Include a tersered UMD build of the SDK, too

57e5fd0

Format

bd8dfbb

Alias timers properly

db16a44

refactor(sdk): Rename Persistence.ts to types.ts in persistence u…

83db66d

…tils - Move Persistence interface from Persistence.ts to types.ts - Update import in PersistenceManager to use type-only import

Add @/ path aliases for _browser and _nodejs folders in SDK

9452c52

refactor(sdk): Consolidate persistence types into single file

191b62c

refactor(sdk): Replace crypto.randomBytes with @noble/post-quantum

6bff8ad

Switch from Node.js `crypto.randomBytes` to `@noble/post-quantum/utils` `randomBytes` for browser compatibility across encryption utilities and test files.

refactor(sdk): Use cipheriv utils from @streamr/utils

2d2d42a

Format

a9a5e8e

feat(utils): Add publicEncrypt and privateDecrypt

d0eb9e2

refactor(sdk): Extract RSAKeyPair creation to environment-specific …

dbbdaf3

…files

Swap stream to readable-stream for browsers

91bfadd

refactor(sdk): Use URL for migrations path instead of string

2337482

Replace migrationsPath with migrationsUrl to use import.meta.url in shared code, avoiding path/url imports. Node.js Persistence converts URL to path using fileURLToPath.

Format

b351310

breaking: Stick to named export only

ee5e3b3

Fix build; rename "script" bundle

ca38e65

The new name matches the pattern.

Fix missing tsconfig (fixes SDK's build)

d792d9c

Re-wire imports (don't import internals via re-exports)

b1456b5

Fix usage of the randomBytes util

f1a01c7

mondoreale added 9 commits January 23, 2026 14:58

Force karma to use cjs build of DHT

9aed209

¯\_(ツ)_/¯

Update comment for bundled browser dependencies in rollup config

45969a5

There's no build-browser anymore – all bundles at once

862baa2

Drill to resolve browser-ready modules + custom randombytes

02430d3

Make generateClientId process-less browser-ready

c0d18e0

Let nightwatch pick chromedriver automatically

2d3051e

Update smoke tests

a55dbe0

Carry up-to-date asn1.js with the package

7243750

Funny how drilling for them deps turn the whole thing into a maze.

Drop fixed chromedriver version

63cb841

This will, potentially, resolve the issues with `nightwatch`.

mondoreale force-pushed the bundle-sdk branch from 7afa666 to f9179dc Compare January 23, 2026 13:59

Fix UMD script references

e768bda

mondoreale force-pushed the bundle-sdk branch from f9179dc to e768bda Compare January 23, 2026 14:03

github-actions bot removed network Related to Network Package test-utils Related to Test Utils Package cli-tools Related to CLI Tools Package dht Related to DHT package proto-rpc node labels Jan 23, 2026

mondoreale marked this pull request as ready for review January 23, 2026 14:12

mondoreale requested a review from Copilot January 23, 2026 14:12

Copilot started reviewing on behalf of mondoreale January 23, 2026 14:13 View session

Copilot AI reviewed Jan 23, 2026

View reviewed changes

packages/sdk/test/browser-smoke-test/nightwatch.conf.js Outdated Show resolved Hide resolved

packages/utils/rollup.config.mts Outdated Show resolved Hide resolved

mondoreale added 3 commits January 23, 2026 15:24

Remove empty chromedriver path

7730264

Both work but empty string is confusing.

Explain packages bundled directly into browser build of @streamr/utils

a0ca393

Missed ripemd160

56c211e

mondoreale requested a review from Copilot January 23, 2026 15:14

Copilot started reviewing on behalf of mondoreale January 23, 2026 15:14 View session

Copilot AI reviewed Jan 23, 2026

View reviewed changes

packages/utils/src/browser/crypto.ts Show resolved Hide resolved

mondoreale merged commit 2c84e0a into bundles Jan 23, 2026
27 checks passed

mondoreale deleted the bundle-sdk branch January 23, 2026 15:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bundle `sdk` for browser (no polyfills required!), and for Node.js #3358

Bundle `sdk` for browser (no polyfills required!), and for Node.js #3358

mondoreale commented Jan 19, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Bundle sdk for browser (no polyfills required!), and for Node.js #3358

Bundle sdk for browser (no polyfills required!), and for Node.js #3358

Conversation

mondoreale commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Key Changes

Known Limitations

Future Considerations

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Bundle `sdk` for browser (no polyfills required!), and for Node.js #3358

Bundle `sdk` for browser (no polyfills required!), and for Node.js #3358

mondoreale commented Jan 19, 2026 •

edited

Loading