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

package/gen/gen-api-docs-v1.js

@@ -1,125 +0,0 @@
-const fs = require("fs");
-const open = require("open");
-const jsdom = require("jsdom");
-const { JSDOM } = jsdom;
-const common = require("../common.js");
-
-function processGenDocs(aliasProject, entities, source, html, args, projectName, alias) {
-    console.log('Received html');
-    console.log("Parsing html");
-
-    const roles = aliasProject.allowRoles.includes("*") ? source.roles : source.roles?.filter(r => aliasProject.allowRoles.includes(r.name));
-    
-    html = html.replace(/^\uFEFF/, '');
-    html = html.replace(/<script src="([^"]+)" data-mt-cond='\{"lazy-load": 1\}'><\/script>/g, (scriptTag, src) => `<script data-mt-cond='{"x": 1}'>${fs.readFileSync(__dirname + "/../docs/" + src).toString()}</script>`);
-    html = html.replace("</body>", `<script data-mt-cond='{"x": 1}'>
-    window.data.name = ${JSON.stringify(source.name)};
-    window.data.description = ${JSON.stringify(source.description)};
-    window.data.rootUrl = ${JSON.stringify(common.getRootUrl(source))};
-    window.data.environmentVariables = ${JSON.stringify(source.environmentVariables)};
-    window.data.roles = ${JSON.stringify(roles)};
-    window.data.entities = ${JSON.stringify(entities)};
-    window.data.features = ${JSON.stringify(aliasProject.features)};
-    try {
-        console.info("MUSHROOM-CLI: START");
-        window.generateDocument();
-        console.info("MUSHROOM-CLI: FINISH");
-    }
-    catch (e) {
-        console.info("MUSHROOM-CLI: FAIL", e);
-    }
-    window.close();
-</script></body>`);
-
-    return new Promise((resolve, reject) => {
-        const virtualConsole = new jsdom.VirtualConsole();
-        virtualConsole.on("info", function(msg, err) {
-            if (typeof msg != "string") return;
-
-            if (msg.indexOf("MUSHROOM-CLI:") === 0) {
-                console.log("GenDocEngine:" + msg.substring("MUSHROOM-CLI:".length));
-            }
-
-            if (msg === "MUSHROOM-CLI: FAIL"){
-                dom = null;
-                reject(err);
-                return;
-            }
-
-            if (msg !== "MUSHROOM-CLI: FINISH") return;
-
-            const code = "<!DOCTYPE html>" + dom.window.document.documentElement.outerHTML;
-
-            dom = null;
-
-            if (args[3] === "tmp") {
-                const htmlFilePath = aliasProject.output + "_tmp.html";
-                console.log(`Writing to ${htmlFilePath}`);
-                fs.writeFile(htmlFilePath, code, err => {
-                    if (err) {
-                        reject(err);
-                        return;
-                    }
-
-                    console.log("Opening file " + htmlFilePath);
-                    open(htmlFilePath).then(() => { 
-                        setTimeout(() => {
-                            fs.unlink(htmlFilePath, ex => {
-                                if (ex)
-                                    console.error("Unable to delete file " + htmlFilePath)
-                            });
-                        }, 1000);
-                    }).catch(() => console.error("Unable to open " + htmlFilePath));
-                    resolve();
-                });
-                return;
-            }
-        
-            common.ensureFolder(aliasProject.output);
-        
-            console.log(`Writing to ${aliasProject.output}`);
-            fs.writeFile(aliasProject.output, code, err => {
-                if (err) {
-                    reject(err);
-                    return;
-                }
-                console.log(`Generated API docs for ${projectName}@${alias} to ${aliasProject.output}`);
-                resolve();
-            });
-        });
-
-        let dom = new JSDOM(html, { 
-            runScripts: "dangerously",
-            resources: "usable",
-            virtualConsole: virtualConsole
-        });
-        console.log('Rendering API document');
-    });
-}
-
-async function genDocs(args, projectName, project, alias, source) {
-    const aliasProject = ((project.docs || {}).alias || {})[alias];
-
-    if (!aliasProject) {
-        throw new Error(`Not found gen docs configuration. Please run 'npx mushroom-cli config ${projectName} gen docs OUTPUT_FILE.html${alias === "default" ? "" : " alias " + alias}' first`);
-    }
-
-    console.log("Use GenDocEngine v1");
-
-    const entities = common.getEntities(source, aliasProject.allowRoles);
-
-    if (Array.isArray(aliasProject.entities)) {
-        for (const entityName in entities) {
-            if (Object.hasOwnProperty.call(entities, entityName)) {
-                if (aliasProject.entities.every(re => !new RegExp(re).test(entityName))){
-                    delete entities[entityName];
-                }
-            }
-        }
-    }
-
-    const html = fs.readFileSync(__dirname + "/../docs/docs.html").toString();
-    await processGenDocs(aliasProject, entities, source, html, args, projectName, alias);
-}
-
-module.exports = genDocs;

package/gen/gen-api-docs.js

@@ -1,298 +0,0 @@
-const fs = require("fs");
-const open = require("open");
-const common = require("../common.js");
-const minify = require("minify");
-const path = require("path");
-
-function reserveWhitelist(obj, whitelist) {
-    if (obj === null && typeof obj !== "object") return null;
-    for (let m in obj) {
-        if (!whitelist.includes(m)) delete obj[m];
-    }
-    return obj;
-}
-
-const environmentVariableWhitelist = ["type", "description"];
-function filterEnvironmentVariables(environmentVariables) {
-    Object.values(environmentVariables).forEach(env => reserveWhitelist(env, environmentVariableWhitelist));
-}
-
-const entityWhitelist = ["name", "description", "actions", "views", "features", "fields"];
-const actionWhitelist = ["grant", "deny", "matches", "description", "exclude"];
-const findByIdWhitelist = [ ...actionWhitelist, "returnableFields", "defaultFields"];
-const findManyWhitelist = [ ...findByIdWhitelist, "allowFilteringFields", "requiredFilteringFields", "allowSortings", "defaultSortings", "pagingType", "maxPageSize", "pageSize", "includeTotal", "cache"];
-const generalWhitelist = [ ...actionWhitelist, "codeHint" ];
-const entityFeatureWhitelist = ["vn_text"];
-const vnTextWhitelist = ["fields", "channels"];
-const vnTextChannelWhitelist = ["fields", "name"];
-const actionCodeHintWhitelist = ["delegator"];
-const actionCodeHintDelegatorWhitelist = ["param", "requestBody"];
-const fieldsOnlyWhitelist = ["fields"];
-const viewWhitelist = [ "grant", "deny", "description", "parameters", "emptyResult", "codeHint"]
-const viewCodeHintWhitelist = ["output"];
-
-function filterEntities(entities) {
-    Object.values(entities).forEach(entity => {
-        filterEntityFields(entity);
-        if (!reserveWhitelist(entity, entityWhitelist)) return;
-        Object.keys(entity.actions).forEach(actionName => {
-            const actions = entity.actions[actionName];            
-            switch (actionName) {
-                case "findMany":
-                    actions.forEach(action => reserveWhitelist(action, findManyWhitelist));
-                    break;
-                case "findById":
-                    actions.forEach(action => reserveWhitelist(action, findByIdWhitelist));
-                    break;
-                case "createOne":
-                case "createMany":
-                case "updateOne":
-                case "updateMany":
-                case "updatePartially":
-                case "deleteOne":
-                case "deleteMany":
-                    actions.forEach(action => reserveWhitelist(action, actionWhitelist));
-                    break;
-                default:
-                    actions.forEach(action => {
-                        reserveWhitelist(action, generalWhitelist);
-                        if (!reserveWhitelist(action.codeHint, actionCodeHintWhitelist)) return;
-                        if (!reserveWhitelist(action.codeHint.delegator, actionCodeHintDelegatorWhitelist)) return;
-                        reserveWhitelist(action.codeHint.delegator.param, fieldsOnlyWhitelist)
-                        reserveWhitelist(action.codeHint.delegator.requestBody, fieldsOnlyWhitelist)
-                    });
-                    break;
-            }
-
-        });
-        Object.keys(entity.views).forEach(viewName => {
-            const views = entity.views[viewName];
-            views.forEach(view => {
-                reserveWhitelist(view, viewWhitelist);
-                if (!reserveWhitelist(view.codeHint, viewCodeHintWhitelist)) return;
-                reserveWhitelist(view.codeHint.output, fieldsOnlyWhitelist)
-            });
-        })
-        if (!reserveWhitelist(entity.features, entityFeatureWhitelist)) return;
-        if (!reserveWhitelist(entity.features.vn_text, vnTextWhitelist)) return;
-        entity.features.vn_text.channels?.forEach(channel => reserveWhitelist(channel, vnTextChannelWhitelist));
-    });
-}
-
-function flattenFields(fields, dict, prefix) {
-    dict ??= {};
-    prefix ??= "";
-
-    for (let m in fields) {
-        const path = prefix ? prefix + "." + m : m;
-        dict[path] = false;
-        const config = fields[m];
-        if (config.type == "object") {
-            flattenFields(config.fields ?? {}, dict, path);
-        }
-        else if (config.type == "array" && config.items && config.items.type == "object") {
-            flattenFields(config.items.fields ?? {}, dict, path);
-        }
-    }
-    
-    return dict;
-}
-
-function removeDisallowedFields(fields, dict) {
-    const allowFields = Object.keys(dict);
-    if (!allowFields.length) return;
-    reserveWhitelist(fields, allowFields);
-    for (let m in fields) {
-        const config = fields[m];
-        if (config.type == "object") {
-            removeDisallowedFields(config.fields ?? {}, dict[m]);
-        }
-        else if (config.type == "array" && config.items && config.items.type == "object") {
-            removeDisallowedFields(config.items.fields ?? {}, dict[m]);
-        }
-    }
-}
-
-function markAllowFields(allowFields, dict) {
-    if (!Array.isArray(allowFields)) return;
-    allowFields.forEach(field => dict[field] = true);
-}
-
-function markIncludedFields(excludedFields, dict) {
-    if (!Array.isArray(excludedFields)) return;
-    for (let m in dict) {
-        if (!dict[m] && !excludedFields.includes(m)) dict[m] = true;
-    }
-}
-
-function filterEntityFields(entity) {
-    const dict = flattenFields(entity.fields);
-    Object.keys(entity.actions).forEach(actionName => {
-        const actions = entity.actions[actionName];            
-        switch (actionName) {
-            case "findMany":
-            case "findById":
-                actions.forEach(action => {
-                    markAllowFields(action.returnableFields, dict);
-                    markAllowFields(action.defaultFields, dict);
-                });
-                break;
-            case "createOne":
-            case "createMany":
-            case "updateOne":
-            case "updateMany":
-            case "updatePartially":
-                actions.forEach(action => markIncludedFields(action.exclude, dict));
-                break;
-        }
-    });
-    const allowFields = Object.keys(dict).filter(m => dict[m]);
-    [...allowFields].forEach(shortField => {
-        shortField += ".";
-        allowFields.map((longerField, i) => longerField.includes(shortField) ? i : -1)
-            .filter(i => i !== -1)
-            .reverse()
-            .forEach(i => allowFields.splice(i, 1));
-    });
-    const whitelist = { };
-    allowFields.forEach(fields => {
-        let obj = whitelist;
-        fields.split('.').forEach(name => {
-            let child = obj[name];
-            if (!child) child = obj[name] = {};
-            obj = child;
-        })
-    })
-    Object.keys(entity.actions).forEach(actionName => {
-        const actions = entity.actions[actionName];            
-        switch (actionName) {
-            case "createOne":
-            case "createMany":
-            case "updateOne":
-            case "updateMany":
-            case "updatePartially":
-                actions.forEach(action => action.exclude = action.exclude?.filter(field => allowFields.includes(field)));
-                break;
-        }
-    });
-    removeDisallowedFields(entity.fields, whitelist);
-}
-
-async function writeDocs(filePath, strTemplate, strData) {
-    //const placeholder = "/*INJECT-JAVASCRIPT-HERE*/";
-    /*const idx = strTemplate.indexOf(placeholder);
-    fs.writeFileSync(filePath, strTemplate.substr(0, idx)); 
-    fs.appendFileSync(filePath, "window.docs = ");
-    fs.appendFileSync(filePath, strData);
-    fs.appendFileSync(filePath, ";\n");
-    fs.appendFileSync(filePath, await minify(path.join(__dirname, "../docs/docs.v2.js"), {
-        js: {
-            compress: true
-        }
-    }));
-    fs.appendFileSync(filePath, strTemplate.substr(idx + placeholder.length));*/
-
-    const placeholder = '<script id="INJECT-JAVASCRIPT-HERE"></script>';
-    const idx = strTemplate.indexOf(placeholder);
-    fs.writeFileSync(filePath, strTemplate.substr(0, idx)); 
-    fs.appendFileSync(filePath, "<script>window.docs = ");
-    fs.appendFileSync(filePath, strData);
-    fs.appendFileSync(filePath, ";\n");
-    fs.appendFileSync(filePath, fs.readFileSync(path.join(__dirname, "../docs/docs.v2.js")));
-    fs.appendFileSync(filePath, "</script>");
-    fs.appendFileSync(filePath, strTemplate.substr(idx + placeholder.length));
-
-    fs.writeFileSync(filePath, await minify(filePath, {
-        "html": {
-            "removeComments": true,
-            "removeCommentsFromCDATA": true,
-            "removeCDATASectionsFromCDATA": true,
-            "collapseWhitespace": true,
-            "collapseBooleanAttributes": true,
-            "removeAttributeQuotes": true,
-            "removeRedundantAttributes": true,
-            "useShortDoctype": true,
-            "removeEmptyAttributes": true,
-            "removeEmptyElements": false,
-            "removeOptionalTags": true,
-            "removeScriptTypeAttributes": false,
-            "removeStyleLinkTypeAttributes": true,
-            "minifyJS": true,
-            "minifyCSS": true
-        }
-    }));
-}
-
-async function genDocs(args, projectName, project, alias, source) {
-    const aliasProject = ((project.docs || {}).alias || {})[alias];
-
-    if (!aliasProject) {
-        throw new Error(`Not found gen docs configuration. Please run 'npx mushroom-cli config ${projectName} gen docs OUTPUT_FILE.html${alias === "default" ? "" : " alias " + alias}' first`);
-    }
-
-    console.log("Use GenDocEngine v1.2");
-
-    const entities = common.getEntities(source, aliasProject.allowRoles);
-
-    if (Array.isArray(aliasProject.entities)) {
-        for (const entityName in entities) {
-            if (Object.hasOwnProperty.call(entities, entityName)) {
-                if (aliasProject.entities.every(re => !new RegExp(re).test(entityName))){
-                    delete entities[entityName];
-                }
-            }
-        }
-    }
-
-    filterEnvironmentVariables(source.environmentVariables);
-    filterEntities(entities);
-
-    const data = JSON.stringify({
-        info: {
-            name: source.name,
-            rootUrl: source.codeHint?.rootUrl ?? source.rootUrl,
-            description: source.description,
-            security: source.security === undefined ? undefined : {
-                crossDomain: source.security.crossDomain,
-                allowOrigins: source.security.allowOrigins
-            }
-        },
-        features: aliasProject.features,
-        roles: common.filterRoles(source.roles ?? [], aliasProject.allowRoles),
-        environmentVariables: source.environmentVariables,
-        entities: entities
-    });
-    // fs.writeFileSync(__dirname + "/../docs/sample.json", data);
-
-    const html = fs.readFileSync(__dirname + "/../docs/docs.v2.html").toString();    
-
-    if (args[3] === "tmp") {
-        const htmlFilePath = aliasProject.output + "_tmp.html";
-        console.log(`Writing to ${htmlFilePath}`);
-        await writeDocs(htmlFilePath, html, data);
-
-        console.log("Opening file " + htmlFilePath);
-        try {
-            await open(htmlFilePath);
-
-            setTimeout(() => {
-                fs.unlink(htmlFilePath, ex => {
-                    if (ex)
-                        console.error("Unable to delete file " + htmlFilePath)
-                });
-            }, 1000);
-        } catch(_) {
-            console.error("Unable to open " + htmlFilePath)
-        }
-        
-        return;
-    }
-
-    common.ensureFolder(aliasProject.output);
-
-    console.log(`Writing to ${aliasProject.output}`);
-    await writeDocs(aliasProject.output, html, data);
-    console.log(`Generated API docs for ${projectName}@${alias} to ${aliasProject.output}`)
-}
-
-module.exports = genDocs;

package/init/init-json.js

@@ -1,106 +0,0 @@
-const fs = require("fs");
-const fetch = require('node-fetch');
-const readlineSync = require("readline-sync");
-const help = require("../help.js");
-const common = require("../common.js");
-
-function initJson(args) {
-    const path = args[2];
-    if (!path) {
-        help(args);
-        return;
-    }
-
-    if (fs.existsSync(path)){
-        console.error(`File ${path} is already existed`);
-        return;
-    }
-
-    if (args[3] === "silent") {
-        console.log("Fetch http://api.siten.vn/gen/template/default.json");
-        fetch("http://api.siten.vn/gen/template/default.json").then(res => res.text()).then(text => {
-            common.ensureFolder(path);
-    
-            fs.writeFile(path, text, err => {
-                if (err)
-                    throw err;
-                console.log(`Initialized json at ${path}`);
-            });
-        });
-        return;
-    }
-
-    console.log("Fetch http://api.siten.vn/gen/template/template-def.json");
-    fetch("http://api.siten.vn/gen/template/template-def.json").then(res => res.json()).then(templateConfig => {
-        const info = {};
-        templateConfig.fields.forEach(field => {
-            while (true)
-            {
-                let question = `${field.required ? "[Required] " : ""}${field.label || field.name}`;
-                if (Array.isArray(field.list)) {
-                    question += "\n";
-                    let i = 1;
-                    field.list.forEach(item => { question += "\t" + i++ + ". " + item + "\n"; });
-                    question += "Please choose";
-                }
-                if (field.defaultValue !== undefined) {
-                    question += ` (default: '${field.defaultValue}')`;
-                }
-                question += ": ";
-                let choice = readlineSync.question(question);
-                if (choice === "") {
-                    if (field.defaultValue != undefined)
-                        choice = field.defaultValue;
-                }
-                else if (Array.isArray(field.list)) {
-                    if (choice !== null && choice !== "" && !isNaN(choice))
-                        choice = field.list[choice - 1];
-                    else
-                        choice = undefined;
-                    if (choice === undefined) {
-                        console.warn("Invalid input");
-                        continue;
-                    }
-                }
-
-                if (choice === "" || choice === undefined || choice == null) {
-                    choice = "";
-
-                    if (field.required) {
-                        console.warn("Required input value");
-                        continue;
-                    }
-                }
-
-                if (choice !== "" && field.pattern) {
-                    const re = new RegExp(field.pattern, field.patternFlags);
-                    if (!re.test(choice)) {
-                        console.warn("Input doesn't match with pattern " + field.pattern);
-                        continue;
-                    }
-                }
-
-                info[field.name] = choice;
-                break;
-            }
-        });
-        //console.log(info);
-
-        console.log(`Fetch ${templateConfig.templateUrl}`);
-        fetch(templateConfig.templateUrl).then(res => res.text()).then(json => {
-            json = json.replace(/\"\$\{([\w]+)\}\"/g, (s0, s1) => JSON.stringify(info[s1]));
-            json = json.replace(/\$\{([\w]+)\}/g, (s0, s1) => JSON.stringify(info[s1]).replace(/^\"|\"$/g, ""));
-
-            common.ensureFolder(path);
-            //console.log(json);
-    
-            fs.writeFile(path, json, err => {
-                if (err)
-                    throw err;
-                console.log(`Initialized json at ${path}`);
-            });
-        });
-    })
-}
-
-module.exports = initJson;

package/init/init-netcore.js

@@ -1,32 +0,0 @@
-const fs = require("fs");
-const { spawn } = require("child_process");
-const common = require("../common.js");
-
-
-function fetchFromGit() {
-    return new Promise((resolve, reject) => {
-        const git = spawn("git", ["clone", "https://tfs.siten.vn/tfs/Siten/CodeBase/_git/Mushroom", "-b", "full_extensions", "--single-branch"]);
-        git.stdout.on('data', (data) => {
-            console.log(`GIT: ${data}`);
-        });
-        
-        git.stderr.on('data', (data) => {
-            console.error(`GIT: ${data}`);
-        });
-        
-        git.on('close', (code) => {
-            if (code) {
-                reject(new Error(`GIT exited with code ${code}`));
-                return;
-            }
-            resolve();
-        });
-    })
-}
-
-async function initNetCore(args) {
-    await fetchFromGit();
-    common.processTemplate("Mushroom", "mushroom-template.json");
-}
-
-module.exports = initNetCore;

package/init.js

@@ -1,28 +0,0 @@
-const help = require("./help.js");
-
-const initJson = require("./init/init-json");
-const initNetCore = require("./init/init-netcore");
-
-async function init(args) {
-    const configCommand = args[1];
-    switch(configCommand) {
-        case "json":
-            initJson(args);
-            break;
-        case "netcore":
-            await initNetCore(args);
-            break;
-        case "":
-        case undefined:
-        case "help":
-        case "man":
-            help("init");
-            break;
-        default:
-            help(args, true);
-            break;
-    }
-
-}
-
-module.exports = init;