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

package/gen/gen-ts-driver.js

@@ -63,37 +63,38 @@ function getCSharpTypeFromMushroomType(type) {
     return "UNKNOWN_TYPE_" + type;
 }
 
-function generateTypescriptClass(objectDefination, indent, options) {
-    if (!indent) indent = "";
-    let code = "{\n";
+function generateTypescriptClass(objectDefination, className, options) {
+    let childrenCode = '';
+    let code = `export interface ${className} {\n`;
     for (let fieldName in objectDefination) {
         const optionalMark = options?.checkRequired && objectDefination[fieldName].required ? "" : "?";
         if (objectDefination[fieldName].type == "object") {
-            code += `${indent}    ${fieldName}${optionalMark}: ${generateTypescriptClass(objectDefination[fieldName].fields, indent + "    ")},
-`;
+            const fieldClassName = className + "_" + toTypeScriptClassName(fieldName);
+            code += `    ${fieldName}${optionalMark}: ${fieldClassName},\n`;
+            childrenCode += generateTypescriptClass(objectDefination[fieldName].fields, fieldClassName);
         }
         else if (objectDefination[fieldName].type == "array") {
             if (objectDefination[fieldName].items.type == "object") {
-                code += `${indent}    ${fieldName}${optionalMark}: ${generateTypescriptClass(objectDefination[fieldName].items.fields, indent + "    ")}[],
-`;
+                const fieldClassName = className + "_" + toTypeScriptClassName(fieldName);
+                code += `    ${fieldName}${optionalMark}: ${fieldClassName}[],\n`;
+                childrenCode += generateTypescriptClass(objectDefination[fieldName].items.fields, fieldClassName);
             }
             else {
-                code += `${indent}    ${fieldName}${optionalMark}: ${getCSharpTypeFromMushroomType(objectDefination[fieldName].items.type)}[],
-`;
+                code += `    ${fieldName}${optionalMark}: ${getCSharpTypeFromMushroomType(objectDefination[fieldName].items.type)}[],\n`;
             }
         }
         else {
-            code += `${indent}    ${fieldName}${optionalMark}: ${getCSharpTypeFromMushroomType(objectDefination[fieldName].type)},
-`;
+            code += `    ${fieldName}${optionalMark}: ${getCSharpTypeFromMushroomType(objectDefination[fieldName].type)},\n`;
         }
     }
-    code += indent + "}";
-    return code;
+    code += "}\n\n";
+
+    return code + childrenCode;
 }
 
 function generateTypescriptClassFromViewParameters(parameters) {
     if (Array.isArray(parameters)){
-        return '{\n' + parameters.map(p => `    ${p.field}${p.validation?.required ? "" : "?"}: ${getCSharpTypeFromMushroomType(p.type || "string")}${p.isArray ? "[]" : ""}`).join(',\n') + '\n}';
+        return '{\n' + parameters.map(p => `    ${p.field}${p.validation?.required && p.defaultValue === undefined ? "" : "?"}: ${getCSharpTypeFromMushroomType(p.type || "string")}${p.isArray ? "[]" : ""}`).join(',\n') + '\n}';
     }
     return '{}';
 }
@@ -125,7 +126,7 @@ function genTypescriptDriverString(aliasProject, source) {
         }
     }
 
-    let code = `import mushroom, { defineAsyncResource, defineAsyncView, fireEvent, createRestfulAsyncFunction, IdType, IMushroom, Mushroom, MushroomRequest, MushroomRequestSetting, MushroomRestfulRequest, MushroomResponse, MushroomResourceBase, MushroomListResource, MushroomFindByIdResource, MushroomCreateResource, MushroomBatchCreateResource, MushroomUpdateResource, MushroomBatchUpdateResource, MushroomPartialUpdateResource, MushroomDeleteResource, MushroomBatchDeleteResource, MushroomExtensibleResource, MushroomViewFunction, MushroomError } from "mushroomjs";
+    let code = `import mushroom, { defineAsyncResource, defineAsyncView, fireEvent, createRestfulAsyncFunction, IdType, IMushroom, Mushroom, MushroomRequest, MushroomRequestSetting, MushroomRestfulRequest, MushroomResponse, MushroomResponseDataType, MushroomResourceBase, MushroomListResource, MushroomFindByIdResource, MushroomCreateResource, MushroomBatchCreateResource, MushroomUpdateResource, MushroomBatchUpdateResource, MushroomPartialUpdateResource, MushroomDeleteResource, MushroomBatchDeleteResource, MushroomExtensibleResource, MushroomViewFunction, MushroomError, IMushroomOfflineResponse, MushroomOfflineResponse, MushroomOfflineResponseState } from "mushroomjs";
 ${extensionsImportLines.join("\n")}
 export * from "mushroomjs";
 export const extensions = {
@@ -143,9 +144,7 @@ export type IdValue = ${source.idType == "AutoIncInt" || source.idType == "AutoI
 
         const entity = entities[entityName];
         const typescriptClassName = toTypeScriptClassName(entityName);
-        code += `export interface ${typescriptClassName} ${generateTypescriptClass(entity.fields)};
-`;
-
+        code += generateTypescriptClass(entity.fields, typescriptClassName);
 
         const actions = {};
         iApiClassBody += `    ${entityName}: MushroomResourceBase`;
@@ -156,7 +155,12 @@ export type IdValue = ${source.idType == "AutoIncInt" || source.idType == "AutoI
 
             actions[actionName] = {
                 clientCache: (actionName === "findById" || actionName === "findMany") && isAllowCache(entity.actions[actionName], true) ? true : undefined,
-                includeTotal: actionName === "findMany" && entity.actions[actionName].some(a => a.includeTotal) ? true: undefined
+                includeTotal: actionName === "findMany" && entity.actions[actionName].some(a => a.includeTotal) ? true: undefined,
+                offlineMode: entity.actions[actionName].some(a => a.offlineMode === "disallow") 
+                    ? "disallow"
+                    : !entity.actions[actionName].length || entity.actions[actionName].some(a => a.offlineMode === "allow")
+                        ? "allow"
+                        : undefined
             };
 
             switch (actionName) {
@@ -233,8 +237,8 @@ ${customMethodCode}}
                 code += `export interface ${inputType} ${generateTypescriptClassFromViewParameters(view.parameters)};
 `;
                 if (view.codeHint?.output)
-                    code += `export interface ${outputType} ${generateTypescriptClass(view.codeHint.output.fields, undefined, {checkRequired: true})};
-`;
+                    code += generateTypescriptClass(view.codeHint.output.fields, outputType, {checkRequired: true});
+                
                 return `MushroomViewFunction<${outputType}, ${inputType}>`;
             });
             viewCode += `
@@ -299,7 +303,7 @@ function genDtsString(aliasProject, source) {
         }
     }
 
-    let code = `import { IdType, IMushroom, Mushroom, MushroomRequest, MushroomRequestSetting, MushroomRestfulRequest, MushroomResponse, MushroomResourceBase, MushroomListResource, MushroomFindByIdResource, MushroomCreateResource, MushroomBatchCreateResource, MushroomUpdateResource, MushroomBatchUpdateResource, MushroomPartialUpdateResource, MushroomDeleteResource, MushroomBatchDeleteResource, MushroomExtensibleResource, MushroomViewFunction, MushroomError } from "mushroomjs";
+    let code = `import { IdType, IMushroom, Mushroom, MushroomRequest, MushroomRequestSetting, MushroomRestfulRequest, MushroomResponse, MushroomResponseDataType, MushroomResourceBase, MushroomListResource, MushroomFindByIdResource, MushroomCreateResource, MushroomBatchCreateResource, MushroomUpdateResource, MushroomBatchUpdateResource, MushroomPartialUpdateResource, MushroomDeleteResource, MushroomBatchDeleteResource, MushroomExtensibleResource, MushroomViewFunction, MushroomError, IMushroomOfflineResponse, MushroomOfflineResponse, MushroomOfflineResponseState } from "mushroomjs";
 ${extensionsImportLines.join("\n")}
 export * from "mushroomjs";
 export declare const extensions = {
@@ -317,9 +321,7 @@ export declare type IdValue = ${source.idType == "AutoIncInt" || source.idType =
 
         const entity = entities[entityName];
         const typescriptClassName = toTypeScriptClassName(entityName);
-        code += `export interface ${typescriptClassName} ${generateTypescriptClass(entity.fields)};
-`;
-
+        code += generateTypescriptClass(entity.fields, typescriptClassName);
 
         const actions = {};
         iApiClassBody += `    ${entityName}: MushroomResourceBase`;
@@ -329,7 +331,13 @@ export declare type IdValue = ${source.idType == "AutoIncInt" || source.idType =
                 continue;
 
             actions[actionName] = {
-                clientCache: (actionName === "findById" || actionName === "findMany") && isAllowCache(entity.actions[actionName], true) ? true : undefined
+                clientCache: (actionName === "findById" || actionName === "findMany") && isAllowCache(entity.actions[actionName], true) ? true : undefined,
+                includeTotal: actionName === "findMany" && entity.actions[actionName].some(a => a.includeTotal) ? true: undefined,
+                offlineMode: entity.actions[actionName].some(a => a.offlineMode === "disallow") 
+                    ? "disallow"
+                    : !entity.actions[actionName].length || entity.actions[actionName].some(a => a.offlineMode === "allow")
+                        ? "allow"
+                        : undefined
             };
 
             switch (actionName) {
@@ -403,11 +411,10 @@ ${customMethodCode}}
             const viewParameterTypes = viewRoles.map(view => {
                 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)};
-`;
+                code += `export interface ${inputType} ${generateTypescriptClassFromViewParameters(view.parameters)};\n`;
                 if (view.codeHint?.output)
-                    code += `export interface ${outputType} ${generateTypescriptClass(view.codeHint.output.fields, undefined, {checkRequired: true})};
-`;
+                    code += generateTypescriptClass(view.codeHint.output.fields, outputType, {checkRequired: true});
+
                 return `MushroomViewFunction<${outputType}, ${inputType}>`;
             });
             viewCode += `

package/gen.js

@@ -6,6 +6,7 @@ const help = require("./help.js");
 const masterFile = require("./master-file/master-file");
 
 const genApiDocs = require("./gen/gen-api-docs");
+const genApiDocsV1 = require("./gen/gen-api-docs-v1");
 const genDatabaseDocs = require("./gen/gen-db-docs");
 const javascriptDriverGenerator = require("./gen/gen-js-driver");
 const genJavascriptDriverTarball = require("./gen/gen-js-driver-tarball");
@@ -85,7 +86,10 @@ async function gen(args) {
     const type = args[2];
     switch (type) {
         case "docs":
-            await genApiDocs(args, projectName, project, alias, source);
+            if (args.includes("v1"))
+                await genApiDocsV1(args.filter(p => p != "v1"), projectName, project, alias, source);
+            else    
+                await genApiDocs(args, projectName, project, alias, source);
             break;
         case "db-docs":
             genDatabaseDocs(args, projectName, project, alias, source);

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,78 +1,82 @@
-#!/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 pkg = require("./package.json");
-const checkUpdate = require("./check-update");
-
-const versionGroup = pkg.version.match(/([^-]+)(-(\w+).*)?/);
-const currentDistTag = versionGroup[3] ? versionGroup[3] : "latest";
-console.log("Mushroom CLI version " +  pkg.version);
-
-async function run(args) {
-    let debugMode = false;
-    if (args.indexOf("--debug") !== -1) {
-        debugMode = true;
-        args = args.filter(arg => arg !== "--debug");
-    }
-
-    let checkUpdateTask;
-    if (args.indexOf("--no-check-update") !== -1){
-        args = args.filter(arg => arg !== "--no-check-update");
-        checkUpdateTask = null;
-    }
-    else{
-        checkUpdateTask = checkUpdate();
-        checkUpdateTask.catch(() => {});
-    }
-
-    try {
-        switch(args[0]) {
-            case "init":
-                await init(args);
-                break;
-            case "config":
-                await config(args);
-                break;
-            case "gen":
-                await gen(args);
-                break;
-            case "update":
-                await update(args);
-                break;
-            case "":
-            case undefined:
-                console.log(`Mushroom CLI`);
-                break;
-            case "help":
-            case "man":
-                help(args.slice(1).join());
-                break;
-            default:
-                help(args, true);
-                break;
-        }
-    }
-    catch (e) {
-        console.error(debugMode ? e : e.message);
-    }
-    
-
-    if (checkUpdateTask !== null)
-        try {
-            var data = await checkUpdateTask;
-            if (data["dist-tags"] && data["dist-tags"][currentDistTag] && data["dist-tags"][currentDistTag] !== pkg.version) {
-                console.warn(`YOUR mushroom-cli VERSION IS NOT LATEST (dist-tags: ${currentDistTag}). PLEASE RUN: npm i mushroom-cli@${data["dist-tags"][currentDistTag]} OR yarn add mushroom-cli@^${data["dist-tags"][currentDistTag]}`);
-            }
-        }
-        catch(e) {
-            if (debugMode) console.log(e);
-        }
-}
-
-const [,, ...args] = process.argv;
+#!/usr/bin/env node
+
+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");
+
+const versionGroup = pkg.version.match(/([^-]+)(-(\w+).*)?/);
+const currentDistTag = versionGroup[3] ? versionGroup[3] : "latest";
+console.log("Mushroom CLI version " +  pkg.version);
+
+async function run(args) {
+    let debugMode = false;
+    if (args.indexOf("--debug") !== -1) {
+        debugMode = true;
+        args = args.filter(arg => arg !== "--debug");
+    }
+
+    let checkUpdateTask;
+    if (args.indexOf("--no-check-update") !== -1){
+        args = args.filter(arg => arg !== "--no-check-update");
+        checkUpdateTask = null;
+    }
+    else{
+        checkUpdateTask = checkUpdate();
+        checkUpdateTask.catch(() => {});
+    }
+
+    const startTime = new Date().getTime();
+    try {
+        switch(args[0]) {
+            case "init":
+                await init(args);
+                break;
+            case "config":
+                await config(args);
+                break;
+            case "gen":
+                await gen(args);
+                break;
+            case "merge":
+                merge(args);
+                break;
+            case "update":
+                await update(args);
+                break;
+            case "help":
+            case "man":
+                help(args.slice(1).join());
+                break;
+            default:
+                help(args, true);
+                break;
+        }
+    }
+    catch (e) {
+        console.error(debugMode ? e : "ERROR: " + e.message);
+    }
+    finally {
+        console.log("Processed in", new Date().getTime() - startTime, "ms.");
+    }
+    
+
+    if (checkUpdateTask !== null)
+        try {
+            var data = await checkUpdateTask;
+            if (data["dist-tags"] && data["dist-tags"][currentDistTag] && data["dist-tags"][currentDistTag] !== pkg.version) {
+                console.warn(`YOUR mushroom-cli VERSION IS NOT LATEST (dist-tags: ${currentDistTag}). PLEASE RUN: npm i mushroom-cli@${data["dist-tags"][currentDistTag]} OR yarn add mushroom-cli@^${data["dist-tags"][currentDistTag]}`);
+            }
+        }
+        catch(e) {
+            if (debugMode) console.log(e);
+        }
+}
+
+const [,, ...args] = process.argv;
 run(args);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mushroom-cli",
-  "version": "1.2.0-alpha.1",
+  "version": "1.2.0-alpha.11",
   "description": "Mushroom CLI",
   "main": "mr.js",
   "scripts": {
@@ -16,11 +16,13 @@
   },
   "author": "suco2007",
   "license": "ISC",
+  "dependencies-comments": "node-fetch: 2.x; open: 8.x; minify: 7.x",
   "dependencies": {
-    "jsdom": "^21.0.0",
+    "jsdom": "^24.1.1",
     "json5": "^2.2.3",
-    "node-fetch": "^2.6.7",
-    "open": "^8.4.0",
+    "minify": "7.2.2",
+    "node-fetch": "^2.7.0",
+    "open": "^8.4.2",
     "readline-sync": "^1.4.10",
     "targz": "^1.0.1"
   }