/* eslint-disable */ /* tslint:disable */ /** * This is an autogenerated file created by the Stencil compiler. * It contains typing information for all components that exist in this project. */ import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime"; import { IUserConfig } from "./lib/http/data-fetcher/fetchers/form-config-fetcher"; import { SnkMessageBuilder } from "./lib/message/SnkMessageBuilder"; import { DataUnit, FieldDescriptor, Filter, KeyboardManager, Record, UnitMetadata } from "@sankhyalabs/core"; import { IFieldConfig } from "@sankhyalabs/ezui/src/utils/interfaces/IFieldConfig"; import { IGroupConfig, IGuideConfig } from "./components/snk-form-config/FormConfigHelper"; import { IOption } from "@sankhyalabs/ezui/src/components/ez-search/ez-search"; import { ITreeItem } from "@sankhyalabs/ezui/src/components/ez-tree/interfaces/ITreeItem"; import { IAction } from "./components/snk-actions-button/actions/interfaces/IAction"; import { LayoutFormConfig } from "./lib/configs/LayoutFormConfig"; import { DataFetcher, Options } from "./lib/http/data-fetcher/DataFetcher"; import { AutorizationType } from "./lib/http/data-fetcher/fetchers/auth-fetcher"; import { AlertItem } from "@sankhyalabs/ezui/dist/types/components/ez-alert-list/ez-alert-list"; import { IAppletCallerParams } from "./lib/applet-caller/applet-caller"; import { IClientEventResponse } from "./lib/http/data-fetcher/interfaces/IClientEventResponse"; 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"; import { AttachFetcherFacadeInterface, PresentationMode } from "./lib"; import { FetcherFacade } from "./components/snk-attach/structure"; import { ICustomFormatter, ISelectionToastConfig } from "@sankhyalabs/ezui/dist/types/components/ez-grid/interfaces"; import { Action, TaskbarManager } from "./components/snk-taskbar/snk-taskbar"; import { IFormCardConfig, IFormConfig, IRecordValidator, ISummaryField } from "@sankhyalabs/ezui/dist/types/utils/form/interfaces"; import { EzGridColumn, IGridConfig, IStatusResolver, StatusResolverFunction } from "@sankhyalabs/ezui/dist/types/components/ez-grid/controller/EzGridController"; import { IExporterStrategyMode, IRecordID } from "./components/snk-data-exporter/interfaces/IRecordID"; import { ICustomEditor, ICustomRender } from "@sankhyalabs/ezui/dist/types/utils"; import { IExporterProvider } from "./components/snk-data-exporter/interfaces/IExporterProvider"; import { DataState, RowMetadata } from "./components/snk-data-unit/snk-data-unit"; import { ActionDefaultFilter } from "./components/snk-filter-bar/types/default-filters"; import { SnkFormConfigManager } from "./components/snk-form-config/SnkFormConfigManager"; import { IGuideItem } from "@sankhyalabs/ezui/dist/types/components/ez-guide-navigator/interfaces"; import { DataState as DataState1 } from "./components/snk-data-unit/snk-data-unit"; import { PropsCustomEditor } from "./components/snk-crud/interfaces/PropsCustomEditor"; import { PropsCustomRender } from "./components/snk-crud/interfaces/PropsCustomRender"; import { GuideBuilder } from "./components/snk-crud/subcomponents/GuideBuilder"; import { SnkFilterItemConfig } from "./components/snk-filter-bar/filter-item/snk-filter-item"; import { ListItem } from "./components/snk-filter-bar/filter-list/snk-filter-list"; import { ListGroup } from "@sankhyalabs/ezui/dist/types/components/ez-list/ez-list"; import { IOption as IOption2 } from "@sankhyalabs/ezui/dist/types/components/ez-combo-box/ez-combo-box"; import { IExportResult } from "./components/snk-data-exporter/data/export-result"; import { IExportConfig } from "./components/snk-data-exporter/data/export-config"; import { IExpressionGroup, IExpressionItem } from "./components/snk-personalized-filter/interfaces/IExpressionItem"; import { IPersonalizedFilter } from "./components/snk-personalized-filter/interfaces/IPersonalizedFilter"; import { SnkApplication } from "./components/snk-application/snk-application"; import { Filter as Filter1 } from "@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata"; import { EPresentationMode } from "./components/snk-filter-bar/filter-item/editors/enum/presentationMode"; import { FilterFieldsDataSource, IFilterField, IFilterLink } from "./components/snk-filter-field-search/interfaces"; import { IEzPopoverAnchorOptions } from "@sankhyalabs/ezui/dist/types/components/ez-popover/ez-popover"; import { SnkFilterItemConfig as SnkFilterItemConfig1 } from "./components/snk-filter-bar/filter-item/snk-filter-item"; import { ListItem as ListItem1 } from "./components/snk-filter-bar/filter-list/snk-filter-list"; import { Period } from "./components/snk-filter-bar/filter-item/editors/snk-filter-period"; import { IFormViewField } from "@sankhyalabs/ezui/dist/types/components/ez-form-view/interfaces/IFormViewField"; import { FormMetadata } from "@sankhyalabs/ezui/dist/collection/utils/form"; import { ICustomEditor as ICustomEditor1 } from "@sankhyalabs/ezui/dist/types/utils/customEditor/interfaces/ICustomEditor"; import { IMultiSelectionListDataSource } from "@sankhyalabs/ezui/dist/types/components/ez-multi-selection-list/interfaces/IMultiSelectionListDataSource"; import { PresentationMode as PresentationMode1 } from "./lib/@types"; import { PrintSelectorResponse } from "./components/snk-print-selector/snk-print-selector"; import { PendingPrintJobData } from "./lib/utils/PrintUtils"; import { IBreadcrumbItem } from "@sankhyalabs/ezui/dist/types/components/ez-breadcrumb/ez-breadcrumb"; import { Action as Action1, CustomButton } from "./components/snk-taskbar/snk-taskbar"; export namespace Components { interface ConfigHeader { "configOptions": Array; "hasChanges"?: boolean; "messagesBuilder": SnkMessageBuilder; "optionConfigChanged": boolean; "selectedConfig": IUserConfig; } interface ConfigsButton { "configOptions": Array; "hasChanges": boolean; "messagesBuilder": SnkMessageBuilder; "selectedConfig": IUserConfig; } interface FieldConfig { "dataUnit"?: DataUnit; "fieldConfig": IFieldConfig; "fieldDescriptor": FieldDescriptor; "messagesBuilder"?: SnkMessageBuilder; "show": (_anchorElement: HTMLElement) => Promise; } interface FieldItem { "dataUnit"?: DataUnit; "fieldConfig": IFieldConfig; "messagesBuilder"?: SnkMessageBuilder; "onLayoutConfig": boolean; } interface FieldsLayout { "addFieldToLayout": (incomingField: IFieldConfig) => Promise; "dataUnit"?: DataUnit; "groupsList": IGroupConfig[]; "guideNames": string[]; "messagesBuilder": SnkMessageBuilder; "selectedGuide": IGuideConfig; } interface FieldsSelector { "availableFields": IFieldConfig[]; "dataUnit"?: DataUnit; "messagesBuilder": SnkMessageBuilder; } interface GuidesConfigurator { "guidesList": IGuideConfig[]; "messagesBuilder": SnkMessageBuilder; "selectedGuide": IGuideConfig; } interface PesquisaGrid { /** * Registros da grade */ "dataSource": Record[]; /** * Campo que representa a descrição do registro */ "descriptionField": string; /** * Nome da entidade representada na grade */ "entityName": string; /** * Campos que representam as colunas da grade. */ "metadata": UnitMetadata; /** * Campo que representa a chave primária do registro */ "pkField": string; /** * Define se deve carregar configurações da grade */ "shouldLoadConfig": boolean; } interface PesquisaTree { /** * Define se permite seleção de items não analíticos */ "allowsNonAnalytic": boolean; "applyFilter": () => Promise; /** * Argumentos que serão usados ao chamar a função treeLoader. */ "argument": string; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * Informa se a árvore hierárquica deve ou não ser carregada. */ "shouldLoadTree": boolean; /** * Função responsável por carregar a árvore hierárquica do componente */ "treeLoader"?: (text: string) => Promise>; } interface SnkActionsButton { } interface SnkActionsForm { /** * Ação na qual os parâmetros serão preenchidos. */ "action": IAction; /** * Responsável por retornar a ação com os parâmetros preenchidos. */ "applyParameters": (action: IAction) => void; /** * Responsável por abrir a popup. */ "openPopup": () => Promise; } interface SnkApplication { /** * 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; /** * 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. * @returns * @async */ "addPendingAction": (actionsLocker: string, action: Function) => Promise; /** * 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; /** * 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; /** * 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. * @returns A resposta do Service Broker. * @async */ "callServiceBroker": (serviceName: string, payload: string | Object, options?: Options) => Promise; "clearPopUpTitle": () => Promise; /** * Fecha o Modal e limpa o conteúdo. * @returns * @async */ "closeModal": () => Promise; /** * Fecha o Popup e limpa o conteúdo. * @returns * @async */ "closePopUp": () => Promise; /** * Nome da configuração utilizada para salvar as preferências dos blocos de construção. */ "configName": string; /** * 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; /** * 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; /** * 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; /** * 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 | IOption1>; /** * Realiza a pesquisa de registros 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 */ "executePreparedSearchPlus": (mode: string, argument: string, options: any) => Promise | IOption1>; /** * 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?: ISearchCtxOptions) => Promise | 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>; /** * 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 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; /** * Obtém o nome (label) da aplicação. * @returns O nome da aplicação. * @async */ "getAppLabel": () => Promise; /** * Retorna o path relativo da aplicação. * @returns O caminho relativo da aplicação. * @async */ "getApplicationPath": () => Promise; /** * 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; /** * 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; /** * 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; /** * Retorna a instância do DataFetcher utilizado pelo application. * @returns O DataFetcher da aplicação. * @async */ "getDataFetcher": () => Promise; /** * 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; /** * 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; /** * 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; /** * 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; /** * Obtém o controlador de teclado. * @returns O gerenciador de teclado. * @async */ "getKeyboardManager": () => Promise; /** * Obtém o notificador de Layout de formulário. * @returns O configurador de Layout do Formulário. * @async */ "getLayoutFormConfig": () => Promise; /** * Obtém o resourceID da tela em questão. * @returns O ID do recurso da aplicação. * @async */ "getResourceID": () => Promise; /** * 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; /** * Obtém o UserId do usuário logado. * @returns O ID do usuário. * @async */ "getUserID": () => Promise; /** * 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 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; /** * 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; /** * 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) => Promise; /** * 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; /** * Inicializa o onboarding para uma chave específica. * @param onboardingKey - A chave do onboarding a ser iniciado. * @returns * @async */ "initOnboarding": (onboardingKey: string) => Promise; /** * Obtém `true` caso a tela esteja em modo de debug. */ "isDebugMode": () => Promise; /** * Retorna se uma feature flag global está ativa ou não. */ "isFeatureActive": (featureName: string) => Promise; /** * 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; /** * 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; /** * 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; /** * 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) => Promise>; /** * 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; /** * 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; /** * 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; /** * 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) => Promise; /** * Remove um client event do DataFetcher da aplicação. * @param eventID - Nome do evento a ser removido. * @returns * @async */ "removeClientEvent": (eventID: String) => Promise; /** * 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; "setPopUpTitle": (title: string) => Promise; /** * 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. * @returns * @async */ "setSearchFilterContext": (name: string, value: string) => Promise; /** * 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) => Promise; /** * Exibe o conteúdo passado em um Modal. * @param content - O elemento HTML a ser exibido no modal. * @returns * @async */ "showModal": (content: HTMLElement) => Promise; /** * 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; "showScrimApp": (active: boolean) => Promise; /** * 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; /** * 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; /** * Atualiza o cache de dataunits da aplicação. * @param oldName - Nome do dataunit que está em cache (será removido). * @param dataUnitName - Nome do dataunit que 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; /** * 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. * @returns * @async */ "webConnection": (keyPort: string, methodName: string, params: IAppletCallerParams) => Promise; /** * Retorna uma promise que será resolvida quando o snk-application estiver carregado e registrado no ApplicationContext. * @returns O componente SnkApplication carregado. * @async */ "whenApplicationReady": () => Promise; } interface SnkAttach { /** * DataUnit responsável por carregar os dados. */ "dataUnit": DataUnit; /** * DataUnitBuilder responsável por implementar dados a serem utilizados no DataUnit. */ "dataUnitBuilder": FetcherFacade; /** * Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. */ "entityName": string; /** * Fetcher responsável por carregar os dados do DataUnit. */ "fetcher": AttachFetcherFacadeInterface; /** * FetcherType define o tipo de fetcher responsável por carregar os dados do DataUnit. */ "fetcherType": TFetcherType; /** * Chave da configuração legado da grid. */ "gridLegacyConfigName": string; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * Identificação do registro pai. */ "registerKey": string; } interface SnkClientConfirm { /** * Retorno quando usuário confirmar. */ "accept": () => void; /** * Retorno quando usuário cancelar. */ "cancel": () => void; /** * Mensagem da popup. */ "message": string; /** * Responsável por abrir a popup. */ "openPopup": () => Promise; /** * Título da popup. */ "titleMessage": string; } interface SnkConfigurator { /** * Fecha a janela de configuração. */ "close": () => Promise; /** * Usado para guardar ou recuperar as configurações do formulário. */ "configName": string; /** * ID do container que contém os elementos customizados do configurator. */ "customContainerId": string; /** * Define se o LayoutFormConfig será exibido no configurador. */ "layoutFormConfig": boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * Exibe a janela de configuração. */ "open": () => Promise; /** * Identificador de recursos como configurações e acesso. */ "resourceID": string; /** * Usado para exibir os botões de ação */ "showActionButtons": boolean; /** * Define qual modo de visualização está ativo. */ "viewMode": VIEW_MODE; } interface SnkCrud { /** * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. */ "actionsList": Array; /** * Registra um editor customizado para campos da grade e formulário. */ "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise; /** * Registra um formatador de valores para uma coluna da grid. */ "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise; /** * Registra um render customizado para colunas da grid. */ "addGridCustomRender": (fieldName: string, customRender: ICustomRender) => Promise; /** * Define se a grid será focada ao ser carregada. */ "autoFocus"?: boolean; /** * Define se a carga dos dados será feita assim que o componente for carregado. */ "autoLoad"?: boolean; /** * Usado para fechar o configurator do CRUD */ "closeConfigurator": () => Promise; /** * Usado para salvar as configurações dos blocos de construção. */ "configName": string; /** * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). */ "disablePersonalizedFilter": boolean; /** * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) */ "domainMessagesBuilder": string; /** * Ativa inserção de registros no modo grade. */ "enableGridInsert"?: boolean; /** * Define se o componente deve usar o LockManager para controle de carregamento da aplicação */ "enableLockManagerLoadingComp"?: boolean; /** * Ativa o gerenciamento de locks na grade pela Taskbar. */ "enableLockManagerTaskbarClick"?: boolean; /** * Chave da configuração legado da barra de filtros. */ "filterBarLegacyConfigName": string; /** * Título que será apresentado na barra de filtros */ "filterBarTitle": string; /** * Chave da configuração legado do formulário. */ "formLegacyConfigName": string; /** * Retorna o elemento da filter-bar da grade. */ "getFilterBar": () => Promise; /** * Usado para alternar a visão entre GRID e FORM externamente. */ "goToView": (mode: string) => Promise; /** * Chave da configuração legado da grade. */ "gridLegacyConfigName": string; /** * Ignora os campos "somente leitura" no modo de inserção. */ "ignoreReadOnlyFormFields"?: boolean; /** * Define se o LayoutFormConfig será exibido no configurador. */ "layoutFormConfig": boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * Habilita a edição de múltiplos registros simultâneos. */ "multipleEditionEnabled": boolean; /** * Determina se pode haver mais de uma linha selecionada na grade. */ "multipleSelection": boolean; /** * Usado para abrir o configurator do CRUD */ "openConfigurator": () => Promise; /** * Define se a grid será focada ao ser carregada. */ "paginationCounterMode"?: 'show' | 'hidden' | 'auto'; /** * Altera o modo de apresentação dos botões do snk-taskbar. */ "presentationMode": PresentationMode; /** * Validador responsável por checar a integridade das informações do registro. */ "recordsValidator": IRecordValidator; /** * Faz o recarregamento da filter-bar do crud, buscando o state no servidor. */ "reloadFilterBar": () => Promise; /** * Remove o formatador de valores de uma coluna da grid. */ "removeCustomValueFormatter": (columnName: string) => Promise; /** * Configuração da seleção de grade no toast. */ "selectionToastConfig": ISelectionToastConfig; /** * Define uma função para configurar um título cusotmizado no modo formulário. */ "setCustomFormTitle": () => string; /** * Altera/adiciona uma propriedade nos metadados do campo. */ "setFieldProp": (fieldName: string, propName: string, value: any) => Promise; /** * Usado para exibir os botões de ação do snk-configurator */ "showActionButtons": boolean; /** * Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } */ "statusResolver": IStatusResolver | StatusResolverFunction; /** * Modo de exportação dos dados. */ "strategyExporter": IExporterStrategyMode; /** * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. */ "taskbarManager": TaskbarManager; /** * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. */ "useEnterLikeTab": boolean; } interface SnkCustomSlotElements { /** * Nome do slot onde os elementos customizados deverão aparecer. */ "slotName": string; } interface SnkDataExporter { /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * Provedor das informações para exportação dos dados. */ "provider": IExporterProvider; } interface SnkDataUnit { /** * Executado após a ação de salvar. * @param dataUnit - A instância do DataUnit. * @returns */ "afterSave": (dataUnit: DataUnit) => void; /** * Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação. * @param dataUnit - A instância do DataUnit. * @returns `false` para cancelar a ação, `true` para continuar. */ "beforeSave": (dataUnit: DataUnit) => boolean | Promise; /** * Usado para obter configuração de metadados. * @type {string} */ "configName": string; /** * Controla o estado atual dos dados. * @type {DataState} */ "dataState": DataState; /** * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. * @type {DataUnit} */ "dataUnit": DataUnit; /** * Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. * @type {string} */ "dataUnitName": string; /** * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) * @type {string} */ "domainMessagesBuilder": string; /** * Determina qual a entidade que representa os dados em questão. * @type {string} */ "entityName": string; /** * Obtém o dataUnit. * @returns Uma promessa que resolve com a instância do DataUnit. * @async */ "getDataUnit": () => Promise; /** * Retorna os campos que possuem a propriedade "rm_precision" (Row Metadata Precision). * @returns Uma promessa que resolve com um array de nomes de campos. * @async */ "getFieldsWithRmPrecision": () => Promise; /** * Retorna os campos que possuem a propriedade "rmp" (Row Metadata Provider). * @returns Uma promessa que resolve com um array de nomes de campos. * @async */ "getFieldsWithRmp": () => Promise; /** * Busca os metadados da linha selecionada. * @param record - O registro ou ID do registro para o qual buscar os metadados. Se omitido, usa o registro selecionado. * @returns Uma promessa que resolve com os metadados da linha. * @async */ "getRowMetadata": (record?: Record | string) => Promise; /** * Método que retorna a lista de IDs dos registros selecionados. * @returns Retorna uma promessa que resolve com a lista de IDs dos registros selecionados. * @async */ "getSelectedRecordsIDsInfo": () => Promise>; /** * Responsável por evitar a mensagem de sucesso ao salvar. * @type {boolean} */ "ignoreSaveMessage": boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. * @type {SnkMessageBuilder} */ "messagesBuilder": SnkMessageBuilder; /** * Determina quantas linhas são retornadas por página. * @type {number} * @default 150 */ "pageSize": number; /** * Identificador de recursos como configurações e acesso. * @type {string} */ "resourceID": string; /** * Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. * @type {boolean} * @default true */ "useCancelConfirm": boolean; } interface SnkDefaultFilter { /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage": (key: string, props?: any) => string; /** * Informa se já existe um filtro padrão criado. */ "hasDefaultFilter": boolean; } interface SnkDetailView { /** * Registra um editor customizado para campos da grade e formulário. */ "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise; /** * Registra um render customizado para colunas da grid. */ "addGridCustomRender": (fieldName: string, customRender: ICustomRender) => Promise; "branchGuide": IGuideItem; /** * Define se a edição está habilitada na grid. */ "canEdit": boolean; /** * Muda o modo de visualização do componente entre VIEW_MODE.GRID e VIEW_MODE.FORM * @param mode - Novo modo que o componente deve ser apresentado. */ "changeViewMode": (mode: VIEW_MODE) => Promise; /** * Abre o configurador de grid. */ "configGrid": () => Promise; /** * Registra um editor customizado para campos da grade e formulário. */ "customEditors": PropsCustomEditor; /** * Render customizados da grade. */ "customRenders": PropsCustomRender; /** * Representa o estado do dataUnit detail. */ "dataState": DataState1; /** * Instância do DataUnit detail. */ "dataUnit": DataUnit; /** * Determina todo o caminho desde o pai até chegar neste nível */ "dataUnitName": string; /** * Nome da entidade detail. */ "entityName": string; /** * Gerenciador de configuração do formulário. */ "formConfigManager": SnkFormConfigManager; /** * Caminho do identificador da guia vinculada. */ "guideItemPath": Array; /** * Descrição amigável do cadastro detalhe. */ "label": string; "messagesBuilder": SnkMessageBuilder; /** * Altera o modo de apresentação dos botões do snk-taskbar. */ "presentationMode": PresentationMode; /** * Identificador de recursos como configurações e acesso. */ "resourceID": string; /** * Representa o formulário selecionado. */ "selectedForm": string; "showUp": () => Promise; /** * Define o identificador do container de elementos customizados da Taskbar. */ "taskbarCustomContainerId": string; } interface SnkEntityList { /** * Configurações para carregar os dados do componente */ "config": SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage": string; /** * Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida */ "maxHeightList": string; "reloadList": () => Promise; /** * Método que possibilita alterar como o item da lista vai ser apresentado. Observação: No React ele se transforma em VNode e não HTMLElement. */ "rightListSlotBuilder": (item: ListItem, group?: ListGroup) => HTMLElement | string; /** * Define o valor do componente */ "value": IOption2; } interface SnkExporterEmailSender { "close": () => Promise; "getMessage": (key: string, params?: any) => string; "open": (config: IExportConfig) => Promise; } interface SnkExpressionGroup { /** * Identificador da unidade de dados. */ "entityURI": string; /** * Id do filtro que será carregado. */ "filterId": string; "getExpressionGroup": () => Promise; /** * Grupo que será representado visualmente pelo componente. */ "group": IExpressionGroup; /** * Define se o filtro em questão é um filtro padrão. */ "isDefaultFilter": boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * Tamanho do elemento pai do grupo */ "parentTop": number; } interface SnkExpressionItem { /** * Controla a exibição do botão Remover. */ "canRemove": boolean; /** * Identificador da unidade de dados. */ "entityURI": string; /** * Expressão que será representada visualmente. */ "expression": IExpressionItem; /** * Define se o filtro em questão é um filtro padrão. */ "isDefaultFilter": boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; } interface SnkFilterAdvancedMode { /** * Propriedade que mantém informações relacionadas ao SnkApplication. */ "application": SnkApplication; /** * Propriedade que contém informações do filtro personalizado. */ "filterAssistent": IPersonalizedFilter; } interface SnkFilterAssistentMode { /** * Propriedade que mantém informações relacionadas ao SnkApplication. */ "application": SnkApplication; /** * Responsável por receber a URI da entidade. */ "entityUri": string; /** * Propriedade que contém informações do filtro personalizado. */ "filterAssistent": IPersonalizedFilter; /** * Id do filtro que será carregado. */ "filterId": string; /** * Define se o filtro em questão é um filtro padrão. */ "isDefaultFilter": boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; } interface SnkFilterBar { /** * @description Adiciona um item de filtro. * @async * @param filterItem - Item a ser adicionado, caso o item já exista com o ID, ele não será adicionado novamente. * @return Retorna uma Promise que resolve quando o item for adicionado. */ "addFilterItem": (filterItem: SnkFilterItemConfig) => Promise; /** * @description Função chamada depois de aplicar os filtros. */ "afterApplyConfig"?: () => void; /** * @description Define se a carga dos dados será feita assim que o componente for carregado. */ "autoLoad"?: boolean; /** * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. */ "configName": string; /** * @description Loader customizado para carregar as configurações. * @param configName - Nome da configuração. * @param resourceId - ID do recurso. * @param options - Opções adicionais. * @returns Retorna a configuração dos filtros. */ "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise>; /** * @description Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. */ "dataUnit": DataUnit; /** * @description Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). */ "disablePersonalizedFilter": boolean; /** * @description Define se o componente deve usar o LockManager para controle de carregamento. */ "enableLockManagerLoadingComp"?: boolean; /** * @description Chave da configuração legada da barra de filtros. */ "filterBarLegacyConfigName": string; /** * @description Lista todos os filtros disponíveis ao usuário. */ "filterConfig": Array; /** * @description Configuração customizada dos filtros. * @param config - Lista de configurações de filtros. */ "filterCustomConfig"?: Array; /** * @description Intercepta a configuração dos filtros antes de serem aplicadas. * @param config - Lista de configurações de filtros. * @returns Retorna a lista de configurações de filtros. */ "filterCustomConfigInterceptor"?: (config: Array) => Array; /** * @description Retorna um item de filtro pelo ID. * @async * @param id - ID do item de filtro. * @returns O item de filtro correspondente ou undefined se não for encontrado. */ "getFilterItem": (id: string) => Promise; "getFilters": () => Promise; /** * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * @description Modo de apresentação da barra de filtros. */ "mode": "regular" | "button" | "hidden"; /** * @description Faz o recarregamento da barra de filtros buscando o state no servidor. * @async * @return Retorna uma Promise que resolve quando o recarregamento for concluído. */ "reload": () => Promise; /** * @description Remove um item de filtro. * @async * @param filterID - ID do item a ser removido. * @returns Retorna o item de filtro removido, ou undefined caso não seja encontrado. */ "removeFilterItem": (filterID: string) => Promise; /** * @description Identificador de recursos como configurações e acesso. */ "resourceID": string; /** * @description Abre o modal de filtros. * @async */ "showFilterModal": () => Promise; /** * @description Título que será apresentado na barra de filtros. */ "title": string; /** * @description Atualiza um item do filtro. * @async * @param newFilterItem - Item com as informações atualizadas, caso o item não seja encontrado no array, ele não será modificado. * @return Retorna uma Promise que resolve quando a atualização for concluída. */ "updateFilterItem": (newFilterItem: SnkFilterItemConfig) => Promise; } interface SnkFilterBinarySelect { /** * Limpa o valor do componente restaurando o valor original da configuração. */ "clearValue": () => Promise; /** * Define as configurações do componente snk-filter-binary-select */ "config": SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage": string; /** * Define a variação do componente */ "presentationMode": EPresentationMode; /** * Redefine os valores padrão do componente. */ "resetValues": () => Promise; /** * Define o foco no componente snk-filter-binary-select. */ "setFocus": () => Promise; /** * Define o valor do componente snk-filter-binary-select */ "value": any; } interface SnkFilterCheckboxList { /** * Limpa o valor do componente restaurando o valor original da configuração. */ "clearValue": () => Promise; /** * Define as configurações do componente snk-filter-multi-select */ "config": SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage": string; /** * Define o foco no componente snk-filter-checkbox-list. */ "setFocus": () => Promise; } interface SnkFilterDetail { "clearValue": () => Promise; /** * Define as configurações do componente snk-filter-detail. */ "config": SnkFilterItemConfig; /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage": (key: string, props?: any) => string; /** * Define se o filtro pode ser removido. */ "removalBlocked": boolean; /** * Define o foco no campo do editor. */ "setFocusField": () => Promise; /** * Controla a visibilidade do botão de fixar elemento */ "showHardFixed": boolean; } interface SnkFilterFieldSearch { /** * Filtra a fonte de dados do componente. * @param filterText - Texto para filtrar a fonte de dados. * @throws {Error} - Quando o componente estiver com a propriedade searchable como true. */ "applyFilter": (filterText: string) => Promise; /** * Define a fonte de dados que o componente vai utilizar para carregamento dos campos. */ "fieldsDataSource": FilterFieldsDataSource; /** * Define se o componente irá possuir um campo de pesquisa. */ "searchable": boolean; /** * /** Realiza a abertura do componente abaixo do elemento HTML informado e faz a primeira carga de dados. * @param element - Elemento HTML onde o snk-filter-field-search irá se posicionar abaixo. * @param options - opções para regular o posicionamento do componente. */ "show": (element?: HTMLElement, options?: IEzPopoverAnchorOptions) => Promise; } interface SnkFilterItem { /** * Define as configurações do componente snk-filter-item. */ "config": SnkFilterItemConfig; /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage": (key: string, props?: any) => string; /** * Oculta os detalhes de um item da lista. */ "hideDetail": () => Promise; /** * Usado para controlar a visibilidade dos chips de filtros */ "showChips": boolean; /** * Exibe os detalhes de um item da lista. */ "showUp": (open?: boolean) => Promise; } interface SnkFilterList { /** * Define a classe CSS a ser adicionada no botão (usado principalmente para sinalizar o filtro aplicado). */ "buttonClass": string; /** * Define o texto exibido quando a lista está vazia. */ "emptyText": string; /** * Define o texto exibido no componente de busca. */ "findFilterText": string; /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage": (key: string, props?: any) => string; /** * Oculta os detalhes do componente snk-filter-list. */ "hideDetail": () => Promise; /** * Define o ícone usado no ez-button do filtro. */ "iconName": string; /** * Guarda a lista de filtros. */ "items": Array; /** * Define o label usado no ez-button do filtro. */ "label": string; } interface SnkFilterModal { /** * Ação executada ao adicionar um filtro personalizado */ "addPersonalizedFilter": (isDefault?: boolean) => void; /** * Ação executada ao aplicar os filtros */ "applyFilters": (updatedFilterConfig: Array) => void; /** * Ação disparada ao fechar o modal */ "closeModal": () => void; /** * Nome da configuração. Serve para distinguir várias instâncias do componente. */ "configName": string; /** * Ação executada ao deletar um filtro personalizado */ "deletePersonalizedFilter": (filter: IPersonalizedFilter, configName: string, isDefault?: boolean) => void; /** * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). */ "disablePersonalizedFilter": boolean; /** * Ação executada ao editar um filtro personalizado */ "editPersonalizedFilter": (id:string, isDefault?: boolean) => void; /** * Filtros a serem apresentados */ "filterConfig": Array; /** * @description Intercepta a configuração dos filtros antes de serem aplicadas. * @param config - Lista de configurações de filtros. * @returns Retorna a lista de configurações de filtros. */ "filterCustomConfigInterceptor"?: (config: Array) => Array; /** * Guarda o filtro a ser deletado no Apply do modal */ "filterDefaultToDelete": SnkFilterItemConfig; /** * Guarda filtros a serem deletados no Apply do modal */ "filtersToDelete": IPersonalizedFilter[]; /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage": (key: string, props?: any) => string; /** * Define se o modal está aberto ou não. */ "opened": boolean; } interface SnkFilterModalItem { /** * Nome da configuração. Serve para distinguir várias instâncias do componente. */ "configName": string; "filterItem": SnkFilterItemConfig; /** * Identificador de recursos como configurações e acesso. */ "resourceID": string; } interface SnkFilterMultiSelect { /** * Limpa o valor do componente restaurando o valor original da configuração. */ "clearValue": () => Promise; /** * Define as configurações do componente snk-filter-multi-select */ "config": SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage": string; /** * Define o foco no componente snk-filter-multi-select. */ "setFocus": () => Promise; /** * Define o valor do componente snk-filter-multi-select */ "value": any; } interface SnkFilterNumber { /** * Limpa o valor do componente restaurando o valor original da configuração. */ "clearValue": () => Promise; /** * Define as configurações do componente snk-filter-number */ "config": SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage": string; /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage": (key: string, props?: any) => string; /** * Define a variação do componente */ "presentationMode": EPresentationMode; /** * Define o foco no componente snk-filter-number */ "setFocus": () => Promise; /** * Exibe o componente snk-filter-number */ "show": () => Promise; /** * Define o valor do componente snk-filter-number */ "value": FilterNumberValueType; } interface SnkFilterParamConfig { /** * Fecha o modal de configuração de valor variável */ "close": () => Promise; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * Abre o modal de configuração de valor variável */ "open": (expressionItem: IExpressionItem) => Promise; } interface SnkFilterPeriod { /** * Limpa o valor do componente restaurando o valor original da configuração. */ "clearValue": () => Promise; /** * Define as configurações do componente snk-filter-period */ "config": SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage": string; /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage": (key: string, props?: any) => string; /** * Define a variação do componente */ "presentationMode": EPresentationMode; /** * Define o foco no componente snk-filter-period. */ "setFocus": () => Promise; /** * Exibe o componente snk-filter-period */ "show": () => Promise; /** * Define o valor do componente snk-filter-period */ "value": Period; } interface SnkFilterSearch { /** * Limpa o valor do componente restaurando o valor original da configuração. */ "clearValue": () => Promise; /** * Define as configurações do componente snk-filter-search */ "config": SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage": string; /** * Define o foco no componente snk-filter-search. */ "setFocus": () => Promise; /** * Define o valor do componente snk-filter-search */ "value": IOption2; } interface SnkFilterText { /** * Limpa o valor do componente restaurando o valor original da configuração. */ "clearValue": () => Promise; /** * Define as configurações do componente snk-filter-text. */ "config": SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage": string; /** * Define o foco no componente snk-filter-text. */ "setFocus": () => Promise; /** * Define o valor do componente snk-filter-text. */ "value": string; } interface SnkForm { /** * Registra um editor customizado para campos do formulário. * @async * @param fieldName - Nome do campo. * @param customEditor - Editor customizado. * @returns */ "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise; /** * Nome usado para guardar/recuperar as configurações do formulário. */ "configName": string; /** * Chave da configuração legada do formulário. */ "formLegacyConfigName": string; /** * Fecha a janela de configurações do formulário. * @async * @returns */ "hideConfig": () => Promise; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * Validador responsável por checar a integridade das informações do registro. */ "recordsValidator": IRecordValidator; /** * Identificador de recursos como configurações e acesso. */ "resourceID": string; /** * Altera/adiciona uma propriedade nos metadados do campo. * @async * @param fieldName - Nome do campo. * @param propName - Nome da propriedade. * @param value - Valor da propriedade. * @returns */ "setFieldProp": (fieldName: string, propName: string, value: any) => Promise; /** * Exibe a janela de configurações do formulário. * @async * @returns */ "showConfig": () => Promise; /** * Valida o formulário. * @async * @returns * @description Este método executa a validação do formulário, verificando se todos os campos estão preenchidos corretamente de acordo com as regras definidas. Se a validação falhar, uma exceção será lançada com os detalhes dos erros encontrados. Caso contrário, o método será resolvido sem erros. */ "validate": () => Promise; } interface SnkFormConfig { /** * Campos de configuração de formulário. */ "configManager": SnkFormConfigManager; /** * Repositório de dados, controla a manipulação dos dados. */ "dataUnit": DataUnit; /** * Ignora os campos "somente leitura" no modo de inserção. */ "ignoreReadOnlyFormFields"?: boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; } interface SnkFormSummary { /** * Define se o card está contraído ou não. */ "contracted": boolean; /** * Define se o card está fixado ou não. */ "fixed": boolean; /** * Define quais são as informações exibidas no modo contraído. Cada atributo será exibido com seu respectivo valor. */ "summary": { [key:string] : any }; } interface SnkFormView { /** * Registra um editor customizado para campos da grade e formulário */ "addCustomEditor": (fieldName: string, customEditor: ICustomEditor1, detailContext?: string) => Promise; /** * Define se o botão de expandir deve ser apresentado. */ "canExpand": boolean; /** * Define se o botão de fixar deve ser apresentado. */ "canFix": boolean; /** * Define se o componente será apresentado no modo default ou no modo resumido. */ "contracted": boolean; /** * Registra um editor customizado para campos da grade e formulário. */ "customEditors": PropsCustomEditor; /** * Define a instância do DataUnit que deve se ligar ao formulário. */ "dataUnit": DataUnit; /** * Campo para o buscador de campos. */ "fieldSearch": HTMLEzSearchElement; /** * Determina o campo que deve ficar em evidência. */ "fieldToFocus": string; /** * Lista de campos para serem apresentados no formulário. */ "fields": Array; /** * Lista de propriedades que serão alteradas/adicionadas por coluna. */ "fieldsProps": object; /** * Define se o card está fixado ou não. */ "fixed": boolean; /** * Metadados de campos que definem quais campos são obrigatórios, quais devem ser limpos durante a cópia de registros e valores padões dos campos. */ "formMetadata": FormMetadata; /** * Texto para ser apresentado como título do componente */ "label": string; /** * Caminho amigável para se chegar a este detalhe. */ "levelPath": string; /** * Identificador único do componente, esse é utilizado para identificar o componente no evento de `snkContentCardChanged` */ "name": string; /** * Validador responsável por checar a integridade das informações do registro. */ "recordsValidator": IRecordValidator; /** * Altera/adiciona uma propriedade nos metadados do campo. */ "setFieldProp": (fieldName: string, propName: string, value: any) => Promise; /** * Exibe a busca de campos ancorada ao container de cabeçalho do snk-form-view. */ "showSearchField": () => Promise; "showUp": () => Promise; "summaryFields": Array; } interface SnkGrid { /** * Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`. */ "actionsList": Array; /** * Registra um editor customizado para um campo da grade ou formulário. * @async * @description Adiciona um componente de edição personalizado para um campo específico. Este editor será usado tanto na edição em linha na grade quanto em formulários de detalhe. * @param fieldName O nome do campo que receberá o editor customizado. * @param customEditor A instância do editor customizado. * @param detailContext O contexto de detalhe onde o editor será aplicado (opcional). * @returns Uma promessa que é resolvida quando o editor é registrado. */ "addCustomEditor": (fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise; /** * Registra um formatador de valor customizado para uma coluna da grade. * @async * @description Adiciona uma função de formatação personalizada para os valores de uma coluna específica, afetando como os dados são exibidos. * @param columnName O nome da coluna que receberá o formatador. * @param customFormatter A instância do formatador de valor. * @returns Uma promessa que é resolvida quando o formatador é registrado. */ "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise; /** * Registra um renderizador customizado para uma coluna da grade. * @async * @description Adiciona um componente de renderização personalizado para uma coluna específica, permitindo a exibição de conteúdo customizado nas células. * @param fieldName O nome do campo (coluna) que receberá o renderizador customizado. * @param customRender A instância do renderizador customizado. * @param detailContext O contexto de detalhe onde o renderizador será aplicado (opcional). * @returns Uma promessa que é resolvida quando o renderizador é registrado. */ "addGridCustomRender": (fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise; /** * Define se a grade receberá o foco automaticamente ao ser carregada. */ "autoFocus"?: boolean; /** * Define se os dados serão carregados automaticamente na inicialização do componente. */ "autoLoad"?: boolean; /** * Define se a edição de dados na grade está habilitada. */ "canEdit": boolean; /** * Define o data source para o filtro de colunas. */ "columnFilterDataSource": IMultiSelectionListDataSource; /** * Define se a grade deve ser exibida em modo compacto. */ "compact": boolean; /** * Nome usado para salvar e recuperar a configuração da grade. */ "configName": string; /** * Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros) e no modal lateral de filtros (contêiner de filtros personalizados). */ "disablePersonalizedFilter": boolean; /** * Habilita a inserção de registros diretamente na grade. */ "enableGridInsert"?: boolean; /** * Define se o componente deve usar o LockManager para controle de carregamento da aplicação. */ "enableLockManagerLoadingComp"?: boolean; /** * Ativa o gerenciamento de locks na grade pela Taskbar. */ "enableLockManagerTaskbarClick"?: boolean; /** * Chave da configuração legada da barra de filtros. */ "filterBarLegacyConfigName": string; /** * Título que será apresentado na barra de filtros. */ "filterBarTitle": string; /** * @description Configuração customizada dos filtros. * @param config - Lista de configurações de filtros. */ "filterCustomConfig"?: Array; /** * @description Intercepta a configuração dos filtros antes de serem aplicadas. * @param config - Lista de configurações de filtros. * @returns Retorna a lista de configurações de filtros. */ "filterCustomConfigInterceptor"?: (config: Array) => Array; /** * Retorna o elemento da barra de filtros da grade. * @async * @description Este método permite acessar o elemento da barra de filtros, que pode ser útil para manipulações adicionais ou para obter o estado atual dos filtros aplicados. * @returns O elemento da barra de filtros. */ "getFilterBar": () => Promise; /** * Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade. */ "gridHeaderCustomSlotId": string; /** * Chave da configuração legada da grade. */ "gridLegacyConfigName": string; /** * Fecha a janela de configurações da grade. * @async * @description Este método fecha o pop-up de configuração de colunas da grade. * @returns Uma promessa que é resolvida quando a janela de configuração é fechada. */ "hideConfig": () => Promise; /** * Determina se a grade está vinculada a um detalhe de outra tela. */ "isDetail": boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * Habilita a edição de múltiplos registros simultaneamente. */ "multipleEditionEnabled": boolean; /** * Determina se a seleção de múltiplas linhas é permitida. */ "multipleSelection": boolean; /** * Altera a aparência das bordas e sombras do componente. Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout). Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up). */ "outlineMode"?: boolean; /** * Define o modo de exibição do contador de paginação. */ "paginationCounterMode"?: 'show' | 'hidden' | 'auto'; /** * Altera o modo de apresentação dos botões do `snk-taskbar`. */ "presentationMode": PresentationMode1; /** * Validador responsável por verificar a integridade dos dados de um registro. */ "recordsValidator": IRecordValidator; "refreshColumnFilterDataSource": () => Promise; /** * Recarrega a configuração da grade. * @description Este método força o recarregamento da configuração da grade a partir do `ConfigStorage`. A operação é assíncrona, mas o método não aguarda sua conclusão. */ "reloadConfig": () => Promise; /** * Recarrega a barra de filtros da grade, buscando o estado do servidor. * @async * @description Força o recarregamento da barra de filtros, atualizando suas configurações e filtros a partir do servidor. * @returns Uma promessa que é resolvida quando a barra de filtros é recarregada. */ "reloadFilterBar": () => Promise; /** * Remove um formatador de valor customizado de uma coluna da grade. * @async * @description Remove uma função de formatação personalizada previamente registrada para uma coluna. * @param columnName O nome da coluna da qual o formatador será removido. * @returns Uma promessa que é resolvida quando o formatador é removido. */ "removeCustomValueFormatter": (columnName: string) => Promise; /** * Identificador de recursos, como configurações e permissões de acesso. */ "resourceID": string; /** * Configuração do toast de seleção da grade. */ "selectionToastConfig": ISelectionToastConfig; /** * Define a configuração da grade. * @async * @description Aplica uma nova configuração de colunas e ordenação à grade. * @param config O objeto de configuração a ser aplicado na grade. * @returns Uma promessa que é resolvida quando a configuração é aplicada. */ "setConfig": (config: IGridConfig) => Promise; /** * Atribui o foco para a grade. * @async * @description Move o foco do navegador para o componente da grade, permitindo a navegação por teclado. * @returns Uma promessa que é resolvida quando o foco é atribuído. */ "setFocus": () => Promise; /** * Exibe a janela de configurações da grade. * @async * @description Este método abre o pop-up de configuração de colunas da grade, permitindo ao usuário ajustar a visibilidade, ordem e largura das colunas. * @returns Uma promessa que é resolvida quando a janela de configuração é exibida. */ "showConfig": () => Promise; /** * Define a configuração de cores para a coluna de status. * @example ```json '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' ``` */ "statusResolver": IStatusResolver | StatusResolverFunction; /** * Define o modo de exportação dos dados. */ "strategyExporter": IExporterStrategyMode; /** * Informa se a coluna de checkbox deve ser suprimida. */ "suppressCheckboxColumn": boolean; /** * Informa se a grade deve suprimir o filtro de coluna. */ "suppressFilterColumn"?: boolean; /** * Define se a grade deve suprimir a barra de rolagem horizontal. */ "suppressHorizontalScroll": boolean; /** * Define o identificador do contêiner de elementos customizados da `Taskbar`. */ "taskbarCustomContainerId": string; /** * Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. */ "taskbarManager": TaskbarManager; /** * Define o nome do slot para elementos customizados na `Taskbar` principal do componente. */ "topTaskbarCustomSlotId": string; /** * Quando `true`, a tecla ENTER navega entre as células como a tecla TAB. */ "useEnterLikeTab": boolean; /** * Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`. */ "useSearchColumn": boolean; } interface SnkGridConfig { /** * Colunas da grade. */ "columns": Array; /** * Configurações da grade. */ "config": IGridConfig; /** * Nome usado para salvar/recuperar a configuração. */ "configName": string; /** * Nome usado para salvar/recuperar a configuração. */ "resourceID": string; /** * Aba selecionada das configurações da grade. */ "selectedIndex": number; } interface SnkGuidesViewer { /** * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. */ "actionsList": Array; /** * Registra um editor customizado para campos da grade e formulário */ "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise; /** * Registra um render customizado para colunas da grid. */ "addGridCustomRender": (fieldName: string, customRender: ICustomRender) => Promise; /** * Define se a edição está habilitada na grid. */ "canEdit": boolean; /** * Nome usado para guardar/recuperar as configurações do formulário. */ "configName": string; /** * Representa o estado do dataUnit master. */ "dataState": DataState1; /** * Instância do DataUnit master. */ "dataUnit": DataUnit; /** * Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. */ "detailTaskbarCustomContainerId": string; /** * Ativa inserção de registros no modo grade. */ "enableGridInsert"?: boolean; /** * Determina todo o caminho de entidades. */ "entityPath": string; /** * Chave da configuração legado do formulário. */ "formLegacyConfigName": string; /** * Fornece uma função para obter um título customizado do formulário. */ "getCustomTitle": () => string; /** * Ignora os campos "somente leitura" no modo de inserção. */ "ignoreReadOnlyFormFields"?: boolean; /** * Configuração do formulário master. */ "masterFormConfig": IFormConfig; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * Altera o modo de apresentação dos botões do snk-taskbar. */ "presentationMode": PresentationMode; /** * Validador responsável por checar a integridade das informações do registro. */ "recordsValidator": IRecordValidator; /** * Identificador de recursos como configurações e acesso. */ "resourceID": string; /** * Guia selecionada. */ "selectedGuide": IGuideItem; /** * Altera/adiciona uma propriedade nos metadados do campo. */ "setFieldProp": (fieldName: string, propName: string, value: any) => Promise; /** * Atribui o foco para o componente. */ "setFocus": () => Promise; /** * Abre o configurador do formulário * @param detail - Define se a configuração que está sendo carregada é referente a um form detail. */ "showFormConfig": (detail?: boolean) => Promise; /** * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. */ "taskbarManager": TaskbarManager; } interface SnkLayoutFormConfig { "messagesBuilder": SnkMessageBuilder; /** * Salva o tipo de layout escolhido. Sem retorno. */ "save": () => Promise; } interface SnkPersonalizedFilter { /** * Nome da configuração, utilizado para distinguir múltiplas instâncias do componente. * @property */ "configName": string; /** * Cria um novo filtro personalizado caso não exista nenhum. * @method * @returns */ "createPersonalizedFilter": () => Promise; /** * URI da entidade utilizada para buscar os campos disponíveis para filtro. * @property */ "entityUri": string; /** * Identificador do filtro a ser carregado. * @property */ "filterId": string; /** * Indica se o filtro é o filtro padrão do sistema. * @property * @default false */ "isDefaultFilter": boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. * @property */ "messagesBuilder": SnkMessageBuilder; /** * Identificador do recurso utilizado para salvar e recuperar filtros. * @property */ "resourceID": string; } interface SnkPersonalizedFilterEditor { /** * Configuração que define as opções e comportamento do componente. */ "config": SnkFilterItemConfig; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * Controla o modo de apresentação do componente, que pode ser configurado como modal ou chip. */ "presentationMode": EPresentationMode; /** * Apresenta o componente */ "show": () => Promise; /** * Controla o valor do componente. */ "value": Array; } interface SnkPesquisa { /** * Define se permite a seleção de itens não analíticos. * @type {boolean} * @default false * @example allowsNonAnalytic={true} */ "allowsNonAnalytic": boolean; /** * Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente. * @type {string} * @mutable * @example argument="Texto para pesquisa" */ "argument": string; /** * Nome da entidade sobre a qual a pesquisa será realizada. * @type {string} * @example entityName="Produto" */ "entityName": string; /** * Define se a popup de pesquisa terá ou não modo hierárquico. * @type {boolean} * @default false * @example isHierarchyEntity={true} */ "isHierarchyEntity": boolean; /** * Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados. * @type {(text: string) => Promise} * @param text Texto utilizado como argumento de pesquisa. * @returns Promise com os dados da pesquisa. * @example searchLoader={(text) => fetchItems(text)} */ "searchLoader": (text: string) => Promise; /** * Função disparada ao selecionar um item da pesquisa. * @type {(option: IOption) => void} * @param option Item selecionado. * @returns void * @example selectItem={(option) => handleSelect(option)} */ "selectItem": (option: IOption2) => void; /** * Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível. * @type {(text: string) => Promise} * @param text Texto utilizado como argumento de pesquisa para a árvore. * @returns Promise com os dados da árvore. */ "treeLoader"?: (text: string) => Promise; } interface SnkPrintSelector { "openPrintSelector": (printJobData: PendingPrintJobData) => Promise; } interface SnkSelectBox { /** * Se true, impede que o campo de texto receba foco automaticamente ao abrir as opções. */ "preventAutoFocus": boolean; /** * Determina a opção selecionada. */ "selectedOption": IOption2 | string; } interface SnkSimpleBar { /** * Define os itens que serão apresentados no breadcrumb. */ "breadcrumbItens": Array; /** * Define o título do header. */ "label": string; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; } interface SnkSimpleCrud { /** * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. */ "actionsList": Array; /** * @description Registra um editor customizado para campos da grade e do formulário. * @param fieldName - O nome do campo. * @param customEditor - A instância do editor customizado. * @returns */ "addCustomEditor": (fieldName: string, customEditor: ICustomEditor) => Promise; /** * @description Registra um formatador de valores para uma coluna da grade. * @param columnName - O nome da coluna. * @param customFormatter - A instância do formatador customizado. * @returns */ "addCustomValueFormatter": (columnName: string, customFormatter: ICustomFormatter) => Promise; /** * @description Registra um renderizador customizado para colunas da grade. * @param fieldName - O nome do campo. * @param customRender - A instância do renderizador customizado. * @returns */ "addGridCustomRender": (fieldName: string, customRender: ICustomRender) => Promise; /** * @description Define se a grade será focada ao ser carregada. */ "autoFocus"?: boolean; /** * @description Define se a carga dos dados será feita assim que o componente for carregado. */ "autoLoad"?: boolean; /** * @description Usado para fechar o configurador do CRUD. * @returns */ "closeConfigurator": () => Promise; /** * @description Usado para salvar as configurações dos blocos de construção. */ "configName": string; /** * @description Estado atual dos dados. */ "dataState": DataState1; /** * @description Instância do DataUnit a ser utilizada pelo componente. */ "dataUnit": DataUnit; /** * Desabilita a edição na grade. */ "disableGridEdition": boolean; /** * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade). */ "domainMessagesBuilder": string; /** * @description Habilita a inserção contínua de registros. */ "enableContinuousInsert": boolean; /** * @description Ativa a inserção de registros no modo grade. */ "enableGridInsert"?: boolean; /** * @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação. */ "enableLockManagerLoadingComp"?: boolean; /** * @description Ativa o gerenciamento de locks na grade pela Taskbar. */ "enableLockManagerTaskbarClick"?: boolean; /** * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD. */ "entityName": string; /** * @description Configuração do formulário. */ "formConfig": IFormConfig; /** * @description Chave da configuração legada do formulário. */ "formLegacyConfigName": string; /** * @description Obtém os registros do DataUnit. * @returns Uma promessa que resolve com a lista de registros. */ "getRecords": () => Promise>; /** * @description Usado para alternar a visão entre GRID e FORM externamente. * @param view - A visão para a qual navegar. * @returns */ "goToView": (view: VIEW_MODE) => Promise; /** * @description Configuração da grade. */ "gridConfig": IGridConfig; /** * @description Chave da configuração legada da grade. */ "gridLegacyConfigName": string; /** * @description Ignora os campos "somente leitura" no modo de inserção. */ "ignoreReadOnlyFormFields": boolean; /** * @description Define se o LayoutFormConfig será exibido no configurador. */ "layoutFormConfig": boolean; /** * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * @description Define o modo de operação do CRUD (servidor ou em memória). */ "mode": SIMPLE_CRUD_MODE; /** * @description Habilita a edição de múltiplos registros simultâneos. */ "multipleEditionEnabled": boolean; /** * @description Determina se pode haver mais de uma linha selecionada na grade. */ "multipleSelection": boolean; /** * @description Usado para abrir o configurador do CRUD. * @returns */ "openConfigurator": () => Promise; /** * @description Altera visualmente as sombras e bordas do componente. Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout). Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up). */ "outlineMode"?: boolean; /** * @description Determina quantas linhas são retornadas por página. */ "pageSize": number; /** * @description Define o modo de exibição do contador de paginação. */ "paginationCounterMode"?: 'show' | 'hidden' | 'auto'; /** * @description Remove o formatador de valores de uma coluna da grade. * @param columnName - O nome da coluna. * @returns */ "removeCustomValueFormatter": (columnName: string) => Promise; /** * @description Identificador de recursos como configurações e acesso. */ "resourceID": string; /** * @description Altera/adiciona uma propriedade nos metadados do campo. * @param fieldName - O nome do campo. * @param propName - O nome da propriedade. * @param value - O valor da propriedade. * @returns */ "setFieldProp": (fieldName: string, propName: string, value: any) => Promise; /** * @description Define os metadados do DataUnit. * @param metadata - Os metadados a serem definidos. * @returns */ "setMetadata": (metadata: UnitMetadata) => Promise; /** * @description Define os registros do DataUnit. * @param records - Os registros a serem definidos. * @returns */ "setRecords": (records: Array) => Promise; /** * @description Usado para exibir os botões de ação do snk-configurator. */ "showConfiguratorButtons": boolean; /** * @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. */ "taskbarManager": TaskbarManager; /** * @description Atualiza a configuração do formulário. * @returns */ "updateConfig": () => Promise; /** * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição. */ "useCancelConfirm": boolean; /** * @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. */ "useEnterLikeTab": boolean; } interface SnkSimpleFormConfig { /** * Chave que representa a configuração do formulário */ "configName": string; /** * Data unit responsável pelos campos disponíveis */ "dataUnit": DataUnit; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * Responsável por abrir o configurador. */ "show": () => Promise; } interface SnkTaskbar { /** * @description Lista de ações a serem exibidas no botão "Mais opções". */ "actionsList": Array; /** * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. */ "actionsSettingsList": Array; /** * @description Define o alinhamento dos itens da barra de tarefas à direita. */ "alignRigth": boolean; /** * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas. */ "buttons": string; /** * @description Nome da configuração usada para salvar ou recuperar as configurações do formulário. Também é utilizado como fallback para a chave de armazenamento do exportador de dados. */ "configName": string; /** * @description Mapa com definições de botões personalizados. A chave do mapa deve ser informada na propriedade `buttons` no local onde o botão deve ser renderizado. */ "customButtons": Map; /** * @description Define o identificador do contêiner na DOM que é responsável por guardar os elementos personalizados que não podem ser passados por slot. * @example Elementos customizados na Taskbar da aba de detalhes. */ "customContainerId": string; /** * @description Define o identificador do slot que recebe elementos personalizados. */ "customSlotId": string; /** * @description Instância do `DataUnit` com a qual a barra de tarefas irá interagir para realizar operações de dados (ex: salvar, próximo, anterior). */ "dataUnit": DataUnit; /** * @description Array contendo os identificadores de todos os botões que devem ser desabilitados. */ "disabledButtons": Array; /** * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder": SnkMessageBuilder; /** * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens. */ "overflowStrategy": 'hiddenItems' | 'none'; /** * @description Altera o modo de apresentação dos botões da barra de tarefas. */ "presentationMode": PresentationMode1; /** * @description Define qual botão deve ter a aparência de destaque (primário). */ "primaryButton": string; /** * @description Identificador de recursos, como configurações e permissões de acesso. */ "resourceID": string; } interface SnkViewRepresentation { /** * Define o layout do componente: 'CASCADE' ou 'SIDE_BY_SIDE' */ "mode": FormLayout; } interface TaskbarActionsButton { /** * Define a lista de ações. */ "actions": Array; /** * Se false o usuário não pode interagir com o componente. */ "enabled": boolean; /** * Esaconde a lista de ações. */ "hideActions": () => Promise; /** * Informa se a lista de ações está aberta. */ "isOpened": () => Promise; /** * Exibe a lista de ações. */ "showActions": () => Promise; /** * Texto que será exibido no botão */ "title": string; } interface TaskbarSplitButton { /** * Função de callback acionada ao clicar no botão principal. * @param name Nome da ação a ser executada. */ "action": (name: string) => void; /** * Define a lista de ações disponíveis no dropdown do botão. */ "actions": Array; /** * Classe CSS personalizada para estilizar o botão. */ "className": string; /** * Identificador de elemento para fins de rastreamento e automação de testes. */ "dataElementId": string; /** * Se false o usuário não pode interagir com o componente. */ "enabled": boolean; /** * Nome do ícone a ser exibido no botão. */ "iconName": string; /** * Nome identificador da ação do botão. */ "name": string; /** * Texto que será exibido no botão. */ "title": string; } interface TestePesquisa { } } export interface ConfigHeaderCustomEvent extends CustomEvent { detail: T; target: HTMLConfigHeaderElement; } export interface ConfigsButtonCustomEvent extends CustomEvent { detail: T; target: HTMLConfigsButtonElement; } export interface FieldConfigCustomEvent extends CustomEvent { detail: T; target: HTMLFieldConfigElement; } export interface FieldItemCustomEvent extends CustomEvent { detail: T; target: HTMLFieldItemElement; } export interface FieldsLayoutCustomEvent extends CustomEvent { detail: T; target: HTMLFieldsLayoutElement; } export interface FieldsSelectorCustomEvent extends CustomEvent { detail: T; target: HTMLFieldsSelectorElement; } export interface GuidesConfiguratorCustomEvent extends CustomEvent { detail: T; target: HTMLGuidesConfiguratorElement; } export interface PesquisaGridCustomEvent extends CustomEvent { detail: T; target: HTMLPesquisaGridElement; } export interface PesquisaTreeCustomEvent extends CustomEvent { detail: T; target: HTMLPesquisaTreeElement; } export interface SnkApplicationCustomEvent extends CustomEvent { detail: T; target: HTMLSnkApplicationElement; } export interface SnkAttachCustomEvent extends CustomEvent { detail: T; target: HTMLSnkAttachElement; } export interface SnkConfiguratorCustomEvent extends CustomEvent { detail: T; target: HTMLSnkConfiguratorElement; } export interface SnkCrudCustomEvent extends CustomEvent { detail: T; target: HTMLSnkCrudElement; } export interface SnkCustomSlotElementsCustomEvent extends CustomEvent { detail: T; target: HTMLSnkCustomSlotElementsElement; } export interface SnkDataUnitCustomEvent extends CustomEvent { detail: T; target: HTMLSnkDataUnitElement; } export interface SnkDefaultFilterCustomEvent extends CustomEvent { detail: T; target: HTMLSnkDefaultFilterElement; } export interface SnkDetailViewCustomEvent extends CustomEvent { detail: T; target: HTMLSnkDetailViewElement; } export interface SnkEntityListCustomEvent extends CustomEvent { detail: T; target: HTMLSnkEntityListElement; } export interface SnkExpressionGroupCustomEvent extends CustomEvent { detail: T; target: HTMLSnkExpressionGroupElement; } export interface SnkExpressionItemCustomEvent extends CustomEvent { detail: T; target: HTMLSnkExpressionItemElement; } export interface SnkFilterAdvancedModeCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterAdvancedModeElement; } export interface SnkFilterAssistentModeCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterAssistentModeElement; } export interface SnkFilterBarCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterBarElement; } export interface SnkFilterBinarySelectCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterBinarySelectElement; } export interface SnkFilterCheckboxListCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterCheckboxListElement; } export interface SnkFilterDetailCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterDetailElement; } export interface SnkFilterFieldSearchCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterFieldSearchElement; } export interface SnkFilterItemCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterItemElement; } export interface SnkFilterListCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterListElement; } export interface SnkFilterModalItemCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterModalItemElement; } export interface SnkFilterMultiSelectCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterMultiSelectElement; } export interface SnkFilterNumberCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterNumberElement; } export interface SnkFilterPeriodCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterPeriodElement; } export interface SnkFilterSearchCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterSearchElement; } export interface SnkFilterTextCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFilterTextElement; } export interface SnkFormCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFormElement; } export interface SnkFormConfigCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFormConfigElement; } export interface SnkFormViewCustomEvent extends CustomEvent { detail: T; target: HTMLSnkFormViewElement; } export interface SnkGridCustomEvent extends CustomEvent { detail: T; target: HTMLSnkGridElement; } export interface SnkGridConfigCustomEvent extends CustomEvent { detail: T; target: HTMLSnkGridConfigElement; } export interface SnkGuidesViewerCustomEvent extends CustomEvent { detail: T; target: HTMLSnkGuidesViewerElement; } export interface SnkPersonalizedFilterCustomEvent extends CustomEvent { detail: T; target: HTMLSnkPersonalizedFilterElement; } export interface SnkPersonalizedFilterEditorCustomEvent extends CustomEvent { detail: T; target: HTMLSnkPersonalizedFilterEditorElement; } export interface SnkSelectBoxCustomEvent extends CustomEvent { detail: T; target: HTMLSnkSelectBoxElement; } export interface SnkSimpleBarCustomEvent extends CustomEvent { detail: T; target: HTMLSnkSimpleBarElement; } export interface SnkSimpleCrudCustomEvent extends CustomEvent { detail: T; target: HTMLSnkSimpleCrudElement; } export interface SnkSimpleFormConfigCustomEvent extends CustomEvent { detail: T; target: HTMLSnkSimpleFormConfigElement; } export interface SnkTaskbarCustomEvent extends CustomEvent { detail: T; target: HTMLSnkTaskbarElement; } export interface TaskbarActionsButtonCustomEvent extends CustomEvent { detail: T; target: HTMLTaskbarActionsButtonElement; } declare global { interface HTMLConfigHeaderElement extends Components.ConfigHeader, HTMLStencilElement { } var HTMLConfigHeaderElement: { prototype: HTMLConfigHeaderElement; new (): HTMLConfigHeaderElement; }; interface HTMLConfigsButtonElement extends Components.ConfigsButton, HTMLStencilElement { } var HTMLConfigsButtonElement: { prototype: HTMLConfigsButtonElement; new (): HTMLConfigsButtonElement; }; interface HTMLFieldConfigElement extends Components.FieldConfig, HTMLStencilElement { } var HTMLFieldConfigElement: { prototype: HTMLFieldConfigElement; new (): HTMLFieldConfigElement; }; interface HTMLFieldItemElement extends Components.FieldItem, HTMLStencilElement { } var HTMLFieldItemElement: { prototype: HTMLFieldItemElement; new (): HTMLFieldItemElement; }; interface HTMLFieldsLayoutElement extends Components.FieldsLayout, HTMLStencilElement { } var HTMLFieldsLayoutElement: { prototype: HTMLFieldsLayoutElement; new (): HTMLFieldsLayoutElement; }; interface HTMLFieldsSelectorElement extends Components.FieldsSelector, HTMLStencilElement { } var HTMLFieldsSelectorElement: { prototype: HTMLFieldsSelectorElement; new (): HTMLFieldsSelectorElement; }; interface HTMLGuidesConfiguratorElement extends Components.GuidesConfigurator, HTMLStencilElement { } var HTMLGuidesConfiguratorElement: { prototype: HTMLGuidesConfiguratorElement; new (): HTMLGuidesConfiguratorElement; }; interface HTMLPesquisaGridElement extends Components.PesquisaGrid, HTMLStencilElement { } var HTMLPesquisaGridElement: { prototype: HTMLPesquisaGridElement; new (): HTMLPesquisaGridElement; }; interface HTMLPesquisaTreeElement extends Components.PesquisaTree, HTMLStencilElement { } var HTMLPesquisaTreeElement: { prototype: HTMLPesquisaTreeElement; new (): HTMLPesquisaTreeElement; }; interface HTMLSnkActionsButtonElement extends Components.SnkActionsButton, HTMLStencilElement { } var HTMLSnkActionsButtonElement: { prototype: HTMLSnkActionsButtonElement; new (): HTMLSnkActionsButtonElement; }; interface HTMLSnkActionsFormElement extends Components.SnkActionsForm, HTMLStencilElement { } var HTMLSnkActionsFormElement: { prototype: HTMLSnkActionsFormElement; new (): HTMLSnkActionsFormElement; }; interface HTMLSnkApplicationElement extends Components.SnkApplication, HTMLStencilElement { } var HTMLSnkApplicationElement: { prototype: HTMLSnkApplicationElement; new (): HTMLSnkApplicationElement; }; interface HTMLSnkAttachElement extends Components.SnkAttach, HTMLStencilElement { } var HTMLSnkAttachElement: { prototype: HTMLSnkAttachElement; new (): HTMLSnkAttachElement; }; interface HTMLSnkClientConfirmElement extends Components.SnkClientConfirm, HTMLStencilElement { } var HTMLSnkClientConfirmElement: { prototype: HTMLSnkClientConfirmElement; new (): HTMLSnkClientConfirmElement; }; interface HTMLSnkConfiguratorElement extends Components.SnkConfigurator, HTMLStencilElement { } var HTMLSnkConfiguratorElement: { prototype: HTMLSnkConfiguratorElement; new (): HTMLSnkConfiguratorElement; }; interface HTMLSnkCrudElement extends Components.SnkCrud, HTMLStencilElement { } var HTMLSnkCrudElement: { prototype: HTMLSnkCrudElement; new (): HTMLSnkCrudElement; }; interface HTMLSnkCustomSlotElementsElement extends Components.SnkCustomSlotElements, HTMLStencilElement { } var HTMLSnkCustomSlotElementsElement: { prototype: HTMLSnkCustomSlotElementsElement; new (): HTMLSnkCustomSlotElementsElement; }; interface HTMLSnkDataExporterElement extends Components.SnkDataExporter, HTMLStencilElement { } var HTMLSnkDataExporterElement: { prototype: HTMLSnkDataExporterElement; new (): HTMLSnkDataExporterElement; }; interface HTMLSnkDataUnitElement extends Components.SnkDataUnit, HTMLStencilElement { } var HTMLSnkDataUnitElement: { prototype: HTMLSnkDataUnitElement; new (): HTMLSnkDataUnitElement; }; interface HTMLSnkDefaultFilterElement extends Components.SnkDefaultFilter, HTMLStencilElement { } var HTMLSnkDefaultFilterElement: { prototype: HTMLSnkDefaultFilterElement; new (): HTMLSnkDefaultFilterElement; }; interface HTMLSnkDetailViewElement extends Components.SnkDetailView, HTMLStencilElement { } var HTMLSnkDetailViewElement: { prototype: HTMLSnkDetailViewElement; new (): HTMLSnkDetailViewElement; }; interface HTMLSnkEntityListElement extends Components.SnkEntityList, HTMLStencilElement { } var HTMLSnkEntityListElement: { prototype: HTMLSnkEntityListElement; new (): HTMLSnkEntityListElement; }; interface HTMLSnkExporterEmailSenderElement extends Components.SnkExporterEmailSender, HTMLStencilElement { } var HTMLSnkExporterEmailSenderElement: { prototype: HTMLSnkExporterEmailSenderElement; new (): HTMLSnkExporterEmailSenderElement; }; interface HTMLSnkExpressionGroupElement extends Components.SnkExpressionGroup, HTMLStencilElement { } var HTMLSnkExpressionGroupElement: { prototype: HTMLSnkExpressionGroupElement; new (): HTMLSnkExpressionGroupElement; }; interface HTMLSnkExpressionItemElement extends Components.SnkExpressionItem, HTMLStencilElement { } var HTMLSnkExpressionItemElement: { prototype: HTMLSnkExpressionItemElement; new (): HTMLSnkExpressionItemElement; }; interface HTMLSnkFilterAdvancedModeElement extends Components.SnkFilterAdvancedMode, HTMLStencilElement { } var HTMLSnkFilterAdvancedModeElement: { prototype: HTMLSnkFilterAdvancedModeElement; new (): HTMLSnkFilterAdvancedModeElement; }; interface HTMLSnkFilterAssistentModeElement extends Components.SnkFilterAssistentMode, HTMLStencilElement { } var HTMLSnkFilterAssistentModeElement: { prototype: HTMLSnkFilterAssistentModeElement; new (): HTMLSnkFilterAssistentModeElement; }; interface HTMLSnkFilterBarElement extends Components.SnkFilterBar, HTMLStencilElement { } var HTMLSnkFilterBarElement: { prototype: HTMLSnkFilterBarElement; new (): HTMLSnkFilterBarElement; }; interface HTMLSnkFilterBinarySelectElement extends Components.SnkFilterBinarySelect, HTMLStencilElement { } var HTMLSnkFilterBinarySelectElement: { prototype: HTMLSnkFilterBinarySelectElement; new (): HTMLSnkFilterBinarySelectElement; }; interface HTMLSnkFilterCheckboxListElement extends Components.SnkFilterCheckboxList, HTMLStencilElement { } var HTMLSnkFilterCheckboxListElement: { prototype: HTMLSnkFilterCheckboxListElement; new (): HTMLSnkFilterCheckboxListElement; }; interface HTMLSnkFilterDetailElement extends Components.SnkFilterDetail, HTMLStencilElement { } var HTMLSnkFilterDetailElement: { prototype: HTMLSnkFilterDetailElement; new (): HTMLSnkFilterDetailElement; }; interface HTMLSnkFilterFieldSearchElement extends Components.SnkFilterFieldSearch, HTMLStencilElement { } var HTMLSnkFilterFieldSearchElement: { prototype: HTMLSnkFilterFieldSearchElement; new (): HTMLSnkFilterFieldSearchElement; }; interface HTMLSnkFilterItemElement extends Components.SnkFilterItem, HTMLStencilElement { } var HTMLSnkFilterItemElement: { prototype: HTMLSnkFilterItemElement; new (): HTMLSnkFilterItemElement; }; interface HTMLSnkFilterListElement extends Components.SnkFilterList, HTMLStencilElement { } var HTMLSnkFilterListElement: { prototype: HTMLSnkFilterListElement; new (): HTMLSnkFilterListElement; }; interface HTMLSnkFilterModalElement extends Components.SnkFilterModal, HTMLStencilElement { } var HTMLSnkFilterModalElement: { prototype: HTMLSnkFilterModalElement; new (): HTMLSnkFilterModalElement; }; interface HTMLSnkFilterModalItemElement extends Components.SnkFilterModalItem, HTMLStencilElement { } var HTMLSnkFilterModalItemElement: { prototype: HTMLSnkFilterModalItemElement; new (): HTMLSnkFilterModalItemElement; }; interface HTMLSnkFilterMultiSelectElement extends Components.SnkFilterMultiSelect, HTMLStencilElement { } var HTMLSnkFilterMultiSelectElement: { prototype: HTMLSnkFilterMultiSelectElement; new (): HTMLSnkFilterMultiSelectElement; }; interface HTMLSnkFilterNumberElement extends Components.SnkFilterNumber, HTMLStencilElement { } var HTMLSnkFilterNumberElement: { prototype: HTMLSnkFilterNumberElement; new (): HTMLSnkFilterNumberElement; }; interface HTMLSnkFilterParamConfigElement extends Components.SnkFilterParamConfig, HTMLStencilElement { } var HTMLSnkFilterParamConfigElement: { prototype: HTMLSnkFilterParamConfigElement; new (): HTMLSnkFilterParamConfigElement; }; interface HTMLSnkFilterPeriodElement extends Components.SnkFilterPeriod, HTMLStencilElement { } var HTMLSnkFilterPeriodElement: { prototype: HTMLSnkFilterPeriodElement; new (): HTMLSnkFilterPeriodElement; }; interface HTMLSnkFilterSearchElement extends Components.SnkFilterSearch, HTMLStencilElement { } var HTMLSnkFilterSearchElement: { prototype: HTMLSnkFilterSearchElement; new (): HTMLSnkFilterSearchElement; }; interface HTMLSnkFilterTextElement extends Components.SnkFilterText, HTMLStencilElement { } var HTMLSnkFilterTextElement: { prototype: HTMLSnkFilterTextElement; new (): HTMLSnkFilterTextElement; }; interface HTMLSnkFormElement extends Components.SnkForm, HTMLStencilElement { } var HTMLSnkFormElement: { prototype: HTMLSnkFormElement; new (): HTMLSnkFormElement; }; interface HTMLSnkFormConfigElement extends Components.SnkFormConfig, HTMLStencilElement { } var HTMLSnkFormConfigElement: { prototype: HTMLSnkFormConfigElement; new (): HTMLSnkFormConfigElement; }; interface HTMLSnkFormSummaryElement extends Components.SnkFormSummary, HTMLStencilElement { } var HTMLSnkFormSummaryElement: { prototype: HTMLSnkFormSummaryElement; new (): HTMLSnkFormSummaryElement; }; interface HTMLSnkFormViewElement extends Components.SnkFormView, HTMLStencilElement { } var HTMLSnkFormViewElement: { prototype: HTMLSnkFormViewElement; new (): HTMLSnkFormViewElement; }; interface HTMLSnkGridElement extends Components.SnkGrid, HTMLStencilElement { } var HTMLSnkGridElement: { prototype: HTMLSnkGridElement; new (): HTMLSnkGridElement; }; interface HTMLSnkGridConfigElement extends Components.SnkGridConfig, HTMLStencilElement { } var HTMLSnkGridConfigElement: { prototype: HTMLSnkGridConfigElement; new (): HTMLSnkGridConfigElement; }; interface HTMLSnkGuidesViewerElement extends Components.SnkGuidesViewer, HTMLStencilElement { } var HTMLSnkGuidesViewerElement: { prototype: HTMLSnkGuidesViewerElement; new (): HTMLSnkGuidesViewerElement; }; interface HTMLSnkLayoutFormConfigElement extends Components.SnkLayoutFormConfig, HTMLStencilElement { } var HTMLSnkLayoutFormConfigElement: { prototype: HTMLSnkLayoutFormConfigElement; new (): HTMLSnkLayoutFormConfigElement; }; interface HTMLSnkPersonalizedFilterElement extends Components.SnkPersonalizedFilter, HTMLStencilElement { } var HTMLSnkPersonalizedFilterElement: { prototype: HTMLSnkPersonalizedFilterElement; new (): HTMLSnkPersonalizedFilterElement; }; interface HTMLSnkPersonalizedFilterEditorElement extends Components.SnkPersonalizedFilterEditor, HTMLStencilElement { } var HTMLSnkPersonalizedFilterEditorElement: { prototype: HTMLSnkPersonalizedFilterEditorElement; new (): HTMLSnkPersonalizedFilterEditorElement; }; interface HTMLSnkPesquisaElement extends Components.SnkPesquisa, HTMLStencilElement { } var HTMLSnkPesquisaElement: { prototype: HTMLSnkPesquisaElement; new (): HTMLSnkPesquisaElement; }; interface HTMLSnkPrintSelectorElement extends Components.SnkPrintSelector, HTMLStencilElement { } var HTMLSnkPrintSelectorElement: { prototype: HTMLSnkPrintSelectorElement; new (): HTMLSnkPrintSelectorElement; }; interface HTMLSnkSelectBoxElement extends Components.SnkSelectBox, HTMLStencilElement { } var HTMLSnkSelectBoxElement: { prototype: HTMLSnkSelectBoxElement; new (): HTMLSnkSelectBoxElement; }; interface HTMLSnkSimpleBarElement extends Components.SnkSimpleBar, HTMLStencilElement { } var HTMLSnkSimpleBarElement: { prototype: HTMLSnkSimpleBarElement; new (): HTMLSnkSimpleBarElement; }; interface HTMLSnkSimpleCrudElement extends Components.SnkSimpleCrud, HTMLStencilElement { } var HTMLSnkSimpleCrudElement: { prototype: HTMLSnkSimpleCrudElement; new (): HTMLSnkSimpleCrudElement; }; interface HTMLSnkSimpleFormConfigElement extends Components.SnkSimpleFormConfig, HTMLStencilElement { } var HTMLSnkSimpleFormConfigElement: { prototype: HTMLSnkSimpleFormConfigElement; new (): HTMLSnkSimpleFormConfigElement; }; interface HTMLSnkTaskbarElement extends Components.SnkTaskbar, HTMLStencilElement { } var HTMLSnkTaskbarElement: { prototype: HTMLSnkTaskbarElement; new (): HTMLSnkTaskbarElement; }; interface HTMLSnkViewRepresentationElement extends Components.SnkViewRepresentation, HTMLStencilElement { } var HTMLSnkViewRepresentationElement: { prototype: HTMLSnkViewRepresentationElement; new (): HTMLSnkViewRepresentationElement; }; interface HTMLTaskbarActionsButtonElement extends Components.TaskbarActionsButton, HTMLStencilElement { } var HTMLTaskbarActionsButtonElement: { prototype: HTMLTaskbarActionsButtonElement; new (): HTMLTaskbarActionsButtonElement; }; interface HTMLTaskbarSplitButtonElement extends Components.TaskbarSplitButton, HTMLStencilElement { } var HTMLTaskbarSplitButtonElement: { prototype: HTMLTaskbarSplitButtonElement; new (): HTMLTaskbarSplitButtonElement; }; interface HTMLTestePesquisaElement extends Components.TestePesquisa, HTMLStencilElement { } var HTMLTestePesquisaElement: { prototype: HTMLTestePesquisaElement; new (): HTMLTestePesquisaElement; }; interface HTMLElementTagNameMap { "config-header": HTMLConfigHeaderElement; "configs-button": HTMLConfigsButtonElement; "field-config": HTMLFieldConfigElement; "field-item": HTMLFieldItemElement; "fields-layout": HTMLFieldsLayoutElement; "fields-selector": HTMLFieldsSelectorElement; "guides-configurator": HTMLGuidesConfiguratorElement; "pesquisa-grid": HTMLPesquisaGridElement; "pesquisa-tree": HTMLPesquisaTreeElement; "snk-actions-button": HTMLSnkActionsButtonElement; "snk-actions-form": HTMLSnkActionsFormElement; "snk-application": HTMLSnkApplicationElement; "snk-attach": HTMLSnkAttachElement; "snk-client-confirm": HTMLSnkClientConfirmElement; "snk-configurator": HTMLSnkConfiguratorElement; "snk-crud": HTMLSnkCrudElement; "snk-custom-slot-elements": HTMLSnkCustomSlotElementsElement; "snk-data-exporter": HTMLSnkDataExporterElement; "snk-data-unit": HTMLSnkDataUnitElement; "snk-default-filter": HTMLSnkDefaultFilterElement; "snk-detail-view": HTMLSnkDetailViewElement; "snk-entity-list": HTMLSnkEntityListElement; "snk-exporter-email-sender": HTMLSnkExporterEmailSenderElement; "snk-expression-group": HTMLSnkExpressionGroupElement; "snk-expression-item": HTMLSnkExpressionItemElement; "snk-filter-advanced-mode": HTMLSnkFilterAdvancedModeElement; "snk-filter-assistent-mode": HTMLSnkFilterAssistentModeElement; "snk-filter-bar": HTMLSnkFilterBarElement; "snk-filter-binary-select": HTMLSnkFilterBinarySelectElement; "snk-filter-checkbox-list": HTMLSnkFilterCheckboxListElement; "snk-filter-detail": HTMLSnkFilterDetailElement; "snk-filter-field-search": HTMLSnkFilterFieldSearchElement; "snk-filter-item": HTMLSnkFilterItemElement; "snk-filter-list": HTMLSnkFilterListElement; "snk-filter-modal": HTMLSnkFilterModalElement; "snk-filter-modal-item": HTMLSnkFilterModalItemElement; "snk-filter-multi-select": HTMLSnkFilterMultiSelectElement; "snk-filter-number": HTMLSnkFilterNumberElement; "snk-filter-param-config": HTMLSnkFilterParamConfigElement; "snk-filter-period": HTMLSnkFilterPeriodElement; "snk-filter-search": HTMLSnkFilterSearchElement; "snk-filter-text": HTMLSnkFilterTextElement; "snk-form": HTMLSnkFormElement; "snk-form-config": HTMLSnkFormConfigElement; "snk-form-summary": HTMLSnkFormSummaryElement; "snk-form-view": HTMLSnkFormViewElement; "snk-grid": HTMLSnkGridElement; "snk-grid-config": HTMLSnkGridConfigElement; "snk-guides-viewer": HTMLSnkGuidesViewerElement; "snk-layout-form-config": HTMLSnkLayoutFormConfigElement; "snk-personalized-filter": HTMLSnkPersonalizedFilterElement; "snk-personalized-filter-editor": HTMLSnkPersonalizedFilterEditorElement; "snk-pesquisa": HTMLSnkPesquisaElement; "snk-print-selector": HTMLSnkPrintSelectorElement; "snk-select-box": HTMLSnkSelectBoxElement; "snk-simple-bar": HTMLSnkSimpleBarElement; "snk-simple-crud": HTMLSnkSimpleCrudElement; "snk-simple-form-config": HTMLSnkSimpleFormConfigElement; "snk-taskbar": HTMLSnkTaskbarElement; "snk-view-representation": HTMLSnkViewRepresentationElement; "taskbar-actions-button": HTMLTaskbarActionsButtonElement; "taskbar-split-button": HTMLTaskbarSplitButtonElement; "teste-pesquisa": HTMLTestePesquisaElement; } } declare namespace LocalJSX { interface ConfigHeader { "configOptions"?: Array; "hasChanges"?: boolean; "messagesBuilder"?: SnkMessageBuilder; "onConfigClose"?: (event: ConfigHeaderCustomEvent) => void; "onSaveConfig"?: (event: ConfigHeaderCustomEvent) => void; "optionConfigChanged"?: boolean; "selectedConfig"?: IUserConfig; } interface ConfigsButton { "configOptions"?: Array; "hasChanges"?: boolean; "messagesBuilder"?: SnkMessageBuilder; "onFormConfigOptionSelected"?: (event: ConfigsButtonCustomEvent) => void; "selectedConfig"?: IUserConfig; } interface FieldConfig { "dataUnit"?: DataUnit; "fieldConfig"?: IFieldConfig; "fieldDescriptor"?: FieldDescriptor; "messagesBuilder"?: SnkMessageBuilder; "onFieldConfigChanged"?: (event: FieldConfigCustomEvent) => void; } interface FieldItem { "dataUnit"?: DataUnit; "fieldConfig"?: IFieldConfig; "messagesBuilder"?: SnkMessageBuilder; "onAddFieldToGuide"?: (event: FieldItemCustomEvent) => void; "onLayoutConfig"?: boolean; "onSetFieldAsAvailable"?: (event: FieldItemCustomEvent) => void; } interface FieldsLayout { "dataUnit"?: DataUnit; "groupsList"?: IGroupConfig[]; "guideNames"?: string[]; "messagesBuilder"?: SnkMessageBuilder; "onGuideRenamed"?: (event: FieldsLayoutCustomEvent) => void; "onIsEditingGroupName"?: (event: FieldsLayoutCustomEvent) => void; "onIsEditingGuideName"?: (event: FieldsLayoutCustomEvent) => void; "onLayoutChanged"?: (event: FieldsLayoutCustomEvent) => void; "onSetFieldListAsAvailable"?: (event: FieldsLayoutCustomEvent) => void; "selectedGuide"?: IGuideConfig; } interface FieldsSelector { "availableFields"?: IFieldConfig[]; "dataUnit"?: DataUnit; "messagesBuilder"?: SnkMessageBuilder; "onFieldListChanged"?: (event: FieldsSelectorCustomEvent) => void; } interface GuidesConfigurator { "guidesList"?: IGuideConfig[]; "messagesBuilder"?: SnkMessageBuilder; "onCreateNewGuide"?: (event: GuidesConfiguratorCustomEvent) => void; "onGuideDeleted"?: (event: GuidesConfiguratorCustomEvent) => void; "onGuideListChanged"?: (event: GuidesConfiguratorCustomEvent) => void; "onGuideSelected"?: (event: GuidesConfiguratorCustomEvent) => void; "selectedGuide"?: IGuideConfig; } interface PesquisaGrid { /** * Registros da grade */ "dataSource"?: Record[]; /** * Campo que representa a descrição do registro */ "descriptionField"?: string; /** * Nome da entidade representada na grade */ "entityName"?: string; /** * Campos que representam as colunas da grade. */ "metadata"?: UnitMetadata; "onPesquisaGridSelectItem"?: (event: PesquisaGridCustomEvent) => void; /** * Campo que representa a chave primária do registro */ "pkField"?: string; /** * Define se deve carregar configurações da grade */ "shouldLoadConfig"?: boolean; } interface PesquisaTree { /** * Define se permite seleção de items não analíticos */ "allowsNonAnalytic"?: boolean; /** * Argumentos que serão usados ao chamar a função treeLoader. */ "argument"?: string; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; "onPesquisaTreeSelectItem"?: (event: PesquisaTreeCustomEvent) => void; /** * Informa se a árvore hierárquica deve ou não ser carregada. */ "shouldLoadTree"?: boolean; /** * Função responsável por carregar a árvore hierárquica do componente */ "treeLoader"?: (text: string) => Promise>; } interface SnkActionsButton { } interface SnkActionsForm { /** * Ação na qual os parâmetros serão preenchidos. */ "action"?: IAction; /** * Responsável por retornar a ação com os parâmetros preenchidos. */ "applyParameters"?: (action: IAction) => void; } interface SnkApplication { /** * 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. */ "enableLockManagerLoadingApp"?: boolean; /** * Chave da configuração legada do formulário, utilizada para migração de configurações antigas. */ "formLegacyConfigName"?: string; /** * 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. */ "onApplicationLoaded"?: (event: SnkApplicationCustomEvent) => void; /** * Emitido ao iniciar a carga do componente. */ "onApplicationLoading"?: (event: SnkApplicationCustomEvent) => void; } interface SnkAttach { /** * DataUnit responsável por carregar os dados. */ "dataUnit"?: DataUnit; /** * DataUnitBuilder responsável por implementar dados a serem utilizados no DataUnit. */ "dataUnitBuilder"?: FetcherFacade; /** * Nome da entidade à ser utilizada para relacionar o anexo ao DataUnit pai. */ "entityName"?: string; /** * Fetcher responsável por carregar os dados do DataUnit. */ "fetcher"?: AttachFetcherFacadeInterface; /** * FetcherType define o tipo de fetcher responsável por carregar os dados do DataUnit. */ "fetcherType"?: TFetcherType; /** * Chave da configuração legado da grid. */ "gridLegacyConfigName"?: string; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * Evento disparado quando o usuário clica no botão voltar. */ "onBack"?: (event: SnkAttachCustomEvent) => void; /** * Identificação do registro pai. */ "registerKey": string; } interface SnkClientConfirm { /** * Retorno quando usuário confirmar. */ "accept"?: () => void; /** * Retorno quando usuário cancelar. */ "cancel"?: () => void; /** * Mensagem da popup. */ "message"?: string; /** * Título da popup. */ "titleMessage"?: string; } interface SnkConfigurator { /** * Usado para guardar ou recuperar as configurações do formulário. */ "configName"?: string; /** * ID do container que contém os elementos customizados do configurator. */ "customContainerId"?: string; /** * Define se o LayoutFormConfig será exibido no configurador. */ "layoutFormConfig"?: boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * Emitido quando cancela o salvamento da configuração. */ "onCancel"?: (event: SnkConfiguratorCustomEvent) => void; /** * Emitido quando seleciona o modo de visualização. */ "onConfigSelected"?: (event: SnkConfiguratorCustomEvent) => void; /** * Emitido quando clica para abrir a configuração. */ "onOpenConfig"?: (event: SnkConfiguratorCustomEvent) => void; /** * Emitido quando salva a configuração. */ "onSave"?: (event: SnkConfiguratorCustomEvent) => void; /** * Identificador de recursos como configurações e acesso. */ "resourceID"?: string; /** * Usado para exibir os botões de ação */ "showActionButtons"?: boolean; /** * Define qual modo de visualização está ativo. */ "viewMode"?: VIEW_MODE; } interface SnkCrud { /** * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. */ "actionsList"?: Array; /** * Define se a grid será focada ao ser carregada. */ "autoFocus"?: boolean; /** * Define se a carga dos dados será feita assim que o componente for carregado. */ "autoLoad"?: boolean; /** * Usado para salvar as configurações dos blocos de construção. */ "configName"?: string; /** * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). */ "disablePersonalizedFilter"?: boolean; /** * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) */ "domainMessagesBuilder"?: string; /** * Ativa inserção de registros no modo grade. */ "enableGridInsert"?: boolean; /** * Define se o componente deve usar o LockManager para controle de carregamento da aplicação */ "enableLockManagerLoadingComp"?: boolean; /** * Ativa o gerenciamento de locks na grade pela Taskbar. */ "enableLockManagerTaskbarClick"?: boolean; /** * Chave da configuração legado da barra de filtros. */ "filterBarLegacyConfigName"?: string; /** * Título que será apresentado na barra de filtros */ "filterBarTitle"?: string; /** * Chave da configuração legado do formulário. */ "formLegacyConfigName"?: string; /** * Chave da configuração legado da grade. */ "gridLegacyConfigName"?: string; /** * Ignora os campos "somente leitura" no modo de inserção. */ "ignoreReadOnlyFormFields"?: boolean; /** * Define se o LayoutFormConfig será exibido no configurador. */ "layoutFormConfig"?: boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * Habilita a edição de múltiplos registros simultâneos. */ "multipleEditionEnabled"?: boolean; /** * Determina se pode haver mais de uma linha selecionada na grade. */ "multipleSelection"?: boolean; /** * Emitido pela taskbar sempre que houver click de botão ou ação. */ "onActionClick"?: (event: SnkCrudCustomEvent) => void; /** * Emitido quando cancela o salvamento da configuração no configurator do CRUD. */ "onConfiguratorCancel"?: (event: SnkCrudCustomEvent) => void; /** * Emitido quando salva a configuração no configurator do CRUD. */ "onConfiguratorSave"?: (event: SnkCrudCustomEvent) => void; /** * Responsável por notificar quando ocorrer a renderização de itens do formulário. */ "onFormItemsReady"?: (event: SnkCrudCustomEvent>) => void; "onViewModeChanged"?: (event: SnkCrudCustomEvent) => void; /** * Define se a grid será focada ao ser carregada. */ "paginationCounterMode"?: 'show' | 'hidden' | 'auto'; /** * Altera o modo de apresentação dos botões do snk-taskbar. */ "presentationMode"?: PresentationMode; /** * Validador responsável por checar a integridade das informações do registro. */ "recordsValidator"?: IRecordValidator; /** * Configuração da seleção de grade no toast. */ "selectionToastConfig"?: ISelectionToastConfig; /** * Define uma função para configurar um título cusotmizado no modo formulário. */ "setCustomFormTitle"?: () => string; /** * Usado para exibir os botões de ação do snk-configurator */ "showActionButtons"?: boolean; /** * Configuração do valor da coluna de status. Exemplo: { "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } } */ "statusResolver"?: IStatusResolver | StatusResolverFunction; /** * Modo de exportação dos dados. */ "strategyExporter"?: IExporterStrategyMode; /** * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. */ "taskbarManager"?: TaskbarManager; /** * Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. */ "useEnterLikeTab"?: boolean; } interface SnkCustomSlotElements { /** * Emitido quando elemento é carregado na tela. */ "onSnkCustomSlotElementsLoaded"?: (event: SnkCustomSlotElementsCustomEvent) => void; /** * Nome do slot onde os elementos customizados deverão aparecer. */ "slotName"?: string; } interface SnkDataExporter { /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * Provedor das informações para exportação dos dados. */ "provider"?: IExporterProvider; } interface SnkDataUnit { /** * Executado após a ação de salvar. * @param dataUnit - A instância do DataUnit. * @returns */ "afterSave"?: (dataUnit: DataUnit) => void; /** * Executado imediatamente antes da ação de salvar as alterações. Útil no caso de validações por exemplo. Caso retorne "false" (ou a promessa se resolva como false), cancela a ação. * @param dataUnit - A instância do DataUnit. * @returns `false` para cancelar a ação, `true` para continuar. */ "beforeSave"?: (dataUnit: DataUnit) => boolean | Promise; /** * Usado para obter configuração de metadados. * @type {string} */ "configName"?: string; /** * Controla o estado atual dos dados. * @type {DataState} */ "dataState"?: DataState; /** * Uma vez instanciado, pode-se obter o dataUnit por esta propriedade. * @type {DataUnit} */ "dataUnit"?: DataUnit; /** * Usado para criar o dataUnit uma única vez. Se omitido, será usado o próprio nome da entidade. * @type {string} */ "dataUnitName"?: string; /** * Define a chave customizada para sobrescrever as mensagens (Não pegando pela entidade) * @type {string} */ "domainMessagesBuilder"?: string; /** * Determina qual a entidade que representa os dados em questão. * @type {string} */ "entityName"?: string; /** * Responsável por evitar a mensagem de sucesso ao salvar. * @type {boolean} */ "ignoreSaveMessage"?: boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. * @type {SnkMessageBuilder} */ "messagesBuilder"?: SnkMessageBuilder; /** * Emitido quando se cancela uma inserção ou cópia. * @event cancelEdition * @type {CustomEvent} * @bubbles false */ "onCancelEdition"?: (event: SnkDataUnitCustomEvent) => void; /** * Emitido quando há qualquer mudança de estado no DataUnit. * @event dataStateChange * @type {CustomEvent} * @bubbles false */ "onDataStateChange"?: (event: SnkDataUnitCustomEvent) => void; /** * Emitido quando há campos no DataUnit que devem ser ocultados. * @event dataUnitFieldsHidded * @type {CustomEvent} */ "onDataUnitFieldsHidded"?: (event: SnkDataUnitCustomEvent) => void; /** * Emitido quando o DataUnit está pronto. * @event dataUnitReady * @type {CustomEvent} * @bubbles false */ "onDataUnitReady"?: (event: SnkDataUnitCustomEvent) => void; /** * Emitido quando um registro é adicionado ou copiado. * @event insertionMode * @type {CustomEvent} * @bubbles false */ "onInsertionMode"?: (event: SnkDataUnitCustomEvent) => void; /** * Emitido quando o messagesBuilder é atualizado. * @event messagesBuilderUpdated * @type {CustomEvent} * @bubbles false */ "onMessagesBuilderUpdated"?: (event: SnkDataUnitCustomEvent) => void; /** * Determina quantas linhas são retornadas por página. * @type {number} * @default 150 */ "pageSize"?: number; /** * Identificador de recursos como configurações e acesso. * @type {string} */ "resourceID"?: string; /** * Determina se será usado mensagem de confirmação padrão na tentativa de cancelar a edição. * @type {boolean} * @default true */ "useCancelConfirm"?: boolean; } interface SnkDefaultFilter { /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage"?: (key: string, props?: any) => string; /** * Informa se já existe um filtro padrão criado. */ "hasDefaultFilter"?: boolean; "onActionSelected"?: (event: SnkDefaultFilterCustomEvent) => void; } interface SnkDetailView { "branchGuide"?: IGuideItem; /** * Define se a edição está habilitada na grid. */ "canEdit"?: boolean; /** * Registra um editor customizado para campos da grade e formulário. */ "customEditors"?: PropsCustomEditor; /** * Render customizados da grade. */ "customRenders"?: PropsCustomRender; /** * Representa o estado do dataUnit detail. */ "dataState"?: DataState1; /** * Instância do DataUnit detail. */ "dataUnit"?: DataUnit; /** * Determina todo o caminho desde o pai até chegar neste nível */ "dataUnitName"?: string; /** * Nome da entidade detail. */ "entityName"?: string; /** * Gerenciador de configuração do formulário. */ "formConfigManager"?: SnkFormConfigManager; /** * Caminho do identificador da guia vinculada. */ "guideItemPath"?: Array; /** * Descrição amigável do cadastro detalhe. */ "label"?: string; "messagesBuilder"?: SnkMessageBuilder; /** * Responsável por notificar quando ocorrer a renderização de itens do formulário. */ "onFormItemsReady"?: (event: SnkDetailViewCustomEvent>) => void; /** * Emitido quando há necessidade de atualizar a estrutura de guias. */ "onSnkDetailGuidesChange"?: (event: SnkDetailViewCustomEvent) => void; /** * Emitido quando há necessidade de comutar entre grid e form. */ "onSnkSwitchGuide"?: (event: SnkDetailViewCustomEvent) => void; /** * Altera o modo de apresentação dos botões do snk-taskbar. */ "presentationMode"?: PresentationMode; /** * Identificador de recursos como configurações e acesso. */ "resourceID"?: string; /** * Representa o formulário selecionado. */ "selectedForm"?: string; /** * Define o identificador do container de elementos customizados da Taskbar. */ "taskbarCustomContainerId"?: string; } interface SnkEntityList { /** * Configurações para carregar os dados do componente */ "config"?: SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage"?: string; /** * Permite definir uma altura máxima para o ez-list, adicionando um scroll ao atingir esta medida */ "maxHeightList"?: string; /** * Emite um evento customizado ao realizar alteração nos valores do componente */ "onValueChanged"?: (event: SnkEntityListCustomEvent) => void; /** * Método que possibilita alterar como o item da lista vai ser apresentado. Observação: No React ele se transforma em VNode e não HTMLElement. */ "rightListSlotBuilder"?: (item: ListItem, group?: ListGroup) => HTMLElement | string; /** * Define o valor do componente */ "value"?: IOption2; } interface SnkExporterEmailSender { "getMessage"?: (key: string, params?: any) => string; } interface SnkExpressionGroup { /** * Identificador da unidade de dados. */ "entityURI"?: string; /** * Id do filtro que será carregado. */ "filterId"?: string; /** * Grupo que será representado visualmente pelo componente. */ "group"?: IExpressionGroup; /** * Define se o filtro em questão é um filtro padrão. */ "isDefaultFilter"?: boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * Emitido ao alterar quantidade de grupos ou expressões */ "onEzExpressionLayoutChanged"?: (event: SnkExpressionGroupCustomEvent) => void; /** * Emitido quando ocorrer alterações no grupo. */ "onEzFilterGroupChange"?: (event: SnkExpressionGroupCustomEvent) => void; /** * Emitido ao pressionar o botão de remover grupo. */ "onEzFilterGroupRemove"?: (event: SnkExpressionGroupCustomEvent) => void; /** * Tamanho do elemento pai do grupo */ "parentTop"?: number; } interface SnkExpressionItem { /** * Controla a exibição do botão Remover. */ "canRemove"?: boolean; /** * Identificador da unidade de dados. */ "entityURI"?: string; /** * Expressão que será representada visualmente. */ "expression"?: IExpressionItem; /** * Define se o filtro em questão é um filtro padrão. */ "isDefaultFilter"?: boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * Emitido quando acontece alterações na expressão. */ "onEzFilterItemChange"?: (event: SnkExpressionItemCustomEvent) => void; /** * Emitido ao confirmar uma remoção. */ "onEzFilterItemRemove"?: (event: SnkExpressionItemCustomEvent) => void; } interface SnkFilterAdvancedMode { /** * Propriedade que mantém informações relacionadas ao SnkApplication. */ "application"?: SnkApplication; /** * Propriedade que contém informações do filtro personalizado. */ "filterAssistent"?: IPersonalizedFilter; /** * Evento emitido sempre que uma edição na expressão é realizada. */ "onEzExpressionChange"?: (event: SnkFilterAdvancedModeCustomEvent) => void; } interface SnkFilterAssistentMode { /** * Propriedade que mantém informações relacionadas ao SnkApplication. */ "application"?: SnkApplication; /** * Responsável por receber a URI da entidade. */ "entityUri"?: string; /** * Propriedade que contém informações do filtro personalizado. */ "filterAssistent"?: IPersonalizedFilter; /** * Id do filtro que será carregado. */ "filterId"?: string; /** * Define se o filtro em questão é um filtro padrão. */ "isDefaultFilter"?: boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; "onEzChangeFilter"?: (event: SnkFilterAssistentModeCustomEvent) => void; } interface SnkFilterBar { /** * @description Função chamada depois de aplicar os filtros. */ "afterApplyConfig"?: () => void; /** * @description Define se a carga dos dados será feita assim que o componente for carregado. */ "autoLoad"?: boolean; /** * @description Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade serve para separar a configuração de cada uma. */ "configName"?: string; /** * @description Loader customizado para carregar as configurações. * @param configName - Nome da configuração. * @param resourceId - ID do recurso. * @param options - Opções adicionais. * @returns Retorna a configuração dos filtros. */ "customFilterBarConfig"?: (configName: string, resourceId: string, options: any) => Promise>; /** * @description Recebe o DataUnit do ambiente. Se não for informado, procura pela referência do SnkDataUnit. Necessário para se registrar como provedor de filtros. */ "dataUnit"?: DataUnit; /** * @description Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). */ "disablePersonalizedFilter"?: boolean; /** * @description Define se o componente deve usar o LockManager para controle de carregamento. */ "enableLockManagerLoadingComp"?: boolean; /** * @description Chave da configuração legada da barra de filtros. */ "filterBarLegacyConfigName"?: string; /** * @description Lista todos os filtros disponíveis ao usuário. */ "filterConfig"?: Array; /** * @description Configuração customizada dos filtros. * @param config - Lista de configurações de filtros. */ "filterCustomConfig"?: Array; /** * @description Intercepta a configuração dos filtros antes de serem aplicadas. * @param config - Lista de configurações de filtros. * @returns Retorna a lista de configurações de filtros. */ "filterCustomConfigInterceptor"?: (config: Array) => Array; /** * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * @description Modo de apresentação da barra de filtros. */ "mode"?: "regular" | "button" | "hidden"; /** * @description Evento emitido quando a configuração dos filtros é atualizada. * @param configs - Lista de configurações de filtros atualizadas. * @event */ "onConfigUpdated"?: (event: SnkFilterBarCustomEvent) => void; /** * @description Identificador de recursos como configurações e acesso. */ "resourceID"?: string; /** * @description Título que será apresentado na barra de filtros. */ "title"?: string; } interface SnkFilterBinarySelect { /** * Define as configurações do componente snk-filter-binary-select */ "config"?: SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage"?: string; /** * Emitido quando o valor do filtro é alterado. */ "onValueChanged"?: (event: SnkFilterBinarySelectCustomEvent) => void; /** * Define a variação do componente */ "presentationMode"?: EPresentationMode; /** * Define o valor do componente snk-filter-binary-select */ "value"?: any; } interface SnkFilterCheckboxList { /** * Define as configurações do componente snk-filter-multi-select */ "config"?: SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage"?: string; /** * Emite um evento customizado ao realizar alteração nos valores do componente */ "onValueChanged"?: (event: SnkFilterCheckboxListCustomEvent) => void; } interface SnkFilterDetail { /** * Define as configurações do componente snk-filter-detail. */ "config"?: SnkFilterItemConfig; /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage"?: (key: string, props?: any) => string; /** * Emitido quando há uma alteração nos filtros. */ "onFilterChange"?: (event: SnkFilterDetailCustomEvent) => void; /** * Define se o filtro pode ser removido. */ "removalBlocked"?: boolean; /** * Controla a visibilidade do botão de fixar elemento */ "showHardFixed"?: boolean; } interface SnkFilterFieldSearch { /** * Define a fonte de dados que o componente vai utilizar para carregamento dos campos. */ "fieldsDataSource"?: FilterFieldsDataSource; /** * Emitido sempre que um item da lista for selecionado * @type {EventEmitter} */ "onEzSelectFilterItem"?: (event: SnkFilterFieldSearchCustomEvent) => void; /** * Define se o componente irá possuir um campo de pesquisa. */ "searchable"?: boolean; } interface SnkFilterItem { /** * Define as configurações do componente snk-filter-item. */ "config"?: SnkFilterItemConfig; /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage"?: (key: string, props?: any) => string; /** * Emitido quando há uma alteração nos filtros. */ "onFilterChange"?: (event: SnkFilterItemCustomEvent) => void; /** * Emitido quando o detalhe de um item da lista é aberto ou fechado. */ "onVisibleChanged"?: (event: SnkFilterItemCustomEvent) => void; /** * Usado para controlar a visibilidade dos chips de filtros */ "showChips"?: boolean; } interface SnkFilterList { /** * Define a classe CSS a ser adicionada no botão (usado principalmente para sinalizar o filtro aplicado). */ "buttonClass"?: string; /** * Define o texto exibido quando a lista está vazia. */ "emptyText"?: string; /** * Define o texto exibido no componente de busca. */ "findFilterText"?: string; /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage"?: (key: string, props?: any) => string; /** * Define o ícone usado no ez-button do filtro. */ "iconName"?: string; /** * Guarda a lista de filtros. */ "items"?: Array; /** * Define o label usado no ez-button do filtro. */ "label"?: string; /** * Disparado quando um item da lista é clicado. */ "onSnkItemSelected"?: (event: SnkFilterListCustomEvent) => void; } interface SnkFilterModal { /** * Ação executada ao adicionar um filtro personalizado */ "addPersonalizedFilter"?: (isDefault?: boolean) => void; /** * Ação executada ao aplicar os filtros */ "applyFilters"?: (updatedFilterConfig: Array) => void; /** * Ação disparada ao fechar o modal */ "closeModal"?: () => void; /** * Nome da configuração. Serve para distinguir várias instâncias do componente. */ "configName"?: string; /** * Ação executada ao deletar um filtro personalizado */ "deletePersonalizedFilter"?: (filter: IPersonalizedFilter, configName: string, isDefault?: boolean) => void; /** * Desabilita a apresentação da opção de filtros personalizados na filter bar (chip de filtros) e no modal lateral de filtros (container de filtros personalizados). */ "disablePersonalizedFilter"?: boolean; /** * Ação executada ao editar um filtro personalizado */ "editPersonalizedFilter"?: (id:string, isDefault?: boolean) => void; /** * Filtros a serem apresentados */ "filterConfig"?: Array; /** * @description Intercepta a configuração dos filtros antes de serem aplicadas. * @param config - Lista de configurações de filtros. * @returns Retorna a lista de configurações de filtros. */ "filterCustomConfigInterceptor"?: (config: Array) => Array; /** * Guarda o filtro a ser deletado no Apply do modal */ "filterDefaultToDelete"?: SnkFilterItemConfig; /** * Guarda filtros a serem deletados no Apply do modal */ "filtersToDelete"?: IPersonalizedFilter[]; /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage"?: (key: string, props?: any) => string; /** * Define se o modal está aberto ou não. */ "opened"?: boolean; } interface SnkFilterModalItem { /** * Nome da configuração. Serve para distinguir várias instâncias do componente. */ "configName"?: string; "filterItem"?: SnkFilterItemConfig; "onAddPersonalizedFilter"?: (event: SnkFilterModalItemCustomEvent) => void; "onEditPersonalizedFilter"?: (event: SnkFilterModalItemCustomEvent) => void; "onFilterChange"?: (event: SnkFilterModalItemCustomEvent) => void; /** * Identificador de recursos como configurações e acesso. */ "resourceID"?: string; } interface SnkFilterMultiSelect { /** * Define as configurações do componente snk-filter-multi-select */ "config"?: SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage"?: string; /** * Emitido quando o valor do filtro é alterado. */ "onValueChanged"?: (event: SnkFilterMultiSelectCustomEvent) => void; /** * Define o valor do componente snk-filter-multi-select */ "value"?: any; } interface SnkFilterNumber { /** * Define as configurações do componente snk-filter-number */ "config"?: SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage"?: string; /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage"?: (key: string, props?: any) => string; /** * Emitido quando o valor do filtro é alterado. */ "onValueChanged"?: (event: SnkFilterNumberCustomEvent) => void; /** * Define a variação do componente */ "presentationMode"?: EPresentationMode; /** * Define o valor do componente snk-filter-number */ "value"?: FilterNumberValueType; } interface SnkFilterParamConfig { /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; } interface SnkFilterPeriod { /** * Define as configurações do componente snk-filter-period */ "config"?: SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage"?: string; /** * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder. */ "getMessage"?: (key: string, props?: any) => string; /** * Emitido quando o valor do filtro é alterado. */ "onValueChanged"?: (event: SnkFilterPeriodCustomEvent) => void; /** * Define a variação do componente */ "presentationMode"?: EPresentationMode; /** * Define o valor do componente snk-filter-period */ "value"?: Period; } interface SnkFilterSearch { /** * Define as configurações do componente snk-filter-search */ "config"?: SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage"?: string; /** * Emitido quando o valor do filtro é alterado. */ "onValueChanged"?: (event: SnkFilterSearchCustomEvent) => void; /** * Define o valor do componente snk-filter-search */ "value"?: IOption2; } interface SnkFilterText { /** * Define as configurações do componente snk-filter-text. */ "config"?: SnkFilterItemConfig; /** * Usado para exibir mensagens de erro. */ "errorMessage"?: string; /** * Emitido quando o valor do filtro é alterado. */ "onValueChanged"?: (event: SnkFilterTextCustomEvent) => void; /** * Define o valor do componente snk-filter-text. */ "value"?: string; } interface SnkForm { /** * Nome usado para guardar/recuperar as configurações do formulário. */ "configName"?: string; /** * Chave da configuração legada do formulário. */ "formLegacyConfigName"?: string; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. */ "onActionClick"?: (event: SnkFormCustomEvent) => void; /** * @deprecated Esta propriedade foi descontinuada. Ela não tem mais efeito sobre o componente. */ "onExit"?: (event: SnkFormCustomEvent) => void; /** * Responsável por notificar quando ocorrer a renderização de itens do formulário. OBS: Emitido no subcomponente snk-form-view */ "onFormItemsReady"?: (event: SnkFormCustomEvent>) => void; /** * Validador responsável por checar a integridade das informações do registro. */ "recordsValidator"?: IRecordValidator; /** * Identificador de recursos como configurações e acesso. */ "resourceID"?: string; } interface SnkFormConfig { /** * Campos de configuração de formulário. */ "configManager"?: SnkFormConfigManager; /** * Repositório de dados, controla a manipulação dos dados. */ "dataUnit"?: DataUnit; /** * Ignora os campos "somente leitura" no modo de inserção. */ "ignoreReadOnlyFormFields"?: boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * Emitido ao salvar as configurações. */ "onConfigChange"?: (event: SnkFormConfigCustomEvent) => void; /** * Emitido ao fechar as configurações. */ "onConfigClose"?: (event: SnkFormConfigCustomEvent) => void; } interface SnkFormSummary { /** * Define se o card está contraído ou não. */ "contracted"?: boolean; /** * Define se o card está fixado ou não. */ "fixed"?: boolean; /** * Define quais são as informações exibidas no modo contraído. Cada atributo será exibido com seu respectivo valor. */ "summary"?: { [key:string] : any }; } interface SnkFormView { /** * Define se o botão de expandir deve ser apresentado. */ "canExpand"?: boolean; /** * Define se o botão de fixar deve ser apresentado. */ "canFix"?: boolean; /** * Define se o componente será apresentado no modo default ou no modo resumido. */ "contracted"?: boolean; /** * Registra um editor customizado para campos da grade e formulário. */ "customEditors"?: PropsCustomEditor; /** * Define a instância do DataUnit que deve se ligar ao formulário. */ "dataUnit"?: DataUnit; /** * Campo para o buscador de campos. */ "fieldSearch"?: HTMLEzSearchElement; /** * Determina o campo que deve ficar em evidência. */ "fieldToFocus"?: string; /** * Lista de campos para serem apresentados no formulário. */ "fields"?: Array; /** * Lista de propriedades que serão alteradas/adicionadas por coluna. */ "fieldsProps"?: object; /** * Define se o card está fixado ou não. */ "fixed"?: boolean; /** * Metadados de campos que definem quais campos são obrigatórios, quais devem ser limpos durante a cópia de registros e valores padões dos campos. */ "formMetadata"?: FormMetadata; /** * Texto para ser apresentado como título do componente */ "label"?: string; /** * Caminho amigável para se chegar a este detalhe. */ "levelPath"?: string; /** * Identificador único do componente, esse é utilizado para identificar o componente no evento de `snkContentCardChanged` */ "name"?: string; /** * Responsável por notificar quando ocorrer a renderização de itens do formulário. */ "onFormItemsReady"?: (event: SnkFormViewCustomEvent>) => void; /** * Emitido quando a configuração do card é alterada. */ "onSnkContentCardChanged"?: (event: SnkFormViewCustomEvent<{ formName: string, cardConfig: IFormCardConfig, propertyChanged: string }>) => void; /** * Emitido quando o campo recebe foco */ "onSnkRequestClearFieldToFocus"?: (event: SnkFormViewCustomEvent) => void; /** * Validador responsável por checar a integridade das informações do registro. */ "recordsValidator"?: IRecordValidator; "summaryFields"?: Array; } interface SnkGrid { /** * Lista de ações que devem ser usadas no botão "Mais opções" do `snk-taskbar`. */ "actionsList"?: Array; /** * Define se a grade receberá o foco automaticamente ao ser carregada. */ "autoFocus"?: boolean; /** * Define se os dados serão carregados automaticamente na inicialização do componente. */ "autoLoad"?: boolean; /** * Define se a edição de dados na grade está habilitada. */ "canEdit"?: boolean; /** * Define o data source para o filtro de colunas. */ "columnFilterDataSource"?: IMultiSelectionListDataSource; /** * Define se a grade deve ser exibida em modo compacto. */ "compact"?: boolean; /** * Nome usado para salvar e recuperar a configuração da grade. */ "configName"?: string; /** * Desabilita a apresentação da opção de filtros personalizados na barra de filtros (chip de filtros) e no modal lateral de filtros (contêiner de filtros personalizados). */ "disablePersonalizedFilter"?: boolean; /** * Habilita a inserção de registros diretamente na grade. */ "enableGridInsert"?: boolean; /** * Define se o componente deve usar o LockManager para controle de carregamento da aplicação. */ "enableLockManagerLoadingComp"?: boolean; /** * Ativa o gerenciamento de locks na grade pela Taskbar. */ "enableLockManagerTaskbarClick"?: boolean; /** * Chave da configuração legada da barra de filtros. */ "filterBarLegacyConfigName"?: string; /** * Título que será apresentado na barra de filtros. */ "filterBarTitle"?: string; /** * @description Configuração customizada dos filtros. * @param config - Lista de configurações de filtros. */ "filterCustomConfig"?: Array; /** * @description Intercepta a configuração dos filtros antes de serem aplicadas. * @param config - Lista de configurações de filtros. * @returns Retorna a lista de configurações de filtros. */ "filterCustomConfigInterceptor"?: (config: Array) => Array; /** * Define o nome do slot para elementos customizados na `Taskbar` do cabeçalho da grade. */ "gridHeaderCustomSlotId"?: string; /** * Chave da configuração legada da grade. */ "gridLegacyConfigName"?: string; /** * Determina se a grade está vinculada a um detalhe de outra tela. */ "isDetail"?: boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * Habilita a edição de múltiplos registros simultaneamente. */ "multipleEditionEnabled"?: boolean; /** * Determina se a seleção de múltiplas linhas é permitida. */ "multipleSelection"?: boolean; /** * Emitido ao clicar em um botão de ação ou item de menu. * @description Este evento é acionado quando o usuário clica em um botão de ação ou item de menu na grade, permitindo a execução de ações específicas. * @param detail - O identificador da ação clicada, que pode ser usado para determinar qual ação executar. */ "onActionClick"?: (event: SnkGridCustomEvent) => void; /** * Emitido quando o componente estiver completamente carregado. */ "onComponentReady"?: (event: SnkGridCustomEvent) => void; /** * Emitido ao realizar um duplo clique em uma linha da grade. * @description Este evento é acionado quando o usuário clica duas vezes em uma linha da grade, permitindo ações como edição rápida ou visualização de detalhes. * @param detail - Detalhes do evento, contendo a linha clicada. */ "onGridDoubleClick"?: (event: SnkGridCustomEvent) => void; /** * Altera a aparência das bordas e sombras do componente. Se `false`, aplica o padrão de sombras (ideal para o elemento principal do layout). Se `true`, aplica um contorno (ideal para quando o componente está dentro de outro, como um painel ou pop-up). */ "outlineMode"?: boolean; /** * Define o modo de exibição do contador de paginação. */ "paginationCounterMode"?: 'show' | 'hidden' | 'auto'; /** * Altera o modo de apresentação dos botões do `snk-taskbar`. */ "presentationMode"?: PresentationMode1; /** * Validador responsável por verificar a integridade dos dados de um registro. */ "recordsValidator"?: IRecordValidator; /** * Identificador de recursos, como configurações e permissões de acesso. */ "resourceID"?: string; /** * Configuração do toast de seleção da grade. */ "selectionToastConfig"?: ISelectionToastConfig; /** * Define a configuração de cores para a coluna de status. * @example ```json '{ "RECDESP": { "-1" : "#BD0025", "1" : "#157A00" } }' ``` */ "statusResolver"?: IStatusResolver | StatusResolverFunction; /** * Define o modo de exportação dos dados. */ "strategyExporter"?: IExporterStrategyMode; /** * Informa se a coluna de checkbox deve ser suprimida. */ "suppressCheckboxColumn"?: boolean; /** * Informa se a grade deve suprimir o filtro de coluna. */ "suppressFilterColumn"?: boolean; /** * Define se a grade deve suprimir a barra de rolagem horizontal. */ "suppressHorizontalScroll"?: boolean; /** * Define o identificador do contêiner de elementos customizados da `Taskbar`. */ "taskbarCustomContainerId"?: string; /** * Gerenciador das barras de tarefas. Permite determinar botões específicos ou gerenciar o estado dos botões. */ "taskbarManager"?: TaskbarManager; /** * Define o nome do slot para elementos customizados na `Taskbar` principal do componente. */ "topTaskbarCustomSlotId"?: string; /** * Quando `true`, a tecla ENTER navega entre as células como a tecla TAB. */ "useEnterLikeTab"?: boolean; /** * Define se a grade deve exibir um buscador de colunas ao pressionar `Ctrl+F`. */ "useSearchColumn"?: boolean; } interface SnkGridConfig { /** * Colunas da grade. */ "columns"?: Array; /** * Configurações da grade. */ "config"?: IGridConfig; /** * Nome usado para salvar/recuperar a configuração. */ "configName"?: string; /** * Emitido ao cancelar a alteração das configurações. */ "onConfigCancel"?: (event: SnkGridConfigCustomEvent) => void; /** * Emitido ao salvar a alteração das configurações. */ "onConfigChange"?: (event: SnkGridConfigCustomEvent) => void; /** * Nome usado para salvar/recuperar a configuração. */ "resourceID"?: string; /** * Aba selecionada das configurações da grade. */ "selectedIndex"?: number; } interface SnkGuidesViewer { /** * Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. */ "actionsList"?: Array; /** * Define se a edição está habilitada na grid. */ "canEdit"?: boolean; /** * Nome usado para guardar/recuperar as configurações do formulário. */ "configName"?: string; /** * Representa o estado do dataUnit master. */ "dataState"?: DataState1; /** * Instância do DataUnit master. */ "dataUnit"?: DataUnit; /** * Define o identificador do container de elementos customizados da Taskbar da aba de detalhes. */ "detailTaskbarCustomContainerId"?: string; /** * Ativa inserção de registros no modo grade. */ "enableGridInsert"?: boolean; /** * Determina todo o caminho de entidades. */ "entityPath"?: string; /** * Chave da configuração legado do formulário. */ "formLegacyConfigName"?: string; /** * Fornece uma função para obter um título customizado do formulário. */ "getCustomTitle"?: () => string; /** * Ignora os campos "somente leitura" no modo de inserção. */ "ignoreReadOnlyFormFields"?: boolean; /** * Configuração do formulário master. */ "masterFormConfig"?: IFormConfig; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * Emitido sempre que houver click de botão ou ação. */ "onActionClick"?: (event: SnkGuidesViewerCustomEvent) => void; /** * Emitido quando o botão de voltar é acionado. */ "onExit"?: (event: SnkGuidesViewerCustomEvent) => void; /** * Responsável por notificar quando ocorrer a renderização de itens do formulário. */ "onFormItemsReady"?: (event: SnkGuidesViewerCustomEvent>) => void; /** * Emitido quando a configuração do formulário master é definida. */ "onSnkMasterFormConfigChange"?: (event: SnkGuidesViewerCustomEvent) => void; /** * Altera o modo de apresentação dos botões do snk-taskbar. */ "presentationMode"?: PresentationMode; /** * Validador responsável por checar a integridade das informações do registro. */ "recordsValidator"?: IRecordValidator; /** * Identificador de recursos como configurações e acesso. */ "resourceID"?: string; /** * Guia selecionada. */ "selectedGuide"?: IGuideItem; /** * Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. */ "taskbarManager"?: TaskbarManager; } interface SnkLayoutFormConfig { "messagesBuilder"?: SnkMessageBuilder; } interface SnkPersonalizedFilter { /** * Nome da configuração, utilizado para distinguir múltiplas instâncias do componente. * @property */ "configName"?: string; /** * URI da entidade utilizada para buscar os campos disponíveis para filtro. * @property */ "entityUri"?: string; /** * Identificador do filtro a ser carregado. * @property */ "filterId"?: string; /** * Indica se o filtro é o filtro padrão do sistema. * @property * @default false */ "isDefaultFilter"?: boolean; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. * @property */ "messagesBuilder"?: SnkMessageBuilder; /** * Evento emitido após salvar as alterações do filtro personalizado. * @event */ "onEzAfterSave"?: (event: SnkPersonalizedFilterCustomEvent) => void; /** * Evento emitido ao cancelar a personalização do filtro. * @event */ "onEzCancel"?: (event: SnkPersonalizedFilterCustomEvent) => void; /** * Evento emitido ao salvar as alterações do filtro personalizado. * @event */ "onEzSave"?: (event: SnkPersonalizedFilterCustomEvent) => void; /** * Identificador do recurso utilizado para salvar e recuperar filtros. * @property */ "resourceID"?: string; } interface SnkPersonalizedFilterEditor { /** * Configuração que define as opções e comportamento do componente. */ "config"?: SnkFilterItemConfig; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; "onAddFilter"?: (event: SnkPersonalizedFilterEditorCustomEvent) => void; "onDeleteFilter"?: (event: SnkPersonalizedFilterEditorCustomEvent) => void; "onEditFilter"?: (event: SnkPersonalizedFilterEditorCustomEvent) => void; /** * Emitido quando o valor do filtro é alterado. */ "onValueChanged"?: (event: SnkPersonalizedFilterEditorCustomEvent) => void; /** * Controla o modo de apresentação do componente, que pode ser configurado como modal ou chip. */ "presentationMode"?: EPresentationMode; /** * Controla o valor do componente. */ "value"?: Array; } interface SnkPesquisa { /** * Define se permite a seleção de itens não analíticos. * @type {boolean} * @default false * @example allowsNonAnalytic={true} */ "allowsNonAnalytic"?: boolean; /** * Argumento utilizado ao chamar a função searchLoader. Pode ser alterado externamente. * @type {string} * @mutable * @example argument="Texto para pesquisa" */ "argument"?: string; /** * Nome da entidade sobre a qual a pesquisa será realizada. * @type {string} * @example entityName="Produto" */ "entityName"?: string; /** * Define se a popup de pesquisa terá ou não modo hierárquico. * @type {boolean} * @default false * @example isHierarchyEntity={true} */ "isHierarchyEntity"?: boolean; /** * Função responsável em carregar os itens do componente snk-pesquisa. Deve retornar uma Promise com os dados encontrados. * @type {(text: string) => Promise} * @param text Texto utilizado como argumento de pesquisa. * @returns Promise com os dados da pesquisa. * @example searchLoader={(text) => fetchItems(text)} */ "searchLoader"?: (text: string) => Promise; /** * Função disparada ao selecionar um item da pesquisa. * @type {(option: IOption) => void} * @param option Item selecionado. * @returns void * @example selectItem={(option) => handleSelect(option)} */ "selectItem"?: (option: IOption2) => void; /** * Função responsável por carregar a árvore hierárquica do componente. Opcional. Caso não seja fornecida, o modo árvore não estará disponível. * @type {(text: string) => Promise} * @param text Texto utilizado como argumento de pesquisa para a árvore. * @returns Promise com os dados da árvore. */ "treeLoader"?: (text: string) => Promise; } interface SnkPrintSelector { } interface SnkSelectBox { /** * Emitido ao alterar a seleção do componente snk-select-box. */ "onEzChange"?: (event: SnkSelectBoxCustomEvent) => void; /** * Se true, impede que o campo de texto receba foco automaticamente ao abrir as opções. */ "preventAutoFocus"?: boolean; /** * Determina a opção selecionada. */ "selectedOption"?: IOption2 | string; } interface SnkSimpleBar { /** * Define os itens que serão apresentados no breadcrumb. */ "breadcrumbItens"?: Array; /** * Define o título do header. */ "label"?: string; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * Emitido quando algum item do breadcrumb é clicado. */ "onClickBreadcrumbItem"?: (event: SnkSimpleBarCustomEvent) => void; /** * Emitido quando o botão "voltar" é acionado. */ "onExit"?: (event: SnkSimpleBarCustomEvent) => void; } interface SnkSimpleCrud { /** * @description Ações a serem colocadas no botão "Mais opções" do componente snk-taskbar. */ "actionsList"?: Array; /** * @description Define se a grade será focada ao ser carregada. */ "autoFocus"?: boolean; /** * @description Define se a carga dos dados será feita assim que o componente for carregado. */ "autoLoad"?: boolean; /** * @description Usado para salvar as configurações dos blocos de construção. */ "configName"?: string; /** * @description Estado atual dos dados. */ "dataState"?: DataState1; /** * @description Instância do DataUnit a ser utilizada pelo componente. */ "dataUnit"?: DataUnit; /** * Desabilita a edição na grade. */ "disableGridEdition"?: boolean; /** * @description Define a chave customizada para sobrescrever as mensagens (não pegando pela entidade). */ "domainMessagesBuilder"?: string; /** * @description Habilita a inserção contínua de registros. */ "enableContinuousInsert"?: boolean; /** * @description Ativa a inserção de registros no modo grade. */ "enableGridInsert"?: boolean; /** * @description Define se o componente deve usar o LockManager para controle de carregamento da aplicação. */ "enableLockManagerLoadingComp"?: boolean; /** * @description Ativa o gerenciamento de locks na grade pela Taskbar. */ "enableLockManagerTaskbarClick"?: boolean; /** * @description Define o nome da entidade que o componente vai utilizar para fazer as operações de CRUD. */ "entityName"?: string; /** * @description Configuração do formulário. */ "formConfig"?: IFormConfig; /** * @description Chave da configuração legada do formulário. */ "formLegacyConfigName"?: string; /** * @description Configuração da grade. */ "gridConfig"?: IGridConfig; /** * @description Chave da configuração legada da grade. */ "gridLegacyConfigName"?: string; /** * @description Ignora os campos "somente leitura" no modo de inserção. */ "ignoreReadOnlyFormFields"?: boolean; /** * @description Define se o LayoutFormConfig será exibido no configurador. */ "layoutFormConfig"?: boolean; /** * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * @description Define o modo de operação do CRUD (servidor ou em memória). */ "mode"?: SIMPLE_CRUD_MODE; /** * @description Habilita a edição de múltiplos registros simultâneos. */ "multipleEditionEnabled"?: boolean; /** * @description Determina se pode haver mais de uma linha selecionada na grade. */ "multipleSelection"?: boolean; /** * @description Emitido sempre que houver clique de botão ou ação na barra de tarefas. */ "onActionClick"?: (event: SnkSimpleCrudCustomEvent) => void; /** * @description Emitido quando o salvamento da configuração no configurador do CRUD é cancelado. */ "onConfiguratorCancel"?: (event: SnkSimpleCrudCustomEvent) => void; /** * @description Emitido quando a configuração no configurador do CRUD é salva. */ "onConfiguratorSave"?: (event: SnkSimpleCrudCustomEvent) => void; /** * @description Emitido quando há qualquer mudança de estado no DataUnit. */ "onDataStateChange"?: (event: SnkSimpleCrudCustomEvent) => void; /** * @description Emitido quando o DataUnit está pronto. */ "onDataUnitReady"?: (event: SnkSimpleCrudCustomEvent) => void; /** * @description Responsável por notificar quando ocorrer a renderização de itens do formulário. */ "onFormItemsReady"?: (event: SnkSimpleCrudCustomEvent>) => void; /** * @description Altera visualmente as sombras e bordas do componente. Quando `false`, aplica o padrão de sombras ao componente (utilizar quando for o elemento principal do layout). Quando `true`, aplica o padrão de contorno ao componente (utilizar quando estiver contido em outro elemento como um painel ou pop-up). */ "outlineMode"?: boolean; /** * @description Determina quantas linhas são retornadas por página. */ "pageSize"?: number; /** * @description Define o modo de exibição do contador de paginação. */ "paginationCounterMode"?: 'show' | 'hidden' | 'auto'; /** * @description Identificador de recursos como configurações e acesso. */ "resourceID"?: string; /** * @description Usado para exibir os botões de ação do snk-configurator. */ "showConfiguratorButtons"?: boolean; /** * @description Gerenciador das barras de tarefas. É possível determinar botões específicos ou mesmo gerenciar o estado dos botões. */ "taskbarManager"?: TaskbarManager; /** * @description Determina se será usada mensagem de confirmação padrão na tentativa de cancelar a edição. */ "useCancelConfirm"?: boolean; /** * @description Quando verdadeiro, o ENTER fará a navegação como se fosse a tecla TAB na grade. */ "useEnterLikeTab"?: boolean; } interface SnkSimpleFormConfig { /** * Chave que representa a configuração do formulário */ "configName"?: string; /** * Data unit responsável pelos campos disponíveis */ "dataUnit"?: DataUnit; /** * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; "onSnkConfigSaved"?: (event: SnkSimpleFormConfigCustomEvent) => void; } interface SnkTaskbar { /** * @description Lista de ações a serem exibidas no botão "Mais opções". */ "actionsList"?: Array; /** * @description Lista de ações que devem ser usadas no botão "Mais opções" do componente snk-taskbar. */ "actionsSettingsList"?: Array; /** * @description Define o alinhamento dos itens da barra de tarefas à direita. */ "alignRigth"?: boolean; /** * @description Lista de botões, separados por vírgula, que define todos os elementos a serem criados na barra de tarefas. */ "buttons"?: string; /** * @description Nome da configuração usada para salvar ou recuperar as configurações do formulário. Também é utilizado como fallback para a chave de armazenamento do exportador de dados. */ "configName"?: string; /** * @description Mapa com definições de botões personalizados. A chave do mapa deve ser informada na propriedade `buttons` no local onde o botão deve ser renderizado. */ "customButtons"?: Map; /** * @description Define o identificador do contêiner na DOM que é responsável por guardar os elementos personalizados que não podem ser passados por slot. * @example Elementos customizados na Taskbar da aba de detalhes. */ "customContainerId"?: string; /** * @description Define o identificador do slot que recebe elementos personalizados. */ "customSlotId"?: string; /** * @description Instância do `DataUnit` com a qual a barra de tarefas irá interagir para realizar operações de dados (ex: salvar, próximo, anterior). */ "dataUnit"?: DataUnit; /** * @description Array contendo os identificadores de todos os botões que devem ser desabilitados. */ "disabledButtons"?: Array; /** * @description Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção. */ "messagesBuilder"?: SnkMessageBuilder; /** * @description Emitido sempre que um botão ou uma ação da barra de tarefas é clicado. * @eventProperty */ "onActionClick"?: (event: SnkTaskbarCustomEvent) => void; /** * @description Emitido quando uma ação de salvar é iniciada pela barra de tarefas, indicando um estado de bloqueio para evitar ações concorrentes. * @eventProperty */ "onTaskbarSaveLocker"?: (event: SnkTaskbarCustomEvent) => void; /** * @description Emitido quando a ação de salvar é concluída ou cancelada, liberando o estado de bloqueio. * @eventProperty */ "onTaskbarSaveUnlocker"?: (event: SnkTaskbarCustomEvent) => void; /** * @description Define como será o comportamento da barra de tarefas quando ocorrer um overflow de itens. */ "overflowStrategy"?: 'hiddenItems' | 'none'; /** * @description Altera o modo de apresentação dos botões da barra de tarefas. */ "presentationMode"?: PresentationMode1; /** * @description Define qual botão deve ter a aparência de destaque (primário). */ "primaryButton"?: string; /** * @description Identificador de recursos, como configurações e permissões de acesso. */ "resourceID"?: string; } interface SnkViewRepresentation { /** * Define o layout do componente: 'CASCADE' ou 'SIDE_BY_SIDE' */ "mode"?: FormLayout; } interface TaskbarActionsButton { /** * Define a lista de ações. */ "actions"?: Array; /** * Se false o usuário não pode interagir com o componente. */ "enabled"?: boolean; /** * Emitido ao selecionar uma ação */ "onTaskbarActionSelected"?: (event: TaskbarActionsButtonCustomEvent) => void; /** * Emitido quando componente é desconectado da DOM */ "onTaskbarActionsButtonDisconnected"?: (event: TaskbarActionsButtonCustomEvent) => void; /** * Emitido ao mostrar a lista de ações */ "onTaskbarActionsOpened"?: (event: TaskbarActionsButtonCustomEvent) => void; /** * Texto que será exibido no botão */ "title"?: string; } interface TaskbarSplitButton { /** * Função de callback acionada ao clicar no botão principal. * @param name Nome da ação a ser executada. */ "action"?: (name: string) => void; /** * Define a lista de ações disponíveis no dropdown do botão. */ "actions"?: Array; /** * Classe CSS personalizada para estilizar o botão. */ "className"?: string; /** * Identificador de elemento para fins de rastreamento e automação de testes. */ "dataElementId"?: string; /** * Se false o usuário não pode interagir com o componente. */ "enabled"?: boolean; /** * Nome do ícone a ser exibido no botão. */ "iconName"?: string; /** * Nome identificador da ação do botão. */ "name"?: string; /** * Texto que será exibido no botão. */ "title"?: string; } interface TestePesquisa { } interface IntrinsicElements { "config-header": ConfigHeader; "configs-button": ConfigsButton; "field-config": FieldConfig; "field-item": FieldItem; "fields-layout": FieldsLayout; "fields-selector": FieldsSelector; "guides-configurator": GuidesConfigurator; "pesquisa-grid": PesquisaGrid; "pesquisa-tree": PesquisaTree; "snk-actions-button": SnkActionsButton; "snk-actions-form": SnkActionsForm; "snk-application": SnkApplication; "snk-attach": SnkAttach; "snk-client-confirm": SnkClientConfirm; "snk-configurator": SnkConfigurator; "snk-crud": SnkCrud; "snk-custom-slot-elements": SnkCustomSlotElements; "snk-data-exporter": SnkDataExporter; "snk-data-unit": SnkDataUnit; "snk-default-filter": SnkDefaultFilter; "snk-detail-view": SnkDetailView; "snk-entity-list": SnkEntityList; "snk-exporter-email-sender": SnkExporterEmailSender; "snk-expression-group": SnkExpressionGroup; "snk-expression-item": SnkExpressionItem; "snk-filter-advanced-mode": SnkFilterAdvancedMode; "snk-filter-assistent-mode": SnkFilterAssistentMode; "snk-filter-bar": SnkFilterBar; "snk-filter-binary-select": SnkFilterBinarySelect; "snk-filter-checkbox-list": SnkFilterCheckboxList; "snk-filter-detail": SnkFilterDetail; "snk-filter-field-search": SnkFilterFieldSearch; "snk-filter-item": SnkFilterItem; "snk-filter-list": SnkFilterList; "snk-filter-modal": SnkFilterModal; "snk-filter-modal-item": SnkFilterModalItem; "snk-filter-multi-select": SnkFilterMultiSelect; "snk-filter-number": SnkFilterNumber; "snk-filter-param-config": SnkFilterParamConfig; "snk-filter-period": SnkFilterPeriod; "snk-filter-search": SnkFilterSearch; "snk-filter-text": SnkFilterText; "snk-form": SnkForm; "snk-form-config": SnkFormConfig; "snk-form-summary": SnkFormSummary; "snk-form-view": SnkFormView; "snk-grid": SnkGrid; "snk-grid-config": SnkGridConfig; "snk-guides-viewer": SnkGuidesViewer; "snk-layout-form-config": SnkLayoutFormConfig; "snk-personalized-filter": SnkPersonalizedFilter; "snk-personalized-filter-editor": SnkPersonalizedFilterEditor; "snk-pesquisa": SnkPesquisa; "snk-print-selector": SnkPrintSelector; "snk-select-box": SnkSelectBox; "snk-simple-bar": SnkSimpleBar; "snk-simple-crud": SnkSimpleCrud; "snk-simple-form-config": SnkSimpleFormConfig; "snk-taskbar": SnkTaskbar; "snk-view-representation": SnkViewRepresentation; "taskbar-actions-button": TaskbarActionsButton; "taskbar-split-button": TaskbarSplitButton; "teste-pesquisa": TestePesquisa; } } export { LocalJSX as JSX }; declare module "@stencil/core" { export namespace JSX { interface IntrinsicElements { "config-header": LocalJSX.ConfigHeader & JSXBase.HTMLAttributes; "configs-button": LocalJSX.ConfigsButton & JSXBase.HTMLAttributes; "field-config": LocalJSX.FieldConfig & JSXBase.HTMLAttributes; "field-item": LocalJSX.FieldItem & JSXBase.HTMLAttributes; "fields-layout": LocalJSX.FieldsLayout & JSXBase.HTMLAttributes; "fields-selector": LocalJSX.FieldsSelector & JSXBase.HTMLAttributes; "guides-configurator": LocalJSX.GuidesConfigurator & JSXBase.HTMLAttributes; "pesquisa-grid": LocalJSX.PesquisaGrid & JSXBase.HTMLAttributes; "pesquisa-tree": LocalJSX.PesquisaTree & JSXBase.HTMLAttributes; "snk-actions-button": LocalJSX.SnkActionsButton & JSXBase.HTMLAttributes; "snk-actions-form": LocalJSX.SnkActionsForm & JSXBase.HTMLAttributes; "snk-application": LocalJSX.SnkApplication & JSXBase.HTMLAttributes; "snk-attach": LocalJSX.SnkAttach & JSXBase.HTMLAttributes; "snk-client-confirm": LocalJSX.SnkClientConfirm & JSXBase.HTMLAttributes; "snk-configurator": LocalJSX.SnkConfigurator & JSXBase.HTMLAttributes; "snk-crud": LocalJSX.SnkCrud & JSXBase.HTMLAttributes; "snk-custom-slot-elements": LocalJSX.SnkCustomSlotElements & JSXBase.HTMLAttributes; "snk-data-exporter": LocalJSX.SnkDataExporter & JSXBase.HTMLAttributes; "snk-data-unit": LocalJSX.SnkDataUnit & JSXBase.HTMLAttributes; "snk-default-filter": LocalJSX.SnkDefaultFilter & JSXBase.HTMLAttributes; "snk-detail-view": LocalJSX.SnkDetailView & JSXBase.HTMLAttributes; "snk-entity-list": LocalJSX.SnkEntityList & JSXBase.HTMLAttributes; "snk-exporter-email-sender": LocalJSX.SnkExporterEmailSender & JSXBase.HTMLAttributes; "snk-expression-group": LocalJSX.SnkExpressionGroup & JSXBase.HTMLAttributes; "snk-expression-item": LocalJSX.SnkExpressionItem & JSXBase.HTMLAttributes; "snk-filter-advanced-mode": LocalJSX.SnkFilterAdvancedMode & JSXBase.HTMLAttributes; "snk-filter-assistent-mode": LocalJSX.SnkFilterAssistentMode & JSXBase.HTMLAttributes; "snk-filter-bar": LocalJSX.SnkFilterBar & JSXBase.HTMLAttributes; "snk-filter-binary-select": LocalJSX.SnkFilterBinarySelect & JSXBase.HTMLAttributes; "snk-filter-checkbox-list": LocalJSX.SnkFilterCheckboxList & JSXBase.HTMLAttributes; "snk-filter-detail": LocalJSX.SnkFilterDetail & JSXBase.HTMLAttributes; "snk-filter-field-search": LocalJSX.SnkFilterFieldSearch & JSXBase.HTMLAttributes; "snk-filter-item": LocalJSX.SnkFilterItem & JSXBase.HTMLAttributes; "snk-filter-list": LocalJSX.SnkFilterList & JSXBase.HTMLAttributes; "snk-filter-modal": LocalJSX.SnkFilterModal & JSXBase.HTMLAttributes; "snk-filter-modal-item": LocalJSX.SnkFilterModalItem & JSXBase.HTMLAttributes; "snk-filter-multi-select": LocalJSX.SnkFilterMultiSelect & JSXBase.HTMLAttributes; "snk-filter-number": LocalJSX.SnkFilterNumber & JSXBase.HTMLAttributes; "snk-filter-param-config": LocalJSX.SnkFilterParamConfig & JSXBase.HTMLAttributes; "snk-filter-period": LocalJSX.SnkFilterPeriod & JSXBase.HTMLAttributes; "snk-filter-search": LocalJSX.SnkFilterSearch & JSXBase.HTMLAttributes; "snk-filter-text": LocalJSX.SnkFilterText & JSXBase.HTMLAttributes; "snk-form": LocalJSX.SnkForm & JSXBase.HTMLAttributes; "snk-form-config": LocalJSX.SnkFormConfig & JSXBase.HTMLAttributes; "snk-form-summary": LocalJSX.SnkFormSummary & JSXBase.HTMLAttributes; "snk-form-view": LocalJSX.SnkFormView & JSXBase.HTMLAttributes; "snk-grid": LocalJSX.SnkGrid & JSXBase.HTMLAttributes; "snk-grid-config": LocalJSX.SnkGridConfig & JSXBase.HTMLAttributes; "snk-guides-viewer": LocalJSX.SnkGuidesViewer & JSXBase.HTMLAttributes; "snk-layout-form-config": LocalJSX.SnkLayoutFormConfig & JSXBase.HTMLAttributes; "snk-personalized-filter": LocalJSX.SnkPersonalizedFilter & JSXBase.HTMLAttributes; "snk-personalized-filter-editor": LocalJSX.SnkPersonalizedFilterEditor & JSXBase.HTMLAttributes; "snk-pesquisa": LocalJSX.SnkPesquisa & JSXBase.HTMLAttributes; "snk-print-selector": LocalJSX.SnkPrintSelector & JSXBase.HTMLAttributes; "snk-select-box": LocalJSX.SnkSelectBox & JSXBase.HTMLAttributes; "snk-simple-bar": LocalJSX.SnkSimpleBar & JSXBase.HTMLAttributes; "snk-simple-crud": LocalJSX.SnkSimpleCrud & JSXBase.HTMLAttributes; "snk-simple-form-config": LocalJSX.SnkSimpleFormConfig & JSXBase.HTMLAttributes; "snk-taskbar": LocalJSX.SnkTaskbar & JSXBase.HTMLAttributes; "snk-view-representation": LocalJSX.SnkViewRepresentation & JSXBase.HTMLAttributes; "taskbar-actions-button": LocalJSX.TaskbarActionsButton & JSXBase.HTMLAttributes; "taskbar-split-button": LocalJSX.TaskbarSplitButton & JSXBase.HTMLAttributes; "teste-pesquisa": LocalJSX.TestePesquisa & JSXBase.HTMLAttributes; } } }