@sankhyalabs/sankhyablocks 9.2.0-ms.13 → 9.2.0-ms.3

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

@@ -23,69 +23,60 @@ export declare class SnkFilterBar implements FilterProvider {
   private hasValidValue;
   _filtersComparator: (a: SnkFilterItemConfig, b: SnkFilterItemConfig) => number;
   /**
-   * @description Define se o componente deve usar o LockManager para controle de carregamento.
+   * Define se o componente deve usar o LockManager para controle de carregamento
    */
   enableLockManagerLoadingComp?: boolean;
   /**
-   * @description Loader customizado para carregar as configurações.
-   * @param {string} configName - Nome da configuração.
-   * @param {string} resourceId - ID do recurso.
-   * @param {any} options - Opções adicionais.
-   * @returns {Promise<Array<SnkFilterItemConfig>>} Retorna a configuração dos filtros.
+   * Loader customizado para carregar as configurações
    */
   customFilterBarConfig?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
   /**
-   * @description Recebe o DataUnit do ambiente. Se não for informado, procura pela referência
+   * Recebe o DataUnit do ambiente. Se não for informado, procura pela referência
    * do SnkDataUnit. Necessário para se registrar como provedor de filtros.
    */
   dataUnit: DataUnit;
   /**
-   * @description Título que será apresentado na barra de filtros.
+   * Título que será apresentado na barra de filtros
    */
   title: string;
   /**
-   * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade
+   * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade
    * serve para separar a configuração de cada uma.
    */
   configName: string;
   /**
-   * @description Identificador de recursos como configurações e acesso.
+   * Identificador de recursos como configurações e acesso.
    */
   resourceID: string;
   /**
-   * @description Modo de apresentação da barra de filtros.
+   * Modo de apresentação da filterbar.
    */
   mode: "regular" | "button" | "hidden";
   /**
-   * @description Lista todos os filtros disponíveis ao usuário.
+   * Lista todos os filtros disponíveis ao usuário.
    */
   filterConfig: Array<SnkFilterItemConfig>;
   /**
-   * @description 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;
   /**
-   * @description Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros)
+   * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros)
    * e no modal lateral de filtros (container de filtros personalizados).
   */
   disablePersonalizedFilter: boolean;
   /**
-   * @description Chave da configuração legada da barra de filtros.
+   * Chave da configuração legado da barra de filtros.
    */
   filterBarLegacyConfigName: string;
   /**
-   * @description Define se a carga dos dados será feita assim que o componente for carregado.
+   * Define se a carga dos dados será feita assim que o componente for carregado.
    */
   autoLoad?: boolean;
   /**
-   * @description Função chamada depois de aplicar os filtros.
+   * Função chamada depois de aplicar os filtros.
    */
   afterApplyConfig?: () => void;
-  /**
-   * @description Evento emitido quando a configuração dos filtros é atualizada.
-   * @param {SnkFilterItemConfig[]} configs - Lista de configurações de filtros atualizadas.
-   * @event
-   */
   configUpdated: EventEmitter<SnkFilterItemConfig[]>;
   allowDefault: boolean;
   scrollerLocked: boolean;
@@ -94,37 +85,31 @@ export declare class SnkFilterBar implements FilterProvider {
   observeFilterConfig(newValue: Array<SnkFilterItemConfig>, oldValue: Array<SnkFilterItemConfig>): void;
   private handleFilterConfigsChanged;
   /**
-   * @description Faz o recarregamento da barra de filtros buscando o state no servidor.
-   * @async
-   * @return {Promise<void>} Retorna uma Promise que resolve quando o recarregamento for concluído.
+   * Faz o recarregamento da filterbar buscando o state no servidor.
    */
   reload(): Promise<void>;
   /**
-   * @description Retorna um item de filtro pelo ID.
-   * @async
-   * @param {string} id - ID do item de filtro.
-   * @returns {Promise<SnkFilterItemConfig | undefined>} O item de filtro correspondente ou undefined se não for encontrado.
+   * Retorna um item de filtro pelo ID.
    */
   getFilterItem(id: string): Promise<SnkFilterItemConfig | undefined>;
   /**
-  * @description Atualiza um item do filtro.
-  * @async
-  * @param {SnkFilterItemConfig} newFilterItem - Item com as informações atualizadas, caso o item não seja encontrado no array, ele não será modificado.
-  * @return {Promise<void>} Retorna uma Promise que resolve quando a atualização for concluída.
+  * Atualiza um item do filtro.
+  *
+  * @param filterItem - Item com as informações atualizadas, caso o item não seja encontrado no array ele mão será modificado
   */
   updateFilterItem(newFilterItem: SnkFilterItemConfig): Promise<void>;
   /**
-  * @description Adiciona um item de filtro.
-  * @async
-  * @param {SnkFilterItemConfig} filterItem - Item a ser adicionado, caso o item já exista com o ID, ele não será adicionado novamente.
-  * @return {Promise<void>} Retorna uma Promise que resolve quando o item for adicionado.
+  * Adiciona um item de filtro.
+  *
+  * @param filterItem - Item a ser adicionado, caso o item já exista com o ID ele não será adicionado novamente
   */
   addFilterItem(filterItem: SnkFilterItemConfig): Promise<void>;
   /**
-  * @description Remove um item de filtro.
-  * @async
-  * @param {string} filterID - ID do item a ser removido.
-  * @returns {Promise<SnkFilterItemConfig|undefined>} Retorna o item de filtro removido, ou undefined caso não seja encontrado.
+  * Remove um item de filtro.
+  *
+  * @param filterID - ID do a ser adicionado
+  *
+  * @returns {Promise<SnkFilterItemConfig|undefined>} - Retorna o item de filtro removido, ou undefined caso não encontrado.
   */
   removeFilterItem(filterID: string): Promise<SnkFilterItemConfig | undefined>;
   componentDidLoad(): void;
@@ -134,12 +119,11 @@ export declare class SnkFilterBar implements FilterProvider {
   private doLoadData;
   /**
    * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
-   * através de um pequeno módulo na estrutura da aplicaçã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-filter-bar.msg.ts"
    */
   private getMessage;
-  getFilters(): Promise<Filter[]>;
   getFilter(_dataUnit: string): Array<Filter>;
   private isActiveFilter;
   private registryFilterProvider;
@@ -160,8 +144,7 @@ export declare class SnkFilterBar implements FilterProvider {
   */
   filterChangeListener(evt: CustomEvent): void;
   /**
-   * @description Abre o modal de filtros.
-   * @async
+   * Abre o modal de filtros
   */
   showFilterModal(): Promise<void>;
   addPersonalizedFilter(isDefault?: boolean): void;

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

@@ -27,7 +27,7 @@ export declare class SnkForm {
    */
   messagesBuilder: SnkMessageBuilder;
   /**
-   * Chave da configuração legada do formulário.
+   * Chave da configuração legado do formulário.
    */
   formLegacyConfigName: string;
   /**
@@ -35,58 +35,33 @@ export declare class SnkForm {
    */
   resourceID: string;
   /**
-   * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
+   * Emitido quando o botão de voltar é acionado.
    */
   exit: EventEmitter<void>;
   /**
-   * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente.
+   * Emitido sempre que houver click de botão ou ação.
    */
   actionClick: EventEmitter<string>;
   /**
    * Responsável por notificar quando ocorrer a renderização de itens do formulário.
-   * OBS: Emitido no subcomponente snk-form-view
    */
   formItemsReady: EventEmitter<Array<HTMLElement>>;
   /**
    * Exibe a janela de configurações do formulário.
-   * @async
-   * @returns {Promise<void>}
    */
   showConfig(): Promise<void>;
   /**
    * Fecha a janela de configurações do formulário.
-   * @async
-   * @returns {Promise<void>}
    */
   hideConfig(): Promise<void>;
   /**
-   * Registra um editor customizado para campos do formulário.
-   * @async
-   * @param {string} fieldName - Nome do campo.
-   * @param {ICustomEditor} customEditor - Editor customizado.
-   * @returns {Promise<void>}
+   * Registra um editor customizado para campos da grade e formulário.
    */
   addCustomEditor(fieldName: string, customEditor: ICustomEditor): Promise<void>;
   /**
    * Altera/adiciona uma propriedade nos metadados do campo.
-   * @async
-   * @param {string} fieldName - Nome do campo.
-   * @param {string} propName - Nome da propriedade.
-   * @param {any} value - Valor da propriedade.
-   * @returns {Promise<void>}
    */
   setFieldProp(fieldName: string, propName: string, value: any): Promise<void>;
-  /**
-   * Valida o formulário.
-   * @async
-   * @returns {Promise<void>}
-   * @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>;
   private closeConfig;
   private dataunitReady;
   private setCustomEditors;

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

@@ -48,7 +48,6 @@ 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.
    */
@@ -185,10 +184,6 @@ export declare class SnkGrid {
    * Informa se a coluna de checkbox deve ser suprimida.
    */
   suppressCheckboxColumn: boolean;
-  /**
-   * Informa se a grade deve suprimir o filtro de coluna.
-   */
-  suppressFilterColumn?: boolean;
   /**
    * Define se a grade deve ser exibida em modo compacto.
    */

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

@@ -1,21 +1,3 @@
-/**
- * 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';
@@ -34,62 +16,32 @@ export declare class SnkPersonalizedFilter {
   private _filterAssistent;
   /**
    * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
-   * @property
    */
   messagesBuilder: SnkMessageBuilder;
   /**
-   * URI da entidade utilizada para buscar os campos disponíveis para filtro.
-   * @property
+   * Responsável por receber a URI da entidade.
    */
   entityUri: string;
   /**
-   * Identificador do filtro a ser carregado.
-   * @property
+   * Id do filtro que será carregado.
    */
   filterId: string;
   /**
-   * Nome da configuração, utilizado para distinguir múltiplas instâncias do componente.
-   * @property
+   * Nome da configuração. Serve para distinguir várias instâncias do componente.
    */
   configName: string;
   /**
-   * Identificador do recurso utilizado para salvar e recuperar filtros.
-   * @property
+   * Nome da configuração. Serve para distinguir várias instâncias do componente.
    */
   resourceID: string;
   /**
-   * Indica se o filtro é o filtro padrão do sistema.
-   * @property
-   * @default false
+   * Define se o filtro em questão é um filtro padrão.
    */
   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,68 +28,30 @@ 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.
-   * 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.
+   * Função responsável por carregar a árvore hierárquica do componente
    */
   treeLoader?: (text: string) => Promise<any>;
   /**
-   * Função disparada ao selecionar um item da pesquisa.
-   *
-   * @type {(option: IOption) => void}
-   * @param option Item selecionado.
-   * @returns void
-   * @example
-   * selectItem={(option) => handleSelect(option)}
+   * Função disparada ao selecionar um item.
    */
   selectItem: (option: IOption) => void;
   /**
-   * Nome da entidade sobre a qual a pesquisa será realizada.
-   *
-   * @type {string}
-   * @example
-   * entityName="Produto"
+   * Nome da entidade onde a pesquisa é aplicada.
    */
   entityName: string;
   /**
-   * Argumento utilizado ao chamar a função searchLoader.
-   * Pode ser alterado externamente.
-   *
-   * @type {string}
-   * @mutable
-   * @example
-   * argument="Texto para pesquisa"
+   * Argumentos que serão usados ao chamar a função searchLoader.
    */
   argument: string;
   /**
-   * Define se a popup de pesquisa terá ou não modo hierárquico.
-   *
-   * @type {boolean}
-   * @default false
-   * @example
-   * isHierarchyEntity={true}
+   * Define se a popup de pesquisa possuirá ou não modo Hierarquico.
    */
   isHierarchyEntity: boolean;
   /**
-   * Define se permite a seleção de itens não analíticos.
-   *
-   * @type {boolean}
-   * @default false
-   * @example
-   * allowsNonAnalytic={true}
+   * Define se permite seleção de items não analíticos
    */
   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 no breadcrumb.
-   */
+  * Define os itens que serão apresentados pelo 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>;
   /**
-   * 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"
-   */
+   * 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"
+  */
   private getMessage;
   componentDidLoad(): void;
   render(): any;