mushroom-cli 1.2.3 → 1.2.5

package/README.md

@@ -132,6 +132,18 @@ npx mushroom-cli parameters --no-check-update
 
 ## Version
 
+### 1.2.5
+
+Improvement
+
+- gen ts-driver, js-driver: add anchors in generated code to make easier to modify code by update-ts
+
+### 1.2.4
+
+Improvement
+
+- gen docs: support to gen HTTP and cURL code snippets for `requestBodyType`: `Binary` and `FormData`
+
 ### 1.2.3
 
 Improvement

package/dist/common.js

@@ -282,3 +282,13 @@ export function logWarning(message, ...parameters) {
 export function logError(message, ...parameters) {
     console.error(message, ...parameters);
 }
+export function toVietnameseNonTongue(str) {
+    const signText = 'ăâđêôơưàảãạáằẳẵặắầẩẫậấèẻẽẹéềểễệếìỉĩịíòỏõọóồổỗộốờởỡợớùủũụúừửữựứỳỷỹỵýĂÂĐÐÊÔƠƯÀẢÃẠÁẰẲẴẶẮẦẨẪẬẤÈẺẼẸÉỀỂỄỆẾÌỈĨỊÍÒỎÕỌÓỒỔỖỘỐỜỞỠỢỚÙỦŨỤÚỪỬỮỰỨỲỶỸỴÝ';
+    const unsignedText = 'aadeoouaaaaaaaaaaaaaaaeeeeeeeeeeiiiiiooooooooooooooouuuuuuuuuuyyyyyAADDEOOUAAAAAAAAAAAAAAAEEEEEEEEEEIIIIIOOOOOOOOOOOOOOOUUUUUUUUUUYYYYY';
+    let returnValue = '';
+    for (let i = 0; i < str.length; i++) {
+        const index = signText.indexOf(str.charAt(i));
+        returnValue += index !== -1 ? unsignedText.charAt(index) : str.charAt(i);
+    }
+    return returnValue;
+}

package/dist/docs/docs.v2.html

@@ -4506,8 +4506,13 @@ API.get{{EntityName}}().deleteAsync(arg, count -> {
     const response = await mushroom.{{entityName}}.{{httpMethod}}Async({<span style="display: {{paramDisplay}}">
         params: {{paramModel:html}},</span><span style="display: {{bodyDisplay}}">
         body: {{bodyModel:html}}</span>
-    });
-    console.log("Kết quả trả về, response: %o", response);
+    });<span style="display: {{responseJsonDisplay}}">
+    console.log("Dữ liệu trả về, response: %o", response);
+    // Kết quả: response.result
+    // Metadata: response.meta</span><span style="display: {{responseBinaryDisplay}}">
+    const blob = response.resultAsBlob();
+    // Hoặc có thể dùng const text = response.resultAsText() để convert blob về string
+    // Lưu ý: dùng response.result sẽ bị lỗi nếu quá trình convert blob về string rồi parse JSON bị lỗi</span>
 } catch (error) {
     console.error("Có lỗi: %o", error);
 }</pre>
@@ -4547,7 +4552,7 @@ catch (Exception ex)
         Code tham khảo:
         <pre data-language="http">POST {{rootUrlPath}}{{entityName}}s/{{httpMethod}}{{queryString}} HTTP/1.1
 Host: <span class="domain">{{domain}}</span>
-Content-Type: application/json
+Content-Type: {{contentType}}
 X-HTTP-Method-Override: {{httpMethod}}<span style="display: {{tokenDisplay}}">
 Token: your token</span>
 
@@ -4558,17 +4563,24 @@ Token: your token</span>
     <div class="curl-snippet">
         cURL
         <pre data-language="cURL">curl -X POST \
-  '<span class="root-url">{{rootUrl}}</span>{{entityName}}s/{{httpMethod}}{{queryString}}' \
-  -H 'Content-Type: application/json' \
+  '<span class="root-url">{{rootUrl}}</span>{{entityName}}s/{{httpMethod}}{{queryString}}' \<span style="display: {{contentTypeDisplay}}">
+  -H 'Content-Type: {{contentType}}' \</span>
   -H 'X-HTTP-Method-Override: {{httpMethod}}' \<span style="display: {{tokenDisplay}}">
-  -H 'Token: {<span>{</span>TOKEN}}' \</span>
-  -d '{{bodyModel:html}}'</pre>
+  -H 'Token: {<span>{</span>TOKEN}}' \</span><span style="display: {{bodyDisplay}}">
+  -d '{{bodyModel:html}}'</span><span style="display: {{formDataDisplay}}">
+  -F "field=value" \
+  -F "file=@/path/to/file.ext"</span><span style="display: {{binaryDisplay}}">
+  -T "/path/to/file.ext"</span></pre>
         Shell
         <pre data-language="cURL">curl --request POST \
-  --url '<span class="root-url">{{rootUrl}}</span>{{entityName}}s/{{httpMethod}}{{queryString}}' \
+  --url '<span class="root-url">{{rootUrl}}</span>{{entityName}}s/{{httpMethod}}{{queryString}}' \<span style="display: {{contentTypeDisplay}}">
+  --header 'Content-Type: {{contentType}}' \</span>
   --header 'X-HTTP-Method-Override: {{httpMethod}}' \<span style="display: {{tokenDisplay}}">
-  --header 'Token: {<span>{</span>TOKEN}}' \</span>
-  --data '{{bodyModel:html}}'</pre>
+  --header 'Token: {<span>{</span>TOKEN}}' \</span><span style="display: {{bodyDisplay}}">
+  --data '{{bodyModel:html}}'</span><span style="display: {{formDataDisplay}}">
+  --form "field=value" \
+  --form "file=@/path/to/file.ext"</span><span style="display: {{binaryDisplay}}">
+  --data-binary "@/path/to/file.ext"</span></pre>
     </div>
 </script>
 <div class="mushroom-docs-template" id="template-codeSnippets-generalAction-Java">

package/dist/docs/docs.v2.js

@@ -1626,10 +1626,14 @@ window.codeSnippets = {
       renderTemplate('template-codeSnippets-generalAction-Javascript', {
         entityName: args.entityName,
         httpMethod: getHttpMethod(args.actionName),
+        requestBodyType: args.action?.codeHint?.delegator?.requestBodyType,
         paramDisplay: args.action?.codeHint?.delegator?.param?.fields ? 'inline' : 'none',
-        bodyDisplay: args.action?.codeHint?.delegator?.requestBody?.fields ? 'inline' : 'none',
-        paramModel: formatHintModel(args.action.codeHint?.delegator?.param?.fields, '        ', { mode: 'model' }).trim(),
-        bodyModel: formatHintModel(args.action.codeHint?.delegator?.requestBody?.fields, '        ', { mode: 'model' }).trim(),
+        bodyDisplay: (!args.action?.codeHint?.delegator?.requestBodyType || args.action?.codeHint?.delegator?.requestBodyType === 'JSON') && args.action?.codeHint?.delegator?.requestBody?.fields || args.action?.codeHint?.delegator?.requestBodyType === 'Binary' || args.action?.codeHint?.delegator?.requestBodyType === 'FormData' ? 'inline' : 'none',
+        paramModel: formatHintModel(args.action?.codeHint?.delegator?.param?.fields, '        ', { mode: 'model' }).trim(),
+        bodyModel: args.action?.codeHint?.delegator?.requestBodyType === 'Binary' ? 'file' : args.action?.codeHint?.delegator?.requestBodyType === 'FormData' ? 'formData' : formatHintModel(args.action?.codeHint?.delegator?.requestBody?.fields, '        ', { mode: 'model' }).trim(),
+        isBinaryResponse: args.action?.codeHint?.delegator?.isBinaryResponse,
+        responseBinaryDisplay: args.action?.codeHint?.delegator?.isBinaryResponse ? 'block' : 'none',
+        responseJsonDisplay: args.action?.codeHint?.delegator?.isBinaryResponse ? 'none' : 'block',
       }),
     JavascriptParamModel: (args) =>
       args.action?.codeHint?.delegator?.param?.fields
@@ -1648,7 +1652,7 @@ window.codeSnippets = {
           })
         : '',
     JavascriptResultModel: (args) =>
-      args.action?.codeHint?.delegator?.result?.fields
+      args.action?.codeHint?.delegator?.result?.fields && !args.action?.codeHint?.delegator?.isBinaryResponse
         ? renderTemplate('template-codeSnippets-generalAction-JavascriptModel', {
             undefinedModel: formatHintModel(args.action.codeHint.delegator.result.fields, undefined, { mode: 'model_undefined' }),
             valueModel: formatHintModel(args.action.codeHint.delegator.result.fields, undefined, { mode: 'model' }),
@@ -1668,7 +1672,8 @@ window.codeSnippets = {
         entityName: args.entityName,
         queryString: genQueryString(args.action.codeHint?.delegator?.param),
         httpMethod: getHttpMethod(args.actionName),
-        bodyModel: formatHintModel(args.action.codeHint?.delegator?.requestBody?.fields, undefined, { mode: 'model', hideComment: true }),
+        contentType: args.action?.codeHint?.delegator?.requestBodyType === 'Binary' ? 'octet/stream' : args.action?.codeHint?.delegator?.requestBodyType === 'FormData' ? 'multipart/form-data' : 'application/json',
+        bodyModel: args.action?.codeHint?.delegator?.requestBodyType === 'Binary' ? 'BINARY' : args.action?.codeHint?.delegator?.requestBodyType === 'FormData' ? 'FORMDATA' : formatHintModel(args.action.codeHint?.delegator?.requestBody?.fields, undefined, { mode: 'model', hideComment: true }),
         tokenDisplay: args.action.grant !== '*' ? 'inline' : 'none',
       }),
     cURL: (args) =>
@@ -1677,7 +1682,12 @@ window.codeSnippets = {
         entityName: args.entityName,
         queryString: genQueryString(args.action.codeHint?.delegator?.param),
         httpMethod: getHttpMethod(args.actionName),
+        contentType: args.action?.codeHint?.delegator?.requestBodyType === 'Binary' ? 'octet/stream' : args.action?.codeHint?.delegator?.requestBodyType === 'FormData' ? '' : 'application/json',
+        contentTypeDisplay: args.action?.codeHint?.delegator?.requestBodyType === 'FormData' ? 'none' : 'inline',
+        formDataDisplay: args.action?.codeHint?.delegator?.requestBodyType === 'FormData' ? 'inline' : 'none',
+        binaryDisplay: args.action?.codeHint?.delegator?.requestBodyType === 'Binary' ? 'inline' : 'none',
         bodyModel: formatHintModel(args.action.codeHint?.delegator?.requestBody?.fields, undefined, { mode: 'model', hideComment: true }),
+        bodyDisplay: !args.action?.codeHint?.delegator?.requestBodyType || args.action?.codeHint?.delegator?.requestBodyType === 'JSON' ? 'inline' : 'none',
         tokenDisplay: args.action.grant !== '*' ? 'inline' : 'none',
       }),
     Java: (args) =>

package/dist/gen/gen-api-docs.js

@@ -48,7 +48,7 @@ const entityFeatureWhitelist = ['vn_text'];
 const vnTextWhitelist = ['fields', 'channels'];
 const vnTextChannelWhitelist = ['fields', 'name'];
 const actionCodeHintWhitelist = ['delegator'];
-const actionCodeHintDelegatorWhitelist = ['param', 'requestBody', 'result'];
+const actionCodeHintDelegatorWhitelist = ['param', 'requestBodyType', 'requestBody', 'result', 'isBinaryResponse'];
 const fieldsOnlyWhitelist = ['fields'];
 const viewWhitelist = ['grant', 'deny', 'description', 'parameters', 'emptyResult', 'codeHint'];
 const viewCodeHintWhitelist = ['output'];
@@ -287,7 +287,7 @@ export default async function genDocs(args, projectName, project, alias, source)
         info: {
             name: source.name,
             rootUrl: source.codeHint?.rootUrl ?? source.rootUrl,
-            description: source.description,
+            description: source.description ?? '',
             security: source.security === undefined
                 ? undefined
                 : {

package/dist/gen/gen-csharp.js

@@ -23,20 +23,10 @@ function singleLine(str) {
         return '';
     return str.replace(/\r/g, '').replace(/\n/g, '<br/>');
 }
-function toVietnameseNonTongue(str) {
-    const signText = 'ăâđêôơưàảãạáằẳẵặắầẩẫậấèẻẽẹéềểễệếìỉĩịíòỏõọóồổỗộốờởỡợớùủũụúừửữựứỳỷỹỵýĂÂĐÐÊÔƠƯÀẢÃẠÁẰẲẴẶẮẦẨẪẬẤÈẺẼẸÉỀỂỄỆẾÌỈĨỊÍÒỎÕỌÓỒỔỖỘỐỜỞỠỢỚÙỦŨỤÚỪỬỮỰỨỲỶỸỴÝ';
-    const unsignedText = 'aadeoouaaaaaaaaaaaaaaaeeeeeeeeeeiiiiiooooooooooooooouuuuuuuuuuyyyyyAADDEOOUAAAAAAAAAAAAAAAEEEEEEEEEEIIIIIOOOOOOOOOOOOOOOUUUUUUUUUUYYYYY';
-    let returnValue = '';
-    for (let i = 0; i < str.length; i++) {
-        const index = signText.indexOf(str.charAt(i));
-        returnValue += index !== -1 ? unsignedText.charAt(index) : str.charAt(i);
-    }
-    return returnValue;
-}
 function toCSharpName(str) {
     if (!str)
         return '_';
-    const name = toVietnameseNonTongue(str).replace(/\W/g, '_');
+    const name = common.toVietnameseNonTongue(str).replace(/\W/g, '_');
     const c = name.charAt(0);
     return ('0' <= c && c <= '9' ? '_' : '') + c.toUpperCase() + name.substring(1);
 }

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

@@ -23,9 +23,9 @@ export function genJavascriptDriverString(aliasProject, source) {
         return '';
     }
     const entities = common.getEntities(source, aliasProject.allowRoles);
-    const extensionsImportLines = [];
-    const extensionsExportLines = [];
-    const extensionsCodeLines = [];
+    const extensionsImportLines = ['/* import all mushroom extensions */'];
+    const extensionsExportLines = ['/* export all mushroom extensions */'];
+    const extensionsCodeLines = ['/* using all mushroom extensions */'];
     if (Array.isArray(aliasProject.features)) {
         if (aliasProject.features.includes('auth')) {
             extensionsImportLines.push('//import * as AuthExtension from "mushroomjs-auth";');
@@ -94,7 +94,7 @@ exports.extensions = extensions;
         for (const viewName in entity.views) {
             views[viewName] = {};
         }
-        code += `defineAsyncResource({name:${JSON.stringify(entityName)},actions:${JSON.stringify(actions)},views:${JSON.stringify(views)}});
+        code += `defineAsyncResource({name:${JSON.stringify(entityName)},actions:${JSON.stringify(actions)},views:${JSON.stringify(views)}}, mushroom);
 `;
     }
     code += `

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

@@ -17,24 +17,14 @@ function isAllowCache(actions, defaultValue) {
     }
     return result;
 }
-function toVietnameseNonTongue(str) {
-    const signText = 'ăâđêôơưàảãạáằẳẵặắầẩẫậấèẻẽẹéềểễệếìỉĩịíòỏõọóồổỗộốờởỡợớùủũụúừửữựứỳỷỹỵýĂÂĐÐÊÔƠƯÀẢÃẠÁẰẲẴẶẮẦẨẪẬẤÈẺẼẸÉỀỂỄỆẾÌỈĨỊÍÒỎÕỌÓỒỔỖỘỐỜỞỠỢỚÙỦŨỤÚỪỬỮỰỨỲỶỸỴÝ';
-    const unsignedText = 'aadeoouaaaaaaaaaaaaaaaeeeeeeeeeeiiiiiooooooooooooooouuuuuuuuuuyyyyyAADDEOOUAAAAAAAAAAAAAAAEEEEEEEEEEIIIIIOOOOOOOOOOOOOOOUUUUUUUUUUYYYYY';
-    let returnValue = '';
-    for (let i = 0; i < str.length; i++) {
-        const index = signText.indexOf(str.charAt(i));
-        returnValue += index !== -1 ? unsignedText.charAt(index) : str.charAt(i);
-    }
-    return returnValue;
-}
 function toTypeScriptClassName(str) {
     if (!str)
         return '_';
-    const name = toVietnameseNonTongue(str).replace(/\W/g, '_');
+    const name = common.toVietnameseNonTongue(str).replace(/\W/g, '_');
     const c = name.charAt(0);
     return ('0' <= c && c <= '9' ? '_' : '') + c.toUpperCase() + name.substring(1);
 }
-function getCSharpTypeFromMushroomType(type) {
+function getTypescriptTypeFromMushroomType(type) {
     switch (type) {
         case 'string':
             return 'string';
@@ -102,11 +92,11 @@ function generateTypescriptClass(objectDefination, className, options) {
                     childrenCode += generateTypescriptClass(field.values.items.fields ?? {}, fieldClassName, options);
                 }
                 else {
-                    code += `    ${fieldName}${optionalMark}: Record<string, Array<${getCSharpTypeFromMushroomType(field.values.items?.type ?? 'string')}${itemNullType}>${valueNullType}>${nullType};\n`;
+                    code += `    ${fieldName}${optionalMark}: Record<string, Array<${getTypescriptTypeFromMushroomType(field.values.items?.type ?? 'string')}${itemNullType}>${valueNullType}>${nullType};\n`;
                 }
             }
             else {
-                code += `    ${fieldName}${optionalMark}: Record<string, ${getCSharpTypeFromMushroomType(field.values?.type ?? 'string')}${valueNullType}>${nullType};\n`;
+                code += `    ${fieldName}${optionalMark}: Record<string, ${getTypescriptTypeFromMushroomType(field.values?.type ?? 'string')}${valueNullType}>${nullType};\n`;
             }
         }
         else if (field.type == 'array') {
@@ -131,15 +121,15 @@ function generateTypescriptClass(objectDefination, className, options) {
                     childrenCode += generateTypescriptClass(field.items.values.fields ?? {}, fieldClassName, options);
                 }
                 else {
-                    code += `    ${fieldName}${optionalMark}: Array<Record<string, ${getCSharpTypeFromMushroomType(field.items.type ?? 'string')}${valueNullType}>${itemNullType}>${nullType};\n`;
+                    code += `    ${fieldName}${optionalMark}: Array<Record<string, ${getTypescriptTypeFromMushroomType(field.items.type ?? 'string')}${valueNullType}>${itemNullType}>${nullType};\n`;
                 }
             }
             else {
-                code += `    ${fieldName}${optionalMark}: Array<${getCSharpTypeFromMushroomType(field.items?.type ?? 'string')}${itemNullType}>${nullType};\n`;
+                code += `    ${fieldName}${optionalMark}: Array<${getTypescriptTypeFromMushroomType(field.items?.type ?? 'string')}${itemNullType}>${nullType};\n`;
             }
         }
         else {
-            code += `    ${fieldName}${optionalMark}: ${getCSharpTypeFromMushroomType(field.type ?? 'string')}${nullType};\n`;
+            code += `    ${fieldName}${optionalMark}: ${getTypescriptTypeFromMushroomType(field.type ?? 'string')}${nullType};\n`;
         }
     }
     code += '}\n\n';
@@ -149,7 +139,7 @@ function generateTypescriptClassFromViewParameters(parameters) {
     if (Array.isArray(parameters)) {
         return ('{\n' +
             parameters
-                .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'};`)
+                .map((p) => `${generateDescription(p.description)}    ${p.field}${p.validation?.required && p.defaultValue === undefined ? '' : '?'}: ${getTypescriptTypeFromMushroomType(p.type || 'string')}${p.isArray ? '[]' : ''}${p.validation?.required && p.defaultValue === undefined ? '' : ' | null'};`)
                 .join('\n') +
             '\n}');
     }
@@ -186,7 +176,7 @@ function generateTopCustomClass(config, entityName, methodName, grantRole, postf
         }
     }
     else
-        inputClassName = getCSharpTypeFromMushroomType(type);
+        inputClassName = getTypescriptTypeFromMushroomType(type);
     return isKeyValue
         ? isArray
             ? 'Record<string, ' + inputClassName + '[]>'
@@ -241,10 +231,10 @@ export function genTypescriptDriverString(aliasProject, source) {
         return '';
     }
     const entities = common.getEntities(source, aliasProject.allowRoles);
-    const extensionsImportLines = [];
-    const extensionsExportLines = [];
-    const extensionsTypes = [];
-    const extensionsCodeLines = [];
+    const extensionsImportLines = ['/* import all mushroom extensions */'];
+    const extensionsExportLines = ['/* export all mushroom extensions */'];
+    const extensionsTypes = ['/* all mushroom extensions types */'];
+    const extensionsCodeLines = ['/* using all mushroom extensions */'];
     if (Array.isArray(aliasProject.features)) {
         if (aliasProject.features.includes('auth')) {
             extensionsImportLines.push('import * as AuthExtension from "mushroomjs-auth";');
@@ -404,7 +394,7 @@ export interface CustomMethodBodyRequest<TBody> extends MushroomRequest {
         }
         iApiClassBody += `,
 `;
-        code += `defineAsyncResource<${typescriptClassName}>(${JSON.stringify({ name: entityName, actions: actions, views: views })});
+        code += `defineAsyncResource<${typescriptClassName}>(${JSON.stringify({ name: entityName, actions: actions, views: views })}, mushroom);
 
 `;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mushroom-cli",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "description": "Mushroom CLI",
   "main": "dist/mr.js",
   "type": "module",
@@ -33,9 +33,9 @@
   "author": "suco2007",
   "license": "ISC",
   "dependencies": {
-    "jsdom": "^27.4.0",
+    "jsdom": "^29.0.2",
     "json5": "^2.2.3",
-    "minify": "^14.1.0",
+    "minify": "^15.2.1",
     "node-fetch": "^3.3.2",
     "open": "^11.0.0",
     "readline-sync": "^1.4.10",