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

package/README.md

@@ -4,89 +4,217 @@
 
 Init a mushroom json file
 
-    npx mushroom-cli init json ./api/SampleProject.json [silent]
+```bash
+npx mushroom-cli init json ./api/SampleProject.json [silent]
+```
 
 Init a DotNet Core project which pre-install Mushroom Server
 
-    npx mushroom-cli init netcore [projectName]
+```bash
+npx mushroom-cli init netcore [projectName]
+```
 
 ## Configure
 
 Add the mushroom json file into mushroom-config.json
 
-    npx mushroom-cli config add ./api/yourProjectName.json
+```bash
+npx mushroom-cli config add ./api/yourProjectName.json
+```
 
 Config gen docs api
 
-    npx mushroom-cli config gen projectName docs ./wwwroot/docs.html [alias aliasName] [features file,auth,mail,driver] [roles Admin,User-Contributor]
+```bash
+npx mushroom-cli config gen projectName docs ./wwwroot/docs.html [alias aliasName] [features file,auth,mail,driver] [roles Admin,User-Contributor]
+```
 
 Config gen database docs
 
-    npx mushroom-cli config gen projectName db-docs ./wwwroot/db-docs.html [alias aliasName] [features file,auth,mail]
+```bash
+npx mushroom-cli config gen projectName "db-docs" ./wwwroot/db-docs.html [alias aliasName] [features file,auth,mail]
+```
 
 Config gen javascript driver
 
-    npx mushroom-cli config gen projectName js-driver ./src/api/mushroom.api.js [alias aliasName] [roles Admin,User-Contributor] [tarball tarballName]
+```bash
+npx mushroom-cli config gen projectName "js-driver" ./src/api/mushroom.api.js [alias aliasName] [roles Admin,User-Contributor] [tarball tarballName]
+```
 
 Config gen typescript driver
 
-    npx mushroom-cli config gen projectName ts-driver ./src/api/mushroom.api.ts [alias aliasName] [roles Admin,User-Contributor]
+```bash
+npx mushroom-cli config gen projectName "ts-driver" ./src/api/mushroom.api.ts [alias aliasName] [roles Admin,User-Contributor]
+```
 
 Config gen entities for Mushroom project in CSharp and using MongoDb
 
-    npx mushroom-cli config gen projectName c#-mongo ./API/Generated.cs [alias aliasName]
+```bash
+npx mushroom-cli config gen projectName "c#-mongo" ./API/Generated.cs [alias aliasName]
+```
 
 Config gen entities for CSharp project which calls Mushroom API
 
-    npx mushroom-cli config gen projectName c#-driver ./API/Generated.cs [roles Admin,User-Contributor] [alias aliasName] [access-modifier public] [features file,auth,mail]
+```bash
+npx mushroom-cli config gen projectName "c#-driver" ./API/Generated.cs [roles Admin,User-Contributor] [alias aliasName] [access-modifier public] [features file,auth,mail]
+```
 
 ## Genarate
 
 Generate docs api (html format)
 
-    npx mushroom-cli gen projectName[@aliasName] docs [tmp]
+```bash
+npx mushroom-cli gen projectName[@aliasName] docs [v1] [tmp]
+```
 
 Generate database docs (html format)
 
-    npx mushroom-cli gen projectName[@aliasName] db-docs [tmp]
+```bash
+npx mushroom-cli gen projectName[@aliasName] "db-docs" [tmp]
+```
 
 Generate npm package (tarball file)
 
-    npx mushroom-cli gen projectName[@aliasName] js-driver-tarball
+```bash
+npx mushroom-cli gen projectName[@aliasName] "js-driver-tarball"
+```
 
 Generate javascript driver
 
-    npx mushroom-cli gen projectName[@aliasName] js-driver
+```bash
+npx mushroom-cli gen projectName[@aliasName] "js-driver"
+```
 
 Generate typescript driver
 
-    npx mushroom-cli gen projectName[@aliasName] ts-driver
+```bash
+npx mushroom-cli gen projectName[@aliasName] "ts-driver"
+```
 
 Generate entities for Mushroom project in CSharp and using MongoDb
 
-    npx mushroom-cli gen projectName[@aliasName] c#-mongo
+```bash
+npx mushroom-cli gen projectName[@aliasName] "c#-mongo"
+```
 
 Generate entities for CSharp project which calls Mushroom API
 
-    npx mushroom-cli gen projectName[@aliasName] c#-driver
+```bash
+npx mushroom-cli gen projectName[@aliasName] "c#-driver"
+```
+
+## Merge
+
+```bash
+npx mushroom-cli merge output-path.json
+```
 
 ## Update
 
-Update ts code
+Update ts code (configuration was stored in mushroom-config.json file)
+
+```bash
+npx mushroom-cli update "ts-code"
+```
 
-    npx mushroom-cli update ts-code [file-path.ts] [remote-ts-code-url]
+Update ts code (simple call)
+
+```bash
+npx mushroom-cli update "ts-code" file-path.ts remote-ts-code-url
+```
 
 ## Other
 
 Disable checking for update:
 
-    npx mushroom-cli parameters --no-check-update
+```bash
+npx mushroom-cli parameters --no-check-update
+```
 
 ## Version
 
+### 1.2.0-alpha.11
+
+Improvement:
+
+* gen-docs:
+  * allow user add and change API root url
+  * filter role list
+  * fornat cURL to easy to copy and paste to Postman
+  * lighten font on MacOS
+* gen-ts:
+  * export type for object fields
+
+### 1.2.0-alpha.10
+
+Improvement:
+
+* gen-docs: add default-value information of fields
+
+### 1.2.0-alpha.9
+
+Improvement:
+
+* gen-docs
+  * v1.2: minify, fix bug (some fields are not excluded)
+
+### 1.2.0-alpha.8
+
+Improvement:
+
+* gen-docs
+  * v1.2: deal with very big api docs
+  * v1: prerender all docs html (need more RAM, less performance)
+
+### 1.2.0-alpha.7
+
+New features:
+
+* init netcore: Support some new set-functions: `ToLowerCase`, `ToUpperCase`, `Trim`, `Replace`
+
+Changes:
+
+* init netcore: Operating fail if unknown command or set-function found
+
+### 1.2.0-alpha.6
+
+New features:
+
+* gen-ts-driver: Support offline mode
+
+Changes:
+
+* gen-api-docs: Improve generating api-docs
+* gen-csharp: Generate resource classes with `partial`
+
+### 1.2.0-alpha.5
+
+New features:
+
+* Improve documentation generation: view, custom action.
+
+### 1.2.0-alpha.4
+
+Fixed bugs:
+
+* Generate api docs: doesn't exclude fields of object in an array
+
+### 1.2.0-alpha.3
+
+Fixed bugs:
+
+* Generate wrong required field for view parameter
+
+### 1.2.0-alpha.2
+
+New features:
+
+* Support merge command
+
 ### 1.2.0-alpha.1
 
-Support type for View result
+New features:
+
+* Support type for View result
 
 ### 1.1.0
 

package/common.js

@@ -12,7 +12,7 @@ function ensureFolder(path, isFolder) {
         return;
 
     if (!fs.existsSync(path)) {
-        fs.mkdirSync(path, { recursive: true, mode: 0755 });
+        fs.mkdirSync(path, { recursive: true, mode: 0o755 });
     }
 }
 
@@ -49,7 +49,7 @@ function getEntities(projectApiConfiguration, roles, getAll) {
                 if (!action.grant || !action.enabled || action.codeHint && action.codeHint.disabled)
                     return;
 
-                var allow = roles.indexOf("*") !== -1 || action.grant === "*";
+                var allow = roles.includes("*") || action.grant === "*";
 
                 if (!allow)
                     action.grant.split("|").forEach(function (roleGroup) {
@@ -66,6 +66,7 @@ function getEntities(projectApiConfiguration, roles, getAll) {
                 
                 if (!(entity.name in entities))
                     entities[entity.name] = {
+                        name: entity.name,
                         description: entity.description,
                         storageName: entity.storageName ? entity.storageName : entity.name,
                         fields: entity.fields,
@@ -105,6 +106,7 @@ function getEntities(projectApiConfiguration, roles, getAll) {
 
                 if (!(entity.name in entities))
                     entities[entity.name] = {
+                        name: entity.name,
                         description: entity.description,
                         storageName: entity.storageName ? entity.storageName : entity.name,
                         fields: entity.fields,
@@ -127,6 +129,15 @@ function getEntities(projectApiConfiguration, roles, getAll) {
     return entities;
 }
 
+function filterRoles(roleList, allowRoleList) {
+    const roles = !allowRoleList || allowRoleList.includes("*") ? [...roleList] : roleList.filter(role => allowRoleList.includes(role.name));
+    roles.push({
+        name: "[Mọi người dùng]",
+        description: "Tất cả người dùng (kể cả chưa đăng nhập)"
+    });
+    return roles;
+}
+
 function processTemplate(basePath, templatePath) {
     const templateJsonContent = fs.readFileSync(path.join(basePath, templatePath)).toString();
     const template = JSON.parse(templateJsonContent);
@@ -160,6 +171,8 @@ function processCommand(command, basePath, variables) {
         case "replace":
             processReplaceCommand(command, basePath, variables);
             return;
+        default:
+            throw new Error(`Unknown command: ${command.command}`);
     }
 }
 
@@ -181,9 +194,24 @@ function processSetCommand(command, variables) {
         case "New-GUID":
             processSetGuidCommand(command.variable, variables);
             break;
+        case "ToLowerCase":
+            toLowerCommand(command.variable, variables, command.input);
+            break;
+        case "ToUpperCase":
+            toUpperCaseCommand(command.variable, variables, command.input);
+            break;
+        case "Trim":
+            trimCommand(command.variable, variables, command.input);
+            break;
+        case "Replace":
+            replaceCommand(command.variable, variables, command.input, command.replacement, command.pattern, command.mode);
+            break;
+        default:
+            throw new Error(`Unknown set-command: ${command["function"]}`);
     }
 }
 
+//#region set-commands
 function processSetGuidCommand(variable, variables) {
     variables[variable] = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, c => {
         var r = Math.random() * 16 | 0, v = c == 'x' ? r : (r & 0x3 | 0x8);
@@ -191,6 +219,24 @@ function processSetGuidCommand(variable, variables) {
     }).toUpperCase();
 }
 
+function toLowerCommand(variable, variables, input) {
+    variables[variable] = (variables[input] || "").toLowerCase();
+}
+
+function toUpperCaseCommand(variable, variables, input) {
+    variables[variable] = (variables[input] || "").toUpperCase();
+}
+
+function trimCommand(variable, variables, input) {
+    variables[variable] = (variables[input] || "").trim();
+}
+
+function replaceCommand(variable, variables, input, replacement, pattern, mode) {
+    var regex = new RegExp(pattern, mode);
+    variables[variable] = (variables[input] || "").replace(regex, replacement === undefined || replacement === null ? "" : replacement);
+}
+//#endregion
+
 function processRenameCommand(command, basePath, variables) {
     const input = replaceVariables(command.input, variables);
     const output = replaceVariables(command.output, variables);
@@ -232,5 +278,6 @@ module.exports = {
     ensureFolder: ensureFolder,
     getRootUrl: getRootUrl,
     getEntities: getEntities,
+    filterRoles:filterRoles,
     processTemplate: processTemplate
 };

package/docs/doc-mt.js

@@ -279,6 +279,107 @@ function formatModal(obj, strIndent, options) {
     return result;
 }
 
+function formatHintModal(obj, strIndent, options) {
+    if (!obj)
+        return "";
+
+    strIndent = strIndent || "";
+    options = options || {};
+
+    var result = "";
+    var nextIndent = strIndent + "    ";
+    for (var m in obj) {
+        if (!obj.hasOwnProperty(m))
+            continue;
+        
+        var child = obj[m];
+
+        var validation = !options.optionalToAll && child.required ? "required" : "optional";
+        if (child.type === "IdRef" && child.reference) {
+            validation += ", ref: <a href='#" + encodeHtml(child.reference) + "' onclick='setTimeout(gotoHash, 20)'>" + encodeHtml(child.reference) + "</a>";
+        }
+
+        if (child.validValues && Array.isArray(child.validValues)) {
+            validation += ", enum(" + encodeHtml(child.validValues.join(", ")) + ")";
+        }
+
+        if (child.type === "array" && child.items && child.items.type != "object") {
+            validation += ", array items: " + (!options.optionalToAll && child.items.required ? "required" : "optional");
+            if (child.items.validValues && Array.isArray(child.items.validValues))
+                validation += ", enum(" + encodeHtml(child.items.validValues.join(", ")) + ")";        
+        }
+
+        var comment = `<span class="code-comment">// ${validation} ${typeof child.description === "string" && child.description !== "" ? "- " + encodeHtml(child.description) : ""}</span>`;
+
+        if (options.mode === "modal") {
+            if (child.type === "object")
+                result += "\r\n" + nextIndent + '"' + m + '": ' + comment + formatHintModal(child.fields, nextIndent, options) + ",";
+            else if (child.type === "array") {
+                result += `\r\n${nextIndent}"${m}": [`;
+                if (child.items.type === "object")
+                    result += " " + comment + formatHintModal(child.items.fields, nextIndent, options);
+                else if (child.items.type === "datetime")
+                    result += `\r\n${nextIndent}    ` + JSON.stringify(child.items.defaultValue || "ISODate_ISO_8601") + " " + comment + `\r\n${nextIndent}`;
+                else if (child.items.type === "boolean")
+                    result += `\r\n${nextIndent}    ` + child.items.defaultValue || "false" + " " + comment + `\r\n${nextIndent}`;
+                else if (child.items.type === "integer" || child.items.type === "long"|| child.items.type === "double")
+                    result += `\r\n${nextIndent}    ` + child.items.defaultValue || "0" + " " + comment + `\r\n${nextIndent}`;
+                else
+                    result += `\r\n${nextIndent}    ` + JSON.stringify(child.defaultValue || child.type) + " " + comment + `\r\n${nextIndent}`;
+                result += `]`;
+            }
+            else if (child.type === "datetime")
+                result += `\r\n${nextIndent}"${m}": ` + JSON.stringify(child.defaultValue || "ISODate_ISO_8601") + ", " + comment;
+            else if (child.type === "boolean")
+                result += `\r\n${nextIndent}"${m}": ` + (child.defaultValue || "false") + ", " + comment;
+            else if (child.type === "integer" || child.type === "long"|| child.type === "double")
+                result += `\r\n${nextIndent}"${m}": ` + (child.defaultValue || "0") + ", " + comment;
+            else
+                result += `\r\n${nextIndent}"${m}": ` + JSON.stringify(child.defaultValue || child.type) + ", " + comment;
+        } else if (options.mode === "modal_null") {
+            if (child.type === "object")
+                result += "\r\n" + nextIndent + '"' + m + '": ' + comment + formatHintModal(child.fields, nextIndent, options);
+            else if (child.type === "array") {
+                result += `\r\n${nextIndent}"${m}": [`;
+                if (child.items.type === "object")
+                    result += " " + comment + formatHintModal(child.items.fields, nextIndent, options) + "],";
+                else
+                    result += "], " + comment;
+            }
+            else 
+                result += `\r\n${nextIndent}"${m}": null, ${comment}`;
+        } else if (options.mode === "modal_undefined") {
+            if (child.type === "object")
+                result += "\r\n" + nextIndent + '"' + m + '": ' + comment + formatHintModal(child.fields, nextIndent, options);
+            else if (child.type === "array") {
+                result += `\r\n${nextIndent}"${m}": [`;
+                if (child.items.type === "object")
+                    result += " " + comment + formatHintModal(child.items.fields, nextIndent, options) + "], ";
+                else
+                    result += "], " + comment;
+            }
+            else 
+                result += `\r\n${nextIndent}"${m}": undefined, ${comment}`;
+        } else {
+            result += "\r\n" + strIndent + encodeHtml(m) + ": " + encodeHtml(child.type);
+            if (child.type === "array")
+                result += child.items.type === "object" ? " of object" : " of " + child.items.type;
+            if (child.type === "object")
+                result += " " + comment + formatHintModal(child.fields, strIndent + "    ", options);
+            else if (child.type === "array" && child.items.type === "object")
+                result += " " + comment + formatHintModal(child.items.fields, strIndent + "    ", options);
+            else
+                result +=  ", " + comment;
+        }
+    }
+
+    if (options.mode === "modal" || options.mode === "modal_null" || options.mode === "modal_undefined") {
+        return (strIndent ? "\r\n" + strIndent : "") +  "{" + result + "\r\n" + strIndent + "}";
+    }
+    
+    return result;
+}
+
 function explainRoles(strRoles) {
     if (!strRoles)
         return "";
@@ -320,6 +421,7 @@ function getModalInput(excludedFields, fields, options) {
             var obj = fields;
             var segs = item.split(".");
             for (var i = 0; i < segs.length; i++) {
+                if (!obj) return;
                 var seg = segs[i];
                 if (!(seg in obj))
                     return;
@@ -329,7 +431,7 @@ function getModalInput(excludedFields, fields, options) {
                 else if (obj[seg].type === "object")
                     obj = obj[seg].fields;
                 else if (obj[seg].type === "array")
-                    obj = obj[seg].items;
+                    obj = obj[seg].items?.fields;
                 else
                     return;
             }