@sankhyalabs/sankhyablocks 9.2.0-ms.9 → 9.2.0-rc.2

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

@@ -1,6 +1,6 @@
 import { EventEmitter } from '../../../stencil-public-runtime';
-import { SnkFilterItemConfig } from './snk-filter-item';
 import { CustomElementFilterProps } from '../types/custom-element-filter';
+import { SnkFilterItemConfig } from './snk-filter-item';
 export declare class SnkFilterDetail {
   _element: HTMLElement;
   _editor: HTMLElement;
@@ -20,14 +20,19 @@ export declare class SnkFilterDetail {
    * Controla a visibilidade do botão de fixar elemento
    */
   showHardFixed: boolean;
+  /**
+   * Define se o filtro pode ser removido.
+   */
+  removalBlocked: boolean;
   /**
    * Emitido quando há uma alteração nos filtros.
    */
   filterChange: EventEmitter<SnkFilterItemConfig>;
   /**
-   * Exibe o componente snk-filter-detail.
+   * Define o foco no campo do editor.
    */
-  show(): Promise<void>;
+  setFocusField(): Promise<void>;
+  clearValue(): Promise<void>;
   observeConfig(newValue: SnkFilterItemConfig): void;
   componentDidLoad(): void;
   changeConfig(newConfig: SnkFilterItemConfig): void;

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

@@ -1,14 +1,16 @@
-import { MaskFormatter } from '@sankhyalabs/core';
+import { KeyboardManager, MaskFormatter } from '@sankhyalabs/core';
 import { EventEmitter } from '../../../stencil-public-runtime';
-import FilterItemType from './filter-item-type.enum';
 import FilterType from '../types/filter-type.enum';
+import FilterItemType from './filter-item-type.enum';
 export declare class SnkFilterItem {
   _filterItemElement: HTMLElement;
   _chipElement: HTMLEzChipElement;
   _rightIconElement: HTMLElement;
   _leftIconElement: HTMLElement;
   _popover: HTMLEzPopoverCoreElement;
+  _filterDetail: HTMLSnkFilterDetailElement;
   _idSnkFilterDetail: string;
+  _keyboardManager: KeyboardManager | undefined;
   detailIsVisible: boolean;
   /**
    * Define as configurações do componente snk-filter-item.
@@ -53,12 +55,26 @@ export declare class SnkFilterItem {
   canClearFilter(): any;
   getRightIconName(): "close" | "chevron-up" | "chevron-down";
   getLeftIconName(): "calendar" | "tune";
-  hasActiveElements(value: any): boolean;
-  hasActiveValue(config: any): boolean;
+  hasActiveElements(value: {
+    elements?: Array<ItemMultiList>;
+  } | Array<ItemMultiList>): boolean;
+  hasActiveValue(config: SnkFilterItemConfig): boolean;
   getEnabledChip(): boolean;
   private handleVisibilityPopover;
+  private getCustomMessage;
+  private hasValue;
+  private getTooltipMessage;
+  private getTypeChip;
+  private initKeyboardManager;
+  connectedCallback(): void;
+  disconnectedCallback(): void;
   render(): any;
 }
+interface ItemMultiList {
+  id: string;
+  label: string;
+  check: boolean;
+}
 export interface SnkFilterItemConfig {
   id: string;
   label: string;
@@ -71,8 +87,15 @@ export interface SnkFilterItemConfig {
   value?: any;
   hardFixed?: boolean;
   fixed?: boolean;
+  enabled?: boolean;
   removalBlocked?: boolean;
   groupedItems: Array<SnkFilterItemConfig>;
   originOrder?: number;
   mask?: typeof MaskFormatter.DEFAULT_MASKS;
+  required?: boolean;
+  hasError?: boolean;
+  defaultMessage?: string;
+  requiredMessage?: string;
+  disabledMessage?: string;
 }
+export {};

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

@@ -1,12 +1,14 @@
-import { SnkFilterItemConfig } from '../filter-item/snk-filter-item';
 import { IPersonalizedFilter } from '../../snk-personalized-filter/interfaces/IPersonalizedFilter';
+import { SnkFilterItemConfig } from '../filter-item/snk-filter-item';
 export declare class SnkFilterModal {
   private _modalTitle;
   private _cancelButtonLabel;
   private _okButtonLabel;
-  private _originalFilterConfig;
   private _defaultFilter;
   private _application;
+  private filters;
+  _element: HTMLElement;
+  filtersWithError: string[];
   /**
    * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
    */
@@ -18,7 +20,11 @@ export declare class SnkFilterModal {
   /**
    * Filtros a serem apresentados
    */
-  filters: Array<SnkFilterItemConfig>;
+  filterConfig: Array<SnkFilterItemConfig>;
+  /**
+   * Define se o modal está aberto ou não.
+   */
+  opened: boolean;
   /**
    * Ação executada ao aplicar os filtros
    */
@@ -52,6 +58,13 @@ export declare class SnkFilterModal {
   * e no modal lateral de filtros (container de filtros personalizados).
   */
   disablePersonalizedFilter: boolean;
+  /**
+   * @description Intercepta a configuração dos filtros antes de serem aplicadas.
+   * @param {Array<SnkFilterItemConfig>} config - Lista de configurações de filtros.
+   * @returns {Array<SnkFilterItemConfig>} Retorna a lista de configurações de filtros.
+   */
+  filterCustomConfigInterceptor?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
+  filterConfigChangeHandler(newValue: Array<SnkFilterItemConfig>): void;
   /**
    * Emitido quando um filtro personalizado é deletado.
    */
@@ -70,6 +83,7 @@ export declare class SnkFilterModal {
   private handleClearFilterList;
   private handleClearSigleFilter;
   private uncheckFilterValues;
+  private validateFilters;
   private renderFilterItem;
   private isDefaultFilterNumberVariation;
   private mountFiltersLines;

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

@@ -1,8 +1,8 @@
 import { EventEmitter } from '../../../../stencil-public-runtime';
+import { IPersonalizedFilter } from '../../../snk-personalized-filter/interfaces/IPersonalizedFilter';
+import { SnkFilterPersonalized } from '../../filter-item/editors/snk-personalized-filter-editor/snk-personalized-filter-editor';
 import FilterItemType from '../../filter-item/filter-item-type.enum';
 import { SnkFilterItemConfig } from '../../filter-item/snk-filter-item';
-import { SnkFilterPersonalized } from '../../filter-item/editors/snk-personalized-filter-editor/snk-personalized-filter-editor';
-import { IPersonalizedFilter } from '../../../snk-personalized-filter/interfaces/IPersonalizedFilter';
 import { CustomElementFilterProps } from '../../types/custom-element-filter';
 export declare class SnkFilterModalItem {
   private _idContentEditor;
@@ -20,7 +20,6 @@ export declare class SnkFilterModalItem {
   filterChange: EventEmitter<SnkFilterItemConfig>;
   editPersonalizedFilter: EventEmitter<string>;
   addPersonalizedFilter: EventEmitter<void>;
-  observeFilterItem(newValue: SnkFilterItemConfig): void;
   getContentEditorConfig(): CustomElementFilterProps;
   buildSnkFilterPersonalizedProps(): CustomElementFilterProps<SnkFilterPersonalized>;
   isVisible(newValue: any): boolean;

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

@@ -3,11 +3,10 @@ import { Filter, FilterProvider } from '@sankhyalabs/core/dist/dataunit/metadata
 import { EventEmitter } from '../../stencil-public-runtime';
 import { SnkMessageBuilder } from '../../lib/message/SnkMessageBuilder';
 import { SnkApplication } from '../snk-application/snk-application';
+import { IPersonalizedFilter } from '../snk-personalized-filter/interfaces/IPersonalizedFilter';
 import FilterItemType from './filter-item/filter-item-type.enum';
 import { SnkFilterItemConfig } from './filter-item/snk-filter-item';
-import { IPersonalizedFilter } from '../snk-personalized-filter/interfaces/IPersonalizedFilter';
 export declare class SnkFilterBar implements FilterProvider {
-  private _filterModalFactory;
   private _elPersonalizedFilter;
   _element: HTMLElement;
   _application: SnkApplication;
@@ -81,6 +80,17 @@ export declare class SnkFilterBar implements FilterProvider {
    * @description Função chamada depois de aplicar os filtros.
    */
   afterApplyConfig?: () => void;
+  /**
+   * @description Configuração customizada dos filtros.
+   * @param {Array<SnkFilterItemConfig>} config - Lista de configurações de filtros.
+   */
+  filterCustomConfig?: Array<SnkFilterItemConfig>;
+  /**
+   * @description Intercepta a configuração dos filtros antes de serem aplicadas.
+   * @param {Array<SnkFilterItemConfig>} config - Lista de configurações de filtros.
+   * @returns {Array<SnkFilterItemConfig>} Retorna a lista de configurações de filtros.
+   */
+  filterCustomConfigInterceptor?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
   /**
    * @description Evento emitido quando a configuração dos filtros é atualizada.
    * @param {SnkFilterItemConfig[]} configs - Lista de configurações de filtros atualizadas.
@@ -91,6 +101,7 @@ export declare class SnkFilterBar implements FilterProvider {
   scrollerLocked: boolean;
   showPersonalizedFilter: boolean;
   personalizedFilterId: string;
+  isFilterModalOpen: boolean;
   observeFilterConfig(newValue: Array<SnkFilterItemConfig>, oldValue: Array<SnkFilterItemConfig>): void;
   private handleFilterConfigsChanged;
   /**
@@ -139,6 +150,7 @@ export declare class SnkFilterBar implements FilterProvider {
    * 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;
@@ -166,6 +178,8 @@ export declare class SnkFilterBar implements FilterProvider {
   addPersonalizedFilter(isDefault?: boolean): void;
   editPersonalizedFilter(id: string, isDefault?: boolean): void;
   deletePersonalizedFilter(filter: IPersonalizedFilter, filterItemType: FilterItemType, configName: string, isDefault?: boolean): void;
+  closeFilterModal(): void;
+  applyFiltersFromModal(filters: SnkFilterItemConfig[]): void;
   handleHidePersonalizedFilter(reloadFilterBar: boolean): void;
   hidePersonalizedFilter(): void;
   componentWillLoad(): Promise<void>;

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

@@ -1,5 +1,5 @@
-import { SnkFilterItemConfig } from "../filter-item/snk-filter-item";
 import { IPersonalizedFilter } from "../../snk-personalized-filter/interfaces/IPersonalizedFilter";
+import { SnkFilterItemConfig } from "../filter-item/snk-filter-item";
 type OnCompleteCallback = (filter: SnkFilterItemConfig[]) => void;
 type GetMessageFn = (key: string, params?: any) => string;
 type AddPersonalizedFilterFn = (isDefault?: boolean) => void;
@@ -14,6 +14,7 @@ export type SnkFilterModalFactoryParams = {
   onAddPersonalizedFilter: AddPersonalizedFilterFn;
   onEditPersonalizedFilter: EditPersonalizedFilterFn;
   onDeletePersonalizedFilter: deletePersonalizedFilterFn;
+  filterCustomConfigInterceptor?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
 };
 declare class SnkFilterModalFactory {
   private _closeModal;
@@ -25,7 +26,8 @@ declare class SnkFilterModalFactory {
   private _addPersonalizedFilterFn;
   private _editPersonalizedFilterFn;
   private _onDeletePersonalizedFilter;
-  constructor({ filterConfig, configName, onComplete, getMessage, disablePersonalizedFilter, onAddPersonalizedFilter, onEditPersonalizedFilter, onDeletePersonalizedFilter }: SnkFilterModalFactoryParams);
+  private _filterCustomConfigInterceptor?;
+  constructor({ filterConfig, configName, onComplete, getMessage, disablePersonalizedFilter, onAddPersonalizedFilter, onEditPersonalizedFilter, onDeletePersonalizedFilter, filterCustomConfigInterceptor }: SnkFilterModalFactoryParams);
   private applyFilters;
   private buildFilterModal;
   showModal(): Promise<void>;

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

@@ -0,0 +1,11 @@
+import { SnkFilterItemConfig } from "../filter-item/snk-filter-item";
+export declare function hasActiveElements(value: {
+  elements?: Array<ItemMultiList>;
+} | Array<ItemMultiList>): boolean;
+export declare function getInvalidFilters(filters: SnkFilterItemConfig[]): SnkFilterItemConfig[];
+export declare function validateFilters(filters: SnkFilterItemConfig[]): boolean;
+export interface ItemMultiList {
+  id: string;
+  label: string;
+  check: boolean;
+}

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

@@ -1,18 +1,19 @@
-import { EventEmitter } from '../../stencil-public-runtime';
 import { DataUnit, KeyboardManager } from '@sankhyalabs/core';
 import { IGridConfig, IStatusResolver, StatusResolverFunction } from '@sankhyalabs/ezui/dist/types/components/ez-grid/controller/EzGridController';
-import { DataState, SnkDataUnit } from '../snk-data-unit/snk-data-unit';
-import { Action, TaskbarManager } from '../snk-taskbar/snk-taskbar';
-import { SnkApplication } from '../snk-application/snk-application';
-import { PresentationMode } from '../../lib/@types';
-import TaskbarProcessor from '../snk-taskbar/processor/taskbar-processor';
-import { SnkMessageBuilder } from '../../lib/message/SnkMessageBuilder';
 import { ICustomFormatter, ISelectionToastConfig } from '@sankhyalabs/ezui/dist/types/components/ez-grid/interfaces';
-import { IRecordValidator } from '@sankhyalabs/ezui/dist/types/utils/form/interfaces';
 import { IMultiSelectionListDataSource } from '@sankhyalabs/ezui/dist/types/components/ez-multi-selection-list/interfaces/IMultiSelectionListDataSource';
 import { ICustomEditor, ICustomRender } from '@sankhyalabs/ezui/dist/types/utils';
+import { IRecordValidator } from '@sankhyalabs/ezui/dist/types/utils/form/interfaces';
+import { EventEmitter } from '../../stencil-public-runtime';
+import { PresentationMode } from '../../lib/@types';
 import RmPrecisionCustomValueFormatter from '../../lib/DefaultCustomFormatters/RmPrecisionCustomValueFormatter';
+import { SnkMessageBuilder } from '../../lib/message/SnkMessageBuilder';
+import { SnkApplication } from '../snk-application/snk-application';
 import { IExporterStrategyMode } from '../snk-data-exporter/interfaces/IRecordID';
+import { DataState, SnkDataUnit } from '../snk-data-unit/snk-data-unit';
+import { SnkFilterItemConfig } from '../snk-filter-bar/filter-item/snk-filter-item';
+import TaskbarProcessor from '../snk-taskbar/processor/taskbar-processor';
+import { Action, TaskbarManager } from '../snk-taskbar/snk-taskbar';
 export declare class SnkGrid {
   _grid: HTMLEzGridElement;
   _snkDataUnit: HTMLSnkDataUnitElement;
@@ -48,6 +49,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 +83,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 +105,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 +132,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 +157,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.
@@ -192,6 +194,17 @@ export declare class SnkGrid {
    * Define se a grade deve ser exibida em modo compacto.
    */
   compact: boolean;
+  /**
+   * @description Configuração customizada dos filtros.
+   * @param {Array<SnkFilterItemConfig>} config - Lista de configurações de filtros.
+   */
+  filterCustomConfig?: Array<SnkFilterItemConfig>;
+  /**
+   * @description Intercepta a configuração dos filtros antes de serem aplicadas.
+   * @param {Array<SnkFilterItemConfig>} config - Lista de configurações de filtros.
+   * @returns {Array<SnkFilterItemConfig>} Retorna a lista de configurações de filtros.
+   */
+  filterCustomConfigInterceptor?: (config: Array<SnkFilterItemConfig>) => Array<SnkFilterItemConfig>;
   /**
    * 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.
@@ -199,13 +212,13 @@ 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.
+   * Emitido quando o componente estiver completamente carregado.
    */
   componentReady: EventEmitter<void>;
   /**
@@ -304,12 +317,15 @@ export declare class SnkGrid {
   private normalizeGridConfig;
   private loadConfig;
   private addGridLegacyConfigName;
+  private hasCalculatedFields;
   private gridConfigChangeHandler;
   private modalConfigChangeHandler;
+  private hasToForceClientSideExporter;
   private dataExporterProviderStore;
   private addElementID;
   private loadGridCustomFormatters;
   private interceptMetadataLoaded;
+  private interceptLoadData;
   private dataUnitInterceptor;
   private finishLoading;
   private setCustomRenders;

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;