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

package/dist/types/components.d.ts

@@ -1700,52 +1700,72 @@ export namespace Components {
     }
     interface SnkGrid {
         /**
-          * 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>;
         /**
-          * 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 fieldName O nome do campo que receberá o editor customizado.
+          * @param customEditor A instância do editor customizado.
+          * @param detailContext O contexto de detalhe onde o editor será aplicado (opcional).
+          * @returns Uma promessa que é resolvida quando o editor é registrado.
          */
         "addCustomEditor": (fieldName: string, customEditor: ICustomEditor, 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 columnName O nome da coluna que receberá o formatador.
+          * @param customFormatter A instância do formatador de valor.
+          * @returns Uma promessa que é resolvida quando o formatador é registrado.
          */
         "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => 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 fieldName O nome do campo (coluna) que receberá o renderizador customizado.
+          * @param customRender A instância do renderizador customizado.
+          * @param detailContext O contexto de detalhe onde o renderizador será aplicado (opcional).
+          * @returns Uma promessa que é resolvida quando o renderizador é registrado.
          */
         "addGridCustomRender": (fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>;
         /**
-          * Define se a grid será focada ao ser carregada.
+          * Define se a grade receberá o foco automaticamente ao ser carregada.
          */
         "autoFocus"?: boolean;
         /**
-          * 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 edição está habilitada na grid.
+          * Define se a edição de dados na grade está habilitada.
          */
         "canEdit": boolean;
+        /**
+          * Define o data source para o filtro de colunas.
+         */
         "columnFilterDataSource": IMultiSelectionListDataSource;
         /**
-          * Define se a grade deve ser exibida em modo compacto
+          * Define se a grade deve ser exibida em modo compacto.
          */
         "compact": boolean;
         /**
-          * Nome usado para salvar/recuperar a configuração.
+          * Nome usado para salvar e recuperar a configuração da grade.
          */
         "configName": 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;
         /**
-          * Ativa inserção de registros no modo grade.
+          * Habilita a inserção de registros diretamente na grade.
          */
         "enableGridInsert"?: boolean;
         /**
-          * 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;
         /**
@@ -1753,31 +1773,37 @@ export namespace Components {
          */
         "enableLockManagerTaskbarClick"?: boolean;
         /**
-          * Chave da configuração legado da barra de filtros.
+          * Chave da configuração legada da barra de filtros.
          */
         "filterBarLegacyConfigName": string;
         /**
-          * Título que será apresentado na barra de filtros
+          * Título que será apresentado na barra de filtros.
          */
         "filterBarTitle": string;
         /**
-          * 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 O elemento da barra de filtros.
          */
         "getFilterBar": () => Promise<HTMLSnkFilterBarElement>;
         /**
-          * 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;
         /**
-          * Chave da configuração legado da grade.
+          * Chave da configuração legada da grade.
          */
         "gridLegacyConfigName": string;
         /**
           * 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 Uma promessa que é resolvida quando a janela de configuração é fechada.
          */
         "hideConfig": () => Promise<void>;
         /**
-          * Determina se a grade está vinculada a um detalhe.
+          * Determina se a grade está vinculada a um detalhe de outra tela.
          */
         "isDetail": boolean;
         /**
@@ -1785,92 +1811,114 @@ export namespace Components {
          */
         "messagesBuilder": SnkMessageBuilder;
         /**
-          * Habilita a edição de múltiplos registros simultâneos.
+          * Habilita a edição de múltiplos registros simultaneamente.
          */
         "multipleEditionEnabled": boolean;
         /**
-          * Determina se pode haver mais de uma linha selecionada.
+          * Determina se a seleção de múltiplas linhas é permitida.
          */
         "multipleSelection": 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 grid será focada ao ser carregada.
+          * Define o modo de exibição do contador de paginação.
          */
         "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
         /**
-          * 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": PresentationMode1;
         /**
-          * 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;
+        /**
+          * 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": () => 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 Uma promessa que é resolvida quando a barra de filtros é recarregada.
          */
         "reloadFilterBar": () => 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 columnName O nome da coluna da qual o formatador será removido.
+          * @returns Uma promessa que é resolvida quando o formatador é removido.
          */
         "removeCustomValueFormatter": (columnName: string) => Promise<void>;
         /**
-          * 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;
         /**
-          * 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 config O objeto de configuração a ser aplicado na grade.
+          * @returns Uma promessa que é resolvida quando a configuração é aplicada.
          */
         "setConfig": (config: IGridConfig) => 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 Uma promessa que é resolvida quando o foco é atribuído.
          */
         "setFocus": () => Promise<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 Uma promessa que é resolvida quando a janela de configuração é exibida.
          */
         "showConfig": () => Promise<void>;
         /**
-          * 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;
         /**
-          * Modo de exportação dos dados.
+          * Define o modo de exportação dos dados.
          */
         "strategyExporter": IExporterStrategyMode;
         /**
-          * 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 suprimir o scroll horizontal.
+          * Define se a grade deve suprimir a barra de rolagem horizontal.
          */
         "suppressHorizontalScroll": boolean;
         /**
-          * Define o identificador do container de elementos customizados da Taskbar.
+          * Define o identificador do contêiner de elementos customizados da `Taskbar`.
          */
         "taskbarCustomContainerId": string;
         /**
-          * 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;
         /**
-          * 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;
         /**
-          * 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;
         /**
-          * 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;
     }
@@ -4244,40 +4292,43 @@ declare namespace LocalJSX {
     }
     interface SnkGrid {
         /**
-          * 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>;
         /**
-          * Define se a grid será focada ao ser carregada.
+          * Define se a grade receberá o foco automaticamente ao ser carregada.
          */
         "autoFocus"?: boolean;
         /**
-          * 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 edição está habilitada na grid.
+          * Define se a edição de dados na grade está habilitada.
          */
         "canEdit"?: boolean;
+        /**
+          * Define o data source para o filtro de colunas.
+         */
         "columnFilterDataSource"?: IMultiSelectionListDataSource;
         /**
-          * Define se a grade deve ser exibida em modo compacto
+          * Define se a grade deve ser exibida em modo compacto.
          */
         "compact"?: boolean;
         /**
-          * Nome usado para salvar/recuperar a configuração.
+          * Nome usado para salvar e recuperar a configuração da grade.
          */
         "configName"?: 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;
         /**
-          * Ativa inserção de registros no modo grade.
+          * Habilita a inserção de registros diretamente na grade.
          */
         "enableGridInsert"?: boolean;
         /**
-          * 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;
         /**
@@ -4285,23 +4336,23 @@ declare namespace LocalJSX {
          */
         "enableLockManagerTaskbarClick"?: boolean;
         /**
-          * Chave da configuração legado da barra de filtros.
+          * Chave da configuração legada da barra de filtros.
          */
         "filterBarLegacyConfigName"?: string;
         /**
-          * Título que será apresentado na barra de filtros
+          * Título que será apresentado na barra de filtros.
          */
         "filterBarTitle"?: 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;
         /**
-          * Chave da configuração legado da grade.
+          * Chave da configuração legada da grade.
          */
         "gridLegacyConfigName"?: string;
         /**
-          * Determina se a grade está vinculada a um detalhe.
+          * Determina se a grade está vinculada a um detalhe de outra tela.
          */
         "isDetail"?: boolean;
         /**
@@ -4309,83 +4360,88 @@ declare namespace LocalJSX {
          */
         "messagesBuilder"?: SnkMessageBuilder;
         /**
-          * Habilita a edição de múltiplos registros simultâneos.
+          * Habilita a edição de múltiplos registros simultaneamente.
          */
         "multipleEditionEnabled"?: boolean;
         /**
-          * Determina se pode haver mais de uma linha selecionada.
+          * Determina se a seleção de múltiplas linhas é permitida.
          */
         "multipleSelection"?: 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 detail - O identificador da ação clicada, que pode ser usado para determinar qual ação executar.
          */
         "onActionClick"?: (event: SnkGridCustomEvent<string>) => void;
         /**
-          * Emitido quando o componente estiver completamente carregado.
+          * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
          */
         "onComponentReady"?: (event: SnkGridCustomEvent<void>) => void;
         /**
-          * 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 detail - Detalhes do evento, contendo a linha clicada.
          */
         "onGridDoubleClick"?: (event: SnkGridCustomEvent<any>) => 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)
+          * 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 grid será focada ao ser carregada.
+          * Define o modo de exibição do contador de paginação.
          */
         "paginationCounterMode"?: 'show' | 'hidden' | 'auto';
         /**
-          * 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"?: PresentationMode1;
         /**
-          * 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;
         /**
-          * 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;
         /**
-          * 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;
         /**
-          * Modo de exportação dos dados.
+          * Define o modo de exportação dos dados.
          */
         "strategyExporter"?: IExporterStrategyMode;
         /**
-          * 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 suprimir o scroll horizontal.
+          * Define se a grade deve suprimir a barra de rolagem horizontal.
          */
         "suppressHorizontalScroll"?: boolean;
         /**
-          * Define o identificador do container de elementos customizados da Taskbar.
+          * Define o identificador do contêiner de elementos customizados da `Taskbar`.
          */
         "taskbarCustomContainerId"?: string;
         /**
-          * 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;
         /**
-          * 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;
         /**
-          * 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;
         /**
-          * 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;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sankhyalabs/sankhyablocks",
-  "version": "9.2.0-dev.3",
+  "version": "9.2.0-dev.4",
   "description": "Stencil Component Starter",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",
@@ -21,9 +21,10 @@
   ],
   "scripts": {
     "prebuild": "(test -f ./src/components.d.ts && git checkout ./src/components.d.ts) || true",
-    "build": "stencil build --docs",
-    "build.prod": "npm run prebuild && stencil build --docs --prod",
+    "build": "stencil build --docs && npm run formatdocs",
+    "build.prod": "npm run prebuild && stencil build --docs --prod && npm run formatdocs",
     "build.with.peerdeps": "stencil build --docs --prod --force-peer-deps",
+    "formatdocs": "node ./scripts/format-docs.js",
     "start": "stencil build --dev --watch --serve --force-peer-deps",
     "test": "stencil test --spec --e2e --coverage --silent --testResultsProcessor jest-sonar-reporter --runInBand",
     "test.dev": "stencil test --spec --e2e",