3.0.45

changelog.md

@@ -0,0 +1,35 @@
+# Changelog
+
+## 2024-10-13 - 3.0.45 - fix(ts)
+Fixed formatting issues in SmartDuplex class
+
+- Resolved inconsistent spacing in SmartDuplex class methods and constructor.
+- Ensured consistent formatting in the getWebStreams method.
+
+## 2024-06-02 - 3.0.39 - smartduplex
+Add .getWebStreams method
+
+- Introduced a new `.getWebStreams` method in the smartduplex module, providing compatibility with the web streams API.
+
+## 2024-03-16 - 3.0.34 - configuration
+Update project configuration files
+
+- Updated `tsconfig` for optimization.
+- Modified `npmextra.json` to set the `githost` attribute.
+
+## 2023-11-03 - 3.0.0 to 3.0.8 - core
+Transition to major version 3.x
+
+- Implemented breaking changes in the core system for better performance and feature set.
+- Continuous core updates to improve stability and performance across minor version increments.
+  
+## 2023-11-02 - 2.0.4 to 2.0.8 - core
+Core updates and a major fix
+
+- Implemented core updates addressing minor bugs and enhancements.
+- A significant breaking change update transitioning from 2.0.x to 3.0.0.
+  
+## 2022-03-31 - 2.0.0 - core
+Major esm transition
+
+- Implemented a breaking change by switching the core to ESM (ECMAScript Module) format for modernized module handling.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@push.rocks/smartstream",
-  "version": "3.0.39",
+  "version": "3.0.45",
   "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",

ts/00_commitinfo_data.ts

@@ -1,8 +1,8 @@
 /**
- * autocreated commitinfo by @pushrocks/commitinfo
+ * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
   name: '@push.rocks/smartstream',
-  version: '3.0.39',
+  version: '3.0.45',
   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/index.ts

@@ -1,3 +1,8 @@
+import { stream } from './smartstream.plugins.js';
+export {
+  stream,
+}
+
 export * from './smartstream.classes.smartduplex.js';
 export * from './smartstream.classes.streamwrapper.js';
 export * from './smartstream.classes.streamintake.js';

ts/smartstream.classes.smartduplex.ts

@@ -53,21 +53,29 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
   }
 
   // INSTANCE
-  private backpressuredArray: plugins.lik.BackpressuredArray<TOutput>;
+  private backpressuredArray: plugins.lik.BackpressuredArray<TOutput>; // an array that only takes a defined amount of items
   public options: ISmartDuplexOptions<TInput, TOutput>;
   private observableSubscription?: plugins.smartrx.rxjs.Subscription;
   private debugLog(messageArg: string) {
+    // optional debug log
     if (this.options.debug) {
       console.log(messageArg);
     }
   }
 
   constructor(optionsArg?: ISmartDuplexOptions<TInput, TOutput>) {
-    super(Object.assign({
+    super(
+      Object.assign(
+        {
           highWaterMark: 1,
-    }, optionsArg));
+        },
+        optionsArg
+      )
+    );
     this.options = optionsArg;
-    this.backpressuredArray = new plugins.lik.BackpressuredArray<TOutput>(this.options.highWaterMark || 1)
+    this.backpressuredArray = new plugins.lik.BackpressuredArray<TOutput>(
+      this.options.highWaterMark || 1
+    );
   }
 
   public async _read(size: number): Promise<void> {
@@ -92,7 +100,7 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
       this.debugLog(`${this.options.name}: can push more again`);
     }
     return canPushMore;
-  };
+  }
 
   private asyncWritePromiseObjectmap = new plugins.lik.ObjectMap<Promise<any>>();
   // Ensure the _write method types the chunk as TInput and encodes TOutput
@@ -110,7 +118,7 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
       },
       push: async (pushArg: TOutput) => {
         return await this.backpressuredPush(pushArg);
-      }
+      },
     };
 
     try {
@@ -157,4 +165,53 @@ export class SmartDuplex<TInput = any, TOutput = any> extends Duplex {
     this.backpressuredArray.push(null);
     callback();
   }
+
+  public async getWebStreams(): Promise<{ readable: ReadableStream; writable: WritableStream }> {
+    const duplex = this;
+    const readable = new ReadableStream({
+      start(controller) {
+        duplex.on('readable', () => {
+          let chunk;
+          while (null !== (chunk = duplex.read())) {
+            controller.enqueue(chunk);
+          }
+        });
+
+        duplex.on('end', () => {
+          controller.close();
+        });
+      },
+      cancel(reason) {
+        duplex.destroy(new Error(reason));
+      },
+    });
+
+    const writable = new WritableStream({
+      write(chunk) {
+        return new Promise<void>((resolve, reject) => {
+          const isBackpressured = !duplex.write(chunk, (error) => {
+            if (error) {
+              reject(error);
+            } else {
+              resolve();
+            }
+          });
+
+          if (isBackpressured) {
+            duplex.once('drain', resolve);
+          }
+        });
+      },
+      close() {
+        return new Promise<void>((resolve, reject) => {
+          duplex.end(resolve);
+        });
+      },
+      abort(reason) {
+        duplex.destroy(new Error(reason));
+      },
+    });
+
+    return { readable, writable };
+  }
 }

ts/smartstream.classes.streamintake.ts

@@ -1,6 +1,45 @@
 import * as plugins from './smartstream.plugins.js';
 
 export class StreamIntake<T> extends plugins.stream.Readable {
+  // STATIC
+  public static async fromStream<U>(inputStream: plugins.stream.Readable | ReadableStream, options?: plugins.stream.ReadableOptions): Promise<StreamIntake<U>> {
+    const intakeStream = new StreamIntake<U>(options);
+
+    if (inputStream instanceof plugins.stream.Readable) {
+      inputStream.on('data', (chunk: U) => {
+        intakeStream.pushData(chunk);
+      });
+
+      inputStream.on('end', () => {
+        intakeStream.signalEnd();
+      });
+
+      inputStream.on('error', (err: Error) => {
+        intakeStream.destroy(err);
+      });
+    } else {
+      const reader = (inputStream as ReadableStream).getReader();
+
+      const readChunk = () => {
+        reader.read().then(({ done, value }) => {
+          if (done) {
+            intakeStream.signalEnd();
+          } else {
+            intakeStream.pushData(value);
+            readChunk();
+          }
+        }).catch((err) => {
+          intakeStream.destroy(err);
+        });
+      };
+
+      readChunk();
+    }
+
+    return intakeStream;
+  }
+
+  // INSTANCE
   private signalEndBoolean = false;
   private chunkStore: T[] = [];
   public pushNextObservable = new plugins.smartrx.ObservableIntake<any>();

ts_web/00_commitinfo_data.ts

@@ -1,8 +1,8 @@
 /**
- * autocreated commitinfo by @pushrocks/commitinfo
+ * autocreated commitinfo by @push.rocks/commitinfo
  */
 export const commitinfo = {
   name: '@push.rocks/smartstream',
-  version: '3.0.39',
+  version: '3.0.45',
   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_web/convert.ts

@@ -1,64 +0,0 @@
-export interface IDuplexStream {
-  read(): any;
-  write(chunk: any, callback?: (error?: Error | null) => void): boolean;
-  on(event: string, listener: (...args: any[]) => void): this;
-  once(event: string, listener: (...args: any[]) => void): this;
-  end(callback?: () => void): void;
-  destroy(error?: Error): void;
-}
-
-export interface IReadableStreamOptions {
-  highWaterMark?: number;
-}
-
-export interface IWritableStreamOptions {
-  highWaterMark?: number;
-}
-
-export function convertDuplexToWebStream(duplex: IDuplexStream): { readable: ReadableStream, writable: WritableStream } {
-  const readable = new ReadableStream({
-    start(controller) {
-      duplex.on('readable', () => {
-        let chunk;
-        while (null !== (chunk = duplex.read())) {
-          controller.enqueue(chunk);
-        }
-      });
-
-      duplex.on('end', () => {
-        controller.close();
-      });
-    },
-    cancel(reason) {
-      duplex.destroy(new Error(reason));
-    }
-  });
-
-  const writable = new WritableStream({
-    write(chunk) {
-      return new Promise<void>((resolve, reject) => {
-        const isBackpressured = !duplex.write(chunk, (error) => {
-          if (error) {
-            reject(error);
-          } else {
-            resolve();
-          }
-        });
-
-        if (isBackpressured) {
-          duplex.once('drain', resolve);
-        }
-      });
-    },
-    close() {
-      return new Promise<void>((resolve, reject) => {
-        duplex.end(resolve);
-      });
-    },
-    abort(reason) {
-      duplex.destroy(new Error(reason));
-    }
-  });
-
-  return { readable, writable };
-}

ts_web/index.ts

@@ -1,5 +1,2 @@
 import './plugins.js';
 export * from './classes.webduplexstream.js';
-export {
-  convertDuplexToWebStream,
-} from './convert.js';