cob-cli 2.39.9 → 2.40.0

package/bin/cob-cli.js

@@ -12,6 +12,7 @@ const test             = require("../lib/commands/test");
 const deploy           = require("../lib/commands/deploy");
 const updateFromServer = require("../lib/commands/updateFromServer");
 const getDefs          = require("../lib/commands/getDefs");
+const generateMermaid  = require("../lib/commands/generateMermaid");
 const { upgradeRepo }  = require("../lib/commands/upgradeRepo");
 
 /*******************************************/
@@ -85,4 +86,14 @@ program
     .description('Updates local copy with definitions on server')
     .action( getDefs );
     
-program.parse(process.argv);
+program
+    .command('generateMermaid')
+    .option('-e --environment <name>', 'environment to use')
+    .option('-s --server <name>', 'server to use (ignores -e)')
+    .option('-f --filter <regexp>', 'regexp used to filter against names & descriptions')
+    .option('-l --labels <lang>', 'add labels in the given language. Available options are "en", "pt" or "es"')
+    .option('-d --debug', 'send debug info to stderr')
+    .description('Generates mermaid diagram from Definitions')
+    .action( generateMermaid );
+    
+program.parse(process.argv);

package/lib/commands/generateMermaid.js

@@ -0,0 +1,168 @@
+const { getCurrentCommandEnviroment } = require("../task_lists/common_enviromentHandler");
+const { checkRepoVersion } = require("../commands/upgradeRepo");
+const fs = require('fs');
+const fg = require('fast-glob');
+const path = require('path')
+const axios = require('axios');
+const FileCookieStore = require('file-cookie-store');
+
+async function generateMermaid(args) {
+    try {
+        checkRepoVersion()
+        const cmdEnv = await getCurrentCommandEnviroment(args)
+
+        if(args.debug) console.error(`Generating mermaid` );
+        const defs = args.server
+            ? await readDefsFromServer(args.server, args.filter, args.debug)
+            : await readDefsFromDisk(`recordm/definitions/${cmdEnv.name}`, args.filter, args.debug);
+
+        console.log('erDiagram');
+        let refs = [];
+        let references = [];
+        for(const def of defs){
+            refs.push(...getRefs(def.name, def.fieldDefinitions, args.debug));
+            references.push(...getReferences(def.name, def.fieldDefinitions, args.debug));
+        }
+        refs = uniqBy(refs, r => r.one + ":" + r.many)
+        references = uniqBy(references, r => r.one + ":" + r.many)
+        if(args.debug) console.error(
+            'refs: ', refs,
+            'references: ', references
+        )
+
+        const tables = new Set();
+        for(const ref of refs){
+            tables.add(ref.one);
+            tables.add(ref.many);
+        }
+
+        // Output table defs
+        for(const table of tables){
+            const id = toMermaidId(table)
+            if (id != table) { console.debug(`\t${id}["${table}"]{}`) }
+        }
+        console.debug("")
+        // Output relations
+        for (const ref of refs) {
+            const one = toMermaidId(ref.one);
+            const many = toMermaidId(ref.many);
+            const left = '|o';
+            const right = (ref.required ? '|' : 'o') + '{';
+            const msgType = references.some(r => r.one === ref.one && r.many === ref.many) ? "hasMany" : "isOf"
+            let msg = "";
+            switch (args.label) {
+                case "en":
+                    msg = msgType == "hasMany" ? `${ref.one} have many ${ref.many}` : `_${ref.fieldName}_ is one of ${ref.one}`;
+                    break;
+                case "pt":
+                    msg = msgType == "hasMany" ? `${ref.one} têm ${ref.many}` : `_${ref.fieldName}_ refere um registo de ${ref.one}`;
+                    break;
+                case "es":
+                    msg = msgType == "hasMany" ? `${ref.one} tienen ${ref.many}` : `_${ref.fieldName}_ se refiere a un registro de ${ref.one}`;
+                    break;
+            }
+
+            console.debug(`\t${one} ${left}..${right} ${many}: " ${msg}"`)
+        }
+
+    } catch(err) {
+        console.error("\n",err.message);
+    }
+}
+module.exports = generateMermaid;
+
+async function readDefsFromDisk(dir, filter, debug) {
+    if(debug) console.error(`Reading Definitions from ${dir}`);
+    const defFiles = await fg([`${dir}/*.json`]);
+    return defFiles
+        .map((f) => JSON.parse(fs.readFileSync(f)))
+        .filter(def => {
+            return !filter || def.name.match(filter) || def.description?.match(filter)
+        })
+}
+
+async function readDefsFromServer(server, filter, debug) {
+    if(debug) console.error(`Reading Definitions from server ${server}`);
+
+    const p = path.resolve(require('os').homedir(), '.cob-cookie');
+    const cookieFile = new FileCookieStore(p, {auto_sync: false});
+    const cobtoken = await readCobtoken(cookieFile, server);
+
+    // get Defs
+    let defs = (await axios.get(`https://${server}/recordm/recordm/definitions`,{
+        headers: {
+            Accept: "application/json",
+            Cookie: cobtoken
+        }
+    })).data
+    if(debug) console.error('found a total of ', defs.length, 'Defs');
+    // filter
+    if(filter) defs = defs.filter(def => {
+        return def.name.match(filter) || def.description?.match(filter)
+    })
+    if(debug) console.error('filtered to ', defs.length, 'Defs');
+    return await Promise.all(defs.map(async (def) => {
+        return (await axios.get(`https://${server}/recordm/recordm/definitions/${def.id}`,{
+            headers: {
+                Accept: "application/json",
+                Cookie: cobtoken
+            }
+        })).data
+    }))
+}
+
+function readCobtoken(cookies, server){
+    return new Promise((resolve, reject) => {
+        cookies.findCookie(server, '/', 'cobtoken', (err, result) => {
+            if(err != null) reject(err);
+            else resolve(result);
+        } )
+    })
+}
+
+function getRefs(defName, fieldDefs, debug) {
+    return fieldDefs.reduce((acc, fd) => {
+        if (fd.configuration.keys.Reference && !fd.configuration.keys.AutoRefField) {
+            // if(debug) console.error('using fieldDefinition', fd) 
+            acc.push({
+                one: fd.configuration.keys.Reference.args.definition,
+                many: defName,
+                fieldName: fd.name,
+                required: !!fd.required,
+                duplicable: !!fd.duplicable
+            });
+        }
+        if (fd.fields) acc.push(...getRefs(defName, fd.fields));
+        return acc;
+    }, [])
+}
+
+function getReferences(defName, fieldDefs, debug) {
+    return fieldDefs.reduce((acc, fd) => {
+        if (fd.configuration.keys.References) {
+            // if(debug) console.error('using fieldDefinition', fd.name, fd.configuration.keys.References) 
+            acc.push({
+                one: defName,
+                many: fd.configuration.keys.References.args.definition,
+                duplicable: true
+            });
+        }
+        if (fd.fields) acc.push(...getReferences(defName, fd.fields));
+        return acc;
+    }, [])
+}
+
+function toMermaidId(name) {
+    return name.normalize("NFD")
+        .replace(/\p{Diacritic}/gu, "")
+        .replace(/\./g, "_")
+        .replace(/ /g, "_");
+}
+
+function uniqBy(a, key) {
+    const seen = new Set();
+    return a.filter(item => {
+        const k = key(item);
+        return seen.has(k) ? false : seen.add(k);
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cob-cli",
-  "version": "2.39.9",
+  "version": "2.40.0",
   "description": "A command line utility to help Cult of Bits partners develop with higher speed and reusing common code and best practices.",
   "preferGlobal": true,
   "repository": {
@@ -18,12 +18,14 @@
   "dependencies": {
     "@webpack-cli/serve": "^2.0.1",
     "axios": "^0.21.1",
+    "chokidar": "^3.5.3",
     "cmd-line-importer": "^1.0.0",
     "colors": "^1.4.0",
     "commander": "^5.1.0",
     "concurrently": "^5.3.0",
     "execa": "^4.0.3",
     "fast-glob": "^3.2.5",
+    "file-cookie-store": "^0.2.1",
     "fs-extra": "^9.0.1",
     "inquirer": "^7.3.3",
     "listr": "^0.14.3",
@@ -34,8 +36,7 @@
     "webpack": "^5.75.0",
     "webpack-cli": "^5.0.1",
     "webpack-dev-server": "^4.11.1",
-    "xdg-basedir": "^5.1.0",
-    "chokidar": "^3.5.3"
+    "xdg-basedir": "^5.1.0"
   },
   "keywords": [],
   "author": "mimes70",