backlib 0.3.3 → 0.5.0-SNAPSHOT.1

package/README.md

@@ -8,7 +8,7 @@ Minimalist utilities for backend services.
 - **Web Async** Web request utilities based on [koajs](https://koajs.com/) over express as it is a modern rewrite of more or less the same API with backed in support for Promise/async/await (simplify many of the usecases)
 
 
-> NOTE: Still under development. If not part of BriteSnow, wait for 0.3.0 and above to use this library. In the meantime feel free to copy/paste code.
+> NOTE: Version `0.4.0` and above uses ESM module (i.e., `type: module`) only. 
 
 
 ## Log

package/dist/decorator-leaf-tracer.js

@@ -1,19 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.newLeafTracer = void 0;
 /**
  * Tracker to determine if a decorator is on the leaf"est" method of the class hierarchy.
  */
-function newLeafTracer() {
+export function newLeafTracer() {
     return new LeafTracer();
 }
-exports.newLeafTracer = newLeafTracer;
 /**
  * Ter
  */
 class LeafTracer {
-    // object class, by TopTarget
-    dic = new Map();
+    constructor() {
+        // object class, by TopTarget
+        this.dic = new Map();
+    }
     /** Returns true if this method is the leaf most method annotatio traced by this tracer */
     trace(objectClass, targetClass, propertyKey) {
         let topTargetClassByProperty = this.dic.get(objectClass);
@@ -41,3 +39,4 @@ class LeafTracer {
         }
     }
 }
+//# sourceMappingURL=decorator-leaf-tracer.js.map

package/dist/decorator-leaf-tracer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorator-leaf-tracer.js","sourceRoot":"","sources":["../src/decorator-leaf-tracer.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,MAAM,UAAU,aAAa;IAC5B,OAAO,IAAI,UAAU,EAAE,CAAC;AACzB,CAAC;AAID;;GAEG;AACH,MAAM,UAAU;IAAhB;QAEC,6BAA6B;QACrB,QAAG,GAA6C,IAAI,GAAG,EAAE,CAAC;IAgCnE,CAAC;IA9BA,0FAA0F;IAC1F,KAAK,CAAC,WAAqB,EAAE,WAAqB,EAAE,WAAmB;QAEtE,IAAI,wBAAwB,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAEzD,6FAA6F;QAC7F,oCAAoC;QACpC,IAAI,CAAC,wBAAwB,EAAE;YAC9B,wBAAwB,GAAG,IAAI,GAAG,EAAoB,CAAC;YACvD,wBAAwB,CAAC,GAAG,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YAEvD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,wBAAwB,CAAC,CAAC;YACpD,OAAO,IAAI,CAAC;SACZ;QACD,+BAA+B;aAC1B;YACJ,IAAI,cAAc,GAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAE/D,8DAA8D;YAC9D,6CAA6C;YAC7C,IAAI,CAAC,cAAc,EAAE;gBACpB,wBAAwB,CAAC,GAAG,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;gBACvD,OAAO,IAAI,CAAC;aACZ;YACD,6EAA6E;iBACxE;gBACJ,OAAO,CAAC,cAAc,KAAK,WAAW,CAAC,CAAC;aACxC;SACD;IACF,CAAC;CACD"}

package/dist/index.d.ts

@@ -1,4 +1,6 @@
-export * from './decorator-leaf-tracer';
-export * from './fs';
-export * from './log';
-export * from './utils';
+export { newLeafTracer } from './decorator-leaf-tracer.js';
+export { FileWriter } from './log-file-writer.js';
+export type { FileNameProvider, FileWriterOptions, OnFileCompleted, RecordSerializer } from './log-file-writer.js';
+export { BaseLog } from './log.js';
+export type { LogOptions, LogWriter } from './log.js';
+export { prompt } from './utils.js';

package/dist/index.js

@@ -1,16 +1,9 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./decorator-leaf-tracer"), exports);
-__exportStar(require("./fs"), exports);
-__exportStar(require("./log"), exports);
-__exportStar(require("./utils"), exports);
+// Export decorator constructs
+export { newLeafTracer } from './decorator-leaf-tracer.js';
+// Export log-file-writer constructs
+export { FileWriter } from './log-file-writer.js';
+// Export log constructs
+export { BaseLog } from './log.js';
+// Export utils constructs
+export { prompt } from './utils.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,oCAAoC;AACpC,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAElD,wBAAwB;AACxB,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEnC,0BAA0B;AAC1B,OAAO,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC"}

package/dist/log-file-writer.d.ts

@@ -0,0 +1,39 @@
+import { LogWriter } from './index.js';
+export declare type OnFileCompleted = (file: string) => Promise<void>;
+export declare type FileNameProvider = (rev: number) => string;
+/** Record serializer to string, which will be appended to the file. If null, record will be skipped */
+export declare type RecordSerializer<R> = (rec: R) => string | null;
+export interface FileWriterOptions<R> {
+    /** Local directory in which the logs files will be saved */
+    dir: string;
+    /** maxCount of record before file is uploaded to destination */
+    maxCount: number;
+    /** max time (in seconds) before file is uploaded to destination (which ever comes first with maxCount) */
+    maxTime: number;
+    /** Optional fileName generator for the new log file name (MUST BE UNIQUE for this dir) */
+    fileNameProvider?: FileNameProvider;
+    recordSerializer?: RecordSerializer<R>;
+    onFileCompleted?: OnFileCompleted;
+}
+export declare class FileWriter<R> implements LogWriter<R> {
+    readonly name = "to-deprecate";
+    private dir;
+    private maxCount;
+    private maxTime;
+    private fileNameProvider;
+    private recordSerializer;
+    private onFileCompleted?;
+    private _init;
+    private _rev;
+    private count;
+    private nextUpload;
+    private lastUpload?;
+    private file?;
+    constructor(opts: FileWriterOptions<R>);
+    private init;
+    /** Update the revision file */
+    private rev;
+    /** IMPLEMENTATION of the FileWriter interface */
+    writeRec(rec: R): Promise<void>;
+    private endFile;
+}

package/dist/log-file-writer.js

@@ -0,0 +1,104 @@
+import { pathExists } from 'fs-aux';
+import { appendFile, mkdir, rename } from 'fs/promises';
+import * as Path from "path";
+import { isString } from 'utils-min';
+export class FileWriter {
+    constructor(opts) {
+        this.name = 'to-deprecate'; // TODO: to deprecate
+        this._init = false;
+        this._rev = 0;
+        this.count = 0;
+        this.nextUpload = null; // null means nothing scheduled
+        this.maxCount = opts.maxCount;
+        this.maxTime = opts.maxTime;
+        this.dir = opts.dir;
+        this.fileNameProvider = opts.fileNameProvider ?? defaultFileNameProvider;
+        this.onFileCompleted = opts.onFileCompleted;
+        this.recordSerializer = opts.recordSerializer ?? defaultSerializer;
+    }
+    async init() {
+        if (!this._init) {
+            await mkdir(this.dir, { recursive: true });
+            this.rev();
+            this._init = true;
+        }
+    }
+    /** Update the revision file */
+    rev() {
+        this.count = 0;
+        this._rev = this._rev + 1;
+        const fileName = this.fileNameProvider(this._rev);
+        this.file = Path.join(this.dir, fileName);
+    }
+    /** IMPLEMENTATION of the FileWriter interface */
+    async writeRec(rec) {
+        if (!this._init) {
+            await this.init();
+        }
+        const str = this.recordSerializer(rec);
+        if (str != null) {
+            const strWithNl = str + '\n'; // add the new line
+            await appendFile(this.file, strWithNl);
+        }
+        // add count
+        this.count = this.count + 1;
+        // if we are above the count, we upload
+        if (this.count > this.maxCount) {
+            console.log(`->> rev ${this.name} because count ${this.count} > maxCount ${this.maxCount}`);
+            await this.endFile();
+        }
+        // if still below the count, but do not have this.nextUpload, schedule one
+        else if (this.nextUpload === null) {
+            const maxTimeMs = this.maxTime * 1000; // in ms
+            const nextUpload = Date.now() + maxTimeMs;
+            this.nextUpload = nextUpload;
+            setTimeout(async () => {
+                // perform only if this.nextUpload match the scheduled nextUpload (otherwise, was already processed and this schedule is outdated)
+                if (this.nextUpload === nextUpload) {
+                    console.log(`->> rev ${this.name} because maxTimeMs ${maxTimeMs}`);
+                    await this.endFile();
+                }
+            }, maxTimeMs);
+        }
+    }
+    async endFile() {
+        const file = this.file;
+        // we rev just before to make sure other logs will happen on new files
+        this.rev();
+        try {
+            const exists = await pathExists(file);
+            if (exists) {
+                if (this.onFileCompleted) {
+                    try {
+                        console.log(`->> endFile processing ${this.name} `);
+                        await this.onFileCompleted(file);
+                    }
+                    catch (ex) {
+                        console.log(`LOG PROCESSING ERROR - processing file '${file}' caused the following error: ${ex}`);
+                    }
+                }
+            }
+            else {
+                console.log(`LOG PROCESSING REMOVE ERROR - cannot be processed file '${file}' does not exists anymore`);
+            }
+        }
+        // Note: note sure we need this global catch now. 
+        catch (ex) {
+            console.log(`LOG PROCESSING - logger.processLogFile - cannot upload to big query ${file}, ${ex.message}`);
+            await rename(file, file + '.error');
+        }
+        this.count = 0;
+        this.lastUpload = Date.now();
+        this.nextUpload = null;
+    }
+}
+/** default serializer */
+function defaultSerializer(rec) {
+    return isString(rec) ? rec : JSON.stringify(rec);
+}
+function defaultFileNameProvider(rev) {
+    const date = new Date().toISOString().replace(/[T:.]/g, "-").slice(0, -1);
+    const revStr = `${rev}`.padStart(5, '0');
+    return `log-file-${date}-${revStr}.log`;
+}
+//# sourceMappingURL=log-file-writer.js.map

package/dist/log-file-writer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log-file-writer.js","sourceRoot":"","sources":["../src/log-file-writer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AA0BrC,MAAM,OAAO,UAAU;IAkBrB,YAAY,IAA0B;QAjB7B,SAAI,GAAG,cAAc,CAAC,CAAC,qBAAqB;QAS7C,UAAK,GAAG,KAAK,CAAC;QACd,SAAI,GAAG,CAAC,CAAC;QACT,UAAK,GAAG,CAAC,CAAC;QACV,eAAU,GAAkB,IAAI,CAAC,CAAC,+BAA+B;QAMvE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC9B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;QACpB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,IAAI,uBAAuB,CAAC;QACzE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAC5C,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,IAAI,iBAAiB,CAAC;IACrE,CAAC;IAEO,KAAK,CAAC,IAAI;QAChB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3C,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;SACnB;IACH,CAAC;IAED,+BAA+B;IACvB,GAAG;QACT,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAElD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;IAC3C,CAAC;IAGD,iDAAiD;IACjD,KAAK,CAAC,QAAQ,CAAC,GAAM;QAEnB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;SACnB;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE;YACf,MAAM,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,mBAAmB;YACjD,MAAM,UAAU,CAAC,IAAI,CAAC,IAAK,EAAE,SAAS,CAAC,CAAC;SACzC;QAED,YAAY;QACZ,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QAE5B,uCAAuC;QACvC,IAAI,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,EAAE;YAC9B,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,CAAC,IAAI,kBAAkB,IAAI,CAAC,KAAK,eAAe,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;YAC5F,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;SACtB;QACD,0EAA0E;aACrE,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE;YACjC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC,QAAQ;YAE/C,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;YAC1C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAE7B,UAAU,CAAC,KAAK,IAAI,EAAE;gBACpB,kIAAkI;gBAClI,IAAI,IAAI,CAAC,UAAU,KAAK,UAAU,EAAE;oBAClC,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,CAAC,IAAI,sBAAsB,SAAS,EAAE,CAAC,CAAC;oBACnE,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;iBACtB;YACH,CAAC,EAAE,SAAS,CAAC,CAAC;SACf;IAEH,CAAC;IAEO,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAK,CAAC;QACxB,sEAAsE;QACtE,IAAI,CAAC,GAAG,EAAE,CAAC;QAEX,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,CAAC;YACtC,IAAI,MAAM,EAAE;gBACV,IAAI,IAAI,CAAC,eAAe,EAAE;oBACxB,IAAI;wBACF,OAAO,CAAC,GAAG,CAAC,0BAA0B,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;wBACpD,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;qBAClC;oBAAC,OAAO,EAAO,EAAE;wBAChB,OAAO,CAAC,GAAG,CAAC,2CAA2C,IAAI,iCAAiC,EAAE,EAAE,CAAC,CAAC;qBACnG;iBACF;aACF;iBAAM;gBACL,OAAO,CAAC,GAAG,CAAC,2DAA2D,IAAI,2BAA2B,CAAC,CAAC;aACzG;SAEF;QACD,kDAAkD;QAClD,OAAO,EAAO,EAAE;YACd,OAAO,CAAC,GAAG,CAAC,uEAAuE,IAAI,KAAK,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC;YAC1G,MAAM,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,QAAQ,CAAC,CAAC;SACrC;QAED,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;CAEF;AAED,yBAAyB;AAEzB,SAAS,iBAAiB,CAAI,GAAM;IAClC,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AACnD,CAAC;AAED,SAAS,uBAAuB,CAAC,GAAW;IAC1C,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC1E,MAAM,MAAM,GAAG,GAAG,GAAG,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACzC,OAAO,YAAY,IAAI,IAAI,MAAM,MAAM,CAAC;AAC1C,CAAC"}

package/dist/log.d.ts

@@ -1,4 +1,4 @@
-interface LogOptions<R> {
+export interface LogOptions<R> {
     writers: LogWriter<R>[];
 }
 /**
@@ -10,44 +10,5 @@ export declare class BaseLog<R> {
     log(rec: R): Promise<void>;
 }
 export interface LogWriter<R> {
-    readonly name: string;
     writeRec?(rec: R): Promise<void>;
 }
-/** processing file, if return true, then file will be assumed to be full processed, and will be deleted */
-export declare type FileProcessor = (file: string) => Promise<boolean>;
-/** Record serializer to string, which will be appended to the file. If null, record will be skipped */
-export declare type RecordSerializer<R> = (rec: R) => string | null;
-interface FileLogWriterOptions<R> {
-    /** name of the logWriter, will be used as prefix */
-    name: string;
-    /** Local directory in which the logs files will be saved */
-    dir: string;
-    /** maxCount of record before file is uploaded to destination */
-    maxCount: number;
-    /** max time (in ms) before file is uploaded to destination (which ever comes first with maxCount) */
-    maxTime: number;
-    fileProcessor?: FileProcessor;
-    recordSerializer?: RecordSerializer<R>;
-}
-export declare class FileLogWriter<R> implements LogWriter<R> {
-    readonly name: string;
-    private dir;
-    private maxCount;
-    private maxTime;
-    private fileProcessor?;
-    private recordSerializer;
-    private _init;
-    private _rev;
-    private count;
-    private nextUpload;
-    private lastUpload?;
-    private file?;
-    constructor(opts: FileLogWriterOptions<R>);
-    private init;
-    /** Update the revision file */
-    private rev;
-    /** IMPLEMENTATION of the FileWriter interface */
-    writeRec(rec: R): Promise<void>;
-    private endFile;
-}
-export {};

package/dist/log.js

@@ -1,35 +1,10 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileLogWriter = exports.BaseLog = void 0;
-const fs = __importStar(require("fs-extra"));
-const Path = __importStar(require("path"));
-const utils_min_1 = require("utils-min");
-const fs_1 = require("./fs");
+// const { pathExists, mkdirs, appendFile, rename } = (await import('fs-extra')).default;
 /**
  * Base Log class that handle the base log management logic.
  */
-class BaseLog {
-    logWriters = [];
+export class BaseLog {
     constructor(opts) {
+        this.logWriters = [];
         this.logWriters = [...opts.writers];
     }
     async log(rec) {
@@ -41,110 +16,10 @@ class BaseLog {
                 }
                 catch (ex) {
                     // here log console.log, no choise
-                    console.log(`LOG ERROR - Log exception when writeRec on logWriter ${writer.name}. ${ex}`);
+                    console.log(`ERROR - BACKLIB - Log exception when writeRec on logWriter ${writer}. ${ex}`);
                 }
             }
         }
     }
 }
-exports.BaseLog = BaseLog;
-class FileLogWriter {
-    name;
-    dir;
-    maxCount;
-    maxTime;
-    fileProcessor;
-    recordSerializer;
-    _init = false;
-    _rev = 0;
-    count = 0;
-    nextUpload = null; // null means nothing scheduled
-    lastUpload;
-    file;
-    constructor(opts) {
-        this.name = opts.name;
-        this.maxCount = opts.maxCount;
-        this.maxTime = opts.maxTime;
-        this.dir = opts.dir;
-        this.fileProcessor = opts.fileProcessor;
-        this.recordSerializer = opts.recordSerializer ?? defaultSerializer;
-    }
-    async init() {
-        if (!this._init) {
-            await fs.mkdirs(this.dir);
-            // delete the logs dir if exit
-            const oldLogFiles = await fs_1.glob(this.dir + `${this.name}*.log`);
-            await fs_1.saferRemove(oldLogFiles);
-            console.log('Deleted old log files', oldLogFiles);
-            this.rev();
-            this._init = true;
-        }
-    }
-    /** Update the revision file */
-    rev() {
-        this.count = 0;
-        this._rev = this._rev + 1;
-        const suffix = `${this._rev}`.padStart(5, '0');
-        this.file = Path.join(this.dir, `${this.name}-${suffix}.log`);
-    }
-    /** IMPLEMENTATION of the FileWriter interface */
-    async writeRec(rec) {
-        if (!this._init) {
-            await this.init();
-        }
-        // TODO: Need to move this outside of the generic log implementation (we do this because bigquery expect info to be string, since it can be dynamic)
-        // NOTE: In fact, this whole file write and upload, should be part of a FileLogWriter, and we just treat it as above (perhaps in the BigQueryLogWriter extends FileLogWriter)
-        const str = this.recordSerializer(rec);
-        if (str != null) {
-            await fs.appendFile(this.file, str);
-        }
-        // add count
-        this.count = this.count + 1;
-        // if we are above the count, we upload
-        if (this.count > this.maxCount) {
-            await this.endFile();
-        }
-        // if still below the count, but do not have this.nextUpload, schedule one
-        else if (this.nextUpload === null) {
-            const maxTimeMs = this.maxTime * 1000; // in ms
-            const nextUpload = Date.now() + maxTimeMs;
-            this.nextUpload = nextUpload;
-            setTimeout(async () => {
-                // perform only if this.nextUpload match the scheduled nextUpload (otherwise, was already processed and this schedule is outdated)
-                if (this.nextUpload === nextUpload) {
-                    await this.endFile();
-                }
-            }, maxTimeMs);
-        }
-    }
-    async endFile() {
-        const file = this.file;
-        // we rev just before to make sure other logs will happen on new files
-        this.rev();
-        try {
-            const exists = await fs.pathExists(file);
-            if (exists) {
-                if (this.fileProcessor) {
-                    await this.fileProcessor(file);
-                }
-                await fs_1.saferRemove(file);
-            }
-            else {
-                console.log(`CODE ERROR - can't upload to big query ${file} does not exists`);
-            }
-        }
-        catch (ex) {
-            console.log(`ERROR - logger.processLogFile - cannot upload to big query ${file}, ${ex.message}`);
-            await fs.rename(file, file + '.error');
-        }
-        this.count = 0;
-        this.lastUpload = Date.now();
-        this.nextUpload = null;
-    }
-}
-exports.FileLogWriter = FileLogWriter;
-/** default serializer */
-function defaultSerializer(rec) {
-    return utils_min_1.isString(rec) ? rec : JSON.stringify(rec);
-}
-//#endregion ---------- /FileLogWriter ---------- 
+//# sourceMappingURL=log.js.map

package/dist/log.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../src/log.ts"],"names":[],"mappings":"AACA,yFAAyF;AAQzF;;GAEG;AACH,MAAM,OAAO,OAAO;IAGnB,YAAY,IAAmB;QAFvB,eAAU,GAAmB,EAAE,CAAC;QAGvC,IAAI,CAAC,UAAU,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAM;QAEf,GAAG;QACH,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,UAAU,EAAE;YACrC,IAAI,MAAM,CAAC,QAAQ,EAAE;gBACpB,IAAI;oBACH,MAAM,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;iBAC3B;gBAAC,OAAO,EAAE,EAAE;oBACZ,kCAAkC;oBAClC,OAAO,CAAC,GAAG,CAAC,8DAA8D,MAAM,KAAK,EAAE,EAAE,CAAC,CAAC;iBAC3F;aACD;SACD;IAEF,CAAC;CAED"}

package/dist/utils.js

@@ -1,8 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.prompt = void 0;
 /** Promise a message and return the trimmed entered value */
-async function prompt(message) {
+export async function prompt(message) {
     process.stdout.write(`\n${message}: `);
     return new Promise(function (resolve, reject) {
         process.stdin.resume();
@@ -13,4 +10,4 @@ async function prompt(message) {
         });
     });
 }
-exports.prompt = prompt;
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,6DAA6D;AAC7D,MAAM,CAAC,KAAK,UAAU,MAAM,CAAC,OAAe;IAC3C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,OAAO,IAAI,CAAC,CAAC;IACvC,OAAO,IAAI,OAAO,CAAC,UAAU,OAAO,EAAE,MAAM;QAC3C,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QACvB,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAClC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,IAAI;YACtC,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,35 +1,30 @@
 {
   "name": "backlib",
-  "version": "0.3.3",
+  "type": "module",
+  "version": "0.5.0-SNAPSHOT.1",
   "description": "Minimalist library for backend services",
   "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
   "engines": {
-    "node": ">=14.4"
+    "node": ">=16.13"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/britesnow/node-backlib.git"
   },
   "scripts": {
-    "test": "TS_NODE_FILES=true ./node_modules/.bin/mocha -p ./test/tsconfig.json ./test/spec/*.spec.ts",
-    "testw": "TS_NODE_FILES=true ./node_modules/.bin/mocha -p ./test/tsconfig.json ./test/spec/*.spec.ts --watch --watch-files './test/**/*.ts','./src/**/*.ts'",
+    "test": "echo 'no test for now'",
     "prepare": "node_modules/.bin/rimraf ./dist && ./node_modules/.bin/tsc"
   },
   "author": "jeremy.chone@gmail.com",
   "license": "MIT",
   "dependencies": {
-    "fast-glob": "^3.2.7",
-    "fs-extra": "^10.0.0",
-    "utils-min": "^0.1.18"
+    "fs-aux": "^0.1.0",
+    "utils-min": "^0.2.0"
   },
   "devDependencies": {
-    "@types/fs-extra": "^9.0.12",
-    "@types/mocha": "^9.0.0",
-    "mocha": "^9.0.2",
+    "@types/node": "^17.0.10",
     "rimraf": "^3.0.2",
-    "ts-node-dev": "^1.1.8",
-    "typescript": "^4.3.5"
+    "typescript": "^4.5.5"
   },
   "files": [
     "src/",

package/src/index.ts

@@ -1,5 +1,19 @@
-export * from './decorator-leaf-tracer';
-export * from './fs';
-export * from './log';
-export * from './utils';
+// Export decorator constructs
+export { newLeafTracer } from './decorator-leaf-tracer.js';
+// Export log-file-writer constructs
+export { FileWriter } from './log-file-writer.js';
+export type { FileNameProvider, FileWriterOptions, OnFileCompleted, RecordSerializer } from './log-file-writer.js';
+// Export log constructs
+export { BaseLog } from './log.js';
+export type { LogOptions, LogWriter } from './log.js';
+// Export utils constructs
+export { prompt } from './utils.js';
+
+
+
+
+
+
+
+
 

package/src/log-file-writer.ts

@@ -0,0 +1,159 @@
+import { pathExists } from 'fs-aux';
+import { appendFile, mkdir, rename } from 'fs/promises';
+import * as Path from "path";
+import { isString } from 'utils-min';
+import { LogWriter } from './index.js';
+
+export type OnFileCompleted = (file: string) => Promise<void>;
+export type FileNameProvider = (rev: number) => string;
+
+/** Record serializer to string, which will be appended to the file. If null, record will be skipped */
+export type RecordSerializer<R> = (rec: R) => string | null;
+
+export interface FileWriterOptions<R> {
+  /** Local directory in which the logs files will be saved */
+  dir: string;
+  /** maxCount of record before file is uploaded to destination */
+  maxCount: number;
+  /** max time (in seconds) before file is uploaded to destination (which ever comes first with maxCount) */
+  maxTime: number;
+
+  /** Optional fileName generator for the new log file name (MUST BE UNIQUE for this dir) */
+  fileNameProvider?: FileNameProvider,
+  /* Optional recordSerializer to file. By default, JSON.serializer() (new line json) */
+  recordSerializer?: RecordSerializer<R>;
+  /* Call when a log file is completed (i.e., new entries will go to another file) */
+  onFileCompleted?: OnFileCompleted;
+
+}
+
+export class FileWriter<R> implements LogWriter<R> {
+  readonly name = 'to-deprecate'; // TODO: to deprecate
+  private dir: string;
+  private maxCount: number;
+  private maxTime: number;
+
+  private fileNameProvider: FileNameProvider;
+  private recordSerializer: RecordSerializer<R>;
+  private onFileCompleted?: OnFileCompleted;
+
+  private _init = false;
+  private _rev = 0;
+  private count = 0;
+  private nextUpload: number | null = null; // null means nothing scheduled
+  private lastUpload?: number;
+
+  private file?: string;
+
+  constructor(opts: FileWriterOptions<R>) {
+    this.maxCount = opts.maxCount;
+    this.maxTime = opts.maxTime;
+    this.dir = opts.dir;
+    this.fileNameProvider = opts.fileNameProvider ?? defaultFileNameProvider;
+    this.onFileCompleted = opts.onFileCompleted;
+    this.recordSerializer = opts.recordSerializer ?? defaultSerializer;
+  }
+
+  private async init() {
+    if (!this._init) {
+      await mkdir(this.dir, { recursive: true });
+      this.rev();
+      this._init = true;
+    }
+  }
+
+  /** Update the revision file */
+  private rev() {
+    this.count = 0;
+    this._rev = this._rev + 1;
+
+    const fileName = this.fileNameProvider(this._rev);
+
+    this.file = Path.join(this.dir, fileName)
+  }
+
+
+  /** IMPLEMENTATION of the FileWriter interface */
+  async writeRec(rec: R) {
+
+    if (!this._init) {
+      await this.init();
+    }
+
+    const str = this.recordSerializer(rec);
+    if (str != null) {
+      const strWithNl = str + '\n'; // add the new line
+      await appendFile(this.file!, strWithNl);
+    }
+
+    // add count
+    this.count = this.count + 1;
+
+    // if we are above the count, we upload
+    if (this.count > this.maxCount) {
+      console.log(`->> rev ${this.name} because count ${this.count} > maxCount ${this.maxCount}`);
+      await this.endFile();
+    }
+    // if still below the count, but do not have this.nextUpload, schedule one
+    else if (this.nextUpload === null) {
+      const maxTimeMs = this.maxTime * 1000; // in ms
+
+      const nextUpload = Date.now() + maxTimeMs;
+      this.nextUpload = nextUpload;
+
+      setTimeout(async () => {
+        // perform only if this.nextUpload match the scheduled nextUpload (otherwise, was already processed and this schedule is outdated)
+        if (this.nextUpload === nextUpload) {
+          console.log(`->> rev ${this.name} because maxTimeMs ${maxTimeMs}`);
+          await this.endFile();
+        }
+      }, maxTimeMs);
+    }
+
+  }
+
+  private async endFile() {
+    const file = this.file!;
+    // we rev just before to make sure other logs will happen on new files
+    this.rev();
+
+    try {
+      const exists = await pathExists(file);
+      if (exists) {
+        if (this.onFileCompleted) {
+          try {
+            console.log(`->> endFile processing ${this.name} `);
+            await this.onFileCompleted(file);
+          } catch (ex: any) {
+            console.log(`LOG PROCESSING ERROR - processing file '${file}' caused the following error: ${ex}`);
+          }
+        }
+      } else {
+        console.log(`LOG PROCESSING REMOVE ERROR - cannot be processed file '${file}' does not exists anymore`);
+      }
+
+    }
+    // Note: note sure we need this global catch now. 
+    catch (ex: any) {
+      console.log(`LOG PROCESSING - logger.processLogFile - cannot upload to big query ${file}, ${ex.message}`);
+      await rename(file, file + '.error');
+    }
+
+    this.count = 0;
+    this.lastUpload = Date.now();
+    this.nextUpload = null;
+  }
+
+}
+
+/** default serializer */
+
+function defaultSerializer<R>(rec: R): string {
+  return isString(rec) ? rec : JSON.stringify(rec);
+}
+
+function defaultFileNameProvider(rev: number): string {
+  const date = new Date().toISOString().replace(/[T:.]/g, "-").slice(0, -1);
+  const revStr = `${rev}`.padStart(5, '0');
+  return `log-file-${date}-${revStr}.log`;
+}

package/src/log.ts

@@ -1,11 +1,9 @@
-import * as fs from 'fs-extra';
-import * as Path from 'path';
-import { isString } from 'utils-min';
-import { glob, saferRemove } from './fs';
+
+// const { pathExists, mkdirs, appendFile, rename } = (await import('fs-extra')).default;
 
 
 //#region    ---------- BaseLog ---------- 
-interface LogOptions<R> {
+export interface LogOptions<R> {
 	writers: LogWriter<R>[]
 }
 
@@ -28,7 +26,7 @@ export class BaseLog<R> {
 					await writer.writeRec(rec);
 				} catch (ex) {
 					// here log console.log, no choise
-					console.log(`LOG ERROR - Log exception when writeRec on logWriter ${writer.name}. ${ex}`);
+					console.log(`ERROR - BACKLIB - Log exception when writeRec on logWriter ${writer}. ${ex}`);
 				}
 			}
 		}
@@ -39,161 +37,6 @@ export class BaseLog<R> {
 //#endregion ---------- /BaseLog ---------- 
 
 export interface LogWriter<R> {
-	readonly name: string;
 	writeRec?(rec: R): Promise<void>
 }
 
-
-//#region    ---------- FileLogWriter ---------- 
-/** processing file, if return true, then file will be assumed to be full processed, and will be deleted */
-export type FileProcessor = (file: string) => Promise<boolean>;
-
-/** Record serializer to string, which will be appended to the file. If null, record will be skipped */
-export type RecordSerializer<R> = (rec: R) => string | null;
-
-interface FileLogWriterOptions<R> {
-	/** name of the logWriter, will be used as prefix */
-	name: string;
-	/** Local directory in which the logs files will be saved */
-	dir: string;
-	/** maxCount of record before file is uploaded to destination */
-	maxCount: number;
-	/** max time (in ms) before file is uploaded to destination (which ever comes first with maxCount) */
-	maxTime: number;
-
-	/* Mehod to process the file (.e.g., upload to bucket, bigquery, ...) */
-	fileProcessor?: FileProcessor;
-
-	/* Optional recordSerializer to file. By default, JSON.serializer() (new line json) */
-	recordSerializer?: RecordSerializer<R>;
-}
-
-
-
-export class FileLogWriter<R> implements LogWriter<R> {
-
-	readonly name: string;
-	private dir: string;
-	private maxCount: number;
-	private maxTime: number;
-	private fileProcessor?: FileProcessor;
-	private recordSerializer: RecordSerializer<R>;
-
-	private _init = false;
-	private _rev = 0;
-	private count = 0;
-	private nextUpload: number | null = null; // null means nothing scheduled
-	private lastUpload?: number;
-
-	private file?: string;
-
-
-	constructor(opts: FileLogWriterOptions<R>) {
-		this.name = opts.name;
-		this.maxCount = opts.maxCount;
-		this.maxTime = opts.maxTime;
-		this.dir = opts.dir;
-		this.fileProcessor = opts.fileProcessor;
-		this.recordSerializer = opts.recordSerializer ?? defaultSerializer;
-	}
-
-	private async init() {
-		if (!this._init) {
-			await fs.mkdirs(this.dir);
-
-			// delete the logs dir if exit
-			const oldLogFiles = await glob(this.dir + `${this.name}*.log`);
-			await saferRemove(oldLogFiles);
-			console.log('Deleted old log files', oldLogFiles);
-
-			this.rev();
-
-			this._init = true;
-		}
-
-	}
-
-	/** Update the revision file */
-	private rev() {
-		this.count = 0;
-		this._rev = this._rev + 1;
-		const suffix = `${this._rev}`.padStart(5, '0');
-		this.file = Path.join(this.dir, `${this.name}-${suffix}.log`)
-	}
-
-
-	/** IMPLEMENTATION of the FileWriter interface */
-	async writeRec(rec: R) {
-
-		if (!this._init) {
-			await this.init();
-		}
-
-		// TODO: Need to move this outside of the generic log implementation (we do this because bigquery expect info to be string, since it can be dynamic)
-		// NOTE: In fact, this whole file write and upload, should be part of a FileLogWriter, and we just treat it as above (perhaps in the BigQueryLogWriter extends FileLogWriter)
-		const str = this.recordSerializer(rec);
-		if (str != null) {
-			await fs.appendFile(this.file!, str);
-		}
-
-		// add count
-		this.count = this.count + 1;
-
-		// if we are above the count, we upload
-		if (this.count > this.maxCount) {
-			await this.endFile();
-		}
-		// if still below the count, but do not have this.nextUpload, schedule one
-		else if (this.nextUpload === null) {
-			const maxTimeMs = this.maxTime * 1000; // in ms
-
-			const nextUpload = Date.now() + maxTimeMs;
-			this.nextUpload = nextUpload;
-
-			setTimeout(async () => {
-				// perform only if this.nextUpload match the scheduled nextUpload (otherwise, was already processed and this schedule is outdated)
-				if (this.nextUpload === nextUpload) {
-					await this.endFile();
-				}
-			}, maxTimeMs);
-		}
-
-	}
-
-	private async endFile() {
-		const file = this.file!;
-		// we rev just before to make sure other logs will happen on new files
-		this.rev();
-
-		try {
-			const exists = await fs.pathExists(file);
-			if (exists) {
-				if (this.fileProcessor) {
-					await this.fileProcessor(file);
-				}
-				await saferRemove(file);
-			} else {
-				console.log(`CODE ERROR - can't upload to big query ${file} does not exists`);
-			}
-
-		} catch (ex) {
-			console.log(`ERROR - logger.processLogFile - cannot upload to big query ${file}, ${ex.message}`);
-			await fs.rename(file, file + '.error');
-		}
-
-		this.count = 0;
-		this.lastUpload = Date.now();
-		this.nextUpload = null;
-	}
-
-}
-
-/** default serializer */
-
-function defaultSerializer<R>(rec: R): string {
-	return isString(rec) ? rec : JSON.stringify(rec);
-}
-
-//#endregion ---------- /FileLogWriter ---------- 
-
-

package/dist/fs.d.ts

@@ -1,12 +0,0 @@
-import { Options } from 'fast-glob';
-/**
- * Simplified and sorted glob function (using fast-glob) for one or more pattern from current directory or a optional cwd one.
- *
- * Note 1: The result will be sorted by natural directory/subdir/filename order (as a would a recursive walk)
- * Note 2: When `cwd` in options, it is added to the file path i.e. `pathJoin(cwd, path)`
- *
- * @returns always sorted result return Promise<string[]>
-*/
-export declare function glob(pattern: string | string[], cwdOrFastGlobOptions?: string | Options): Promise<string[]>;
-/** Remove one or more files. Resolved the number of names removed */
-export declare function saferRemove(names: string | string[], cwd?: string): Promise<string[]>;

package/dist/fs.js

@@ -1,77 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.saferRemove = exports.glob = void 0;
-const fast_glob_1 = __importDefault(require("fast-glob"));
-const fs_extra_1 = require("fs-extra");
-const path_1 = require("path");
-const utils_min_1 = require("utils-min");
-/**
- * Simplified and sorted glob function (using fast-glob) for one or more pattern from current directory or a optional cwd one.
- *
- * Note 1: The result will be sorted by natural directory/subdir/filename order (as a would a recursive walk)
- * Note 2: When `cwd` in options, it is added to the file path i.e. `pathJoin(cwd, path)`
- *
- * @returns always sorted result return Promise<string[]>
-*/
-async function glob(pattern, cwdOrFastGlobOptions) {
-    let opts = undefined;
-    if (cwdOrFastGlobOptions != null) {
-        opts = (typeof cwdOrFastGlobOptions === 'string') ? { cwd: cwdOrFastGlobOptions } : cwdOrFastGlobOptions;
-    }
-    const result = await fast_glob_1.default(pattern, opts);
-    const cwd = (opts) ? opts.cwd : undefined;
-    const list = result.map(path => {
-        return (cwd) ? path_1.join(cwd, path) : path;
-    });
-    return list.sort(globCompare);
-}
-exports.glob = glob;
-/** Remove one or more files. Resolved the number of names removed */
-async function saferRemove(names, cwd) {
-    const baseDir = (cwd) ? path_1.resolve(cwd) : path_1.resolve('./');
-    let removedNames = [];
-    for (const name of utils_min_1.asArray(names)) {
-        const fullPath = path_1.join(baseDir, name);
-        if (!fullPath.startsWith(baseDir)) {
-            throw new Error(`Path to be removed does not look safe (nothing done): ${fullPath}\n\tCause: Does not belong to ${baseDir}`);
-        }
-        const exists = await fs_extra_1.pathExists(fullPath);
-        if (exists) {
-            await fs_extra_1.remove(fullPath);
-            removedNames.push(name);
-        }
-    }
-    return removedNames;
-}
-exports.saferRemove = saferRemove;
-//#region    ---------- Utils ---------- 
-function globCompare(a, b) {
-    const aPathIdxs = pathIndexes(a);
-    const bPathIdxs = pathIndexes(b);
-    const minIdx = Math.min(aPathIdxs.length, bPathIdxs.length) - 1;
-    const aMinPath = a.substring(0, aPathIdxs[minIdx]);
-    const bMinPath = b.substring(0, bPathIdxs[minIdx]);
-    // if the common path is the same, and the path depth is different, then, the shortest one come first;
-    if ((aMinPath === bMinPath) && (aPathIdxs.length !== bPathIdxs.length)) {
-        return (aPathIdxs.length < bPathIdxs.length) ? -1 : 1;
-    }
-    // otherwise, we do a normal compare
-    return (a < b) ? -1 : 1;
-}
-function pathIndexes(fullPath) {
-    const idxs = [];
-    const l = fullPath.length;
-    for (let i = 0; i < l; i++) {
-        if (fullPath[i] === '/') {
-            idxs.push(i);
-        }
-    }
-    return idxs;
-}
-// function asArray(names: string | string[]) {
-// 	return (names instanceof Array) ? names : [names];
-// }
-//#endregion ---------- /Utils ----------

package/src/fs.ts

@@ -1,84 +0,0 @@
-import FastGlob, { Options } from 'fast-glob';
-import { pathExists, remove } from 'fs-extra';
-import { join as pathJoin, resolve as pathResolve } from 'path';
-import { asArray } from 'utils-min';
-
-/** 
- * Simplified and sorted glob function (using fast-glob) for one or more pattern from current directory or a optional cwd one. 
- * 
- * Note 1: The result will be sorted by natural directory/subdir/filename order (as a would a recursive walk)
- * Note 2: When `cwd` in options, it is added to the file path i.e. `pathJoin(cwd, path)`
- * 
- * @returns always sorted result return Promise<string[]>
-*/
-export async function glob(pattern: string | string[], cwdOrFastGlobOptions?: string | Options): Promise<string[]> {
-	let opts: Options | undefined = undefined;
-
-	if (cwdOrFastGlobOptions != null) {
-		opts = (typeof cwdOrFastGlobOptions === 'string') ? { cwd: cwdOrFastGlobOptions } : cwdOrFastGlobOptions;
-	}
-
-	const result = await FastGlob(pattern, opts);
-	const cwd = (opts) ? opts.cwd : undefined;
-	const list = result.map(path => {
-		return (cwd) ? pathJoin(cwd, path) : path;
-	});
-	return list.sort(globCompare);
-}
-
-/** Remove one or more files. Resolved the number of names removed */
-export async function saferRemove(names: string | string[], cwd?: string): Promise<string[]> {
-	const baseDir = (cwd) ? pathResolve(cwd) : pathResolve('./');
-	let removedNames: string[] = [];
-
-	for (const name of asArray(names)) {
-		const fullPath = pathJoin(baseDir, name);
-		if (!fullPath.startsWith(baseDir)) {
-			throw new Error(`Path to be removed does not look safe (nothing done): ${fullPath}\n\tCause: Does not belong to ${baseDir}`);
-		}
-		const exists = await pathExists(fullPath);
-		if (exists) {
-			await remove(fullPath);
-			removedNames.push(name);
-		}
-	}
-	return removedNames;
-}
-
-
-//#region    ---------- Utils ---------- 
-function globCompare(a: string, b: string) {
-	const aPathIdxs = pathIndexes(a);
-	const bPathIdxs = pathIndexes(b);
-	const minIdx = Math.min(aPathIdxs.length, bPathIdxs.length) - 1;
-	const aMinPath = a.substring(0, aPathIdxs[minIdx]);
-	const bMinPath = b.substring(0, bPathIdxs[minIdx]);
-
-	// if the common path is the same, and the path depth is different, then, the shortest one come first;
-	if ((aMinPath === bMinPath) && (aPathIdxs.length !== bPathIdxs.length)) {
-		return (aPathIdxs.length < bPathIdxs.length) ? -1 : 1;
-	}
-
-	// otherwise, we do a normal compare
-	return (a < b) ? -1 : 1;
-
-
-}
-
-function pathIndexes(fullPath: string): number[] {
-	const idxs: number[] = [];
-
-	const l = fullPath.length;
-	for (let i = 0; i < l; i++) {
-		if (fullPath[i] === '/') {
-			idxs.push(i);
-		}
-	}
-
-	return idxs;
-}
-
-// function asArray(names: string | string[]) {
-// 	return (names instanceof Array) ? names : [names];
-// }
-//#endregion ---------- /Utils ----------