mushroom-cli 1.2.0-alpha.22 → 1.2.0-alpha.24

package/README.md

@@ -132,6 +132,18 @@ npx mushroom-cli parameters --no-check-update
 
 ## Version
 
+### 1.2.0-alpha.24
+
+Improvement:
+
+- gen-docs
+  - Add `JavascriptParamModel`, `JavascriptRequestBodyModel`, `JavascriptResultModel` tab in code snippets of custom methods
+  - 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
+  - Add docs for `inline` mode of download file and zip file(s), `allowSmallerSize` for thumb
+  - Support link for Roles and Code Snippets
+
 ### 1.2.0-alpha.22
 
 Improvement:

package/dist/docs/docs.v2.html

@@ -2101,6 +2101,7 @@ API.fileExtension().uploadAsync(file, uploadResult -> {
                     <h4>Query string</h4>
                     <ul>
                         <li>id: string, required - Mã của file cần download</li>
+                        <li>inline: boolean, optional - Cho biết có download ở chế độ inline hay không. Xem thêm tại <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition" target="_blank">Content-Disposition</a></li>
                     </ul>
                 </div>
                 <div>
@@ -2128,6 +2129,11 @@ Content-Range: byte {realStartIndex}-{realEndIndex}/{totalLength}
                 </div>
                 <div class="js-driver-snippet">
                     <h4>Mẫu javascript</h4>
+                    Lấy về link download file
+                    <pre>mushroom.$file.getDownloadLink("your file id");</pre>
+                    Tùy biến lấy về link download inline mode
+                    <pre>mushroom.$file.linkBuilder.download.id("your file id").inline().build();</pre>
+                    Download file trên trình duyệt
                     <pre>mushroom.$file.download("your file id");</pre>
                 </div>
             </div>
@@ -2209,6 +2215,13 @@ Content-Range: byte {realStartIndex}-{realEndIndex}/{totalLength}
                                 <li>rotate270 - xoay ảnh 270 độ</li>
                             </ul>
                         </li>
+                        <li>
+                            o: string, optional, chỉ định các tùy chọn, nhận một trong các giá trị sau, có thể áp dụng nhiều tùy chọn, phân cách nhau bởi dấu phải
+                            <ul>
+                                <li>allow-smaller-size - cho phép sinh ảnh bé hơn kích thước quy định nếu ảnh gốc bé</li>
+                                <li>disable-cache - không sử dụng cache server mà yêu cầu sinh ảnh thumb mới</li>
+                            </ul>
+                        </li>
                     </ul>
                 </div>
                 <div>
@@ -2233,23 +2246,28 @@ Last-Modified: {datetime}</pre>
                             <div class="js-driver-snippet">
                                 <pre data-language="javascript">const imgSrc = mushroom.$file.linkBuilder.thumb
     .id(fileId) <span class="code-comment">// required
-    // .stretch(width, height)
-    // .square(size)
-    // .zoom(width, height, backgroundColor) // backgroundColor: optional, default: transparent, valid values: transparent | [0-9a-fA-F]{6}
-    // .x(width)
-    // .y(height)
-    // .clip(150, 75, "top", "left") 
-    // // .clip(width, height, verticalAlign, horizontalAlign)
-    // //     verticalAlign: optional, default: middle, valid values: top | middle | bottom
-    // //     horizontalAlign: optional, default: center, valid values: left | center | right
+    // .stretch(width, height) // width: gt 0; height: gt 0
+    // .square(size) // size: gt 0
+    // .zoom(width, height, backgroundColor)
+    //      width: gt: 0
+    //      height: gt 0
+    //      backgroundColor: optional, default: transparent, valid values: transparent | [0-9a-fA-F]{6}
+    // .x(width) // width: gt 0
+    // .y(height) // height: gt 0
+    // .clip(width, height, verticalAlign, horizontalAlign)
+    //      width: gt 0
+    //      height: gt 0
+    //      verticalAlign: optional, default: middle, valid values: top | middle | bottom
+    //      horizontalAlign: optional, default: center, valid values: left | center | right
     // .rotate90()
     // .rotate180()
     // .rotate270()
     // .flipVertical()
     // .flipHorizontal()
-    // .transparent(50) // value: from 0 to 255
+    // .transparent(value) // value: from 0 to 255
     // .grayscale()
-    // .format("png") // outputFormat: source | jpg | png | gif | webp | auto</span>
+    // .allowSmallerSize()
+    // .format(outputFormat) // outputFormat: source | jpg | png | gif | webp | auto</span>
     .build();</pre>
                             </div>
                         </div>
@@ -2330,6 +2348,7 @@ Tạo hiệu ứng đen trắng: &lt;img src="<span class="root-url">{{rootUrl}}
                     <ul>
                         <li>id: string, required, danh sách mã các file cần zip, các mã file được phân cách bởi dấu phảy (,)</li>
                         <li>name: string, optional, tên file zip khi download. Mặc định là "No name.zip"</li>
+                        <li>inline: boolean, optional - Cho biết có download ở chế độ inline hay không. Xem thêm tại <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition" target="_blank">Content-Disposition</a></li>
                     </ul>
                 </div>
                 <div>
@@ -2343,7 +2362,14 @@ Content-Disposition: attachment; filename="{name}"</pre>
                 </div>
                 <div class="js-driver-snippet">
                     <h4>Mẫu javascript</h4>
-                    <pre>mushroom.$file.zip(["your file id 1", "your file id 2"]);</pre>
+                    Lấy về link download zip file
+                    <pre>mushroom.$file.getZipLink("your file id 1", "your file id 2");</pre>
+                    Tùy biến lấy về link download zip file với chế độ inline
+                    <pre>mushroom.$file.linkBuilder.zip.add("your file id 1", "your file id 2").inline().build();</pre>
+                    Tùy biến lấy về link download zip file chỉ định tên file
+                    <pre>mushroom.$file.linkBuilder.zip.add("your file id 1", "your file id 2").attachment("file-name.zip").build();</pre>
+                    Download zip file trên trình duyệt
+                    <pre>mushroom.$file.zip("your file id 1", "your file id 2");</pre>
                 </div>
             </div>
         </div>
@@ -2689,7 +2715,7 @@ catch (error) {
     </div>
 </div>
 <div class="mushroom-docs-template" id="template-project-entity-action-role">
-    <li role="presentation"><a onclick="renderEntityActionRolePage.call(this, '{{entityName}}', '{{actionName}}', '{{grant}}'); activeRoleTab.call(this)" data-role="{{grant}}">{{explainedRole}}</a></li>
+    <li role="presentation"><a onclick="renderEntityActionRolePage.call(this, '{{entityName}}', '{{actionName}}', '{{grant}}'); activeRoleTab.call(this)" data-hash="{{entityName}}.{{actionName}}/{{grant}}" data-role="{{grant}}">{{explainedRole}}</a></li>
 </div>
 <div class="mushroom-docs-template" id="template-project-entity-action-page">
     <div class="tab-page" data-role="{{grant}}"></div>
@@ -4389,12 +4415,8 @@ API.get{{EntityName}}().deleteAsync(arg, count -> {
         Code tham khảo:
         <pre data-language="javascript">try {
     const response = await mushroom.{{entityName}}.{{httpMethod}}Async({<span style="display: {{paramDisplay}}">
-        params: {
-            <span class="code-comment">// parameters here</span>
-        },</span><span style="display: {{bodyDisplay}}">
-        body: {
-            <span class="code-comment">// request body here</span>
-        }</span>
+        params: {{paramModel:html}},</span><span style="display: {{bodyDisplay}}">
+        body: {{bodyModel:html}}</span>
     });
     console.log("Kết quả trả về, response: %o", response);
 } catch (error) {
@@ -4402,6 +4424,16 @@ API.get{{EntityName}}().deleteAsync(arg, count -> {
 }</pre>
     </div>
 </script>
+<script type="text/mushroom-docs-template" class="mushroom-docs-template" id="template-codeSnippets-generalAction-JavascriptModel">
+    <div class="js-model-snippet">
+        Javascript UNDEFINED model
+        <pre data-language="json">{{undefinedModel:html}}</pre>
+        Javascript VALUE model
+        <pre data-language="json">{{valueModel:html}}</pre>
+        Javascript NULL model
+        <pre data-language="json">{{nullModel:html}}</pre>
+    </div>
+</script>
 <div class="mushroom-docs-template" id="template-codeSnippets-generalAction-CSharp">
     <div class="csharp-driver-snippet">
         <p>Hỗ trợ: DotNet Framework 4.5+, DotNet Core 3.1+, Unity3D, Mono</p>
@@ -4424,31 +4456,30 @@ 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">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}}{{queryString}} 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 IF ANY</span></pre>
+{{bodyModel:html}}</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 POST \
-  '<span class="root-url">{{rootUrl}}</span>{{entityName}}s/{{httpMethod}}<span class="place-holder">?param1=value1&amp;param2=value2</span>' \
+  '<span class="root-url">{{rootUrl}}</span>{{entityName}}s/{{httpMethod}}{{queryString}}' \
   -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>
+  -d '{{bodyModel:html}}'</pre>
         Shell
         <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>' \
+  --url '<span class="root-url">{{rootUrl}}</span>{{entityName}}s/{{httpMethod}}{{queryString}}' \
   --header 'X-HTTP-Method-Override: {{httpMethod}}' \<span style="display: {{tokenDisplay}}">
   --header 'Token: {<span>{</span>TOKEN}}' \</span>
-  --data 'BODY DATA IF ANY'</pre>
+  --data '{{bodyModel:html}}'</pre>
     </div>
 </script>
 <div class="mushroom-docs-template" id="template-codeSnippets-generalAction-Java">
@@ -4989,7 +5020,7 @@ API.get{{EntityName}}().getViews().{{viewName}}Async(arg, result -> {
     </div>
     <div class="query-string">
         <h4>Query string</h4>
-        <pre class="query-string-model"></pre>
+        <ul class="parameters-list"></ul>
     </div>
     <div class="request-body">
         <h4>Request body</h4>
@@ -5025,7 +5056,7 @@ API.get{{EntityName}}().getViews().{{viewName}}Async(arg, result -> {
 </div>
 <div class="mushroom-docs-template" id="template-view-parameters">
     <li>
-        <b>{{field}}</b>: {{type}}, {{required}}{{defaultValue}} - {{description}}
+        <b>{{field}}</b>: {{type}}, {{required}}{{defaultValue}}, {{description}}
     </li>
 </div>
 <div class="mushroom-docs-template" id="template-view">

package/dist/docs/docs.v2.js

@@ -270,7 +270,7 @@ function formatModel(obj, strIndent, options) {
             ' ' +
             comment +
             `\r\n${nextIndent}`;
-        result += `]`;
+        result += '],';
       } else if (child.type === 'datetime')
         result +=
           `\r\n${nextIndent}"${m}": ` + JSON.stringify(child.defaultValue || 'ISODate_ISO_8601') + ', ' + comment;
@@ -281,7 +281,7 @@ function formatModel(obj, strIndent, options) {
       else result += `\r\n${nextIndent}"${m}": ` + JSON.stringify(child.defaultValue || child.type) + ', ' + comment;
     } else if (options.mode === 'model_null') {
       if (child.type === 'object')
-        result += '\r\n' + nextIndent + '"' + m + '": ' + comment + formatModel(child.fields, nextIndent, options);
+        result += '\r\n' + nextIndent + '"' + m + '": ' + comment + formatModel(child.fields, nextIndent, options) + ',';
       else if (child.type === 'array') {
         result += `\r\n${nextIndent}"${m}": [`;
         if (child.items.type === 'object')
@@ -290,7 +290,7 @@ function formatModel(obj, strIndent, options) {
       } else result += `\r\n${nextIndent}"${m}": null, ${comment}`;
     } else if (options.mode === 'model_undefined') {
       if (child.type === 'object')
-        result += '\r\n' + nextIndent + '"' + m + '": ' + comment + formatModel(child.fields, nextIndent, options);
+        result += '\r\n' + nextIndent + '"' + m + '": ' + comment + formatModel(child.fields, nextIndent, options) + ',';
       else if (child.type === 'array') {
         result += `\r\n${nextIndent}"${m}": [`;
         if (child.items.type === 'object')
@@ -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).replace(/\n/g, ' ') : ''}</span>`;
+    var comment = options.hideComment ? '' : `<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')
@@ -415,7 +415,7 @@ function formatHintModel(obj, strIndent, options) {
             ' ' +
             comment +
             `\r\n${nextIndent}`;
-        result += `]`;
+        result += '],';
       } else if (child.type === 'datetime')
         result +=
           `\r\n${nextIndent}"${m}": ` + JSON.stringify(child.defaultValue || 'ISODate_ISO_8601') + ', ' + comment;
@@ -426,7 +426,7 @@ function formatHintModel(obj, strIndent, options) {
       else result += `\r\n${nextIndent}"${m}": ` + JSON.stringify(child.defaultValue || child.type) + ', ' + comment;
     } else if (options.mode === 'model_null') {
       if (child.type === 'object')
-        result += '\r\n' + nextIndent + '"' + m + '": ' + comment + formatHintModel(child.fields, nextIndent, options);
+        result += '\r\n' + nextIndent + '"' + m + '": ' + comment + formatHintModel(child.fields, nextIndent, options) + ',';
       else if (child.type === 'array') {
         result += `\r\n${nextIndent}"${m}": [`;
         if (child.items.type === 'object')
@@ -435,7 +435,7 @@ function formatHintModel(obj, strIndent, options) {
       } else result += `\r\n${nextIndent}"${m}": null, ${comment}`;
     } else if (options.mode === 'model_undefined') {
       if (child.type === 'object')
-        result += '\r\n' + nextIndent + '"' + m + '": ' + comment + formatHintModel(child.fields, nextIndent, options);
+        result += '\r\n' + nextIndent + '"' + m + '": ' + comment + formatHintModel(child.fields, nextIndent, options) + ",";
       else if (child.type === 'array') {
         result += `\r\n${nextIndent}"${m}": [`;
         if (child.items.type === 'object')
@@ -745,20 +745,28 @@ function renderEntityActionRolePage(entityName, actionName, grant) {
     domain: getApiDomain(localStorage.selected_root_url),
     rootUrlPath: getApiPath(localStorage.selected_root_url),
   };
-  const snippet = window.codeSnippets[codeSnippetName] ?? {};
+  const snippets = window.codeSnippets[codeSnippetName] 
+    ? Object.keys(window.codeSnippets[codeSnippetName]).map((lang) => {
+      return {
+        lang: lang,
+        html: window.codeSnippets[codeSnippetName][lang]?.call(null, args)
+      }
+    }).filter(item => item.html) 
+    : [];
+
   const data = {
     explainedDenyRoles: explainRoles(action.deny),
     entityName,
-    codeSnippetTabHeaders: Object.keys(snippet)
+    codeSnippetTabHeaders: snippets
       .map(
-        (lang, idx) =>
-          `<li role="presentation" ${idx ? '' : 'class="active"'}><a data-role="${lang}" onclick="activeRoleTab.call(this)">${lang}</a></li>`,
+        (item, idx) =>
+          `<li role="presentation" ${idx ? '' : 'class="active"'}><a data-role="${item.lang}" onclick="activeRoleTab.call(this)" data-hash="${entityName}.${actionName}/${grant}/${item.lang}">${item.lang}</a></li>`,
       )
       .join(''),
-    codeSnippetTabPages: Object.keys(snippet)
+    codeSnippetTabPages: snippets
       .map(
-        (lang, idx) =>
-          `<div class="tab-page ${lang} ${idx ? '' : 'active'}" data-role="${lang}">${snippet[lang]?.call(null, args) ?? ''}</div>`,
+        (item, idx) =>
+          `<div class="tab-page ${item.lang} ${idx ? '' : 'active'}" data-role="${item.lang}">${item.html}</div>`,
       )
       .join(''),
     EntityName: args.EntityName,
@@ -1005,9 +1013,16 @@ function renderDeleteMany(args) {}
 
 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();
+    args.tabPage.querySelector('.parameters-list').innerHTML = Object.keys(args.action.codeHint.delegator.param.fields)
+    .map((m) => {
+      const field = args.action.codeHint.delegator.param.fields[m];
+      return renderTemplate('template-view-parameters', {
+        field: m,
+        type: (field.type === 'array' ? 'array of ' : '') + (field.items?.type ?? 'string'),
+        description: field.description ?? '',
+        required: field.required ? 'required' : 'optional',
+      })
+    }).join('');
   } else {
     args.tabPage.querySelector('.query-string')?.remove();
   }
@@ -1022,7 +1037,6 @@ function renderGeneralAction(args) {
   } 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,
@@ -1036,6 +1050,17 @@ function renderGeneralAction(args) {
   }
 }
 
+function genQueryString(param) {
+  if (!param) return '';
+  if (!param.fields) return '';
+
+  const queryString = Object.keys(param.fields).map(key => {
+    const type = param.fields[key].type === 'array' ? 'array_of_' + (param.fields[key].items?.type ?? 'value') : param.fields[key].type;
+    return `${key}=${type}`;
+  }).join("&");
+  return queryString ? '?' + queryString : '';
+}
+
 function renderEntityView(entityName, viewName) {
   if (this.dataset.rendered) return;
   this.dataset.rendered = true;
@@ -1597,7 +1622,33 @@ window.codeSnippets = {
         httpMethod: getHttpMethod(args.actionName),
         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(),
+      }),
+    JavascriptParamModel: (args) =>
+      args.action?.codeHint?.delegator?.param?.fields
+        ? renderTemplate('template-codeSnippets-generalAction-JavascriptModel', {
+            undefinedModel: formatHintModel(args.action.codeHint.delegator.param.fields, undefined, { mode: 'model_undefined' }),
+            valueModel: formatHintModel(args.action.codeHint.delegator.param.fields, undefined, { mode: 'model' }),
+            nullModel: formatHintModel(args.action.codeHint.delegator.param.fields, undefined, { mode: 'model_null' }),
+          })
+        : '',
+    JavascriptRequestBodyModel: (args) =>
+      args.action?.codeHint?.delegator?.requestBody?.fields
+        ? renderTemplate('template-codeSnippets-generalAction-JavascriptModel', {
+            undefinedModel: formatHintModel(args.action.codeHint.delegator.requestBody.fields, undefined, { mode: 'model_undefined' }),
+            valueModel: formatHintModel(args.action.codeHint.delegator.requestBody.fields, undefined, { mode: 'model' }),
+            nullModel: formatHintModel(args.action.codeHint.delegator.requestBody.fields, undefined, { mode: 'model_null' }),
+          })
+        : '',
+    JavascriptResultModel: (args) =>
+      args.action?.codeHint?.delegator?.result?.fields
+        ? 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' }),
+            nullModel: formatHintModel(args.action.codeHint.delegator.result.fields, undefined, { mode: 'model_null' }),
+          })
+        : '',
     CSharp: (args) =>
       renderTemplate('template-codeSnippets-generalAction-CSharp', {
         entityName: args.entityName,
@@ -1609,14 +1660,18 @@ window.codeSnippets = {
         domain: args.domain,
         rootUrlPath: args.rootUrlPath,
         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 }),
         tokenDisplay: args.action.grant !== '*' ? 'inline' : 'none',
       }),
     cURL: (args) =>
       renderTemplate('template-codeSnippets-generalAction-cURL', {
         rootUrl: localStorage.selected_root_url,
         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 }),
         tokenDisplay: args.action.grant !== '*' ? 'inline' : 'none',
       }),
     Java: (args) =>
@@ -1767,6 +1822,10 @@ function activeRoleTab() {
       return $(this).data('role') === role;
     })
     .addClass('active');
+  var hash = $(this).data('hash');
+  if (hash) {
+    location.hash = hash;
+  }
 }
 
 function activeFirstChild() {
@@ -1781,7 +1840,7 @@ function activeFirstChild() {
 function gotoHash() {
   if (!location.hash) return;
 
-  const m = location.hash.match(/^#(\$[\w-]+|\w+)(\.((views\.)?\w+))?$/);
+  const m = location.hash.match(/^#(\$[\w-]+|\w+)(\.((views\.)?\w+)(\/[\/\w\+\|]+)?)?$/);
   if (!m) return;
 
   const cardSelector = m[1].charAt(0) === '$' ? '#extension-' + m[1].substring(1) : '#entity-' + m[1];
@@ -1820,6 +1879,21 @@ function gotoHash() {
     if (isNaN(stickyTop)) stickyTop = 0;
   }
   window.scrollTo(0, top - stickyTop);
+
+  if (m[5]) {
+    const segs = m[5].substring(1).split('/');
+    const role = segs[0];
+    if (!role) return;
+    const snippet = segs[1];
+
+    const aRole = document.querySelector(`${panelSelector} .panel-body .nav-tabs a[data-role="${role}"]`);
+    if (aRole && aRole.onclick) aRole.onclick();
+
+    if (!snippet) return;
+
+    const aSnippet = document.querySelector(`${panelSelector} .panel-body .tab-pages .tab-page[data-role="${role}"] .nav-tabs a[data-role="${snippet}"]`);
+    if (aSnippet && aSnippet.onclick) aSnippet.onclick();
+  }
 }
 
 function copied() {

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

@@ -16,9 +16,16 @@ function reserveWhitelist(obj, whitelist) {
     return obj;
 }
 const environmentVariableWhitelist = ['type', 'description'];
-function filterEnvironmentVariables(environmentVariables) {
+function filterEnvironmentVariables(environmentVariables, allowRoles) {
     if (!environmentVariables)
         return;
+    if (!allowRoles.includes('*')) {
+        Object.keys(environmentVariables).forEach((envName) => {
+            if (environmentVariables[envName].codeHint?.roles?.every((role) => !allowRoles.includes(role))) {
+                delete environmentVariables[envName];
+            }
+        });
+    }
     Object.values(environmentVariables).forEach((env) => reserveWhitelist(env, environmentVariableWhitelist));
 }
 const entityWhitelist = ['name', 'description', 'actions', 'views', 'features', 'fields'];
@@ -145,7 +152,9 @@ function markIncludedFields(excludedFields, dict) {
     if (!Array.isArray(excludedFields))
         return;
     for (const m in dict) {
-        if (!dict[m] && !excludedFields.includes(m))
+        if (!dict[m] &&
+            !excludedFields.includes(m) &&
+            excludedFields.every((excludedField) => !m.startsWith(excludedField + '.')))
             dict[m] = true;
     }
 }
@@ -198,7 +207,18 @@ function filterEntityFields(entity) {
             case 'updateOne':
             case 'updateMany':
             case 'updatePartially':
-                actions.forEach((action) => (action.exclude = action.exclude?.filter((field) => allowFields.includes(field))));
+                actions.forEach((action) => {
+                    action.exclude = action.exclude?.filter((field) => {
+                        let idx = 0;
+                        do {
+                            idx = field.indexOf('.', idx + 1);
+                            const prefix = idx === -1 ? field : field.substring(0, idx);
+                            if (allowFields.includes(prefix))
+                                return true;
+                        } while (idx !== -1);
+                        return false;
+                    });
+                });
                 break;
         }
     });
@@ -250,7 +270,8 @@ export default async function genDocs(args, projectName, project, alias, source)
         throw new Error(`Not found gen docs configuration. Please run 'npx mushroom-cli config ${projectName} gen docs OUTPUT_FILE.html${alias === 'default' ? '' : ' alias ' + alias}' first`);
     }
     common.logInfo('Use GenDocEngine v1.2');
-    const entities = common.getEntities(source, aliasProject.allowRoles);
+    const allowRoles = aliasProject.allowRoles ?? ['*'];
+    const entities = common.getEntities(source, allowRoles);
     if (Array.isArray(aliasProject.entities)) {
         for (const entityName in entities) {
             if (Object.hasOwnProperty.call(entities, entityName)) {
@@ -260,7 +281,7 @@ export default async function genDocs(args, projectName, project, alias, source)
             }
         }
     }
-    filterEnvironmentVariables(source.environmentVariables);
+    filterEnvironmentVariables(source.environmentVariables, allowRoles);
     filterEntities(entities);
     const data = JSON.stringify({
         info: {
@@ -275,7 +296,7 @@ export default async function genDocs(args, projectName, project, alias, source)
                 },
         },
         features: aliasProject.features,
-        roles: common.filterRoles(source.roles ?? [], aliasProject.allowRoles ?? ['*']),
+        roles: common.filterRoles(source.roles ?? [], allowRoles),
         environmentVariables: source.environmentVariables,
         entities: entities,
     });

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

@@ -259,7 +259,7 @@ 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, MushroomFindByIdResource, MushroomCreateResource, MushroomBatchCreateResource, MushroomUpdateResource, MushroomBatchUpdateResource, MushroomPartialUpdateResource, MushroomDeleteResource, MushroomBatchDeleteResource, MushroomExtensibleResource, MushroomViewFunction, MushroomError, IMushroomOfflineResponse, MushroomOfflineResponse, MushroomOfflineResponseState } from "mushroomjs";
+    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";
 ${extensionsImportLines.join('\n')}
 export * from "mushroomjs";
 export const extensions = {
@@ -316,7 +316,7 @@ export interface CustomMethodBodyRequest<TBody> extends MushroomRequest {
                 case 'findMany': {
                     iApiClassBody += ` & MushroomListResource<${typescriptClassName}>`;
                     if (includeTotal)
-                        iApiClassBody += ` & MushroomCountResource<${typescriptClassName}>`;
+                        iApiClassBody += ' & MushroomCountResource';
                     break;
                 }
                 case 'findById': {
@@ -439,7 +439,7 @@ export function genDtsString(aliasProject, source) {
             extensionsTypes.push('FileExtension.IMushroomFile & ');
         }
     }
-    let code = `import { IdType, IMushroom, Mushroom, MushroomRequest, MushroomRequestSetting, MushroomRestfulRequest, MushroomResponse, MushroomResponseDataType, MushroomResourceBase, MushroomListResource, MushroomFindByIdResource, MushroomCreateResource, MushroomBatchCreateResource, MushroomUpdateResource, MushroomBatchUpdateResource, MushroomPartialUpdateResource, MushroomDeleteResource, MushroomBatchDeleteResource, MushroomExtensibleResource, MushroomViewFunction, MushroomError, IMushroomOfflineResponse, MushroomOfflineResponse, MushroomOfflineResponseState } from "mushroomjs";
+    let code = `import { 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";
 ${extensionsImportLines.join('\n')}
 export * from "mushroomjs";
 export declare const extensions = {
@@ -495,7 +495,7 @@ export interface CustomMethodBodyRequest<TBody> extends MushroomRequest {
                 case 'findMany': {
                     iApiClassBody += ` & MushroomListResource<${typescriptClassName}>`;
                     if (includeTotal)
-                        iApiClassBody += ` & MushroomCountResource<${typescriptClassName}>`;
+                        iApiClassBody += ' & MushroomCountResource';
                     break;
                 }
                 case 'findById': {

package/package.json

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