@sankhyalabs/sankhyablocks 9.1.9-rc.2 → 9.1.10

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-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;

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

@@ -46,187 +46,152 @@ export declare class SnkSimpleCrud {
   _fieldToGetFocus: string;
   _customContainerId: string;
   /**
-   * @description 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;
   /**
-   * @description Ativa o gerenciamento de locks na grade pela Taskbar.
+   * 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;
   /**
-   * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD.
+   * 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;
   /**
-   * @description Determina se pode haver mais de uma linha selecionada na grade.
+   * 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;
   /**
-   * @description Determina quantas linhas são retornadas por página.
+   * Determina quantas linhas são retornadas por página.
    */
   pageSize: number;
   /**
-   * @description Identificador de recursos como configurações e acesso.
+   * Identificador de recursos como configurações e acesso.
    */
   resourceID: string;
   /**
-   * @description Ativa a inserção de registros no modo grade.
+   * Ativa inserção de registros no modo grade.
    */
   enableGridInsert?: boolean;
   /**
-   * @description Define o modo de exibição do contador de paginação.
+   * Define se a grid será focada ao ser carregada.
    */
   paginationCounterMode?: 'show' | 'hidden' | 'auto';
   /**
-   * @description Emitido quando há qualquer mudança de estado no DataUnit.
+   * Emitido quando há qualquer mudança de estado no DataUnit.
    */
   dataStateChange: EventEmitter<DataState>;
   /**
-   * @description Emitido quando o DataUnit está pronto.
+   * Emitido quando o DataUnit está pronto.
    */
   dataUnitReady: EventEmitter<DataUnit>;
   /**
-   * @description Emitido sempre que houver clique de botão ou ação na barra de tarefas.
+   * Emitido sempre que houver click de botão ou ação.
    */
   actionClick: EventEmitter<string>;
   /**
-   * @description 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.
    */
   formItemsReady: EventEmitter<Array<HTMLElement>>;
   /**
-   * @description Emitido quando a configuração no configurador do CRUD é salva.
+   * Emitido quando salva a configuração no configurator do CRUD.
    */
   configuratorSave: EventEmitter<any>;
   /**
-   * @description Emitido quando o salvamento da configuração no configurador do CRUD é cancelado.
+   * Emitido quando cancela o salvamento da configuração no configurator do CRUD.
    */
   configuratorCancel: EventEmitter<any>;
   /**
-  * @description 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. É possível determinar botões específicos
+ * ou mesmo gerenciar o estado dos botões.
+ */
   taskbarManager: TaskbarManager;
   /**
-   * @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 Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
+   * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade.
    */
   useEnterLikeTab: boolean;
   /**
-   * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
+   * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar.
    */
   actionsList: Array<Action>;
   /**
-   * @description Usado para salvar as configurações dos blocos de construção.
+   * Usado para salvar as configurações dos blocos de construção.
    */
   configName: string;
   /**
-   * @description Usado para exibir os botões de ação do snk-configurator.
+   * Usado para exibir os botões de ação do snk-configurator.
    */
   showConfiguratorButtons: boolean;
   /**
-   * @description Chave da configuração legada da grade.
+   * Chave da configuração legado da grade.
    */
   gridLegacyConfigName: string;
   /**
-   * @description Chave da configuração legada do formulário.
+   * Chave da configuração legado do formulário.
    */
   formLegacyConfigName: string;
   /**
-   * @description Ignora os campos "somente leitura" no modo de inserção.
+   * Ignora os campos "somente leitura" no modo de inserção.
    */
   ignoreReadOnlyFormFields: boolean;
   /**
-   * @description Define se a grade será focada ao ser carregada.
+   * Define se a grid será focada ao ser carregada.
    */
   autoFocus?: boolean;
   /**
-   * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade).
-   */
+  * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
+  */
   domainMessagesBuilder: string;
   /**
-   * @description Habilita a edição de múltiplos registros simultâneos.
+   * Habilita a edição de múltiplos registros simultâneos.
    */
   multipleEditionEnabled: boolean;
   /**
-   * @description Define se o LayoutFormConfig será exibido no configurador.
+   * Define se o LayoutFormConfig será exibido no configurador.
    */
   layoutFormConfig: boolean;
   /**
-   * @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>}
+   * Registra um editor customizado para campos da grade e formulário.
    */
   addCustomEditor(fieldName: string, customEditor: ICustomEditor): Promise<void>;
   /**
-   * @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>}
+   * Registra um render customizado para colunas da grid.
    */
   addGridCustomRender(fieldName: string, customRender: ICustomRender): Promise<void>;
   /**
-   * @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 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).
-   */
+  * 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)
+  */
   outlineMode?: boolean;
   handleResourceIDChanged(newValue: string, oldValue: string): void;
   /**
-   * @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>}
+   * Registra um formatador de valores para uma coluna da grid.
    */
   addCustomValueFormatter(columnName: string, customFormatter: ICustomFormatter): Promise<void>;
   /**
-   * @description Remove o formatador de valores de uma coluna da grade.
-   * @param {string} columnName - O nome da coluna.
-   * @returns {Promise<void>}
+   * Remove o formatador de valores de uma coluna da grid.
    */
   removeCustomValueFormatter(columnName: string): Promise<void>;
   /**
-   * @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>}
+   * Altera/adiciona uma propriedade nos metadados do campo.
    */
   setFieldProp(fieldName: string, propName: string, value: any): Promise<void>;
   private loadTaskbarProcessor;
@@ -237,9 +202,7 @@ export declare class SnkSimpleCrud {
   private get application();
   resolveInMemoryBtns(taskbarButtons: Array<string>): Array<string>;
   /**
-   * @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>}
+   * Usado para alternar a visão entre GRID e FORM externamente.
    */
   goToView(view: VIEW_MODE): Promise<void>;
   actionClickListener(evt: CustomEvent): void;
@@ -272,37 +235,17 @@ 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>>;
   /**
-   * @description Usado para abrir o configurador do CRUD.
-   * @returns {Promise<void>}
+   * Usado para abrir o configurator do CRUD
    */
   openConfigurator(): Promise<void>;
   /**
-   * @description Usado para fechar o configurador do CRUD.
-   * @returns {Promise<void>}
+   * Usado para fechar o configurator do CRUD
    */
   closeConfigurator(): Promise<void>;
-  /**
-   * @description Atualiza a configuração do formulário.
-   * @returns {Promise<void>}
-   */
   updateConfig(): Promise<void>;
   processMetadata(): void;
   private addGridCustomValueFormattters;