@sankhyalabs/sankhyablocks 9.1.0 → 9.1.2

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 { IPreparedSearchOptions, 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";
@@ -176,180 +177,307 @@ 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
+          * Obtém as opções em componentes de pesquisa com base em opções preparadas. 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.
+          * @returns Uma lista de opções ou uma única opção.
+          * @async
          */
-        "executePreparedSearch": (mode: string, argument: string, options: any) => Promise<Array<IOption1> | IOption1>;
+        "executePreparedSearch": (mode: string, argument: string, options: IPreparedSearchOptions) => Promise<Array<IOption1> | IOption1>;
         /**
           * Realiza a pesquisa de registros Ex.: snk-config-options
          */
-        "executePreparedSearchPlus": (mode: string, argument: string, options: any) => Promise<Array<IOption1> | IOption1>;
+        "executePreparedSearchPlus": (mode: string, argument: string, options: IPreparedSearchOptions) => 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.
          */
         "isDebugMode": () => 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>;
         /**
@@ -358,64 +486,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>;
         /**
@@ -423,11 +609,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>;
     }
@@ -2907,25 +3096,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.
@@ -4031,6 +4223,10 @@ declare namespace LocalJSX {
           * Emitido sempre que houver click de botão ou ação.
          */
         "onActionClick"?: (event: SnkGridCustomEvent<string>) => void;
+        /**
+          * Emitido quando o componente estiver completamente carregado.
+         */
+        "onComponentReady"?: (event: SnkGridCustomEvent<void>) => void;
         /**
           * Emitido sempre que houver duplo click na grade.
          */

package/package.json

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

package/dist/sankhyablocks/p-5126b34e.entry.js

@@ -1 +0,0 @@
-import{r as i,c as t,h as s,F as e,g as a}from"./p-d8d8169b.js";import{KeyboardManager as r,Action as n,ElementIDUtils as o,ApplicationContext as d,StringUtils as h}from"@sankhyalabs/core";import{T as l}from"./p-7de79adf.js";import{C as c}from"./p-8758404f.js";import{P as u,E as g}from"./p-0f3698af.js";import{T as m}from"./p-1a0caadb.js";import{s as k}from"./p-a349689a.js";import{C as v,S as p,a as f,R as T,b,c as C}from"./p-fa591f6f.js";import{SelectionMode as E}from"@sankhyalabs/core/dist/dataunit/DataUnit";import"./p-cd1a5b6a.js";import"./p-c9657baa.js";import"@sankhyalabs/ezui/dist/collection/utils/constants";import"@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata";import"./p-37b4f642.js";import"./p-ff1990ad.js";import"./p-b21d32f6.js";import"./p-9019a32f.js";import{g as R}from"./p-7dd49d15.js";import{buildFieldSearch as O}from"@sankhyalabs/ezui/dist/collection/utils";import"@sankhyalabs/ezui/dist/collection/components/ez-grid/utils/InMemoryFilterColumnDataSource";import"./p-8f3f2306.js";import"./p-8d884fab.js";import"@sankhyalabs/ezui/dist/collection/components/ez-grid/utils";import"@sankhyalabs/core/dist/utils/SortingUtils";import"./p-688dcb4c.js";class _ extends v{getFilters(){var i;return null===(i=this.dataUnit)||void 0===i?void 0:i.getAppliedFilters()}getOrders(){var i;return null===(i=this.dataUnit)||void 0===i?void 0:i.getSort()}getResourceURI(){var i;return null===(i=this.dataUnit)||void 0===i?void 0:i.name}getSelectedNumber(){return this.dataUnit.getSelectionInfo().length}getTotalRecords(){var i,t,s;const{total:e}=(null===(i=this.dataUnit)||void 0===i?void 0:i.getPaginationInfo())||{};return null!=e?e:null===(s=null===(t=this.dataUnit)||void 0===t?void 0:t.records)||void 0===s?void 0:s.length}getSelectedIDs(){return R(this.dataUnit)}getOffset(){return this.getExporterOffset(this.getPaginationInfo())}getPageSize(){var i;return null===(i=this.dataUnit)||void 0===i?void 0:i.pageSize}getExportLimit(){return 5e3}getRecordID(){var i,t,s;return null===(s=null===(t=null===(i=this.dataUnit)||void 0===i?void 0:i.records)||void 0===t?void 0:t[0])||void 0===s?void 0:s.__record__id__}getPaginationInfo(){var i;return null===(i=this.dataUnit)||void 0===i?void 0:i.getPaginationInfo()}getExporterOffset(i){if(null==i)return;const t=i.firstRecord;return t>0?t-1:t}}const I=class{constructor(s){i(this,s),this.actionClick=t(this,"actionClick",7),this.gridDoubleClick=t(this,"gridDoubleClick",7),this._customEditors=new Map,this._customRenders=new Map,this._keyboardManager=new r,this._topTaskbarProcessor=new m({"snkGridTopTaskbar.regular":["FORM_MODE","CONFIGURATOR","INSERT"],"snkGridTopTaskbar.regular.secondary":["FORM_MODE","CONFIGURATOR","INSERT"],"snkGridTopTaskbar.regular.singleTaskbar":[],"snkGridTopTaskbar.finish_edition":["CANCEL","SAVE",this.handleAddFormMode()],"snkGridTopTaskbar.finish_edition.secondary":[],"snkGridTopTaskbar.finish_edition.singleTaskbar":[]}),this._headerTaskbarProcessor=new m({"snkGridHeaderTaskbar.unselected":["REFRESH","DATA_EXPORTER","ACTIONS_BUTTON","MORE_OPTIONS"],"snkGridHeaderTaskbar.selected":this.getGridHeaderSelectedBtns(),"snkGridHeaderTaskbar.detail.unselected":["REFRESH","MORE_OPTIONS"],"snkGridHeaderTaskbar.detail.selected":["UPDATE","ATTACH","CLONE","REMOVE","MORE_OPTIONS","DIVIDER","REFRESH"],"snkGridHeaderTaskbar.singleTaskbar.unselected":["INSERT","FORM_MODE","CONFIGURATOR","REFRESH","DATA_EXPORTER","ACTIONS_BUTTON","MORE_OPTIONS"],"snkGridHeaderTaskbar.singleTaskbar.selected":["UPDATE","CLONE","REMOVE","MORE_OPTIONS","DIVIDER","ATTACH","FORM_MODE","CONFIGURATOR","REFRESH","DATA_EXPORTER","ACTIONS_BUTTON"],"snkGridHeaderTaskbar.singleTaskbar.detail.unselected":["INSERT","FORM_MODE","CONFIGURATOR","REFRESH","MORE_OPTIONS"],"snkGridHeaderTaskbar.singleTaskbar.detail.selected":["UPDATE","ATTACH","CLONE","REMOVE","MORE_OPTIONS","DIVIDER","FORM_MODE","CONFIGURATOR","REFRESH"],"snkGridHeaderTaskbar.singleTaskbar.finish_edition":["CANCEL","SAVE",this.handleAddFormMode()]}),this.dataUnitInterceptor={interceptAction:async i=>i.type===n.METADATA_LOADED?await this.interceptMetadataLoaded(i):i},this._dataUnit=void 0,this._dataState=void 0,this._gridConfig=void 0,this._popUpGridConfig=!1,this._showSnkFilterBar=!0,this._enableContinuousInsert=!1,this.columnFilterDataSource=new p,this.enableLockManagerLoadingComp=!1,this.enableLockManagerTaskbarClick=!1,this.configName=void 0,this.filterBarTitle=void 0,this.resourceID=void 0,this.selectionToastConfig=void 0,this.actionsList=void 0,this.isDetail=void 0,this.taskbarManager=void 0,this.statusResolver=void 0,this.multipleSelection=void 0,this.presentationMode=u.PRIMARY,this.messagesBuilder=void 0,this.useEnterLikeTab=!1,this.recordsValidator=void 0,this.canEdit=!0,this.taskbarCustomContainerId=void 0,this.gridHeaderCustomSlotId="GRID_HEADER_CUSTOM_ELEMENTS",this.topTaskbarCustomSlotId="GRID_TASKBAR_CUSTOM_ELEMENTS",this.disablePersonalizedFilter=void 0,this.gridLegacyConfigName=void 0,this.filterBarLegacyConfigName=void 0,this.autoLoad=void 0,this.autoFocus=!0,this.enableGridInsert=!1,this.outlineMode=!1,this.suppressHorizontalScroll=!1,this.strategyExporter=g.SERVER_SIDE,this.useSearchColumn=!0,this.multipleEditionEnabled=!0,this.paginationCounterMode="auto",this.suppressCheckboxColumn=void 0,this.compact=void 0}getGridHeaderSelectedBtns(){const i=[l.UPDATE,l.CLONE,l.REMOVE,l.MORE_OPTIONS,l.DIVIDER,l.ATTACH,l.FORM_MODE,l.CONFIGURATOR,l.REFRESH,l.DATA_EXPORTER,l.ACTIONS_BUTTON];return this.multipleEditionEnabled&&i.unshift(l.UPDATE_MULTIPLE),i}reloadConfig(){this.loadConfig()}async showConfig(){null!=this._grid&&this.openGridConfig()}async hideConfig(){null!=this._grid&&this.closeGridConfig()}async setConfig(i){this.setGridConfig(i)}async reloadFilterBar(){var i;null===(i=this._snkFilterBar)||void 0===i||i.reload()}async getFilterBar(){return this._snkFilterBar}async addCustomEditor(i,t,s){if(this._grid)return void this._grid.addCustomEditor(i,t,s);const e=new Map(this._customEditors);e.set(i,{customEditor:t,detailContext:s}),this._customEditors=e}async addGridCustomRender(i,t,s){if(this._grid)return void this._grid.addGridCustomRender(i,t,s);const e=new Map(this._customRenders);e.set(i,{customRender:t,detailContext:s}),this._customRenders=e}async addCustomValueFormatter(i,t){this._grid.addCustomValueFormatter(i,t)}async removeCustomValueFormatter(i){this._grid.removeCustomValueFormatter(i)}async setFocus(){this._grid.setFocus()}async handleClick(i){var t;if(this.hasToBlockEvent(i)){if(i.preventDefault(),i.stopPropagation(),!await this._dataUnit.cancelEdition())return;const s=new i.constructor(i.type,i);null===(t=i.target)||void 0===t||t.dispatchEvent(s)}this._grid&&!this._grid.contains(i.target)&&this._grid.stopEdit()}hasToBlockEvent(i){var t;return(null===(t=this._snkFilterBar)||void 0===t?void 0:t.contains(i.target))&&this.enableGridInsert&&this._dataUnit.hasNewRecord()}async handleGridLegacyConfigName(i,t){i&&i!==t&&(this.addGridLegacyConfigName(),this.loadConfig())}handleAddFormMode(){return this.enableGridInsert?l.FORM_MODE:""}openGridConfig(){this._grid.getColumnsState().then((i=>{this._snkGridConfig.columns=i.filter((i=>i.name)),this._popUpGridConfig=!0}))}closeGridConfig(){this._popUpGridConfig=!1}setGridConfig(i){this._gridConfig=i,f.assertDefaultSorting(this._gridConfig,this._dataUnit)}fixColumNameCharset(i){try{return decodeURIComponent(escape(i))}catch(t){return i}}normalizeGridConfig(i){if(!i)return i;const t=i.columns.map((i=>Object.assign(Object.assign({},i),{name:this.fixColumNameCharset(i.name)})));return Object.assign(Object.assign({},i),{columns:t})}loadConfig(){c.loadGridConfig(this.configName,this.resourceID).then((i=>{this.setGridConfig(this.normalizeGridConfig(i))})).catch((i=>{console.warn(i)}))}addGridLegacyConfigName(){this.gridLegacyConfigName&&this.configName&&c.addGridLegacyConfig(this.configName,this.gridLegacyConfigName)}gridConfigChangeHandler(i){const t=this.normalizeGridConfig(i.detail);c.saveGridConfig(t,this.configName,this.resourceID),i.stopPropagation()}modalConfigChangeHandler(i){const t=this.normalizeGridConfig(i.detail);this._grid.setColumnsState(t.columns).then((()=>{this.setGridConfig(t),this.closeGridConfig(),this.dataExporterProviderStore()})),i.stopPropagation()}async dataExporterProviderStore(){const i=this.strategyExporter===g.SERVER_SIDE?new _(this._dataUnit,this._grid):new C(this._dataUnit,this._grid);k.set("exporterProviders",Object.assign(Object.assign({},k.get("exporterProviders")),{[this.configName]:i}))}addElementID(){o.addIDInfo(this._element,null,{dataUnit:this._dataUnit})}loadGridCustomFormatters(i){i&&this._grid&&i.forEach((i=>{var t;(null===(t=i.properties)||void 0===t?void 0:t.rm_precision)&&this.addCustomValueFormatter(i.name,this._rmPrecisionCustomValueFormatter)}))}async interceptMetadataLoaded(i){return this.loadGridCustomFormatters(i.payload.fields),i}finishLoading(){this._dataUnit.addInterceptor(this.dataUnitInterceptor),f.assertDefaultSorting(this._gridConfig,this._dataUnit),this.addElementID(),null!=this.columnFilterDataSource&&(this.columnFilterDataSource.setApplication(this._application),this.columnFilterDataSource.setDataUnit(this._dataUnit))}setCustomRenders(){if(this._grid)for(const[i,t]of this._customRenders)this._grid.addGridCustomRender(i,t.customRender,t.detailContext),this._customRenders.delete(i)}setCustomEditors(){if(this._grid)for(const[i,t]of this._customEditors)this._grid.addCustomEditor(i,t.customEditor,t.detailContext),this._customEditors.delete(i)}componentWillLoad(){this._application=d.getContextValue("__SNK__APPLICATION__");let i=this._element.parentElement;for(;i;){if("SNK-DATA-UNIT"===i.tagName.toUpperCase()){this._snkDataUnit=i,this._dataUnit=this._snkDataUnit.dataUnit,this._dataUnit?this.finishLoading():this._snkDataUnit.addEventListener("dataUnitReady",(i=>{this._dataUnit=i.detail,this.finishLoading()})),this.messagesBuilder||(this.messagesBuilder=this._snkDataUnit.messagesBuilder),this._snkDataUnit.addEventListener("dataStateChange",this.handleDataStateChange.bind(this)),this._snkDataUnit.addEventListener("cancelEdition",(()=>{var i;(null===(i=this._dataState)||void 0===i?void 0:i.recordsIsEmpty)&&this._dataUnit.clearSelection()}));break}i=i.parentElement}this._rmPrecisionCustomValueFormatter=new T,this.addGridLegacyConfigName(),this.loadConfig(),this._continuousInsertUtils=new b(this._application,this.resourceID,this.configName),this.enableGridInsert&&this._continuousInsertUtils.getConfig().then((i=>this._enableContinuousInsert=i))}componentDidRender(){var i,t;this._rmPrecisionCustomValueFormatter.setGrid(this._grid),this.loadGridCustomFormatters(null===(t=null===(i=this._dataUnit)||void 0===i?void 0:i.metadata)||void 0===t?void 0:t.fields),this.setCustomRenders(),this.setCustomEditors()}async handleDataStateChange(i){this._dataState=i.detail,this._rmPrecisionCustomValueFormatter.setDataState(this._dataState)}getHeaderDisabledButtons(){var i;const t=[];return(null===(i=this._dataState)||void 0===i?void 0:i.selectionInfo)&&(this._dataState.selectionInfo.length>1&&t.push(l.CLONE,l.ATTACH,l.UPDATE),this._dataState.selectionInfo.isAllRecords()&&t.push(l.REMOVE)),t}getInvisibleButtons(){var i,t;let s=[];return this._dataUnit&&0!==this._dataUnit.records.length||s.push(l.DATA_EXPORTER),(null===(i=this._dataState)||void 0===i?void 0:i.selectionInfo.mode)===E.ALL_RECORDS&&s.push(l.ACTIONS_BUTTON),1===(null===(t=this._dataState)||void 0===t?void 0:t.selectionInfo.length)&&s.push(l.UPDATE_MULTIPLE),s}componentWillRender(){const i=this.getInvisibleButtons();this._headerTaskbarProcessor.process(this.getHeaderTaskbarId(),this.taskbarManager,this._dataState,this.getHeaderDisabledButtons(),i),this._topTaskbarProcessor.process(this.getTopTaskBarId(),this.taskbarManager,this._dataState,void 0,i),this.dataExporterProviderStore()}getHeaderTaskbarId(){var i,t;const s=this._dataState&&!!(null===(i=this._dataState.selectionInfo)||void 0===i?void 0:i.length),e={primary:this.isDetail?"snkGridHeaderTaskbar.detail":"snkGridHeaderTaskbar",secondary:this.isDetail?"snkGridHeaderTaskbar.detail":"snkGridHeaderTaskbar",singleTaskbar:this.isDetail?"snkGridHeaderTaskbar.singleTaskbar.detail":"snkGridHeaderTaskbar.singleTaskbar"}[this.presentationMode];let a=s?`${e}.selected`:`${e}.unselected`;return(null===(t=this._dataState)||void 0===t?void 0:t.isDirty)&&this.presentationMode===u.SINGLE_TASKBAR&&(a="snkGridHeaderTaskbar.singleTaskbar.finish_edition"),a}getTopTaskBarId(){var i;const t={primary:"",secondary:".secondary",singleTaskbar:".singleTaskbar"}[this.presentationMode];return(null===(i=this._dataState)||void 0===i?void 0:i.isDirty)?`snkGridTopTaskbar.finish_edition${t}`:`snkGridTopTaskbar.regular${t}`}getPrimaryButton(){return{primary:"INSERT",secondary:"",singleTaskbar:"INSERT"}[this.presentationMode]}getColumnSearch(i){return null!=this._columnSearch||(this._columnSearch=O(i,(({argument:i})=>new Promise((t=>{this._grid.filterColumns(i).then((i=>{t(i.filter((i=>!i.hidden)).map((i=>({label:i.label,value:i.name}))))}))}))),(i=>{null!=i&&this._grid.locateColumn(i.value)}))),this._columnSearch}getActionsList(){const i=[];if(this.enableGridInsert&&i.push(this._continuousInsertUtils.actionContinuousInsert(this._enableContinuousInsert,(()=>{this._enableContinuousInsert=!this._enableContinuousInsert,this._continuousInsertUtils.handleSaveConfig(this._enableContinuousInsert)}))),this.isGridInsertActive())return i;if(null!=this.taskbarManager&&null!=this.taskbarManager.getMoreOptions){const t=this.getTopTaskBarId();return i.concat(this.taskbarManager.getMoreOptions(t,this.configName,this._dataState,this.actionsList))}return i.concat(this.actionsList)}getActionsSettingsList(){return[{value:h.generateUUID(),label:this.messagesBuilder.getMessage("snkGrid.findColumn",{}),disableCloseOnSelect:!0,eagerInitialize:!0,itemBuilder:(i,t)=>this.getColumnSearch(t)}]}handleFilterConfigUpdated(i){this._showSnkFilterBar=!!i.length&&(1!==i.length||"PERSONALIZED_FILTER_GROUP"!==i[0].id||i[0].groupedItems.length>0)}getGridHeaderButtons(){return this.isGridInsertActive()?l.MORE_OPTIONS:this._headerTaskbarProcessor.buttons}isGridInsertActive(){return this.enableGridInsert&&this._dataUnit.hasNewRecord()}render(){if(this._dataUnit)return s("div",{class:"snk-grid__container ez-flex ez-flex--column ez-flex-item--auto ez-padding--large ez-box--no-outline",tabindex:"0"},s("div",{class:"snk-grid__header ez-margin-bottom--extra-small"},this._showSnkFilterBar&&s(e,null,s("snk-filter-bar",{ref:i=>this._snkFilterBar=i,title:this.filterBarTitle,dataUnit:this._dataUnit,"data-element-id":"gridFilter",class:"snk-grid__filter-bar ez-align--top",configName:this.configName,messagesBuilder:this.messagesBuilder,resourceID:this.resourceID,onConfigUpdated:i=>this.handleFilterConfigUpdated(i.detail),disablePersonalizedFilter:this.disablePersonalizedFilter,filterBarLegacyConfigName:this.filterBarLegacyConfigName,autoLoad:this.autoLoad,enableLockManagerLoadingComp:this.enableLockManagerLoadingComp}),s("hr",{class:"ez-divider-vertical ez-divider--dark ez-margin-left--medium snk-grid__header-divider"})),s("snk-taskbar",{class:"ez-padding-left--medium ez-padding-top--extra-small","data-element-id":"grid_top",key:"topTaskbar",configName:this.configName,dataUnit:this._dataUnit,messagesBuilder:this.messagesBuilder,buttons:this._topTaskbarProcessor.buttons,disabledButtons:this._topTaskbarProcessor.disabledButtons,customButtons:this._topTaskbarProcessor.customButtons,primaryButton:this.getPrimaryButton(),resourceID:this.resourceID,customContainerId:this.taskbarCustomContainerId,customSlotId:this.topTaskbarCustomSlotId,overflowStrategy:"none",actionsSettingsList:this.getActionsSettingsList()},s("slot",{name:this.topTaskbarCustomSlotId}))),s("ez-grid",{ref:i=>this._grid=i,class:(this.presentationMode===u.SECONDARY?"snk-grid-container__without-shadow ":"")+"snk-grid__table","data-element-id":"embedded",dataUnit:this._dataUnit,key:"grid-"+this._snkDataUnit.entityName,config:this._gridConfig,onConfigChange:i=>{this.gridConfigChangeHandler(i)},onEzDoubleClick:i=>this.gridDoubleClick.emit(i.detail),statusResolver:this.statusResolver,multipleSelection:this.multipleSelection,columnfilterDataSource:this.columnFilterDataSource,selectionToastConfig:this.selectionToastConfig,useEnterLikeTab:this.useEnterLikeTab,recordsValidator:this.recordsValidator,canEdit:this.canEdit,autoFocus:this.autoFocus,enableGridInsert:this.enableGridInsert,enableContinuousInsert:this._enableContinuousInsert,enableLockManagerTaskbarClick:this.enableLockManagerTaskbarClick,enableLockManagerLoadingComp:this.enableLockManagerLoadingComp,outlineMode:this.outlineMode,useSearchColumn:this.useSearchColumn,suppressHorizontalScroll:this.suppressHorizontalScroll,paginationCounterMode:this.paginationCounterMode,suppressCheckboxColumn:this.suppressCheckboxColumn,compact:this.compact},s("snk-taskbar",{id:"teste",dataUnit:this._dataUnit,configName:this.configName,messagesBuilder:this.messagesBuilder,"data-element-id":"grid_left",buttons:this.getGridHeaderButtons(),presentationMode:this.presentationMode,disabledButtons:this._headerTaskbarProcessor.disabledButtons,customButtons:this._headerTaskbarProcessor.customButtons,slot:"leftButtons",actionsList:this.getActionsList(),primaryButton:this.getPrimaryButton(),resourceID:this.resourceID,customContainerId:this.taskbarCustomContainerId,customSlotId:this.gridHeaderCustomSlotId,actionsSettingsList:this.getActionsSettingsList()},s("slot",{name:this.gridHeaderCustomSlotId}))),s("div",{class:"ez-col ez-col--sd-12 snk-grid-container__footer"},s("slot",{name:"SnkGridFooter"})),s("ez-popup",{size:"medium",heightMode:"auto",useHeader:!1,opened:this._popUpGridConfig,onEzClosePopup:()=>this.closeGridConfig()},s("snk-grid-config",{ref:i=>this._snkGridConfig=i,config:this._gridConfig,"data-element-id":this._element.getAttribute(o.DATA_ELEMENT_ID_ATTRIBUTE_NAME),selectedIndex:0,configName:this.configName,onConfigChange:i=>this.modalConfigChangeHandler(i),onConfigCancel:()=>this.closeGridConfig(),resourceID:this.resourceID})))}get _element(){return a(this)}static get watchers(){return{gridLegacyConfigName:["handleGridLegacyConfigName"]}}};I.style=".sc-snk-grid-h{--snk-grid-min-height:300px;--snk-grid-padding:var(--space--small)}.snk-grid__container.sc-snk-grid{display:flex;height:100%;width:100%;padding:var(--snk-grid-padding);outline:none}.snk-grid__header.sc-snk-grid{width:100%;display:flex;flex-wrap:nowrap;justify-content:flex-end}.snk-grid__filter-bar.sc-snk-grid{width:100%}.snk-grid__header-divider.sc-snk-grid{margin-bottom:var(--space--medium)}.snk-grid__table.sc-snk-grid{min-height:var(--snk-grid-min-height)}.snk-grid-container__without-shadow.sc-snk-grid{--ezgrid__container--shadow:unset}.snk-grid-container__footer.sc-snk-grid{background-color:var(--background--xlight, #FFF);border-radius:0 0 var(--border--radius-medium) var(--border--radius-medium);box-shadow:var(--shadow--small)}";export{I as snk_grid}