@sankhyalabs/sankhyablocks 9.2.0-dev.11 → 9.2.0-dev.13

package/dist/components/snk-personalized-filter2.js

@@ -45,8 +45,10 @@ const SnkPersonalizedFilter = /*@__PURE__*/ proxyCustomElement(class extends HTM
     this.resourceID = undefined;
     this.isDefaultFilter = false;
   }
-  /*
-   * Cria um novo filtro se não houver nenhum filtro existente
+  /**
+   * Cria um novo filtro personalizado caso não exista nenhum.
+   * @method
+   * @returns {Promise<void>}
    */
   async createPersonalizedFilter() {
     const newPersonalizedFilter = {
@@ -82,6 +84,12 @@ const SnkPersonalizedFilter = /*@__PURE__*/ proxyCustomElement(class extends HTM
     this._originalFilterAssistent = ObjectUtils.copy(newPersonalizedFilter);
     this._filterAssistent = ObjectUtils.copy(newPersonalizedFilter);
   }
+  /**
+   * 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, oldValue) {
     if (newValue == null || oldValue == newValue || this.resourceID == undefined) {
       return;

package/dist/components/snk-simple-bar2.js

@@ -14,11 +14,11 @@ const SnkSimpleBar = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     this.messagesBuilder = undefined;
   }
   /**
-   * 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"
+   */
   getMessage(key, params) {
     var _a;
     if (this.messagesBuilder)

package/dist/components/snk-simple-crud2.js

@@ -86,7 +86,10 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     this.outlineMode = false;
   }
   /**
-   * Registra um editor customizado para campos da grade e formulário.
+   * @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>}
    */
   async addCustomEditor(fieldName, customEditor) {
     if (this._grid && this._form) {
@@ -99,7 +102,10 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     this._customEditors = newCustomEditors;
   }
   /**
-   * Registra um render customizado para colunas da grid.
+   * @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>}
    */
   async addGridCustomRender(fieldName, customRender) {
     if (this._grid) {
@@ -121,19 +127,28 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     await this.loadGridConfig(true);
   }
   /**
-   * Registra um formatador de valores para uma coluna da grid.
+   * @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>}
    */
   async addCustomValueFormatter(columnName, customFormatter) {
     this._grid.addCustomValueFormatter(columnName, customFormatter);
   }
   /**
-   * Remove o formatador de valores de uma coluna da grid.
+   * @description Remove o formatador de valores de uma coluna da grade.
+   * @param {string} columnName - O nome da coluna.
+   * @returns {Promise<void>}
    */
   async removeCustomValueFormatter(columnName) {
     this._grid.removeCustomValueFormatter(columnName);
   }
   /**
-   * Altera/adiciona uma propriedade nos metadados do campo.
+   * @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>}
    */
   async setFieldProp(fieldName, propName, value) {
     const newCustomFieldProps = new Map(this._fieldsProps);
@@ -190,7 +205,9 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     return newTaskBarConfig;
   }
   /**
-   * Usado para alternar a visão entre GRID e FORM externamente.
+   * @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>}
    */
   async goToView(view) {
     this._currentViewMode = view;
@@ -464,6 +481,11 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     this.dataUnit = this._inMemoryLoader.dataUnit;
     this.dataUnitReady.emit(this.dataUnit);
   }
+  /**
+   * @description Define os metadados do DataUnit.
+   * @param {UnitMetadata} metadata - Os metadados a serem definidos.
+   * @returns {Promise<void>}
+   */
   setMetadata(metadata) {
     if (this._inMemoryLoader) {
       this._inMemoryLoader.metadata = metadata;
@@ -473,6 +495,11 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     }
     return Promise.resolve();
   }
+  /**
+   * @description Define os registros do DataUnit.
+   * @param {Array<Record>} records - Os registros a serem definidos.
+   * @returns {Promise<void>}
+   */
   setRecords(records) {
     if (this._inMemoryLoader) {
       this._inMemoryLoader.records = records;
@@ -482,23 +509,33 @@ const SnkSimpleCrud = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     }
     return Promise.resolve();
   }
+  /**
+   * @description Obtém os registros do DataUnit.
+   * @returns {Promise<Array<Record>>} Uma promessa que resolve com a lista de registros.
+   */
   getRecords() {
     return Promise.resolve(this.dataUnit.records);
   }
   /**
-   * Usado para abrir o configurator do CRUD
+   * @description Usado para abrir o configurador do CRUD.
+   * @returns {Promise<void>}
    */
   async openConfigurator() {
     var _a;
     (_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.open();
   }
   /**
-   * Usado para fechar o configurator do CRUD
+   * @description Usado para fechar o configurador do CRUD.
+   * @returns {Promise<void>}
    */
   async closeConfigurator() {
     var _a;
     (_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.close();
   }
+  /**
+   * @description Atualiza a configuração do formulário.
+   * @returns {Promise<void>}
+   */
   async updateConfig() {
     if (this._formConfigManager == undefined) {
       this._formConfigManager = new SnkFormConfigManager(this.configName, this.resolveResourceID());

package/dist/esm/snk-personalized-filter.entry.js

@@ -43,8 +43,10 @@ const SnkPersonalizedFilter = class {
     this.resourceID = undefined;
     this.isDefaultFilter = false;
   }
-  /*
-   * Cria um novo filtro se não houver nenhum filtro existente
+  /**
+   * Cria um novo filtro personalizado caso não exista nenhum.
+   * @method
+   * @returns {Promise<void>}
    */
   async createPersonalizedFilter() {
     const newPersonalizedFilter = {
@@ -80,6 +82,12 @@ const SnkPersonalizedFilter = class {
     this._originalFilterAssistent = ObjectUtils.copy(newPersonalizedFilter);
     this._filterAssistent = ObjectUtils.copy(newPersonalizedFilter);
   }
+  /**
+   * 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, oldValue) {
     if (newValue == null || oldValue == newValue || this.resourceID == undefined) {
       return;

package/dist/esm/snk-simple-bar.entry.js

@@ -13,11 +13,11 @@ const SnkSimpleBar = class {
     this.messagesBuilder = undefined;
   }
   /**
-   * 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"
+   */
   getMessage(key, params) {
     var _a;
     if (this.messagesBuilder)

package/dist/esm/snk-simple-crud.entry.js

@@ -82,7 +82,10 @@ const SnkSimpleCrud = class {
     this.outlineMode = false;
   }
   /**
-   * Registra um editor customizado para campos da grade e formulário.
+   * @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>}
    */
   async addCustomEditor(fieldName, customEditor) {
     if (this._grid && this._form) {
@@ -95,7 +98,10 @@ const SnkSimpleCrud = class {
     this._customEditors = newCustomEditors;
   }
   /**
-   * Registra um render customizado para colunas da grid.
+   * @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>}
    */
   async addGridCustomRender(fieldName, customRender) {
     if (this._grid) {
@@ -117,19 +123,28 @@ const SnkSimpleCrud = class {
     await this.loadGridConfig(true);
   }
   /**
-   * Registra um formatador de valores para uma coluna da grid.
+   * @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>}
    */
   async addCustomValueFormatter(columnName, customFormatter) {
     this._grid.addCustomValueFormatter(columnName, customFormatter);
   }
   /**
-   * Remove o formatador de valores de uma coluna da grid.
+   * @description Remove o formatador de valores de uma coluna da grade.
+   * @param {string} columnName - O nome da coluna.
+   * @returns {Promise<void>}
    */
   async removeCustomValueFormatter(columnName) {
     this._grid.removeCustomValueFormatter(columnName);
   }
   /**
-   * Altera/adiciona uma propriedade nos metadados do campo.
+   * @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>}
    */
   async setFieldProp(fieldName, propName, value) {
     const newCustomFieldProps = new Map(this._fieldsProps);
@@ -186,7 +201,9 @@ const SnkSimpleCrud = class {
     return newTaskBarConfig;
   }
   /**
-   * Usado para alternar a visão entre GRID e FORM externamente.
+   * @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>}
    */
   async goToView(view) {
     this._currentViewMode = view;
@@ -460,6 +477,11 @@ const SnkSimpleCrud = class {
     this.dataUnit = this._inMemoryLoader.dataUnit;
     this.dataUnitReady.emit(this.dataUnit);
   }
+  /**
+   * @description Define os metadados do DataUnit.
+   * @param {UnitMetadata} metadata - Os metadados a serem definidos.
+   * @returns {Promise<void>}
+   */
   setMetadata(metadata) {
     if (this._inMemoryLoader) {
       this._inMemoryLoader.metadata = metadata;
@@ -469,6 +491,11 @@ const SnkSimpleCrud = class {
     }
     return Promise.resolve();
   }
+  /**
+   * @description Define os registros do DataUnit.
+   * @param {Array<Record>} records - Os registros a serem definidos.
+   * @returns {Promise<void>}
+   */
   setRecords(records) {
     if (this._inMemoryLoader) {
       this._inMemoryLoader.records = records;
@@ -478,23 +505,33 @@ const SnkSimpleCrud = class {
     }
     return Promise.resolve();
   }
+  /**
+   * @description Obtém os registros do DataUnit.
+   * @returns {Promise<Array<Record>>} Uma promessa que resolve com a lista de registros.
+   */
   getRecords() {
     return Promise.resolve(this.dataUnit.records);
   }
   /**
-   * Usado para abrir o configurator do CRUD
+   * @description Usado para abrir o configurador do CRUD.
+   * @returns {Promise<void>}
    */
   async openConfigurator() {
     var _a;
     (_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.open();
   }
   /**
-   * Usado para fechar o configurator do CRUD
+   * @description Usado para fechar o configurador do CRUD.
+   * @returns {Promise<void>}
    */
   async closeConfigurator() {
     var _a;
     (_a = this._snkConfigurator) === null || _a === void 0 ? void 0 : _a.close();
   }
+  /**
+   * @description Atualiza a configuração do formulário.
+   * @returns {Promise<void>}
+   */
   async updateConfig() {
     if (this._formConfigManager == undefined) {
       this._formConfigManager = new SnkFormConfigManager(this.configName, this.resolveResourceID());

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