3.2.0

changelog.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 2024-10-16 - 3.2.0 - feat(SmartDuplex)
+Added method to create SmartDuplex from a WebReadableStream.
+
+- Implemented a static method in SmartDuplex to allow creating an instance from a WebReadableStream.
+- This addition enhances the capability of SmartDuplex to integrate with web streams, facilitating seamless stream manipulation across environments.
+
+## 2024-10-14 - 3.1.2 - fix(WebDuplexStream)
+Fix variable naming inconsistency in WebDuplexStream test
+
+- Changed variable names from 'transformStream' to 'webDuplexStream' for consistency.
+- Renamed 'writableStream' and 'readableStream' to 'writer' and 'reader' respectively.
+
 ## 2024-10-13 - 3.1.1 - fix(WebDuplexStream)
 Improved read/write interface and error handling in WebDuplexStream
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartstream",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "private": false,
   "description": "A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.",
   "type": "module",

test/test.ts_web.both.ts

@@ -28,22 +28,22 @@ tap.test('WebDuplexStream should handle transform with a write function', async
   const input = [1, 2, 3, 4, 5];
   const expectedOutput = [2, 4, 6, 8, 10];
 
-  const transformStream = new webstream.WebDuplexStream<number, number>({
+  const webDuplexStream = new webstream.WebDuplexStream<number, number>({
     writeFunction: async (chunk, { push }) => {
       // Push the doubled number into the stream
       push(chunk * 2);
     },
   });
 
-  const writableStream = transformStream.writable.getWriter();
-  const readableStream = transformStream.readable.getReader();
+  const writer = webDuplexStream.writable.getWriter();
+  const reader = webDuplexStream.readable.getReader();
 
   const output: number[] = [];
 
   // Read from the stream asynchronously
   const readPromise = (async () => {
     while (true) {
-      const { value, done } = await readableStream.read();
+      const { value, done } = await reader.read();
       if (done) break;
       if (value !== undefined) {
         output.push(value);
@@ -53,9 +53,9 @@ tap.test('WebDuplexStream should handle transform with a write function', async
 
   // Write to the stream
   for (const num of input) {
-    await writableStream.write(num);
+    await writer.write(num);
   }
-  await writableStream.close();
+  await writer.close();
 
   // Wait for the reading to complete
   await readPromise;

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartstream',
-  version: '3.1.1',
+  version: '3.2.0',
   description: 'A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.'
 }

ts/smartstream.classes.smartduplex.ts

@@ -52,6 +52,31 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
     return smartDuplex;
   }
 
+  public static fromWebReadableStream<T = any>(
+    readableStream: ReadableStream<T>
+  ): SmartDuplex<T, T> {
+    const smartDuplex = new SmartDuplex<T, T>({
+      readFunction: async () => {
+        const reader = readableStream.getReader();
+        try {
+          while (true) {
+            const { value, done } = await reader.read();
+            if (value !== undefined) {
+              smartDuplex.push(value);
+            }
+            if (done) {
+              smartDuplex.end();
+              break;
+            }
+          }
+        } finally {
+          reader.releaseLock();
+        }
+      },
+    });
+    return smartDuplex;
+  }
+
   // INSTANCE
   private backpressuredArray: plugins.lik.BackpressuredArray<TOutput>; // an array that only takes a defined amount of items
   public options: ISmartDuplexOptions<TInput, TOutput>;

ts/smartstream.functions.ts

@@ -1,4 +1,4 @@
-import { Transform, type TransformCallback, type TransformOptions } from 'stream';
+import { type TransformOptions } from 'stream';
 import { SmartDuplex } from './smartstream.classes.smartduplex.js';
 
 export interface AsyncTransformFunction<TInput, TOutput> {

ts_web/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartstream',
-  version: '3.1.1',
+  version: '3.2.0',
   description: 'A library to simplify the creation and manipulation of Node.js streams, providing utilities for handling transform, duplex, and readable/writable streams effectively in TypeScript.'
 }