@sankhyalabs/sankhyablocks 9.1.0-dev.19 → 9.1.0-dev.20

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

@@ -612,22 +612,24 @@ const SnkApplication = class {
   }
   /**
    * Obtém o controlador de teclado.
-   *
-   * @return {KeyboardManager} the keyboard manager
+   * @returns {Promise<KeyboardManager>} O gerenciador de teclado.
+   * @async
    */
   async getKeyboardManager() {
     return Promise.resolve(this._keyboardManager);
   }
   /**
-   * Obtém o notificador de Layout de formulario.
-   *
-   * @return {LayoutFormConfig} the Configurador de Layout do Formulario
+   * Obtém o notificador de Layout de formulário.
+   * @returns {Promise<LayoutFormConfig>} O configurador de Layout do Formulário.
+   * @async
    */
   async getLayoutFormConfig() {
     return Promise.resolve(this._LayoutFormConfigSingleton);
   }
   /**
    * Obtém `true` caso o usuário logado seja o SUP.
+   * @returns {Promise<boolean>} `true` se o usuário for SUP, `false` caso contrário.
+   * @async
    */
   async isUserSup() {
     return new Promise((resolve, reject) => {
@@ -640,9 +642,10 @@ const SnkApplication = class {
   }
   /**
    * Adiciona uma ação pendente que deve ser executada por um determinado locker.
-   *
-   * @param actionsLocker nome do locker da ação que será adicionada
-   * @param action ação que será executada
+   * @param {string} actionsLocker - Nome do locker da ação que será adicionada.
+   * @param {Function} action - Ação que será executada.
+   * @returns {Promise<void>}
+   * @async
    */
   async addPendingAction(actionsLocker, action) {
     var _a;
@@ -650,15 +653,22 @@ const SnkApplication = class {
     this._pendingActions.set(actionsLocker, [...actionsFromContext, action]);
   }
   /**
- * Realiza a chamada ao Service Broker conforme o nome do serviço.
- *
- * @param serviceName - Nome do serviço
- * @param payload - Dados que serão processados na ação
- * @param options - Parâmetros de URL
- */
+   * Realiza a chamada ao Service Broker conforme o nome do serviço.
+   * @param {string} serviceName - Nome do serviço.
+   * @param {string | Object} payload - Dados que serão processados na ação.
+   * @param {Options} [options] - Parâmetros de URL.
+   * @returns {Promise<any>} A resposta do Service Broker.
+   * @async
+   */
   async callServiceBroker(serviceName, payload, options) {
     return DataFetcher.get().callServiceBroker(serviceName, payload, options);
   }
+  /**
+   * Inicializa o onboarding para uma chave específica.
+   * @param {string} onboardingKey - A chave do onboarding a ser iniciado.
+   * @returns {Promise<void>}
+   * @async
+   */
   async initOnboarding(onboardingKey) {
     if (this.hasToShowNewVersionPopup()) {
       await this.addPendingAction(this.NEW_VERSION_POPUP_LOCKER, () => this.doInitOnboarding(onboardingKey));
@@ -670,7 +680,11 @@ const SnkApplication = class {
     OnboardingUtils.getInstance().init(onboardingKey, window.envContext);
   }
   /**
-   * Obtém `true` caso o usuário logado tem permissão pra determinada ação.
+   * Obtém `true` caso o usuário logado tenha permissão para determinada ação.
+   * @param {AutorizationType} access - O tipo de acesso a ser verificado.
+   * @param {string} [resourceID] - O ID do recurso para verificar a permissão. Se não fornecido, verifica a permissão da aplicação.
+   * @returns {Promise<boolean>} `true` se o usuário tiver acesso, `false` caso contrário.
+   * @async
    */
   async hasAccess(access, resourceID) {
     return new Promise((resolve, reject) => {
@@ -682,7 +696,10 @@ const SnkApplication = class {
     });
   }
   /**
-   * Obtém todos os acessos do usuário logado.
+   * Obtém todos os acessos do usuário logado para um recurso específico ou para a aplicação.
+   * @param {string} [resourceID] - O ID do recurso. Se não fornecido, obtém os acessos da aplicação.
+   * @returns {Promise<any>} Um objeto contendo todos os tipos de acesso e se o usuário os possui.
+   * @async
    */
   async getAllAccess(resourceID) {
     return new Promise((resolve, reject) => {
@@ -707,36 +724,57 @@ const SnkApplication = class {
   }
   /**
    * Obtém o valor de um parâmetro do tipo string.
+   * @param {string} name - O nome do parâmetro.
+   * @returns {Promise<string>} O valor do parâmetro como string.
+   * @async
    */
   async getStringParam(name) {
     return this.parameters.asString(name);
   }
   /**
    * Obtém o valor de um parâmetro do tipo Inteiro.
+   * @param {string} name - O nome do parâmetro.
+   * @returns {Promise<number>} O valor do parâmetro como número inteiro.
+   * @async
    */
   async getIntParam(name) {
     return this.parameters.asInteger(name);
   }
   /**
    * Obtém o valor de um parâmetro do tipo Decimal.
+   * @param {string} name - O nome do parâmetro.
+   * @returns {Promise<number>} O valor do parâmetro como número decimal.
+   * @async
    */
   async getFloatParam(name) {
     return this.parameters.asFloat(name);
   }
   /**
    * Obtém o valor de um parâmetro do tipo booleano.
+   * @param {string} name - O nome do parâmetro.
+   * @returns {Promise<boolean>} O valor do parâmetro como booleano.
+   * @async
    */
   async getBooleanParam(name) {
     return this.parameters.asBoolean(name);
   }
   /**
    * Obtém o valor de um parâmetro do tipo data.
+   * @param {string} name - O nome do parâmetro.
+   * @returns {Promise<Date>} O valor do parâmetro como objeto Date.
+   * @async
    */
   async getDateParam(name) {
     return this.parameters.asDate(name);
   }
   /**
    * Exibe o conteúdo passado em um Popup.
+   * @param {HTMLElement} content - O elemento HTML a ser exibido no popup.
+   * @param {"auto" | "full"} [size="full"] - O tamanho do popup.
+   * @param {boolean} [useHeader=true] - Define se o cabeçalho do popup deve ser usado.
+   * @param {Function} [onCloseCallback] - Função a ser chamada quando o popup for fechado.
+   * @returns {Promise<void>}
+   * @async
    */
   async showPopUp(content, size = "full", useHeader = true, onCloseCallback) {
     this.clearContent(this._popUp);
@@ -753,6 +791,9 @@ const SnkApplication = class {
   }
   /**
    * Exibe o conteúdo passado em um Modal.
+   * @param {HTMLElement} content - O elemento HTML a ser exibido no modal.
+   * @returns {Promise<void>}
+   * @async
    */
   async showModal(content) {
     this.clearContent(this._rightModal);
@@ -760,15 +801,18 @@ const SnkApplication = class {
     this._rightModal.opened = true;
   }
   /**
-   * Apresenta uma lista de alertas,
-   * geralmente é utilizado para apresentar resultados
-   * de processamentos em lote.
+   * Apresenta uma lista de alertas.
+   * Geralmente é utilizado para apresentar resultados de processamentos em lote.
+   * @param {Array<AlertItem>} alerts - A lista de alertas a serem exibidos.
+   * @returns {Promise<void>}
    */
   showAlerts(alerts) {
     return ApplicationUtils.showAlerts({ alerts });
   }
   /**
    * Fecha o Modal e limpa o conteúdo.
+   * @returns {Promise<void>}
+   * @async
    */
   async closeModal() {
     this.clearContent(this._rightModal);
@@ -776,6 +820,8 @@ const SnkApplication = class {
   }
   /**
    * Fecha o Popup e limpa o conteúdo.
+   * @returns {Promise<void>}
+   * @async
    */
   async closePopUp() {
     this.clearContent(this._popUp);
@@ -784,7 +830,10 @@ const SnkApplication = class {
     this._popUp.heightMode = "full";
   }
   /**
-   * Verifica se a licença do cliente tem determinado opcional (produto)
+   * Verifica se a licença do cliente tem determinado opcional (produto).
+   * @param {string} opcional - O nome do opcional ou uma string de opcionais separados por vírgula.
+   * @returns {Promise<boolean>} `true` se o cliente tiver o opcional, `false` caso contrário.
+   * @async
    */
   async temOpcional(opcional) {
     const opts = opcional.split(",");
@@ -810,7 +859,10 @@ const SnkApplication = class {
     });
   }
   /**
-   * Obtém a configuração de um recurso por service broker
+   * Obtém a configuração de um recurso por service broker.
+   * @param {string} key - A chave da configuração.
+   * @returns {Promise<any>} Os dados da configuração.
+   * @async
    */
   async getConfig(key) {
     let payload = {
@@ -854,6 +906,10 @@ const SnkApplication = class {
   }
   /**
    * Salva a configuração de determinado recurso.
+   * @param {string} key - A chave da configuração.
+   * @param {Object} data - Os dados da configuração a serem salvos.
+   * @returns {Promise<any>} O resultado da operação de salvamento.
+   * @async
    */
   async saveConfig(key, data) {
     let payload = {
@@ -875,21 +931,30 @@ const SnkApplication = class {
   }
   /**
    * Acessa informações de contexto "empurrados" na abertura da tela.
+   * @param {string} attribName - O nome do atributo.
+   * @returns {Promise<string>} O valor do atributo.
+   * @async
    */
   async getAttributeFromHTMLWrapper(attribName) {
     return Promise.resolve(window[attribName]);
   }
   /**
    * Abre determinada tela, repassando pkObject.
+   * @param {string} resourceId - O ID do recurso da tela a ser aberta.
+   * @param {Object} pkObject - O objeto de chave primária a ser passado para a tela.
+   * @returns {Promise<void>}
+   * @async
    */
   async openApp(resourceId, pkObject) {
     Workspace.openAppActivity(resourceId, pkObject);
   }
   /**
    * Realiza a chamada do WebConnection para realizar a exportação de arquivo.
-   * @param keyPort - Chave da porta que será requisitada.
-   * @param methodName - Nome do tipo de exportação de arquivo que será realizado.
-   * @param params - Parâmetros necessários para realizar a exportação do arquivo.
+   * @param {string} keyPort - Chave da porta que será requisitada.
+   * @param {string} methodName - Nome do tipo de exportação de arquivo que será realizado.
+   * @param {IAppletCallerParams} params - Parâmetros necessários para realizar a exportação do arquivo.
+   * @returns {Promise<void>}
+   * @async
    */
   async webConnection(keyPort, methodName, params) {
     this.getStringParam(keyPort).then((port) => {
@@ -910,6 +975,13 @@ 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.
+   * @param {string} entityName - O nome da entidade.
+   * @param {string} [dataUnitName] - O nome para identificar o DataUnit no cache.
+   * @param {DataUnit} [parentDataUnit] - O DataUnit pai, se houver.
+   * @param {string} [configName] - O nome da configuração a ser usada.
+   * @param {string} [resourceID] - O ID do recurso. Se não fornecido, usa o da aplicação.
+   * @returns {Promise<DataUnit>} O DataUnit criado ou obtido do cache.
+   * @async
    */
   async createDataunit(entityName, dataUnitName, parentDataUnit, configName, resourceID) {
     if (resourceID == undefined) {
@@ -941,9 +1013,11 @@ const SnkApplication = class {
   }
   /**
    * Atualiza o cache de dataunits da aplicação.
-   * @param oldName - Nome do dataunit que está em cache.
-   * @param dataUnitName - Nome do dataunit que será armazenado em cache.
-   * @param dataUnit - Instancia do Dataunit para ser armazenado em cache.
+   * @param {string} oldName - Nome do dataunit que está em cache (será removido).
+   * @param {string} dataUnitName - Nome do dataunit que será armazenado em cache.
+   * @param {DataUnit} dataUnit - Instância do Dataunit para ser armazenado em cache.
+   * @returns {Promise<void>}
+   * @async
    */
   async updateDataunitCache(oldName, dataUnitName, dataUnit) {
     if (oldName) {
@@ -952,7 +1026,14 @@ const SnkApplication = class {
     this._duCache.set(dataUnitName, dataUnit);
   }
   /**
-   * Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
+   * Obtém um DataUnit do cache ou cria um caso ainda não tenha sido criado.
+   * @param {string} entityName - O nome da entidade.
+   * @param {string} dataUnitName - O nome para identificar o DataUnit no cache.
+   * @param {DataUnit} [parentDataUnit] - O DataUnit pai, se houver.
+   * @param {string} [configName] - O nome da configuração a ser usada.
+   * @param {string} [resourceID] - O ID do recurso. Se não fornecido, usa o da aplicação.
+   * @returns {Promise<DataUnit>} O DataUnit obtido do cache ou recém-criado.
+   * @async
    */
   async getDataUnit(entityName, dataUnitName, parentDataUnit, configName, resourceID) {
     return new Promise((resolve, reject) => {
@@ -969,9 +1050,10 @@ const SnkApplication = class {
   }
   /**
    * Registra um client event para o DataFetcher da aplicação.
-   *
-   * @param eventID - Nome do evento para a aplicação se registrar.
-   * @param handler - Função de callback que será chamada quando o client event ocorrer.
+   * @param {String} eventID - Nome do evento para a aplicação se registrar.
+   * @param {(clientEvent: IClientEventResponse, dataFetcherReacaller: IDataFetcherRecaller) => void} handler - Função de callback que será chamada quando o client event ocorrer.
+   * @returns {Promise<void>}
+   * @async
    */
   async addClientEvent(eventID, handler) {
     return new Promise((resolve) => {
@@ -980,9 +1062,10 @@ const SnkApplication = class {
     });
   }
   /**
-   * Remove um client event para o DataFetcher da aplicação.
-   *
-   * @param eventID - Nome do evento a ser removido.
+   * Remove um client event do DataFetcher da aplicação.
+   * @param {String} eventID - Nome do evento a ser removido.
+   * @returns {Promise<void>}
+   * @async
    */
   async removeClientEvent(eventID) {
     return new Promise((resolve) => {
@@ -991,9 +1074,10 @@ const SnkApplication = class {
     });
   }
   /**
-   * Verfica se um client event está registrado no DataFetcher da aplicação.
-   *
-   * @param eventID - Nome do evento a ser verificado.
+   * Verifica se um client event está registrado no DataFetcher da aplicação.
+   * @param {String} eventID - Nome do evento a ser verificado.
+   * @returns {Promise<boolean>} `true` se o evento estiver registrado, `false` caso contrário.
+   * @async
    */
   async hasClientEvent(eventID) {
     return new Promise((resolve) => {
@@ -1011,61 +1095,106 @@ const SnkApplication = class {
   }
   /**
    * Obtém o resourceID da tela em questão.
+   * @returns {Promise<string>} O ID do recurso da aplicação.
+   * @async
    */
   async getResourceID() {
     return Promise.resolve(this.applicationResourceID);
   }
   /**
-   * Obtém o UserId da tela em questão.
+   * Obtém o UserId do usuário logado.
+   * @returns {Promise<string>} O ID do usuário.
+   * @async
    */
   async getUserID() {
     return Promise.resolve(window["UID"]);
   }
   /**
    * Exibe o diálogo de alerta de acordo com os parâmetros passados.
+   * @param {string} title - O título do alerta.
+   * @param {string} message - A mensagem do alerta.
+   * @param {string} [icon] - O nome do ícone a ser exibido.
+   * @param {MessageOptions} [options] - Opções adicionais para a mensagem.
+   * @returns {Promise<boolean>}
+   * @async
    */
   async alert(title, message, icon, options) {
     return ApplicationUtils.alert(title, message, icon, options);
   }
   /**
    * Exibe o diálogo de erro de acordo com os parâmetros passados.
+   * @param {string} title - O título do erro.
+   * @param {string} message - A mensagem do erro.
+   * @param {string} [icon] - O nome do ícone a ser exibido.
+   * @param {MessageOptions} [options] - Opções adicionais para a mensagem.
+   * @returns {Promise<boolean>}
+   * @async
    */
   async error(title, message, icon, options) {
     return ApplicationUtils.error(title, message, icon, options);
   }
   /**
    * Exibe o diálogo de sucesso de acordo com os parâmetros passados.
+   * @param {string} title - O título da mensagem de sucesso.
+   * @param {string} message - A mensagem de sucesso.
+   * @param {string} [icon] - O nome do ícone a ser exibido.
+   * @param {MessageOptions} [options] - Opções adicionais para a mensagem.
+   * @returns {Promise<boolean>}
+   * @async
    */
   async success(title, message, icon, options) {
     return ApplicationUtils.success(title, message, icon, options);
   }
   /**
-   * Exibe um diálogo de mensagem comum
+   * Exibe um diálogo de mensagem comum.
+   * @param {string} title - O título da mensagem.
+   * @param {string} message - A mensagem.
+   * @param {string} [icon] - O nome do ícone a ser exibido.
+   * @param {MessageOptions} [options] - Opções adicionais para a mensagem.
+   * @returns {Promise<boolean>}
+   * @async
    */
   async message(title, message, icon, options) {
     return ApplicationUtils.message(title, message, icon, options);
   }
   /**
-   * Exibe um diálogo de confirmação
+   * Exibe um diálogo de confirmação.
+   * @param {string} title - O título da confirmação.
+   * @param {string} message - A mensagem da confirmação.
+   * @param {string} [icon] - O nome do ícone a ser exibido.
+   * @param {DialogType} [dialogType] - O tipo de diálogo.
+   * @param {MessageOptions} [options] - Opções adicionais para a mensagem.
+   * @returns {Promise<boolean>} `true` se confirmado, `false` caso contrário.
+   * @async
    */
   async confirm(title, message, icon, dialogType, options) {
     return ApplicationUtils.confirm(title, message, icon, dialogType, options);
   }
   /**
    * Exibe uma informação efêmera (de segundo plano).
+   * @param {string} message - A mensagem a ser exibida.
+   * @param {MessageOptions} [options] - Opções adicionais para a mensagem.
+   * @returns {Promise<void>}
+   * @async
    */
   async info(message, options) {
     return ApplicationUtils.info(message, options);
   }
   /**
    * Obtém os totalizadores da grade.
+   * @param {string} name - O nome da configuração de totalizadores.
+   * @param {string} resourceID - O ID do recurso.
+   * @param {Array<Filter>} filters - A lista de filtros a serem aplicados.
+   * @returns {Promise<Map<string, number>>} Um mapa com os nomes dos totalizadores e seus valores.
+   * @async
    */
   async loadTotals(name, resourceID, filters) {
     return this.totalsFetcher.fetchTotals(name, resourceID, filters);
   }
   /**
-   * Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk
-   * @returns boolean
+   * Obtém a informação se o último carregamento do dataunit foi feito através de um loadByPk.
+   * @returns {Promise<boolean>} `true` se foi carregado por PK, `false` caso contrário.
+   * @async
    */
   async isLoadedByPk() {
     return Promise.resolve(this._isLoadedByPk);
@@ -1073,6 +1202,10 @@ const SnkApplication = class {
   /**
 * Remove registro do cache do PreLoader do dataunit.
 * Deve ser usado quando existe um dataunit usando loader do application, mas o removeLoader está sendo sobrescrito.
+* @param {DataUnit} dataUnit - O DataUnit do qual o registro será removido.
+* @param {Array<string>} recordsIDs - Os IDs dos registros a serem removidos.
+* @returns {Promise<void>}
+* @async
 */
   async preloadMangerRemoveRecord(dataUnit, recordsIDs) {
     const records = recordsIDs.map(id => {
@@ -1132,8 +1265,14 @@ const SnkApplication = class {
     return this._authFetcher;
   }
   /**
-   * Obtém as opções em componentes de pesquisa
+   * Obtém as opções em componentes de pesquisa.
    * Ex.: snk-config-options
+   * @param {ISearchArgument} searchArgument - Argumentos da pesquisa.
+   * @param {string} fieldName - Nome do campo no DataUnit.
+   * @param {DataUnit} dataUnit - Instância do DataUnit.
+   * @param {ISearchCtxOptions} [ctxOptions] - Opções de contexto adicionais.
+   * @returns {Promise<Array<IOption> | IOption>} Uma lista de opções ou uma única opção.
+   * @async
    */
   async executeSearch(searchArgument, fieldName, dataUnit, ctxOptions) {
     const descriptor = dataUnit === null || dataUnit === void 0 ? void 0 : dataUnit.getField(fieldName);
@@ -1231,8 +1370,11 @@ const SnkApplication = class {
     return await this.executePreparedSearch(mode, argument, Object.assign(Object.assign({}, options), { useSearchPlus: true }));
   }
   /**
-   * Obtém as opções em componentes de pesquisa
-   * Ex.: snk-config-options
+   * @param {string} mode - O modo da pesquisa ("ADVANCED" ou outro).
+   * @param {string} argument - O argumento da pesquisa.
+   * @param {any} options - Opções preparadas para a pesquisa. Veja a documentação para exemplo de uso.
+   * @returns {Promise<Array<IOption> | IOption>} Uma lista de opções ou uma única opção.
+   * @async
    */
   async executePreparedSearch(mode, argument, options) {
     const mdByName = {};
@@ -1292,14 +1434,21 @@ const SnkApplication = class {
     });
   }
   /**
-   * Obtém o nome das telas da aplicação
+   * Obtém o nome (label) da aplicação.
+   * @returns {Promise<string>} O nome da aplicação.
+   * @async
    */
   async getAppLabel() {
     return Workspace.getAppLabel(this.applicationResourceID);
   }
   /**
-   * Adiciona um listener no fetcher de Pesquisa
-  */
+   * Adiciona um listener no fetcher de Pesquisa.
+   * @param {string} entityName - O nome da entidade.
+   * @param {DataUnit} dataUnit - A instância do DataUnit.
+   * @param {ISearchListener} listener - O listener a ser adicionado.
+   * @returns {Promise<IRemoveSearchListener>} Uma função para remover o listener.
+   * @async
+   */
   addSearchListener(entityName, dataUnit, listener) {
     return new Promise(resolve => {
       const removeListener = this.pesquisaFetcher.addSearchListener(entityName, dataUnit.dataUnitId, listener);
@@ -1307,8 +1456,10 @@ const SnkApplication = class {
     });
   }
   /**
-    Realiza o import de um JavaScript que está disponivel dentro da pasta /public da aplicação.
-    @param relativePath: Define o caminho relativo para o arquivo JavaScript a ser importado.
+    Realiza o import de um JavaScript que está disponível dentro da pasta /public da aplicação.
+    @param {string | Array<string>} relativePath - Define o caminho relativo para o arquivo JavaScript a ser importado, ou uma lista de caminhos.
+    @returns {Promise<void>}
+    @async
    */
   importScript(relativePath) {
     return new Promise((resolve) => {
@@ -1329,6 +1480,8 @@ const SnkApplication = class {
   }
   /**
    * Retorna o path relativo da aplicação.
+   * @returns {Promise<string>} O caminho relativo da aplicação.
+   * @async
    */
   async getApplicationPath() {
     return new Promise((resolve) => {
@@ -1349,20 +1502,27 @@ const SnkApplication = class {
    * Com base em um campo realiza um "select distinct" respeitando os
    * filtros atuais do dataUnit e um critério de filtro para a própria
    * coluna.
+   * @param {DataUnit} dataUnit - A instância do DataUnit.
+   * @param {string} fieldName - O nome do campo para o select distinct.
+   * @param {string} argument - O argumento de filtro para a coluna.
+   * @returns {Promise<Array<any>>} Uma lista de valores distintos.
+   * @async
    */
   executeSelectDistinct(dataUnit, fieldName, argument) {
     return this.dataUnitFetcher.loadSelectDistinct(dataUnit, fieldName, argument);
   }
   /**
-   * Retorna a instancia do DataFetcher utilizado pelo application
-   * @returns DataFetcher do application
+   * Retorna a instância do DataFetcher utilizado pelo application.
+   * @returns {Promise<DataFetcher>} O DataFetcher da aplicação.
+   * @async
    */
   getDataFetcher() {
     return Promise.resolve(DataFetcher.get());
   }
   /**
-  * Retorna uma promise que sera resolvida quando o snk-application estiver carregado e registrado no ApplicationContext
-  * @returns SnkApplication carregado.
+  * Retorna uma promise que será resolvida quando o snk-application estiver carregado e registrado no ApplicationContext.
+  * @returns {Promise<SnkApplication>} O componente SnkApplication carregado.
+  * @async
   */
   async whenApplicationReady() {
     const isLoadding = ApplicationContext.getContextValue("__SNK__APPLICATION__LOADING__");
@@ -1375,9 +1535,10 @@ const SnkApplication = class {
   }
   /**
    * Atribui valor para parâmetros de contexto no componente de pesquisa.
-   *
-   * @param name - Nome do parâmetro
-   * @param value - String conversível de acordo com o tipo do parâmetro
+   * @param {string} name - Nome do parâmetro.
+   * @param {string} value - String conversível de acordo com o tipo do parâmetro.
+   * @returns {Promise<void>}
+   * @async
    */
   async setSearchFilterContext(name, value) {
     ApplicationContext.setContextValue(`__SNK__APPLICATION__FILTER__CONTEXT(${name})__`, value);
@@ -1632,6 +1793,12 @@ const SnkApplication = class {
   async changeTemplateSkeleton(templateSkeletonType) {
     this._templateSkeleton = templateSkeletonType ? templateSkeletonType : this._templateSkeleton;
   }
+  /**
+   * Marca a aplicação para recarregar, opcionalmente especificando um tipo de esqueleto de carregamento.
+   * @param {TEMPLATES_SKELETON} [templateSkeletonType] - O tipo de esqueleto de carregamento a ser exibido.
+   * @returns {Promise<void>}
+   * @async
+   */
   async markToReload(templateSkeletonType) {
     if (!this.enableLockManagerLoadingApp)
       return;
@@ -1640,6 +1807,13 @@ const SnkApplication = class {
     await LockManager.resetLocks(this._element, LockManagerOperation.APP_LOADING);
     this.resolveApplicationReady();
   }
+  /**
+   * Adiciona um bloqueio de carregamento à aplicação.
+   * @param {boolean} [forceReady=false] - Se `true`, força a aplicação para o estado "não pronto" antes de adicionar o bloqueio.
+   * @param {TEMPLATES_SKELETON} [templateSkeletonType] - O tipo de esqueleto de carregamento a ser exibido.
+   * @returns {Promise<string>} O ID do bloqueio adicionado.
+   * @async
+   */
   async addLoadingLock(forceReady = false, templateSkeletonType) {
     if (!this.enableLockManagerLoadingApp)
       return;