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

package/README.md

@@ -132,6 +132,13 @@ npx mushroom-cli parameters --no-check-update
 
 ## Version
 
+### 1.2.0-alpha.21
+
+Improvement:
+
+- gen-docs
+  - generate docs for response body of custom methods
+
 ### 1.2.0-alpha.20
 
 Improvement:

package/dist/common.js

@@ -52,17 +52,16 @@ export function getEntities(projectApiConfiguration, roles, getAll) {
                 if (!action.grant || !action.enabled || (action.codeHint && action.codeHint.disabled))
                     return;
                 let allow = roles?.includes('*') || action.grant === '*';
-                if (!allow)
-                    action.grant.split('|').forEach(function (roleGroup) {
+                if (!allow) {
+                    action.grant = action.grant.split('|').map(roleGroup => {
                         if (!roleGroup)
-                            return;
-                        roleGroup.split('+').forEach(function (grantedRole) {
-                            if (roles?.indexOf(grantedRole) !== -1)
-                                allow = true;
-                        });
-                    });
-                if (!allow)
-                    return;
+                            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,
@@ -78,21 +77,21 @@ export function getEntities(projectApiConfiguration, roles, getAll) {
             });
         }
         for (const viewName in entity.views) {
-            entity.views[viewName].forEach(function (view) {
+            entity.views[viewName].forEach((view) => {
                 var _a;
                 if (!view.grant || !view.enabled)
                     return;
                 let allow = roles?.indexOf('*') !== -1 || view.grant === '*';
-                view.grant.split('|').forEach(function (roleGroup) {
-                    if (!roleGroup)
+                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;
-                    roleGroup.split('+').forEach(function (grantedRole) {
-                        if (roles?.indexOf(grantedRole) !== -1)
-                            allow = true;
-                    });
-                });
-                if (!allow)
-                    return;
+                }
                 if (!(entity.name in entities)) {
                     entities[entity.name] = {
                         name: entity.name,

package/dist/docs/docs.v2.html

@@ -4424,34 +4424,19 @@ catch (Exception ex)
 <script type="text/mushroom-docs-template" class="mushroom-docs-template" id="template-codeSnippets-generalAction-HTTP">
     <div class="http-snippet">
         Code tham khảo:
-        <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>
-        <pre data-language="http"><span style="display: {{bodyDisplay}}">TRƯỜNG HỢP CÓ BODY DATA</span>
-POST {{rootUrlPath}}{{entityName}}s/{{httpMethod}}<span class="place-holder">?param1=value1&amp;param2=value2</span> HTTP/1.1
+        <pre data-language="http">POST {{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
 X-HTTP-Method-Override: {{httpMethod}}<span style="display: {{tokenDisplay}}">
 Token: your token</span>
 
-<span class="place-holder">BODY DATA</span>
-<span style="display: {{noBodyDisplay}}">
-TRƯỜNG HỢP KHÔNG CÓ BODY DATA
-GET {{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
-X-HTTP-Method-Override: {{httpMethod}}<span style="display: {{tokenDisplay}}">
-Token: your token</span></span></pre>
+<span class="place-holder">BODY DATA IF ANY</span></pre>
     </div>
 </script>
 <script type="text/mushroom-docs-template" class="mushroom-docs-template" id="template-codeSnippets-generalAction-cURL">
     <div class="curl-snippet">
         cURL
-        <pre data-language="cURL">curl -X {{httpMethod}} \
+        <pre data-language="cURL">curl -X POST \
   '<span class="root-url">{{rootUrl}}</span>{{entityName}}s/{{httpMethod}}<span class="place-holder">?param1=value1&amp;param2=value2</span>' \
   -H 'Content-Type: application/json' \
   -H 'X-HTTP-Method-Override: {{httpMethod}}' \<span style="display: {{tokenDisplay}}">
@@ -4459,7 +4444,7 @@ Token: your token</span></span></pre>
   -d 'BODY DATA IF ANY'
 </pre>
         Shell
-        <pre data-language="cURL">curl --request {{httpMethod}} \
+        <pre data-language="cURL">curl --request POST \
   --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>
@@ -5010,6 +4995,10 @@ API.get{{EntityName}}().getViews().{{viewName}}Async(arg, result -> {
         <h4>Request body</h4>
         <pre class="request-body-model"></pre>
     </div>
+    <div class="response-body">
+        <h4>Response body</h4>
+        <pre class="response-body-model"></pre>
+    </div>
 </div>
 
 

package/dist/docs/docs.v2.js

@@ -387,7 +387,7 @@ function formatHintModel(obj, strIndent, options) {
         validation += ', enum(' + encodeHtml(child.items.validValues.join(', ')) + ')';
     }
 
-    var comment = `<span class="code-comment">// ${validation} ${typeof child.description === 'string' && child.description !== '' ? '- ' + encodeHtml(child.description) : ''}</span>`;
+    var comment = `<span class="code-comment">// ${validation} ${typeof child.description === 'string' && child.description !== '' ? '- ' + encodeHtml(child.description).replace(/\n/g, ' ') : ''}</span>`;
 
     if (options.mode === 'model') {
       if (child.type === 'object')
@@ -1007,17 +1007,33 @@ function renderGeneralAction(args) {
   if (args.action?.codeHint?.delegator?.param?.fields) {
     args.tabPage.querySelector('.query-string-model').innerHTML = formatHintModel(
       args.action.codeHint.delegator.param.fields,
-    );
+    ).trim();
   } else {
     args.tabPage.querySelector('.query-string')?.remove();
   }
   if (args.action?.codeHint?.delegator?.requestBody?.fields) {
     args.tabPage.querySelector('.request-body-model').innerHTML = formatHintModel(
       args.action.codeHint.delegator.requestBody.fields,
-    );
+    ).trim();
+  } else if (args.action?.codeHint?.delegator?.requestBody?.items?.fields) {
+    args.tabPage.querySelector('.request-body-model').innerHTML = 'ARRAY OF:\n' + formatHintModel(
+      args.action.codeHint.delegator.requestBody.items.fields,
+    ).trim();
   } else {
     args.tabPage.querySelector('.request-body')?.remove();
   }
+  console.log('args.action.codeHint.delegator', args.action.codeHint.delegator);
+  if (args.action?.codeHint?.delegator?.result?.fields) {
+    args.tabPage.querySelector('.response-body-model').innerHTML = formatHintModel(
+      args.action.codeHint.delegator.result.fields,
+    ).trim();
+  } else if (args.action?.codeHint?.delegator?.result?.items?.fields) {
+    args.tabPage.querySelector('.response-body-model').innerHTML = 'ARRAY OF:\n' + formatHintModel(
+      args.action.codeHint.delegator.result.items.fields,
+    ).trim();
+  } else {
+    args.tabPage.querySelector('.response-body')?.remove();
+  }
 }
 
 function renderEntityView(entityName, viewName) {
@@ -1594,14 +1610,13 @@ window.codeSnippets = {
         rootUrlPath: args.rootUrlPath,
         entityName: args.entityName,
         httpMethod: getHttpMethod(args.actionName),
-        bodyDisplay: args.action?.codeHint?.delegator?.requestBody?.fields ? 'inline' : 'none',
-        noBodyDisplay: args.action?.codeHint?.delegator?.requestBody?.fields ? 'none' : 'inline',
         tokenDisplay: args.action.grant !== '*' ? 'inline' : 'none',
       }),
     cURL: (args) =>
       renderTemplate('template-codeSnippets-generalAction-cURL', {
         rootUrl: localStorage.selected_root_url,
         entityName: args.entityName,
+        httpMethod: getHttpMethod(args.actionName),
         tokenDisplay: args.action.grant !== '*' ? 'inline' : 'none',
       }),
     Java: (args) =>

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

@@ -41,7 +41,7 @@ const entityFeatureWhitelist = ['vn_text'];
 const vnTextWhitelist = ['fields', 'channels'];
 const vnTextChannelWhitelist = ['fields', 'name'];
 const actionCodeHintWhitelist = ['delegator'];
-const actionCodeHintDelegatorWhitelist = ['param', 'requestBody'];
+const actionCodeHintDelegatorWhitelist = ['param', 'requestBody', 'result'];
 const fieldsOnlyWhitelist = ['fields'];
 const viewWhitelist = ['grant', 'deny', 'description', 'parameters', 'emptyResult', 'codeHint'];
 const viewCodeHintWhitelist = ['output'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mushroom-cli",
-  "version": "1.2.0-alpha.20",
+  "version": "1.2.0-alpha.21",
   "description": "Mushroom CLI",
   "main": "dist/mr.js",
   "type": "module",