mushroom-cli 1.2.0-alpha.10 → 1.2.0-alpha.12

package/{gen → dist/gen}/gen-db-docs.js

@@ -1,222 +1,204 @@
-const fs = require("fs");
-const open = require("open");
-const common = require("../common.js");
-
-function encodeHtml(str) {
-    if (str === null || str === undefined)
-        return "";
-    if (typeof str !== "string")
-        str = str.toString();
-    var html = str.replace(/&/g, "&");
-    html = html.replace(/</g, "&lt;");
-    html = html.replace(/>/g, "&gt;");
-    html = html.replace(/"/g, "&quot;");
-    html = html.replace(/'/g, "&apos;");
-    return html;
-}
-
-function getConstrains(valField) {
-    const constraints = [];
-
-    if (valField.reference)
-        constraints.push(`Ref to <a href="#${valField.reference}">${encodeHtml(valField.reference)}</a>`);
-
-    if (valField.validation) {
-        if (valField.validation.required)
-            constraints.push("Not null");
-        if (valField.validation.validValues && valField.validation.validValues.length)
-            constraints.push(`Enum: ${valField.validation.validValues.map(encodeHtml).join(", ")}`);
-        if (valField.validation.invalidValues && valField.validation.invalidValues.length)
-            constraints.push(`Invalid values: ${valField.validation.invalidValues.map(encodeHtml).join(", ")}`);
-        if (valField.validation.length !== undefined)
-            constraints.push(`Length: ${valField.validation.length}`);
-        if (valField.validation.minLength !== undefined)
-            constraints.push(`Min length: ${valField.validation.minLength}`);
-        if (valField.validation.maxLength !== undefined)
-            constraints.push(`Max length: ${valField.validation.maxLength}`);
-        if (valField.validation.gt !== undefined)
-            constraints.push(`GT: ${encodeHtml(valField.validation.gt)}`);
-        if (valField.validation.lt !== undefined)
-            constraints.push(`LT: ${encodeHtml(valField.validation.lt)}`);
-        if (valField.validation.min !== undefined)
-            constraints.push(`Min: ${encodeHtml(valField.validation.min)}`);
-        if (valField.validation.max !== undefined)
-            constraints.push(`Max: ${encodeHtml(valField.validation.max)}`);
-        if (valField.validation.pattern)
-            constraints.push(`Pattern: ${encodeHtml(valField.validation.pattern)}`);
-    }
-
-    if (valField.defaultValue)
-        constraints.push(`Default (${encodeHtml(valField.defaultValue)})`);
-
-    return constraints.join("<br/>");
-}
-
-function getMongoTableDocs(valTable) {
-    let str = `
-        <table border="1" cellspacing="0" cellpadding="8" width="100%" bordercolor="#999">
-            <tr>
-                <th style="width: 1.75in">Column</th>
-                <th style="width: 1in">DataType</th>
-                <th style="width: 2in">Constraints</th>
-                <th>Description</th>
-            </tr>`;
-    for (let keyField in valTable) {
-        const valField = valTable[keyField];
-        const isObject = valField.type === "object" ||  valField.type === "array" && valField.items.type === "object";
-        const isArray = valField.type === "array";
-
-        if (isObject) {
-            str += `
-            <tr>
-                <td valign="top" rowspan="2">${keyField}</td>
-                <td valign="top">${isArray ? "array of " : ""}object</td>
-                <td valign="top">${getConstrains(isArray ? valField.items : valField)}</td>
-                <td valign="top" style="word-break: break-word">${encodeHtml(valField.description)}</td>
-            </tr>
-            <tr>
-                <td colspan="3">${getMongoTableDocs(isArray ? valField.items.fields : valField.fields)}</td>
-            </tr>`;
-        }
-        else {
-            str += `
-            <tr>
-                <td valign="top">${keyField}</td>
-                <td valign="top">${isArray ? "array of " + valField.items.type : valField.type}</td>
-                <td valign="top">${getConstrains(valField)}${isArray ? "<hr/>Array items:<br/>" + getConstrains(valField.items) : ""}</td>
-                <td valign="top" style="word-break: break-word">${encodeHtml(valField.description)}</td>
-            </tr>`;
-        }
-    }
-    str += `</table>`;
-    return str;
-}
-
-function getMongoDbDocs(entities, source) {
-    let htmlStr = "";
-    let toc = "";
-    for (let keyTable in entities) {
-        const valTable = entities[keyTable];
-        const des = encodeHtml(valTable.description);
-        htmlStr += `
-                    <h2 id="${keyTable}">${keyTable}</h2>
-                    <div>${des}</div>
-                    ${getMongoTableDocs(valTable.fields)}
-                    <br>`;
-        toc += `<li><a href="#${keyTable}">${keyTable}</a> <span class="des">- ${des}</span></li>`;
-    }
-    
-    return `
-<!DOCTYPE html>
-<html>
-<head>
-    <meta charset=utf-8>
-    <style>
-        * {box-sizing: border-box}
-        html, body {margin: 0 0; padding: 0 0; font-family: Calibri, 'helvetica neue', Arial, serifs}
-        h2{background-color: #ccc;margin: 30px -20px 0;padding: 5px 10px;}
-        hr{border-width: 0; border-top: 1px solid #ccc;}
-        table {border-collapse: collapse;margin-top: 5px;}
-        th{background-color: #d7d7d7}
-        a{color: #000; text-decoration: none}
-        a:hover{color: blue; text-decoration: underline}
-
-        .nav{position: fixed; top: 0; left: 0; bottom: 0; width: 200px; z-index: 100; overflow: auto;border-right: 1px solid #bbb;background-color: #eee}
-        ul#nav-toc{padding: 0;margin: 0}
-        ul#nav-toc li{list-style: none;padding: 0;margin: 0;}
-        ul#nav-toc a{display: block;padding: 5px 10px;}
-        ul#nav-toc a:hover{background-color: #aaa; color: #fff; text-decoration: none}
-        ul#nav-toc .des{display: none}
-
-        :target {
-            -webkit-animation: target-fade 2s 1;
-            -moz-animation: target-fade 2s 1;
-        }
-        
-        @-webkit-keyframes target-fade {
-            0% { background-color: #ff0; }
-            100% { background-color: #ccc; }
-        }
-        @-moz-keyframes target-fade {
-            0% { background-color: #ff0; }
-            100% { background-color: #ccc; }
-        }
-        
-        body{padding-left: 200px}
-        .paper{padding: 0 20px}
-
-        ul#main-toc a{font-weight: bold}
-
-        @media print {
-            body{padding-left: 0}
-            .nav{display: none}
-        }
-        @media only screen and (max-width: 768px) {
-            body{padding-left: 0}
-            .nav{display: none}
-        }
-    </style>
-<head>
-<body>
-    <div class="nav">
-        <ul id="nav-toc">${toc}</ul>
-    </div>
-    <div class="paper">
-        <h1 style="text-align: center">Đặc tả Cơ sở dữ liệu</h1>
-        Hệ quản trị cơ sở dữ liệu: <b>${source.db}</b>
-        <ul id="main-toc">${toc}</ul>
-        ${htmlStr}
-    </div>
-</body>
-</html>`;
-}
-
-function genDatabaseDocs(args, projectName, project, alias, source) {
-    const aliasProject = ((project.dbDocs || {}).alias || {})[alias];
-
-    if (!aliasProject) {
-        throw new Error(`Not found gen db-docs configuration. Please run 'npx mushroom-cli config ${projectName} gen db-docs OUTPUT_FILE.html${alias === "default" ? "" : " alias " + alias}' first`);
-    }
-
-    const entities = common.getEntities(source, aliasProject.allowRoles, true);
-
-    let code;
-    switch (source.db) {
-        case "MongoDB":
-            code = getMongoDbDocs(entities, source);
-            break;
-        //case "SqlServer":
-        //    break;
-        case undefined:
-        case null:
-        case "":
-            throw new Error(`Missing db configuration in ${aliasProject.output}`);
-        default:
-            throw new Error(`Unsupported gen db-docs for '${source.db}'`);
-    }
-
-    if (args[3] === "tmp") {
-        const htmlFilePath = aliasProject.output + "_tmp.html";
-        fs.writeFile(htmlFilePath, code, err => {
-            if (err)
-                throw err;
-            open(htmlFilePath).then(() => { 
-                setTimeout(() => {
-                    fs.unlink(htmlFilePath, ex => {
-                        if (ex)
-                            console.error(ex);
-                    });
-                }, 2000);
-            }).catch(err => {console.error(err);});
-        });
-        
-        return;
-    }
-
-    common.ensureFolder(aliasProject.output);
-
-    fs.writeFileSync(aliasProject.output, code);
-    console.log(`Generated Database docs for ${projectName}@${alias} to ${aliasProject.output}`);
-}
-
-module.exports = genDatabaseDocs;
+import fs from 'fs';
+import open from 'open';
+import * as common from '../common.js';
+function encodeHtml(str) {
+    if (str === null || str === undefined)
+        return '';
+    const s = typeof str !== 'string' ? str.toString() : str;
+    let html = s.replace(/&/g, '&amp;');
+    html = html.replace(/</g, '&lt;');
+    html = html.replace(/>/g, '&gt;');
+    html = html.replace(/"/g, '&quot;');
+    html = html.replace(/'/g, '&apos;');
+    return html;
+}
+function getConstrains(valField) {
+    if (!valField)
+        return '';
+    const constraints = [];
+    if (valField.reference)
+        constraints.push(`Ref to <a href="#${valField.reference}">${encodeHtml(valField.reference)}</a>`);
+    if (valField.validation) {
+        if (valField.validation.required)
+            constraints.push('Not null');
+        if (valField.validation.validValues && valField.validation.validValues.length)
+            constraints.push(`Enum: ${valField.validation.validValues.map(encodeHtml).join(', ')}`);
+        if (valField.validation.invalidValues && valField.validation.invalidValues.length)
+            constraints.push(`Invalid values: ${valField.validation.invalidValues.map(encodeHtml).join(', ')}`);
+        if (valField.validation.length !== undefined)
+            constraints.push(`Length: ${valField.validation.length}`);
+        if (valField.validation.minLength !== undefined)
+            constraints.push(`Min length: ${valField.validation.minLength}`);
+        if (valField.validation.maxLength !== undefined)
+            constraints.push(`Max length: ${valField.validation.maxLength}`);
+        if (valField.validation.gt !== undefined)
+            constraints.push(`GT: ${encodeHtml(valField.validation.gt)}`);
+        if (valField.validation.lt !== undefined)
+            constraints.push(`LT: ${encodeHtml(valField.validation.lt)}`);
+        if (valField.validation.min !== undefined)
+            constraints.push(`Min: ${encodeHtml(valField.validation.min)}`);
+        if (valField.validation.max !== undefined)
+            constraints.push(`Max: ${encodeHtml(valField.validation.max)}`);
+        if (valField.validation.pattern)
+            constraints.push(`Pattern: ${encodeHtml(valField.validation.pattern)}`);
+    }
+    if (valField.defaultValue)
+        constraints.push(`Default (${encodeHtml(valField.defaultValue)})`);
+    return constraints.join('<br/>');
+}
+function getMongoTableDocs(valTable) {
+    let str = `
+        <table border="1" cellspacing="0" cellpadding="8" width="100%" bordercolor="#999">
+            <tr>
+                <th style="width: 1.75in">Column</th>
+                <th style="width: 1in">DataType</th>
+                <th style="width: 2in">Constraints</th>
+                <th>Description</th>
+            </tr>`;
+    for (const keyField in valTable) {
+        const valField = valTable[keyField];
+        const isObject = valField.type === 'object' || (valField.type === 'array' && valField.items?.type === 'object');
+        const isArray = valField.type === 'array';
+        if (isObject) {
+            str += `
+            <tr>
+                <td valign="top" rowspan="2">${keyField}</td>
+                <td valign="top">${isArray ? 'array of ' : ''}object</td>
+                <td valign="top">${getConstrains(isArray ? valField.items : valField)}</td>
+                <td valign="top" style="word-break: break-word">${encodeHtml(valField.description)}</td>
+            </tr>
+            <tr>
+                <td colspan="3">${getMongoTableDocs((isArray ? valField.items?.fields : valField.fields) ?? {})}</td>
+            </tr>`;
+        }
+        else {
+            str += `
+            <tr>
+                <td valign="top">${keyField}</td>
+                <td valign="top">${isArray ? 'array of ' + valField.items?.type : valField.type}</td>
+                <td valign="top">${getConstrains(valField)}${isArray ? '<hr/>Array items:<br/>' + getConstrains(valField.items) : ''}</td>
+                <td valign="top" style="word-break: break-word">${encodeHtml(valField.description)}</td>
+            </tr>`;
+        }
+    }
+    str += `</table>`;
+    return str;
+}
+function getMongoDbDocs(entities, source) {
+    let htmlStr = '';
+    let toc = '';
+    for (const keyTable in entities) {
+        const valTable = entities[keyTable];
+        const des = encodeHtml(valTable.description);
+        htmlStr += `
+                    <h2 id="${keyTable}">${keyTable}</h2>
+                    <div>${des}</div>
+                    ${getMongoTableDocs(valTable.fields)}
+                    <br>`;
+        toc += `<li><a href="#${keyTable}">${keyTable}</a> <span class="des">- ${des}</span></li>`;
+    }
+    return `
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset=utf-8>
+    <style>
+        * {box-sizing: border-box}
+        html, body {margin: 0 0; padding: 0 0; font-family: Calibri, 'helvetica neue', Arial, serifs}
+        h2{background-color: #ccc;margin: 30px -20px 0;padding: 5px 10px;}
+        hr{border-width: 0; border-top: 1px solid #ccc;}
+        table {border-collapse: collapse;margin-top: 5px;}
+        th{background-color: #d7d7d7}
+        a{color: #000; text-decoration: none}
+        a:hover{color: blue; text-decoration: underline}
+
+        .nav{position: fixed; top: 0; left: 0; bottom: 0; width: 200px; z-index: 100; overflow: auto;border-right: 1px solid #bbb;background-color: #eee}
+        ul#nav-toc{padding: 0;margin: 0}
+        ul#nav-toc li{list-style: none;padding: 0;margin: 0;}
+        ul#nav-toc a{display: block;padding: 5px 10px;}
+        ul#nav-toc a:hover{background-color: #aaa; color: #fff; text-decoration: none}
+        ul#nav-toc .des{display: none}
+
+        :target {
+            -webkit-animation: target-fade 2s 1;
+            -moz-animation: target-fade 2s 1;
+        }
+        
+        @-webkit-keyframes target-fade {
+            0% { background-color: #ff0; }
+            100% { background-color: #ccc; }
+        }
+        @-moz-keyframes target-fade {
+            0% { background-color: #ff0; }
+            100% { background-color: #ccc; }
+        }
+        
+        body{padding-left: 200px}
+        .paper{padding: 0 20px}
+
+        ul#main-toc a{font-weight: bold}
+
+        @media print {
+            body{padding-left: 0}
+            .nav{display: none}
+        }
+        @media only screen and (max-width: 768px) {
+            body{padding-left: 0}
+            .nav{display: none}
+        }
+    </style>
+<head>
+<body>
+    <div class="nav">
+        <ul id="nav-toc">${toc}</ul>
+    </div>
+    <div class="paper">
+        <h1 style="text-align: center">Đặc tả Cơ sở dữ liệu</h1>
+        Hệ quản trị cơ sở dữ liệu: <b>${source.db}</b>
+        <ul id="main-toc">${toc}</ul>
+        ${htmlStr}
+    </div>
+</body>
+</html>`;
+}
+export default function genDatabaseDocs(args, projectName, project, alias, source) {
+    const aliasProject = ((project.dbDocs || {}).alias || {})[alias];
+    if (!aliasProject) {
+        throw new Error(`Not found gen db-docs configuration. Please run 'npx mushroom-cli config ${projectName} gen db-docs OUTPUT_FILE.html${alias === 'default' ? '' : ' alias ' + alias}' first`);
+    }
+    const entities = common.getEntities(source, aliasProject.allowRoles, true);
+    let code;
+    switch (source.db) {
+        case 'MongoDB':
+            code = getMongoDbDocs(entities, source);
+            break;
+        case undefined:
+        case null:
+            throw new Error(`Missing db configuration in ${aliasProject.output}`);
+        default:
+            throw new Error(`Unsupported gen db-docs for '${source.db}'`);
+    }
+    if (args[3] === 'tmp') {
+        const htmlFilePath = aliasProject.output + '_tmp.html';
+        fs.writeFile(htmlFilePath, code, (err) => {
+            if (err)
+                throw err;
+            open(htmlFilePath)
+                .then(() => {
+                setTimeout(() => {
+                    fs.unlink(htmlFilePath, (ex) => {
+                        if (ex)
+                            common.logError(ex);
+                    });
+                }, 2000);
+            })
+                .catch((err) => {
+                common.logError(err);
+            });
+        });
+        return;
+    }
+    common.ensureFolder(aliasProject.output);
+    fs.writeFileSync(aliasProject.output, code);
+    common.logInfo(`Generated Database docs for ${projectName}@${alias} to ${aliasProject.output}`);
+}

package/{gen → dist/gen}/gen-js-driver-tarball.js

@@ -1,101 +1,81 @@
-const fs = require("fs");
-const path = require('path');
-var targz = require('targz');
-const javascriptDriverGenerator = require("./gen-js-driver");
-const typescriptDriverGenerator = require("./gen-ts-driver");
-const package = require("./../package.json");
-
-function compressAsync(src, dest, folderName) {
-    return new Promise((resolve, reject) => {
-        const options = {
-            src: src,
-            dest: dest
-        };
-        if (folderName) {
-            options.tar = {
-                map: (header) => {
-                    if (header.name === ".") return header;
-                    header.name = folderName + '/' + header.name;
-                    return header;
-                }
-            };
-        }
-
-        targz.compress(options, function(err){
-            if(err) {
-                reject(err);
-                return;
-            }
-            resolve();
-        });
-    });
-}
-
-async function genJavascriptDriverTarball(args, projectName, project, alias, source) {
-    const aliasProject = ((project.jsDriver || {}).alias || {})[alias];
-
-    let tarballName = aliasProject.tarballName ? aliasProject.tarballName : projectName;
-    tarballName = tarballName.toLowerCase().replace(/[^a-z-]/g, "-");
-
-    const dirPath = path.join(path.dirname(aliasProject.output), tarballName);
-
-    const versionGroup = package.version.match(/([^-]+)(-(\w+).*)?/);
-    const currentDistTag = versionGroup[3] ? versionGroup[3] : "latest";
-
-    const dependencies = [`"mushroomjs": "${currentDistTag}"`];
-    if (Array.isArray(aliasProject.features) && aliasProject.features.includes("auth")) {
-        dependencies.push(`"mushroomjs-auth": "${currentDistTag}"`);
-    }
-    if (Array.isArray(aliasProject.features) && aliasProject.features.includes("file")) {
-        dependencies.push(`"mushroomjs-file": "${currentDistTag}"`);
-    }
-    
-    const packageContent = `{
-    "version": "1.0.${new Date().getTime()}",
-    "name": "${tarballName}",
-    "private": true,
-    "main": "${tarballName}.js",
-    "types": "${tarballName}.d.ts",
-    "dependencies": {
-        ${dependencies.join(',\n        ')}
-    }
-}`;
-
-    if (fs.existsSync(dirPath)) {
-        console.log("Clean up tarball folder");
-        // fs.rmdirSync(dirPath, { recursive: true });
-        fs.rmSync(dirPath, { recursive: true });
-    }
-
-    const tarballFileName = path.join(path.dirname(aliasProject.output), tarballName + ".tar.gz");
-
-    if (fs.existsSync(tarballFileName)) {
-        console.log("Clean up old tarball file");
-        fs.unlinkSync(tarballFileName);
-    }
-
-    console.log("Creating tarball folder");
-
-    fs.mkdirSync(dirPath, { recursive: true, mode: 0755 });
-
-    console.log("Generating main file: " + tarballName + ".js");
-    let code = javascriptDriverGenerator.genJavascriptDriverString(aliasProject, source);
-    fs.writeFileSync(path.join(dirPath, tarballName + ".js"), code);
-    
-    console.log("Generating types file: " + tarballName + ".d.ts");
-    code = typescriptDriverGenerator.genDtsString(aliasProject, source);
-    fs.writeFileSync(path.join(dirPath, tarballName + ".d.ts"), code);
-
-    console.log("Generating package file: package.json");
-    fs.writeFileSync(path.join(dirPath, "package.json"), packageContent);
-   
-    console.log("Generating tarball file: " + tarballFileName);
-    await compressAsync(dirPath, tarballFileName, tarballName);
-
-    console.log("Generated tarball file");
-    // fs.rmdirSync(dirPath, { recursive: true });
-    fs.rmSync(dirPath, { recursive: true });
-    console.log("Cleaned up tarball folder");
-}
-
-module.exports = genJavascriptDriverTarball;
+import fs from 'fs';
+import path from 'path';
+import targz from 'targz';
+import * as common from '../common.js';
+import * as javascriptDriverGenerator from './gen-js-driver.js';
+import * as typescriptDriverGenerator from './gen-ts-driver.js';
+import packageJson from '../../package.json' assert { type: 'json' };
+function compressAsync(src, dest, folderName) {
+    return new Promise((resolve, reject) => {
+        const options = {
+            src: src,
+            dest: dest,
+        };
+        if (folderName) {
+            options.tar = {
+                map: (header) => {
+                    if (header.name === '.')
+                        return header;
+                    header.name = folderName + '/' + header.name;
+                    return header;
+                },
+            };
+        }
+        targz.compress(options, function (err) {
+            if (err) {
+                reject(err);
+                return;
+            }
+            resolve();
+        });
+    });
+}
+export default async function genJavascriptDriverTarball(args, projectName, project, alias, source) {
+    const aliasProject = ((project.jsDriver || {}).alias || {})[alias];
+    let tarballName = aliasProject.tarballName ? aliasProject.tarballName : projectName;
+    tarballName = tarballName.toLowerCase().replace(/[^a-z-]/g, '-');
+    const dirPath = path.join(path.dirname(aliasProject.output), tarballName);
+    const versionGroup = packageJson.version.match(/([^-]+)(-(\w+).*)?/);
+    const currentDistTag = versionGroup?.[3] ? versionGroup[3] : 'latest';
+    const dependencies = [`"mushroomjs": "${currentDistTag}"`];
+    if (Array.isArray(aliasProject.features) && aliasProject.features.includes('auth')) {
+        dependencies.push(`"mushroomjs-auth": "${currentDistTag}"`);
+    }
+    if (Array.isArray(aliasProject.features) && aliasProject.features.includes('file')) {
+        dependencies.push(`"mushroomjs-file": "${currentDistTag}"`);
+    }
+    const packageContent = `{
+    "version": "1.0.${new Date().getTime()}",
+    "name": "${tarballName}",
+    "private": true,
+    "main": "${tarballName}.js",
+    "types": "${tarballName}.d.ts",
+    "dependencies": {
+        ${dependencies.join(',\n        ')}
+    }
+}`;
+    if (fs.existsSync(dirPath)) {
+        common.logInfo('Clean up tarball folder');
+        fs.rmSync(dirPath, { recursive: true });
+    }
+    const tarballFileName = path.join(path.dirname(aliasProject.output), tarballName + '.tar.gz');
+    if (fs.existsSync(tarballFileName)) {
+        common.logInfo('Clean up old tarball file');
+        fs.unlinkSync(tarballFileName);
+    }
+    common.logInfo('Creating tarball folder');
+    fs.mkdirSync(dirPath, { recursive: true, mode: 0o755 });
+    common.logInfo('Generating main file:', tarballName + '.js');
+    let code = javascriptDriverGenerator.genJavascriptDriverString(aliasProject, source);
+    fs.writeFileSync(path.join(dirPath, tarballName + '.js'), code);
+    common.logInfo('Generating types file:', tarballName + '.d.ts');
+    code = typescriptDriverGenerator.genDtsString(aliasProject, source);
+    fs.writeFileSync(path.join(dirPath, tarballName + '.d.ts'), code);
+    common.logInfo('Generating package file: package.json');
+    fs.writeFileSync(path.join(dirPath, 'package.json'), packageContent);
+    common.logInfo('Generating tarball file:', tarballFileName);
+    await compressAsync(dirPath, tarballFileName, tarballName);
+    common.logInfo('Generated tarball file');
+    fs.rmSync(dirPath, { recursive: true });
+    common.logInfo('Cleaned up tarball folder');
+}