@sankhyalabs/sankhyablocks 9.1.7-rc.2 → 9.1.8-rc.2

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

@@ -23,60 +23,69 @@ export declare class SnkFilterBar implements FilterProvider {
   private hasValidValue;
   _filtersComparator: (a: SnkFilterItemConfig, b: SnkFilterItemConfig) => number;
   /**
-   * Define se o componente deve usar o LockManager para controle de carregamento
+   * @description Define se o componente deve usar o LockManager para controle de carregamento.
    */
   enableLockManagerLoadingComp?: boolean;
   /**
-   * Loader customizado para carregar as configurações
+   * @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.
    */
   customFilterBarConfig?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
   /**
-   * Recebe o DataUnit do ambiente. Se não for informado, procura pela referência
+   * @description 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;
   /**
-   * Título que será apresentado na barra de filtros
+   * @description Título que será apresentado na barra de filtros.
    */
   title: string;
   /**
-   * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade
+   * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade
    * serve para separar a configuração de cada uma.
    */
   configName: string;
   /**
-   * Identificador de recursos como configurações e acesso.
+   * @description Identificador de recursos como configurações e acesso.
    */
   resourceID: string;
   /**
-   * Modo de apresentação da filterbar.
+   * @description Modo de apresentação da barra de filtros.
    */
   mode: "regular" | "button" | "hidden";
   /**
-   * Lista todos os filtros disponíveis ao usuário.
+   * @description Lista todos os filtros disponíveis ao usuário.
    */
   filterConfig: Array<SnkFilterItemConfig>;
   /**
-   * 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;
   /**
-   * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros)
+   * @description 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;
   /**
-   * Chave da configuração legado da barra de filtros.
+   * @description Chave da configuração legada da barra de filtros.
    */
   filterBarLegacyConfigName: string;
   /**
-   * 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;
   /**
-   * Função chamada depois de aplicar os filtros.
+   * @description 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;
@@ -85,31 +94,37 @@ export declare class SnkFilterBar implements FilterProvider {
   observeFilterConfig(newValue: Array<SnkFilterItemConfig>, oldValue: Array<SnkFilterItemConfig>): void;
   private handleFilterConfigsChanged;
   /**
-   * Faz o recarregamento da filterbar buscando o state no servidor.
+   * @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.
    */
   reload(): Promise<void>;
   /**
-   * Retorna um item de filtro pelo ID.
+   * @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.
    */
   getFilterItem(id: string): Promise<SnkFilterItemConfig | undefined>;
   /**
-  * 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
+  * @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.
   */
   updateFilterItem(newFilterItem: SnkFilterItemConfig): Promise<void>;
   /**
-  * 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
+  * @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.
   */
   addFilterItem(filterItem: SnkFilterItemConfig): Promise<void>;
   /**
-  * 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.
+  * @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.
   */
   removeFilterItem(filterID: string): Promise<SnkFilterItemConfig | undefined>;
   componentDidLoad(): void;
@@ -119,7 +134,7 @@ 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 modulo na estrutura da aplicação:
+   * através de um pequeno módulo 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"
    */
@@ -144,7 +159,8 @@ export declare class SnkFilterBar implements FilterProvider {
   */
   filterChangeListener(evt: CustomEvent): void;
   /**
-   * Abre o modal de filtros
+   * @description Abre o modal de filtros.
+   * @async
   */
   showFilterModal(): Promise<void>;
   addPersonalizedFilter(isDefault?: boolean): void;

package/dist/types/components.d.ts

@@ -1186,83 +1186,98 @@ export namespace Components {
     }
     interface SnkFilterBar {
         /**
-          * 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
+          * @description Adiciona um item de filtro.
+          * @async 
+          * @param filterItem - Item a ser adicionado, caso o item já exista com o ID, ele não será adicionado novamente.
+          * @return Retorna uma Promise que resolve quando o item for adicionado.
          */
         "addFilterItem": (filterItem: SnkFilterItemConfig) => Promise<void>;
         /**
-          * Função chamada depois de aplicar os filtros.
+          * @description Função chamada depois de aplicar os filtros.
          */
         "afterApplyConfig"?: () => 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;
         /**
-          * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
+          * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
          */
         "configName": string;
         /**
-          * Loader customizado para carregar as configurações
+          * @description Loader customizado para carregar as configurações.
+          * @param configName - Nome da configuração.
+          * @param resourceId - ID do recurso.
+          * @param options - Opções adicionais.
+          * @returns Retorna a configuração dos filtros.
          */
         "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
         /**
-          * 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.
+          * @description 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;
         /**
-          * 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).
+          * @description 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;
         /**
-          * Define se o componente deve usar o LockManager para controle de carregamento
+          * @description Define se o componente deve usar o LockManager para controle de carregamento.
          */
         "enableLockManagerLoadingComp"?: boolean;
         /**
-          * Chave da configuração legado da barra de filtros.
+          * @description Chave da configuração legada da barra de filtros.
          */
         "filterBarLegacyConfigName": string;
         /**
-          * Lista todos os filtros disponíveis ao usuário.
+          * @description Lista todos os filtros disponíveis ao usuário.
          */
         "filterConfig": Array<SnkFilterItemConfig>;
         /**
-          * Retorna um item de filtro pelo ID.
+          * @description Retorna um item de filtro pelo ID.
+          * @async 
+          * @param id - ID do item de filtro.
+          * @returns O item de filtro correspondente ou undefined se não for encontrado.
          */
         "getFilterItem": (id: string) => Promise<SnkFilterItemConfig | undefined>;
         /**
-          * 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;
         /**
-          * Modo de apresentação da filterbar.
+          * @description Modo de apresentação da barra de filtros.
          */
         "mode": "regular" | "button" | "hidden";
         /**
-          * Faz o recarregamento da filterbar buscando o state no servidor.
+          * @description Faz o recarregamento da barra de filtros buscando o state no servidor.
+          * @async 
+          * @return Retorna uma Promise que resolve quando o recarregamento for concluído.
          */
         "reload": () => Promise<void>;
         /**
-          * Remove um item de filtro.
-          * @param filterID - ID do a ser adicionado
-          * @returns - Retorna o item de filtro removido, ou undefined caso não encontrado.
+          * @description Remove um item de filtro.
+          * @async 
+          * @param filterID - ID do item a ser removido.
+          * @returns Retorna o item de filtro removido, ou undefined caso não seja encontrado.
          */
         "removeFilterItem": (filterID: string) => Promise<SnkFilterItemConfig | undefined>;
         /**
-          * Identificador de recursos como configurações e acesso.
+          * @description Identificador de recursos como configurações e acesso.
          */
         "resourceID": string;
         /**
-          * Abre o modal de filtros
+          * @description Abre o modal de filtros.
+          * @async
          */
         "showFilterModal": () => Promise<void>;
         /**
-          * Título que será apresentado na barra de filtros
+          * @description Título que será apresentado na barra de filtros.
          */
         "title": string;
         /**
-          * 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
+          * @description Atualiza um item do filtro.
+          * @async 
+          * @param newFilterItem - Item com as informações atualizadas, caso o item não seja encontrado no array, ele não será modificado.
+          * @return Retorna uma Promise que resolve quando a atualização for concluída.
          */
         "updateFilterItem": (newFilterItem: SnkFilterItemConfig) => Promise<void>;
     }
@@ -3813,56 +3828,65 @@ declare namespace LocalJSX {
     }
     interface SnkFilterBar {
         /**
-          * Função chamada depois de aplicar os filtros.
+          * @description Função chamada depois de aplicar os filtros.
          */
         "afterApplyConfig"?: () => 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;
         /**
-          * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
+          * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma.
          */
         "configName"?: string;
         /**
-          * Loader customizado para carregar as configurações
+          * @description Loader customizado para carregar as configurações.
+          * @param configName - Nome da configuração.
+          * @param resourceId - ID do recurso.
+          * @param options - Opções adicionais.
+          * @returns Retorna a configuração dos filtros.
          */
         "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise<Array<SnkFilterItemConfig>>;
         /**
-          * 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.
+          * @description 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;
         /**
-          * 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).
+          * @description 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;
         /**
-          * Define se o componente deve usar o LockManager para controle de carregamento
+          * @description Define se o componente deve usar o LockManager para controle de carregamento.
          */
         "enableLockManagerLoadingComp"?: boolean;
         /**
-          * Chave da configuração legado da barra de filtros.
+          * @description Chave da configuração legada da barra de filtros.
          */
         "filterBarLegacyConfigName"?: string;
         /**
-          * Lista todos os filtros disponíveis ao usuário.
+          * @description Lista todos os filtros disponíveis ao usuário.
          */
         "filterConfig"?: Array<SnkFilterItemConfig>;
         /**
-          * 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;
         /**
-          * Modo de apresentação da filterbar.
+          * @description Modo de apresentação da barra de filtros.
          */
         "mode"?: "regular" | "button" | "hidden";
+        /**
+          * @description Evento emitido quando a configuração dos filtros é atualizada.
+          * @param configs - Lista de configurações de filtros atualizadas.
+          * @event
+         */
         "onConfigUpdated"?: (event: SnkFilterBarCustomEvent<SnkFilterItemConfig[]>) => void;
         /**
-          * Identificador de recursos como configurações e acesso.
+          * @description Identificador de recursos como configurações e acesso.
          */
         "resourceID"?: string;
         /**
-          * Título que será apresentado na barra de filtros
+          * @description Título que será apresentado na barra de filtros.
          */
         "title"?: string;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sankhyalabs/sankhyablocks",
-  "version": "9.1.7-rc.2",
+  "version": "9.1.8-rc.2",
   "description": "Stencil Component Starter",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",