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

package/dist/types/components.d.ts

@@ -22,6 +22,7 @@ import { IClientEventResponse } from "./lib/http/data-fetcher/interfaces/IClient
 import { IDataFetcherRecaller } from "./lib/http/data-fetcher/recaller/IDataFetcherRecaller";
 import { DialogType, FormLayout, MessageOptions } from "@sankhyalabs/ezui/dist/collection/utils";
 import { IOption as IOption1, ISearchArgument } from "@sankhyalabs/ezui/dist/types/components/ez-search/ez-search";
+import { ISearchCtxOptions } from "./components/snk-application/snk-application";
 import { IRemoveSearchListener, ISearchListener, SearchCriteria } from "./lib/http/data-fetcher/fetchers/pesquisa-fetcher";
 import { SIMPLE_CRUD_MODE, TEMPLATES_SKELETON, VIEW_MODE } from "./lib/utils/constants";
 import { TFetcherType } from "./components/snk-attach/interfaces/TFetcherType";
@@ -181,61 +182,113 @@ export namespace Components {
           * 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.
+          * @returns 
+          * @async
          */
         "addClientEvent": (eventID: String, handler: (clientEvent: IClientEventResponse, dataFetcherReacaller: IDataFetcherRecaller) => void) => Promise<void>;
+        /**
+          * Adiciona um bloqueio de carregamento à aplicação.
+          * @param forceReady - Se `true`, força a aplicação para o estado "não pronto" antes de adicionar o bloqueio.
+          * @param templateSkeletonType - O tipo de esqueleto de carregamento a ser exibido.
+          * @returns O ID do bloqueio adicionado.
+          * @async
+         */
         "addLoadingLock": (forceReady?: boolean, templateSkeletonType?: TEMPLATES_SKELETON) => Promise<() => void>;
         /**
           * 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 actionsLocker - Nome do locker da ação que será adicionada.
+          * @param action - Ação que será executada.
+          * @returns 
+          * @async
          */
         "addPendingAction": (actionsLocker: string, action: Function) => Promise<void>;
         /**
-          * Adiciona um listener no fetcher de Pesquisa
+          * Adiciona um listener no fetcher de Pesquisa.
+          * @param entityName - O nome da entidade.
+          * @param dataUnit - A instância do DataUnit.
+          * @param listener - O listener a ser adicionado.
+          * @returns Uma função para remover o listener.
+          * @async
          */
         "addSearchListener": (entityName: string, dataUnit: DataUnit, listener: ISearchListener) => Promise<IRemoveSearchListener>;
         /**
           * Exibe o diálogo de alerta de acordo com os parâmetros passados.
+          * @param title - O título do alerta.
+          * @param message - A mensagem do alerta.
+          * @param icon - O nome do ícone a ser exibido.
+          * @param options - Opções adicionais para a mensagem.
+          * @returns 
+          * @async
          */
         "alert": (title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>;
         /**
           * 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
+          * @param serviceName - Nome do serviço.
+          * @param payload - Dados que serão processados na ação.
+          * @param options - Parâmetros de URL.
+          * @returns A resposta do Service Broker.
+          * @async
          */
         "callServiceBroker": (serviceName: string, payload: string | Object, options?: Options) => Promise<any>;
         "clearPopUpTitle": () => Promise<void>;
         /**
           * Fecha o Modal e limpa o conteúdo.
+          * @returns 
+          * @async
          */
         "closeModal": () => Promise<void>;
         /**
           * Fecha o Popup e limpa o conteúdo.
+          * @returns 
+          * @async
          */
         "closePopUp": () => Promise<void>;
         /**
-          * Usado para salvar as configurações dos blocos de construção.
+          * Nome da configuração utilizada para salvar as preferências dos blocos de construção.
          */
         "configName": string;
         /**
-          * Exibe um diálogo de confirmação
+          * Exibe um diálogo de confirmação.
+          * @param title - O título da confirmação.
+          * @param message - A mensagem da confirmação.
+          * @param icon - O nome do ícone a ser exibido.
+          * @param dialogType - O tipo de diálogo.
+          * @param options - Opções adicionais para a mensagem.
+          * @returns `true` se confirmado, `false` caso contrário.
+          * @async
          */
         "confirm": (title: string, message: string, icon?: string, dialogType?: DialogType, options?: MessageOptions) => Promise<boolean>;
         /**
           * 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 entityName - O nome da entidade.
+          * @param dataUnitName - O nome para identificar o DataUnit no cache.
+          * @param parentDataUnit - O DataUnit pai, se houver.
+          * @param configName - O nome da configuração a ser usada.
+          * @param resourceID - O ID do recurso. Se não fornecido, usa o da aplicação.
+          * @returns O DataUnit criado ou obtido do cache.
+          * @async
          */
         "createDataunit": (entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>;
         /**
-          * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
+          * Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
          */
         "enableLockManagerLoadingApp": boolean;
         /**
           * Exibe o diálogo de erro de acordo com os parâmetros passados.
+          * @param title - O título do erro.
+          * @param message - A mensagem do erro.
+          * @param icon - O nome do ícone a ser exibido.
+          * @param options - Opções adicionais para a mensagem.
+          * @returns 
+          * @async
          */
         "error": (title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>;
         /**
-          * Obtém as opções em componentes de pesquisa Ex.: snk-config-options
+          * @param mode - O modo da pesquisa ("ADVANCED" ou outro).
+          * @param argument - O argumento da pesquisa.
+          * @param options - Opções preparadas para a pesquisa. Veja a documentação para exemplo de uso.
+          * @returns Uma lista de opções ou uma única opção.
+          * @async
          */
         "executePreparedSearch": (mode: string, argument: string, options: any) => Promise<Array<IOption1> | IOption1>;
         /**
@@ -243,106 +296,177 @@ export namespace Components {
          */
         "executePreparedSearchPlus": (mode: string, argument: string, options: any) => Promise<Array<IOption1> | IOption1>;
         /**
-          * Obtém as opções em componentes de pesquisa Ex.: snk-config-options
+          * Obtém as opções em componentes de pesquisa. Ex.: snk-config-options
+          * @param searchArgument - Argumentos da pesquisa.
+          * @param fieldName - Nome do campo no DataUnit.
+          * @param dataUnit - Instância do DataUnit.
+          * @param ctxOptions - Opções de contexto adicionais.
+          * @returns Uma lista de opções ou uma única opção.
+          * @async
          */
-        "executeSearch": (searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: any) => Promise<Array<IOption1> | IOption1>;
+        "executeSearch": (searchArgument: ISearchArgument, fieldName: string, dataUnit: DataUnit, ctxOptions?: ISearchCtxOptions) => Promise<Array<IOption1> | IOption1>;
         /**
           * 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 - A instância do DataUnit.
+          * @param fieldName - O nome do campo para o select distinct.
+          * @param argument - O argumento de filtro para a coluna.
+          * @returns Uma lista de valores distintos.
+          * @async
          */
         "executeSelectDistinct": (dataUnit: DataUnit, fieldName: string, argument: string) => Promise<Array<any>>;
         /**
-          * Chave da configuração legado do formulário.
+          * Chave da configuração legada do formulário, utilizada para migração de configurações antigas.
          */
         "formLegacyConfigName": string;
         /**
-          * 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 resourceID - O ID do recurso. Se não fornecido, obtém os acessos da aplicação.
+          * @returns Um objeto contendo todos os tipos de acesso e se o usuário os possui.
+          * @async
          */
         "getAllAccess": (resourceID?: string) => Promise<any>;
         /**
-          * Obtém o nome das telas da aplicação
+          * Obtém o nome (label) da aplicação.
+          * @returns O nome da aplicação.
+          * @async
          */
         "getAppLabel": () => Promise<string>;
         /**
           * Retorna o path relativo da aplicação.
+          * @returns O caminho relativo da aplicação.
+          * @async
          */
         "getApplicationPath": () => Promise<string>;
         /**
           * Acessa informações de contexto "empurrados" na abertura da tela.
+          * @param attribName - O nome do atributo.
+          * @returns O valor do atributo.
+          * @async
          */
         "getAttributeFromHTMLWrapper": (attribName: string) => Promise<string>;
         /**
           * Obtém o valor de um parâmetro do tipo booleano.
+          * @param name - O nome do parâmetro.
+          * @returns O valor do parâmetro como booleano.
+          * @async
          */
         "getBooleanParam": (name: string) => Promise<boolean>;
         /**
-          * Obtém a configuração de um recurso por service broker
+          * Obtém a configuração de um recurso por service broker.
+          * @param key - A chave da configuração.
+          * @returns Os dados da configuração.
+          * @async
          */
         "getConfig": (key: string) => Promise<any>;
         /**
-          * Retorna a instancia do DataFetcher utilizado pelo application
-          * @returns DataFetcher do application
+          * Retorna a instância do DataFetcher utilizado pelo application.
+          * @returns O DataFetcher da aplicação.
+          * @async
          */
         "getDataFetcher": () => Promise<DataFetcher>;
         /**
-          * 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 entityName - O nome da entidade.
+          * @param dataUnitName - O nome para identificar o DataUnit no cache.
+          * @param parentDataUnit - O DataUnit pai, se houver.
+          * @param configName - O nome da configuração a ser usada.
+          * @param resourceID - O ID do recurso. Se não fornecido, usa o da aplicação.
+          * @returns O DataUnit obtido do cache ou recém-criado.
+          * @async
          */
         "getDataUnit": (entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>;
         /**
           * Obtém o valor de um parâmetro do tipo data.
+          * @param name - O nome do parâmetro.
+          * @returns O valor do parâmetro como objeto Date.
+          * @async
          */
         "getDateParam": (name: string) => Promise<Date>;
         /**
           * Obtém o valor de um parâmetro do tipo Decimal.
+          * @param name - O nome do parâmetro.
+          * @returns O valor do parâmetro como número decimal.
+          * @async
          */
         "getFloatParam": (name: string) => Promise<number>;
         /**
           * Obtém o valor de um parâmetro do tipo Inteiro.
+          * @param name - O nome do parâmetro.
+          * @returns O valor do parâmetro como número inteiro.
+          * @async
          */
         "getIntParam": (name: string) => Promise<number>;
         /**
           * Obtém o controlador de teclado.
-          * @return the keyboard manager
+          * @returns O gerenciador de teclado.
+          * @async
          */
         "getKeyboardManager": () => Promise<KeyboardManager>;
         /**
-          * Obtém o notificador de Layout de formulario.
-          * @return the Configurador de Layout do Formulario
+          * Obtém o notificador de Layout de formulário.
+          * @returns O configurador de Layout do Formulário.
+          * @async
          */
         "getLayoutFormConfig": () => Promise<LayoutFormConfig>;
         /**
           * Obtém o resourceID da tela em questão.
+          * @returns O ID do recurso da aplicação.
+          * @async
          */
         "getResourceID": () => Promise<string>;
         /**
           * Obtém o valor de um parâmetro do tipo string.
+          * @param name - O nome do parâmetro.
+          * @returns O valor do parâmetro como string.
+          * @async
          */
         "getStringParam": (name: string) => Promise<string>;
         /**
-          * Obtém o UserId da tela em questão.
+          * Obtém o UserId do usuário logado.
+          * @returns O ID do usuário.
+          * @async
          */
         "getUserID": () => Promise<string>;
         /**
-          * Chave da configuração legado da grade.
+          * Chave da configuração legada da grade, utilizada para migração de configurações antigas.
          */
         "gridLegacyConfigName": string;
         /**
-          * 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 access - O tipo de acesso a ser verificado.
+          * @param resourceID - O ID do recurso para verificar a permissão. Se não fornecido, verifica a permissão da aplicação.
+          * @returns `true` se o usuário tiver acesso, `false` caso contrário.
+          * @async
          */
         "hasAccess": (access: AutorizationType, resourceID?: string) => Promise<boolean>;
         /**
-          * Verfica se um client event está registrado no DataFetcher da aplicação.
+          * Verifica se um client event está registrado no DataFetcher da aplicação.
           * @param eventID - Nome do evento a ser verificado.
+          * @returns `true` se o evento estiver registrado, `false` caso contrário.
+          * @async
          */
         "hasClientEvent": (eventID: String) => Promise<boolean>;
         /**
-          * 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 relativePath - Define o caminho relativo para o arquivo JavaScript a ser importado, ou uma lista de caminhos.
+          * @returns 
+          * @async
          */
         "importScript": (relativePath: string | Array<string>) => Promise<void>;
         /**
           * Exibe uma informação efêmera (de segundo plano).
+          * @param message - A mensagem a ser exibida.
+          * @param options - Opções adicionais para a mensagem.
+          * @returns 
+          * @async
          */
         "info": (message: string, options?: MessageOptions) => Promise<void>;
+        /**
+          * Inicializa o onboarding para uma chave específica.
+          * @param onboardingKey - A chave do onboarding a ser iniciado.
+          * @returns 
+          * @async
+         */
         "initOnboarding": (onboardingKey: string) => Promise<void>;
         /**
           * Obtém `true` caso a tela esteja em modo de debug.
@@ -353,12 +477,15 @@ export namespace Components {
          */
         "isFeatureActive": (featureName: string) => Promise<boolean>;
         /**
-          * 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 `true` se foi carregado por PK, `false` caso contrário.
+          * @async
          */
         "isLoadedByPk": () => Promise<boolean>;
         /**
           * Obtém `true` caso o usuário logado seja o SUP.
+          * @returns `true` se o usuário for SUP, `false` caso contrário.
+          * @async
          */
         "isUserSup": () => Promise<boolean>;
         /**
@@ -367,64 +494,122 @@ export namespace Components {
         "loadByPK": LoadByPkHandler;
         /**
           * Obtém os totalizadores da grade.
+          * @param name - O nome da configuração de totalizadores.
+          * @param resourceID - O ID do recurso.
+          * @param filters - A lista de filtros a serem aplicados.
+          * @returns Um mapa com os nomes dos totalizadores e seus valores.
+          * @async
          */
         "loadTotals": (name: string, resourceID: string, filters: Array<Filter>) => Promise<Map<string, number>>;
+        /**
+          * Marca a aplicação para recarregar, opcionalmente especificando um tipo de esqueleto de carregamento.
+          * @param templateSkeletonType - O tipo de esqueleto de carregamento a ser exibido.
+          * @returns 
+          * @async
+         */
         "markToReload": (templateSkeletonType?: TEMPLATES_SKELETON) => Promise<void>;
         /**
-          * Exibe um diálogo de mensagem comum
+          * Exibe um diálogo de mensagem comum.
+          * @param title - O título da mensagem.
+          * @param message - A mensagem.
+          * @param icon - O nome do ícone a ser exibido.
+          * @param options - Opções adicionais para a mensagem.
+          * @returns 
+          * @async
          */
         "message": (title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>;
+        /**
+          * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+         */
         "messagesBuilder": SnkMessageBuilder;
         /**
           * Abre determinada tela, repassando pkObject.
+          * @param resourceId - O ID do recurso da tela a ser aberta.
+          * @param pkObject - O objeto de chave primária a ser passado para a tela.
+          * @returns 
+          * @async
          */
         "openApp": (resourceId: string, pkObject: Object) => Promise<void>;
         /**
           * 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 - O DataUnit do qual o registro será removido.
+          * @param recordsIDs - Os IDs dos registros a serem removidos.
+          * @returns 
+          * @async
          */
         "preloadMangerRemoveRecord": (dataUnit: DataUnit, recordsIDs: Array<string>) => Promise<void>;
         /**
-          * Remove um client event para o DataFetcher da aplicação.
+          * Remove um client event do DataFetcher da aplicação.
           * @param eventID - Nome do evento a ser removido.
+          * @returns 
+          * @async
          */
         "removeClientEvent": (eventID: String) => Promise<void>;
         /**
           * Salva a configuração de determinado recurso.
+          * @param key - A chave da configuração.
+          * @param data - Os dados da configuração a serem salvos.
+          * @returns O resultado da operação de salvamento.
+          * @async
          */
         "saveConfig": (key: string, data: Object) => Promise<any>;
         "setPopUpTitle": (title: string) => Promise<void>;
         /**
           * 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 name - Nome do parâmetro.
+          * @param value - String conversível de acordo com o tipo do parâmetro.
+          * @returns 
+          * @async
          */
         "setSearchFilterContext": (name: string, value: string) => Promise<void>;
         /**
-          * 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 alerts - A lista de alertas a serem exibidos.
+          * @returns
          */
         "showAlerts": (alerts: Array<AlertItem>) => Promise<void>;
         /**
           * Exibe o conteúdo passado em um Modal.
+          * @param content - O elemento HTML a ser exibido no modal.
+          * @returns 
+          * @async
          */
         "showModal": (content: HTMLElement) => Promise<void>;
         /**
           * Exibe o conteúdo passado em um Popup.
+          * @param content - O elemento HTML a ser exibido no popup.
+          * @param size - O tamanho do popup.
+          * @param useHeader - Define se o cabeçalho do popup deve ser usado.
+          * @param onCloseCallback - Função a ser chamada quando o popup for fechado.
+          * @returns 
+          * @async
          */
         "showPopUp": (content: HTMLElement, size?: "auto" | "full", useHeader?: boolean, onCloseCallback?: Function) => Promise<void>;
         "showScrimApp": (active: boolean) => Promise<void>;
         /**
           * Exibe o diálogo de sucesso de acordo com os parâmetros passados.
+          * @param title - O título da mensagem de sucesso.
+          * @param message - A mensagem de sucesso.
+          * @param icon - O nome do ícone a ser exibido.
+          * @param options - Opções adicionais para a mensagem.
+          * @returns 
+          * @async
          */
         "success": (title: string, message: string, icon?: string, options?: MessageOptions) => Promise<boolean>;
         /**
-          * Verifica se a licença do cliente tem determinado opcional (produto)
+          * Verifica se a licença do cliente tem determinado opcional (produto).
+          * @param opcional - O nome do opcional ou uma string de opcionais separados por vírgula.
+          * @returns `true` se o cliente tiver o opcional, `false` caso contrário.
+          * @async
          */
         "temOpcional": (opcional: string) => Promise<boolean>;
         /**
           * Atualiza o cache de dataunits da aplicação.
-          * @param oldName - Nome do dataunit que está em cache.
+          * @param oldName - Nome do dataunit que está em cache (será removido).
           * @param dataUnitName - Nome do dataunit que será armazenado em cache.
-          * @param dataUnit - Instancia do Dataunit para ser armazenado em cache.
+          * @param dataUnit - Instância do Dataunit para ser armazenado em cache.
+          * @returns 
+          * @async
          */
         "updateDataunitCache": (oldName: string, dataUnitName: string, dataUnit: DataUnit) => Promise<void>;
         /**
@@ -432,11 +617,14 @@ export namespace Components {
           * @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.
+          * @returns 
+          * @async
          */
         "webConnection": (keyPort: string, methodName: string, params: IAppletCallerParams) => Promise<void>;
         /**
-          * 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 O componente SnkApplication carregado.
+          * @async
          */
         "whenApplicationReady": () => Promise<SnkApplication>;
     }
@@ -2934,25 +3122,28 @@ declare namespace LocalJSX {
     }
     interface SnkApplication {
         /**
-          * Usado para salvar as configurações dos blocos de construção.
+          * Nome da configuração utilizada para salvar as preferências dos blocos de construção.
          */
         "configName"?: string;
         /**
-          * Define se o componente deve usar o LockManager para controle de carregamento da aplicação
+          * Define se o componente deve usar o LockManager para controle de carregamento da aplicação.
          */
         "enableLockManagerLoadingApp"?: boolean;
         /**
-          * Chave da configuração legado do formulário.
+          * Chave da configuração legada do formulário, utilizada para migração de configurações antigas.
          */
         "formLegacyConfigName"?: string;
         /**
-          * Chave da configuração legado da grade.
+          * Chave da configuração legada da grade, utilizada para migração de configurações antigas.
          */
         "gridLegacyConfigName"?: string;
         /**
           * Usado para receber um parâmetro na inicialização da tela, e utilizá-lo conforme necessário caso a tela receba um parâmetro, e, esta propriedade não seja informada é criado um filtro de forma automática através do método defaultLoadByPk
          */
         "loadByPK"?: LoadByPkHandler;
+        /**
+          * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+         */
         "messagesBuilder"?: SnkMessageBuilder;
         /**
           * Emitido quando a aplicação for carregada.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sankhyalabs/sankhyablocks",
-  "version": "9.1.0-dev.19",
+  "version": "9.1.0-dev.20",
   "description": "Stencil Component Starter",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",