11.0.20

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@push.rocks/smartfile",
   "private": false,
-  "version": "11.0.16",
+  "version": "11.0.20",
   "description": "Provides comprehensive tools for efficient file management in Node.js using TypeScript, including handling streams, virtual directories, and various file operations.",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
@@ -13,7 +13,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://gitlab.com/push.rocks/smartfile.git"
+    "url": "https://code.foss.global/push.rocks/smartfile.git"
   },
   "keywords": [
     "file management",
@@ -40,7 +40,7 @@
   "bugs": {
     "url": "https://gitlab.com/push.rocks/smartfile/issues"
   },
-  "homepage": "https://gitlab.com/push.rocks/smartfile#readme",
+  "homepage": "https://code.foss.global/push.rocks/smartfile",
   "dependencies": {
     "@push.rocks/lik": "^6.0.15",
     "@push.rocks/smartdelay": "^3.0.5",

ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartfile',
-  version: '11.0.16',
+  version: '11.0.20',
   description: 'Provides comprehensive tools for efficient file management in Node.js using TypeScript, including handling streams, virtual directories, and various file operations.'
 }

ts/classes.smartfile.ts

@@ -306,4 +306,11 @@ export class SmartFile extends plugins.smartjson.Smartjson {
     stream.push(null); // Push null to signify the end of the stream (EOF)
     return stream;
   }
+
+  /**
+   * Returns the size of the file in bytes
+   */
+  public async getSize(): Promise<number> {
+    return this.contentBuffer.length;
+  }
 }

ts/classes.streamfile.ts

@@ -10,26 +10,16 @@ type TStreamSource = (streamFile: StreamFile) => Promise<Readable>;
  * It allows creating streams from a file path, a URL, or a buffer.
  */
 export class StreamFile {
-  // INSTANCE
-  relativeFilePath?: string;
-  private streamSource: TStreamSource;
-
-  // enable stream based multi use
-  private cachedStreamBuffer?: Buffer;
-  public multiUse: boolean;
-  public used: boolean = false;
-
-  private constructor(streamSource: TStreamSource, relativeFilePath?: string) {
-    this.streamSource = streamSource;
-    this.relativeFilePath = relativeFilePath;
-  }
-
   // STATIC
 
   public static async fromPath(filePath: string): Promise<StreamFile> {
-    const streamSource: TStreamSource = async (stremFileArg) => smartfileFsStream.createReadStream(filePath);
+    const streamSource: TStreamSource = async (streamFileArg) => smartfileFsStream.createReadStream(filePath);
     const streamFile = new StreamFile(streamSource, filePath);
     streamFile.multiUse = true;
+    streamFile.byteLengthComputeFunction = async () => {
+      const stats = await smartfileFs.stat(filePath);
+      return stats.size;
+    }
     return streamFile;
   }
 
@@ -37,6 +27,10 @@ export class StreamFile {
     const streamSource: TStreamSource = async (streamFileArg) => plugins.smartrequest.getStream(url); // Replace with actual plugin method
     const streamFile = new StreamFile(streamSource);
     streamFile.multiUse = true;
+    streamFile.byteLengthComputeFunction = async () => {
+      const response = await plugins.smartrequest.getBinary(url); // TODO: switch to future .getBinaryByteLength()
+      return response.body.length;
+    }
     return streamFile;
   }
 
@@ -49,6 +43,7 @@ export class StreamFile {
     };
     const streamFile = new StreamFile(streamSource, relativeFilePath);
     streamFile.multiUse = true;
+    streamFile.byteLengthComputeFunction = async () => buffer.length;
     return streamFile;
   }
 
@@ -91,6 +86,22 @@ export class StreamFile {
     return streamFile;
   }
 
+
+  // INSTANCE
+  relativeFilePath?: string;
+  private streamSource: TStreamSource;
+
+  // enable stream based multi use
+  private cachedStreamBuffer?: Buffer;
+  public multiUse: boolean;
+  public used: boolean = false;
+  public byteLengthComputeFunction: () => Promise<number>;
+
+  private constructor(streamSource: TStreamSource, relativeFilePath?: string) {
+    this.streamSource = streamSource;
+    this.relativeFilePath = relativeFilePath;
+  }
+
   // METHODS
 
   private checkMultiUse() {
@@ -149,4 +160,15 @@ export class StreamFile {
     const contentBuffer = await this.getContentAsBuffer();
     return contentBuffer.toString(formatArg);
   }
+
+  /**
+   * Returns the size of the file content in bytes.
+   */
+  public async getSize(): Promise<number> {
+    if (this.byteLengthComputeFunction) {
+      return this.byteLengthComputeFunction();
+    } else {
+      return null;
+    }
+  }
 }

ts/fs.ts

@@ -190,7 +190,8 @@ export const removeManySync = (filePathArrayArg: string[]): void => {
 ===============================================================*/
 
 /**
- *
+ * reads a file content to an object
+ * good for JSON, YAML, TOML, etc.
  * @param filePathArg
  * @param fileTypeArg
  * @returns {any}
@@ -485,7 +486,6 @@ export let toFs = async (
   return await done.promise;
 };
 
-
+export const stat = async (filePathArg: string) => {
-
+  return plugins.fsPromises.stat(filePathArg);
-
+}
-

ts/plugins.ts

@@ -1,9 +1,10 @@
 // node native scope
 import * as fs from 'fs';
+import * as fsPromises from 'fs/promises';
 import * as path from 'path';
 import * as stream from 'stream';
 
-export { fs, path, stream };
+export { fs, fsPromises, path, stream };
 
 // @pushrocks scope
 import * as lik from '@push.rocks/lik';