@sankhyalabs/sankhyablocks 9.2.0-ms.9 → 9.2.0-rc.2

package/dist/types/components.d.ts

@@ -52,12 +52,13 @@ import { IExportConfig } from "./components/snk-data-exporter/data/export-config
 import { IExpressionGroup, IExpressionItem } from "./components/snk-personalized-filter/interfaces/IExpressionItem";
 import { IPersonalizedFilter } from "./components/snk-personalized-filter/interfaces/IPersonalizedFilter";
 import { SnkApplication } from "./components/snk-application/snk-application";
-import { SnkFilterModalFactoryParams } from "./components/snk-filter-bar/utils/SnkFilterModalFactory";
+import { Filter as Filter1 } from "@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata";
 import { EPresentationMode } from "./components/snk-filter-bar/filter-item/editors/enum/presentationMode";
 import { FilterFieldsDataSource, IFilterField, IFilterLink } from "./components/snk-filter-field-search/interfaces";
 import { IEzPopoverAnchorOptions } from "@sankhyalabs/ezui/dist/types/components/ez-popover/ez-popover";
 import { SnkFilterItemConfig as SnkFilterItemConfig1 } from "./components/snk-filter-bar/filter-item/snk-filter-item";
 import { ListItem as ListItem1 } from "./components/snk-filter-bar/filter-list/snk-filter-list";
+import { Period } from "./components/snk-filter-bar/filter-item/editors/snk-filter-period";
 import { IFormViewField } from "@sankhyalabs/ezui/dist/types/components/ez-form-view/interfaces/IFormViewField";
 import { FormMetadata } from "@sankhyalabs/ezui/dist/collection/utils/form";
 import { ICustomEditor as ICustomEditor1 } from "@sankhyalabs/ezui/dist/types/utils/customEditor/interfaces/ICustomEditor";
@@ -1093,6 +1094,10 @@ export namespace Components {
           * Configurações para carregar os dados do componente
          */
         "config": SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage": string;
         /**
           * Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida
          */
@@ -1245,6 +1250,17 @@ export namespace Components {
           * @description Lista todos os filtros disponíveis ao usuário.
          */
         "filterConfig": Array<SnkFilterItemConfig>;
+        /**
+          * @description Configuração customizada dos filtros.
+          * @param config - Lista de configurações de filtros.
+         */
+        "filterCustomConfig"?: Array<SnkFilterItemConfig>;
+        /**
+          * @description Intercepta a configuração dos filtros antes de serem aplicadas.
+          * @param config - Lista de configurações de filtros.
+          * @returns Retorna a lista de configurações de filtros.
+         */
+        "filterCustomConfigInterceptor"?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
         /**
           * @description Retorna um item de filtro pelo ID.
           * @async 
@@ -1252,6 +1268,7 @@ export namespace Components {
           * @returns O item de filtro correspondente ou undefined se não for encontrado.
          */
         "getFilterItem": (id: string) => Promise<SnkFilterItemConfig | undefined>;
+        "getFilters": () => Promise<Filter1[]>;
         /**
           * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
          */
@@ -1295,10 +1312,18 @@ export namespace Components {
         "updateFilterItem": (newFilterItem: SnkFilterItemConfig) => Promise<void>;
     }
     interface SnkFilterBinarySelect {
+        /**
+          * Limpa o valor do componente restaurando o valor original da configuração.
+         */
+        "clearValue": () => Promise<void>;
         /**
           * Define as configurações do componente snk-filter-binary-select
          */
         "config": SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage": string;
         /**
           * Define a variação do componente
          */
@@ -1307,18 +1332,35 @@ export namespace Components {
           * Redefine os valores padrão do componente.
          */
         "resetValues": () => Promise<void>;
+        /**
+          * Define o foco no componente snk-filter-binary-select.
+         */
+        "setFocus": () => Promise<void>;
         /**
           * Define o valor do componente snk-filter-binary-select
          */
         "value": any;
     }
     interface SnkFilterCheckboxList {
+        /**
+          * Limpa o valor do componente restaurando o valor original da configuração.
+         */
+        "clearValue": () => Promise<void>;
         /**
           * Define as configurações do componente snk-filter-multi-select
          */
         "config": SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage": string;
+        /**
+          * Define o foco no componente snk-filter-checkbox-list.
+         */
+        "setFocus": () => Promise<void>;
     }
     interface SnkFilterDetail {
+        "clearValue": () => Promise<void>;
         /**
           * Define as configurações do componente snk-filter-detail.
          */
@@ -1328,9 +1370,13 @@ export namespace Components {
          */
         "getMessage": (key: string, props?: any) => string;
         /**
-          * Exibe o componente snk-filter-detail.
+          * Define se o filtro pode ser removido.
          */
-        "show": () => Promise<void>;
+        "removalBlocked": boolean;
+        /**
+          * Define o foco no campo do editor.
+         */
+        "setFocusField": () => Promise<void>;
         /**
           * Controla a visibilidade do botão de fixar elemento
          */
@@ -1444,13 +1490,19 @@ export namespace Components {
          */
         "editPersonalizedFilter": (id:string, isDefault?: boolean) => void;
         /**
-          * Guarda o filtro a ser deletado no Apply do modal
+          * Filtros a serem apresentados
          */
-        "filterDefaultToDelete": SnkFilterItemConfig;
+        "filterConfig": Array<SnkFilterItemConfig>;
         /**
-          * Filtros a serem apresentados
+          * @description Intercepta a configuração dos filtros antes de serem aplicadas.
+          * @param config - Lista de configurações de filtros.
+          * @returns Retorna a lista de configurações de filtros.
          */
-        "filters": Array<SnkFilterItemConfig>;
+        "filterCustomConfigInterceptor"?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
+        /**
+          * Guarda o filtro a ser deletado no Apply do modal
+         */
+        "filterDefaultToDelete": SnkFilterItemConfig;
         /**
           * Guarda filtros a serem deletados no Apply do modal
          */
@@ -1459,6 +1511,10 @@ export namespace Components {
           * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
          */
         "getMessage": (key: string, props?: any) => string;
+        /**
+          * Define se o modal está aberto ou não.
+         */
+        "opened": boolean;
     }
     interface SnkFilterModalItem {
         /**
@@ -1472,24 +1528,40 @@ export namespace Components {
         "resourceID": string;
     }
     interface SnkFilterMultiSelect {
+        /**
+          * Limpa o valor do componente restaurando o valor original da configuração.
+         */
+        "clearValue": () => Promise<void>;
         /**
           * Define as configurações do componente snk-filter-multi-select
          */
         "config": SnkFilterItemConfig;
         /**
-          * Exibe o componente snk-filter-multi-select
+          * Usado para exibir mensagens de erro.
          */
-        "show": () => Promise<void>;
+        "errorMessage": string;
+        /**
+          * Define o foco no componente snk-filter-multi-select.
+         */
+        "setFocus": () => Promise<void>;
         /**
           * Define o valor do componente snk-filter-multi-select
          */
         "value": any;
     }
     interface SnkFilterNumber {
+        /**
+          * Limpa o valor do componente restaurando o valor original da configuração.
+         */
+        "clearValue": () => Promise<void>;
         /**
           * Define as configurações do componente snk-filter-number
          */
         "config": SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage": string;
         /**
           * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
          */
@@ -1498,6 +1570,10 @@ export namespace Components {
           * Define a variação do componente
          */
         "presentationMode": EPresentationMode;
+        /**
+          * Define o foco no componente snk-filter-number
+         */
+        "setFocus": () => Promise<void>;
         /**
           * Exibe o componente snk-filter-number
          */
@@ -1522,10 +1598,18 @@ export namespace Components {
         "open": (expressionItem: IExpressionItem) => Promise<IExpressionItem>;
     }
     interface SnkFilterPeriod {
+        /**
+          * Limpa o valor do componente restaurando o valor original da configuração.
+         */
+        "clearValue": () => Promise<void>;
         /**
           * Define as configurações do componente snk-filter-period
          */
         "config": SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage": string;
         /**
           * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
          */
@@ -1534,6 +1618,10 @@ export namespace Components {
           * Define a variação do componente
          */
         "presentationMode": EPresentationMode;
+        /**
+          * Define o foco no componente snk-filter-period.
+         */
+        "setFocus": () => Promise<void>;
         /**
           * Exibe o componente snk-filter-period
          */
@@ -1541,27 +1629,47 @@ export namespace Components {
         /**
           * Define o valor do componente snk-filter-period
          */
-        "value": any;
+        "value": Period;
     }
     interface SnkFilterSearch {
+        /**
+          * Limpa o valor do componente restaurando o valor original da configuração.
+         */
+        "clearValue": () => Promise<void>;
         /**
           * Define as configurações do componente snk-filter-search
          */
         "config": SnkFilterItemConfig;
         /**
-          * Exibe o componente snk-filter-search
+          * Usado para exibir mensagens de erro.
          */
-        "show": () => Promise<void>;
+        "errorMessage": string;
+        /**
+          * Define o foco no componente snk-filter-search.
+         */
+        "setFocus": () => Promise<void>;
         /**
           * Define o valor do componente snk-filter-search
          */
         "value": IOption2;
     }
     interface SnkFilterText {
+        /**
+          * Limpa o valor do componente restaurando o valor original da configuração.
+         */
+        "clearValue": () => Promise<void>;
         /**
           * Define as configurações do componente snk-filter-text.
          */
         "config": SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage": string;
+        /**
+          * Define o foco no componente snk-filter-text.
+         */
+        "setFocus": () => Promise<void>;
         /**
           * Define o valor do componente snk-filter-text.
          */
@@ -1815,6 +1923,17 @@ export namespace Components {
           * Título que será apresentado na barra de filtros.
          */
         "filterBarTitle": string;
+        /**
+          * @description Configuração customizada dos filtros.
+          * @param config - Lista de configurações de filtros.
+         */
+        "filterCustomConfig"?: Array<SnkFilterItemConfig>;
+        /**
+          * @description Intercepta a configuração dos filtros antes de serem aplicadas.
+          * @param config - Lista de configurações de filtros.
+          * @returns Retorna a lista de configurações de filtros.
+         */
+        "filterCustomConfigInterceptor"?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
         /**
           * Retorna o elemento da barra de filtros da grade.
           * @async 
@@ -1869,6 +1988,7 @@ export namespace Components {
           * Validador responsável por verificar a integridade dos dados de um registro.
          */
         "recordsValidator": IRecordValidator;
+        "refreshColumnFilterDataSource": () => Promise<void>;
         /**
           * 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.
@@ -2087,28 +2207,40 @@ export namespace Components {
     }
     interface SnkPersonalizedFilter {
         /**
-          * Nome da configuração. Serve para distinguir várias instâncias do componente.
+          * Nome da configuração, utilizado para distinguir múltiplas instâncias do componente.
+          * @property
          */
         "configName": string;
+        /**
+          * Cria um novo filtro personalizado caso não exista nenhum.
+          * @method 
+          * @returns
+         */
         "createPersonalizedFilter": () => Promise<void>;
         /**
-          * Responsável por receber a URI da entidade.
+          * URI da entidade utilizada para buscar os campos disponíveis para filtro.
+          * @property
          */
         "entityUri": string;
         /**
-          * Id do filtro que será carregado.
+          * Identificador do filtro a ser carregado.
+          * @property
          */
         "filterId": string;
         /**
-          * Define se o filtro em questão é um filtro padrão.
+          * Indica se o filtro é o filtro padrão do sistema.
+          * @property 
+          * @default false
          */
         "isDefaultFilter": boolean;
         /**
           * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+          * @property
          */
         "messagesBuilder": SnkMessageBuilder;
         /**
-          * Nome da configuração. Serve para distinguir várias instâncias do componente.
+          * Identificador do recurso utilizado para salvar e recuperar filtros.
+          * @property
          */
         "resourceID": string;
     }
@@ -2136,31 +2268,53 @@ export namespace Components {
     }
     interface SnkPesquisa {
         /**
-          * Define se permite seleção de items não analíticos
+          * Define se permite a seleção de itens não analíticos.
+          * @type {boolean}
+          * @default false
+          * @example allowsNonAnalytic={true}
          */
         "allowsNonAnalytic": boolean;
         /**
-          * Argumentos que serão usados ao chamar a função searchLoader.
+          * Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente.
+          * @type {string}
+          * @mutable 
+          * @example argument="Texto para pesquisa"
          */
         "argument": string;
         /**
-          * Nome da entidade onde a pesquisa é aplicada.
+          * Nome da entidade sobre a qual a pesquisa será realizada.
+          * @type {string}
+          * @example entityName="Produto"
          */
         "entityName": string;
         /**
-          * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
+          * Define se a popup de pesquisa terá ou não modo hierárquico.
+          * @type {boolean}
+          * @default false
+          * @example isHierarchyEntity={true}
          */
         "isHierarchyEntity": boolean;
         /**
-          * Função responsável em carregar os itens do componente snk-pesquisa.
+          * Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados.
+          * @type {(text: string) => Promise<any>}
+          * @param text Texto utilizado como argumento de pesquisa.
+          * @returns Promise com os dados da pesquisa.
+          * @example searchLoader={(text) => fetchItems(text)}
          */
         "searchLoader": (text: string) => Promise<any>;
         /**
-          * Função disparada ao selecionar um item.
+          * Função disparada ao selecionar um item da pesquisa.
+          * @type {(option: IOption) => void}
+          * @param option Item selecionado.
+          * @returns void
+          * @example selectItem={(option) => handleSelect(option)}
          */
         "selectItem": (option: IOption2) => void;
         /**
-          * Função responsável por carregar a árvore hierárquica do componente
+          * Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível.
+          * @type {(text: string) => Promise<any>}
+          * @param text Texto utilizado como argumento de pesquisa para a árvore.
+          * @returns Promise com os dados da árvore.
          */
         "treeLoader"?: (text: string) => Promise<any>;
     }
@@ -2179,11 +2333,11 @@ export namespace Components {
     }
     interface SnkSimpleBar {
         /**
-          * Define os itens que serão apresentados pelo breadcrumb
+          * Define os itens que serão apresentados no breadcrumb.
          */
         "breadcrumbItens": Array<IBreadcrumbItem>;
         /**
-          * Define o título do header
+          * Define o título do header.
          */
         "label": string;
         /**
@@ -2193,138 +2347,196 @@ export namespace Components {
     }
     interface SnkSimpleCrud {
         /**
-          * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
+          * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsList": Array<Action>;
         /**
-          * 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 fieldName - O nome do campo.
+          * @param customEditor - A instância do editor customizado.
+          * @returns
          */
         "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise<void>;
         /**
-          * Registra um formatador de valores para uma coluna da grid.
+          * @description Registra um formatador de valores para uma coluna da grade.
+          * @param columnName - O nome da coluna.
+          * @param customFormatter - A instância do formatador customizado.
+          * @returns
          */
         "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise<void>;
         /**
-          * Registra um render customizado para colunas da grid.
+          * @description Registra um renderizador customizado para colunas da grade.
+          * @param fieldName - O nome do campo.
+          * @param customRender - A instância do renderizador customizado.
+          * @returns
          */
         "addGridCustomRender": (fieldName: string, customRender: ICustomRender) => Promise<void>;
         /**
-          * Define se a grid será focada ao ser carregada.
+          * @description Define se a grade será focada ao ser carregada.
          */
         "autoFocus"?: boolean;
         /**
-          * Define se a carga dos dados será feita assim que o componente for carregado.
+          * @description Define se a carga dos dados será feita assim que o componente for carregado.
          */
         "autoLoad"?: boolean;
         /**
-          * Usado para fechar o configurator do CRUD
+          * @description Usado para fechar o configurador do CRUD.
+          * @returns
          */
         "closeConfigurator": () => Promise<void>;
         /**
-          * Usado para salvar as configurações dos blocos de construção.
+          * @description Usado para salvar as configurações dos blocos de construção.
          */
         "configName": string;
+        /**
+          * @description Estado atual dos dados.
+         */
         "dataState": DataState1;
+        /**
+          * @description Instância do DataUnit a ser utilizada pelo componente.
+         */
         "dataUnit": DataUnit;
         /**
-          * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
+          * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade).
          */
         "domainMessagesBuilder": string;
+        /**
+          * @description Habilita a inserção contínua de registros.
+         */
         "enableContinuousInsert": boolean;
         /**
-          * Ativa inserção de registros no modo grade.
+          * @description Ativa a inserção de registros no modo grade.
          */
         "enableGridInsert"?: boolean;
         /**
-          * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
+          * @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
          */
         "enableLockManagerLoadingComp"?: boolean;
         /**
-          * Ativa o gerenciamento de locks na grade pela Taskbar.
+          * @description Ativa o gerenciamento de locks na grade pela Taskbar.
          */
         "enableLockManagerTaskbarClick"?: boolean;
         /**
-          * Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD
+          * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD.
          */
         "entityName": string;
+        /**
+          * @description Configuração do formulário.
+         */
         "formConfig": IFormConfig;
         /**
-          * Chave da configuração legado do formulário.
+          * @description Chave da configuração legada do formulário.
          */
         "formLegacyConfigName": string;
+        /**
+          * @description Obtém os registros do DataUnit.
+          * @returns Uma promessa que resolve com a lista de registros.
+         */
         "getRecords": () => Promise<Array<Record>>;
         /**
-          * 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 - A visão para a qual navegar.
+          * @returns
          */
         "goToView": (view: VIEW_MODE) => Promise<void>;
+        /**
+          * @description Configuração da grade.
+         */
         "gridConfig": IGridConfig;
         /**
-          * Chave da configuração legado da grade.
+          * @description Chave da configuração legada da grade.
          */
         "gridLegacyConfigName": string;
         /**
-          * Ignora os campos "somente leitura" no modo de inserção.
+          * @description Ignora os campos "somente leitura" no modo de inserção.
          */
         "ignoreReadOnlyFormFields": boolean;
         /**
-          * Define se o LayoutFormConfig será exibido no configurador.
+          * @description Define se o LayoutFormConfig será exibido no configurador.
          */
         "layoutFormConfig": boolean;
         /**
-          * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+          * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
          */
         "messagesBuilder": SnkMessageBuilder;
+        /**
+          * @description Define o modo de operação do CRUD (servidor ou em memória).
+         */
         "mode": SIMPLE_CRUD_MODE;
         /**
-          * Habilita a edição de múltiplos registros simultâneos.
+          * @description Habilita a edição de múltiplos registros simultâneos.
          */
         "multipleEditionEnabled": boolean;
         /**
-          * Determina se pode haver mais de uma linha selecionada na grade.
+          * @description Determina se pode haver mais de uma linha selecionada na grade.
          */
         "multipleSelection": boolean;
         /**
-          * Usado para abrir o configurator do CRUD
+          * @description Usado para abrir o configurador do CRUD.
+          * @returns
          */
         "openConfigurator": () => Promise<void>;
         /**
-          * Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
+          * @description Altera visualmente as sombras e bordas do componente. Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout). Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up).
          */
         "outlineMode"?: boolean;
         /**
-          * Determina quantas linhas são retornadas por página.
+          * @description Determina quantas linhas são retornadas por página.
          */
         "pageSize": number;
         /**
-          * Define se a grid será focada ao ser carregada.
+          * @description Define o modo de exibição do contador de paginação.
          */
         "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
         /**
-          * Remove o formatador de valores de uma coluna da grid.
+          * @description Remove o formatador de valores de uma coluna da grade.
+          * @param columnName - O nome da coluna.
+          * @returns
          */
         "removeCustomValueFormatter": (columnName: string) => Promise<void>;
         /**
-          * Identificador de recursos como configurações e acesso.
+          * @description Identificador de recursos como configurações e acesso.
          */
         "resourceID": string;
         /**
-          * Altera/adiciona uma propriedade nos metadados do campo.
+          * @description Altera/adiciona uma propriedade nos metadados do campo.
+          * @param fieldName - O nome do campo.
+          * @param propName - O nome da propriedade.
+          * @param value - O valor da propriedade.
+          * @returns
          */
         "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
+        /**
+          * @description Define os metadados do DataUnit.
+          * @param metadata - Os metadados a serem definidos.
+          * @returns
+         */
         "setMetadata": (metadata: UnitMetadata) => Promise<void>;
+        /**
+          * @description Define os registros do DataUnit.
+          * @param records - Os registros a serem definidos.
+          * @returns
+         */
         "setRecords": (records: Array<Record>) => Promise<void>;
         /**
-          * Usado para exibir os botões de ação do snk-configurator.
+          * @description Usado para exibir os botões de ação do snk-configurator.
          */
         "showConfiguratorButtons": boolean;
         /**
-          * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
+          * @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
          */
         "taskbarManager": TaskbarManager;
+        /**
+          * @description Atualiza a configuração do formulário.
+          * @returns
+         */
         "updateConfig": () => Promise<void>;
+        /**
+          * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
+         */
         "useCancelConfirm": boolean;
         /**
-          * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
+          * @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
          */
         "useEnterLikeTab": boolean;
     }
@@ -3728,6 +3940,10 @@ declare namespace LocalJSX {
           * Configurações para carregar os dados do componente
          */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage"?: string;
         /**
           * Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida
          */
@@ -3898,6 +4114,17 @@ declare namespace LocalJSX {
           * @description Lista todos os filtros disponíveis ao usuário.
          */
         "filterConfig"?: Array<SnkFilterItemConfig>;
+        /**
+          * @description Configuração customizada dos filtros.
+          * @param config - Lista de configurações de filtros.
+         */
+        "filterCustomConfig"?: Array<SnkFilterItemConfig>;
+        /**
+          * @description Intercepta a configuração dos filtros antes de serem aplicadas.
+          * @param config - Lista de configurações de filtros.
+          * @returns Retorna a lista de configurações de filtros.
+         */
+        "filterCustomConfigInterceptor"?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
         /**
           * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
          */
@@ -3926,6 +4153,10 @@ declare namespace LocalJSX {
           * Define as configurações do componente snk-filter-binary-select
          */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage"?: string;
         /**
           * Emitido quando o valor do filtro é alterado.
          */
@@ -3944,6 +4175,10 @@ declare namespace LocalJSX {
           * Define as configurações do componente snk-filter-multi-select
          */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage"?: string;
         /**
           * Emite um evento customizado ao realizar alteração nos valores do componente
          */
@@ -3962,6 +4197,10 @@ declare namespace LocalJSX {
           * Emitido quando há uma alteração nos filtros.
          */
         "onFilterChange"?: (event: SnkFilterDetailCustomEvent<SnkFilterItemConfig>) => void;
+        /**
+          * Define se o filtro pode ser removido.
+         */
+        "removalBlocked"?: boolean;
         /**
           * Controla a visibilidade do botão de fixar elemento
          */
@@ -4068,13 +4307,19 @@ declare namespace LocalJSX {
          */
         "editPersonalizedFilter"?: (id:string, isDefault?: boolean) => void;
         /**
-          * Guarda o filtro a ser deletado no Apply do modal
+          * Filtros a serem apresentados
          */
-        "filterDefaultToDelete"?: SnkFilterItemConfig;
+        "filterConfig"?: Array<SnkFilterItemConfig>;
         /**
-          * Filtros a serem apresentados
+          * @description Intercepta a configuração dos filtros antes de serem aplicadas.
+          * @param config - Lista de configurações de filtros.
+          * @returns Retorna a lista de configurações de filtros.
+         */
+        "filterCustomConfigInterceptor"?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
+        /**
+          * Guarda o filtro a ser deletado no Apply do modal
          */
-        "filters"?: Array<SnkFilterItemConfig>;
+        "filterDefaultToDelete"?: SnkFilterItemConfig;
         /**
           * Guarda filtros a serem deletados no Apply do modal
          */
@@ -4083,6 +4328,10 @@ declare namespace LocalJSX {
           * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
          */
         "getMessage"?: (key: string, props?: any) => string;
+        /**
+          * Define se o modal está aberto ou não.
+         */
+        "opened"?: boolean;
     }
     interface SnkFilterModalItem {
         /**
@@ -4103,6 +4352,10 @@ declare namespace LocalJSX {
           * Define as configurações do componente snk-filter-multi-select
          */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage"?: string;
         /**
           * Emitido quando o valor do filtro é alterado.
          */
@@ -4117,6 +4370,10 @@ declare namespace LocalJSX {
           * Define as configurações do componente snk-filter-number
          */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage"?: string;
         /**
           * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
          */
@@ -4145,6 +4402,10 @@ declare namespace LocalJSX {
           * Define as configurações do componente snk-filter-period
          */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage"?: string;
         /**
           * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
          */
@@ -4160,13 +4421,17 @@ declare namespace LocalJSX {
         /**
           * Define o valor do componente snk-filter-period
          */
-        "value"?: any;
+        "value"?: Period;
     }
     interface SnkFilterSearch {
         /**
           * Define as configurações do componente snk-filter-search
          */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage"?: string;
         /**
           * Emitido quando o valor do filtro é alterado.
          */
@@ -4181,6 +4446,10 @@ declare namespace LocalJSX {
           * Define as configurações do componente snk-filter-text.
          */
         "config"?: SnkFilterItemConfig;
+        /**
+          * Usado para exibir mensagens de erro.
+         */
+        "errorMessage"?: string;
         /**
           * Emitido quando o valor do filtro é alterado.
          */
@@ -4392,6 +4661,17 @@ declare namespace LocalJSX {
           * Título que será apresentado na barra de filtros.
          */
         "filterBarTitle"?: string;
+        /**
+          * @description Configuração customizada dos filtros.
+          * @param config - Lista de configurações de filtros.
+         */
+        "filterCustomConfig"?: Array<SnkFilterItemConfig>;
+        /**
+          * @description Intercepta a configuração dos filtros antes de serem aplicadas.
+          * @param config - Lista de configurações de filtros.
+          * @returns Retorna a lista de configurações de filtros.
+         */
+        "filterCustomConfigInterceptor"?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
         /**
           * Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade.
          */
@@ -4423,7 +4703,7 @@ declare namespace LocalJSX {
          */
         "onActionClick"?: (event: SnkGridCustomEvent<string>) => void;
         /**
-          * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
+          * Emitido quando o componente estiver completamente carregado.
          */
         "onComponentReady"?: (event: SnkGridCustomEvent<void>) => void;
         /**
@@ -4623,30 +4903,49 @@ declare namespace LocalJSX {
     }
     interface SnkPersonalizedFilter {
         /**
-          * Nome da configuração. Serve para distinguir várias instâncias do componente.
+          * Nome da configuração, utilizado para distinguir múltiplas instâncias do componente.
+          * @property
          */
         "configName"?: string;
         /**
-          * Responsável por receber a URI da entidade.
+          * URI da entidade utilizada para buscar os campos disponíveis para filtro.
+          * @property
          */
         "entityUri"?: string;
         /**
-          * Id do filtro que será carregado.
+          * Identificador do filtro a ser carregado.
+          * @property
          */
         "filterId"?: string;
         /**
-          * Define se o filtro em questão é um filtro padrão.
+          * Indica se o filtro é o filtro padrão do sistema.
+          * @property 
+          * @default false
          */
         "isDefaultFilter"?: boolean;
         /**
           * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+          * @property
          */
         "messagesBuilder"?: SnkMessageBuilder;
+        /**
+          * Evento emitido após salvar as alterações do filtro personalizado.
+          * @event
+         */
         "onEzAfterSave"?: (event: SnkPersonalizedFilterCustomEvent<void>) => void;
+        /**
+          * Evento emitido ao cancelar a personalização do filtro.
+          * @event
+         */
         "onEzCancel"?: (event: SnkPersonalizedFilterCustomEvent<void>) => void;
+        /**
+          * Evento emitido ao salvar as alterações do filtro personalizado.
+          * @event
+         */
         "onEzSave"?: (event: SnkPersonalizedFilterCustomEvent<string>) => void;
         /**
-          * Nome da configuração. Serve para distinguir várias instâncias do componente.
+          * Identificador do recurso utilizado para salvar e recuperar filtros.
+          * @property
          */
         "resourceID"?: string;
     }
@@ -4677,31 +4976,53 @@ declare namespace LocalJSX {
     }
     interface SnkPesquisa {
         /**
-          * Define se permite seleção de items não analíticos
+          * Define se permite a seleção de itens não analíticos.
+          * @type {boolean}
+          * @default false
+          * @example allowsNonAnalytic={true}
          */
         "allowsNonAnalytic"?: boolean;
         /**
-          * Argumentos que serão usados ao chamar a função searchLoader.
+          * Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente.
+          * @type {string}
+          * @mutable 
+          * @example argument="Texto para pesquisa"
          */
         "argument"?: string;
         /**
-          * Nome da entidade onde a pesquisa é aplicada.
+          * Nome da entidade sobre a qual a pesquisa será realizada.
+          * @type {string}
+          * @example entityName="Produto"
          */
         "entityName"?: string;
         /**
-          * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
+          * Define se a popup de pesquisa terá ou não modo hierárquico.
+          * @type {boolean}
+          * @default false
+          * @example isHierarchyEntity={true}
          */
         "isHierarchyEntity"?: boolean;
         /**
-          * Função responsável em carregar os itens do componente snk-pesquisa.
+          * Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados.
+          * @type {(text: string) => Promise<any>}
+          * @param text Texto utilizado como argumento de pesquisa.
+          * @returns Promise com os dados da pesquisa.
+          * @example searchLoader={(text) => fetchItems(text)}
          */
         "searchLoader"?: (text: string) => Promise<any>;
         /**
-          * Função disparada ao selecionar um item.
+          * Função disparada ao selecionar um item da pesquisa.
+          * @type {(option: IOption) => void}
+          * @param option Item selecionado.
+          * @returns void
+          * @example selectItem={(option) => handleSelect(option)}
          */
         "selectItem"?: (option: IOption2) => void;
         /**
-          * Função responsável por carregar a árvore hierárquica do componente
+          * Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível.
+          * @type {(text: string) => Promise<any>}
+          * @param text Texto utilizado como argumento de pesquisa para a árvore.
+          * @returns Promise com os dados da árvore.
          */
         "treeLoader"?: (text: string) => Promise<any>;
     }
@@ -4723,11 +5044,11 @@ declare namespace LocalJSX {
     }
     interface SnkSimpleBar {
         /**
-          * Define os itens que serão apresentados pelo breadcrumb
+          * Define os itens que serão apresentados no breadcrumb.
          */
         "breadcrumbItens"?: Array<IBreadcrumbItem>;
         /**
-          * Define o título do header
+          * Define o título do header.
          */
         "label"?: string;
         /**
@@ -4735,136 +5056,157 @@ declare namespace LocalJSX {
          */
         "messagesBuilder"?: SnkMessageBuilder;
         /**
-          * Emitido quando algum item do breadcrumb é clicado
+          * Emitido quando algum item do breadcrumb é clicado.
          */
         "onClickBreadcrumbItem"?: (event: SnkSimpleBarCustomEvent<IBreadcrumbItem>) => void;
         /**
-          * Emitido quando o botão voltar é acionado
+          * Emitido quando o botão "voltar" é acionado.
          */
         "onExit"?: (event: SnkSimpleBarCustomEvent<void>) => void;
     }
     interface SnkSimpleCrud {
         /**
-          * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
+          * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
          */
         "actionsList"?: Array<Action>;
         /**
-          * Define se a grid será focada ao ser carregada.
+          * @description Define se a grade será focada ao ser carregada.
          */
         "autoFocus"?: boolean;
         /**
-          * Define se a carga dos dados será feita assim que o componente for carregado.
+          * @description Define se a carga dos dados será feita assim que o componente for carregado.
          */
         "autoLoad"?: boolean;
         /**
-          * Usado para salvar as configurações dos blocos de construção.
+          * @description Usado para salvar as configurações dos blocos de construção.
          */
         "configName"?: string;
+        /**
+          * @description Estado atual dos dados.
+         */
         "dataState"?: DataState1;
+        /**
+          * @description Instância do DataUnit a ser utilizada pelo componente.
+         */
         "dataUnit"?: DataUnit;
         /**
-          * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
+          * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade).
          */
         "domainMessagesBuilder"?: string;
+        /**
+          * @description Habilita a inserção contínua de registros.
+         */
         "enableContinuousInsert"?: boolean;
         /**
-          * Ativa inserção de registros no modo grade.
+          * @description Ativa a inserção de registros no modo grade.
          */
         "enableGridInsert"?: boolean;
         /**
-          * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
+          * @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
          */
         "enableLockManagerLoadingComp"?: boolean;
         /**
-          * Ativa o gerenciamento de locks na grade pela Taskbar.
+          * @description Ativa o gerenciamento de locks na grade pela Taskbar.
          */
         "enableLockManagerTaskbarClick"?: boolean;
         /**
-          * Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD
+          * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD.
          */
         "entityName"?: string;
+        /**
+          * @description Configuração do formulário.
+         */
         "formConfig"?: IFormConfig;
         /**
-          * Chave da configuração legado do formulário.
+          * @description Chave da configuração legada do formulário.
          */
         "formLegacyConfigName"?: string;
+        /**
+          * @description Configuração da grade.
+         */
         "gridConfig"?: IGridConfig;
         /**
-          * Chave da configuração legado da grade.
+          * @description Chave da configuração legada da grade.
          */
         "gridLegacyConfigName"?: string;
         /**
-          * Ignora os campos "somente leitura" no modo de inserção.
+          * @description Ignora os campos "somente leitura" no modo de inserção.
          */
         "ignoreReadOnlyFormFields"?: boolean;
         /**
-          * Define se o LayoutFormConfig será exibido no configurador.
+          * @description Define se o LayoutFormConfig será exibido no configurador.
          */
         "layoutFormConfig"?: boolean;
         /**
-          * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+          * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
          */
         "messagesBuilder"?: SnkMessageBuilder;
+        /**
+          * @description Define o modo de operação do CRUD (servidor ou em memória).
+         */
         "mode"?: SIMPLE_CRUD_MODE;
         /**
-          * Habilita a edição de múltiplos registros simultâneos.
+          * @description Habilita a edição de múltiplos registros simultâneos.
          */
         "multipleEditionEnabled"?: boolean;
         /**
-          * Determina se pode haver mais de uma linha selecionada na grade.
+          * @description Determina se pode haver mais de uma linha selecionada na grade.
          */
         "multipleSelection"?: boolean;
         /**
-          * Emitido sempre que houver click de botão ou ação.
+          * @description Emitido sempre que houver clique de botão ou ação na barra de tarefas.
          */
         "onActionClick"?: (event: SnkSimpleCrudCustomEvent<string>) => void;
         /**
-          * Emitido quando cancela o salvamento da configuração no configurator do CRUD.
+          * @description Emitido quando o salvamento da configuração no configurador do CRUD é cancelado.
          */
         "onConfiguratorCancel"?: (event: SnkSimpleCrudCustomEvent<any>) => void;
         /**
-          * Emitido quando salva a configuração no configurator do CRUD.
+          * @description Emitido quando a configuração no configurador do CRUD é salva.
          */
         "onConfiguratorSave"?: (event: SnkSimpleCrudCustomEvent<any>) => void;
         /**
-          * Emitido quando há qualquer mudança de estado no DataUnit.
+          * @description Emitido quando há qualquer mudança de estado no DataUnit.
          */
         "onDataStateChange"?: (event: SnkSimpleCrudCustomEvent<DataState1>) => void;
         /**
-          * Emitido quando o DataUnit está pronto.
+          * @description Emitido quando o DataUnit está pronto.
          */
         "onDataUnitReady"?: (event: SnkSimpleCrudCustomEvent<DataUnit>) => void;
         /**
-          * Responsável por notificar quando ocorrer a renderização de itens do formulário.
+          * @description Responsável por notificar quando ocorrer a renderização de itens do formulário.
          */
         "onFormItemsReady"?: (event: SnkSimpleCrudCustomEvent<Array<HTMLElement>>) => void;
         /**
-          * Altera visualmente as sombras e bordas do componente Quando false, aplica o padrão de sombras ao componente (Utilizar quando for o elemento principal do layout) Quando true, aplica o padrão de outline ao componente (Utilizar quando estiver contido em outro elemento como um painel ou pop-up)
+          * @description Altera visualmente as sombras e bordas do componente. Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout). Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up).
          */
         "outlineMode"?: boolean;
         /**
-          * Determina quantas linhas são retornadas por página.
+          * @description Determina quantas linhas são retornadas por página.
          */
         "pageSize"?: number;
         /**
-          * Define se a grid será focada ao ser carregada.
+          * @description Define o modo de exibição do contador de paginação.
          */
         "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
         /**
-          * Identificador de recursos como configurações e acesso.
+          * @description Identificador de recursos como configurações e acesso.
          */
         "resourceID"?: string;
         /**
-          * Usado para exibir os botões de ação do snk-configurator.
+          * @description Usado para exibir os botões de ação do snk-configurator.
          */
         "showConfiguratorButtons"?: boolean;
         /**
-          * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
+          * @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões.
          */
         "taskbarManager"?: TaskbarManager;
+        /**
+          * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
+         */
         "useCancelConfirm"?: boolean;
         /**
-          * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
+          * @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
          */
         "useEnterLikeTab"?: boolean;
     }