@sankhyalabs/sankhyablocks 2.4.0 → 2.4.1

package/dist/cjs/snk-application.cjs.entry.js

@@ -709,7 +709,7 @@ const SnkApplication = class {
     }
   }
   /**
-   * Caso o usuário logado seja o SUP.
+   * Obtém `true` caso o usuário logado seja o SUP.
    */
   async isUserSup() {
     return new Promise((resolve, reject) => {
@@ -721,7 +721,7 @@ const SnkApplication = class {
     });
   }
   /**
-   * Se o usuário logado tem permissão pra determinada ação.
+   * Obtém `true` caso o usuário logado tem permissão pra determinada ação.
    */
   async hasAccess(access) {
     return new Promise((resolve, reject) => {
@@ -733,7 +733,7 @@ const SnkApplication = class {
     });
   }
   /**
-   * Retorna todos os acessos do usuário logado.
+   * Obtém todos os acessos do usuário logado.
    */
   async getAllAccess() {
     return new Promise((resolve, reject) => {
@@ -750,37 +750,37 @@ const SnkApplication = class {
     });
   }
   /**
-   * Retorna o valor de um parâmetro do tipo string.
+   * Obtém o valor de um parâmetro do tipo string.
    */
   async getStringParam(name) {
     return this.parameters.asString(name);
   }
   /**
-   * Retorna o valor de um parâmetro do tipo Inteiro.
+   * Obtém o valor de um parâmetro do tipo Inteiro.
    */
   async getIntParam(name) {
     return this.parameters.asInteger(name);
   }
   /**
-   * Retorna o valor de um parâmetro do tipo Decimal.
+   * Obtém o valor de um parâmetro do tipo Decimal.
    */
   async getFloatParam(name) {
     return this.parameters.asFloat(name);
   }
   /**
-   * Retorna o valor de um parâmetro do tipo booleano.
+   * Obtém o valor de um parâmetro do tipo booleano.
    */
   async getBooleanParam(name) {
     return this.parameters.asBoolean(name);
   }
   /**
-   * Retorna o valor de um parâmetro do tipo data.
+   * Obtém o valor de um parâmetro do tipo data.
    */
   async getDateParam(name) {
     return this.parameters.asDate(name);
   }
   /**
-   * Mostra o conteúdo passado em um Popup
+   * Exibe o conteúdo passado em um Popup.
    */
   async showPopUp(content, size = "full", useHeader = true) {
     this.clearContent(this._popUp);
@@ -792,17 +792,23 @@ const SnkApplication = class {
       this._popUp.useHeader = false;
     }
   }
+  /**
+   * Exibe o conteúdo passado em um Modal.
+   */
   async showModal(content) {
     this.clearContent(this._rightModal);
     this._rightModal.appendChild(content);
     this._rightModal.opened = true;
   }
+  /**
+   * Fecha o Modal e limpa o conteúdo.
+   */
   async closeModal() {
     this.clearContent(this._rightModal);
     this._rightModal.opened = false;
   }
   /**
-   * Fecha o popup, liberando o conteúdo.
+   * Fecha o Popup e limpa o conteúdo.
    */
   async closePopUp() {
     this.clearContent(this._popUp);
@@ -837,7 +843,7 @@ const SnkApplication = class {
     });
   }
   /**
-   * Retorna a configuração de um recurso por service broker
+   * Obtém a configuração de um recurso por service broker
    */
   async getConfig(key) {
     let payload = {
@@ -878,13 +884,13 @@ const SnkApplication = class {
     });
   }
   /**
-   * Acessa informações de contexto "empurrados" na abertura da tela
+   * Acessa informações de contexto "empurrados" na abertura da tela.
    */
   async getAttributeFromHTMLWrapper(attribName) {
     return Promise.resolve(window[attribName]);
   }
   /**
-   * Abre determinada tela, repassando pkObject
+   * Abre determinada tela, repassando pkObject.
    */
   async openApp(resourceId, pkObject) {
     Workspace.openAppActivity(resourceId, pkObject);
@@ -902,7 +908,7 @@ const SnkApplication = class {
   }
   /**
    * Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
-   * passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado
+   * passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
    */
   async createDataunit(entityName, dataUnitName) {
     return new Promise((resolve, reject) => {
@@ -943,31 +949,31 @@ const SnkApplication = class {
     });
   }
   /**
-   * Retorna o resourceID da tela em questão.
+   * Obtém o resourceID da tela em questão.
    */
   async getResourceID() {
     return Promise.resolve(this.resourceID);
   }
   /**
-   * Retorna o resourceID da tela em questão.
+   * Obtém o UserId da tela em questão.
    */
   async getUserID() {
     return Promise.resolve(window["UID"]);
   }
   /**
-   * Mostra o diálogo de alerta de acordo com os parâmetros passados.
+   * Exibe o diálogo de alerta de acordo com os parâmetros passados.
    */
   async alert(title, message, icon, options) {
     return utils.ApplicationUtils.alert(title, message, icon, options);
   }
   /**
-   * Mostra o diálogo de erro de acordo com os parâmetros passados.
+   * Exibe o diálogo de erro de acordo com os parâmetros passados.
    */
   async error(title, message, icon, options) {
     return utils.ApplicationUtils.error(title, message, icon, options);
   }
   /**
-   * Mostra o diálogo de sucesso de acordo com os parâmetros passados.
+   * Exibe o diálogo de sucesso de acordo com os parâmetros passados.
    */
   async success(title, message, icon, options) {
     return utils.ApplicationUtils.success(title, message, icon, options);
@@ -985,43 +991,43 @@ const SnkApplication = class {
     return utils.ApplicationUtils.confirm(title, message, icon, dialogType, options);
   }
   /**
-   * Mostra uma informação efêmera (de segundo plano).
+   * Exibe uma informação efêmera (de segundo plano).
    */
   async info(message, options) {
     return utils.ApplicationUtils.info(message, options);
   }
   /**
-   * Busca a configuração de formulário.
+   * Obtém a configuração de formulário.
    */
   async loadFormConfig(name) {
     return this.formConfigFetcher.loadFormConfig(name, this.resourceID);
   }
   /**
-   * Busca a configuração de grade.
+   * Obtém a configuração de grade.
    */
   async loadGridConfig(name) {
     return this.gridConfigFetcher.getConfig(name, this.resourceID);
   }
   /**
-   * Busca lista de configurações de formulário do usuário.
+   * Obtém a lista de configurações de formulário do usuário.
    */
   async fetchUserAvailableConfigs(name) {
     return this.formConfigFetcher.fetchUserAvailableConfigs(name, this.resourceID);
   }
   /**
-   * Busca a configuração de formulário do usuário.
+   * Obtém a configuração de formulário do usuário.
    */
   async fetchLegacyConfig(name) {
     return this.formConfigFetcher.fetchLegacyConfig(name, this.resourceID);
   }
   /**
-   * Busca a configuração padrão de formulário.
+   * Obtém a configuração padrão de formulário.
    */
   async fetchDefaultConfig(name) {
     return this.formConfigFetcher.fetchDefaultConfig(name, this.resourceID);
   }
   /**
-   * Busca os totalizadores da grade.
+   * Obtém os totalizadores da grade.
    */
   async loadTotals(name, resourceID, filters) {
     return this.totalsFetcher.fetchTotals(name, resourceID, filters);
@@ -1065,13 +1071,13 @@ const SnkApplication = class {
     return this.formConfigFetcher.saveConfig(config, name, this.resourceID);
   }
   /**
-   * Busca um objeto com um conjunto de valores padrão.
+   * Obtém um objeto com um conjunto de valores padrão.
    */
   async getDefaultValues() {
     return this.defaultValuesFetcher.getDefaultValues(this.resourceID);
   }
   /**
-   * Retorna um valor padrão específico de uma expressão.
+   * Obtém um valor padrão específico de uma expressão.
    */
   async getDefaultValue(expression) {
     return this._defaultValues && this._defaultValues[expression];
@@ -1133,6 +1139,10 @@ const SnkApplication = class {
     }
     return this._defaultValuesFetcher;
   }
+  /**
+   * Obtém as opções em componentes de pesquisa
+   * Ex.: snk-config-options
+   */
   async executeSearch(searchArgument, fieldName, dataUnit) {
     const descriptor = dataUnit === null || dataUnit === void 0 ? void 0 : dataUnit.getField(fieldName);
     if (!descriptor) ;
@@ -1170,6 +1180,10 @@ const SnkApplication = class {
       return this.executePreparedSearch(mode, argument, { entity: ENTITYNAME, entityDescription: DESCRIPTIONENTITY, criteria, searchOptions });
     }
   }
+  /**
+   * Obtém as opções em componentes de pesquisa
+   * Ex.: snk-config-options
+   */
   async executePreparedSearch(mode, argument, options) {
     const { entity, entityDescription, criteria, searchOptions } = options;
     if (mode === "ADVANCED") {
@@ -1191,6 +1205,9 @@ const SnkApplication = class {
       return this.pesquisaFetcher.loadSearchOptions(entity, argument, criteria, searchOptions);
     }
   }
+  /**
+   * Obtém `true` caso a tela esteja em modo de debug.
+   */
   async isDebugMode() {
     return new Promise(accept => {
       accept(window['isDebugMode']);

package/dist/cjs/snk-config-options.cjs.entry.js

@@ -15,7 +15,7 @@ const SnkConfigOptions = class {
     index.registerInstance(this, hostRef);
     this.configOptionsChanged = index.createEvent(this, "configOptionsChanged", 7);
     /**
-     * Armazena as propriedades do campo
+     * Armazena as propriedades do campo.
      */
     this.fieldConfig = {};
   }

package/dist/cjs/snk-configurator_3.cjs.entry.js

@@ -25,10 +25,16 @@ const SnkConfigurator = class {
      */
     this.viewMode = GRID_MODE.name;
   }
+  /**
+   * Exibe a janela de configuração.
+   */
   async open() {
     this._opened = true;
     this.configSelected.emit(this.getViewModeValue());
   }
+  /**
+   * Fecha a janela de configuração.
+   */
   async close() {
     this.closeConfig();
   }
@@ -104,7 +110,7 @@ const SnkFieldConfig = class {
      */
     this.isConfigActive = false;
     /**
-     * Define se o componente está em modo de inserção
+     * Define se o componente está em modo de inserção.
      */
     this.modeInsertion = true;
   }
@@ -121,7 +127,7 @@ const SnkFieldConfig = class {
    * 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-form.msg.ts"
+   * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-form.msg.ts".
    */
   getMessage(key) {
     return this._application.messagesBuilder.getMessage(key, {});
@@ -166,7 +172,7 @@ const SnkGrid = class {
     this._popUpGridConfig = false;
   }
   /**
-   * Método responsável em abrir o modal de configurações da grade.
+   * Exibe a janela de configurações da grade.
    */
   async showConfig() {
     if (this._grid == undefined) {
@@ -175,7 +181,7 @@ const SnkGrid = class {
     this.openGridConfig();
   }
   /**
-   * Método responsável em fechar o modal de configurações da grade.
+   * Fecha a janela de configurações da grade.
    */
   async hideConfig() {
     if (this._grid == undefined) {
@@ -184,7 +190,7 @@ const SnkGrid = class {
     this.closeGridConfig();
   }
   /**
-   * Método responsável por setar as configurações da grade.
+   * Atribui o valor da configuração da grade.
    */
   async setConfig(config) {
     this.setGridConfig(config);

package/dist/cjs/snk-crud.cjs.entry.js

@@ -17,7 +17,7 @@ const SnkCrud = class {
     this.actionClick = index.createEvent(this, "actionClick", 7);
     this._viewMode = GRID_MODE.name;
     /**
-     * Determina se pode haver mais de uma linha selecionada na grade
+     * Determina se pode haver mais de uma linha selecionada na grade.
      */
     this.multipleSelection = true;
   }

package/dist/cjs/snk-data-unit.cjs.entry.js

@@ -18,7 +18,7 @@ const SnkDataUnit = class {
     this.cancelEdition = index.createEvent(this, "cancelEdition", 7);
     this._onDataUnitResolve = [];
     /**
-     * Determina quantas linhas são retornadas por página
+     * Determina quantas linhas são retornadas por página.
      */
     this.pageSize = 150;
     this._dataUnitObserver = (action) => {
@@ -91,9 +91,7 @@ const SnkDataUnit = class {
     this.dataUnitReady.emit(this.dataUnit);
   }
   /**
-   * Pode-se obter o dataUnit através desse método. Outra forma, é ouvir o evento de
-   *
-   * @returns dataUnit
+   * Obtém o dataUnit.
    */
   async getDataUnit() {
     return new Promise((resolve) => {

package/dist/cjs/snk-filter-bar_7.cjs.entry.js

@@ -437,6 +437,9 @@ const SnkFilterBar = class {
       this.registryFilterProvider();
     }
   }
+  /**
+  * Emitido quando acontece a alteração do estado do filtro.
+  */
   filterChangeListener(evt) {
     this.updateFilter(evt.detail);
   }
@@ -506,6 +509,9 @@ const SnkFilterItem = class {
   observeDetailIsVisible(value) {
     this.visibleChanged.emit(value);
   }
+  /**
+   * Exibe os detalhes de um item da lista.
+   */
   async showUp(open = false) {
     return new Promise(resolve => {
       this._filterItemElement.scrollIntoView({ behavior: "auto", block: "nearest", inline: "nearest" });
@@ -530,6 +536,9 @@ const SnkFilterItem = class {
     const rect = this._filterItemElement.getBoundingClientRect();
     return `calc(${rect.left}px + ${padding})`;
   }
+  /**
+   * Oculta os detalhes de um item da lista.
+   */
   async hideDetail() {
     if (this.detailIsVisible) {
       if (this._floatingID != undefined) {
@@ -640,6 +649,9 @@ const SnkFilterItem = class {
       }
     }
   }
+  /**
+   * Emitido quando o estado do filtro é alterado.
+   */
   filterChangeListener() {
     this.hideDetail();
   }
@@ -696,6 +708,9 @@ const SnkFilterList = class {
     this._filterArgument = "";
     this._filterInput.setFocus();
   }
+  /**
+   * Oculta os detalhes do componente snk-filter-list.
+   */
   async hideDetail() {
     if (this._floatingID != undefined) {
       core.FloatingManager.close(this._floatingID);
@@ -871,6 +886,9 @@ const EzGridConfig = class {
     this.selectedIndex = 0;
   }
   /* Creation Methods */
+  /**
+   * Salva as configurações da grade.
+   */
   async saveConfig(config) {
     var _a;
     if (config == undefined || ((_a = this._application) === null || _a === void 0 ? void 0 : _a.configName) == undefined) {
@@ -1330,6 +1348,9 @@ const SelectBox = class {
   constructor(hostRef) {
     index.registerInstance(this, hostRef);
     this.ezChange = index.createEvent(this, "ezChange", 7);
+    /**
+     * Determina a opção selecionada.
+     */
     this.selectedOption = constants.ORDER_VALUES.none;
   }
   render() {

package/dist/cjs/snk-filter-binary-select.cjs.entry.js

@@ -13,6 +13,9 @@ const SnkFilterBinarySelect = class {
   isSelected(option) {
     return this.value == undefined || this.value === option;
   }
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-binary-select
+   */
   ezChangeListener(evt) {
     if (!evt.detail) {
       this.assertCheckedOption(evt.target);
@@ -41,6 +44,9 @@ const SnkFilterBinarySelect = class {
       this.value = undefined;
     }
   }
+  /**
+   * Exibe o componente snk-filter-binary-select
+   */
   async show() {
     this._checkOne.setFocus();
   }

package/dist/cjs/snk-filter-detail.cjs.entry.js

@@ -12,6 +12,9 @@ const SnkFilterDetail = class {
     index.registerInstance(this, hostRef);
     this.filterChange = index.createEvent(this, "filterChange", 7);
   }
+  /**
+   * Exibe o componente snk-filter-detail.
+   */
   async show() {
     this._editor["show"]();
   }

package/dist/cjs/snk-filter-multi-select.cjs.entry.js

@@ -10,9 +10,15 @@ const SnkFilterMultiSelect = class {
   constructor(hostRef) {
     index.registerInstance(this, hostRef);
   }
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-multi-select
+   */
   ezChangeListener(evt) {
     this.value = evt.detail.value;
   }
+  /**
+   * Exibe o componente snk-filter-multi-select
+   */
   async show() {
     this._comboElement.setFocus();
   }

package/dist/cjs/snk-filter-number.cjs.entry.js

@@ -10,9 +10,15 @@ const SnkFilterPeriod = class {
   constructor(hostRef) {
     index.registerInstance(this, hostRef);
   }
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-number
+   */
   ezChangeListener(evt) {
     this.value = evt.detail;
   }
+  /**
+   * Exibe o componente snk-filter-number
+   */
   async show() {
     this._numberElement.setFocus();
   }

package/dist/cjs/snk-filter-period.cjs.entry.js

@@ -10,6 +10,9 @@ const SnkFilterPeriod = class {
   constructor(hostRef) {
     index.registerInstance(this, hostRef);
   }
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-period
+   */
   ezChangeListener() {
     const start = this._startDate.value;
     const end = this._endDate.value;
@@ -32,6 +35,9 @@ const SnkFilterPeriod = class {
     }
     return null;
   }
+  /**
+   * Exibe o componente snk-filter-period
+   */
   async show() {
     this._startDate.setFocus();
   }

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

@@ -77,6 +77,9 @@ const SnkFilterPersonalized = class {
       }
     });
   }
+  /**
+   * Exibe o componente snk-filter-personalized
+   */
   async show() {
     const elem = document.querySelector("#param_0");
     if (elem) {

package/dist/cjs/snk-filter-search.cjs.entry.js

@@ -10,6 +10,9 @@ const SnkFilterSearch = class {
   constructor(hostRef) {
     index.registerInstance(this, hostRef);
   }
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-search
+   */
   ezChangeListener(_evt) {
     this.value = this._searchInput.value;
   }
@@ -29,6 +32,9 @@ const SnkFilterSearch = class {
       });
     });
   }
+  /**
+   * Exibe o componente snk-filter-search
+   */
   async show() {
     this._searchInput.setFocus();
   }

package/dist/cjs/snk-filter-text.cjs.entry.js

@@ -9,6 +9,9 @@ const SnkFilterText = class {
   constructor(hostRef) {
     index.registerInstance(this, hostRef);
   }
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-text.
+   */
   ezChangeListener(evt) {
     this.value = evt.detail;
   }

package/dist/cjs/snk-form.cjs.entry.js

@@ -25,13 +25,13 @@ const SnkForm = class {
     this._showFormConfig = false;
   }
   /**
-   * Método responsável em abrir o modal de configurações do form.
+   * Exibe a janela de configurações do formulário.
    */
   async showConfig() {
     this._showFormConfig = true;
   }
   /**
-   * Método responsável em fechar o modal de configurações do form.
+   * Fecha a janela de configurações do formulário.
    */
   async hideConfig() {
     this._showFormConfig = false;