@sankhyalabs/sankhyablocks 9.2.0-dev.4 → 9.2.0-dev.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."
+            }]
         }
       }
     };

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

@@ -470,8 +470,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Usado para determinar O alinhamento dos items na taskbar."
+          "tags": [{
+              "name": "description",
+              "text": "Define o alinhamento dos itens da barra de tarefas \u00E0 direita."
+            }],
+          "text": ""
         },
         "attribute": "align-rigth",
         "reflect": false,
@@ -488,8 +491,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Usado para determinar o identificador do slot que recebe elementos personalizados."
+          "tags": [{
+              "name": "description",
+              "text": "Define o identificador do slot que recebe elementos personalizados."
+            }],
+          "text": ""
         },
         "attribute": "custom-slot-id",
         "reflect": false,
@@ -506,8 +512,14 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Usado para determinar o identificador do container na DOM que \u00E9 responsavel por guardar os elementos personalizados\nque n\u00E3o podem ser passados por slot.\n\nExemplo: Elementos customizados na Taskbar da aba de detalhes."
+          "tags": [{
+              "name": "description",
+              "text": "Define o identificador do cont\u00EAiner na DOM que \u00E9 respons\u00E1vel por guardar os elementos personalizados\nque n\u00E3o podem ser passados por slot."
+            }, {
+              "name": "example",
+              "text": "Elementos customizados na Taskbar da aba de detalhes."
+            }],
+          "text": ""
         },
         "attribute": "custom-container-id",
         "reflect": false
@@ -523,8 +535,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Define como ser\u00E1 o comportamento da taskbar quando ocorrer overflow"
+          "tags": [{
+              "name": "description",
+              "text": "Define como ser\u00E1 o comportamento da barra de tarefas quando ocorrer um overflow de itens."
+            }],
+          "text": ""
         },
         "attribute": "overflow-strategy",
         "reflect": false,
@@ -541,8 +556,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Usado para guardar ou recuperar as configura\u00E7\u00F5es do formul\u00E1rio."
+          "tags": [{
+              "name": "description",
+              "text": "Nome da configura\u00E7\u00E3o usada para salvar ou recuperar as configura\u00E7\u00F5es do formul\u00E1rio. Tamb\u00E9m \u00E9 utilizado como fallback para a chave de armazenamento do exportador de dados."
+            }],
+          "text": ""
         },
         "attribute": "config-name",
         "reflect": false
@@ -558,8 +576,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Identificador de recursos como configura\u00E7\u00F5es e acesso."
+          "tags": [{
+              "name": "description",
+              "text": "Identificador de recursos, como configura\u00E7\u00F5es e permiss\u00F5es de acesso."
+            }],
+          "text": ""
         },
         "attribute": "resource-i-d",
         "reflect": false
@@ -575,8 +596,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Lista separada por virgula, contendo todos os elementos a serem criados."
+          "tags": [{
+              "name": "description",
+              "text": "Lista de bot\u00F5es, separados por v\u00EDrgula, que define todos os elementos a serem criados na barra de tarefas."
+            }],
+          "text": ""
         },
         "attribute": "buttons",
         "reflect": false
@@ -599,8 +623,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Mapa com defini\u00E7\u00E3o de bot\u00F5es personalizados. A chave do mapa deve ser\npassada na lista \"buttons\" no lugar onde o bot\u00E3o ir\u00E1 aparecer."
+          "tags": [{
+              "name": "description",
+              "text": "Mapa com defini\u00E7\u00F5es de bot\u00F5es personalizados. A chave do mapa deve ser informada na propriedade `buttons` no local onde o bot\u00E3o deve ser renderizado."
+            }],
+          "text": ""
         }
       },
       "actionsList": {
@@ -621,8 +648,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Lista de a\u00E7\u00F5es que devem ser usadas no bot\u00E3o \"Mais op\u00E7\u00F5es\" do componente snk-taskbar."
+          "tags": [{
+              "name": "description",
+              "text": "Lista de a\u00E7\u00F5es a serem exibidas no bot\u00E3o \"Mais op\u00E7\u00F5es\"."
+            }],
+          "text": ""
         }
       },
       "actionsSettingsList": {
@@ -643,8 +673,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Lista de a\u00E7\u00F5es que devem ser usadas no bot\u00E3o \"Mais op\u00E7\u00F5es\" do componente snk-taskbar."
+          "tags": [{
+              "name": "description",
+              "text": "Lista de a\u00E7\u00F5es que devem ser usadas no bot\u00E3o \"Mais op\u00E7\u00F5es\" do componente snk-taskbar."
+            }],
+          "text": ""
         }
       },
       "primaryButton": {
@@ -658,8 +691,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Determina qual bot\u00E3o deve ter apar\u00EAncia prim\u00E1ria."
+          "tags": [{
+              "name": "description",
+              "text": "Define qual bot\u00E3o deve ter a apar\u00EAncia de destaque (prim\u00E1rio)."
+            }],
+          "text": ""
         },
         "attribute": "primary-button",
         "reflect": false
@@ -679,8 +715,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Array contendo todos os bot\u00F5es a serem desabilitados."
+          "tags": [{
+              "name": "description",
+              "text": "Array contendo os identificadores de todos os bot\u00F5es que devem ser desabilitados."
+            }],
+          "text": ""
         }
       },
       "dataUnit": {
@@ -699,8 +738,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Inst\u00E2ncia do DataUnit."
+          "tags": [{
+              "name": "description",
+              "text": "Inst\u00E2ncia do `DataUnit` com a qual a barra de tarefas ir\u00E1 interagir para realizar opera\u00E7\u00F5es de dados (ex: salvar, pr\u00F3ximo, anterior)."
+            }],
+          "text": ""
         }
       },
       "presentationMode": {
@@ -719,8 +761,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Altera o modo de apresenta\u00E7\u00E3o dos bot\u00F5es do snk-taskbar."
+          "tags": [{
+              "name": "description",
+              "text": "Altera o modo de apresenta\u00E7\u00E3o dos bot\u00F5es da barra de tarefas."
+            }],
+          "text": ""
         },
         "attribute": "presentation-mode",
         "reflect": true,
@@ -742,8 +787,11 @@ export class SnkTaskbar {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
+          "tags": [{
+              "name": "description",
+              "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
+            }],
+          "text": ""
         }
       }
     };
@@ -769,8 +817,14 @@ export class SnkTaskbar {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": "Emitido sempre que houver click de bot\u00E3o ou a\u00E7\u00E3o."
+          "tags": [{
+              "name": "description",
+              "text": "Emitido sempre que um bot\u00E3o ou uma a\u00E7\u00E3o da barra de tarefas \u00E9 clicado."
+            }, {
+              "name": "eventProperty",
+              "text": undefined
+            }],
+          "text": ""
         },
         "complexType": {
           "original": "string",
@@ -784,8 +838,14 @@ export class SnkTaskbar {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": "Emitido sempre que um save \u00E9 iniciado pela taskbar."
+          "tags": [{
+              "name": "description",
+              "text": "Emitido quando uma a\u00E7\u00E3o de salvar \u00E9 iniciada pela barra de tarefas, indicando um estado de bloqueio para evitar a\u00E7\u00F5es concorrentes."
+            }, {
+              "name": "eventProperty",
+              "text": undefined
+            }],
+          "text": ""
         },
         "complexType": {
           "original": "void",
@@ -799,8 +859,14 @@ export class SnkTaskbar {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": "Emitido sempre que o ocorre alguma action que libera o save."
+          "tags": [{
+              "name": "description",
+              "text": "Emitido quando a a\u00E7\u00E3o de salvar \u00E9 conclu\u00EDda ou cancelada, liberando o estado de bloqueio."
+            }, {
+              "name": "eventProperty",
+              "text": undefined
+            }],
+          "text": ""
         },
         "complexType": {
           "original": "void",

package/dist/components/snk-form.js

@@ -33,18 +33,26 @@ const SnkForm$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
   }
   /**
    * 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) {
@@ -57,10 +65,28 @@ const SnkForm$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
   }
   /**
    * 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();
   }
@@ -150,7 +176,8 @@ const SnkForm$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
     "showConfig": [64],
     "hideConfig": [64],
     "addCustomEditor": [64],
-    "setFieldProp": [64]
+    "setFieldProp": [64],
+    "validate": [64]
   }]);
 function defineCustomElement$1() {
   if (typeof customElements === "undefined") {