TS: update type definitions to support TS v6

Types can remain common with existing v5.5+ ones, since only `ReadableStreamBYOBReader.read`
was updated in a backwards-compatible way.

The tests needed some changes, specifically isolating browser ones with a
standalone tsconfig, due to type resolution/erasure changes in v6 following
the inclusion of the DOM.AsyncIterable lib in the main DOM types
(with the change, the ReadableStream Node types took precedence over the DOM ones).
With this fix, the browser tests no longer bring in Node types, hence the ReadableStream
type resolution should remain deterministic from now on.

Author: larabr

lib/types/dom.d.ts

@@ -58,6 +58,9 @@ export namespace DOM {
          */
     getWriter(): WritableStreamDefaultWriter<W>;
   }
+  interface ReadableStreamBYOBReaderReadOptions {
+    min?: number;
+  }
   /**
      * The `ReadableStream` interface of the Streams API represents a readable stream of byte data.
      *
@@ -126,7 +129,12 @@ export namespace DOM {
          *
          * [MDN Reference](https://developer.mozilla.org/docs/Web/API/ReadableStreamBYOBReader/read)
          */
-    read<T extends ArrayBufferView>(view: T): Promise<globalThis.ReadableStreamReadResult<T>>;
+    read<T extends Exclude<BufferSource, ArrayBuffer>>(
+          view: T,
+          // `options` are included in TS v6 definitions but not in v5; to keep the types common
+          // we redeclare `ReadableStreamBYOBReaderReadOptions`
+          options?: ReadableStreamBYOBReaderReadOptions
+     ): Promise<globalThis.ReadableStreamReadResult<T>>;
     /**
          * The **`releaseLock()`** method of the ReadableStreamBYOBReader interface releases the reader's lock on the stream.
          *

test/browser.test.ts test/browser/browser.test.tstest/browser.test.ts renamed to test/browser/browser.test.ts

@@ -0,0 +1,8 @@
+{
+    "extends": "../tsconfig.json",
+    "compilerOptions": {
+        "noEmit": true, // code tested by tsx
+        "types": ["mocha", "chai"], // no node types
+        "lib": [] // DOM.AsyncIterable is included in the main DOM types in v6
+    },
+}

test/browser/tsconfig.json

@@ -1,6 +1,14 @@
 import { expect } from 'chai';
-// @ts-expect-error Missing type definitions
-import { toStream, toArrayStream, readToEnd, slice, pipe, ArrayStream, transform, transformAsync, type Stream } from  '@openpgp/web-stream-tools';
+import {
+  toStream,
+  // @ts-expect-error Missing type definitions
+  toArrayStream, pipe, ArrayStream,
+  readToEnd,
+  slice,
+  transform,
+  transformAsync,
+  type Stream
+} from  '@openpgp/web-stream-tools';
 
 describe('Common integration tests', () => {
   it('toStream/readToEnd', async () => {

test/common.test.ts

@@ -2,7 +2,8 @@
     "extends": "./tsconfig.json",
     "compilerOptions": {
         "target": "es5",
-        "noEmit": true, // code tested by tsx
-        "lib": ["DOM.AsyncIterable"]
+        // Option 'target=ES5' is deprecated and will stop functioning in TypeScript 7.0
+        // Specify compilerOption '"ignoreDeprecations": "6.0"' to silence this error.
+        "ignoreDeprecations": "6.0"
     }
 }

test/tsconfig.es5.json

@@ -2,6 +2,6 @@
     "extends": "../tsconfig.json",
     "compilerOptions": {
         "noEmit": true, // code tested by tsx
-        "lib": ["DOM.AsyncIterable"], // for browser tests (for-await)
+        "types": ["node", "mocha", "chai"]
     },
 }

test/tsconfig.json

@@ -2,6 +2,7 @@
     "extends": "../tsconfig.json",
     "compilerOptions": {
         "noEmit": true, // code tested by tsx
+        "skipLibCheck": true
     },
     "include": ["./typescript.v4.7.test.ts"]
 }

test/tsconfig.v4.7.json

@@ -9,9 +9,11 @@
         "allowJs": true,
         "paths": {
             "@openpgp/web-stream-tools": ["."]
-        }
+        },
+        "noEmit": true
     },
     "exclude": [
         "node_modules",
+        "docs"
     ],
 }