mushroom-cli 1.2.0-alpha.26 → 1.2.0-alpha.27

package/README.md

@@ -132,6 +132,13 @@ npx mushroom-cli parameters --no-check-update
 
 ## Version
 
+### 1.2.0-alpha.27
+
+Improvement:
+
+- gen api docs
+  - add validation of fields in custom methods and parameters in views
+
 ### 1.2.0-alpha.25
 
 Improvement:
@@ -139,7 +146,7 @@ Improvement:
 - gen c#-mongo
   - support System.Text.Json on resources
 - gen api docs
-  - impove copy function
+  - improve copy function
   - allow collapse object fields
   - display the description of entities
 

package/dist/docs/docs.v2.html

@@ -109,8 +109,8 @@
 
         .actions .panel-heading .copy, .entity h2 .copy {
             display: none;
-            width: 16px;
-            height: 16px;
+            width: 15px;
+            height: 15px;
             opacity: 0.8;
             background-size: contain;
             background-image: url(data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iNTAiIGhlaWdodD0iNTAiIHZpZXdCb3g9IjAgMCA1MCA1MCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KICA8cmVjdCB4PSIxMCIgeT0iNSIgd2lkdGg9IjI1IiBoZWlnaHQ9IjMwIiBzdHJva2U9IndoaXRlIiBzdHJva2Utd2lkdGg9IjUiIGZpbGw9Im5vbmUiIC8+CiAgPHJlY3QgeD0iMTgiIHk9IjEzIiB3aWR0aD0iMjUiIGhlaWdodD0iMzAiIHN0cm9rZT0id2hpdGUiIHN0cm9rZS13aWR0aD0iNSIgZmlsbD0ibm9uZSIgLz4KPC9zdmc+);
@@ -5145,7 +5145,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}}{{validation}}, {{description}}
     </li>
 </div>
 <div class="mushroom-docs-template" id="template-view">

package/dist/docs/docs.v2.js

@@ -146,6 +146,29 @@ function explainRoles(strRoles) {
     })
     .join(' hoặc ');
 }
+
+function getValidationStringDocs(config, dontEncode) {
+  if (!config) return '';
+
+  const encode = dontEncode ? (s) => s : encodeHtml;
+
+  let validation = '';
+
+  if ('validValues' in config && Array.isArray(config.validValues))
+    validation += ', enum(' + encode(config.validValues.join(', ')) + ')';
+  if ('invalidValues' in config && Array.isArray(config.invalidValues))
+    validation += ', not allow(' + encode(config.invalidValues.join(', ')) + ')';
+  if ('pattern' in config) validation += ', pattern: /' + encode(config.pattern) + '/';
+  if ('length' in config) validation += ', length: ' + encode(config.length);
+  if ('minLength' in config) validation += ', minLength: ' + encode(config.minLength);
+  if ('maxLength' in config) validation += ', maxLength: ' + encode(config.maxLength);
+  if ('min' in config) validation += ', min: ' + encode(config.min);
+  if ('max' in config) validation += ', max: ' + encode(config.max);
+  if ('gt' in config) validation += ', gt: ' + encode(config.gt);
+  if ('lt' in config) validation += ', lt: ' + encode(config.lt);
+  return validation;
+}
+
 function getModelOutput(arrFields, fields, options) {
   if (!fields || !arrFields) return '';
 
@@ -205,37 +228,12 @@ function formatModel(obj, strIndent, options) {
         '</a>';
     }
 
-    if (child.validation) {
-      if ('validValues' in child.validation)
-        validation += ', enum(' + encodeHtml(child.validation.validValues.join(', ')) + ')';
-      if ('invalidValues' in child.validation)
-        validation += ', not allow(' + encodeHtml(child.validation.invalidValues.join(', ')) + ')';
-      if ('pattern' in child.validation) validation += ', pattern: /' + encodeHtml(child.validation.pattern) + '/';
-      if ('length' in child.validation) validation += ', length: ' + child.validation.length;
-      if ('minLength' in child.validation) validation += ', minLength: ' + child.validation.minLength;
-      if ('maxLength' in child.validation) validation += ', maxLength: ' + child.validation.maxLength;
-      if ('min' in child.validation) validation += ', min: ' + encodeHtml(child.validation.min);
-      if ('max' in child.validation) validation += ', max: ' + encodeHtml(child.validation.max);
-      if ('gt' in child.validation) validation += ', gt: ' + encodeHtml(child.validation.gt);
-      if ('lt' in child.validation) validation += ', lt: ' + encodeHtml(child.validation.lt);
-    }
+    validation += getValidationStringDocs(child.validation);
 
     if (child.type === 'array' && child.items && child.items.type != 'object' && child.items.validation) {
       validation +=
         ', array items: ' + (!options.optionalToAll && child.items.validation.required ? 'required' : 'optional');
-      if ('validValues' in child.items.validation)
-        validation += ', enum(' + encodeHtml(child.items.validation.validValues.join(', ')) + ')';
-      if ('invalidValues' in child.items.validation)
-        validation += ', not allow(' + encodeHtml(child.items.validation.invalidValues.join(', ')) + ')';
-      if ('pattern' in child.items.validation)
-        validation += ', pattern: /' + encodeHtml(child.items.validation.pattern) + '/';
-      if ('length' in child.items.validation) validation += ', length: ' + child.items.validation.length;
-      if ('minLength' in child.items.validation) validation += ', minLength: ' + child.items.validation.minLength;
-      if ('maxLength' in child.items.validation) validation += ', maxLength: ' + child.items.validation.maxLength;
-      if ('min' in child.items.validation) validation += ', min: ' + encodeHtml(child.items.validation.min);
-      if ('max' in child.items.validation) validation += ', max: ' + encodeHtml(child.items.validation.max);
-      if ('gt' in child.items.validation) validation += ', gt: ' + encodeHtml(child.items.validation.gt);
-      if ('lt' in child.items.validation) validation += ', lt: ' + encodeHtml(child.items.validation.lt);
+      validation += getValidationStringDocs(child.items.validation);
     }
 
     let defaultValueDocs = '';
@@ -301,7 +299,7 @@ function formatModel(obj, strIndent, options) {
     } else {
       const fieldIdx = 'f_' + __field_idx.toString(36);
       __field_idx++;
-      result += '\r\n' + strIndent + (child.type === 'object' || child.type === 'array' && child.items.type === 'object' ? '<span class="collapsable-field" data-field-idx="' + fieldIdx + '" onclick="collapseThisField(this)">' + encodeHtml(m) + '</span>' : encodeHtml(m)) + ': ' + encodeHtml(child.type);
+      result += '\r\n' + strIndent + (child.type === 'object' || child.type === 'array' && child.items.type === 'object' ? '<span class="collapsable-field" data-field-idx="' + fieldIdx + '" onclick="collapseThisField(this)" title="Thu nhỏ">' + encodeHtml(m) + '</span>' : encodeHtml(m)) + ': ' + encodeHtml(child.type);
       if (child.type === 'array') result += child.items.type === 'object' ? ' of object' : ' of ' + child.items.type;
       if (child.type === 'object') result += ' ' + comment + '<span id="' + fieldIdx + '">' + formatModel(child.fields, strIndent + '    ', options) + '</span>';
       else if (child.type === 'array' && child.items.type === 'object')
@@ -319,6 +317,7 @@ function formatModel(obj, strIndent, options) {
 function collapseThisField(dom) {
   dom.classList.toggle('collapsed');
   document.getElementById(dom.dataset.fieldIdx).classList.toggle('collapsed');
+  dom.title = dom.classList.contains('collapsed') ? 'Mở rộng' : 'Thu nhỏ';
 }
 function toCachePolicyString(cachePolicy) {
   if (cachePolicy === undefined || cachePolicy === null || cachePolicy === 'unset') return 'Không thiết lập cấu hình';
@@ -384,14 +383,11 @@ function formatHintModel(obj, strIndent, options) {
         '</a>';
     }
 
-    if (child.validValues && Array.isArray(child.validValues)) {
-      validation += ', enum(' + encodeHtml(child.validValues.join(', ')) + ')';
-    }
+    validation += getValidationStringDocs(child);
 
     if (child.type === 'array' && child.items && child.items.type != 'object') {
       validation += ', array items: ' + (!options.optionalToAll && child.items.required ? 'required' : 'optional');
-      if (child.items.validValues && Array.isArray(child.items.validValues))
-        validation += ', enum(' + encodeHtml(child.items.validValues.join(', ')) + ')';
+      validation += getValidationStringDocs(child.items);
     }
 
     var comment = options.hideComment ? '' : `<span class="code-comment">// ${validation} ${typeof child.description === 'string' && child.description !== '' ? '- ' + encodeHtml(child.description).replace(/\n/g, ' ') : ''}</span>`;
@@ -1029,6 +1025,7 @@ function renderGeneralAction(args) {
         type: (field.type === 'array' ? 'array of ' : '') + (field.items?.type ?? 'string'),
         description: field.description ?? '',
         required: field.required ? 'required' : 'optional',
+        validation: getValidationStringDocs(p, true),
       })
     }).join('');
   } else {
@@ -1154,6 +1151,7 @@ function renderEntityViewRolePage(entityName, viewName, grant) {
           description: p.description ?? '',
           defaultValue: p.defaultValue ? `, default (${p.defaultValue})` : '',
           required: p.required ? 'required' : 'optional',
+          validation: getValidationStringDocs(p.validation, true),
         }),
       )
       .join('');

package/package.json

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