@sankhyalabs/sankhyablocks 0.0.0-bugfix-dev-KB-11997.0

package/dist/types/components/snk-filter-bar/filter-modal/snk-filter-modal.d.ts

@@ -0,0 +1,56 @@
+import { SnkFilterItemConfig } from '../filter-item/snk-filter-item';
+export declare class SnkFilterModal {
+  private _modalTitle;
+  private _cancelButtonLabel;
+  private _okButtonLabel;
+  private _originalFilterConfig;
+  /**
+   * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
+   */
+  getMessage: (key: string, props?: any) => string;
+  /**
+   * Nome da configuração. Serve para distinguir várias instâncias do componente.
+   */
+  configName: string;
+  /**
+   * Filtros a serem apresentados
+   */
+  filters: Array<SnkFilterItemConfig>;
+  /**
+   * Ação executada ao aplicar os filtros
+   */
+  applyFilters: (updatedFilterConfig: Array<SnkFilterItemConfig>) => void;
+  /**
+   * Ação disparada ao fechar o modal
+   */
+  closeModal: () => void;
+  /**
+   * Ação executada ao adicionar um filtro personalizado
+   */
+  addPersonalizedFilter: () => void;
+  /**
+   * Ação executada ao editart um filtro personalizado
+   */
+  editPersonalizedFilter: (id: string) => void;
+  private getCustomMessage;
+  private handleClearAll;
+  private handleClearOthersFilters;
+  private handleClearCustomFilters;
+  private clearAllCustomFilter;
+  private handleClose;
+  private handleApplyFilters;
+  private isValidCustomFilter;
+  private modalActionListener;
+  private handleFilterChange;
+  private handleClearFilterList;
+  private handleClearSigleFilter;
+  private uncheckFilterValues;
+  private renderFilterItem;
+  private mountFiltersLines;
+  private renderFilterLine;
+  private getIformedFiltersCount;
+  private renderCollapsibleFilterBox;
+  componentWillRender(): void;
+  componentDidLoad(): void;
+  render(): any;
+}

package/dist/types/components/snk-filter-bar/filter-modal/subcomponents/snk-filter-modal-item.d.ts

@@ -0,0 +1,34 @@
+import { EventEmitter } from '../../../../stencil-public-runtime';
+import FilterItemType from '../../filter-item/filter-item-type.enum';
+import { SnkFilterItemConfig } from '../../filter-item/snk-filter-item';
+import { SnkFilterPersonalized } from '../../filter-item/editors/snk-personalized-filter-editor/snk-personalized-filter-editor';
+import { IPersonalizedFilter } from '../../../snk-personalized-filter/interfaces/IPersonalizedFilter';
+import { CustomElementFilterProps } from '../../types/custom-element-filter';
+export declare class SnkFilterModalItem {
+  private _idContentEditor;
+  _element: HTMLElement;
+  _editor: HTMLElement;
+  filterItem: SnkFilterItemConfig;
+  /**
+   * Nome da configuração. Serve para distinguir várias instâncias do componente.
+   */
+  configName: string;
+  /**
+   * Identificador de recursos como configurações e acesso.
+   */
+  resourceID: string;
+  filterChange: EventEmitter<SnkFilterItemConfig>;
+  editPersonalizedFilter: EventEmitter<string>;
+  addPersonalizedFilter: EventEmitter<void>;
+  observeFilterItem(newValue: SnkFilterItemConfig): void;
+  getContentEditorConfig(): CustomElementFilterProps;
+  buildSnkFilterPersonalizedProps(): CustomElementFilterProps<SnkFilterPersonalized>;
+  isVisible(newValue: any): boolean;
+  updateFilterValue(data: any): void;
+  handleDeleteFilter(filter: IPersonalizedFilter, filterItemType: FilterItemType): void;
+  componentDidLoad(): void;
+  private buildRightSlot;
+  private removeValueFromConfig;
+  canShowDetailModal(): boolean;
+  render(): any;
+}

package/dist/types/components/snk-filter-bar/snk-filter-bar.d.ts

@@ -0,0 +1,83 @@
+import { DataUnit } from '@sankhyalabs/core';
+import { Filter, FilterProvider } from '@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata';
+import { SnkMessageBuilder } from '../../lib/message/SnkMessageBuilder';
+import { SnkApplication } from '../snk-application/snk-application';
+import { SnkFilterItemConfig } from './filter-item/snk-filter-item';
+export declare class SnkFilterBar implements FilterProvider {
+  private _filterModalFactory;
+  private _elPersonalizedFilter;
+  _element: HTMLElement;
+  _application: SnkApplication;
+  _updateSequence: Array<string>;
+  _loadingPending: boolean;
+  _configUpdated: boolean;
+  _pendingVariables: boolean;
+  _customfiltersToBeUpdated: Array<SnkFilterItemConfig>;
+  _calculateSortIndex: (item: SnkFilterItemConfig) => number;
+  _filtersComparator: (a: SnkFilterItemConfig, b: SnkFilterItemConfig) => number;
+  /**
+   * 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;
+  /**
+   * Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade
+   * serve para separar a configuração de cada uma.
+   */
+  configName: string;
+  /**
+   * Identificador de recursos como configurações e acesso.
+   */
+  resourceID: string;
+  /**
+   * Lista todos os filtros disponíveis ao usuário.
+   */
+  filterConfig: Array<SnkFilterItemConfig>;
+  /**
+   * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+  */
+  messagesBuilder: SnkMessageBuilder;
+  allowDefault: boolean;
+  scrollerLocked: boolean;
+  showPersonalizedFilter: boolean;
+  personalizedFilterId: string;
+  observeFilterConfig(newValue: Array<SnkFilterItemConfig>, oldValue: Array<SnkFilterItemConfig>): void;
+  /**
+   * Faz o recarregamento da filterbar buscando o state no servidor.
+   */
+  reload(): Promise<void>;
+  componentDidLoad(): void;
+  private processPendingFilter;
+  private getPersonalizedFilterItem;
+  private processAfterUpdateConfig;
+  /**
+   * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
+   * através de um pequeno modulo na estrutura da aplicação:
+   * - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
+   * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-filter-bar.msg.ts"
+   */
+  private getMessage;
+  getFilter(_dataUnit: string): Array<Filter>;
+  private isActiveFilter;
+  private registryFilterProvider;
+  private itemFocused;
+  private filterActiveFilter;
+  private getFilterItems;
+  private calculateUpdateSequence;
+  private normalizeItem;
+  private updateFilter;
+  private loadPermitions;
+  private loadConfigFromStorage;
+  private attachDataUnit;
+  /**
+  * Emitido quando acontece a alteração do estado do filtro.
+  */
+  filterChangeListener(evt: CustomEvent): void;
+  private showFilterModal;
+  addPersonalizedFilter(): void;
+  editPersonalizedFilter(id: string): void;
+  hidePersonalizedFilter(): void;
+  componentWillLoad(): void;
+  componentDidRender(): void;
+  render(): any;
+}

package/dist/types/components/snk-filter-bar/types/custom-element-filter.d.ts

@@ -0,0 +1,6 @@
+export type CustomElementFilterProps<T = object> = {
+  tag: string;
+  props?: Partial<T> | {
+    [key: string]: any;
+  };
+};

package/dist/types/components/snk-filter-bar/types/filter-type.enum.d.ts

@@ -0,0 +1,6 @@
+export declare enum FilterType {
+  QUICK_FILTER = "QUICK_FILTER",
+  CUSTOM_FILTER = "CUSTOM_FILTER",
+  OTHER_FILTERS = "OTHER_FILTERS"
+}
+export default FilterType;

package/dist/types/components/snk-filter-bar/utils/SnkFilterModalFactory.d.ts

@@ -0,0 +1,28 @@
+import { SnkFilterItemConfig } from "../filter-item/snk-filter-item";
+type OnCompleteCallback = (filter: SnkFilterItemConfig[]) => void;
+type GetMessageFn = (key: string, params?: any) => string;
+type AddPersonalizedFilterFn = () => void;
+type EditPersonalizedFilterFn = (id: string) => void;
+export type SnkFilterModalFactoryParams = {
+  filterConfig: SnkFilterItemConfig[];
+  configName: string;
+  onComplete: OnCompleteCallback;
+  getMessage: GetMessageFn;
+  onAddPersonalizedFilter: AddPersonalizedFilterFn;
+  onEditPersonalizedFilter: EditPersonalizedFilterFn;
+};
+declare class SnkFilterModalFactory {
+  private _closeModal;
+  private _configName;
+  private _onComplete;
+  private _filterConfig;
+  private _getMessage;
+  private _addPersonalizedFilterFn;
+  private _editPersonalizedFilterFn;
+  constructor({ filterConfig, configName, onComplete, getMessage, onAddPersonalizedFilter, onEditPersonalizedFilter }: SnkFilterModalFactoryParams);
+  private applyFilters;
+  private buildFilterModal;
+  showModal(): Promise<void>;
+  closeModal(): Promise<void>;
+}
+export default SnkFilterModalFactory;

package/dist/types/components/snk-filter-bar/utils/filters-mock.d.ts

@@ -0,0 +1,263 @@
+export declare const filtersMock: ({
+  id: string;
+  label: string;
+  detailTitle: string;
+  detailModal: string;
+  visible: boolean;
+  type: string;
+  filterType: string;
+  groupedItems: ({
+    id: string;
+    label: string;
+    detailTitle: string;
+    type: string;
+    active: boolean;
+    props: {
+      expression: string;
+      personalizedFilter: {
+        parameters: {
+          name: string;
+          label: string;
+          type: string;
+          dataType: string;
+          searchContext: {
+            entity: string;
+            entityDescription: string;
+            searchOptions: {
+              rootEntity: string;
+              descriptionFieldName: string;
+              codeFieldName: string;
+              showInactives: boolean;
+            };
+          };
+        }[];
+      };
+    };
+    value: {
+      value: string;
+      label: string;
+    }[];
+    visible: boolean;
+    filterType: string;
+  } | {
+    id: string;
+    label: string;
+    detailTitle: string;
+    type: string;
+    props: {
+      expression: string;
+      personalizedFilter: {
+        parameters: {
+          name: string;
+          label: string;
+          type: string;
+          dataType: string;
+          props: {
+            precision: string;
+          };
+        }[];
+      };
+    };
+    value: number[];
+    visible: boolean;
+    filterType: string;
+    active?: undefined;
+  })[];
+  props?: undefined;
+  value?: undefined;
+  hardFixed?: undefined;
+} | {
+  id: string;
+  label: string;
+  detailTitle: string;
+  type: string;
+  props: {
+    options: {
+      name: string;
+      expression: string;
+      label: string;
+    }[];
+    expression?: undefined;
+    personalizedFilter?: undefined;
+    searchContext?: undefined;
+  };
+  value: string;
+  hardFixed: boolean;
+  visible: boolean;
+  filterType: string;
+  detailModal: string;
+  groupedItems?: undefined;
+} | {
+  id: string;
+  label: string;
+  detailTitle: string;
+  type: string;
+  props: {
+    expression: string;
+    options?: undefined;
+    personalizedFilter?: undefined;
+    searchContext?: undefined;
+  };
+  visible: boolean;
+  filterType: string;
+  detailModal?: undefined;
+  groupedItems?: undefined;
+  value?: undefined;
+  hardFixed?: undefined;
+} | {
+  id: string;
+  label: string;
+  detailTitle: string;
+  type: string;
+  props: {
+    expression: {
+      fullfill: string;
+      onlystart: string;
+      onlyend: string;
+    };
+    options?: undefined;
+    personalizedFilter?: undefined;
+    searchContext?: undefined;
+  };
+  visible: boolean;
+  filterType: string;
+  detailModal?: undefined;
+  groupedItems?: undefined;
+  value?: undefined;
+  hardFixed?: undefined;
+} | {
+  id: string;
+  label: string;
+  detailTitle: string;
+  type: string;
+  props: {
+    expression: string;
+    personalizedFilter: {
+      parameters: any[];
+    };
+    options?: undefined;
+    searchContext?: undefined;
+  };
+  filterType: string;
+  detailModal?: undefined;
+  visible?: undefined;
+  groupedItems?: undefined;
+  value?: undefined;
+  hardFixed?: undefined;
+} | {
+  id: string;
+  label: string;
+  detailTitle: string;
+  type: string;
+  props: {
+    expression: string;
+    searchContext: {
+      entity: string;
+      entityDescription: string;
+      searchOptions: {
+        rootEntity: string;
+        descriptionFieldName: string;
+        codeFieldName: string;
+        showInactives: boolean;
+      };
+    };
+    options?: undefined;
+    personalizedFilter?: undefined;
+  };
+  visible: boolean;
+  filterType: string;
+  detailModal: string;
+  groupedItems?: undefined;
+  value?: undefined;
+  hardFixed?: undefined;
+} | {
+  id: string;
+  label: string;
+  detailTitle: string;
+  type: string;
+  props: {
+    expression: string;
+    searchContext: {
+      entity: string;
+      entityDescription: string;
+      searchOptions: {
+        rootEntity: string;
+        descriptionFieldName: string;
+        codeFieldName: string;
+        showInactives: boolean;
+      };
+    };
+    options?: undefined;
+    personalizedFilter?: undefined;
+  };
+  filterType: string;
+  detailModal?: undefined;
+  visible?: undefined;
+  groupedItems?: undefined;
+  value?: undefined;
+  hardFixed?: undefined;
+} | {
+  id: string;
+  label: string;
+  detailTitle: string;
+  type: string;
+  props: {
+    expression: {
+      fullfill: string;
+      onlystart: string;
+      onlyend: string;
+    };
+    options?: undefined;
+    personalizedFilter?: undefined;
+    searchContext?: undefined;
+  };
+  detailModal?: undefined;
+  visible?: undefined;
+  filterType?: undefined;
+  groupedItems?: undefined;
+  value?: undefined;
+  hardFixed?: undefined;
+} | {
+  id: string;
+  label: string;
+  detailTitle: string;
+  type: string;
+  props: {
+    expression: string;
+    options?: undefined;
+    personalizedFilter?: undefined;
+    searchContext?: undefined;
+  };
+  detailModal?: undefined;
+  visible?: undefined;
+  filterType?: undefined;
+  groupedItems?: undefined;
+  value?: undefined;
+  hardFixed?: undefined;
+} | {
+  id: string;
+  label: string;
+  detailTitle: string;
+  type: string;
+  props: {
+    expression: string;
+    searchContext: {
+      entity: string;
+      entityDescription: string;
+      searchOptions: {
+        rootEntity: string;
+        descriptionFieldName: string;
+        codeFieldName: string;
+        showInactives: boolean;
+      };
+    };
+    options?: undefined;
+    personalizedFilter?: undefined;
+  };
+  detailModal?: undefined;
+  visible?: undefined;
+  filterType?: undefined;
+  groupedItems?: undefined;
+  value?: undefined;
+  hardFixed?: undefined;
+})[];

package/dist/types/components/snk-filter-field-search/interfaces/index.d.ts

@@ -0,0 +1,39 @@
+import { UserInterface } from "@sankhyalabs/core";
+import { DataType } from "@sankhyalabs/core";
+export interface FilterFieldsDataSource {
+  fetchData(link?: IFilterLink): Promise<IFilterMetadata>;
+}
+export declare enum SelectedItemType {
+  LINK = "LINK",
+  FIELD = "FIELD"
+}
+export interface IPropertiesFieldSearch {
+  [key: string]: any;
+}
+export interface IFilterField {
+  description: string;
+  label: string;
+  name: string;
+  uri: string;
+  onlyDate: boolean;
+  dataType: DataType;
+  userInterface: UserInterface;
+  properties: IPropertiesFieldSearch;
+  entityName?: string;
+  type?: SelectedItemType;
+  path?: string;
+  entityPath?: Array<string>;
+}
+export interface IFilterLink {
+  id?: string;
+  uri: string;
+  description: string;
+  fieldCount: number;
+  type?: SelectedItemType;
+  cache?: boolean;
+}
+export interface IFilterMetadata {
+  fields: Array<IFilterField>;
+  links: Array<IFilterLink>;
+  currentLink: IFilterLink;
+}

package/dist/types/components/snk-filter-field-search/snk-filter-field-search.d.ts

@@ -0,0 +1,68 @@
+import { EventEmitter } from "../../stencil-public-runtime";
+import { IFilterField, IFilterLink, FilterFieldsDataSource } from "./interfaces";
+import { IBreadcrumbItem } from "@sankhyalabs/ezui/dist/types/components/ez-breadcrumb/ez-breadcrumb";
+import { ListGroup } from "@sankhyalabs/ezui/dist/types/components/ez-list/ez-list";
+import { IEzPopoverAnchorOptions } from "@sankhyalabs/ezui/dist/types/components/ez-popover/ez-popover";
+export declare class SnkFilterFieldSearch {
+  private _ezLinkList;
+  private _ezFieldList;
+  private _ezPopover;
+  private _application;
+  private _currentMetadata;
+  private _currentLink;
+  private _filterText;
+  private _isLoading;
+  /**
+   * Define se o componente irá possuir um campo de pesquisa.
+  */
+  searchable: boolean;
+  /**
+   * Define a fonte de dados que o componente vai utilizar
+   * para carregamento dos campos.
+  */
+  fieldsDataSource: FilterFieldsDataSource;
+  breadcrumbItems: Array<IBreadcrumbItem>;
+  linkItems: Array<ListGroup>;
+  fieldItems: Array<ListGroup>;
+  searchEmpty: boolean;
+  groupEmpty: boolean;
+  /**
+   * Emitido sempre que um item da lista for selecionado
+   * @type {EventEmitter<IFilterField | IFilterLink>}
+  */
+  ezSelectFilterItem: EventEmitter<IFilterField | IFilterLink>;
+  /**
+   * /**
+   * Realiza a abertura do componente abaixo do elemento HTML informado
+   * e faz a primeira carga de dados.
+   *
+   * @param {HTMLElement} element - Elemento HTML onde o snk-filter-field-search irá se posicionar abaixo.
+   * @param {IEzPopoverAnchorOptions} options - opções para regular o posicionamento do componente.
+   */
+  show(element?: HTMLElement, options?: IEzPopoverAnchorOptions): Promise<void>;
+  /**
+   * Filtra a fonte de dados do componente.
+   * @param {string} filterText - Texto para filtrar a fonte de dados.
+   * @throws {Error} - Quando o componente estiver com a propriedade searchable como true.
+  */
+  applyFilter(filterText: string): Promise<void>;
+  private loadData;
+  private mapDataSourceToLinkItems;
+  private mapDataSourceToFieldItems;
+  private handleFilterChange;
+  private handleSelectLink;
+  private getEntityFromBreadCrumbItem;
+  private handleSelectField;
+  private getElementID;
+  /**
+   * Conforme mecanismo de mensagens, é possível customizar as mensagens dos blocos de construção
+   * através de um pequeno modulo na estrutura da aplicação:
+   * - Criar um arquivo no seguinte caminho: /messages/appmessages.msg.js.
+   * Para conhecer os detalhes do módulo, vide o arquivo neste projeto "/src/lib/message/resources/snk-filter-field-search.msg.ts"
+  */
+  private getMessage;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  disconnectedCallback(): void;
+  render(): any;
+}

package/dist/types/components/snk-filter-field-search/subcomponents/index.d.ts

@@ -0,0 +1 @@
+export * from './list-item';

package/dist/types/components/snk-filter-field-search/subcomponents/list-item.d.ts

@@ -0,0 +1,2 @@
+import { IFilterField } from "../interfaces";
+export declare const ListItem: ({ userInterface, description }: IFilterField) => any;

package/dist/types/components/snk-form/SnkFormConfigManager.d.ts

@@ -0,0 +1,24 @@
+import { IFormCardConfig, IFormConfig } from "@sankhyalabs/ezui/dist/types/utils/form/interfaces";
+import { DataUnit } from "@sankhyalabs/core";
+import { IUserConfig } from "../../lib/http/data-fetcher/fetchers/form-config-fetcher";
+export declare class SnkFormConfigManager {
+  private _config;
+  private _onConfigChange;
+  isLoaded: boolean;
+  private _configName;
+  private _formConfigFetcher;
+  private _resourceID;
+  constructor(configName: string, resourceID: string, onConfigChange?: (config: IFormConfig) => void);
+  loadConfig(): Promise<IFormConfig>;
+  saveConfig(config: IFormConfig): Promise<IFormConfig>;
+  saveCardState(cardId: string, cardConfig: IFormCardConfig, propertyChanged: string): Promise<Map<string, IFormCardConfig>>;
+  private updateFixSequence;
+  private getFieldsList;
+  private getInsertionConfig;
+  setConfig(config: IFormConfig): void;
+  getConfig(insertionMode: boolean, dataUnit: DataUnit): IFormConfig;
+  private getFormConfigFetcher;
+  fetchUserAvailableConfigs(): Promise<Array<IUserConfig>>;
+  fetchLegacyConfig(): Promise<IFormConfig>;
+  fetchDefaultConfig(): Promise<IFormConfig>;
+}

package/dist/types/components/snk-form/snk-form.d.ts

@@ -0,0 +1,54 @@
+import { DataUnit } from '@sankhyalabs/core';
+import { IRecordValidator } from '@sankhyalabs/ezui/dist/types/utils/form/interfaces';
+import { EventEmitter } from '../../stencil-public-runtime';
+import { DataState } from '../snk-data-unit/snk-data-unit';
+import { SnkFormConfigManager } from './SnkFormConfigManager';
+import { SnkMessageBuilder } from '../../lib/message/SnkMessageBuilder';
+export declare class SnkForm {
+  private _snkDataUnit;
+  _element: HTMLElement;
+  _dataUnit: DataUnit;
+  _dataState: DataState;
+  _showFormConfig: boolean;
+  _configManager: SnkFormConfigManager;
+  /**
+   * Nome usado para guardar/recuperar as configurações do formulário.
+   */
+  configName: string;
+  /**
+   * Validador responsável por checar a integridade das informações do registro.
+   */
+  recordsValidator: IRecordValidator;
+  /**
+   * Responsável por flexibilizar e padronizar o uso de mensagens nos blocos de construção.
+   */
+  messagesBuilder: SnkMessageBuilder;
+  /**
+   * Identificador de recursos como configurações e acesso.
+   */
+  resourceID: string;
+  /**
+   * Emitido quando o botão de voltar é acionado.
+   */
+  exit: EventEmitter<void>;
+  /**
+   * Emitido sempre que houver click de botão ou ação.
+   */
+  actionClick: EventEmitter<string>;
+  /**
+   * Responsável por notificar quando ocorrer a renderização de itens do formulário.
+   */
+  formItemsReady: EventEmitter<Array<HTMLElement>>;
+  /**
+   * Exibe a janela de configurações do formulário.
+   */
+  showConfig(): Promise<void>;
+  /**
+   * Fecha a janela de configurações do formulário.
+   */
+  hideConfig(): Promise<void>;
+  private closeConfig;
+  private dataunitReady;
+  componentWillLoad(): Promise<void>;
+  render(): any;
+}