Improve Streams (#750)

* Use [NoInterfaceObject] on stream types

* Remove unnecessary "override-exposed"

* Support type parameters for typedefs

* Align ReadableStreamReadResult with IteratorResult

* Add chunk types to TextEncoderStream and TextDecoderStream

Author: MattiasBuelens

baselines/dom.generated.d.ts

@@ -1496,6 +1496,16 @@ interface RTCTransportStats extends RTCStats {
     selectedCandidatePairId?: string;
 }
 
+interface ReadableStreamReadDoneResult<T> {
+    done: true;
+    value?: T;
+}
+
+interface ReadableStreamReadValueResult<T> {
+    done: false;
+    value: T;
+}
+
 interface RegistrationOptions {
     scope?: string;
     type?: WorkerType;
@@ -12709,11 +12719,6 @@ interface ReadableStreamDefaultReader<R = any> {
     releaseLock(): void;
 }
 
-interface ReadableStreamReadResult<T> {
-    done: boolean;
-    value: T;
-}
-
 interface ReadableStreamReader<R = any> {
     cancel(): Promise<void>;
     read(): Promise<ReadableStreamReadResult<R>>;
@@ -15662,6 +15667,8 @@ interface TextDecoderCommon {
 }
 
 interface TextDecoderStream extends GenericTransformStream, TextDecoderCommon {
+    readonly readable: ReadableStream<string>;
+    readonly writable: WritableStream<BufferSource>;
 }
 
 declare var TextDecoderStream: {
@@ -15694,6 +15701,8 @@ interface TextEncoderCommon {
 }
 
 interface TextEncoderStream extends GenericTransformStream, TextEncoderCommon {
+    readonly readable: ReadableStream<Uint8Array>;
+    readonly writable: WritableStream<string>;
 }
 
 declare var TextEncoderStream: {
@@ -19969,6 +19978,7 @@ type ConstrainDouble = number | ConstrainDoubleRange;
 type ConstrainBoolean = boolean | ConstrainBooleanParameters;
 type ConstrainDOMString = string | string[] | ConstrainDOMStringParameters;
 type PerformanceEntryList = PerformanceEntry[];
+type ReadableStreamReadResult<T> = ReadableStreamReadValueResult<T> | ReadableStreamReadDoneResult<T>;
 type VibratePattern = number | number[];
 type COSEAlgorithmIdentifier = number;
 type AuthenticatorSelectionList = AAGUID[];

baselines/webworker.generated.d.ts

@@ -371,6 +371,16 @@ interface QueuingStrategy<T = any> {
     size?: QueuingStrategySizeCallback<T>;
 }
 
+interface ReadableStreamReadDoneResult<T> {
+    done: true;
+    value?: T;
+}
+
+interface ReadableStreamReadValueResult<T> {
+    done: false;
+    value: T;
+}
+
 interface RegistrationOptions {
     scope?: string;
     type?: WorkerType;
@@ -2760,11 +2770,6 @@ interface ReadableStreamDefaultReader<R = any> {
     releaseLock(): void;
 }
 
-interface ReadableStreamReadResult<T> {
-    done: boolean;
-    value: T;
-}
-
 interface ReadableStreamReader<R = any> {
     cancel(): Promise<void>;
     read(): Promise<ReadableStreamReadResult<R>>;
@@ -3083,6 +3088,8 @@ interface TextDecoderCommon {
 }
 
 interface TextDecoderStream extends GenericTransformStream, TextDecoderCommon {
+    readonly readable: ReadableStream<string>;
+    readonly writable: WritableStream<BufferSource>;
 }
 
 declare var TextDecoderStream: {
@@ -3115,6 +3122,8 @@ interface TextEncoderCommon {
 }
 
 interface TextEncoderStream extends GenericTransformStream, TextEncoderCommon {
+    readonly readable: ReadableStream<Uint8Array>;
+    readonly writable: WritableStream<string>;
 }
 
 declare var TextEncoderStream: {
@@ -5804,6 +5813,7 @@ type ImageBitmapSource = CanvasImageSource | Blob | ImageData;
 type TimerHandler = string | Function;
 type PerformanceEntryList = PerformanceEntry[];
 type PushMessageDataInit = BufferSource | string;
+type ReadableStreamReadResult<T> = ReadableStreamReadValueResult<T> | ReadableStreamReadDoneResult<T>;
 type VibratePattern = number | number[];
 type AlgorithmIdentifier = string | Algorithm;
 type HashAlgorithmIdentifier = AlgorithmIdentifier;

inputfiles/addedTypes.json

@@ -2194,6 +2194,38 @@
                         }
                     }
                 }
+            },
+            "TextDecoderStream": {
+                "properties": {
+                    "property": {
+                        "readable": {
+                            "name": "readable",
+                            "read-only": 1,
+                            "override-type": "ReadableStream<string>"
+                        },
+                        "writable": {
+                            "name": "writable",
+                            "read-only": 1,
+                            "override-type": "WritableStream<BufferSource>"
+                        }
+                    }
+                }
+            },
+            "TextEncoderStream": {
+                "properties": {
+                    "property": {
+                        "readable": {
+                            "name": "readable",
+                            "read-only": 1,
+                            "override-type": "ReadableStream<Uint8Array>"
+                        },
+                        "writable": {
+                            "name": "writable",
+                            "read-only": 1,
+                            "override-type": "WritableStream<string>"
+                        }
+                    }
+                }
             }
         }
     },

inputfiles/idl/Streams.widl

@@ -46,14 +46,21 @@ dictionary PipeOptions {
     AbortSignal? signal;
 };
 
-[Exposed=(Window,Worker)]
-interface ReadableStreamReadResult {
-    attribute boolean done;
-    attribute any value;
+dictionary ReadableStreamReadValueResult {
+    required boolean done;
+    required any value;
 };
 
-[Constructor(ReadableStream stream),
- Exposed=(Window,Worker)]
+dictionary ReadableStreamReadDoneResult {
+    required boolean done;
+    any value;
+};
+
+[Exposed=(Window,Worker)]
+typedef (ReadableStreamReadValueResult or ReadableStreamReadDoneResult) ReadableStreamReadResult;
+
+[Exposed=(Window,Worker),
+ NoInterfaceObject]
 interface ReadableStreamDefaultReader {
     readonly attribute Promise<void> closed;
 
@@ -62,8 +69,8 @@ interface ReadableStreamDefaultReader {
     void releaseLock();
 };
 
-[Constructor(ReadableStream stream),
- Exposed=(Window,Worker)]
+[Exposed=(Window,Worker),
+ NoInterfaceObject]
 interface ReadableStreamBYOBReader {
     readonly attribute Promise<void> closed;
 
@@ -72,7 +79,8 @@ interface ReadableStreamBYOBReader {
     void releaseLock();
 };
 
-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker),
+ NoInterfaceObject]
 interface ReadableStreamDefaultController {
     readonly attribute unrestricted double? desiredSize;
 
@@ -81,7 +89,8 @@ interface ReadableStreamDefaultController {
     void error(optional any error);
 };
 
-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker),
+ NoInterfaceObject]
 interface ReadableByteStreamController {
     readonly attribute ReadableStreamBYOBRequest byobRequest;
     readonly attribute unrestricted double? desiredSize;
@@ -91,7 +100,8 @@ interface ReadableByteStreamController {
     void error(optional any error);
 };
 
-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker),
+ NoInterfaceObject]
 interface ReadableStreamBYOBRequest {
     readonly attribute ArrayBufferView view;
 
@@ -121,8 +131,8 @@ dictionary UnderlyingSink {
     any type;
 };
 
-[Constructor(ReadableStream stream),
- Exposed=(Window,Worker)]
+[Exposed=(Window,Worker),
+ NoInterfaceObject]
 interface WritableStreamDefaultWriter {
     readonly attribute Promise<void> closed;
     readonly attribute unrestricted double? desiredSize;
@@ -134,7 +144,8 @@ interface WritableStreamDefaultWriter {
     Promise<void> write(any chunk);
 };
 
-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker),
+ NoInterfaceObject]
 interface WritableStreamDefaultController {
     void error(optional any error);
 };
@@ -158,7 +169,8 @@ dictionary Transformer {
     any writableType;
 };
 
-[Exposed=(Window,Worker)]
+[Exposed=(Window,Worker),
+ NoInterfaceObject]
 interface TransformStreamDefaultController {
     readonly attribute unrestricted double? desiredSize;