@sankhyalabs/sankhyablocks 9.2.0-ms.9 → 9.2.0

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

@@ -48,6 +48,7 @@ export declare class SnkGrid {
    * Define o data source para o filtro de colunas.
    */
   columnFilterDataSource: IMultiSelectionListDataSource;
+  refreshColumnFilterDataSource(): Promise<void>;
   /**
    * Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
    */
@@ -81,9 +82,9 @@ export declare class SnkGrid {
    */
   isDetail: boolean;
   /**
-  * Gerenciador das barras de tarefas. Permite determinar botões específicos
-  * ou 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;
   /**
    * Define a configuração de cores para a coluna de status.
@@ -103,7 +104,7 @@ export declare class SnkGrid {
   presentationMode: PresentationMode;
   /**
    * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
-  */
+   */
   messagesBuilder: SnkMessageBuilder;
   /**
    * Quando `true`, a tecla ENTER navega entre as células como a tecla TAB.
@@ -130,9 +131,9 @@ export declare class SnkGrid {
    */
   topTaskbarCustomSlotId: string;
   /**
-  * 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).
-  */
+   * 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 legada da grade.
@@ -155,10 +156,10 @@ export declare class SnkGrid {
    */
   enableGridInsert?: boolean;
   /**
-  * 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).
-  */
+   * 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 a barra de rolagem horizontal.
@@ -199,10 +200,10 @@ export declare class SnkGrid {
    */
   actionClick: EventEmitter<string>;
   /**
-  * 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.
-  */
+   * 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>;
   /**
    * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
@@ -304,8 +305,10 @@ export declare class SnkGrid {
   private normalizeGridConfig;
   private loadConfig;
   private addGridLegacyConfigName;
+  private hasCalculatedFields;
   private gridConfigChangeHandler;
   private modalConfigChangeHandler;
+  private hasToForceClientSideExporter;
   private dataExporterProviderStore;
   private addElementID;
   private loadGridCustomFormatters;

package/dist/types/components/snk-personalized-filter/snk-personalized-filter.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Componente responsável pela criação, edição e gerenciamento de filtros personalizados.
+ *
+ * Permite alternar entre os modos assistente e avançado, salvar, cancelar e manipular filtros.
+ *
+ * @component
+ * @example
+ * <snk-personalized-filter
+ *    entityUri="sua/entidade"
+ *    filterId="idFiltro"
+ *    configName="nomeConfig"
+ *    resourceID="resourceId"
+ *    isDefaultFilter={false}
+ *    messagesBuilder={messagesBuilderInstance}
+ *    onEzSave={handler}
+ *    onEzCancel={handler}
+ * />
+ */
 import { EventEmitter } from '../../stencil-public-runtime';
 import { IFilterLink, IFilterField, FilterFieldsDataSource } from "../snk-filter-field-search/interfaces";
 import { SnkMessageBuilder } from '../../lib/message/SnkMessageBuilder';
@@ -16,32 +34,62 @@ export declare class SnkPersonalizedFilter {
   private _filterAssistent;
   /**
    * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+   * @property
    */
   messagesBuilder: SnkMessageBuilder;
   /**
-   * 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;
   /**
-   * 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;
   /**
-   * 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;
   /**
-   * 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;
+  /**
+   * Evento emitido ao cancelar a personalização do filtro.
+   * @event
+   */
   ezCancel: EventEmitter<void>;
+  /**
+   * Evento emitido ao salvar as alterações do filtro personalizado.
+   * @event
+   */
   ezSave: EventEmitter<string>;
+  /**
+   * Evento emitido após salvar as alterações do filtro personalizado.
+   * @event
+   */
   ezAfterSave: EventEmitter<void>;
+  /**
+   * Cria um novo filtro personalizado caso não exista nenhum.
+   * @method
+   * @returns {Promise<void>}
+   */
   createPersonalizedFilter(): Promise<void>;
+  /**
+   * Carrega o filtro personalizado com base no identificador informado.
+   * @watch filterId
+   * @param newValue Novo valor do filtroId.
+   * @param oldValue Valor anterior do filtroId.
+   */
   loadFilter(newValue: string, oldValue: string): void;
   _dataSourceFetcher: FilterFieldsDataSource;
   componentWillLoad(): void;

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

@@ -28,30 +28,68 @@ export declare class SnkPesquisa {
   private _valideDataSource;
   /**
    * Função responsável em carregar os itens do componente snk-pesquisa.
+   * Deve retornar uma Promise com os dados encontrados.
+   *
+   * @type {(text: string) => Promise<any>}
+   * @param text Texto utilizado como argumento de pesquisa.
+   * @returns Promise com os dados da pesquisa.
+   * @example
+   * searchLoader={(text) => fetchItems(text)}
    */
   searchLoader: (text: string) => Promise<any>;
   /**
-   * Função responsável por carregar a árvore hierárquica do componente
+   * Função responsável por carregar a árvore hierárquica do componente.
+   * Opcional. Caso não seja fornecida, o modo árvore não estará disponível.
+   *
+   * @type {(text: string) => Promise<any>}
+   * @param text Texto utilizado como argumento de pesquisa para a árvore.
+   * @returns Promise com os dados da árvore.
    */
   treeLoader?: (text: string) => Promise<any>;
   /**
-   * Função disparada ao selecionar um item.
+   * Função disparada ao selecionar um item da pesquisa.
+   *
+   * @type {(option: IOption) => void}
+   * @param option Item selecionado.
+   * @returns void
+   * @example
+   * selectItem={(option) => handleSelect(option)}
    */
   selectItem: (option: IOption) => void;
   /**
-   * Nome da entidade onde a pesquisa é aplicada.
+   * Nome da entidade sobre a qual a pesquisa será realizada.
+   *
+   * @type {string}
+   * @example
+   * entityName="Produto"
    */
   entityName: string;
   /**
-   * Argumentos que serão usados ao chamar a função searchLoader.
+   * Argumento utilizado ao chamar a função searchLoader.
+   * Pode ser alterado externamente.
+   *
+   * @type {string}
+   * @mutable
+   * @example
+   * argument="Texto para pesquisa"
    */
   argument: string;
   /**
-   * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
+   * Define se a popup de pesquisa terá ou não modo hierárquico.
+   *
+   * @type {boolean}
+   * @default false
+   * @example
+   * isHierarchyEntity={true}
    */
   isHierarchyEntity: boolean;
   /**
-   * Define se permite seleção de items não analíticos
+   * Define se permite a seleção de itens não analíticos.
+   *
+   * @type {boolean}
+   * @default false
+   * @example
+   * allowsNonAnalytic={true}
    */
   allowsNonAnalytic: boolean;
   observeArgument(): void;

package/dist/types/components/snk-simple-bar/snk-simple-bar.d.ts

@@ -6,31 +6,31 @@ export declare class SnkSimpleBar {
   private _element;
   _application: SnkApplication;
   /**
-  * Define o título do header
-  */
+   * Define o título do header.
+   */
   label: string;
   /**
-  * Define os itens que serão apresentados pelo breadcrumb
-  */
+   * Define os itens que serão apresentados no breadcrumb.
+   */
   breadcrumbItens: Array<IBreadcrumbItem>;
   /**
-  * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
-  */
+   * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+   */
   messagesBuilder: SnkMessageBuilder;
   /**
-  * Emitido quando algum item do breadcrumb é clicado
-  */
+   * Emitido quando algum item do breadcrumb é clicado.
+   */
   clickBreadcrumbItem: EventEmitter<IBreadcrumbItem>;
   /**
-  * Emitido quando o botão voltar é acionado
-  */
+   * Emitido quando o botão "voltar" é acionado.
+   */
   exit: EventEmitter<void>;
   /**
-   * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
-   * através de um pequeno modulo na estrutura da aplicação:
-   * - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
-   * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-simple-bar.msg.ts"
-  */
+   * Permite customizar as mensagens dos blocos de construção
+   * através de um pequeno módulo na estrutura da aplicação:
+   * - Crie um arquivo no seguinte caminho: /messages/appmessages.msg.js.
+   * Para conhecer os detalhes do módulo, veja o arquivo neste projeto: "/src/lib/message/resources/snk-simple-bar.msg.ts"
+   */
   private getMessage;
   componentDidLoad(): void;
   render(): any;

package/dist/types/components/snk-simple-crud/snk-simple-crud.d.ts

@@ -46,152 +46,187 @@ export declare class SnkSimpleCrud {
   _fieldToGetFocus: string;
   _customContainerId: string;
   /**
-   * 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;
+  /**
+   * @description Estado atual dos dados.
+   */
   dataState: DataState;
+  /**
+   * @description Instância do DataUnit a ser utilizada pelo componente.
+   */
   dataUnit: DataUnit;
   /**
-   * 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 Define o modo de operação do CRUD (servidor ou em memória).
+   */
   mode: SIMPLE_CRUD_MODE;
+  /**
+   * @description Configuração da grade.
+   */
   gridConfig: IGridConfig;
+  /**
+   * @description Configuração do formulário.
+   */
   formConfig: IFormConfig;
   _formFields: IFieldConfig[];
   private _fieldsProps;
+  /**
+   * @description Habilita a inserção contínua de registros.
+   */
   enableContinuousInsert: 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;
+  /**
+   * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição.
+   */
   useCancelConfirm: boolean;
   /**
-   * Determina quantas linhas são retornadas por página.
+   * @description Determina quantas linhas são retornadas por página.
    */
   pageSize: number;
   /**
-   * Identificador de recursos como configurações e acesso.
+   * @description Identificador de recursos como configurações e acesso.
    */
   resourceID: string;
   /**
-   * Ativa inserção de registros no modo grade.
+   * @description Ativa a inserção de registros no modo grade.
    */
   enableGridInsert?: boolean;
   /**
-   * 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';
   /**
-   * Emitido quando há qualquer mudança de estado no DataUnit.
+   * @description Emitido quando há qualquer mudança de estado no DataUnit.
    */
   dataStateChange: EventEmitter<DataState>;
   /**
-   * Emitido quando o DataUnit está pronto.
+   * @description Emitido quando o DataUnit está pronto.
    */
   dataUnitReady: EventEmitter<DataUnit>;
   /**
-   * 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.
    */
   actionClick: EventEmitter<string>;
   /**
-   * 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.
    */
   formItemsReady: EventEmitter<Array<HTMLElement>>;
   /**
-   * Emitido quando salva a configuração no configurator do CRUD.
+   * @description Emitido quando a configuração no configurador do CRUD é salva.
    */
   configuratorSave: EventEmitter<any>;
   /**
-   * 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.
    */
   configuratorCancel: EventEmitter<any>;
   /**
- * 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;
   /**
-   * 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;
   /**
-   * 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;
   /**
-   * 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>;
   /**
-   * 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;
   /**
-   * 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;
   /**
-   * Chave da configuração legado da grade.
+   * @description Chave da configuração legada da grade.
    */
   gridLegacyConfigName: string;
   /**
-   * Chave da configuração legado do formulário.
+   * @description Chave da configuração legada do formulário.
    */
   formLegacyConfigName: 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 a grid será focada ao ser carregada.
+   * @description Define se a grade será focada ao ser carregada.
    */
   autoFocus?: boolean;
   /**
-  * 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;
   /**
-   * Habilita a edição de múltiplos registros simultâneos.
+   * @description Habilita a edição de múltiplos registros simultâneos.
    */
   multipleEditionEnabled: boolean;
   /**
-   * Define se o LayoutFormConfig será exibido no configurador.
+   * @description Define se o LayoutFormConfig será exibido no configurador.
    */
   layoutFormConfig: boolean;
   /**
-   * 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 {string} fieldName - O nome do campo.
+   * @param {ICustomEditor} customEditor - A instância do editor customizado.
+   * @returns {Promise<void>}
    */
   addCustomEditor(fieldName: string, customEditor: ICustomEditor): Promise<void>;
   /**
-   * Registra um render customizado para colunas da grid.
+   * @description Registra um renderizador customizado para colunas da grade.
+   * @param {string} fieldName - O nome do campo.
+   * @param {ICustomRender} customRender - A instância do renderizador customizado.
+   * @returns {Promise<void>}
    */
   addGridCustomRender(fieldName: string, customRender: ICustomRender): Promise<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;
   /**
-  * 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;
   handleResourceIDChanged(newValue: string, oldValue: string): Promise<void>;
   /**
-   * Registra um formatador de valores para uma coluna da grid.
+   * @description Registra um formatador de valores para uma coluna da grade.
+   * @param {string} columnName - O nome da coluna.
+   * @param {ICustomFormatter} customFormatter - A instância do formatador customizado.
+   * @returns {Promise<void>}
    */
   addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter): Promise<void>;
   /**
-   * Remove o formatador de valores de uma coluna da grid.
+   * @description Remove o formatador de valores de uma coluna da grade.
+   * @param {string} columnName - O nome da coluna.
+   * @returns {Promise<void>}
    */
   removeCustomValueFormatter(columnName: string): Promise<void>;
   /**
-   * Altera/adiciona uma propriedade nos metadados do campo.
+   * @description Altera/adiciona uma propriedade nos metadados do campo.
+   * @param {string} fieldName - O nome do campo.
+   * @param {string} propName - O nome da propriedade.
+   * @param {any} value - O valor da propriedade.
+   * @returns {Promise<void>}
    */
   setFieldProp(fieldName: string, propName: string, value: any): Promise<void>;
   private loadTaskbarProcessor;
@@ -202,7 +237,9 @@ export declare class SnkSimpleCrud {
   private get application();
   resolveInMemoryBtns(taskbarButtons: Array<string>): Array<string>;
   /**
-   * 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_MODE} view - A visão para a qual navegar.
+   * @returns {Promise<void>}
    */
   goToView(view: VIEW_MODE): Promise<void>;
   actionClickListener(evt: CustomEvent): void;
@@ -236,17 +273,37 @@ export declare class SnkSimpleCrud {
   private setFieldsProps;
   getTaskBarId(): string;
   initInMemoryDataUnit(): void;
+  /**
+   * @description Define os metadados do DataUnit.
+   * @param {UnitMetadata} metadata - Os metadados a serem definidos.
+   * @returns {Promise<void>}
+   */
   setMetadata(metadata: UnitMetadata): Promise<void>;
+  /**
+   * @description Define os registros do DataUnit.
+   * @param {Array<Record>} records - Os registros a serem definidos.
+   * @returns {Promise<void>}
+   */
   setRecords(records: Array<Record>): Promise<void>;
+  /**
+   * @description Obtém os registros do DataUnit.
+   * @returns {Promise<Array<Record>>} Uma promessa que resolve com a lista de registros.
+   */
   getRecords(): Promise<Array<Record>>;
   /**
-   * Usado para abrir o configurator do CRUD
+   * @description Usado para abrir o configurador do CRUD.
+   * @returns {Promise<void>}
    */
   openConfigurator(): Promise<void>;
   /**
-   * Usado para fechar o configurator do CRUD
+   * @description Usado para fechar o configurador do CRUD.
+   * @returns {Promise<void>}
    */
   closeConfigurator(): Promise<void>;
+  /**
+   * @description Atualiza a configuração do formulário.
+   * @returns {Promise<void>}
+   */
   updateConfig(): Promise<void>;
   processMetadata(): void;
   private addGridCustomValueFormattters;