@sankhyalabs/sankhyablocks 9.1.8 → 9.1.9-rc.2

package/dist/types/components.d.ts

@@ -1186,83 +1186,98 @@ export namespace Components {
     }
     interface SnkFilterBar {
         /**
-          * Adiciona um item de filtro.
-          * @param filterItem - Item a ser adicionado, caso o item já exista com o ID ele não será adicionado novamente
+          * @description Adiciona um item de filtro.
+          * @async 
+          * @param filterItem - Item a ser adicionado, caso o item já exista com o ID, ele não será adicionado novamente.
+          * @return Retorna uma Promise que resolve quando o item for adicionado.
          */
         "addFilterItem": (filterItem: SnkFilterItemConfig) => Promise<void>;
         /**
-          * Função chamada depois de aplicar os filtros.
+          * @description Função chamada depois de aplicar os filtros.
          */
         "afterApplyConfig"?: () => void;
         /**
-          * 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;
         /**
-          * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
+          * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
          */
         "configName": string;
         /**
-          * Loader customizado para carregar as configurações
+          * @description Loader customizado para carregar as configurações.
+          * @param configName - Nome da configuração.
+          * @param resourceId - ID do recurso.
+          * @param options - Opções adicionais.
+          * @returns Retorna a configuração dos filtros.
          */
         "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
         /**
-          * Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros.
+          * @description Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros.
          */
         "dataUnit": DataUnit;
         /**
-          * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados).
+          * @description Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados).
          */
         "disablePersonalizedFilter": boolean;
         /**
-          * Define se o componente deve usar o LockManager para controle de carregamento
+          * @description Define se o componente deve usar o LockManager para controle de carregamento.
          */
         "enableLockManagerLoadingComp"?: boolean;
         /**
-          * Chave da configuração legado da barra de filtros.
+          * @description Chave da configuração legada da barra de filtros.
          */
         "filterBarLegacyConfigName": string;
         /**
-          * Lista todos os filtros disponíveis ao usuário.
+          * @description Lista todos os filtros disponíveis ao usuário.
          */
         "filterConfig": Array<SnkFilterItemConfig>;
         /**
-          * Retorna um item de filtro pelo ID.
+          * @description Retorna um item de filtro pelo ID.
+          * @async 
+          * @param id - ID do item de filtro.
+          * @returns O item de filtro correspondente ou undefined se não for encontrado.
          */
         "getFilterItem": (id: string) => Promise<SnkFilterItemConfig | undefined>;
         /**
-          * 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;
         /**
-          * Modo de apresentação da filterbar.
+          * @description Modo de apresentação da barra de filtros.
          */
         "mode": "regular" | "button" | "hidden";
         /**
-          * Faz o recarregamento da filterbar buscando o state no servidor.
+          * @description Faz o recarregamento da barra de filtros buscando o state no servidor.
+          * @async 
+          * @return Retorna uma Promise que resolve quando o recarregamento for concluído.
          */
         "reload": () => Promise<void>;
         /**
-          * Remove um item de filtro.
-          * @param filterID - ID do a ser adicionado
-          * @returns - Retorna o item de filtro removido, ou undefined caso não encontrado.
+          * @description Remove um item de filtro.
+          * @async 
+          * @param filterID - ID do item a ser removido.
+          * @returns Retorna o item de filtro removido, ou undefined caso não seja encontrado.
          */
         "removeFilterItem": (filterID: string) => Promise<SnkFilterItemConfig | undefined>;
         /**
-          * Identificador de recursos como configurações e acesso.
+          * @description Identificador de recursos como configurações e acesso.
          */
         "resourceID": string;
         /**
-          * Abre o modal de filtros
+          * @description Abre o modal de filtros.
+          * @async
          */
         "showFilterModal": () => Promise<void>;
         /**
-          * Título que será apresentado na barra de filtros
+          * @description Título que será apresentado na barra de filtros.
          */
         "title": string;
         /**
-          * Atualiza um item do filtro.
-          * @param filterItem - Item com as informações atualizadas, caso o item não seja encontrado no array ele mão será modificado
+          * @description Atualiza um item do filtro.
+          * @async 
+          * @param newFilterItem - Item com as informações atualizadas, caso o item não seja encontrado no array, ele não será modificado.
+          * @return Retorna uma Promise que resolve quando a atualização for concluída.
          */
         "updateFilterItem": (newFilterItem: SnkFilterItemConfig) => Promise<void>;
     }
@@ -2058,28 +2073,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;
     }
@@ -2146,11 +2173,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;
         /**
@@ -2160,138 +2187,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;
     }
@@ -3813,56 +3898,65 @@ declare namespace LocalJSX {
     }
     interface SnkFilterBar {
         /**
-          * Função chamada depois de aplicar os filtros.
+          * @description Função chamada depois de aplicar os filtros.
          */
         "afterApplyConfig"?: () => void;
         /**
-          * 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;
         /**
-          * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
+          * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
          */
         "configName"?: string;
         /**
-          * Loader customizado para carregar as configurações
+          * @description Loader customizado para carregar as configurações.
+          * @param configName - Nome da configuração.
+          * @param resourceId - ID do recurso.
+          * @param options - Opções adicionais.
+          * @returns Retorna a configuração dos filtros.
          */
         "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
         /**
-          * Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros.
+          * @description Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros.
          */
         "dataUnit"?: DataUnit;
         /**
-          * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados).
+          * @description Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados).
          */
         "disablePersonalizedFilter"?: boolean;
         /**
-          * Define se o componente deve usar o LockManager para controle de carregamento
+          * @description Define se o componente deve usar o LockManager para controle de carregamento.
          */
         "enableLockManagerLoadingComp"?: boolean;
         /**
-          * Chave da configuração legado da barra de filtros.
+          * @description Chave da configuração legada da barra de filtros.
          */
         "filterBarLegacyConfigName"?: string;
         /**
-          * Lista todos os filtros disponíveis ao usuário.
+          * @description Lista todos os filtros disponíveis ao usuário.
          */
         "filterConfig"?: Array<SnkFilterItemConfig>;
         /**
-          * 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;
         /**
-          * Modo de apresentação da filterbar.
+          * @description Modo de apresentação da barra de filtros.
          */
         "mode"?: "regular" | "button" | "hidden";
+        /**
+          * @description Evento emitido quando a configuração dos filtros é atualizada.
+          * @param configs - Lista de configurações de filtros atualizadas.
+          * @event
+         */
         "onConfigUpdated"?: (event: SnkFilterBarCustomEvent<SnkFilterItemConfig[]>) => void;
         /**
-          * Identificador de recursos como configurações e acesso.
+          * @description Identificador de recursos como configurações e acesso.
          */
         "resourceID"?: string;
         /**
-          * Título que será apresentado na barra de filtros
+          * @description Título que será apresentado na barra de filtros.
          */
         "title"?: string;
     }
@@ -4567,30 +4661,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;
     }
@@ -4663,11 +4776,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;
         /**
@@ -4675,136 +4788,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;
     }