merge main

Author: bencmbrook

.eslintignore

@@ -14,4 +14,4 @@
 **/Internal-Documentation/*
 *.testjs
 *.testts
-*__snapshots__/*
+*__snapshots__/*

.github/commands/dependencies/install_yarn_deps/action.yml

@@ -19,13 +19,9 @@ runs:
           .yarn/unplugged
           .yarn/install-state.gz
           .pnp.cjs
-        key: ${{ runner.os }}-${{ runner.arch }}-yarn-v10-${{ hashFiles('**/yarn.lock', '**/package.json') }}
+        key: ${{ runner.os }}-${{ runner.arch }}-yarn-v3-${{ hashFiles('**/yarn.lock', '**/package.json') }}
         restore-keys: |
-          ${{ runner.os }}-${{ runner.arch }}-yarn-v10-
-    - uses: nick-fields/retry@v3
-      if: steps.yarn-cache.outputs.cache-hit != 'true' || inputs.force-yarn-install == 'true'
-      with:
-        timeout_minutes: 10
-        max_attempts: 3
-        retry_on: error
-        command: yarn install --immutable
+          ${{ runner.os }}-${{ runner.arch }}-yarn-v3-
+    - run: yarn install --immutable
+      name: Install yarn deps
+      shell: bash

.github/workflows/ci.yml

@@ -5,11 +5,11 @@ jobs:
   build-and-upload-artifacts:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ./.github/commands/dependencies/install_yarn_deps
       - name: Build
         run: yarn build
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: build-artifact
           path: dist/
@@ -21,24 +21,24 @@ jobs:
       BROWSERSTACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
     timeout-minutes: 10
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ./.github/commands/dependencies/install_yarn_deps
       - run: yarn test:browserstack
 
   run-depcheck:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ./.github/commands/dependencies/install_yarn_deps
       - run: yarn depcheck
 
   run-pre-commits:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 100 # need the history to do a changed files check below (source, origin)
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v5
       - uses: ./.github/commands/dependencies/install_yarn_deps
       - uses: pre-commit/action@v3.0.0
 
@@ -53,10 +53,10 @@ jobs:
       - run-pre-commits
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - uses: ./.github/commands/dependencies/install_yarn_deps
       - name: Download build artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-artifact
           path: dist
@@ -78,10 +78,10 @@ jobs:
       - run-pre-commits
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - uses: ./.github/commands/dependencies/install_yarn_deps
       - name: Download build artifact
-        uses: actions/download-artifact@v3
+        uses: actions/download-artifact@v4
         with:
           name: build-artifact
           path: dist

.vscode/settings.json

@@ -34,7 +34,7 @@
     "**/.pnp.*": true
   },
   "editor.codeActionsOnSave": {
-    "source.fixAll": "explicit"
+    "source.fixAll": "always"
   },
   "cSpell.words": [
     "allsettled",

README.md

@@ -9,14 +9,12 @@
   - [Examples](#examples)
   - [Usage](#usage)
     - [Importing Conflux](#importing-conflux)
-      - [Package Manager](#package-manager)
-      - [CDN](#cdn)
     - [Creating a ZIP](#creating-a-zip)
       - [Example using `ReadableStream#pipeThrough`](#example-using-readablestreampipethrough)
       - [Example using `writer.write`](#example-using-writerwrite)
       - [Incorporating other streams](#incorporating-other-streams)
     - [Reading ZIP files](#reading-zip-files)
-  - [Supporting Firefox](#supporting-firefox)
+  - [Supporting Legacy Browsers](#supporting-legacy-browsers)
   - [License](#license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -43,7 +41,7 @@
 
 ## Blazing Fast
 
-- ~100 kB import
+- ~55 kB import
 - Uses streams, minimizing memory overhead
 
 ## Compatibility
@@ -64,13 +62,7 @@
 
 ### Importing Conflux
 
-#### Package Manager
-
 ```sh
-# With Yarn
-yarn add @transcend-io/conflux
-
-# With NPM
 npm install --save @transcend-io/conflux
 ```
 
@@ -79,17 +71,6 @@ npm install --save @transcend-io/conflux
 import { Reader, Writer } from '@transcend-io/conflux';
 ```
 
-#### CDN
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/@transcend-io/conflux@3"></script>
-```
-
-```js
-// Reader parses zip files, Writer builds zip files
-const { Reader, Writer } = window.conflux;
-```
-
 ### Creating a ZIP
 
 #### Example using `ReadableStream#pipeThrough`
@@ -98,7 +79,7 @@ const { Reader, Writer } = window.conflux;
 import { Writer } from '@transcend-io/conflux';
 import streamSaver from 'streamsaver';
 
-const s3 = 'https://s3-us-west-2.amazonaws.com/bencmbrook/';
+const s3 = 'https://s3-us-west-2.amazonaws.com/your-bucket/';
 const files = ['NYT.txt', 'water.png', 'Earth.jpg'].values();
 
 const myReadable = new ReadableStream({
@@ -165,7 +146,7 @@ const fileStream = streamSaver.createWriteStream('conflux.zip');
   });
 
   const imgStream = await fetch(
-    'https://s3-us-west-2.amazonaws.com/bencmbrook/Earth.jpg',
+    'https://s3-us-west-2.amazonaws.com/your-bucket/Earth.jpg',
   ).then((r) => r.body);
 
   writer.write({
@@ -195,64 +176,15 @@ fetch('https://cdn.jsdelivr.net/gh/Stuk/jszip/test/ref/deflate.zip').then(
 );
 ```
 
-### Reading ZIP files from a stream
-
-#### Example using `ReadableStream#pipeThrough`
-
-<!-- prettier-ignore -->
-```js
-import { StreamReader } from '@transcend-io/conflux';
-import streamSaver from 'streamsaver';
-
-// Fetch a ZIP file from a remote source
-const zipUrl = '/some-large.zip';
-const response = await fetch(zipUrl);
-
-// Extract files with StreamReader (a TransformStream)
-response.body
-  .pipeThrough(new StreamReader())
-  .pipeTo(
-    new WritableStream({
-      // The StreamReader emits each file's name and a stream containing its contents
-      async write({ name, stream }) {
-        console.log(`Extracting: ${name}`);
-
-        // Save each extracted file, also with streams
-        const fileStream = stream();
-        await fileStream
-          .pipeTo(
-            streamSaver.createWriteStream(name)
-          );
-      },
-    }),
-  );
-```
-
-## Supporting Firefox
+## Supporting Legacy Browsers
 
-Firefox [does not support ReadableStream#pipeThrough](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream#browser_compatibility), since it does not have `WritableStream` or `TransformStream` support yet. Conflux ponyfills `TransformStream` out of the box in Firefox, but if you're using the `myReadable.pipeThrough` and plan to support Firefox, you'll want to ponyfill `ReadableStream` like so:
+Conflux is compatible with all modern browsers since June 2022.
 
-```js
-import { ReadableStream as ReadableStreamPonyfill } from 'web-streams-polyfill/ponyfill';
-
-// Support Firefox with a ponyfill on ReadableStream to add .pipeThrough
-const ModernReadableStream = window.WritableStream
-  ? window.ReadableStream
-  : ReadableStreamPonyfill;
-
-const myReadable = new ModernReadableStream({
-  async pull(controller) {
-    return controller.enqueue({
-      name: `/firefox.txt`,
-      stream: () => new Response.body('Firefox works!'),
-    });
-  },
-});
+If you need to support legacy browsers, you can add polyfills for:
 
-myReadable
-  .pipeThrough(new Writer()) // see "Supporting Firefox" below
-  .pipeTo(streamSaver.createWriteStream('conflux.zip'));
-```
+- [`TransformStream`](https://developer.mozilla.org/en-US/docs/Web/API/TransformStream), and [`WritableStream`](https://developer.mozilla.org/en-US/docs/Web/API/WritableStream) (available in browsers since June 2022) by adding [web-streams-polyfill](https://www.npmjs.com/package/web-streams-polyfill).
+- [`BigInt`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) (available in browsers since January 2020) by setting `globalThis.JSBI` equal to [JSBI](https://github.com/GoogleChromeLabs/jsbi) before importing Conflux.
+- [`globalThis`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis) (available in browsers since January 2020) by adding a polyfill like this [globalthis](https://www.npmjs.com/package/globalthis) or manually setting a shim.
 
 ## License
 

benchmark/index.html

@@ -1,12 +1,12 @@
-<!doctype html>
+<!-- prettier-ignore -->
+<!DOCTYPE html>
 <html lang="en" dir="ltr">
   <head>
     <meta charset="utf-8" />
     <title></title>
   </head>
   <body>
     <p id="loading">Benchmarking...</p>
-    <!-- <script src="https://cdn.jsdelivr.net/npm/web-streams-polyfill@2.0.2/dist/polyfill.min.js"></script> -->
     <script src="https://cdn.jsdelivr.net/npm/lodash@4.17.11/lodash.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/benchmark@2.1.4/benchmark.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/jszip@3.2.2/dist/jszip.min.js"></script>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@transcend-io/conflux",
-  "version": "4.1.2",
+  "version": "5.0.0",
   "description": "Build zip files out of readable streams in the browser",
   "main": "dist/conflux.umd.min.js",
   "jsdelivr": "dist/conflux.umd.min.js",
@@ -98,10 +98,7 @@
     "tape": "^5.7.2"
   },
   "dependencies": {
-    "@babel/runtime-corejs3": "^7.23.5",
-    "jsbi": "^4.3.0",
-    "pako": "^2.1.0",
-    "web-streams-polyfill": "^3.2.1"
+    "pako": "^2.1.0"
   },
   "packageManager": "yarn@4.5.3"
 }

rollup.config.js

@@ -1,25 +1,8 @@
 import resolve from '@rollup/plugin-node-resolve';
 import commonjs from '@rollup/plugin-commonjs';
-import babel from '@rollup/plugin-babel';
 import { terser } from 'rollup-plugin-terser';
 import pkg from './package.json';
 
-const babelDefaults = {
-  // see: https://github.com/rollup/plugins/tree/master/packages/babel#babelhelpers and the note about @babel/runtime for CJS/ES
-  babelHelpers: 'runtime',
-  configFile: './babel.config.js',
-  plugins: [
-    [
-      '@babel/plugin-transform-runtime',
-      {
-        regenerator: true,
-        corejs: { version: 3, proposals: true },
-      },
-    ],
-  ],
-  exclude: ['node_modules/**'],
-};
-
 export default [
   // browser-friendly UMD build
   {
@@ -34,7 +17,6 @@ export default [
     plugins: [
       resolve(), // so Rollup can find package dependencies
       commonjs(), // so Rollup can convert package dependencies to an ES module
-      babel(babelDefaults),
       terser(),
     ],
   },
@@ -47,11 +29,10 @@ export default [
   // `file` and `format` for each target)
   {
     input: 'src/index.js',
-    external: [/pako/, /jsbi/, /web-streams-polyfill/, /@babel\/runtime/],
+    external: [/pako/],
     output: [
       // { file: pkg.main, format: 'cjs' }, // don't need a Node import yet
       { file: pkg.module, format: 'es' },
     ],
-    plugins: [babel(babelDefaults)],
   },
 ];

src/bigint.js

@@ -1,18 +1,25 @@
 /* global globalThis BigInt */
 
-import JSBI from 'jsbi';
-
-// eslint-disable-next-line import/no-mutable-exports
-let jsbi;
+if (!globalThis.BigInt && !globalThis.JSBI) {
+  throw new Error(
+    'BigInt is not supported in this browser.' +
+      ' Conflux is unable to create zip files without BigInt support, or a JSBI polyfill.',
+  );
+}
 
 /**
- * If BigInt is natively supported, change JSBI to use native expressions
- * @see https://github.com/GoogleChromeLabs/jsbi/blob/master/jsbi.d.ts
- * @see https://github.com/GoogleChromeLabs/babel-plugin-transform-jsbi-to-bigint/blob/master/src/index.js
+ * Use JSBI syntax for BigInt operations, instead of calling BigInt directly.
+ *
+ * This is NOT a polyfill. It uses native BigInt by default. Using this syntax simply makes it _possible_ to polyfill BigInt.
+ * If BigInt is not natively supported (ES2020+), library consumer MUST expose globalThis.JSBI before using Conflux.
+ *
+ * @see https://github.com/GoogleChromeLabs/jsbi - JSBI library for why BigInt
+ * @see https://github.com/GoogleChromeLabs/jsbi/blob/master/jsbi.d.ts - types
  */
-if (globalThis.BigInt) {
-  jsbi = {};
+const jsbi = globalThis.JSBI || {};
 
+// If BigInt is natively supported, use it instead of JSBI.
+if (globalThis.BigInt) {
   // constructor
   jsbi.BigInt = (a) => BigInt(a);
 
@@ -52,8 +59,6 @@ if (globalThis.BigInt) {
   // static methods
   jsbi.asIntN = (a, b) => BigInt.asIntN(a, b);
   jsbi.asUintN = (a, b) => BigInt.asUintN(a, b);
-} else {
-  jsbi = JSBI;
 }
 
 export default jsbi;