mushroom-cli 1.2.2 → 1.2.4

package/README.md

@@ -132,6 +132,18 @@ npx mushroom-cli parameters --no-check-update
 
 ## Version
 
+### 1.2.4
+
+Improvement
+
+- gen docs: support to gen HTTP and cURL code snippets for `requestBodyType`: `Binary` and `FormData`
+
+### 1.2.3
+
+Improvement
+
+- gen ts-driver: separate `import` and `import type` when import mushroomjs
+
 ### 1.2.2
 
 New features:
@@ -143,7 +155,7 @@ New features:
 Improvement/Changes:
 
 - gen docs: fix bugs
-- gen c#-mongo: fix signarute for RegisterCustomViewMethod method
+- gen c#-mongo: fix signature for RegisterCustomViewMethod method
 - init netcore:
   - change: show warning message when replacing content in unexisting file (instead of throwing error)
 

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'];

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

@@ -259,7 +259,8 @@ export function genTypescriptDriverString(aliasProject, source) {
             extensionsCodeLines.push('FileExtension.useFile(mushroom);');
         }
     }
-    let code = `import mushroom, { defineAsyncResource, defineAsyncView, fireEvent, createRestfulAsyncFunction, IdType, IMushroom, Mushroom, MushroomRequest, MushroomRequestSetting, MushroomRestfulRequest, MushroomResponse, MushroomResponseDataType, MushroomResourceBase, MushroomListResource, MushroomCountResource, MushroomFindByIdResource, MushroomCreateResource, MushroomBatchCreateResource, MushroomUpdateResource, MushroomBatchUpdateResource, MushroomPartialUpdateResource, MushroomDeleteResource, MushroomBatchDeleteResource, MushroomExtensibleResource, MushroomViewFunction, MushroomError, IMushroomOfflineResponse, MushroomOfflineResponse, MushroomOfflineResponseState } from "mushroomjs";
+    let code = `import mushroom, { defineAsyncResource, defineAsyncView, fireEvent, createRestfulAsyncFunction, Mushroom, MushroomError } from "mushroomjs";
+import type { IdType, IMushroom, MushroomRequest, MushroomRequestSetting, MushroomRestfulRequest, MushroomResponse, MushroomResponseDataType, MushroomResourceBase, MushroomListResource, MushroomCountResource, MushroomFindByIdResource, MushroomCreateResource, MushroomBatchCreateResource, MushroomUpdateResource, MushroomBatchUpdateResource, MushroomPartialUpdateResource, MushroomDeleteResource, MushroomBatchDeleteResource, MushroomExtensibleResource, MushroomViewFunction, IMushroomOfflineResponse, MushroomOfflineResponse, MushroomOfflineResponseState } from "mushroomjs";
 ${extensionsImportLines.join('\n')}
 export * from "mushroomjs";
 export const extensions = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mushroom-cli",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "Mushroom CLI",
   "main": "dist/mr.js",
   "type": "module",
@@ -33,30 +33,30 @@
   "author": "suco2007",
   "license": "ISC",
   "dependencies": {
-    "jsdom": "^26.1.0",
+    "jsdom": "^28.1.0",
     "json5": "^2.2.3",
-    "minify": "^14.0.0",
+    "minify": "^15.0.1",
     "node-fetch": "^3.3.2",
-    "open": "^10.1.2",
+    "open": "^11.0.0",
     "readline-sync": "^1.4.10",
     "targz": "^1.0.1"
   },
   "devDependencies": {
-    "@eslint/js": "^9.34.0",
-    "@types/jsdom": "^21.1.7",
+    "@eslint/js": "^9.39.2",
+    "@types/jsdom": "^27.0.0",
     "@types/minify": "^9.1.4",
     "@types/node": "^22.15.29",
     "@types/node-fetch": "^2.6.13",
     "@types/readline-sync": "^1.4.8",
     "@types/targz": "^1.0.5",
     "copyfiles": "^2.4.1",
-    "eslint": "^9.34.0",
+    "eslint": "^9.39.2",
     "husky": "^9.1.7",
-    "lint-staged": "^16.1.0",
-    "only-allow": "^1.2.1",
-    "prettier": "^3.5.3",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.41.0"
+    "lint-staged": "^16.2.7",
+    "only-allow": "^1.2.2",
+    "prettier": "^3.7.4",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.51.0"
   },
   "engines": {
     "node": ">=14.0.0"