@matter/general 0.16.0-alpha.0-20251003-dc6d5523d → 0.16.0-alpha.0-20251004-92135c7df

package/src/util/Streams.ts

@@ -0,0 +1,130 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { MatterError, TimeoutError } from "#MatterError.js";
+import { MaybePromise } from "./Promises.js";
+
+/**
+ * Generic error thrown when a stream closes in a context where we expected a value.
+ */
+export class EndOfStreamError extends MatterError {
+    constructor(message = "Unexpected end of stream") {
+        super(message);
+    }
+}
+
+/**
+ * Timeout specific to cases where we were expecting a value.
+ */
+export class NoResponseTimeoutError extends TimeoutError {}
+
+/**
+ * A generic iterator type that accepts both async and normal iterators.
+ */
+export type MaybeAsyncIterable<T> = Iterable<T, void, void> | AsyncIterable<T, void, void>;
+
+export namespace Stream {
+    /**
+     * Ponyfill for standard ReadableStream.from().
+     *
+     * If defined, we use the native implementation.  Otherwise we create the stream ourselves.
+     */
+    export function from<T>(iterable: MaybeAsyncIterable<T>): ReadableStream<T> {
+        if ("from" in ReadableStream) {
+            return (ReadableStream as { from(iterable: MaybeAsyncIterable<T>): ReadableStream<T> }).from(iterable);
+        }
+
+        return AnyIterableReadableStream(iterable);
+    }
+
+    /**
+     * Ponyfill for standard ReadableStream#[Symbol.asyncIterator].
+     *
+     * If defined, we use the native implementation.  Otherwise we create the iterator ourselves.  Currently only
+     * necessary on Safari.
+     */
+    export async function* iterable<T>(stream: ReadableStream<T>): AsyncGenerator<T, void, void> {
+        if (Symbol.asyncIterator in stream) {
+            yield* stream as AsyncIterable<T, void, void>;
+            return;
+        }
+
+        const reader = stream.getReader();
+        try {
+            while (true) {
+                const next = await reader.read();
+                if (next.done) {
+                    return;
+                }
+
+                yield next.value;
+            }
+        } finally {
+            reader.releaseLock();
+        }
+    }
+}
+
+/**
+ * Iterable-backed ReadableStream implementation.
+ *
+ * We prefer the native ReadableStream.from which is supported on Node.js 20.6+ as well as Deno and Bun.  This may
+ * require additional testing if required for support on other platforms.
+ */
+function AnyIterableReadableStream<T>(iterable: MaybeAsyncIterable<T>): ReadableStream<T> {
+    let iterator: Iterator<T, void, void> | AsyncIterator<T, void, void> | undefined;
+
+    return new ReadableStream({
+        start() {
+            if (Symbol.asyncIterator in iterable) {
+                iterator = iterable[Symbol.asyncIterator]();
+            } else {
+                iterator = iterable[Symbol.iterator]();
+            }
+        },
+
+        async pull(controller) {
+            if (!iterator) {
+                controller.close();
+                return;
+            }
+
+            try {
+                let next = iterator.next();
+                if (MaybePromise.is(next)) {
+                    next = await next;
+                }
+
+                if (next.done) {
+                    controller.close();
+                    return;
+                }
+
+                controller.enqueue(next.value);
+            } catch (e) {
+                controller.error(e);
+                return;
+            }
+        },
+
+        async cancel(reason) {
+            if (reason) {
+                if (iterator?.throw) {
+                    await iterator.throw(reason);
+                    return;
+                }
+
+                if (iterator?.return) {
+                    await iterator.return();
+                }
+
+                throw reason;
+            }
+
+            await iterator?.return?.();
+        },
+    });
+}

package/src/util/index.ts

@@ -4,6 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+export * from "./Abort.js";
 export * from "./Array.js";
 export * from "./Boot.js";
 export * from "./Bytes.js";
@@ -30,6 +31,6 @@ export * from "./PromiseQueue.js";
 export * from "./Promises.js";
 export * from "./Set.js";
 export * from "./Singleton.js";
-export * from "./Stream.js";
+export * from "./Streams.js";
 export * from "./String.js";
 export * from "./Type.js";

package/dist/cjs/util/Stream.d.ts

@@ -1,16 +0,0 @@
-/**
- * @license
- * Copyright 2022-2025 Matter.js Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-import { MatterError, TimeoutError } from "../MatterError.js";
-export declare class EndOfStreamError extends MatterError {
-    constructor(message?: string);
-}
-export declare class NoResponseTimeoutError extends TimeoutError {
-}
-export interface Stream<T> {
-    read(): Promise<T>;
-    write(data: T): Promise<void>;
-}
-//# sourceMappingURL=Stream.d.ts.map

package/dist/cjs/util/Stream.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Stream.d.ts","sourceRoot":"","sources":["../../../src/util/Stream.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAE9D,qBAAa,gBAAiB,SAAQ,WAAW;gBACjC,OAAO,SAA6B;CAGnD;AAED,qBAAa,sBAAuB,SAAQ,YAAY;CAAG;AAE3D,MAAM,WAAW,MAAM,CAAC,CAAC;IACrB,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IACnB,KAAK,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjC"}

package/dist/cjs/util/Stream.js

@@ -1,38 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var Stream_exports = {};
-__export(Stream_exports, {
-  EndOfStreamError: () => EndOfStreamError,
-  NoResponseTimeoutError: () => NoResponseTimeoutError
-});
-module.exports = __toCommonJS(Stream_exports);
-var import_MatterError = require("../MatterError.js");
-/**
- * @license
- * Copyright 2022-2025 Matter.js Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-class EndOfStreamError extends import_MatterError.MatterError {
-  constructor(message = "Unexpected end of stream") {
-    super(message);
-  }
-}
-class NoResponseTimeoutError extends import_MatterError.TimeoutError {
-}
-//# sourceMappingURL=Stream.js.map

package/dist/cjs/util/Stream.js.map

@@ -1,6 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/util/Stream.ts"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,yBAA0C;AAL1C;AAAA;AAAA;AAAA;AAAA;AAOO,MAAM,yBAAyB,+BAAY;AAAA,EAC9C,YAAY,UAAU,4BAA4B;AAC9C,UAAM,OAAO;AAAA,EACjB;AACJ;AAEO,MAAM,+BAA+B,gCAAa;AAAC;",
-  "names": []
-}

package/dist/esm/util/Stream.d.ts

@@ -1,16 +0,0 @@
-/**
- * @license
- * Copyright 2022-2025 Matter.js Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-import { MatterError, TimeoutError } from "../MatterError.js";
-export declare class EndOfStreamError extends MatterError {
-    constructor(message?: string);
-}
-export declare class NoResponseTimeoutError extends TimeoutError {
-}
-export interface Stream<T> {
-    read(): Promise<T>;
-    write(data: T): Promise<void>;
-}
-//# sourceMappingURL=Stream.d.ts.map

package/dist/esm/util/Stream.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Stream.d.ts","sourceRoot":"","sources":["../../../src/util/Stream.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAE9D,qBAAa,gBAAiB,SAAQ,WAAW;gBACjC,OAAO,SAA6B;CAGnD;AAED,qBAAa,sBAAuB,SAAQ,YAAY;CAAG;AAE3D,MAAM,WAAW,MAAM,CAAC,CAAC;IACrB,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;IACnB,KAAK,CAAC,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjC"}

package/dist/esm/util/Stream.js

@@ -1,18 +0,0 @@
-/**
- * @license
- * Copyright 2022-2025 Matter.js Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-import { MatterError, TimeoutError } from "../MatterError.js";
-class EndOfStreamError extends MatterError {
-  constructor(message = "Unexpected end of stream") {
-    super(message);
-  }
-}
-class NoResponseTimeoutError extends TimeoutError {
-}
-export {
-  EndOfStreamError,
-  NoResponseTimeoutError
-};
-//# sourceMappingURL=Stream.js.map

package/dist/esm/util/Stream.js.map

@@ -1,6 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/util/Stream.ts"],
-  "mappings": "AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,SAAS,aAAa,oBAAoB;AAEnC,MAAM,yBAAyB,YAAY;AAAA,EAC9C,YAAY,UAAU,4BAA4B;AAC9C,UAAM,OAAO;AAAA,EACjB;AACJ;AAEO,MAAM,+BAA+B,aAAa;AAAC;",
-  "names": []
-}

package/src/util/Stream.ts

@@ -1,19 +0,0 @@
-/**
- * @license
- * Copyright 2022-2025 Matter.js Authors
- * SPDX-License-Identifier: Apache-2.0
- */
-import { MatterError, TimeoutError } from "../MatterError.js";
-
-export class EndOfStreamError extends MatterError {
-    constructor(message = "Unexpected end of stream") {
-        super(message);
-    }
-}
-
-export class NoResponseTimeoutError extends TimeoutError {}
-
-export interface Stream<T> {
-    read(): Promise<T>;
-    write(data: T): Promise<void>;
-}