@sankhyalabs/sankhyablocks 9.2.0-dev.9 → 9.2.0-ms.1

package/dist/types/components/snk-data-unit/snk-data-unit.d.ts

@@ -21,73 +21,57 @@ export declare class SnkDataUnit implements DUActionInterceptor {
   fieldsToLink: Array<string>;
   /**
    * Controla o estado atual dos dados.
-   * @type {DataState}
   */
   dataState: DataState;
   /**
    * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
-   * @type {SnkMessageBuilder}
    */
   messagesBuilder: SnkMessageBuilder;
   /**
    * Usado para criar o dataUnit uma única vez.
    * Se omitido, será usado o próprio nome da entidade.
-   * @type {string}
    */
   dataUnitName: string;
   /**
    * Determina qual a entidade que representa os dados em questão.
-   * @type {string}
    */
   entityName: string;
   /**
    * Determina quantas linhas são retornadas por página.
-   * @type {number}
-   * @default 150
    */
   pageSize: number;
   /**
    * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade.
-   * @type {DataUnit}
    */
   dataUnit: DataUnit;
   /**
    * Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo.
    * Caso retorne "false" (ou a promessa se resolva como false), cancela a ação.
-   * @param {DataUnit} dataUnit - A instância do DataUnit.
-   * @returns {boolean | Promise<boolean>} `false` para cancelar a ação, `true` para continuar.
    */
   beforeSave: (dataUnit: DataUnit) => boolean | Promise<boolean>;
   /**
    * Executado após a ação de salvar.
-   * @param {DataUnit} dataUnit - A instância do DataUnit.
-   * @returns {void}
    */
   afterSave: (dataUnit: DataUnit) => void;
   /**
    * Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição.
-   * @type {boolean}
-   * @default true
+   *
   */
   useCancelConfirm: boolean;
   /**
    * Responsável por evitar a mensagem de sucesso ao salvar.
-   * @type {boolean}
    */
   ignoreSaveMessage: boolean;
   /**
    * Usado para obter configuração de metadados.
-   * @type {string}
    */
   configName: string;
   /**
    * Identificador de recursos como configurações e acesso.
-   * @type {string}
    */
   resourceID: string;
   /**
   * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade)
-  * @type {string}
   */
   domainMessagesBuilder: string;
   observePageSize(): void;
@@ -98,75 +82,48 @@ export declare class SnkDataUnit implements DUActionInterceptor {
   observeMessagesBuilder(newValue: SnkMessageBuilder): void;
   /**
    * Emitido quando há qualquer mudança de estado no DataUnit.
-   * @event dataStateChange
-   * @type {CustomEvent<DataState>}
-   * @bubbles false
    */
   dataStateChange: EventEmitter<DataState>;
   /**
    * Emitido quando o DataUnit está pronto.
-   * @event dataUnitReady
-   * @type {CustomEvent<DataUnit>}
-   * @bubbles false
    */
   dataUnitReady: EventEmitter<DataUnit>;
   /**
-   * Emitido quando o messagesBuilder é atualizado.
-   * @event messagesBuilderUpdated
-   * @type {CustomEvent<SnkMessageBuilder>}
-   * @bubbles false
+   * Emitido quando o DataUnit está pronto.
    */
   messagesBuilderUpdated: EventEmitter<SnkMessageBuilder>;
   /**
    * Emitido quando há campos no DataUnit que devem ser ocultados.
-   * @event dataUnitFieldsHidded
-   * @type {CustomEvent<void>}
    */
   dataUnitFieldsHidded: EventEmitter<void>;
   /**
    * Emitido quando um registro é adicionado ou copiado.
-   * @event insertionMode
-   * @type {CustomEvent<void>}
-   * @bubbles false
    */
   insertionMode: EventEmitter<void>;
   /**
    * Emitido quando se cancela uma inserção ou cópia.
-   * @event cancelEdition
-   * @type {CustomEvent<void>}
-   * @bubbles false
    */
   cancelEdition: EventEmitter<void>;
   onMasterFormConfigChange({ detail }: CustomEvent): void;
   /**
    * Obtém o dataUnit.
-   * @returns {Promise<DataUnit>} Uma promessa que resolve com a instância do DataUnit.
-   * @async
    */
   getDataUnit(): Promise<DataUnit>;
   /**
    * Método que retorna a lista de IDs dos registros selecionados.
-   * @returns {Promise<Array<IRecordID>>} Retorna uma promessa que resolve com a lista de IDs dos registros selecionados.
-   * @async
+   * @returns Retorna a lista de IDs dos registros selecionados.
    */
   getSelectedRecordsIDsInfo(): Promise<Array<IRecordID>>;
   /**
    * Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider).
-   * @returns {Promise<string[]>} Uma promessa que resolve com um array de nomes de campos.
-   * @async
    */
   getFieldsWithRmp(): Promise<string[]>;
   /**
    * Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision).
-   * @returns {Promise<string[]>} Uma promessa que resolve com um array de nomes de campos.
-   * @async
    */
   getFieldsWithRmPrecision(): Promise<string[]>;
   /**
    * Busca os metadados da linha selecionada.
-   * @param {Record | string} [record] - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado.
-   * @returns {Promise<RowMetadata>} Uma promessa que resolve com os metadados da linha.
-   * @async
    */
   getRowMetadata(record?: Record | string): Promise<RowMetadata>;
   private doGetRowMetadata;

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,7 +119,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 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"
    */
@@ -159,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;