mushroom-cli 1.2.0-alpha.1 → 1.2.0-alpha.10

package/docs/docs.html

@@ -384,11 +384,17 @@
             <code data-mt-cond='{"action.pagingType": "Page"}'>Theo page number</code>
         </div>
         <div data-mt-cond='{"action.pagingType": {"$exists": true, "$ne": "None"}}'>
-            Số lượng <span data-mt-attr='{"text": "$entityName"}'></span> mặc định trả về trong 1 trang: 
-            <code data-mt-cond='{"action.pageSize": {"$exists": true}}' data-mt-attr='{"text": "$action.pageSize"}'></code>
-            <code data-mt-cond='{"action.pageSize": {"$exists": false}}'>25</code>
+            Số lượng <span data-mt-attr='{"text": "$entityName"}'></span> mặc định trả về trong 1 trang:
+            <code data-mt-cond='{"action.maxPageSize": {"$exists": false}, "action.pageSize": {"$exists": false}}'>25</code>
+            <code data-mt-cond='{"action.maxPageSize": {"$exists": false}, "action.pageSize": {"$exists": true}}' data-mt-attr='{"text": "$action.pageSize"}'></code>
+            <code data-mt-cond='{"action.maxPageSize": {"$exists": true}}'>
+                <span data-mt-cond='{"action.pageSize": {"$exists": false}, "action.maxPageSize": {"$lt": 25}}' data-mt-attr='{"text": "$action.maxPageSize"}'></span>
+                <span data-mt-cond='{"action.pageSize": {"$exists": false}, "action.maxPageSize": {"$gte": 25}}'>25</span>
+                <span data-mt-cond='{"action.pageSize": {"$exists": true}, "action.maxPageSize": {"$lt": "$action.pageSize"}}' data-mt-attr='{"text": "$action.maxPageSize"}'></span>
+                <span data-mt-cond='{"action.pageSize": {"$exists": true}, "action.maxPageSize": {"$gte": "$action.pageSize"}}' data-mt-attr='{"text": "$action.pageSize"}'></span>
+            </code>
             <div data-mt-cond='{"action.maxPageSize": {"$exists": true}}'>
-                limit, pageSize có thể nhận giá trị tối đa: <code data-mt-attr='{"text": "$action.pageSize"}'></code>
+                <code>limit</code> có thể nhận giá trị tối đa: <code data-mt-attr='{"text": "$action.maxPageSize"}'></code>
             </div>
         </div>
         <div data-mt-cond='{"action.includeTotal": true}'>
@@ -438,30 +444,50 @@
             <div class="tab-page Javascript active" data-role="Javascript">
                 <div class="js-driver-snippet">
                     Đơn giản
-                    <pre data-language="javascript">try {
+                    <pre data-language="javascript"><span class="code-comment">// Lấy về danh sách<span data-mt-cond='{"action.pagingType": {"$ne": "None"}}'> có phân trang</span></span>
+try {
     const response = await mushroom.<span data-mt-attr='{"text": "$entityName"}'></span>.listAsync();
-    console.log("Các <span data-mt-attr='{"text": "$entityName"}'></span> thỏa mãn: %o", response);
+    console.log("Các <span data-mt-attr='{"text": "$entityName"}'></span>: %o", response);
 }
 catch (e) {
     console.error("Có lỗi: %o", e);
-}</pre>
+}
+
+<span class="code-comment">// Lấy về tất cả danh sách</span>
+try {
+    const response = await mushroom.<span data-mt-attr='{"text": "$entityName"}'></span>.getAllAsync();
+    console.log("Tất cả các <span data-mt-attr='{"text": "$entityName"}'></span>: %o", response);
+}
+catch (e) {
+    console.error("Có lỗi: %o", e);
+}<div data-mt-cond='{"action.includeTotal": true}'>
+<span class="code-comment">// Lấy về số lượng bản ghi</span>
+try {
+    const response = await mushroom.<span data-mt-attr='{"text": "$entityName"}'></span>.countAsync();
+    console.log("Số lượng tất cả các <span data-mt-attr='{"text": "$entityName"}'></span>: %o", response);
+}
+catch (e) {
+    console.error("Có lỗi: %o", e);
+}</div></pre>
                     Tùy biến tham số
                     <pre data-language="javascript">try {
     const response = await mushroom.<span data-mt-attr='{"text": "$entityName"}'></span>.listAsync({
         fields: "<span class="separated-items" data-mt-iterate='{"data": "$action.returnableFields"}'><span data-mt-attr='{"text": "$this"}'></span><span class="separator">,</span></span>",
         filters: ["your filter 1", "your filter 2"], // <i>or</i> "your filters" ,<span data-mt-cond='{"action.allowSortings": {"$exists": true}}'>
         sort: "<span class="separated-items" data-mt-iterate='{"data": "$action.allowSortings"}'><span data-mt-cond='{"type": "Desc"}'>-</span><span data-mt-attr='{"text": "$field"}'></span><span class="separator">,</span></span>",</span>
-<span data-mt-cond='{"action.pagingType": "LimitOffset"}'>        limit: 25,
-</span><span data-mt-cond='{"action.pagingType": "LimitOffset"}'>        offset: 0,
-</span><span data-mt-cond='{"action.pagingType": "Page"}'>        limit: 25,
-</span><span data-mt-cond='{"action.pagingType": "Page"}'>        page: 1,
-</span><span data-mt-cond='{"entity.features.vn_text.fields.length": {"$gt": 0}}'>        vn_text: "Chuỗi tìm kiếm", <span class="code-comment">// tìm kiếm tiếng Việt không dấu, không phân biệt hoa thường trên <span data-mt-cond='{"entity.features.vn_text.fields.length": {"$gt": 1}}'>các</span> trường: <span class="separated-items" data-mt-iterate='{"data": "$entity.features.vn_text.fields"}'><span data-mt-attr='{"text": "$this"}'></span><span class="separator">,</span></span></span>
-</span>    });
+<span data-mt-cond='{"action.pagingType": {"$in": ["LimitOffset", "Page"]}}'>        limit: 25,
+</span> <span data-mt-cond='{"action.pagingType": "LimitOffset"}'>       offset: 0,
+</span> <span data-mt-cond='{"action.pagingType": "Page"}'>       page: 1,
+</span> <span data-mt-cond='{"entity.features.vn_text.fields.length": {"$gt": 0}}'>       vn_text: "Chuỗi tìm kiếm", <span class="code-comment">// tìm kiếm tiếng Việt không dấu, không phân biệt hoa thường trên <span data-mt-cond='{"entity.features.vn_text.fields.length": {"$gt": 1}}'>các</span> trường: <span class="separated-items" data-mt-iterate='{"data": "$entity.features.vn_text.fields"}'><span data-mt-attr='{"text": "$this"}'></span><span class="separator">,</span></span></span>
+</span>   });
     console.log("Các <span data-mt-attr='{"text": "$entityName"}'></span> thỏa mãn: %o", response);
 }
 catch (e) {
     console.error("Có lỗi: %o", e);
-}</pre>
+}
+
+<span class="code-comment">// Tham số cho getAllAsync tương tự listAsync</span><span data-mt-cond='{"action.includeTotal": true}' class="code-comment">
+// Tham số cho countAsync chỉ hỗ trợ filters</span></pre>
                 </div>
             </div>
             <div class="tab-page JavascriptModel" data-role="JavascriptModel">
@@ -530,7 +556,7 @@ Host: <span data-mt-attr='{"text": {"fn": "getApiDomain"}}'></span><span data-mt
 Token: your token
 </span></pre>
                     Đầy đủ
-                    <pre data-language="http">GET <span data-mt-attr='{"text": {"fn": "getApiPath"}}'></span><span data-mt-attr='{"text": "$entityName"}'></span>s?field1=value1&field2.subfield=value2<span class="separated-items">&$fields=<span data-mt-iterate='{"data": "$action.returnableFields"}'><span data-mt-attr='{"text": "$this"}'></span><span class="separator">,</span></span></span><span class="separated-items" data-mt-cond='{"action.allowSortings": {"$exists": true}}'>&$sort=<span data-mt-iterate='{"data": "$action.allowSortings"}'><span data-mt-cond='{"type": "Desc"}'>-</span><span data-mt-attr='{"text": "$field"}'></span><span class="separator">,</span></span></span><span data-mt-cond='{"action.pagingType": "LimitOffset"}'>&$limit=limit&$offset=offset</span><span data-mt-cond='{"action.pagingType": "Page"}'>&$limit=limit&$page=page</span> HTTP/1.1
+                    <pre data-language="http">GET <span data-mt-attr='{"text": {"fn": "getApiPath"}}'></span><span data-mt-attr='{"text": "$entityName"}'></span>s?field1=value1&field2.subfield=value2<span class="separated-items">&$fields=<span data-mt-iterate='{"data": "$action.returnableFields"}'><span data-mt-attr='{"text": "$this"}'></span><span class="separator">,</span></span></span><span class="separated-items" data-mt-cond='{"action.allowSortings": {"$exists": true}}'>&$sort=<span data-mt-iterate='{"data": "$action.allowSortings"}'><span data-mt-cond='{"type": "Desc"}'>-</span><span data-mt-attr='{"text": "$field"}'></span><span class="separator">,</span></span></span><span style="display: none"> </span><span data-mt-cond='{"action.pagingType": "LimitOffset"}'>&$limit=limit&$offset=offset</span><span style="display: none"> </span><span data-mt-cond='{"action.pagingType": "Page"}'>&$limit=limit&$page=page</span> HTTP/1.1
 Host: <span data-mt-attr='{"text": {"fn": "getApiDomain"}}'></span><span data-mt-cond='{"action.grant": {"$ne": "*"}}'>
 Token: your token
 </span></pre>
@@ -546,13 +572,13 @@ Token: your token
 </span></pre>
                     Đầy đủ
                     <pre data-language="cURL">curl -X GET \
-'<span data-mt-attr='{"text": {"fn": "getApiPath"}}'></span><span data-mt-attr='{"text": "$entityName"}'></span>s?field1=value1&field2.subfield=value2<span class="separated-items">&$fields=<span data-mt-iterate='{"data": "$action.returnableFields"}'><span data-mt-attr='{"text": "$this"}'></span><span class="separator">,</span></span></span><span class="separated-items" data-mt-cond='{"action.allowSortings": {"$exists": true}}'>&$sort=<span data-mt-iterate='{"data": "$action.allowSortings"}'><span data-mt-cond='{"type": "Desc"}'>-</span><span data-mt-attr='{"text": "$field"}'></span><span class="separator">,</span></span></span><span data-mt-cond='{"action.pagingType": "LimitOffset"}'>&$limit=limit&$offset=offset</span><span data-mt-cond='{"action.pagingType": "Page"}'>&$limit=limit&$page=page</span>' \
+'<span data-mt-attr='{"text": {"fn": "getApiPath"}}'></span><span data-mt-attr='{"text": "$entityName"}'></span>s?field1=value1&field2.subfield=value2<span class="separated-items">&$fields=<span data-mt-iterate='{"data": "$action.returnableFields"}'><span data-mt-attr='{"text": "$this"}'></span><span class="separator">,</span></span></span><span class="separated-items" data-mt-cond='{"action.allowSortings": {"$exists": true}}'>&$sort=<span data-mt-iterate='{"data": "$action.allowSortings"}'><span data-mt-cond='{"type": "Desc"}'>-</span><span data-mt-attr='{"text": "$field"}'></span><span class="separator">,</span></span></span><span style="display: none"> </span><span data-mt-cond='{"action.pagingType": "LimitOffset"}'>&$limit=limit&$offset=offset</span><span style="display: none"> </span><span data-mt-cond='{"action.pagingType": "Page"}'>&$limit=limit&$page=page</span>' \
 -H 'Host: <span data-mt-attr='{"text": {"fn": "getApiDomain"}}'></span>'<span data-mt-cond='{"action.grant": {"$ne": "*"}}'> \
 -H 'Token: your token'
 </span></pre>
                     Shell
                     <pre data-language="cURL">curl --request GET \
-  --url '<span data-mt-attr='{"text": {"fn": "getApiPath"}}'></span><span data-mt-attr='{"text": "$entityName"}'></span>s?field1=value1&field2.subfield=value2<span class="separated-items">&$fields=<span data-mt-iterate='{"data": "$action.returnableFields"}'><span data-mt-attr='{"text": "$this"}'></span><span class="separator">,</span></span></span><span class="separated-items" data-mt-cond='{"action.allowSortings": {"$exists": true}}'>&$sort=<span data-mt-iterate='{"data": "$action.allowSortings"}'><span data-mt-cond='{"type": "Desc"}'>-</span><span data-mt-attr='{"text": "$field"}'></span><span class="separator">,</span></span></span><span data-mt-cond='{"action.pagingType": "LimitOffset"}'>&$limit=limit&$offset=offset</span><span data-mt-cond='{"action.pagingType": "Page"}'>&$limit=limit&$page=page</span>' \
+  --url '<span data-mt-attr='{"text": {"fn": "getApiPath"}}'></span><span data-mt-attr='{"text": "$entityName"}'></span>s?field1=value1&field2.subfield=value2<span class="separated-items">&$fields=<span data-mt-iterate='{"data": "$action.returnableFields"}'><span data-mt-attr='{"text": "$this"}'></span><span class="separator">,</span></span></span><span class="separated-items" data-mt-cond='{"action.allowSortings": {"$exists": true}}'>&$sort=<span data-mt-iterate='{"data": "$action.allowSortings"}'><span data-mt-cond='{"type": "Desc"}'>-</span><span data-mt-attr='{"text": "$field"}'></span><span class="separator">,</span></span></span><span style="display: none"> </span><span data-mt-cond='{"action.pagingType": "LimitOffset"}'>&$limit=limit&$offset=offset</span><span style="display: none"> </span><span data-mt-cond='{"action.pagingType": "Page"}'>&$limit=limit&$page=page</span>' \
   -header 'Host: <span data-mt-attr='{"text": {"fn": "getApiDomain"}}'></span>'<span data-mt-cond='{"action.grant": {"$ne": "*"}}'> \
   -header 'Token: your token'
 </span></pre>
@@ -2519,7 +2545,15 @@ API.get<span data-mt-attr='{"text": {"fn": "toCSharpName", "data": "$entityName"
         </ul>
     </div>
     <div data-mt-cond='{"action.description": {"$exists": true}}'>
-        <h4>Thông tin thêm</h4><p data-mt-attr='{"text": "$action.description"}'></p>
+        <h4>Mô tả</h4><p data-mt-attr='{"text": "$action.description"}'></p>
+    </div>
+    <div data-mt-cond='{"action.codeHint.delegator.param.fields": {"$exists": true}}'>
+        <h4>Query string</h4>
+        <pre data-mt-attr='{"html": {"fn": "formatHintModal", "data": ["$action.codeHint.delegator.param.fields"]}}'></pre>
+    </div>
+    <div data-mt-cond='{"action.codeHint.delegator.requestBody.fields": {"$exists": true}}'>
+        <h4>Request body</h4>
+        <pre data-mt-attr='{"html": {"fn": "formatHintModal", "data": ["$action.codeHint.delegator.requestBody.fields"]}}'></pre>
     </div>
     <div class="driver-snippet">
         <h4>Code mẫu</h4>
@@ -2537,7 +2571,14 @@ API.get<span data-mt-attr='{"text": {"fn": "toCSharpName", "data": "$entityName"
                 <div class="js-driver-snippet">
                     Code tham khảo:
                     <pre data-language="javascript">try {
-    const response = await mushroom.<span data-mt-attr='{"text": "$entityName"}'></span>.<span data-mt-attr='{"text": {"fn": "getHttpMethod", "data": "$actionName"}}'></span>Async(parameters)
+    const response = await mushroom.<span data-mt-attr='{"text": "$entityName"}'></span>.<span data-mt-attr='{"text": {"fn": "getHttpMethod", "data": "$actionName"}}'></span>Async({<span data-mt-cond='{"action.codeHint.delegator.param.fields": {"$exists": true}}'>
+        params: {
+            <span class="code-comment">// parameters here</span>
+        },</span><span data-mt-cond='{"action.codeHint.delegator.requestBody.fields": {"$exists": true}}'>
+        body: {
+            <span class="code-comment">// request body here</span>
+        }</span>
+    });
     console.log("Kết quả trả về, response: %o", response);
 } catch (error) {
     console.error("Có lỗi: %o", error);
@@ -2573,7 +2614,7 @@ Token: your token</span>
 
 <span class="place-holder">BODY DATA</span></pre>
                     Nếu webserver chỉ hỗ trợ các http method thông dụng, không hỗ trợ http method <span data-mt-attr='{"text": {"fn": "getHttpMethod", "data": "$actionName"}}'></span> thì sử dụng Header theo cách sau:
-                    <pre data-language="http">TRƯỜNG HỢP CÓ BODY DATA
+                    <pre data-language="http"><span data-mt-cond='{"action.codeHint.delegator.requestBody": {"$exists": false}}'>TRƯỜNG HỢP CÓ BODY DATA</span>
 POST <span data-mt-attr='{"text": {"fn": "getApiPath"}}'></span><span data-mt-attr='{"text": "$entityName"}'></span>s/<span data-mt-attr='{"text": {"fn": "getHttpMethod", "data": "$actionName"}}'></span><span class="place-holder">?param1=value1&amp;param2=value2</span> HTTP/1.1
 Host: <span data-mt-attr='{"text": {"fn": "getApiDomain"}}'></span>
 Content-Type: application/json
@@ -2581,13 +2622,13 @@ X-HTTP-Method-Override: <span data-mt-attr='{"text": {"fn": "getHttpMethod", "da
 Token: your token</span>
 
 <span class="place-holder">BODY DATA</span>
-
+<span data-mt-cond='{"action.codeHint.delegator.requestBody": {"$exists": false}}'>
 TRƯỜNG HỢP KHÔNG CÓ BODY DATA
 GET <span data-mt-attr='{"text": {"fn": "getApiPath"}}'></span><span data-mt-attr='{"text": "$entityName"}'></span>s/<span data-mt-attr='{"text": {"fn": "getHttpMethod", "data": "$actionName"}}'></span><span class="place-holder">?param1=value1&amp;param2=value2</span> HTTP/1.1
 Host: <span data-mt-attr='{"text": {"fn": "getApiDomain"}}'></span>
 Content-Type: application/json
 X-HTTP-Method-Override: <span data-mt-attr='{"text": {"fn": "getHttpMethod", "data": "$actionName"}}'></span><span data-mt-cond='{"action.grant": {"$ne": "*"}}'>
-Token: your token</span>
+Token: your token</span></span>
 </pre>
                 </div>
             </div>
@@ -2705,10 +2746,20 @@ API.get<span data-mt-attr='{"text": {"fn": "toCSharpName", "data": "$entityName"
             </li>
         </ul>
     </div>
+    <div data-mt-cond='{"view.codeHint.output.fields": {"$exists": true}}'>
+        <h4>Dữ liệu trả về</h4>
+        Mảng các object:
+        <pre data-mt-attr='{"html": {"fn": "formatHintModal", "data": ["$view.codeHint.output.fields"]}}'></pre>
+        <div  data-mt-cond='{"view.emptyResult": {"$exists": true}}'>
+            Nếu không có phần tử nào, mảng giá trị sau sẽ được trả về:
+            <pre data-mt-attr='{"text": {"fn": "JSON.stringify", "data": ["$view.emptyResult", null, 4]}}'></pre>
+        </div>
+    </div>
     <div class="driver-snippet">
         <h4>Code mẫu</h4>
         <ul class="nav nav-tabs">
             <li role="presentation" class="active"><a data-role="Javascript" data-mt-event='{"click": "activeRoleTab"}'>Javascript</a></li>
+            <li role="presentation"><a data-role="JavascriptModel" data-mt-event='{"click": "activeRoleTab"}'>JavascriptModel</a></li>
             <li role="presentation"><a data-role="CSharp" data-mt-event='{"click": "activeRoleTab"}'>CSharp</a></li>
             <li role="presentation"><a data-role="HTTP" data-mt-event='{"click": "activeRoleTab"}'>HTTP</a></li>
             <li role="presentation"><a data-role="cURL" data-mt-event='{"click": "activeRoleTab"}'>cURL</a></li>
@@ -2729,6 +2780,16 @@ catch (e) {
 }</pre>
                 </div>
             </div>
+            <div class="tab-page JavascriptModel" data-role="JavascriptModel">
+                <div class="js-modal-snippet">
+                    Javascript UNDEFINED model
+                    <pre data-language="json" data-mt-attr='{"html": {"fn": "formatHintModal", "data": ["$view.codeHint.output.fields", "", {"mode": "modal_undefined"}]}}'></pre>
+                    Javascript VALUE model
+                    <pre data-language="json" data-mt-attr='{"html": {"fn": "formatHintModal", "data": ["$view.codeHint.output.fields", "", {"mode": "modal"}]}}'></pre>
+                    Javascript NULL model
+                    <pre data-language="json" data-mt-attr='{"html": {"fn": "formatHintModal", "data": ["$view.codeHint.output.fields", "", {"mode": "modal_null"}]}}'></pre>
+                </div>
+            </div>
             <div class="tab-page CSharp" data-role="CSharp">
                 <div class="csharp-driver-snippet">
                     <p>Hỗ trợ: DotNet Framework 4.5+, DotNet Core 3.1+, Unity3D, Mono</p>