mushroom-cli 1.2.0-alpha.9 → 1.2.0

package/README.md

@@ -1,161 +1,199 @@
-# Mushroom CLI
-
-## Init
-
-Init a mushroom json file
-
-    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]
-
-## Configure
-
-Add the mushroom json file into mushroom-config.json
-
-    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]
-
-Config gen database docs
-
-    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]
-
-Config gen typescript driver
-
-    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]
-
-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]
-
-## Genarate
-
-Generate docs api (html format)
-
-    npx mushroom-cli gen projectName[@aliasName] docs [v1] [tmp]
-
-Generate database docs (html format)
-
-    npx mushroom-cli gen projectName[@aliasName] db-docs [tmp]
-
-Generate npm package (tarball file)
-
-    npx mushroom-cli gen projectName[@aliasName] js-driver-tarball
-
-Generate javascript driver
-
-    npx mushroom-cli gen projectName[@aliasName] js-driver
-
-Generate typescript driver
-
-    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
-
-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
-
-    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
-
-## Version
-
-### 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
-
-New features:
-
-* Support type for View result
-
-### 1.1.0
-
-Support MushroomServer 0.2.25.4 or later
-
-Support mushroomjs 1.1.0 or later
+# Mushroom CLI
+
+## Init
+
+Init a mushroom json file
+
+```bash
+npx mushroom-cli init json ./api/SampleProject.json [silent]
+```
+
+Init a DotNet Core project which pre-install Mushroom Server
+
+```bash
+npx mushroom-cli init netcore [projectName]
+```
+
+## Configure
+
+Add the mushroom json file into mushroom-config.json
+
+```bash
+npx mushroom-cli config add ./api/yourProjectName.json
+```
+
+Config gen docs api
+
+```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
+
+```bash
+npx mushroom-cli config gen projectName "db-docs" ./wwwroot/db-docs.html [alias aliasName] [features file,auth,mail]
+```
+
+Config gen javascript driver
+
+```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
+
+```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
+
+```bash
+npx mushroom-cli config gen projectName "c#-mongo" ./API/Generated.cs [alias aliasName]
+```
+
+Config gen entities for CSharp project which calls Mushroom API
+
+```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)
+
+```bash
+npx mushroom-cli gen projectName[@aliasName] docs [v1] [tmp]
+```
+
+Generate database docs (html format)
+
+```bash
+npx mushroom-cli gen projectName[@aliasName] "db-docs" [tmp]
+```
+
+Generate npm package (tarball file)
+
+```bash
+npx mushroom-cli gen projectName[@aliasName] "js-driver-tarball"
+```
+
+Generate javascript driver
+
+```bash
+npx mushroom-cli gen projectName[@aliasName] "js-driver"
+```
+
+Generate typescript driver
+
+```bash
+npx mushroom-cli gen projectName[@aliasName] "ts-driver"
+```
+
+Generate entities for Mushroom project in CSharp and using MongoDb
+
+```bash
+npx mushroom-cli gen projectName[@aliasName] "c#-mongo"
+```
+
+Generate entities for CSharp project which calls Mushroom API
+
+```bash
+npx mushroom-cli gen projectName[@aliasName] "c#-driver"
+```
+
+## Merge
+
+```bash
+npx mushroom-cli merge output-path.json
+```
+
+## Update
+
+Update ts code (configuration was stored in mushroom-config.json file)
+
+```bash
+npx mushroom-cli update "ts-code"
+```
+
+Update ts code (simple call)
+
+```bash
+npx mushroom-cli update "ts-code" file-path.ts remote-ts-code-url
+```
+
+## Other
+
+Disable checking for update:
+
+```bash
+npx mushroom-cli parameters --no-check-update
+```
+
+## Version
+
+### 1.2.0
+
+New features:
+
+- Support merge command
+- Support type for View result
+- gen-ts-driver: Support offline mode
+- init netcore: Support some new set-functions: `ToLowerCase`, `ToUpperCase`, `Trim`, `Replace`, `New-RandomNumber`, `New-RandomString`
+- gen-docs: New gen docs engine v1.2 - deal with very big api docs
+  - support minify
+  - allow user to add and change API root url
+  - add `JavascriptParamModel`, `JavascriptRequestBodyModel`, `JavascriptResultModel` tab in code snippets of custom methods
+  - add docs for `inline` mode of download file and zip file(s), `allowSmallerSize` for thumb
+  - support links for Roles and Code Snippets
+  - add docs for response body of custom methods
+  - allow collapse object fields
+  - add validation of fields in custom methods and parameters in views
+
+Improvement/Changes:
+
+- init netcore
+  - Operating fail if unknown command or set-function found
+- gen c#-mongo
+  - support System.Text.Json on resources
+  - generate resource classes with `partial`
+- gen c#-driver
+  - Generate resource classes with `partial`
+- gen ts-driver
+  - export type for object fields
+  - generate type for custom methods of action
+  - generate description for fields, entities
+  - generate type for getCountAsync declaration
+- gen docs
+  - add default-value information of fields
+  - Improve documentation generation: view, custom action.
+  - filter role list
+  - format cURL to easy to copy and paste to Postman
+  - lighten font on MacOS
+  - donot use css and js files of bootstrap and jquery in CDN, copy file locally to enable to view offline
+  - curl of custom method is missing header X-HTTP-Method-Override
+  - Correct generate query string and request body at HTTP and cURL tabs in code snippets of custom methods
+  - Correct generate param and body at Javascript tab in code snippets of custom methods
+  - Correct generate JavascriptModel in code snippets
+  - improve copy function
+  - display the description of entities
+
+Fixed bugs:
+
+- gen docs
+  - Generate wrong required field for view parameter
+  - doesn't exclude fields of object in an array
+- gen-ts
+  - add null value for nullable field type
+
+### 1.1.1
+
+Improvement:
+
+- `mushroom-cli update tsCode` can read the configuration in mushroom-config.json file
+
+### 1.1.0
+
+Support MushroomServer 0.2.25.4 or later
+
+Support mushroomjs 1.1.0 or later

package/dist/check-update.js

@@ -0,0 +1,6 @@
+import fetch from 'node-fetch';
+export default async function checkUpdate() {
+    const res = await fetch('https://registry.npmjs.org/mushroom-cli/');
+    const data = await res.json();
+    return data;
+}

package/dist/common.js

@@ -0,0 +1,280 @@
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import readlineSync from 'readline-sync';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+export function getPackageVersion() {
+    try {
+        const content = fs.readFileSync(path.join(__dirname, '../package.json')).toString();
+        const pkg = JSON.parse(content);
+        return pkg.version;
+    }
+    catch {
+        return '<!unable to get package version>';
+    }
+}
+export function ensureFolder(path, isFolder) {
+    const index = path.lastIndexOf('/');
+    if (!isFolder && index <= 0) {
+        return;
+    }
+    if (!isFolder)
+        path = path.substring(0, index);
+    if (path === '.' || path === '..')
+        return;
+    if (!fs.existsSync(path)) {
+        fs.mkdirSync(path, { recursive: true, mode: 0o755 });
+    }
+}
+export function getRootUrl(projectApiConfiguration) {
+    return projectApiConfiguration.codeHint && projectApiConfiguration.codeHint.rootUrl
+        ? projectApiConfiguration.codeHint.rootUrl
+        : projectApiConfiguration.rootUrl;
+}
+export function getEntities(projectApiConfiguration, roles, getAll) {
+    if (!projectApiConfiguration || !projectApiConfiguration.entities || !Array.isArray(projectApiConfiguration.entities))
+        return {};
+    const entities = {};
+    projectApiConfiguration.entities.forEach((entity) => {
+        if (entity.disabled)
+            return;
+        if (getAll) {
+            entities[entity.name] = entity;
+            entity.storageName = entity.storageName ? entity.storageName : entity.name;
+            if (!roles || !roles.length)
+                roles = ['*'];
+            return;
+        }
+        for (const actionName in entity.actions) {
+            entity.actions[actionName].forEach((action) => {
+                var _a;
+                if (!action.grant || !action.enabled || (action.codeHint && action.codeHint.disabled))
+                    return;
+                const allow = roles?.includes('*') || action.grant === '*';
+                if (!allow) {
+                    action.grant = action.grant
+                        .split('|')
+                        .map((roleGroup) => {
+                        if (!roleGroup)
+                            return null;
+                        const ok = roleGroup.split('+').every((grantedRole) => roles?.includes(grantedRole));
+                        return ok ? roleGroup : null;
+                    })
+                        .filter((roleGroup) => roleGroup)
+                        .join('|');
+                    if (!action.grant)
+                        return;
+                }
+                if (!(entity.name in entities)) {
+                    entities[entity.name] = {
+                        name: entity.name,
+                        description: entity.description,
+                        storageName: entity.storageName ? entity.storageName : entity.name,
+                        fields: entity.fields,
+                        views: {},
+                    };
+                }
+                const actions = ((_a = entities[entity.name]).actions ?? (_a.actions = {}));
+                actions[actionName] ?? (actions[actionName] = []);
+                actions[actionName].push(action);
+            });
+        }
+        for (const viewName in entity.views) {
+            entity.views[viewName].forEach((view) => {
+                var _a;
+                if (!view.grant || !view.enabled)
+                    return;
+                const allow = roles?.indexOf('*') !== -1 || view.grant === '*';
+                if (!allow) {
+                    view.grant = view.grant
+                        .split('|')
+                        .map((roleGroup) => {
+                        if (!roleGroup)
+                            return null;
+                        const ok = roleGroup.split('+').every((grantedRole) => roles?.includes(grantedRole));
+                        return ok ? roleGroup : null;
+                    })
+                        .filter((roleGroup) => roleGroup)
+                        .join('|');
+                    if (!view.grant)
+                        return;
+                }
+                if (!(entity.name in entities)) {
+                    entities[entity.name] = {
+                        name: entity.name,
+                        description: entity.description,
+                        storageName: entity.storageName ? entity.storageName : entity.name,
+                        fields: entity.fields,
+                        actions: {},
+                        views: {},
+                    };
+                }
+                const views = ((_a = entities[entity.name]).views ?? (_a.views = {}));
+                views[viewName] ?? (views[viewName] = []);
+                views[viewName].push(view);
+            });
+        }
+        if (entity.name in entities) {
+            entities[entity.name].features = entity.features;
+        }
+    });
+    return entities;
+}
+export 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;
+}
+export function processTemplate(basePath, templatePath) {
+    const templateJsonContent = fs.readFileSync(path.join(basePath, templatePath)).toString();
+    const template = JSON.parse(templateJsonContent);
+    if (template && typeof template !== 'object') {
+        throw new TypeError(`Invalid template file ${templatePath}`);
+    }
+    const commands = template.steps;
+    if (!Array.isArray(commands)) {
+        throw new TypeError(`Invalid template file ${templatePath}`);
+    }
+    const variables = {};
+    commands.forEach((command) => processCommand(command, basePath, variables));
+    return variables;
+}
+function processCommand(command, basePath, variables) {
+    const commandName = command.command;
+    switch (commandName) {
+        case 'input':
+            processInputCommand(command, variables);
+            return;
+        case 'set':
+            processSetCommand(command, variables);
+            return;
+        case 'rename':
+            processRenameCommand(command, basePath, variables);
+            return;
+        case 'delete':
+            processDeleteCommand(command, basePath, variables);
+            return;
+        case 'replace':
+            processReplaceCommand(command, basePath, variables);
+            return;
+        default:
+            throw new Error(`Unknown command: ${commandName}`);
+    }
+}
+function processInputCommand(command, variables) {
+    const value = readlineSync.question(command.message ?? '');
+    if (command.validation) {
+        if (command.validation.required) {
+            if (value === '')
+                throw new TypeError(`${command.variable} is required`);
+        }
+        if (command.validation.pattern) {
+            if (!new RegExp(command.validation.pattern).test(value))
+                throw new Error(`${value} is not valid`);
+        }
+    }
+    variables[command.variable] = value;
+}
+function processSetCommand(command, variables) {
+    switch (command['function']) {
+        case 'New-GUID':
+            processSetNewGuidCommand(command.variable, variables);
+            break;
+        case 'New-RandomNumber':
+            processSetNewRandomNumberCommand(command.variable, variables, command.min, command.max);
+            break;
+        case 'New-RandomString':
+            processSetNewRandomStringCommand(command.variable, variables, command.length, command.characterPool);
+            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']}`);
+    }
+}
+function processSetNewGuidCommand(variable, variables) {
+    variables[variable] = 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'
+        .replace(/[xy]/g, (c) => {
+        const r = (Math.random() * 16) | 0;
+        const v = c == 'x' ? r : (r & 0x3) | 0x8;
+        return v.toString(16);
+    })
+        .toUpperCase();
+}
+function processSetNewRandomNumberCommand(variable, variables, min = 0, max = (1 << 30) * 4) {
+    variables[variable] = Math.floor(min + Math.random() * (max - min)).toString();
+}
+function processSetNewRandomStringCommand(variable, variables, length, characterPool = '1234567890qwertyuiopasdfghjklzxcvbnmQWERTYUIOPASDFGHJKLZXCVBNM') {
+    let result = '';
+    for (let i = 0; i < length; i++) {
+        result += characterPool.charAt(Math.floor(Math.random() * characterPool.length));
+    }
+    variables[variable] = result;
+}
+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) {
+    const regex = new RegExp(pattern, mode);
+    variables[variable] = variables[input].replace(regex, replacement);
+}
+function processRenameCommand(command, basePath, variables) {
+    const input = replaceVariables(command.input, variables);
+    const output = replaceVariables(command.output, variables);
+    fs.renameSync(path.join(basePath, input), path.join(basePath, output));
+}
+function processDeleteCommand(command, basePath, variables) {
+    const input = replaceVariables(command.input, variables);
+    const deletedPath = path.join(basePath, input);
+    if (fs.lstatSync(deletedPath).isDirectory()) {
+        fs.rmSync(deletedPath, { recursive: true, force: true });
+    }
+    else {
+        fs.rmSync(deletedPath, { force: true });
+    }
+}
+function processReplaceCommand(command, basePath, variables) {
+    const files = command.input;
+    const pattern = new RegExp(command.pattern ?? '', 'g');
+    const replacement = replaceVariables(command.replacement ?? '', variables);
+    files.forEach((file) => {
+        const filePath = replaceVariables(file, variables);
+        let content = fs.readFileSync(path.join(basePath, filePath)).toString();
+        content = content.replace(pattern, () => replacement);
+        fs.writeFileSync(path.join(basePath, filePath), content);
+    });
+}
+function replaceVariables(str, variables) {
+    return str.replace(/\$\{(\w+)\}/g, (_, varName) => variables[varName] ?? '');
+}
+export function logInfo(message, ...parameters) {
+    console.log(message, ...parameters);
+}
+export function logWarning(message, ...parameters) {
+    console.warn(message, ...parameters);
+}
+export function logError(message, ...parameters) {
+    console.error(message, ...parameters);
+}