web-streams-polyfill 3.2.0 → 4.0.0-beta.2

package/es5/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "web-streams-polyfill",
+  "main": "../dist/ponyfill.es5.js",
+  "module": "../dist/ponyfill.es5.mjs",
+  "types": "../types/ponyfill.d.ts"
+}

package/package.json

@@ -1,39 +1,60 @@
 {
   "name": "web-streams-polyfill",
-  "version": "3.2.0",
+  "version": "4.0.0-beta.2",
   "description": "Web Streams, based on the WHATWG spec reference implementation",
-  "main": "dist/polyfill",
-  "browser": "dist/polyfill.min.js",
-  "module": "dist/polyfill.mjs",
-  "types": "dist/types/polyfill.d.ts",
-  "typesVersions": {
-    ">=3.6": {
-      "dist/types/*": [
-        "dist/types/ts3.6/*"
-      ]
-    }
+  "main": "dist/ponyfill.js",
+  "module": "dist/ponyfill.mjs",
+  "types": "types/ponyfill.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/ponyfill.d.ts",
+      "import": "./dist/ponyfill.mjs",
+      "require": "./dist/ponyfill.js"
+    },
+    "./es5": {
+      "types": "./types/ponyfill.d.ts",
+      "import": "./dist/ponyfill.es5.mjs",
+      "require": "./dist/ponyfill.es5.js"
+    },
+    "./polyfill": {
+      "types": "./types/polyfill.d.ts",
+      "default": "./dist/polyfill.js"
+    },
+    "./polyfill/es5": {
+      "types": "./types/polyfill.d.ts",
+      "default": "./dist/polyfill.es5.js"
+    },
+    "./dist/*": "./dist/*",
+    "./types/*": "./types/*",
+    "./package": "./package.json",
+    "./package.json": "./package.json"
   },
   "scripts": {
-    "test": "npm run test:types && npm run test:unit && npm run test:wpt",
-    "test:wpt": "node --expose_gc ./test/run-web-platform-tests.js",
-    "pretest:wpt": "git submodule update --init --recursive",
+    "test": "npm run test:types && npm run test:unit && npm run test:wpt && npm run test:bundler",
+    "test:wpt": "npm run test:wpt:node && npm run test:wpt:chromium && npm run test:wpt:firefox",
+    "test:wpt:node": "node --expose_gc ./test/wpt/node/run.js",
+    "test:wpt:chromium": "node ./test/wpt/browser/run.js --browser chromium",
+    "test:wpt:firefox": "node ./test/wpt/browser/run.js --browser firefox",
+    "test:bundler": "npm run test:bundler:rollup && npm run test:bundler:webpack",
+    "test:bundler:rollup": "cd test/rollup && npm ci && npm test",
+    "test:bundler:webpack": "cd test/webpack && npm ci && npm test",
     "test:types": "tsc -p ./test/types/tsconfig.json",
-    "test:unit": "jasmine --config=test/unit/jasmine.json",
+    "test:unit": "node --experimental-import-meta-resolve ./node_modules/jasmine/bin/jasmine.js --config=test/unit/jasmine.json",
     "lint": "eslint \"src/**/*.ts\"",
     "build": "npm run build:bundle && npm run build:types",
     "build:bundle": "rollup -c",
-    "build:types": "tsc --project . --emitDeclarationOnly --declarationDir ./lib && api-extractor run && node ./build/downlevel-dts.js",
-    "accept:types": "tsc --project . --emitDeclarationOnly --declarationDir ./lib && api-extractor run --local && node ./build/downlevel-dts.js",
+    "build:types": "tsc --project . --emitDeclarationOnly --declarationDir ./lib && api-extractor run",
+    "accept:types": "tsc --project . --emitDeclarationOnly --declarationDir ./lib && api-extractor run --local",
     "prepare": "npm run build"
   },
   "files": [
     "dist",
-    "es6",
-    "es2018",
-    "ponyfill"
+    "es5",
+    "polyfill",
+    "types"
   ],
   "engines": {
-    "node": ">= 8"
+    "node": ">= 14"
   },
   "repository": {
     "type": "git",
@@ -54,23 +75,27 @@
   },
   "homepage": "https://github.com/MattiasBuelens/web-streams-polyfill#readme",
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.13.4",
-    "@rollup/plugin-inject": "^4.0.2",
-    "@rollup/plugin-replace": "^2.4.2",
-    "@rollup/plugin-strip": "^2.0.0",
-    "@rollup/plugin-typescript": "^8.2.1",
-    "@types/node": "^14.14.37",
-    "@typescript-eslint/eslint-plugin": "^4.21.0",
-    "@typescript-eslint/parser": "^4.21.0",
+    "@microsoft/api-extractor": "^7.21.2",
+    "@rollup/plugin-inject": "^4.0.4",
+    "@rollup/plugin-replace": "^4.0.0",
+    "@rollup/plugin-strip": "^2.1.0",
+    "@rollup/plugin-typescript": "^8.3.1",
+    "@types/jasmine": "^4.0.2",
+    "@types/node": "^14.18.12",
+    "@typescript-eslint/eslint-plugin": "^5.19.0",
+    "@typescript-eslint/parser": "^5.19.0",
     "@ungap/promise-all-settled": "^1.1.2",
-    "eslint": "^7.23.0",
-    "jasmine": "^3.7.0",
-    "micromatch": "^4.0.2",
-    "rollup": "^2.44.0",
+    "abort-controller": "^3.0.0",
+    "eslint": "^8.13.0",
+    "jasmine": "^4.0.2",
+    "micromatch": "^4.0.5",
+    "minimist": "^1.2.6",
+    "playwright": "^1.20.2",
+    "recursive-readdir": "^2.2.2",
+    "rollup": "^2.70.1",
     "rollup-plugin-terser": "^7.0.2",
-    "ts-morph": "^10.0.2",
-    "tslib": "^2.2.0",
-    "typescript": "^4.2.4",
-    "wpt-runner": "^3.2.1"
+    "tslib": "^2.3.1",
+    "typescript": "^4.7.0-beta",
+    "wpt-runner": "^4.1.0"
   }
 }

package/polyfill/es5/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "web-streams-polyfill",
+  "main": "../../dist/polyfill.es5.js",
+  "types": "../../types/polyfill.d.ts"
+}

package/polyfill/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "web-streams-polyfill",
+  "main": "../dist/polyfill.js",
+  "types": "../types/polyfill.d.ts"
+}

package/types/polyfill.d.ts

@@ -0,0 +1,62 @@
+/// <reference lib="dom" />
+/// <reference lib="es2018.asynciterable" />
+
+import type {
+  ReadableStreamAsyncIterator,
+  ReadableStreamBYOBReader,
+  ReadableStreamBYOBReadResult,
+  ReadableStreamIteratorOptions
+} from './ponyfill';
+
+export type {
+  ReadableStreamAsyncIterator,
+  ReadableStreamBYOBReader,
+  ReadableStreamBYOBReadResult,
+  ReadableStreamIteratorOptions
+};
+
+declare global {
+  interface ReadableStream<R = any> {
+    /**
+     * Creates a {@link ReadableStreamBYOBReader} and locks the stream to the new reader.
+     *
+     * This call behaves the same way as the no-argument variant, except that it only works on readable byte streams,
+     * i.e. streams which were constructed specifically with the ability to handle "bring your own buffer" reading.
+     * The returned BYOB reader provides the ability to directly read individual chunks from the stream via its
+     * {@link ReadableStreamBYOBReader.read | read()} method, into developer-supplied buffers, allowing more precise
+     * control over allocation.
+     */
+    getReader({ mode }: {
+      mode: 'byob';
+    }): ReadableStreamBYOBReader;
+
+    /**
+     * Creates a {@link ReadableStreamDefaultReader} and locks the stream to the new reader.
+     * While the stream is locked, no other reader can be acquired until this one is released.
+     *
+     * This functionality is especially useful for creating abstractions that desire the ability to consume a stream
+     * in its entirety. By getting a reader for the stream, you can ensure nobody else can interleave reads with yours
+     * or cancel the stream, which would interfere with your abstraction.
+     */
+    getReader(): ReadableStreamDefaultReader<R>;
+
+    /**
+     * Asynchronously iterates over the chunks in the stream's internal queue.
+     *
+     * Asynchronously iterating over the stream will lock it, preventing any other consumer from acquiring a reader.
+     * The lock will be released if the async iterator's {@link ReadableStreamAsyncIterator.return | return()} method
+     * is called, e.g. by breaking out of the loop.
+     *
+     * By default, calling the async iterator's {@link ReadableStreamAsyncIterator.return | return()} method will also
+     * cancel the stream. To prevent this, use the stream's {@link ReadableStream.values | values()} method, passing
+     * `true` for the `preventCancel` option.
+     */
+    values(options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>;
+
+    /**
+     * {@inheritDoc ReadableStream.values}
+     */
+    [Symbol.asyncIterator]: (options?: ReadableStreamIteratorOptions) => ReadableStreamAsyncIterator<R>;
+  }
+}
+

package/{dist/types/ts3.6/polyfill.d.ts → types/ponyfill.d.ts}

@@ -16,6 +16,10 @@ export declare interface AbortSignal {
      * Whether the request is aborted.
      */
     readonly aborted: boolean;
+    /**
+     * The abort reason.
+     */
+    readonly reason?: any;
     /**
      * Add an event listener to be triggered when this signal becomes aborted.
      */
@@ -87,11 +91,11 @@ export declare interface QueuingStrategyInit {
     highWaterMark: number;
 }
 
-declare type QueuingStrategySizeCallback<T = any> = (chunk: T) => number;
-
-declare type ReadableByteStream = ReadableStream<Uint8Array> & {
-    _readableStreamController: ReadableByteStreamController;
-};
+/**
+ * {@inheritDoc QueuingStrategy.size}
+ * @public
+ */
+export declare type QueuingStrategySizeCallback<T = any> = (chunk: T) => number;
 
 /**
  * Allows control of a {@link ReadableStream | readable byte stream}'s state and internal queue.
@@ -233,7 +237,7 @@ export declare interface ReadableStreamAsyncIterator<R> extends AsyncIterator<R>
  * @public
  */
 export declare class ReadableStreamBYOBReader {
-    constructor(stream: ReadableByteStream);
+    constructor(stream: ReadableStream<Uint8Array>);
     /**
      * Returns a promise that will be fulfilled when the stream becomes closed, or rejected if the stream ever errors or
      * the reader's lock is released before the stream finishes closing.

package/{dist/types → types}/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.13.4"
+      "packageVersion": "7.21.2"
     }
   ]
 }

package/CHANGELOG.md

@@ -1,134 +0,0 @@
-# Changelog
-
-> **Tags:**
-> - 💥 Breaking Change
-> - 👓 Spec Compliance
-> - 🚀 New Feature
-> - 🐛 Bug Fix
-> - 👎 Deprecation
-> - 📝 Documentation
-> - 🏠 Internal
-> - 💅 Polish
-
-## v3.2.0 (2021-11-06)
-
-* 👎 Deprecate `WritableStreamDefaultController.abortReason` ([#102](https://github.com/MattiasBuelens/web-streams-polyfill/pull/102))
-  * Use `WritableStreamDefaultController.signal.reason` instead.
-* 👓 Align with [spec version `4b6b93c`](https://github.com/whatwg/streams/tree/4b6b93c69e531e2fe45a6ed4cb1484a7ba4eb8bb/) ([#103](https://github.com/MattiasBuelens/web-streams-polyfill/pull/103))
-
-## v3.1.1 (2021-09-06)
-
-* 🐛 Fix compatibility with TypeScript's DOM types for `ReadableStream` and `TransformStream` ([#85](https://github.com/MattiasBuelens/web-streams-polyfill/issues/85), [#86](https://github.com/MattiasBuelens/web-streams-polyfill/pull/86))
-
-## v3.1.0 (2021-07-21)
-
-* 🚀 Calling `ReadableStream.tee()` on a readable byte stream now returns two readable byte streams. ([#81](https://github.com/MattiasBuelens/web-streams-polyfill/pull/81))
-* 🚀 Add `WritableStreamDefaultController.signal` and `.abortReason`. ([#81](https://github.com/MattiasBuelens/web-streams-polyfill/pull/81))
-  * `.signal` requires a global `AbortController` constructor to be available. If necessary, use a polyfill.
-* 🐛 Make sure streams created with a different version of the polyfill do not pass the brand checks. ([#75](https://github.com/MattiasBuelens/web-streams-polyfill/issues/75), [#77](https://github.com/MattiasBuelens/web-streams-polyfill/pull/77))
-* 👓 Align with [spec version `cada812`](https://github.com/whatwg/streams/tree/cada8129edcc4803b2878a7a3f5e1d8325dc0c23/) ([#79](https://github.com/MattiasBuelens/web-streams-polyfill/pull/79), [#81](https://github.com/MattiasBuelens/web-streams-polyfill/pull/81))
-
-## v3.0.3 (2021-04-09)
-
-* 💅 Change `Promise<void>` to `Promise<undefined>` in TypeScript type definitions ([#72](https://github.com/MattiasBuelens/web-streams-polyfill/pull/72))
-* 🐛 Fix `ReadableStream.tee()` resolving its `cancel()` promise too early ([#73](https://github.com/MattiasBuelens/web-streams-polyfill/pull/73))
-* 👓 Align with [spec version `6762cdb`](https://github.com/whatwg/streams/tree/6762cdb4c6421cfa0da1d834d5a14fdd7326aaa5/) ([#73](https://github.com/MattiasBuelens/web-streams-polyfill/pull/73))
-
-## v3.0.2 (2021-02-10)
-
-* 👓 Align with [spec version `200c971`](https://github.com/whatwg/streams/tree/200c971563b1a695fce3eebe6dab45c348ff0ac0/) ([#69](https://github.com/MattiasBuelens/web-streams-polyfill/pull/69))
-
-## v3.0.1 (2020-11-12)
-
-* 📝 Add documentation to type definitions ([#62](https://github.com/MattiasBuelens/web-streams-polyfill/pull/62))
-* 👓 Align with [spec version `6cd5e81`](https://github.com/whatwg/streams/tree/6cd5e81f6191fed9e7d99ee73d4941e3060311ce/) ([#63](https://github.com/MattiasBuelens/web-streams-polyfill/pull/63))
-* 🐛 Fix an issue where the polyfill could throw an error when resolving/rejecting `reader.closed` when it was already resolved/rejected ([#66](https://github.com/MattiasBuelens/web-streams-polyfill/issues/66), [#67](https://github.com/MattiasBuelens/web-streams-polyfill/pull/67))
-
-## v3.0.0 (2020-07-20)
-
-* 💥 Align with [spec version `62fe4c8`](https://github.com/whatwg/streams/tree/62fe4c8c0df34cec4ff28db9bfa69aec6c65e38d/) ([#52](https://github.com/MattiasBuelens/web-streams-polyfill/pull/52), [#57](https://github.com/MattiasBuelens/web-streams-polyfill/pull/57), [#59](https://github.com/MattiasBuelens/web-streams-polyfill/pull/59))  
-  This includes the following **breaking changes**:
-  * All classes are now exposed globally. Concretely, this adds the following classes:
-    * `ReadableStreamDefaultController`
-    * `ReadableByteStreamController`
-    * `ReadableStreamBYOBRequest`
-    * `ReadableStreamDefaultReader`
-    * `ReadableStreamBYOBReader`
-    * `WritableStreamDefaultController`
-    * `WritableStreamDefaultWriter`
-    * `TransformStreamDefaultController`
-  * `ReadableStream.getIterator()` is renamed to `ReadableStream.values()`
-  * `ReadableByteStreamController.byobRequest` can be `null` (instead of `undefined`) if there is no current BYOB request.
-  * `ReadableStreamBYOBRequest.view` can be `null` (instead of `undefined`) if the BYOB request has already been responded to.
-  * Constructors and methods have stricter type checking for object arguments. For example, `new ReadableStream(null)` would previously behave like `new ReadableStream({})`, but now it throws a `TypeError` instead.
-  * Some constructors and methods may throw slightly different errors when given invalid arguments.
-  * Various byte-stream-related APIs now prohibit zero-length views or buffers.
-  * The async iterator of a `ReadableStream` now behaves more like an async generator, e.g. returning promises fulfilled with `{ value: undefined, done: true }` after `return()`ing the iterator, instead of returning a rejected promise.
-* 💥 Updated TypeScript types to align with new specification ([#60](https://github.com/MattiasBuelens/web-streams-polyfill/pull/60))  
-  While these are _technically_ breaking changes, you should only be affected if you manually reference these types from your code.
-  * `PipeOptions` is renamed to `StreamPipeOptions`
-  * `ReadResult` is replaced by `ReadableStreamDefaultReadResult` and `ReadableStreamBYOBReadResult`
-  * `ReadableStreamDefaultControllerCallback` is replaced by `UnderlyingSourceStartCallback` and `UnderlyingSourcePullCallback`
-  * `ReadableByteStreamControllerCallback` is replaced by `UnderlyingByteSourceStartCallback` and `UnderlyingByteSourcePullCallback`
-  * `ReadableStreamErrorCallback` is renamed to `UnderlyingSourceCancelCallback`
-  * `WritableStreamDefaultControllerStartCallback` is renamed to `UnderlyingSinkStartCallback`
-  * `WritableStreamDefaultControllerWriteCallback` is renamed to `UnderlyingSinkWriteCallback`
-  * `WritableStreamDefaultControllerCloseCallback` is renamed to `UnderlyingSinkCloseCallback`
-  * `WritableStreamErrorCallback` is renamed to `UnderlyingSinkAbortCallback`
-  * `TransformStreamDefaultControllerCallback` is replaced by `TransformerStartCallback` and `TransformerFlushCallback`
-  * `TransformStreamDefaultControllerTransformCallback` is renamed to `TransformerTransformCallback`
-
-## v2.1.1 (2020-04-11)
-
-* 💅 Improve `ReadResult` in TypeScript type definitions. ([759506e](https://github.com/MattiasBuelens/web-streams-polyfill/commit/759506e00e55289ae6f92f30922b8855fcddd9ab), [#49](https://github.com/MattiasBuelens/web-streams-polyfill/pull/49))
-
-## v2.1.0 (2020-02-23)
-
-* 👓 Align with [spec version `ed00d2f`](https://github.com/whatwg/streams/tree/ed00d2fe2d53ac5ad9ff8e727c7ef0a68f424074/) ([#43](https://github.com/MattiasBuelens/web-streams-polyfill/issues/43), [#44](https://github.com/MattiasBuelens/web-streams-polyfill/pull/44))
-* 🏠 Down-level type definitions for older TypeScript versions. ([#41](https://github.com/MattiasBuelens/web-streams-polyfill/pull/41))
-
-## v2.0.6 (2019-11-08)
-
-* 🐛 Fix type definitions to be compatible with TypeScript 3.3 and lower. ([#39](https://github.com/MattiasBuelens/web-streams-polyfill/issues/39), [#40](https://github.com/MattiasBuelens/web-streams-polyfill/pull/40))
-
-## v2.0.5 (2019-10-08)
-
-* 👓 Align with [spec version `ae5e0cb`](https://github.com/whatwg/streams/tree/ae5e0cb41e9f72cdd97f3a6d47bc674c1f4049d1/) ([#33](https://github.com/MattiasBuelens/web-streams-polyfill/pull/33))
-* 🐛 Fix support for non-browser environments, such as Node.
-  * Accept polyfilled `AbortSignal`s. ([#36](https://github.com/MattiasBuelens/web-streams-polyfill/pull/36))
-  * Polyfill `DOMException` if necessary. ([#37](https://github.com/MattiasBuelens/web-streams-polyfill/pull/37))
-
-## v2.0.4 (2019-08-01)
-
-* 🐛 Fix pipe not aborting when both `preventAbort` and `preventCancel` are set ([#31](https://github.com/MattiasBuelens/web-streams-polyfill/pull/31))
-* 👓 Align with [spec version `e4d3b1a`](https://github.com/whatwg/streams/tree/e4d3b1a826e34d27a7cb5485a1cc4b078608c9ec/) ([#31](https://github.com/MattiasBuelens/web-streams-polyfill/pull/31))
-
-## v2.0.3 (2019-04-04)
-
-* 👓 Align with [spec version `6f94580`](https://github.com/whatwg/streams/tree/6f94580f6731d1e017c516af097d47c45aad1f56/) ([#21](https://github.com/MattiasBuelens/web-streams-polyfill/pull/21))
-* 🏠 Run web platform tests on ES5 variant ([#19](https://github.com/MattiasBuelens/web-streams-polyfill/pull/19))
-
-## v2.0.2 (2019-03-17)
-
-* 💅 Improve performance of `reader.read()` and `writer.write()` ([#17](https://github.com/MattiasBuelens/web-streams-polyfill/pull/17), [#18](https://github.com/MattiasBuelens/web-streams-polyfill/pull/18))
-
-## v2.0.1 (2019-03-16)
-
-* 🐛 Fix performance issue with large queues ([#15](https://github.com/MattiasBuelens/web-streams-polyfill/pull/15), [#16](https://github.com/MattiasBuelens/web-streams-polyfill/pull/16))
-
-## v2.0.0 (2019-03-10)
-
-* 💥 Ownership change: [@mattiasbuelens/web-streams-polyfill](https://www.npmjs.com/package/@mattiasbuelens/web-streams-polyfill/v/0.3.2) has been republished as [web-streams-polyfill](https://www.npmjs.com/package/web-streams-polyfill).
-  For the full list of changes between web-streams-polyfill v1.3.2 and this version, [visit the fork's changelog](https://github.com/MattiasBuelens/web-streams-polyfill/blob/v0.3.2/CHANGELOG.md).
-
-* 💥 CommonJS entry points have been moved to `dist/`:
-  * `index.js` ➡ `dist/polyfill.js`
-  * `index.es6.js` ➡ `dist/polyfill.es6.js`
-
-  However, we recommend migrating to a [variant sub-package](https://github.com/MattiasBuelens/web-streams-polyfill#usage) instead:
-  * `require('web-streams-polyfill/index.js')` ➡ `require('web-streams-polyfill')`
-  * `require('web-streams-polyfill/index.es6.js')` ➡ `require('web-streams-polyfill/es6')`
-
-* 👓 Align with [spec version `2c8f35e`](https://github.com/whatwg/streams/tree/2c8f35ed23451ffc9b32ec37b56def4a5349abb1/)
-
-* 🏠 Code moved from [creatorrr/web-streams-polyfill](https://github.com/creatorrr/web-streams-polyfill) to [MattiasBuelens/web-streams-polyfill](https://github.com/MattiasBuelens/web-streams-polyfill)