mushroom-cli 1.1.0 → 1.2.0-alpha.2

package/README.md

@@ -70,6 +70,10 @@ Generate entities for CSharp project which calls Mushroom API
 
     npx mushroom-cli gen projectName[@aliasName] c#-driver
 
+## Merge
+
+    npx mushroom-cli merge output-path.json
+
 ## Update
 
 Update ts code
@@ -84,6 +88,22 @@ Disable checking for update:
 
 ## Version
 
+### 1.2.0-alpha.2
+
+New features:
+
+* Support merge command
+
+Fixed bugs:
+
+* Generate wrong required field for view parameter
+
+### 1.2.0-alpha.1
+
+New features:
+
+* Support type for View result
+
 ### 1.1.0
 
 Support MushroomServer 0.2.25.4 or later

package/gen/gen-ts-driver.js

@@ -63,26 +63,27 @@ function getCSharpTypeFromMushroomType(type) {
     return "UNKNOWN_TYPE_" + type;
 }
 
-function generateTypescriptClass(objectDefination, indent) {
+function generateTypescriptClass(objectDefination, indent, options) {
     if (!indent) indent = "";
     let code = "{\n";
     for (let fieldName in objectDefination) {
+        const optionalMark = options?.checkRequired && objectDefination[fieldName].required ? "" : "?";
         if (objectDefination[fieldName].type == "object") {
-            code += `${indent}    ${fieldName}?: ${generateTypescriptClass(objectDefination[fieldName].fields, indent + "    ")},
+            code += `${indent}    ${fieldName}${optionalMark}: ${generateTypescriptClass(objectDefination[fieldName].fields, indent + "    ")},
 `;
         }
         else if (objectDefination[fieldName].type == "array") {
             if (objectDefination[fieldName].items.type == "object") {
-                code += `${indent}    ${fieldName}?: ${generateTypescriptClass(objectDefination[fieldName].items.fields, indent + "    ")}[],
+                code += `${indent}    ${fieldName}${optionalMark}: ${generateTypescriptClass(objectDefination[fieldName].items.fields, indent + "    ")}[],
 `;
             }
             else {
-                code += `${indent}    ${fieldName}?: ${getCSharpTypeFromMushroomType(objectDefination[fieldName].items.type)}[],
+                code += `${indent}    ${fieldName}${optionalMark}: ${getCSharpTypeFromMushroomType(objectDefination[fieldName].items.type)}[],
 `;
             }
         }
         else {
-            code += `${indent}    ${fieldName}?: ${getCSharpTypeFromMushroomType(objectDefination[fieldName].type)},
+            code += `${indent}    ${fieldName}${optionalMark}: ${getCSharpTypeFromMushroomType(objectDefination[fieldName].type)},
 `;
         }
     }
@@ -92,7 +93,7 @@ function generateTypescriptClass(objectDefination, indent) {
 
 function generateTypescriptClassFromViewParameters(parameters) {
     if (Array.isArray(parameters)){
-        return '{\n' + parameters.map(p => `    ${p.field}?: ${getCSharpTypeFromMushroomType(p.type || "string")}${p.isArray ? "[]" : ""}`).join(',\n') + '\n}';
+        return '{\n' + parameters.map(p => `    ${p.field}${p.validation?.required && p.validation.defaultValue === undefined ? "" : "?"}: ${getCSharpTypeFromMushroomType(p.type || "string")}${p.isArray ? "[]" : ""}`).join(',\n') + '\n}';
     }
     return '{}';
 }
@@ -227,13 +228,17 @@ ${customMethodCode}}
             views[viewName] = { clientCache: true };
 
             const viewParameterTypes = viewRoles.map(view => {
-                const type = `${typescriptClassName}$ViewsResource_${viewName}View_${view.grant === "*" ? "" : toTypeScriptClassName(view.grant)}Parameters`;
-                code += `export interface ${type} ${generateTypescriptClassFromViewParameters(view.parameters)};
+                const inputType = `${typescriptClassName}$ViewsResource_${viewName}View_${view.grant === "*" ? "" : toTypeScriptClassName(view.grant)}Parameters`;
+                const outputType = view.codeHint?.output ? `${typescriptClassName}$ViewsResource_${viewName}View_${view.grant === "*" ? "" : toTypeScriptClassName(view.grant)}Result` : 'any';
+                code += `export interface ${inputType} ${generateTypescriptClassFromViewParameters(view.parameters)};
 `;
-                return `MushroomViewFunction<any, ${type}>`;
+                if (view.codeHint?.output)
+                    code += `export interface ${outputType} ${generateTypescriptClass(view.codeHint.output.fields, undefined, {checkRequired: true})};
+`;
+                return `MushroomViewFunction<${outputType}, ${inputType}>`;
             });
             viewCode += `
-        ${viewName}Async: ${viewParameterTypes.join(' & ')},`;
+        ${viewName}Async: ${viewParameterTypes.join(' | ')},`;
         }
         
         if (viewCode) {
@@ -396,13 +401,17 @@ ${customMethodCode}}
             views[viewName] = { clientCache: true };
 
             const viewParameterTypes = viewRoles.map(view => {
-                const type = `${typescriptClassName}$ViewsResource_${viewName}View_${view.grant === "*" ? "" : toTypeScriptClassName(view.grant)}Parameters`;
-                code += `export interface ${type} ${generateTypescriptClassFromViewParameters(view.parameters)};
+                const inputType = `${typescriptClassName}$ViewsResource_${viewName}View_${view.grant === "*" ? "" : toTypeScriptClassName(view.grant)}Parameters`;
+                const outputType = view.codeHint?.output ? `${typescriptClassName}$ViewsResource_${viewName}View_${view.grant === "*" ? "" : toTypeScriptClassName(view.grant)}Result` : 'any';
+                code += `export interface ${inputType} ${generateTypescriptClassFromViewParameters(view.parameters)};
+`;
+                if (view.codeHint?.output)
+                    code += `export interface ${outputType} ${generateTypescriptClass(view.codeHint.output.fields, undefined, {checkRequired: true})};
 `;
-                return `MushroomViewFunction<any, ${type}>`;
+                return `MushroomViewFunction<${outputType}, ${inputType}>`;
             });
             viewCode += `
-        ${viewName}Async: ${viewParameterTypes.join(' & ')},`;
+        ${viewName}Async: ${viewParameterTypes.join(' | ')},`;
         }
         
         if (viewCode) {

package/merge.js

@@ -0,0 +1,84 @@
+const fs = require("fs");
+const path = require('path');
+const JSON5 = require("json5");
+const common = require("./common.js");
+const help = require("./help.js");
+
+const masterFile = require("./master-file/master-file");
+
+async function merge(args) {
+    let projectName = args[1];
+    const output = args[2];
+
+    if (!projectName || !output) {
+        help(args);
+        return;
+    }
+    
+    let alias = "default";
+    const atIndex = projectName.indexOf("@");
+    if (atIndex !== -1) {
+        alias = projectName.substring(atIndex + 1);
+        projectName = projectName.substring(0, atIndex);
+        if (!projectName) {
+            help(args);
+            return;
+        }
+
+        if (!alias)
+            alias = "default";
+    }
+
+    let mushroomConfig;
+    try {
+        const mushroomConfigContent = fs.readFileSync("./mushroom-config.json").toString();
+        mushroomConfig = JSON.parse(mushroomConfigContent);
+    }
+    catch (e) {
+        console.error("mushroom-config.json not found or unable to parse");
+        throw e;
+    }
+
+    if (!mushroomConfig || typeof mushroomConfig !== "object") 
+        throw new Error(`Invalid configuration. Please re-check file mushroom-config.json`);
+
+    if (!mushroomConfig || !mushroomConfig.projects || !mushroomConfig.projects[projectName])
+        throw new Error(`Project not found (${projectName})`);
+
+    const project = mushroomConfig.projects[projectName];
+    if (!project.src)
+        throw new Error("Project source (src) not found");
+    
+    var source;
+    try {
+        const sourceContent = fs.readFileSync(project.src).toString();
+        source = JSON5.parse(sourceContent);
+    }
+    catch(e) {
+        console.error(project.src + " not found or unable to parse");
+        throw e;
+    }
+
+    if (!source || typeof source !== "object") 
+        throw new Error(`Invalid api project configuration. Please re-check file ${project.src}`);
+    
+    if (Array.isArray(source.fragments)) {
+        console.log("Process master file: " + project.src);
+        source = masterFile.processMasterFile(path.dirname(project.src), source);
+    }
+
+    if (!source || typeof source !== "object") {
+        throw new Error(`${!source}\t${typeof source}\tInvalid api project configuration. Please re-check file ${project.src}`);
+    }
+
+    if (source.name !== projectName) {
+        throw new Error(`Project name is mismatched (${projectName} & ${source.name})`);
+    }
+    
+    common.ensureFolder(output);
+
+    fs.writeFileSync(output, JSON.stringify(source));
+    console.log(`Merged ${projectName}@${alias} then saved to ${output}`);
+}
+
+module.exports = merge;

package/mr.js

@@ -1,10 +1,11 @@
 #!/usr/bin/env node
 
-const init = require("./init.js");
-const config = require("./config.js");
-const gen = require("./gen.js");
-const update = require("./update.js");
-const help = require("./help.js");
+const init = require("./init");
+const config = require("./config");
+const gen = require("./gen");
+const merge = require("./merge");
+const update = require("./update");
+const help = require("./help");
 
 const pkg = require("./package.json");
 const checkUpdate = require("./check-update");
@@ -41,6 +42,9 @@ async function run(args) {
             case "gen":
                 await gen(args);
                 break;
+            case "merge":
+                merge(args);
+                break;
             case "update":
                 await update(args);
                 break;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "mushroom-cli",
-  "version": "1.1.0",
+  "version": "1.2.0-alpha.2",
   "description": "Mushroom CLI",
   "main": "mr.js",
   "scripts": {
-    "release": "npm publish --access public"
+    "release": "npm publish --access public --tag alpha"
   },
   "keywords": [
     "Mushroom",