web-streams-polyfill 3.2.1 → 3.3.0

package/es2018/package.json

@@ -3,5 +3,5 @@
   "main": "../dist/polyfill.es2018",
   "browser": "../dist/polyfill.es2018.min.js",
   "module": "../dist/polyfill.es2018.mjs",
-  "types": "../dist/types/polyfill.d.ts"
+  "types": "../types/polyfill.d.ts"
 }

package/es6/package.json

@@ -3,5 +3,5 @@
   "main": "../dist/polyfill.es6",
   "browser": "../dist/polyfill.es6.min.js",
   "module": "../dist/polyfill.es6.mjs",
-  "types": "../dist/types/polyfill.d.ts"
+  "types": "../types/polyfill.d.ts"
 }

package/package.json

@@ -1,39 +1,35 @@
 {
   "name": "web-streams-polyfill",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "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/*"
-      ]
-    }
-  },
+  "types": "types/polyfill.d.ts",
   "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: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:types": "tsc -p ./test/types/tsconfig.json",
     "test:unit": "jasmine --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"
+    "ponyfill",
+    "types"
   ],
   "engines": {
-    "node": ">= 8"
+    "node": ">= 18"
   },
   "repository": {
     "type": "git",
@@ -54,23 +50,25 @@
   },
   "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.39.1",
+    "@rollup/plugin-inject": "^5.0.5",
+    "@rollup/plugin-replace": "^5.0.5",
+    "@rollup/plugin-strip": "^3.0.4",
+    "@rollup/plugin-typescript": "^11.1.5",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@types/node": "^18.19.4",
+    "@typescript-eslint/eslint-plugin": "^6.17.0",
+    "@typescript-eslint/parser": "^6.17.0",
     "@ungap/promise-all-settled": "^1.1.2",
-    "eslint": "^7.23.0",
-    "jasmine": "^3.7.0",
-    "micromatch": "^4.0.2",
-    "rollup": "^2.44.0",
-    "rollup-plugin-terser": "^7.0.2",
-    "ts-morph": "^10.0.2",
-    "tslib": "^2.2.0",
-    "typescript": "^4.2.4",
-    "wpt-runner": "^3.2.1"
+    "eslint": "^8.56.0",
+    "jasmine": "^5.1.0",
+    "micromatch": "^4.0.5",
+    "minimist": "^1.2.5",
+    "playwright": "^1.14.1",
+    "recursive-readdir": "^2.2.2",
+    "rollup": "^4.9.2",
+    "tslib": "^2.6.2",
+    "typescript": "^5.3.3",
+    "wpt-runner": "^5.0.0"
   }
 }

package/ponyfill/es2018/package.json

@@ -2,5 +2,5 @@
   "name": "web-streams-ponyfill-es2018",
   "main": "../../dist/ponyfill.es2018",
   "module": "../../dist/ponyfill.es2018.mjs",
-  "types": "../../dist/types/polyfill.d.ts"
+  "types": "../../types/ponyfill.d.ts"
 }

package/ponyfill/es6/package.json

@@ -2,5 +2,5 @@
   "name": "web-streams-ponyfill-es6",
   "main": "../../dist/ponyfill.es6",
   "module": "../../dist/ponyfill.es6.mjs",
-  "types": "../../dist/types/polyfill.d.ts"
+  "types": "../../types/ponyfill.d.ts"
 }

package/ponyfill/package.json

@@ -2,5 +2,5 @@
   "name": "web-streams-ponyfill",
   "main": "../dist/ponyfill",
   "module": "../dist/ponyfill.mjs",
-  "types": "../dist/types/polyfill.d.ts"
+  "types": "../types/ponyfill.d.ts"
 }

package/types/polyfill.d.ts

@@ -0,0 +1,29 @@
+/// <reference lib="dom" />
+/// <reference lib="es2018.asynciterable" />
+
+import type { ReadableStreamAsyncIterator, ReadableStreamIteratorOptions } from './ponyfill';
+
+export * from './ponyfill';
+
+declare global {
+  interface ReadableStream<R = any> {
+    /**
+     * 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;
+    /**
+     * If aborted, returns the reason for aborting.
+     */
+    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.
@@ -215,6 +219,13 @@ export declare class ReadableStream<R = any> {
      * {@inheritDoc ReadableStream.values}
      */
     [Symbol.asyncIterator]: (options?: ReadableStreamIteratorOptions) => ReadableStreamAsyncIterator<R>;
+    /**
+     * Creates a new ReadableStream wrapping the provided iterable or async iterable.
+     *
+     * This can be used to adapt various kinds of objects into a readable stream,
+     * such as an array, an async generator, or a Node.js readable stream.
+     */
+    static from<R>(asyncIterable: Iterable<R> | AsyncIterable<R> | ReadableStreamLike<R>): ReadableStream<R>;
 }
 
 /**
@@ -233,7 +244,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.
@@ -248,7 +259,7 @@ export declare class ReadableStreamBYOBReader {
      *
      * If reading a chunk causes the queue to become empty, more data will be pulled from the underlying source.
      */
-    read<T extends ArrayBufferView>(view: T): Promise<ReadableStreamBYOBReadResult<T>>;
+    read<T extends ArrayBufferView>(view: T, options?: ReadableStreamBYOBReaderReadOptions): Promise<ReadableStreamBYOBReadResult<T>>;
     /**
      * Releases the reader's lock on the corresponding stream. After the lock is released, the reader is no longer active.
      * If the associated stream is errored when the lock is released, the reader will appear errored in the same way
@@ -261,6 +272,16 @@ export declare class ReadableStreamBYOBReader {
     releaseLock(): void;
 }
 
+/**
+ * Options for {@link ReadableStreamBYOBReader.read | reading} a stream
+ * with a {@link ReadableStreamBYOBReader | BYOB reader}.
+ *
+ * @public
+ */
+export declare interface ReadableStreamBYOBReaderReadOptions {
+    min?: number;
+}
+
 /**
  * A result returned by {@link ReadableStreamBYOBReader.read}.
  *
@@ -364,6 +385,18 @@ export declare class ReadableStreamDefaultReader<R = any> {
     releaseLock(): void;
 }
 
+/**
+ * A common interface for a `ReadableStreamDefaultReader` implementation.
+ *
+ * @public
+ */
+export declare interface ReadableStreamDefaultReaderLike<R = any> {
+    readonly closed: Promise<undefined>;
+    cancel(reason?: any): Promise<void>;
+    read(): Promise<ReadableStreamDefaultReadResult<R>>;
+    releaseLock(): void;
+}
+
 /**
  * A result returned by {@link ReadableStreamDefaultReader.read}.
  *
@@ -386,6 +419,16 @@ export declare interface ReadableStreamIteratorOptions {
     preventCancel?: boolean;
 }
 
+/**
+ * A common interface for a `ReadadableStream` implementation.
+ *
+ * @public
+ */
+export declare interface ReadableStreamLike<R = any> {
+    readonly locked: boolean;
+    getReader(): ReadableStreamDefaultReaderLike<R>;
+}
+
 /**
  * A pair of a {@link ReadableStream | readable stream} and {@link WritableStream | writable stream} that can be passed
  * to {@link ReadableStream.pipeThrough}.
@@ -443,10 +486,17 @@ export declare interface Transformer<I = any, O = any> {
      * through {@link Transformer.transform | transform()}, and the writable side is about to be closed.
      */
     flush?: TransformerFlushCallback<O>;
+    /**
+     * A function called when the readable side is cancelled, or when the writable side is aborted.
+     */
+    cancel?: TransformerCancelCallback;
     readableType?: undefined;
     writableType?: undefined;
 }
 
+/** @public */
+export declare type TransformerCancelCallback = (reason: any) => void | PromiseLike<void>;
+
 /** @public */
 export declare type TransformerFlushCallback<O> = (controller: TransformStreamDefaultController<O>) => void | PromiseLike<void>;
 

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

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