@sankhyalabs/sankhyablocks 9.2.0-ms.2 → 9.2.0-ms.4

package/dist/collection/components/snk-data-unit/snk-data-unit.js

@@ -100,6 +100,8 @@ export class SnkDataUnit {
   }
   /**
    * Obtém o dataUnit.
+   * @returns {Promise<DataUnit>} Uma promessa que resolve com a instância do DataUnit.
+   * @async
    */
   async getDataUnit() {
     return new Promise((resolve) => {
@@ -113,25 +115,33 @@ export class SnkDataUnit {
   }
   /**
    * Método que retorna a lista de IDs dos registros selecionados.
-   * @returns Retorna a lista de IDs dos registros selecionados.
+   * @returns {Promise<Array<IRecordID>>} Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
+   * @async
    */
   async getSelectedRecordsIDsInfo() {
     return getSelectedRecordsIDsInfo(this.dataUnit);
   }
   /**
    * Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
+   * @returns {Promise<string[]>} Uma promessa que resolve com um array de nomes de campos.
+   * @async
    */
   async getFieldsWithRmp() {
     return this._fieldsWithRmp;
   }
   /**
    * Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
+   * @returns {Promise<string[]>} Uma promessa que resolve com um array de nomes de campos.
+   * @async
    */
   async getFieldsWithRmPrecision() {
     return this._fieldsWithRmPrecision;
   }
   /**
    * Busca os metadados da linha selecionada.
+   * @param {Record | string} [record] - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado.
+   * @returns {Promise<RowMetadata>} Uma promessa que resolve com os metadados da linha.
+   * @async
    */
   async getRowMetadata(record) {
     return this.doGetRowMetadata(record);
@@ -773,7 +783,10 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "type",
+              "text": "{DataState}"
+            }],
           "text": "Controla o estado atual dos dados."
         }
       },
@@ -793,7 +806,10 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "type",
+              "text": "{SnkMessageBuilder}"
+            }],
           "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
         }
       },
@@ -808,7 +824,10 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "type",
+              "text": "{string}"
+            }],
           "text": "Usado para criar o dataUnit uma \u00FAnica vez.\nSe omitido, ser\u00E1 usado o pr\u00F3prio nome da entidade."
         },
         "attribute": "data-unit-name",
@@ -825,7 +844,10 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "type",
+              "text": "{string}"
+            }],
           "text": "Determina qual a entidade que representa os dados em quest\u00E3o."
         },
         "attribute": "entity-name",
@@ -842,7 +864,13 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "type",
+              "text": "{number}"
+            }, {
+              "name": "default",
+              "text": "150"
+            }],
           "text": "Determina quantas linhas s\u00E3o retornadas por p\u00E1gina."
         },
         "attribute": "page-size",
@@ -865,7 +893,10 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "type",
+              "text": "{DataUnit}"
+            }],
           "text": "Uma vez instanciado, pode-se obter o dataUnit por esta propriedade."
         }
       },
@@ -888,7 +919,13 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "param",
+              "text": "dataUnit - A inst\u00E2ncia do DataUnit."
+            }, {
+              "name": "returns",
+              "text": "`false` para cancelar a a\u00E7\u00E3o, `true` para continuar."
+            }],
           "text": "Executado imediatamente antes da a\u00E7\u00E3o de salvar as altera\u00E7\u00F5es. \u00DAtil no caso de valida\u00E7\u00F5es por exemplo.\nCaso retorne \"false\" (ou a promessa se resolva como false), cancela a a\u00E7\u00E3o."
         }
       },
@@ -908,7 +945,13 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "param",
+              "text": "dataUnit - A inst\u00E2ncia do DataUnit."
+            }, {
+              "name": "returns",
+              "text": undefined
+            }],
           "text": "Executado ap\u00F3s a a\u00E7\u00E3o de salvar."
         }
       },
@@ -923,7 +966,13 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "type",
+              "text": "{boolean}"
+            }, {
+              "name": "default",
+              "text": "true"
+            }],
           "text": "Determina se ser\u00E1 usado mensagem de confirma\u00E7\u00E3o padr\u00E3o na tentativa de cancelar a edi\u00E7\u00E3o."
         },
         "attribute": "use-cancel-confirm",
@@ -941,7 +990,10 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "type",
+              "text": "{boolean}"
+            }],
           "text": "Respons\u00E1vel por evitar a mensagem de sucesso ao salvar."
         },
         "attribute": "ignore-save-message",
@@ -958,7 +1010,10 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "type",
+              "text": "{string}"
+            }],
           "text": "Usado para obter configura\u00E7\u00E3o de metadados."
         },
         "attribute": "config-name",
@@ -975,7 +1030,10 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "type",
+              "text": "{string}"
+            }],
           "text": "Identificador de recursos como configura\u00E7\u00F5es e acesso."
         },
         "attribute": "resource-i-d",
@@ -992,7 +1050,10 @@ export class SnkDataUnit {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "type",
+              "text": "{string}"
+            }],
           "text": "Define a chave customizada para sobrescrever as mensagens (N\u00E3o pegando pela entidade)"
         },
         "attribute": "domain-messages-builder",
@@ -1013,7 +1074,16 @@ export class SnkDataUnit {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "event",
+              "text": "dataStateChange"
+            }, {
+              "name": "type",
+              "text": "{CustomEvent<DataState>}"
+            }, {
+              "name": "bubbles",
+              "text": "false"
+            }],
           "text": "Emitido quando h\u00E1 qualquer mudan\u00E7a de estado no DataUnit."
         },
         "complexType": {
@@ -1032,7 +1102,16 @@ export class SnkDataUnit {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "event",
+              "text": "dataUnitReady"
+            }, {
+              "name": "type",
+              "text": "{CustomEvent<DataUnit>}"
+            }, {
+              "name": "bubbles",
+              "text": "false"
+            }],
           "text": "Emitido quando o DataUnit est\u00E1 pronto."
         },
         "complexType": {
@@ -1052,8 +1131,17 @@ export class SnkDataUnit {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": "Emitido quando o DataUnit est\u00E1 pronto."
+          "tags": [{
+              "name": "event",
+              "text": "messagesBuilderUpdated"
+            }, {
+              "name": "type",
+              "text": "{CustomEvent<SnkMessageBuilder>}"
+            }, {
+              "name": "bubbles",
+              "text": "false"
+            }],
+          "text": "Emitido quando o messagesBuilder \u00E9 atualizado."
         },
         "complexType": {
           "original": "SnkMessageBuilder",
@@ -1072,7 +1160,13 @@ export class SnkDataUnit {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "event",
+              "text": "dataUnitFieldsHidded"
+            }, {
+              "name": "type",
+              "text": "{CustomEvent<void>}"
+            }],
           "text": "Emitido quando h\u00E1 campos no DataUnit que devem ser ocultados."
         },
         "complexType": {
@@ -1087,7 +1181,16 @@ export class SnkDataUnit {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "event",
+              "text": "insertionMode"
+            }, {
+              "name": "type",
+              "text": "{CustomEvent<void>}"
+            }, {
+              "name": "bubbles",
+              "text": "false"
+            }],
           "text": "Emitido quando um registro \u00E9 adicionado ou copiado."
         },
         "complexType": {
@@ -1102,7 +1205,16 @@ export class SnkDataUnit {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "event",
+              "text": "cancelEdition"
+            }, {
+              "name": "type",
+              "text": "{CustomEvent<void>}"
+            }, {
+              "name": "bubbles",
+              "text": "false"
+            }],
           "text": "Emitido quando se cancela uma inser\u00E7\u00E3o ou c\u00F3pia."
         },
         "complexType": {
@@ -1131,7 +1243,13 @@ export class SnkDataUnit {
         },
         "docs": {
           "text": "Obt\u00E9m o dataUnit.",
-          "tags": []
+          "tags": [{
+              "name": "returns",
+              "text": "Uma promessa que resolve com a inst\u00E2ncia do DataUnit."
+            }, {
+              "name": "async",
+              "text": undefined
+            }]
         }
       },
       "getSelectedRecordsIDsInfo": {
@@ -1156,7 +1274,10 @@ export class SnkDataUnit {
           "text": "M\u00E9todo que retorna a lista de IDs dos registros selecionados.",
           "tags": [{
               "name": "returns",
-              "text": "Retorna a lista de IDs dos registros selecionados."
+              "text": "Retorna uma promessa que resolve com a lista de IDs dos registros selecionados."
+            }, {
+              "name": "async",
+              "text": undefined
             }]
         }
       },
@@ -1173,7 +1294,13 @@ export class SnkDataUnit {
         },
         "docs": {
           "text": "Retorna os campos que possuem a propriedade \"rmp\" (Row Metadata Provider).",
-          "tags": []
+          "tags": [{
+              "name": "returns",
+              "text": "Uma promessa que resolve com um array de nomes de campos."
+            }, {
+              "name": "async",
+              "text": undefined
+            }]
         }
       },
       "getFieldsWithRmPrecision": {
@@ -1189,15 +1316,24 @@ export class SnkDataUnit {
         },
         "docs": {
           "text": "Retorna os campos que possuem a propriedade \"rm_precision\" (Row Metadata Precision).",
-          "tags": []
+          "tags": [{
+              "name": "returns",
+              "text": "Uma promessa que resolve com um array de nomes de campos."
+            }, {
+              "name": "async",
+              "text": undefined
+            }]
         }
       },
       "getRowMetadata": {
         "complexType": {
           "signature": "(record?: Record | string) => Promise<RowMetadata>",
           "parameters": [{
-              "tags": [],
-              "text": ""
+              "tags": [{
+                  "name": "param",
+                  "text": "record - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado."
+                }],
+              "text": "- O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado."
             }],
           "references": {
             "Promise": {
@@ -1215,7 +1351,16 @@ export class SnkDataUnit {
         },
         "docs": {
           "text": "Busca os metadados da linha selecionada.",
-          "tags": []
+          "tags": [{
+              "name": "param",
+              "text": "record - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado."
+            }, {
+              "name": "returns",
+              "text": "Uma promessa que resolve com os metadados da linha."
+            }, {
+              "name": "async",
+              "text": undefined
+            }]
         }
       }
     };

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."
+            }]
         }
       }
     };