@sankhyalabs/sankhyablocks 2.4.0 → 2.4.2

package/dist/components/snk-application2.js

@@ -706,7 +706,7 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
     }
   }
   /**
-   * 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) => {
@@ -718,7 +718,7 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
     });
   }
   /**
-   * 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) => {
@@ -730,7 +730,7 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
     });
   }
   /**
-   * Retorna todos os acessos do usuário logado.
+   * Obtém todos os acessos do usuário logado.
    */
   async getAllAccess() {
     return new Promise((resolve, reject) => {
@@ -747,37 +747,37 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
     });
   }
   /**
-   * 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);
@@ -789,17 +789,23 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
       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);
@@ -834,7 +840,7 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
     });
   }
   /**
-   * 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 = {
@@ -875,13 +881,13 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
     });
   }
   /**
-   * 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);
@@ -899,7 +905,7 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
   }
   /**
    * 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) => {
@@ -940,31 +946,31 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
     });
   }
   /**
-   * 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 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 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 ApplicationUtils.success(title, message, icon, options);
@@ -982,43 +988,43 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
     return 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 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);
@@ -1062,13 +1068,13 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
     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];
@@ -1130,6 +1136,10 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
     }
     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) ;
@@ -1167,6 +1177,10 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
       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") {
@@ -1188,6 +1202,9 @@ const SnkApplication = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
       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/components/snk-config-options2.js

@@ -12,7 +12,7 @@ const SnkConfigOptions = /*@__PURE__*/ proxyCustomElement(class extends HTMLElem
     this.__registerHost();
     this.configOptionsChanged = createEvent(this, "configOptionsChanged", 7);
     /**
-     * Armazena as propriedades do campo
+     * Armazena as propriedades do campo.
      */
     this.fieldConfig = {};
   }

package/dist/components/snk-configurator2.js

@@ -19,10 +19,16 @@ const SnkConfigurator = /*@__PURE__*/ proxyCustomElement(class extends HTMLEleme
      */
     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();
   }

package/dist/components/snk-crud.js

@@ -28,7 +28,7 @@ const SnkCrud$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
     this.actionClick = 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/components/snk-data-unit.js

@@ -15,7 +15,7 @@ const SnkDataUnit$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     this.cancelEdition = 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) => {
@@ -88,9 +88,7 @@ const SnkDataUnit$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     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/components/snk-field-config2.js

@@ -14,7 +14,7 @@ const SnkFieldConfig = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
      */
     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;
   }
@@ -31,7 +31,7 @@ const SnkFieldConfig = /*@__PURE__*/ proxyCustomElement(class extends HTMLElemen
    * 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, {});

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

@@ -432,6 +432,9 @@ const SnkFilterBar = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
       this.registryFilterProvider();
     }
   }
+  /**
+  * Emitido quando acontece a alteração do estado do filtro.
+  */
   filterChangeListener(evt) {
     this.updateFilter(evt.detail);
   }

package/dist/components/snk-filter-binary-select.js

@@ -10,6 +10,9 @@ const SnkFilterBinarySelect$1 = /*@__PURE__*/ proxyCustomElement(class extends H
   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);
@@ -38,6 +41,9 @@ const SnkFilterBinarySelect$1 = /*@__PURE__*/ proxyCustomElement(class extends H
       this.value = undefined;
     }
   }
+  /**
+   * Exibe o componente snk-filter-binary-select
+   */
   async show() {
     this._checkOne.setFocus();
   }

package/dist/components/snk-filter-detail2.js

@@ -9,6 +9,9 @@ const SnkFilterDetail = /*@__PURE__*/ proxyCustomElement(class extends HTMLEleme
     this.__registerHost();
     this.filterChange = createEvent(this, "filterChange", 7);
   }
+  /**
+   * Exibe o componente snk-filter-detail.
+   */
   async show() {
     this._editor["show"]();
   }

package/dist/components/snk-filter-item2.js

@@ -20,6 +20,9 @@ const SnkFilterItem = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
   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" });
@@ -44,6 +47,9 @@ const SnkFilterItem = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     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) {
@@ -154,6 +160,9 @@ const SnkFilterItem = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
       }
     }
   }
+  /**
+   * Emitido quando o estado do filtro é alterado.
+   */
   filterChangeListener() {
     this.hideDetail();
   }

package/dist/components/snk-filter-list2.js

@@ -30,6 +30,9 @@ const SnkFilterList = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     this._filterArgument = "";
     this._filterInput.setFocus();
   }
+  /**
+   * Oculta os detalhes do componente snk-filter-list.
+   */
   async hideDetail() {
     if (this._floatingID != undefined) {
       FloatingManager.close(this._floatingID);

package/dist/components/snk-filter-multi-select.js

@@ -7,9 +7,15 @@ const SnkFilterMultiSelect$1 = /*@__PURE__*/ proxyCustomElement(class extends HT
     super();
     this.__registerHost();
   }
+  /**
+   * 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/components/snk-filter-number.js

@@ -7,9 +7,15 @@ const SnkFilterPeriod = /*@__PURE__*/ proxyCustomElement(class extends HTMLEleme
     super();
     this.__registerHost();
   }
+  /**
+   * 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/components/snk-filter-period.js

@@ -7,6 +7,9 @@ const SnkFilterPeriod$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLEle
     super();
     this.__registerHost();
   }
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-period
+   */
   ezChangeListener() {
     const start = this._startDate.value;
     const end = this._endDate.value;
@@ -29,6 +32,9 @@ const SnkFilterPeriod$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLEle
     }
     return null;
   }
+  /**
+   * Exibe o componente snk-filter-period
+   */
   async show() {
     this._startDate.setFocus();
   }

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

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

package/dist/components/snk-filter-search.js

@@ -7,6 +7,9 @@ const SnkFilterSearch$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLEle
     super();
     this.__registerHost();
   }
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-search
+   */
   ezChangeListener(_evt) {
     this.value = this._searchInput.value;
   }
@@ -26,6 +29,9 @@ const SnkFilterSearch$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLEle
       });
     });
   }
+  /**
+   * Exibe o componente snk-filter-search
+   */
   async show() {
     this._searchInput.setFocus();
   }

package/dist/components/snk-filter-text.js

@@ -6,6 +6,9 @@ const SnkFilterText$1 = /*@__PURE__*/ proxyCustomElement(class extends HTMLEleme
     super();
     this.__registerHost();
   }
+  /**
+   * Emitido quando acontece a alteração de valor do componente snk-filter-text.
+   */
   ezChangeListener(evt) {
     this.value = evt.detail;
   }

package/dist/components/snk-form2.js

@@ -26,13 +26,13 @@ const SnkForm = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
     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;

package/dist/components/snk-grid-config2.js

@@ -25,6 +25,9 @@ const EzGridConfig = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement
     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) {

package/dist/components/snk-grid2.js

@@ -29,7 +29,7 @@ const SnkGrid = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
     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) {
@@ -38,7 +38,7 @@ const SnkGrid = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
     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) {
@@ -47,7 +47,7 @@ const SnkGrid = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
     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/components/snk-select-box2.js

@@ -9,6 +9,9 @@ const SelectBox = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
     this.__registerHost();
     this.__attachShadow();
     this.ezChange = createEvent(this, "ezChange", 7);
+    /**
+     * Determina a opção selecionada.
+     */
     this.selectedOption = ORDER_VALUES.none;
   }
   render() {