mushroom-cli 1.2.0-alpha.19 → 1.2.0-alpha.20

package/README.md

@@ -132,6 +132,20 @@ npx mushroom-cli parameters --no-check-update
 
 ## Version
 
+### 1.2.0-alpha.20
+
+Improvement:
+
+- gen-ts:
+  - generate description for fields in view
+- gen-docs
+  - curl of custom method is missing header X-HTTP-Method-Override
+
+Fixed bugs:
+
+- gen csharp:
+  - wrong version in Info.cs
+
 ### 1.2.0-alpha.19
 
 Improvement:

package/dist/common.js

@@ -1,6 +1,19 @@
 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) {

package/dist/docs/docs.v2.html

@@ -4427,6 +4427,7 @@ catch (Exception ex)
         <pre data-language="http">{{httpMethod}} {{rootUrlPath}}{{entityName}}s/{{httpMethod}}<span class="place-holder">?param1=value1&amp;param2=value2</span> HTTP/1.1
 Host: <span class="domain">{{domain}}</span>
 Content-Type: application/json<span style="display: {{tokenDisplay}}">
+X-HTTP-Method-Override: {{httpMethod}}
 Token: your token</span>
 
 <span class="place-holder">BODY DATA</span></pre>
@@ -4444,8 +4445,7 @@ GET {{rootUrlPath}}{{entityName}}s/{{httpMethod}}<span class="place-holder">?par
 Host: <span class="domain">{{domain}}</span>
 Content-Type: application/json
 X-HTTP-Method-Override: {{httpMethod}}<span style="display: {{tokenDisplay}}">
-Token: your token</span></span>
-</pre>
+Token: your token</span></span></pre>
     </div>
 </script>
 <script type="text/mushroom-docs-template" class="mushroom-docs-template" id="template-codeSnippets-generalAction-cURL">
@@ -4453,13 +4453,15 @@ Token: your token</span></span>
         cURL
         <pre data-language="cURL">curl -X {{httpMethod}} \
   '<span class="root-url">{{rootUrl}}</span>{{entityName}}s/{{httpMethod}}<span class="place-holder">?param1=value1&amp;param2=value2</span>' \
-  -H 'Content-Type: application/json' \ <span style="display: {{tokenDisplay}}">
+  -H 'Content-Type: application/json' \
+  -H 'X-HTTP-Method-Override: {{httpMethod}}' \<span style="display: {{tokenDisplay}}">
   -H 'Token: {<span>{</span>TOKEN}}' \</span>
   -d 'BODY DATA IF ANY'
 </pre>
         Shell
         <pre data-language="cURL">curl --request {{httpMethod}} \
-  --url '<span class="root-url">{{rootUrl}}</span>{{entityName}}s/{{httpMethod}}<span class="place-holder">?param1=value1&amp;param2=value2</span>' \<span style="display: {{tokenDisplay}}">
+  --url '<span class="root-url">{{rootUrl}}</span>{{entityName}}s/{{httpMethod}}<span class="place-holder">?param1=value1&amp;param2=value2</span>' \
+  --header 'X-HTTP-Method-Override: {{httpMethod}}' \<span style="display: {{tokenDisplay}}">
   --header 'Token: {<span>{</span>TOKEN}}' \</span>
   --data 'BODY DATA IF ANY'</pre>
     </div>

package/dist/gen/gen-csharp.js

@@ -1,20 +1,6 @@
 import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
 import * as common from '../common.js';
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-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>';
-    }
-}
-const packageVersion = getPackageVersion();
+const packageVersion = common.getPackageVersion();
 const newLine = '\n';
 const header = `// NOTE: Please do not modify this file
 // NOTE: Version and compatibility information: please see in Info.cs file

package/dist/gen/gen-js-driver-tarball.js

@@ -1,23 +1,10 @@
 import fs from 'fs';
 import path from 'path';
-import { fileURLToPath } from 'url';
 import targz from 'targz';
 import * as common from '../common.js';
 import * as javascriptDriverGenerator from './gen-js-driver.js';
 import * as typescriptDriverGenerator from './gen-ts-driver.js';
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-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>';
-    }
-}
-const packageVersion = getPackageVersion();
+const packageVersion = common.getPackageVersion();
 function compressAsync(src, dest, folderName) {
     return new Promise((resolve, reject) => {
         const options = {

package/dist/gen/gen-ts-driver.js

@@ -53,6 +53,15 @@ function getCSharpTypeFromMushroomType(type) {
             return 'any';
     }
 }
+function generateDescription(description, ident = '    ') {
+    if (!description)
+        return '';
+    return `${ident}/**\n${ident} * ${description
+        .replace(/\r/g, '')
+        .split('\n')
+        .map((line) => (line.includes('*/') ? line.replace(/\*\//g, '* /') : line))
+        .join('\n' + ident + ' * ')}\n${ident} */\n`;
+}
 function generateTypescriptClass(objectDefination, className, options) {
     let childrenCode = '';
     let code = `export interface ${className} {\n`;
@@ -60,10 +69,11 @@ function generateTypescriptClass(objectDefination, className, options) {
         const field = objectDefination[fieldName];
         if (!field)
             continue;
-        if (field.description) {
-            code += `    /**\n     * ${field.description.replace(/\r/, '').split('\n').map(line => line.includes('*/') ? line.replace(/\*\//g, "* /") : line).join('\n     * ')}\n     */\n`;
-        }
-        const optionalMark = options?.checkRequired && (field.required || field.validation?.required) ? '' : '?';
+        code += generateDescription(field.description);
+        const optionalMark = options?.checkRequired &&
+            (field.required || field.validation?.required)
+            ? ''
+            : '?';
         const nullType = optionalMark ? ' | null' : '';
         if (field.type == 'object') {
             const fieldClassName = className + '_' + toTypeScriptClassName(fieldName);
@@ -71,14 +81,21 @@ function generateTypescriptClass(objectDefination, className, options) {
             childrenCode += generateTypescriptClass(field.fields ?? {}, fieldClassName, options);
         }
         else if (field.type == 'keyValue') {
-            const valueNullType = options?.checkRequired && (field.values.required || field.values.validation?.required) ? '' : ' | null | undefined';
+            const valueNullType = options?.checkRequired &&
+                (field.values.required || field.values.validation?.required)
+                ? ''
+                : ' | null | undefined';
             if (field.values?.type == 'object') {
                 const fieldClassName = className + '_' + toTypeScriptClassName(fieldName);
                 code += `    ${fieldName}${optionalMark}: Record<string, ${fieldClassName}${valueNullType}>${nullType};\n`;
                 childrenCode += generateTypescriptClass(field.values.fields ?? {}, fieldClassName, options);
             }
             else if (field.values?.type == 'array') {
-                const itemNullType = options?.checkRequired && (field.values.items?.required || field.values.items?.validation?.required) ? '' : ' | null | undefined';
+                const itemNullType = options?.checkRequired &&
+                    (field.values.items?.required ||
+                        field.values.items?.validation?.required)
+                    ? ''
+                    : ' | null | undefined';
                 if (field.values.items?.type == 'object') {
                     const fieldClassName = className + '_' + toTypeScriptClassName(fieldName);
                     code += `    ${fieldName}${optionalMark}: Record<string, Array<${fieldClassName}${itemNullType}>${valueNullType}>${nullType};\n`;
@@ -93,14 +110,21 @@ function generateTypescriptClass(objectDefination, className, options) {
             }
         }
         else if (field.type == 'array') {
-            const itemNullType = options?.checkRequired && (field.items.required || field.items.validation?.required) ? '' : ' | null | undefined';
+            const itemNullType = options?.checkRequired &&
+                (field.items.required || field.items.validation?.required)
+                ? ''
+                : ' | null | undefined';
             if (field.items?.type == 'object') {
                 const fieldClassName = className + '_' + toTypeScriptClassName(fieldName);
                 code += `    ${fieldName}${optionalMark}: Array<${fieldClassName}${itemNullType}>${nullType};\n`;
                 childrenCode += generateTypescriptClass(field.items.fields ?? {}, fieldClassName, options);
             }
             else if (field.items?.type == 'keyValue') {
-                const valueNullType = options?.checkRequired && (field.items.values?.required || field.items.values?.validation?.required) ? '' : ' | null | undefined';
+                const valueNullType = options?.checkRequired &&
+                    (field.items.values?.required ||
+                        field.items.values?.validation?.required)
+                    ? ''
+                    : ' | null | undefined';
                 if (field.items.values?.type == 'object') {
                     const fieldClassName = className + '_' + toTypeScriptClassName(fieldName);
                     code += `    ${fieldName}${optionalMark}: Array<Record<string, ${fieldClassName}${valueNullType}>${itemNullType}>${nullType};\n`;
@@ -125,7 +149,7 @@ function generateTypescriptClassFromViewParameters(parameters) {
     if (Array.isArray(parameters)) {
         return ('{\n' +
             parameters
-                .map((p) => `    ${p.field}${p.validation?.required && p.defaultValue === undefined ? '' : '?'}: ${getCSharpTypeFromMushroomType(p.type || 'string')}${p.isArray ? '[]' : ''}${p.validation?.required && p.defaultValue === undefined ? '' : ' | null'};`)
+                .map((p) => `${generateDescription(p.description)}    ${p.field}${p.validation?.required && p.defaultValue === undefined ? '' : '?'}: ${getCSharpTypeFromMushroomType(p.type || 'string')}${p.isArray ? '[]' : ''}${p.validation?.required && p.defaultValue === undefined ? '' : ' | null'};`)
                 .join('\n') +
             '\n}');
     }
@@ -134,15 +158,27 @@ function generateTypescriptClassFromViewParameters(parameters) {
 function generateTopCustomClass(config, entityName, methodName, grantRole, postfix, code) {
     const isKeyValue = config.type == 'keyValue';
     const isArray = isKeyValue ? config.values?.type == 'array' : config.type == 'array';
-    const fields = isKeyValue ? (isArray ? config.values?.items?.fields : config.values?.fields) : (isArray ? config.items?.fields : config.fields);
-    const type = (isKeyValue ? (isArray ? config.values?.items?.type : config.values?.type) : (isArray ? config.items?.type : config.type)) ?? 'string';
+    const fields = isKeyValue
+        ? isArray
+            ? config.values?.items?.fields
+            : config.values?.fields
+        : isArray
+            ? config.items?.fields
+            : config.fields;
+    const type = (isKeyValue
+        ? isArray
+            ? config.values?.items?.type
+            : config.values?.type
+        : isArray
+            ? config.items?.type
+            : config.type) ?? 'string';
     let inputClassName;
     if (type == 'object') {
         if (fields) {
             const roleIndicator = grantRole ? '_' + toTypeScriptClassName(grantRole) + '_' : '';
             inputClassName = `${toTypeScriptClassName(entityName)}_${toTypeScriptClassName(methodName)}${roleIndicator}${postfix}`;
             code.classesCode += generateTypescriptClass(fields, inputClassName, {
-                checkRequired: true
+                checkRequired: true,
             });
         }
         else {
@@ -151,19 +187,25 @@ function generateTopCustomClass(config, entityName, methodName, grantRole, postf
     }
     else
         inputClassName = getCSharpTypeFromMushroomType(type);
-    return isKeyValue ? (isArray ? 'Record<string, ' + inputClassName + '[]>' : 'Record<string, ' + inputClassName + '>') : (isArray ? inputClassName + '[]' : inputClassName);
+    return isKeyValue
+        ? isArray
+            ? 'Record<string, ' + inputClassName + '[]>'
+            : 'Record<string, ' + inputClassName + '>'
+        : isArray
+            ? inputClassName + '[]'
+            : inputClassName;
 }
 function generateCustomMethodCode(entityName, actionName, actions) {
     const result = { classesCode: '', methodCode: '' };
     if (!actionName || !actionName.startsWith('_raw_http_method_') || !actions || !actions.length)
         return result;
-    actions = actions.filter(action => action.enabled);
+    actions = actions.filter((action) => action.enabled);
     if (!actions.length)
         return result;
     const methodName = actionName.substring('_raw_http_method_'.length);
-    let inputTypes = new Set();
-    let outputTypes = new Set();
-    actions.forEach(action => {
+    const inputTypes = new Set();
+    const outputTypes = new Set();
+    actions.forEach((action) => {
         const codeHintDelegator = action?.codeHint?.delegator;
         if (!codeHintDelegator)
             return;
@@ -175,7 +217,7 @@ function generateCustomMethodCode(entityName, actionName, actions) {
             outputTypes.add('any');
         }
         if (codeHintDelegator.param && codeHintDelegator.requestBody) {
-            let paramClassName = generateTopCustomClass(codeHintDelegator.param, entityName, methodName, actions.length > 1 ? action.grant : '', 'ParamRequest', result);
+            const paramClassName = generateTopCustomClass(codeHintDelegator.param, entityName, methodName, actions.length > 1 ? action.grant : '', 'ParamRequest', result);
             const bodyClassName = generateTopCustomClass(codeHintDelegator.requestBody, entityName, methodName, actions.length > 1 ? action.grant : '', 'Request', result);
             inputTypes.add(`CustomMethodRequest<${paramClassName}, ${bodyClassName}>`);
         }
@@ -247,9 +289,7 @@ export interface CustomMethodBodyRequest<TBody> extends MushroomRequest {
         const typescriptClassName = toTypeScriptClassName(entityName);
         code += generateTypescriptClass(entity.fields, typescriptClassName);
         const actions = {};
-        if (entity.description) {
-            iApiClassBody += `    /**\n     * ${entity.description.replace(/\r/, '').split('\n').map(line => line.includes('*/') ? line.replace(/\*\//g, "* /") : line).join('\n     * ')}\n     */\n`;
-        }
+        iApiClassBody += generateDescription(entity.description);
         iApiClassBody += `    ${entityName}: MushroomResourceBase`;
         let customMethodCode = '';
         for (const actionName in entity.actions) {

package/dist/mr.js

@@ -1,7 +1,4 @@
 #!/usr/bin/env node
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
 import * as common from './common.js';
 import init from './init.js';
 import config from './config.js';
@@ -10,19 +7,7 @@ import merge from './merge.js';
 import update from './update.js';
 import help from './help.js';
 import checkUpdate from './check-update.js';
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-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>';
-    }
-}
-const packageVersion = getPackageVersion();
+const packageVersion = common.getPackageVersion();
 const versionGroup = packageVersion.match(/([^-]+)(-(\w+).*)?/);
 const currentDistTag = versionGroup?.[3] ? versionGroup[3] : 'latest';
 common.logInfo('Mushroom CLI version', packageVersion);

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "mushroom-cli",
-  "version": "1.2.0-alpha.19",
+  "version": "1.2.0-alpha.20",
   "description": "Mushroom CLI",
   "main": "dist/mr.js",
   "type": "module",
   "scripts": {
     "build": "tsc && copyfiles -u 2 ./src/docs/* ./dist/docs/",
-    "format": "prettier --write **/*",
+    "format": "prettier --write --ignore-unknown **/*",
     "lint": "eslint ./src/**/*.ts",
     "release": "npm run build && npm publish --access public --tag alpha",
     "preinstall": "npx only-allow npm",