@sankhyalabs/sankhyablocks 9.2.0-ms.1 → 9.2.0-ms.11

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

@@ -159,6 +159,7 @@ const SnkGrid = class {
     this.multipleEditionEnabled = true;
     this.paginationCounterMode = 'auto';
     this.suppressCheckboxColumn = undefined;
+    this.suppressFilterColumn = false;
     this.compact = undefined;
   }
   getGridHeaderSelectedBtns() {
@@ -171,11 +172,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 +193,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 +204,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 +251,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 +269,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/cjs/snk-personalized-filter.cjs.entry.js

@@ -47,8 +47,10 @@ const SnkPersonalizedFilter = class {
     this.resourceID = undefined;
     this.isDefaultFilter = false;
   }
-  /*
-   * Cria um novo filtro se não houver nenhum filtro existente
+  /**
+   * Cria um novo filtro personalizado caso não exista nenhum.
+   * @method
+   * @returns {Promise<void>}
    */
   async createPersonalizedFilter() {
     const newPersonalizedFilter = {
@@ -84,6 +86,12 @@ const SnkPersonalizedFilter = class {
     this._originalFilterAssistent = core.ObjectUtils.copy(newPersonalizedFilter);
     this._filterAssistent = core.ObjectUtils.copy(newPersonalizedFilter);
   }
+  /**
+   * Carrega o filtro personalizado com base no identificador informado.
+   * @watch filterId
+   * @param newValue Novo valor do filtroId.
+   * @param oldValue Valor anterior do filtroId.
+   */
   loadFilter(newValue, oldValue) {
     if (newValue == null || oldValue == newValue || this.resourceID == undefined) {
       return;

package/dist/cjs/snk-simple-bar.cjs.entry.js

@@ -17,11 +17,11 @@ const SnkSimpleBar = class {
     this.messagesBuilder = undefined;
   }
   /**
-   * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
-   * através de um pequeno modulo na estrutura da aplicação:
-   * - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
-   * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-simple-bar.msg.ts"
-  */
+   * Permite customizar as mensagens dos blocos de construção
+   * através de um pequeno módulo na estrutura da aplicação:
+   * - Crie um arquivo no seguinte caminho: /messages/appmessages.msg.js.
+   * Para conhecer os detalhes do módulo, veja o arquivo neste projeto: "/src/lib/message/resources/snk-simple-bar.msg.ts"
+   */
   getMessage(key, params) {
     var _a;
     if (this.messagesBuilder)

package/dist/cjs/snk-simple-crud.cjs.entry.js

@@ -86,7 +86,10 @@ const SnkSimpleCrud = class {
     this.outlineMode = false;
   }
   /**
-   * Registra um editor customizado para campos da grade e formulário.
+   * @description Registra um editor customizado para campos da grade e do formulário.
+   * @param {string} fieldName - O nome do campo.
+   * @param {ICustomEditor} customEditor - A instância do editor customizado.
+   * @returns {Promise<void>}
    */
   async addCustomEditor(fieldName, customEditor) {
     if (this._grid && this._form) {
@@ -99,7 +102,10 @@ const SnkSimpleCrud = class {
     this._customEditors = newCustomEditors;
   }
   /**
-   * Registra um render customizado para colunas da grid.
+   * @description Registra um renderizador customizado para colunas da grade.
+   * @param {string} fieldName - O nome do campo.
+   * @param {ICustomRender} customRender - A instância do renderizador customizado.
+   * @returns {Promise<void>}
    */
   async addGridCustomRender(fieldName, customRender) {
     if (this._grid) {
@@ -121,19 +127,28 @@ const SnkSimpleCrud = class {
     await this.loadGridConfig(true);
   }
   /**
-   * Registra um formatador de valores para uma coluna da grid.
+   * @description Registra um formatador de valores para uma coluna da grade.
+   * @param {string} columnName - O nome da coluna.
+   * @param {ICustomFormatter} customFormatter - A instância do formatador customizado.
+   * @returns {Promise<void>}
    */
   async addCustomValueFormatter(columnName, customFormatter) {
     this._grid.addCustomValueFormatter(columnName, customFormatter);
   }
   /**
-   * Remove o formatador de valores de uma coluna da grid.
+   * @description Remove o formatador de valores de uma coluna da grade.
+   * @param {string} columnName - O nome da coluna.
+   * @returns {Promise<void>}
    */
   async removeCustomValueFormatter(columnName) {
     this._grid.removeCustomValueFormatter(columnName);
   }
   /**
-   * Altera/adiciona uma propriedade nos metadados do campo.
+   * @description Altera/adiciona uma propriedade nos metadados do campo.
+   * @param {string} fieldName - O nome do campo.
+   * @param {string} propName - O nome da propriedade.
+   * @param {any} value - O valor da propriedade.
+   * @returns {Promise<void>}
    */
   async setFieldProp(fieldName, propName, value) {
     const newCustomFieldProps = new Map(this._fieldsProps);
@@ -190,7 +205,9 @@ const SnkSimpleCrud = class {
     return newTaskBarConfig;
   }
   /**
-   * Usado para alternar a visão entre GRID e FORM externamente.
+   * @description Usado para alternar a visão entre GRID e FORM externamente.
+   * @param {VIEW_MODE} view - A visão para a qual navegar.
+   * @returns {Promise<void>}
    */
   async goToView(view) {
     this._currentViewMode = view;
@@ -464,6 +481,11 @@ const SnkSimpleCrud = class {
     this.dataUnit = this._inMemoryLoader.dataUnit;
     this.dataUnitReady.emit(this.dataUnit);
   }
+  /**
+   * @description Define os metadados do DataUnit.
+   * @param {UnitMetadata} metadata - Os metadados a serem definidos.
+   * @returns {Promise<void>}
+   */
   setMetadata(metadata) {
     if (this._inMemoryLoader) {
       this._inMemoryLoader.metadata = metadata;
@@ -473,6 +495,11 @@ const SnkSimpleCrud = class {
     }
     return Promise.resolve();
   }
+  /**
+   * @description Define os registros do DataUnit.
+   * @param {Array<Record>} records - Os registros a serem definidos.
+   * @returns {Promise<void>}
+   */
   setRecords(records) {
     if (this._inMemoryLoader) {
       this._inMemoryLoader.records = records;
@@ -482,23 +509,33 @@ const SnkSimpleCrud = class {
     }
     return Promise.resolve();
   }
+  /**
+   * @description Obtém os registros do DataUnit.
+   * @returns {Promise<Array<Record>>} Uma promessa que resolve com a lista de registros.
+   */
   getRecords() {
     return Promise.resolve(this.dataUnit.records);
   }
   /**
-   * Usado para abrir o configurator do CRUD
+   * @description Usado para abrir o configurador do CRUD.
+   * @returns {Promise<void>}
    */
   async openConfigurator() {
     var _a;
     (_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.open();
   }
   /**
-   * Usado para fechar o configurator do CRUD
+   * @description Usado para fechar o configurador do CRUD.
+   * @returns {Promise<void>}
    */
   async closeConfigurator() {
     var _a;
     (_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.close();
   }
+  /**
+   * @description Atualiza a configuração do formulário.
+   * @returns {Promise<void>}
+   */
   async updateConfig() {
     if (this._formConfigManager == undefined) {
       this._formConfigManager = new SnkFormConfigManager.SnkFormConfigManager(this.configName, this.resolveResourceID());

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

@@ -10,7 +10,6 @@ import DataUnitFetcher from "../../lib/http/data-fetcher/fetchers/data-unit/data
 import ParametersFetcher from "../../lib/http/data-fetcher/fetchers/parameters-fecher";
 import { PesquisaFetcher } from "../../lib/http/data-fetcher/fetchers/pesquisa-fetcher";
 import { TotalsFetcher } from "../../lib/http/data-fetcher/fetchers/totals-fetcher";
-import { agGridLicense } from '../../lib/licenses/sankhyalicense.module';
 import { SnkMessageBuilder } from "../../lib/message/SnkMessageBuilder";
 import UrlUtils from "../../lib/utils/urlutils";
 import Workspace from "../../lib/workspace/workspace";
@@ -867,6 +866,11 @@ export class SnkApplication {
   /**
    * Realiza a pesquisa de registros
    * Ex.: snk-config-options
+   * @param {string} mode - O modo da pesquisa ("ADVANCED" ou outro).
+   * @param {string} argument - O argumento da pesquisa.
+   * @param {any} options - Opções preparadas para a pesquisa.
+   * @returns {Promise<Array<IOption> | IOption>} Uma lista de opções ou uma única opção.
+   * @async
    */
   async executePreparedSearchPlus(mode, argument, options) {
     return await this.executePreparedSearch(mode, argument, Object.assign(Object.assign({}, options), { useSearchPlus: true }));
@@ -876,7 +880,7 @@ export class SnkApplication {
    * Ex.: snk-config-options
    * @param {string} mode - O modo da pesquisa ("ADVANCED" ou outro).
    * @param {string} argument - O argumento da pesquisa.
-   * @param {IPreparedSearchOptions} options - Opções preparadas para a pesquisa.
+   * @param {any} options - Opções preparadas para a pesquisa.
    * @returns {Promise<Array<IOption> | IOption>} Uma lista de opções ou uma única opção.
    * @async
    */
@@ -1231,7 +1235,6 @@ export class SnkApplication {
     ApplicationContext.setContextValue("__EZUI__SEARCH__PLUS__OPTION__LOADER__", (searchArgument, fieldName, dataUnit, ctxOptions) => {
       return this.executeSearch(searchArgument, fieldName, dataUnit, Object.assign(Object.assign({}, ctxOptions), { useSearchPlus: true }));
     });
-    ApplicationContext.setContextValue("__EZUI__GRID_LICENSE__", agGridLicense);
     this.registerPkChangeListener();
     ErrorTracking.init();
     let legacyConfig = {
@@ -3358,9 +3361,6 @@ export class SnkApplication {
             "SearchCriteria": {
               "location": "import",
               "path": "../../lib/http/data-fetcher/fetchers/pesquisa-fetcher"
-            },
-            "IPreparedSearchOptions": {
-              "location": "local"
             }
           },
           "return": "Promise<IOption | IOption[]>"
@@ -3390,16 +3390,25 @@ export class SnkApplication {
       },
       "executePreparedSearchPlus": {
         "complexType": {
-          "signature": "(mode: string, argument: string, options: IPreparedSearchOptions) => Promise<Array<IOption> | IOption>",
+          "signature": "(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>",
           "parameters": [{
-              "tags": [],
-              "text": ""
+              "tags": [{
+                  "name": "param",
+                  "text": "mode - O modo da pesquisa (\"ADVANCED\" ou outro)."
+                }],
+              "text": "- O modo da pesquisa (\"ADVANCED\" ou outro)."
             }, {
-              "tags": [],
-              "text": ""
+              "tags": [{
+                  "name": "param",
+                  "text": "argument - O argumento da pesquisa."
+                }],
+              "text": "- O argumento da pesquisa."
             }, {
-              "tags": [],
-              "text": ""
+              "tags": [{
+                  "name": "param",
+                  "text": "options - Op\u00E7\u00F5es preparadas para a pesquisa."
+                }],
+              "text": "- Op\u00E7\u00F5es preparadas para a pesquisa."
             }],
           "references": {
             "Promise": {
@@ -3409,9 +3418,6 @@ export class SnkApplication {
               "location": "import",
               "path": "@sankhyalabs/ezui/dist/types/components/ez-search/ez-search"
             },
-            "IPreparedSearchOptions": {
-              "location": "local"
-            },
             "Array": {
               "location": "global"
             }
@@ -3420,12 +3426,27 @@ export class SnkApplication {
         },
         "docs": {
           "text": "Realiza a pesquisa de registros\nEx.: snk-config-options",
-          "tags": []
+          "tags": [{
+              "name": "param",
+              "text": "mode - O modo da pesquisa (\"ADVANCED\" ou outro)."
+            }, {
+              "name": "param",
+              "text": "argument - O argumento da pesquisa."
+            }, {
+              "name": "param",
+              "text": "options - Op\u00E7\u00F5es preparadas para a pesquisa."
+            }, {
+              "name": "returns",
+              "text": "Uma lista de op\u00E7\u00F5es ou uma \u00FAnica op\u00E7\u00E3o."
+            }, {
+              "name": "async",
+              "text": undefined
+            }]
         }
       },
       "executePreparedSearch": {
         "complexType": {
-          "signature": "(mode: string, argument: string, options: IPreparedSearchOptions) => Promise<Array<IOption> | IOption>",
+          "signature": "(mode: string, argument: string, options: any) => Promise<Array<IOption> | IOption>",
           "parameters": [{
               "tags": [{
                   "name": "param",
@@ -3453,9 +3474,6 @@ export class SnkApplication {
               "location": "import",
               "path": "@sankhyalabs/ezui/dist/types/components/ez-search/ez-search"
             },
-            "IPreparedSearchOptions": {
-              "location": "local"
-            },
             "Array": {
               "location": "global"
             },