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

package/dist/cjs/snk-data-exporter.cjs.entry.js

@@ -9,7 +9,7 @@ const IFetchDataExporterParams = require('./IFetchDataExporterParams-e78ec415.js
 const index = require('./index-e3e39724.js');
 const constants = require('./constants-6d82e405.js');
 const DataFetcher = require('./DataFetcher-ad9fb3bb.js');
-const snkDataUnit = require('./snk-data-unit-448fce74.js');
+const snkDataUnit = require('./snk-data-unit-72715da9.js');
 require('./ISave-18ffb73e.js');
 require('@sankhyalabs/ezui/dist/collection/utils/constants');
 require('@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata');

package/dist/cjs/{snk-data-unit-448fce74.js → snk-data-unit-72715da9.js}

@@ -237,6 +237,8 @@ const SnkDataUnit = class {
   }
   /**
    * Obtém o dataUnit.
+   * @returns {Promise<DataUnit>} Uma promessa que resolve com a instância do DataUnit.
+   * @async
    */
   async getDataUnit() {
     return new Promise((resolve) => {
@@ -250,25 +252,33 @@ const SnkDataUnit = class {
   }
   /**
    * 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.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);

package/dist/cjs/snk-data-unit.cjs.entry.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-const snkDataUnit = require('./snk-data-unit-448fce74.js');
+const snkDataUnit = require('./snk-data-unit-72715da9.js');
 require('./index-1cf293c1.js');
 require('@sankhyalabs/core');
 require('@sankhyalabs/ezui/dist/collection/utils');

package/dist/cjs/snk-grid.cjs.entry.js

@@ -171,11 +171,18 @@ const SnkGrid = class {
       btns.unshift(taskbarElements.TaskbarElement.UPDATE_MULTIPLE);
     return btns;
   }
+  /**
+   * Recarrega a configuração da grade.
+   * @description Este método força o recarregamento da configuração da grade a partir do `ConfigStorage`. A operação é assíncrona, mas o método não aguarda sua conclusão.
+   */
   reloadConfig() {
     this.loadConfig();
   }
   /**
    * Exibe a janela de configurações da grade.
+   * @async
+   * @description Este método abre o pop-up de configuração de colunas da grade, permitindo ao usuário ajustar a visibilidade, ordem e largura das colunas.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é exibida.
    */
   async showConfig() {
     if (this._grid == undefined) {
@@ -185,6 +192,9 @@ const SnkGrid = class {
   }
   /**
    * Fecha a janela de configurações da grade.
+   * @async
+   * @description Este método fecha o pop-up de configuração de colunas da grade.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando a janela de configuração é fechada.
    */
   async hideConfig() {
     if (this._grid == undefined) {
@@ -193,26 +203,42 @@ const SnkGrid = class {
     this.closeGridConfig();
   }
   /**
-   * Atribui o valor da configuração da grade.
+   * Define a configuração da grade.
+   * @async
+   * @description Aplica uma nova configuração de colunas e ordenação à grade.
+   * @param {IGridConfig} config O objeto de configuração a ser aplicado na grade.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando a configuração é aplicada.
    */
   async setConfig(config) {
     this.setGridConfig(config);
   }
   /**
-   * Faz o recarregamento da filter-bar da grade buscando o state no servidor.
+   * Recarrega a barra de filtros da grade, buscando o estado do servidor.
+   * @async
+   * @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando a barra de filtros é recarregada.
    */
   async reloadFilterBar() {
     var _a;
     (_a = this._snkFilterBar) === null || _a === void 0 ? void 0 : _a.reload();
   }
   /**
-   * Retorna o elemento da filter-bar da grade.
+   * Retorna o elemento da barra de filtros da grade.
+   * @async
+   * @description Este método permite acessar o elemento da barra de filtros, que pode ser útil para manipulações adicionais ou para obter o estado atual dos filtros aplicados.
+   * @returns {Promise<HTMLSnkFilterBarElement>} O elemento da barra de filtros.
    */
   async getFilterBar() {
     return this._snkFilterBar;
   }
   /**
-   * Registra um editor customizado para campos da grade e formulário
+   * Registra um editor customizado para um campo da grade ou formulário.
+   * @async
+   * @description Adiciona um componente de edição personalizado para um campo específico. Este editor será usado tanto na edição em linha na grade quanto em formulários de detalhe.
+   * @param {string} fieldName O nome do campo que receberá o editor customizado.
+   * @param {ICustomEditor} customEditor A instância do editor customizado.
+   * @param {string} [detailContext] O contexto de detalhe onde o editor será aplicado (opcional).
+   * @returns {Promise<void>} Uma promessa que é resolvida quando o editor é registrado.
    */
   async addCustomEditor(fieldName, customEditor, detailContext) {
     if (this._grid) {
@@ -224,7 +250,13 @@ const SnkGrid = class {
     this._customEditors = newCustomEditors;
   }
   /**
-   * Registra um render customizado para colunas da grid.
+   * Registra um renderizador customizado para uma coluna da grade.
+   * @async
+   * @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células.
+   * @param {string} fieldName O nome do campo (coluna) que receberá o renderizador customizado.
+   * @param {ICustomRender} customRender A instância do renderizador customizado.
+   * @param {string} [detailContext] O contexto de detalhe onde o renderizador será aplicado (opcional).
+   * @returns {Promise<void>} Uma promessa que é resolvida quando o renderizador é registrado.
    */
   async addGridCustomRender(fieldName, customRender, detailContext) {
     if (this._grid) {
@@ -236,19 +268,31 @@ const SnkGrid = class {
     this._customRenders = newCustomRenders;
   }
   /**
-   * Registra um formatador de valores para uma coluna da grid.
+   * Registra um formatador de valor customizado para uma coluna da grade.
+   * @async
+   * @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos.
+   * @param {string} columnName O nome da coluna que receberá o formatador.
+   * @param {ICustomFormatter} customFormatter A instância do formatador de valor.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é registrado.
    */
   async addCustomValueFormatter(columnName, customFormatter) {
     this._grid.addCustomValueFormatter(columnName, customFormatter);
   }
   /**
-   * Remove o formatador de valores de uma coluna da grid.
+   * Remove um formatador de valor customizado de uma coluna da grade.
+   * @async
+   * @description Remove uma função de formatação personalizada previamente registrada para uma coluna.
+   * @param {string} columnName O nome da coluna da qual o formatador será removido.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando o formatador é removido.
    */
   async removeCustomValueFormatter(columnName) {
     this._grid.removeCustomValueFormatter(columnName);
   }
   /**
    * Atribui o foco para a grade.
+   * @async
+   * @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado.
+   * @returns {Promise<void>} Uma promessa que é resolvida quando o foco é atribuído.
    */
   async setFocus() {
     this._grid.setFocus();

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