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

package/dist/types/components.d.ts

@@ -1554,7 +1554,11 @@ export namespace Components {
     }
     interface SnkForm {
         /**
-          * Registra um editor customizado para campos da grade e formulário.
+          * Registra um editor customizado para campos do formulário.
+          * @async 
+          * @param fieldName - Nome do campo.
+          * @param customEditor - Editor customizado.
+          * @returns
          */
         "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise<void>;
         /**
@@ -1562,11 +1566,13 @@ export namespace Components {
          */
         "configName": string;
         /**
-          * Chave da configuração legado do formulário.
+          * Chave da configuração legada do formulário.
          */
         "formLegacyConfigName": string;
         /**
           * Fecha a janela de configurações do formulário.
+          * @async 
+          * @returns
          */
         "hideConfig": () => Promise<void>;
         /**
@@ -1583,12 +1589,26 @@ export namespace Components {
         "resourceID": string;
         /**
           * Altera/adiciona uma propriedade nos metadados do campo.
+          * @async 
+          * @param fieldName - Nome do campo.
+          * @param propName - Nome da propriedade.
+          * @param value - Valor da propriedade.
+          * @returns
          */
         "setFieldProp": (fieldName: string, propName: string, value: any) => Promise<void>;
         /**
           * Exibe a janela de configurações do formulário.
+          * @async 
+          * @returns
          */
         "showConfig": () => Promise<void>;
+        /**
+          * Valida o formulário.
+          * @async 
+          * @returns 
+          * @description Este método executa a validação do formulário, verificando se todos os campos estão  preenchidos corretamente de acordo com as regras definidas. Se a validação falhar, uma exceção será lançada com os detalhes dos erros encontrados. Caso contrário, o método será resolvido sem erros.
+         */
+        "validate": () => Promise<void>;
     }
     interface SnkFormConfig {
         /**
@@ -1700,52 +1720,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 +1793,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 +1831,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;
     }
@@ -4099,7 +4167,7 @@ declare namespace LocalJSX {
          */
         "configName"?: string;
         /**
-          * Chave da configuração legado do formulário.
+          * Chave da configuração legada do formulário.
          */
         "formLegacyConfigName"?: string;
         /**
@@ -4107,15 +4175,15 @@ declare namespace LocalJSX {
          */
         "messagesBuilder"?: SnkMessageBuilder;
         /**
-          * Emitido sempre que houver click de botão ou ação.
+          * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
          */
         "onActionClick"?: (event: SnkFormCustomEvent<string>) => void;
         /**
-          * Emitido quando o botão de voltar é acionado.
+          * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
          */
         "onExit"?: (event: SnkFormCustomEvent<void>) => void;
         /**
-          * Responsável por notificar quando ocorrer a renderização de itens do formulário.
+          * Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view
          */
         "onFormItemsReady"?: (event: SnkFormCustomEvent<Array<HTMLElement>>) => void;
         /**
@@ -4244,40 +4312,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 +4356,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 +4380,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.5",
   "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",

package/dist/sankhyablocks/p-fa18530e.entry.js

@@ -1 +0,0 @@
-import{r as i,c as t,h as s,g as e,H as h}from"./p-d8d8169b.js";import{ElementIDUtils as a,ObjectUtils as o,ApplicationContext as n}from"@sankhyalabs/core";import{S as d}from"./p-1210500e.js";import{R as l}from"./p-688dcb4c.js";import{buildFormConfigFromDataUnit as r}from"@sankhyalabs/ezui/dist/collection/utils/form";import{b as c,a as f,g,u as m,c as u}from"./p-8f73da95.js";import{a as v,G as p}from"./p-9019a32f.js";import{ApplicationUtils as C}from"@sankhyalabs/ezui/dist/collection/utils";import{U as b}from"./p-c6331595.js";import"./p-3dba3468.js";import"./p-0dac8fef.js";import"./p-8d884fab.js";import"@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata";import"./p-ff1990ad.js";const y=class{constructor(s){i(this,s),this.exit=t(this,"exit",7),this.actionClick=t(this,"actionClick",7),this.formItemsReady=t(this,"formItemsReady",7),this._customEditors=new Map,this._dataUnit=void 0,this._dataState=void 0,this._showFormConfig=!1,this._configManager=void 0,this.configName=void 0,this.recordsValidator=void 0,this.messagesBuilder=void 0,this.formLegacyConfigName=void 0,this.resourceID=void 0}async showConfig(){this._showFormConfig=!0}async hideConfig(){this._showFormConfig=!1}async addCustomEditor(i,t){if(this._form)return void this._form.addCustomEditor(i,t);const s=new Map(this._customEditors);s.set(i,t),this._customEditors=s}async setFieldProp(i,t,s){await this._form.setFieldProp(i,t,s)}closeConfig(){this.hideConfig()}dataunitReady(){a.addIDInfo(this._element,null,{dataUnit:this._dataUnit})}setCustomEditors(){if(this._form)for(const[i,t]of this._customEditors)this._form.addCustomEditor(i,t),this._customEditors.delete(i)}async componentDidRender(){this.setCustomEditors()}async componentWillLoad(){let i=this._element.parentElement;for(;i;){if("SNK-DATA-UNIT"===i.tagName.toUpperCase()){this._snkDataUnit=i,this._dataUnit=this._snkDataUnit.dataUnit,this._dataState=this._snkDataUnit.dataState,this._dataUnit?this.dataunitReady():this._snkDataUnit.addEventListener("dataUnitReady",(i=>{this._dataUnit=i.detail})),this._snkDataUnit.addEventListener("dataStateChange",this.handleDataStateChange.bind(this));break}i=i.parentElement}null==this.resourceID&&(this.resourceID=await l.getResourceID()),this._configManager=new d(this.configName,this.resourceID,void 0,this._dataUnit),this.addFormLegacyConfig(),await this._configManager.loadConfig()}async handleDataStateChange(i){var t;this._dataState=i.detail;const s=await this._snkDataUnit.getFieldsWithRmPrecision();for(const i of s||[]){if(!i)continue;const s=null===(t=this._dataState.rowMetadata)||void 0===t?void 0:t.getProp("rm_precision",i);(s||0===s)&&(await this.setFieldProp(i,"precision",s),await this.setFieldProp(i,"prettyPrecision",s))}}addFormLegacyConfig(){this.formLegacyConfigName&&this._configManager.addFormLegacyConfig(this.formLegacyConfigName)}render(){if(this._dataUnit&&this._dataState)return s("section",null,s("div",{class:"ez-row"},s("div",{class:"ez-col ez-col--sd-12"},s("ez-form",{ref:i=>this._form=i,key:"ezForm"+this._snkDataUnit.entityName,"data-element-id":"embedded",dataUnit:this._dataUnit,config:this._configManager.getConfig(this._dataUnit),recordsValidator:this.recordsValidator,class:this._showFormConfig?"snk-form__form--hidden":""}),this._showFormConfig&&s("snk-form-config",{messagesBuilder:this.messagesBuilder,dataUnit:this._dataUnit,configManager:this._configManager,onConfigClose:()=>this.closeConfig()}))))}get _element(){return e(this)}};y.style=".sc-snk-form-h{--snk-form__header--min-height:94px;display:block}.snk-form__form--hidden.sc-snk-form{display:none}";const k=class{constructor(s){i(this,s),this.configClose=t(this,"configClose",7),this.configChange=t(this,"configChange",7),this.guidesMap=new Map,this.availableFields=[],this.guidesList=[],this.groupsList=[],this.selectedGuide=void 0,this._formConfig={},this.configOptions=[],this.originalConfigSelected=void 0,this.configSelected=void 0,this.hasChanges=!1,this.optionConfigChanged=!1,this.dataUnit=void 0,this.configManager=void 0,this.ignoreReadOnlyFormFields=void 0,this.messagesBuilder=void 0}handleFieldConfigChanged(){this.hasChanges=!0}async handleFormConfigOptionSelected({detail:i}){this.configSelected=i,await this.loadConfigByUser(),this.selectedGuide=void 0,this.optionConfigChanged=!o.equals(this.configSelected,this.originalConfigSelected),this.configSelected.origin===b.DEFAULT&&(this.hasChanges=!1)}async handleAddFieldToGuide({detail:i}){var t;this.selectedGuide?(this.availableFields=[...this.availableFields.filter((t=>t.name!==i.name))],await(null===(t=this.refFieldsLayout)||void 0===t?void 0:t.addFieldToLayout(i))):this.showNoGuideSelectedDialog()}async handleSetFieldAsAvailable({detail:i}){this.availableFields.some((t=>t.name===i.name))||(this.availableFields=[...this.availableFields,i])}async handleRemoveFieldFromAvailable({detail:i}){this.availableFields=this.availableFields.filter((t=>t.name!==i.name))}observeSelectedGuide(i){var t;const s=null!==(t=this.guidesMap.get(null==i?void 0:i.name))&&void 0!==t?t:[];this.groupsList=[...s]}observeConfigManager(){this.loadFormConfig()}showNoGuideSelectedDialog(){const i=this.getMessage("snkFormConfig.noGuideSelected.title"),t=this.getMessage("snkFormConfig.noGuideSelected.message");C.alert(i,t)}getMessage(i,t){return this.messagesBuilder.getMessage(i,t)}async initializeUserConfig(){if(null!=this.configManager)try{const i=await this.configManager.fetchUserAvailableConfigs();this.configOptions=i;const t=null==this._formConfig||this._formConfig.defaultConfiguration?b.DEFAULT:b.USER;this.configSelected=i.find((i=>i.origin===t)),this.originalConfigSelected=i.find((i=>i.origin===t))}catch(i){console.error(this.getMessage("snkFormConfig.errors.failFetchUserConfig")),console.error(i)}}async loadConfigByUser(){this.configManager&&this.configSelected&&(this.isConfigDefaultSelected()?await this.handleLoadDefaultConfig():this.loadFormConfig())}async handleLoadDefaultConfig(){const i=await this.configManager.fetchDefaultConfig();if(i)return void this.loadFormConfig(i);const t=this.configManager.getEmptyConfig();t&&this.loadFormConfig(t)}isConfigDefaultSelected(){return this.configSelected.origin===b.DEFAULT}loadFormConfig(i){this._formConfig=i||this.getConfig(),this.loadGuides(),this.initializeAvailableFields()}initializeAvailableFields(){var i;if(null==(null===(i=this._formConfig)||void 0===i?void 0:i.fields))return;const t=[...this._formConfig.fields];this.availableFields=this.dataUnit.metadata.fields.filter((({name:i,visible:s,properties:e})=>{const h=t.some((({name:t})=>t===i));return h||!0!==e.visibleOnConfig||s?!0===s&&!1===h:e.visibleOnConfig}))}loadGuides(){var i;this.guidesList=[...c(this._formConfig,this.getMessage("snkFormConfig.form.mainArea"))],this.guidesMap=f(null===(i=this._formConfig)||void 0===i?void 0:i.fields,this.guidesList,this.dataUnit,this.getMessage("snkFormConfig.form.tabGeneral"))}getConfig(){let i=this.configManager.getConfig(this.dataUnit,!1);return i.fields&&0===i.fields.length&&(i=void 0),null==i&&(i=r(this.dataUnit)),o.copy(i)}handleSelectGuide({detail:i}){this.selectedGuide=i}handleLayoutChanged({detail:i}){this.hasChanges=!0,this.groupsList=[...i],this.guidesMap.set(this.selectedGuide.name,[...i])}getIsDefaultConfig(){var i;return(null===(i=this.configSelected)||void 0===i?void 0:i.origin)===b.DEFAULT&&!0===this.optionConfigChanged&&!1===this.hasChanges}getTabsToSave(){return this.guidesList.map((i=>({name:i.name,label:i.name===v.main?i.name:i.label,order:i.name===v.main?0:i.order,visible:i.visible})))}async handleSaveConfig(){var i;const t=await this.configManager.saveConfig(this.buildConfigToSave());this.configSelected=null===(i=this.configOptions)||void 0===i?void 0:i.find((i=>i.origin===(this.hasChanges?b.USER:b.DEFAULT))),this.originalConfigSelected=this.configSelected,this.hasChanges=!1,this.optionConfigChanged=!1,C.info(this.getMessage("snkFormConfig.info.successfullyConfigSaved"),{iconName:"check"}),this.configChange.emit(t)}buildConfigToSave(){if(this.getIsDefaultConfig()){const i=this._formConfig;return i.defaultConfiguration=!0,i}const i=o.copy(this._formConfig);return i.tabs=this.getTabsToSave(),i.fields=g(this.guidesMap),i.defaultConfiguration=!1,i}handleAvailableFieldListChanged({detail:i}){this.availableFields=[...i]}handleSetFieldListAsAvailable({detail:i}){this.availableFields=[...this.availableFields,...i]}handleGuideDeleted({detail:i}){var t,s;const e=i.name,h=null!==(t=this.guidesMap.get(e))&&void 0!==t?t:[],a=[];h.forEach((i=>a.push(...i.fields))),this.availableFields=[...this.availableFields,...a],this.guidesList=[...this.guidesList.filter((i=>i.name!==e))],this.guidesMap.delete(e),(null===(s=this.selectedGuide)||void 0===s?void 0:s.name)===e&&(this.selectedGuide=void 0),this.hasChanges=!0}handleGuideListChanged({detail:i}){this.hasChanges=!0,this.guidesList=[...i]}handleGuideRenamed({detail:i}){var t;const s=null!==(t=this.guidesMap.get(this.selectedGuide.name))&&void 0!==t?t:[],e=m(s,i);this.guidesMap.delete(this.selectedGuide.name),this.guidesMap.set(i,e);const h={name:i,label:i,visible:this.selectedGuide.visible,order:this.selectedGuide.order};this.guidesList=[...this.guidesList.map((i=>i.name===this.selectedGuide.name?h:i))],this.groupsList=[...e],this.selectedGuide=h,this.hasChanges=!0}handleCreateNewGuide(){const i=u(this.guidesList,this.getMessage.bind(this)),t={name:i,label:i,visible:!0,order:this.guidesList.length+1},s={name:p.noGroup,fields:[]};this.guidesList=[...this.guidesList,t],this.guidesMap.set(i,[s]),this.selectedGuide=t,this.hasChanges=!0}getGuideNames(){return[...this.guidesList.map((i=>i.name.toLowerCase())),this.getMessage("snkFormConfig.form.mainArea").toLowerCase()]}async componentWillRender(){if(null==this.messagesBuilder){const i=n.getContextValue("__SNK__APPLICATION__");this.messagesBuilder=i.messagesBuilder}}async componentWillLoad(){this.loadFormConfig(),await this.initializeUserConfig()}render(){return s(h,null,s("config-header",{configOptions:this.configOptions,selectedConfig:this.configSelected,messagesBuilder:this.messagesBuilder,hasChanges:this.hasChanges,optionConfigChanged:this.optionConfigChanged,onConfigClose:()=>this.configClose.emit(),onSaveConfig:async()=>await this.handleSaveConfig()}),s("div",{class:"ez-padding--medium"},s("div",{class:"ez-flex sidebarNavigator__container"},s("guides-configurator",{messagesBuilder:this.messagesBuilder,guidesList:this.guidesList,selectedGuide:this.selectedGuide,onGuideSelected:this.handleSelectGuide.bind(this),onGuideListChanged:this.handleGuideListChanged.bind(this),onCreateNewGuide:this.handleCreateNewGuide.bind(this),onGuideDeleted:this.handleGuideDeleted.bind(this)}),s("fields-layout",{ref:i=>this.refFieldsLayout=i,selectedGuide:this.selectedGuide,guideNames:this.getGuideNames(),groupsList:this.groupsList,messagesBuilder:this.messagesBuilder,dataUnit:this.dataUnit,onGuideRenamed:this.handleGuideRenamed.bind(this),onLayoutChanged:this.handleLayoutChanged.bind(this),onSetFieldListAsAvailable:this.handleSetFieldListAsAvailable.bind(this)}),s("fields-selector",{dataUnit:this.dataUnit,availableFields:this.availableFields,onFieldListChanged:this.handleAvailableFieldListChanged.bind(this),messagesBuilder:this.messagesBuilder}))))}static get watchers(){return{selectedGuide:["observeSelectedGuide"],configManager:["observeConfigManager"]}}};k.style='.sc-snk-form-config-h{display:flex;flex-direction:column;height:100vh;width:100vw;font-family:var(--font-pattern, "Roboto");background:white;color:#2b3a54;--snk-form-config-container-height:calc(100vh - 95px);outline:none}.sidebarNavigator__container.sc-snk-form-config{height:var(--snk-form-config-container-height);gap:20px;align-items:flex-start}.guide-header.sc-snk-form-config{display:flex;width:100%;padding-bottom:12px;border-bottom:1px solid #dce0e8;height:30px;font-weight:500;font-size:16px}';export{y as snk_form,k as snk_form_config}