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

package/dist/types/components/snk-data-unit/snk-data-unit.d.ts

@@ -21,57 +21,73 @@ export declare class SnkDataUnit implements DUActionInterceptor {
   fieldsToLink: Array<string>;
   /**
    * Controla o estado atual dos dados.
+   * @type {DataState}
   */
   dataState: DataState;
   /**
    * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+   * @type {SnkMessageBuilder}
    */
   messagesBuilder: SnkMessageBuilder;
   /**
    * Usado para criar o dataUnit uma única vez.
    * Se omitido, será usado o próprio nome da entidade.
+   * @type {string}
    */
   dataUnitName: string;
   /**
    * Determina qual a entidade que representa os dados em questão.
+   * @type {string}
    */
   entityName: string;
   /**
    * Determina quantas linhas são retornadas por página.
+   * @type {number}
+   * @default 150
    */
   pageSize: number;
   /**
    * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
+   * @type {DataUnit}
    */
   dataUnit: DataUnit;
   /**
    * Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo.
    * Caso retorne "false" (ou a promessa se resolva como false), cancela a ação.
+   * @param {DataUnit} dataUnit - A instância do DataUnit.
+   * @returns {boolean | Promise<boolean>} `false` para cancelar a ação, `true` para continuar.
    */
   beforeSave: (dataUnit: DataUnit) => boolean | Promise<boolean>;
   /**
    * Executado após a ação de salvar.
+   * @param {DataUnit} dataUnit - A instância do DataUnit.
+   * @returns {void}
    */
   afterSave: (dataUnit: DataUnit) => void;
   /**
    * Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição.
-   *
+   * @type {boolean}
+   * @default true
   */
   useCancelConfirm: boolean;
   /**
    * Responsável por evitar a mensagem de sucesso ao salvar.
+   * @type {boolean}
    */
   ignoreSaveMessage: boolean;
   /**
    * Usado para obter configuração de metadados.
+   * @type {string}
    */
   configName: string;
   /**
    * Identificador de recursos como configurações e acesso.
+   * @type {string}
    */
   resourceID: string;
   /**
   * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
+  * @type {string}
   */
   domainMessagesBuilder: string;
   observePageSize(): void;
@@ -82,48 +98,75 @@ export declare class SnkDataUnit implements DUActionInterceptor {
   observeMessagesBuilder(newValue: SnkMessageBuilder): void;
   /**
    * Emitido quando há qualquer mudança de estado no DataUnit.
+   * @event dataStateChange
+   * @type {CustomEvent<DataState>}
+   * @bubbles false
    */
   dataStateChange: EventEmitter<DataState>;
   /**
    * Emitido quando o DataUnit está pronto.
+   * @event dataUnitReady
+   * @type {CustomEvent<DataUnit>}
+   * @bubbles false
    */
   dataUnitReady: EventEmitter<DataUnit>;
   /**
-   * Emitido quando o DataUnit está pronto.
+   * Emitido quando o messagesBuilder é atualizado.
+   * @event messagesBuilderUpdated
+   * @type {CustomEvent<SnkMessageBuilder>}
+   * @bubbles false
    */
   messagesBuilderUpdated: EventEmitter<SnkMessageBuilder>;
   /**
    * Emitido quando há campos no DataUnit que devem ser ocultados.
+   * @event dataUnitFieldsHidded
+   * @type {CustomEvent<void>}
    */
   dataUnitFieldsHidded: EventEmitter<void>;
   /**
    * Emitido quando um registro é adicionado ou copiado.
+   * @event insertionMode
+   * @type {CustomEvent<void>}
+   * @bubbles false
    */
   insertionMode: EventEmitter<void>;
   /**
    * Emitido quando se cancela uma inserção ou cópia.
+   * @event cancelEdition
+   * @type {CustomEvent<void>}
+   * @bubbles false
    */
   cancelEdition: EventEmitter<void>;
   onMasterFormConfigChange({ detail }: CustomEvent): void;
   /**
    * Obtém o dataUnit.
+   * @returns {Promise<DataUnit>} Uma promessa que resolve com a instância do DataUnit.
+   * @async
    */
   getDataUnit(): Promise<DataUnit>;
   /**
    * Método que retorna a lista de IDs dos registros selecionados.
-   * @returns Retorna a lista de IDs dos registros selecionados.
+   * @returns {Promise<Array<IRecordID>>} Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
+   * @async
    */
   getSelectedRecordsIDsInfo(): Promise<Array<IRecordID>>;
   /**
    * Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
+   * @returns {Promise<string[]>} Uma promessa que resolve com um array de nomes de campos.
+   * @async
    */
   getFieldsWithRmp(): Promise<string[]>;
   /**
    * Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
+   * @returns {Promise<string[]>} Uma promessa que resolve com um array de nomes de campos.
+   * @async
    */
   getFieldsWithRmPrecision(): Promise<string[]>;
   /**
    * Busca os metadados da linha selecionada.
+   * @param {Record | string} [record] - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado.
+   * @returns {Promise<RowMetadata>} Uma promessa que resolve com os metadados da linha.
+   * @async
    */
   getRowMetadata(record?: Record | string): Promise<RowMetadata>;
   private doGetRowMetadata;

package/dist/types/components/snk-grid/snk-grid.d.ts

@@ -44,9 +44,12 @@ export declare class SnkGrid {
   _showSnkFilterBar: boolean;
   _enableContinuousInsert: boolean;
   _application: SnkApplication;
+  /**
+   * Define o data source para o filtro de colunas.
+   */
   columnFilterDataSource: IMultiSelectionListDataSource;
   /**
-   * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
+   * Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
    */
   enableLockManagerLoadingComp?: boolean;
   /**
@@ -54,45 +57,48 @@ export declare class SnkGrid {
    */
   enableLockManagerTaskbarClick?: boolean;
   /**
-   * Nome usado para salvar/recuperar a configuração.
+   * Nome usado para salvar e recuperar a configuração da grade.
    */
   configName: string;
   /**
-   * Título que será apresentado na barra de filtros
+   * Título que será apresentado na barra de filtros.
    */
   filterBarTitle: string;
   /**
-   * Identificador de recursos como configurações e acesso.
+   * Identificador de recursos, como configurações e permissões de acesso.
    */
   resourceID: string;
   /**
-   * Configuração da seleção de grade no toast.
+   * Configuração do toast de seleção da grade.
    */
   selectionToastConfig: ISelectionToastConfig;
   /**
-   * Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar.
+   * Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`.
    */
   actionsList: Array<Action>;
   /**
-   * Determina se a grade está vinculada a um detalhe.
+   * Determina se a grade está vinculada a um detalhe de outra tela.
    */
   isDetail: boolean;
   /**
-  * Gerenciador das barras de tarefas. É possível determinar botões específicos
-  * ou mesmo gerenciar o estado dos botões.
+  * Gerenciador das barras de tarefas. Permite determinar botões específicos
+  * ou gerenciar o estado dos botões.
   */
   taskbarManager: TaskbarManager;
   /**
-   * Configuração do valor da coluna de status.
-   * Exemplo: '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
+   * Define a configuração de cores para a coluna de status.
+   * @example
+   * ```json
+   * '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }'
+   * ```
    */
   statusResolver: IStatusResolver | StatusResolverFunction;
   /**
-   * Determina se pode haver mais de uma linha selecionada.
+   * Determina se a seleção de múltiplas linhas é permitida.
    */
   multipleSelection: boolean;
   /**
-   * Altera o modo de apresentação dos botões do snk-taskbar.
+   * Altera o modo de apresentação dos botões do `snk-taskbar`.
    */
   presentationMode: PresentationMode;
   /**
@@ -100,139 +106,187 @@ export declare class SnkGrid {
   */
   messagesBuilder: SnkMessageBuilder;
   /**
-   * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
+   * Quando `true`, a tecla ENTER navega entre as células como a tecla TAB.
    */
   useEnterLikeTab: boolean;
   /**
-   * Validador responsável por checar a integridade das informações do registro.
+   * Validador responsável por verificar a integridade dos dados de um registro.
    */
   recordsValidator: IRecordValidator;
   /**
-   * Define se a edição está habilitada na grid.
+   * Define se a edição de dados na grade está habilitada.
    */
   canEdit: boolean;
   /**
-   * Define o identificador do container de elementos customizados da Taskbar.
+   * Define o identificador do contêiner de elementos customizados da `Taskbar`.
    */
   taskbarCustomContainerId: string;
   /**
-   * Nome do slot de elementos customizados da Taskbar do cabeçalho da grade.
+   * Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade.
    */
   gridHeaderCustomSlotId: string;
   /**
-   * Nome do slot de elementos customizados da Taskbar principal do componente.
+   * Define o nome do slot para elementos customizados na `Taskbar` principal do componente.
    */
   topTaskbarCustomSlotId: string;
   /**
-  * 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).
+  * Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros)
+  * e no modal lateral de filtros (contêiner de filtros personalizados).
   */
   disablePersonalizedFilter: boolean;
   /**
-   * Chave da configuração legado da grade.
+   * Chave da configuração legada da grade.
    */
   gridLegacyConfigName: string;
   /**
-   * Chave da configuração legado da barra de filtros.
+   * Chave da configuração legada da barra de filtros.
    */
   filterBarLegacyConfigName: string;
   /**
-   * Define se a carga dos dados será feita assim que o componente for carregado.
+   * Define se os dados serão carregados automaticamente na inicialização do componente.
    */
   autoLoad?: boolean;
   /**
-   * Define se a grid será focada ao ser carregada.
+   * Define se a grade receberá o foco automaticamente ao ser carregada.
    */
   autoFocus?: boolean;
   /**
-   * Ativa inserção de registros no modo grade.
+   * Habilita a inserção de registros diretamente na grade.
    */
   enableGridInsert?: boolean;
   /**
-  * 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)
+  * Altera a aparência das bordas e sombras do componente.
+  * Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout).
+  * Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up).
   */
   outlineMode?: boolean;
   /**
-   * Define se a grade deve suprimir o scroll horizontal.
+   * Define se a grade deve suprimir a barra de rolagem horizontal.
    */
   suppressHorizontalScroll: boolean;
   /**
-   * Modo de exportação dos dados.
+   * Define o modo de exportação dos dados.
    */
   strategyExporter: IExporterStrategyMode;
   /**
-   * Define se a grade deve exibir um buscador de coluna com uso do Ctrl+F
+   * Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`.
    */
   useSearchColumn: boolean;
   /**
-   * Habilita a edição de múltiplos registros simultâneos.
+   * Habilita a edição de múltiplos registros simultaneamente.
    */
   multipleEditionEnabled: boolean;
   /**
-   * Define se a grid será focada ao ser carregada.
+   * Define o modo de exibição do contador de paginação.
    */
   paginationCounterMode?: 'show' | 'hidden' | 'auto';
   /**
-   * Informa se a coluna de chechbox deve ser suprimida
+   * Informa se a coluna de checkbox deve ser suprimida.
    */
   suppressCheckboxColumn: boolean;
   /**
-   * Define se a grade deve ser exibida em modo compacto
+   * Define se a grade deve ser exibida em modo compacto.
    */
   compact: boolean;
   /**
-   * Emitido sempre que houver click de botão ou ação.
+   * Emitido ao clicar em um botão de ação ou item de menu.
+   * @description Este evento é acionado quando o usuário clica em um botão de ação ou item de menu na grade, permitindo a execução de ações específicas.
+   * @param {string} detail - O identificador da ação clicada, que pode ser usado para determinar qual ação executar.
    */
   actionClick: EventEmitter<string>;
   /**
-  * Emitido sempre que houver duplo click na grade.
+  * Emitido ao realizar um duplo clique em uma linha da grade.
+  * @description Este evento é acionado quando o usuário clica duas vezes em uma linha da grade, permitindo ações como edição rápida ou visualização de detalhes.
+  * @param {any} detail - Detalhes do evento, contendo a linha clicada.
   */
   gridDoubleClick: EventEmitter<any>;
   /**
-   * Emitido quando o componente estiver completamente carregado.
+   * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
    */
   componentReady: EventEmitter<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.
+   */
   reloadConfig(): void;
   /**
    * 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.
    */
   showConfig(): Promise<void>;
   /**
    * 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.
    */
   hideConfig(): Promise<void>;
   /**
-   * 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.
    */
   setConfig(config: IGridConfig): Promise<void>;
   /**
-   * 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.
    */
   reloadFilterBar(): Promise<void>;
   /**
-   * 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.
    */
   getFilterBar(): Promise<HTMLSnkFilterBarElement>;
   /**
-   * 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.
    */
   addCustomEditor(fieldName: string, customEditor: ICustomEditor, detailContext?: string): Promise<void>;
   /**
-   * 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.
    */
   addGridCustomRender(fieldName: string, customRender: ICustomRender, detailContext?: string): Promise<void>;
   /**
-   * 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.
    */
   addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter): Promise<void>;
   /**
-   * 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.
    */
   removeCustomValueFormatter(columnName: string): Promise<void>;
   /**
    * 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.
    */
   setFocus(): Promise<void>;
   handleClick(event: MouseEvent): Promise<void>;