@sankhyalabs/sankhyablocks 0.0.0-feat-dev-kb-4158.0

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

@@ -0,0 +1,12 @@
+declare enum FilterItemType {
+  MULTI_SELECT = "MULTI_SELECT",
+  BINARY_SELECT = "BINARY_SELECT",
+  PERIOD = "PERIOD",
+  SEARCH = "SEARCH",
+  TEXT = "TEXT",
+  NUMBER = "NUMBER",
+  DEFAULT_FILTER = "DEFAULT_FILTER",
+  PERSONALIZED = "PERSONALIZED",
+  MULTI_LIST = "MULTI_LIST"
+}
+export default FilterItemType;

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

@@ -0,0 +1,49 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { SnkFilterItemConfig } from './snk-filter-item';
+import { SnkApplication } from '../../snk-application/snk-application';
+import { CustomElementFilterProps } from '../types/custom-element-filter';
+export declare class SnkFilterDetail {
+  _element: HTMLElement;
+  _editor: HTMLElement;
+  _applyButton: HTMLEzButtonElement;
+  _idContentEditor: string;
+  _application: SnkApplication;
+  originalConfig: SnkFilterItemConfig;
+  /**
+   * 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.
+   */
+  filterChange: EventEmitter<SnkFilterItemConfig>;
+  /**
+   * Exibe o componente snk-filter-detail.
+   */
+  show(): Promise<void>;
+  observeConfig(newValue: SnkFilterItemConfig): void;
+  componentDidLoad(): void;
+  changeConfig(newConfig: SnkFilterItemConfig): void;
+  getContentEditor(): CustomElementFilterProps;
+  handleValueChanged({ detail }: CustomEvent<any>): void;
+  removeItem(): void;
+  removeItemFromGroup(item: any): any;
+  getPopUpHeaderButtons(): any;
+  buildIcon(title: string, iconName: string, action: Function): any;
+  buildIdButton(buttonElement: HTMLButtonElement, title: string): void;
+  clearBinarySelectValues(): void;
+  apply(): any;
+  isVisible(): boolean;
+  clear(): void;
+  filterCanBeCleared(): boolean;
+  onKeyDonwListener(event: KeyboardEvent): void;
+  private buildRightSlot;
+  private removeValueFromConfig;
+  saveConfig(newConfig: any): void;
+  componentWillLoad(): void;
+  render(): any;
+}

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

@@ -0,0 +1,80 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+import FilterItemType from './filter-item-type.enum';
+import FilterType from '../types/filter-type.enum';
+export declare class SnkFilterItem {
+  _filterItemElement: HTMLElement;
+  _chipElement: HTMLElement;
+  _rightIconElement: HTMLElement;
+  _leftIconElement: HTMLElement;
+  _popoverContainer: HTMLElement;
+  _popover: HTMLSnkFilterDetailElement;
+  _floatingID: number;
+  _closeCallback: () => void;
+  _idSnkFilterDetail: string;
+  detailIsVisible: boolean;
+  /**
+   * 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 o detalhe de um item da lista é aberto ou fechado.
+   */
+  visibleChanged: EventEmitter<boolean>;
+  /**
+   * Emitido quando há uma alteração nos filtros.
+   */
+  filterChange: EventEmitter<SnkFilterItemConfig>;
+  observeDetailIsVisible(value: boolean): void;
+  /**
+   * Exibe os detalhes de um item da lista.
+   */
+  showUp(open?: boolean): Promise<void>;
+  private updatePosition;
+  private getFloatOptions;
+  private getScrollOffsetLeft;
+  private getScrollOffsetTop;
+  private controlScrollPage;
+  private getConfigChanges;
+  /**
+   * Oculta os detalhes de um item da lista.
+   */
+  hideDetail(): Promise<void>;
+  onDetailCloseCallback(): void;
+  innerClickCheck: (_floatingContainer: HTMLElement, node: HTMLElement) => boolean;
+  clickListener(evt: MouseEvent): void;
+  mouseDownListener(evt: MouseEvent): void;
+  getLabel(isTooltipLabel?: boolean): any;
+  calculateActiveCount(groupedItems: Array<SnkFilterItemConfig>): number;
+  componentDidLoad(): void;
+  componentDidRender(): void;
+  /**
+   * Emitido quando o estado do filtro é alterado.
+   */
+  filterChangeListener(): void;
+  canClearFilter(): boolean;
+  getRightIconName(): "close" | "chevron-up" | "chevron-down";
+  getLeftIconName(): "calendar" | "tune";
+  hasActiveElements(value: any): boolean;
+  hasActiveValue(config: any): boolean;
+  getEnabledChip(): boolean;
+  render(): any;
+}
+export interface SnkFilterItemConfig {
+  id: string;
+  label: string;
+  detailTitle: string;
+  detailModal: string;
+  type: FilterItemType;
+  filterType: FilterType;
+  visible: boolean;
+  props?: any;
+  value?: any;
+  hardFixed?: boolean;
+  fixed?: boolean;
+  removalBlocked?: boolean;
+  groupedItems: Array<SnkFilterItemConfig>;
+}

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

@@ -0,0 +1,74 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+export declare class SnkFilterList {
+  _element: HTMLElement;
+  _popoverContainer: HTMLElement;
+  _popover: HTMLElement;
+  _filterInput: HTMLEzFilterInputElement;
+  _floatingID: number;
+  _detailIsVisible: boolean;
+  _selectableItemsCount: number;
+  _preselection: number;
+  _filterArgument: string;
+  _showAll: boolean;
+  /**
+   * Define o label usado no ez-button do filtro.
+   */
+  label: string;
+  /**
+   * Define o ícone usado no ez-button do filtro.
+   */
+  iconName: string;
+  /**
+   * Guarda a lista de filtros.
+   */
+  items: Array<ListItem>;
+  /**
+   * Usado pra flexibilizar os verbetes e mensagens de acordo com o SnkMessageBuilder.
+   */
+  getMessage: (key: string, props?: any) => string;
+  /**
+   * Define o texto exibido quando a lista está vazia.
+   */
+  emptyText: string;
+  /**
+   * Define o texto exibido no componente de busca.
+   */
+  findFilterText: string;
+  /**
+   * Define a classe CSS a ser adicionada no botão (usado principalmente para sinalizar o filtro aplicado).
+   */
+  buttonClass: string;
+  /**
+   *  Disparado quando um item da lista é clicado.
+   */
+  snkItemSelected: EventEmitter<string>;
+  private showDetail;
+  innerClickCheck: (_floatingContainer: HTMLElement, node: HTMLElement) => boolean;
+  /**
+   * Oculta os detalhes do componente snk-filter-list.
+   */
+  hideDetail(): Promise<void>;
+  private onListCloseCallback;
+  private buttonClick;
+  componentDidLoad(): void;
+  componentDidRender(): void;
+  buildIdElement(buttonElement: HTMLButtonElement, name: string): void;
+  buildItemElement(item: InternalListItem): HTMLElement;
+  itemSelected(itemName: string): void;
+  getFilterItems(): any;
+  getFooterItems(): ListItem[];
+  keyDownHandler(event: KeyboardEvent): void;
+  changePreselection(newSelection: number): void;
+  render(): any;
+}
+export interface ListItem {
+  label: string;
+  name: string;
+  kind: string;
+  iconName?: string;
+}
+interface InternalListItem extends ListItem {
+  iconClass?: string;
+  labelClass?: string;
+}
+export {};

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 config para buscar no resourceId
+   */
+  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,33 @@
+import { EventEmitter } from '../../../../stencil-public-runtime';
+import FilterItemType from '../../filter-item/filter-item-type.enum';
+import { SnkFilterItemConfig } from '../../filter-item/snk-filter-item';
+import { SnkApplication } from '../../../snk-application/snk-application';
+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;
+  _application: SnkApplication;
+  filterItem: SnkFilterItemConfig;
+  /**
+   * Nome da config para buscar no resourceId
+   */
+  configName: 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;
+  private saveConfig;
+  render(): any;
+}

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

@@ -0,0 +1,79 @@
+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;
+  /**
+   * 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;
+})[];