tnp-helpers 19.0.52 → 19.0.54

package/lib/utils.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UtilsPasswords = exports.UtilsJava = exports.UtilsTaonWorker = exports.UtilsZip = exports.UtilsZipBrowser = exports.UtilsDotFile = exports.UtilsVSCode = exports.UtilsQuickFixes = exports.UtilsMd = exports.UtilsHttp = exports.UtilsTypescript = exports.UtilsNpm = void 0;
+exports.UtilsCliMethod = exports.FilePathMetaData = exports.UtilsPasswords = exports.UtilsJava = exports.UtilsTaonWorker = exports.UtilsZip = exports.UtilsZipBrowser = exports.UtilsVSCode = exports.UtilsQuickFixes = exports.UtilsMd = exports.UtilsHttp = exports.UtilsTypescript = exports.UtilsNpm = void 0;
 //#region imports
 const node_crypto_1 = require("node:crypto"); // @backend
 const lib_1 = require("tnp-config/lib");
 const lib_2 = require("tnp-core/lib");
 const lib_3 = require("tnp-core/lib");
 const typescript_1 = require("typescript");
+const lib_4 = require("typescript-class-helpers/lib");
 const index_1 = require("./index");
 //#endregion
 //#region utils npm
@@ -1267,226 +1268,6 @@ var UtilsVSCode;
     };
 })(UtilsVSCode || (exports.UtilsVSCode = UtilsVSCode = {}));
 //#endregion
-//#region utils dot file
-var UtilsDotFile;
-(function (UtilsDotFile) {
-    //#region parse value from dot file util
-    const parseValue = (rawValue) => {
-        const val = rawValue.trim().replace(/^"|"$/g, '');
-        // Try boolean
-        if (val.toLowerCase() === 'true')
-            return true;
-        if (val.toLowerCase() === 'false')
-            return false;
-        // Try number
-        if (!isNaN(Number(val)) && val !== '')
-            return Number(val);
-        return val;
-    };
-    //#endregion
-    //#region set value to/from dot file
-    UtilsDotFile.setValueToDotFile = (dotFileAbsPath, key, value) => {
-        //#region @backendFunc
-        dotFileAbsPath = (0, lib_2.crossPlatformPath)(dotFileAbsPath);
-        let envContent = '';
-        if (lib_2.fse.existsSync(dotFileAbsPath)) {
-            envContent = index_1.Helpers.readFile(dotFileAbsPath, '');
-        }
-        else {
-            // Create file if it doesn't exist
-            index_1.Helpers.writeFile(dotFileAbsPath, '');
-            index_1.Helpers.logInfo(`[${lib_1.config.frameworkName}-helpers] Created ${lib_2.path.basename(dotFileAbsPath)}`);
-            envContent = '';
-        }
-        const regex = new RegExp(`^${key}=.*$`, 'm');
-        if (regex.test(envContent)) {
-            // Replace existing
-            envContent = envContent.replace(regex, `${key}=${value}`);
-        }
-        else {
-            // Append new
-            if (envContent.length > 0 && !envContent.endsWith('\n')) {
-                envContent += '\n';
-            }
-            envContent += `${key}=${value}\n`;
-        }
-        index_1.Helpers.writeFile(dotFileAbsPath, envContent);
-        index_1.Helpers.info(`[${lib_1.config.frameworkName}-helpers] Updated ${lib_2.path.basename(dotFileAbsPath)}: ${key}=${value}`);
-        //#endregion
-    };
-    //#endregion
-    //#region set comment to key in dot file
-    UtilsDotFile.setCommentToKeyInDotFile = (dotFileAbsPath, key, comment) => {
-        //#region @backendFunc
-        dotFileAbsPath = (0, lib_2.crossPlatformPath)(dotFileAbsPath);
-        let envContent = '';
-        if (lib_2.fse.existsSync(dotFileAbsPath)) {
-            envContent = index_1.Helpers.readFile(dotFileAbsPath, '');
-        }
-        else {
-            index_1.Helpers.writeFile(dotFileAbsPath, '');
-            index_1.Helpers.logInfo(`[${lib_1.config.frameworkName}-helpers] Created ${lib_2.path.basename(dotFileAbsPath)}`);
-            envContent = '';
-        }
-        // Regex: match line starting with "KEY=" and capture value part
-        const regex = new RegExp(`^(${key}=[^#\\n]*)(?:#.*)?$`, 'm');
-        if (regex.test(envContent)) {
-            // Replace existing comment (strip old, append new)
-            envContent = envContent.replace(regex, `$1 # ${comment}`);
-        }
-        else {
-            // Append as new entry with empty value but with comment
-            if (envContent.length > 0 && !envContent.endsWith('\n')) {
-                envContent += '\n';
-            }
-            envContent += `${key}= # ${comment}\n`;
-        }
-        index_1.Helpers.writeFile(dotFileAbsPath, envContent);
-        index_1.Helpers.info(`[${lib_1.config.frameworkName}-helpers] Updated comment for ${key} in ${lib_2.path.basename(dotFileAbsPath)}`);
-        //#endregion
-    };
-    //#endregion
-    //#region get value from dot file
-    UtilsDotFile.getValueFromDotFile = (dotFileAbsPath, key) => {
-        //#region @backendFunc
-        dotFileAbsPath = (0, lib_2.crossPlatformPath)(dotFileAbsPath);
-        if (!lib_2.fse.existsSync(dotFileAbsPath)) {
-            index_1.Helpers.warn(`[${lib_1.config.frameworkName}-helpers] File ${lib_2.path.basename(dotFileAbsPath)} does not exist.`);
-            return;
-        }
-        const envContent = lib_2.fse.readFileSync(dotFileAbsPath, 'utf-8');
-        // Parse line by line
-        const lines = envContent.split(/\r?\n/);
-        for (const line of lines) {
-            const trimmed = line.trim();
-            if (!trimmed || trimmed.startsWith('#'))
-                continue;
-            const [k, ...rest] = trimmed.split('=');
-            if (k === key) {
-                return parseValue(rest.join('='));
-            }
-        }
-        //#endregion
-    };
-    //#endregion
-    //#region set values keys from object
-    UtilsDotFile.setValuesKeysFromObject = (dotFileAbsPath, obj, options) => {
-        //#region @backendFunc
-        dotFileAbsPath = (0, lib_2.crossPlatformPath)(dotFileAbsPath);
-        options = options || {};
-        let envContent = options.setAsNewFile
-            ? ''
-            : index_1.Helpers.readFile(dotFileAbsPath, '');
-        for (const [key, value] of Object.entries(obj)) {
-            const stringValue = String(value);
-            const regex = new RegExp(`^${key}=.*$`, 'm');
-            if (regex.test(envContent)) {
-                envContent = envContent.replace(regex, `${key}=${stringValue}`);
-            }
-            else {
-                if (envContent.length > 0 && !envContent.endsWith('\n')) {
-                    envContent += '\n';
-                }
-                envContent += `${key}=${stringValue}\n`;
-            }
-        }
-        index_1.Helpers.writeFile(dotFileAbsPath, envContent);
-        //#endregion
-    };
-    //#endregion
-    //#region get values keys as json object
-    UtilsDotFile.getValuesKeysAsJsonObject = (dotFileAbsPath) => {
-        //#region @backendFunc
-        dotFileAbsPath = (0, lib_2.crossPlatformPath)(dotFileAbsPath);
-        if (!index_1.Helpers.exists(dotFileAbsPath)) {
-            return {};
-        }
-        const envContent = index_1.Helpers.readFile(dotFileAbsPath, '');
-        const result = {};
-        const lines = envContent.split(/\r?\n/);
-        for (const line of lines) {
-            const trimmed = line.trim();
-            if (!trimmed || trimmed.startsWith('#'))
-                continue;
-            const [key, ...rest] = trimmed.split('=');
-            if (key) {
-                result[key] = parseValue(rest.join('='));
-            }
-        }
-        return result;
-        //#endregion
-    };
-    //#endregion
-    //#region get comments keys as json object
-    /**
-     * @returns key|comment pairs as json object
-     */
-    UtilsDotFile.getCommentsKeysAsJsonObject = (dotFileAbsPath) => {
-        //#region @backendFunc
-        dotFileAbsPath = (0, lib_2.crossPlatformPath)(dotFileAbsPath);
-        if (!index_1.Helpers.exists(dotFileAbsPath)) {
-            return {};
-        }
-        const envContent = index_1.Helpers.readFile(dotFileAbsPath, '');
-        const result = {};
-        const lines = envContent.split(/\r?\n/);
-        const extractInlineComment = (valuePart) => {
-            // Find the first unquoted `#`
-            let inSingle = false;
-            let inDouble = false;
-            let escaped = false;
-            for (let i = 0; i < valuePart.length; i++) {
-                const ch = valuePart[i];
-                if (escaped) {
-                    escaped = false;
-                    continue;
-                }
-                if (ch === '\\') {
-                    escaped = true;
-                    continue;
-                }
-                if (!inDouble && ch === "'") {
-                    inSingle = !inSingle;
-                    continue;
-                }
-                if (!inSingle && ch === '"') {
-                    inDouble = !inDouble;
-                    continue;
-                }
-                if (!inSingle && !inDouble && ch === '#') {
-                    // Everything after '#' is the comment
-                    const raw = valuePart.slice(i + 1);
-                    const comment = raw.replace(/^\s+/, ''); // trim only leading spaces after '#'
-                    return comment.length ? comment : '';
-                }
-            }
-            return undefined;
-        };
-        for (const line of lines) {
-            const raw = line;
-            const trimmed = raw.trim();
-            // Skip empty or full-line comments
-            if (!trimmed || trimmed.startsWith('#'))
-                continue;
-            // Support optional leading `export `
-            const withoutExport = trimmed.startsWith('export ')
-                ? trimmed.slice('export '.length).trim()
-                : trimmed;
-            const eqIdx = withoutExport.indexOf('=');
-            if (eqIdx === -1)
-                continue;
-            const key = withoutExport.slice(0, eqIdx).trim();
-            if (!key)
-                continue;
-            const valuePart = withoutExport.slice(eqIdx + 1);
-            result[key] = extractInlineComment(valuePart);
-        }
-        return result;
-        //#endregion
-    };
-    //#endregion
-})(UtilsDotFile || (exports.UtilsDotFile = UtilsDotFile = {}));
-//#endregion
 //#region utils zip browser
 var UtilsZipBrowser;
 (function (UtilsZipBrowser) {
@@ -1638,20 +1419,20 @@ var UtilsZip;
      */
     UtilsZip.zipDir = async (absPathToDir, options) => {
         //#region @backendFunc
-        const zipPath = `${absPathToDir}.zip`;
-        const destinationFileName = (0, lib_2.crossPlatformPath)([
+        const zipPath = `${lib_2.path.basename(absPathToDir)}.zip`;
+        const destinationFilePath = (0, lib_2.crossPlatformPath)([
             lib_2.path.dirname(absPathToDir),
             zipPath,
         ]);
         if (options.overrideIfZipFileExists) {
             try {
-                index_1.Helpers.removeFileIfExists(destinationFileName);
+                index_1.Helpers.removeFileIfExists(destinationFilePath);
             }
             catch (error) { }
         }
-        if (index_1.Helpers.exists(destinationFileName)) {
-            index_1.Helpers.info(`[${lib_1.config.frameworkName}-helpers] Zip file already exists: ${destinationFileName}`);
-            return destinationFileName;
+        if (index_1.Helpers.exists(destinationFilePath)) {
+            index_1.Helpers.info(`[${lib_1.config.frameworkName}-helpers] Zip file already exists: ${destinationFilePath}`);
+            return destinationFilePath;
         }
         const yazl = await Promise.resolve().then(() => require('yazl')); // Use default import for yazl
         const pipeline = (await Promise.resolve().then(() => require('stream/promises'))).pipeline;
@@ -1671,8 +1452,8 @@ var UtilsZip;
         };
         await addDirectoryToZip(absPathToDir, absPathToDir);
         zipfile.end();
-        await pipeline(zipfile.outputStream, lib_2.fse.createWriteStream(zipPath));
-        return destinationFileName;
+        await pipeline(zipfile.outputStream, lib_2.fse.createWriteStream(destinationFilePath));
+        return destinationFilePath;
         //#endregion;
     };
     // Unzip: `/some/path/folder.zip` → `/some/path/folder`
@@ -2111,4 +1892,118 @@ var UtilsPasswords;
     // })();
 })(UtilsPasswords || (exports.UtilsPasswords = UtilsPasswords = {}));
 //#endregion
+//#region utils filepath metadata
+var FilePathMetaData;
+(function (FilePathMetaData) {
+    const TERMINATOR = 'xxxxx'; // terminates metadata block
+    const KV_SEPARATOR = '...'; // key/value separator
+    const PAIR_SEPARATOR = 'IxIxI'; // between pairs
+    //#region embed data into filename
+    /**
+     * Embed metadata into filename while preserving the extension.
+     *
+     * Example:
+     * embedData({ version: "1.2.3", envName: "__" }, "project.zip")
+     * -> "version|-|1.2.3||--||envName|-|__|||project.zip"
+     */
+    function embedData(data, orgFilename, options) {
+        options = options || {};
+        const ext = lib_2.path.extname(orgFilename);
+        const base = lib_2.path.basename(orgFilename, ext);
+        const meta = Object.entries(data)
+            .map(([key, value]) => `${key}${KV_SEPARATOR}${value ?? ''}`)
+            .join(PAIR_SEPARATOR);
+        return `${meta}${TERMINATOR}${options.skipAddingBasenameAtEnd ? '' : base}${ext}`;
+    }
+    FilePathMetaData.embedData = embedData;
+    //#endregion
+    //#region extract data from filename
+    /**
+     * Extract metadata from filename (reverse of embedData).
+     *
+     * Example:
+     * extractData<{ version: string; env: string }>("myfile__version-1.2.3__env-prod.zip")
+     * -> { version: "1.2.3", env: "prod" }
+     */
+    function extractData(filename) {
+        const ext = lib_2.path.extname(filename);
+        const thereIsNoExt = ext.includes('|') || ext.includes('-');
+        const base = thereIsNoExt ? filename : lib_2.path.basename(filename, ext);
+        // Everything BEFORE the FIRST TERMINATOR
+        const idx = base.lastIndexOf(TERMINATOR);
+        const metaPart = idx >= 0 ? base.substring(0, idx) : base;
+        const data = {};
+        let cursor = 0;
+        while (cursor <= metaPart.length) {
+            const sepIdx = metaPart.indexOf(PAIR_SEPARATOR, cursor);
+            const segment = sepIdx === -1
+                ? metaPart.substring(cursor)
+                : metaPart.substring(cursor, sepIdx);
+            if (segment) {
+                const kvIdx = segment.indexOf(KV_SEPARATOR);
+                if (kvIdx > -1) {
+                    const key = segment.substring(0, kvIdx);
+                    const value = segment.substring(kvIdx + KV_SEPARATOR.length);
+                    data[key] = value;
+                }
+            }
+            if (sepIdx === -1)
+                break;
+            cursor = sepIdx + PAIR_SEPARATOR.length;
+        }
+        return data;
+    }
+    FilePathMetaData.extractData = extractData;
+    //#endregion
+    //#region get only metadata string
+    FilePathMetaData.getOnlyMetadataString = (filename) => {
+        const ext = lib_2.path.extname(filename);
+        const base = lib_2.path.basename(filename, ext);
+        const idx = base.lastIndexOf(TERMINATOR);
+        if (idx === -1)
+            return ''; // no terminator
+        const metaPart = base.substring(0, idx);
+        if (!metaPart.trim())
+            return ''; // empty metadata
+        return metaPart;
+    };
+    //#endregion
+})(FilePathMetaData || (exports.FilePathMetaData = FilePathMetaData = {}));
+//#endregion
+//#region utils cli
+/**
+ * Easy way to connect CLI commands to cli class methods.
+ *
+ * Example:
+ * in clic class
+ * $FirstCli {
+ *
+ *   @UtilsCliMethod.decorator('doSomething')
+ *   doSomething() {
+ *     console.log('doing something');
+ *   }
+ * }
+ *
+ * UtilsCliMethod.getFrom($FirstCli.prototype.doSomething) // "firstcli:dosomething"
+ *
+ */
+var UtilsCliMethod;
+(function (UtilsCliMethod) {
+    const CLI_METHOD_KEY = Symbol('cliMethod');
+    UtilsCliMethod.decorator = (methodName) => {
+        return (target, propertyKey, descriptor) => {
+            // If name not given, fallback to property key
+            Reflect.defineMetadata(CLI_METHOD_KEY, `${lib_3._.camelCase(lib_4.CLASS.getName(target?.constructor)).toLowerCase()}` +
+                `:${lib_3._.camelCase(methodName ?? propertyKey).toLowerCase()}`, descriptor.value);
+        };
+    };
+    UtilsCliMethod.getFrom = (ClassPrototypeMethodFnHere, globalMethod = false) => {
+        const fullCliMethodName = Reflect.getMetadata(CLI_METHOD_KEY, ClassPrototypeMethodFnHere);
+        if (globalMethod) {
+            return fullCliMethodName.split(':')[1];
+        }
+        return fullCliMethodName;
+    };
+})(UtilsCliMethod || (exports.UtilsCliMethod = UtilsCliMethod = {}));
+//#endregion
 //# sourceMappingURL=utils.js.map