@sankhyalabs/sankhyablocks 9.1.5 → 9.1.6

package/dist/collection/components/snk-form/snk-form.js

@@ -17,18 +17,26 @@ export class SnkForm {
   }
   /**
    * Exibe a janela de configurações do formulário.
+   * @async
+   * @returns {Promise<void>}
    */
   async showConfig() {
     this._showFormConfig = true;
   }
   /**
    * Fecha a janela de configurações do formulário.
+   * @async
+   * @returns {Promise<void>}
    */
   async hideConfig() {
     this._showFormConfig = false;
   }
   /**
-   * Registra um editor customizado para campos da grade e formulário.
+   * Registra um editor customizado para campos do formulário.
+   * @async
+   * @param {string} fieldName - Nome do campo.
+   * @param {ICustomEditor} customEditor - Editor customizado.
+   * @returns {Promise<void>}
    */
   async addCustomEditor(fieldName, customEditor) {
     if (this._form) {
@@ -41,10 +49,28 @@ export class SnkForm {
   }
   /**
    * Altera/adiciona uma propriedade nos metadados do campo.
+   * @async
+   * @param {string} fieldName - Nome do campo.
+   * @param {string} propName - Nome da propriedade.
+   * @param {any} value - Valor da propriedade.
+   * @returns {Promise<void>}
    */
   async setFieldProp(fieldName, propName, value) {
     await this._form.setFieldProp(fieldName, propName, value);
   }
+  /**
+   * Valida o formulário.
+   * @async
+   * @returns {Promise<void>}
+   * @description
+   * Este método executa a validação do formulário, verificando se todos os campos estão
+   * preenchidos corretamente de acordo com as regras definidas.
+   * Se a validação falhar, uma exceção será lançada com os detalhes dos erros encontrados.
+   * Caso contrário, o método será resolvido sem erros.
+   */
+  async validate() {
+    await this._form.validate();
+  }
   closeConfig() {
     this.hideConfig();
   }
@@ -203,7 +229,7 @@ export class SnkForm {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Chave da configura\u00E7\u00E3o legado do formul\u00E1rio."
+          "text": "Chave da configura\u00E7\u00E3o legada do formul\u00E1rio."
         },
         "attribute": "form-legacy-config-name",
         "reflect": false
@@ -243,8 +269,11 @@ export class SnkForm {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": "Emitido quando o bot\u00E3o de voltar \u00E9 acionado."
+          "tags": [{
+              "name": "deprecated",
+              "text": "Esta propriedade foi descontinuada. Ela n\u00E3o tem mais efeito sobre o componente."
+            }],
+          "text": ""
         },
         "complexType": {
           "original": "void",
@@ -258,8 +287,11 @@ export class SnkForm {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": "Emitido sempre que houver click de bot\u00E3o ou a\u00E7\u00E3o."
+          "tags": [{
+              "name": "deprecated",
+              "text": "Esta propriedade foi descontinuada. Ela n\u00E3o tem mais efeito sobre o componente."
+            }],
+          "text": ""
         },
         "complexType": {
           "original": "string",
@@ -274,7 +306,7 @@ export class SnkForm {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Respons\u00E1vel por notificar quando ocorrer a renderiza\u00E7\u00E3o de itens do formul\u00E1rio."
+          "text": "Respons\u00E1vel por notificar quando ocorrer a renderiza\u00E7\u00E3o de itens do formul\u00E1rio.\nOBS: Emitido no subcomponente snk-form-view"
         },
         "complexType": {
           "original": "Array<HTMLElement>",
@@ -305,7 +337,13 @@ export class SnkForm {
         },
         "docs": {
           "text": "Exibe a janela de configura\u00E7\u00F5es do formul\u00E1rio.",
-          "tags": []
+          "tags": [{
+              "name": "async",
+              "text": undefined
+            }, {
+              "name": "returns",
+              "text": undefined
+            }]
         }
       },
       "hideConfig": {
@@ -321,18 +359,30 @@ export class SnkForm {
         },
         "docs": {
           "text": "Fecha a janela de configura\u00E7\u00F5es do formul\u00E1rio.",
-          "tags": []
+          "tags": [{
+              "name": "async",
+              "text": undefined
+            }, {
+              "name": "returns",
+              "text": undefined
+            }]
         }
       },
       "addCustomEditor": {
         "complexType": {
           "signature": "(fieldName: string, customEditor: ICustomEditor) => Promise<void>",
           "parameters": [{
-              "tags": [],
-              "text": ""
+              "tags": [{
+                  "name": "param",
+                  "text": "fieldName - Nome do campo."
+                }],
+              "text": "- Nome do campo."
             }, {
-              "tags": [],
-              "text": ""
+              "tags": [{
+                  "name": "param",
+                  "text": "customEditor - Editor customizado."
+                }],
+              "text": "- Editor customizado."
             }],
           "references": {
             "Promise": {
@@ -346,22 +396,43 @@ export class SnkForm {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "Registra um editor customizado para campos da grade e formul\u00E1rio.",
-          "tags": []
+          "text": "Registra um editor customizado para campos do formul\u00E1rio.",
+          "tags": [{
+              "name": "async",
+              "text": undefined
+            }, {
+              "name": "param",
+              "text": "fieldName - Nome do campo."
+            }, {
+              "name": "param",
+              "text": "customEditor - Editor customizado."
+            }, {
+              "name": "returns",
+              "text": undefined
+            }]
         }
       },
       "setFieldProp": {
         "complexType": {
           "signature": "(fieldName: string, propName: string, value: any) => Promise<void>",
           "parameters": [{
-              "tags": [],
-              "text": ""
+              "tags": [{
+                  "name": "param",
+                  "text": "fieldName - Nome do campo."
+                }],
+              "text": "- Nome do campo."
             }, {
-              "tags": [],
-              "text": ""
+              "tags": [{
+                  "name": "param",
+                  "text": "propName - Nome da propriedade."
+                }],
+              "text": "- Nome da propriedade."
             }, {
-              "tags": [],
-              "text": ""
+              "tags": [{
+                  "name": "param",
+                  "text": "value - Valor da propriedade."
+                }],
+              "text": "- Valor da propriedade."
             }],
           "references": {
             "Promise": {
@@ -372,7 +443,47 @@ export class SnkForm {
         },
         "docs": {
           "text": "Altera/adiciona uma propriedade nos metadados do campo.",
-          "tags": []
+          "tags": [{
+              "name": "async",
+              "text": undefined
+            }, {
+              "name": "param",
+              "text": "fieldName - Nome do campo."
+            }, {
+              "name": "param",
+              "text": "propName - Nome da propriedade."
+            }, {
+              "name": "param",
+              "text": "value - Valor da propriedade."
+            }, {
+              "name": "returns",
+              "text": undefined
+            }]
+        }
+      },
+      "validate": {
+        "complexType": {
+          "signature": "() => Promise<void>",
+          "parameters": [],
+          "references": {
+            "Promise": {
+              "location": "global"
+            }
+          },
+          "return": "Promise<void>"
+        },
+        "docs": {
+          "text": "Valida o formul\u00E1rio.",
+          "tags": [{
+              "name": "async",
+              "text": undefined
+            }, {
+              "name": "returns",
+              "text": undefined
+            }, {
+              "name": "description",
+              "text": "Este m\u00E9todo executa a valida\u00E7\u00E3o do formul\u00E1rio, verificando se todos os campos est\u00E3o \npreenchidos corretamente de acordo com as regras definidas.\nSe a valida\u00E7\u00E3o falhar, uma exce\u00E7\u00E3o ser\u00E1 lan\u00E7ada com os detalhes dos erros encontrados.\nCaso contr\u00E1rio, o m\u00E9todo ser\u00E1 resolvido sem erros."
+            }]
         }
       }
     };