@sankhyalabs/sankhyablocks 1.3.34 → 1.4.0-beta.10

package/dist/collection/components/snk-filter-bar/snk-filter-bar.js

@@ -0,0 +1,462 @@
+import { h, Host } from '@stencil/core';
+import { ApplicationContext, ErrorException, ObjectUtils, StringUtils } from '@sankhyalabs/core';
+import FilterItemType from './filter-item/filter-item-type.enum';
+import { ModalAction } from '@sankhyalabs/ezui/dist/collection/components/ez-modal-container';
+import buildFilter from './filter-item/dataunitfilter/data-unit-filter-builder';
+const PERSONALIZED_FILTER = "PERSONALIZED_FILTER";
+const DEFAULT_FILTER = "DEFAULT_FILTER";
+const CLEAR_ALL_FILTERS = "CLEAR_ALL_FILTERS";
+const ADD_FILTER = "ADD_FILTER";
+const APPLIED_FILTERS = "APPLIED_FILTERS";
+export class SnkFilterBar {
+  constructor() {
+    this._updateSequence = [];
+    this._loadingPending = false;
+    this._configUpdated = false;
+    this._pendingFilters = [];
+    this._calculateSortIndex = (item) => {
+      let index = item.hardFixed ? 1000000 : 0;
+      //campos Hard Fixed não variam a ordem
+      if (!item.hardFixed) {
+        index += item.fixed ? 100000 : 0;
+        index += item.value == undefined ? 0 : 10000;
+        index += this._updateSequence.lastIndexOf(item.id) + 1;
+      }
+      return index;
+    };
+    this._filtersComparator = (a, b) => {
+      return this._calculateSortIndex(b) - this._calculateSortIndex(a);
+    };
+  }
+  observeFilterConfig(newValue, oldValue) {
+    if (oldValue != undefined && newValue == undefined) {
+      this._loadingPending = true;
+      this._configUpdated = true;
+    }
+    else {
+      const oldItems = new Map(oldValue ? oldValue.map(item => [item.id, item]) : undefined);
+      newValue.forEach(newItem => {
+        const oldItem = oldItems.get(newItem.id);
+        if (oldItem != undefined) {
+          this._configUpdated = this._configUpdated || ObjectUtils.objectToString(oldItem) != ObjectUtils.objectToString(newItem);
+          this._loadingPending = this._loadingPending || ObjectUtils.objectToString(oldItem.value) !== ObjectUtils.objectToString(newItem.value);
+        }
+        else {
+          this._configUpdated = true;
+          this._loadingPending = this._loadingPending || newItem.value != undefined;
+        }
+      });
+    }
+    this.processAfterUpdateConfig();
+  }
+  processPendingFilter() {
+    if (this._pendingFilters.length > 0 && this._currentPendingFilter == undefined) {
+      this._currentPendingFilter = this._element.querySelector("#filter-" + this._pendingFilters.pop());
+      if (this._currentPendingFilter) {
+        this._currentPendingFilter.showUp(true).then(() => {
+          this._currentPendingFilter = undefined;
+          this.processPendingFilter();
+        });
+      }
+    }
+    if (this._currentPendingFilter == undefined) {
+      this.processAfterUpdateConfig();
+    }
+  }
+  processAfterUpdateConfig() {
+    if (this._pendingFilters.length > 0) {
+      return;
+    }
+    if (this._loadingPending) {
+      this._loadingPending = false;
+      this.dataUnit.loadData();
+    }
+    if (this._configUpdated) {
+      this._configUpdated = false;
+      this._application.saveFilterBarConfig(this.filterConfig, this.configName);
+    }
+  }
+  /**
+   * 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"
+   */
+  getMessage(key, params) {
+    return this._application.messagesBuilder.getMessage(key, params);
+  }
+  getFilter(_dataUnit) {
+    var _a;
+    const filters = [];
+    (_a = this.filterConfig) === null || _a === void 0 ? void 0 : _a.filter(item => this.isActiveFilter(item)).forEach(item => {
+      const filter = buildFilter(item);
+      if (filter) {
+        filters.push(filter);
+      }
+    });
+    return filters;
+  }
+  isActiveFilter(item) {
+    return (item.visible && item.value != undefined) || item.type === FilterItemType.DEFAULT_FILTER;
+  }
+  registryFilterProvider() {
+    this.dataUnit.addFilterProvider(this);
+    if (this.filterConfig) {
+      this.dataUnit.loadData();
+    }
+  }
+  itemFocused(selectedItem) {
+    this._element.querySelectorAll("snk-filter-item,snk-filter-list").forEach(item => {
+      if (item.id === selectedItem) {
+        if (item.tagName.toLowerCase() === "snk-filter-item" && item.getClientRects()[0].x < 0) {
+          item.scrollIntoView({ behavior: "auto", inline: 'nearest' });
+        }
+      }
+      else {
+        item["hideDetail"]();
+      }
+    });
+  }
+  getFilterItems() {
+    const pinnedItems = [];
+    const unpinnedItems = [];
+    this.filterConfig
+      .filter(item => item.visible)
+      .forEach((item, index) => {
+      const itemId = `filter-${item.id}`;
+      const filterItem = (h("snk-filter-item", { onFocusin: () => this.itemFocused(itemId), id: itemId, config: item, class: index > 0 ? "ez-padding-left--medium" : "", getMessage: (key, props) => this.getMessage(key, props), key: item.id }));
+      if (item.fixed || item.hardFixed) {
+        pinnedItems.push(filterItem);
+      }
+      else {
+        unpinnedItems.push(filterItem);
+      }
+      return filterItem;
+    });
+    const elements = [];
+    elements.push(...pinnedItems);
+    if (pinnedItems.length > 0 && unpinnedItems.length > 0) {
+      elements.push(h("hr", { class: "ez-divider-vertical ez-divider--dark ez-margin-left--medium snk-filter-bar__divider" }));
+    }
+    elements.push(...unpinnedItems);
+    return elements;
+  }
+  calculateUpdateSequence(item) {
+    if (item) {
+      this._updateSequence = this._updateSequence.filter(itemId => item.id !== itemId);
+      this._updateSequence.push(item.id);
+    }
+  }
+  normalizeItem(item) {
+    const normalized = Object.assign({}, item);
+    const optionals = ["props", "value", "hardFixed", "fixed"];
+    optionals.forEach(prop => {
+      if (normalized[prop] == undefined) {
+        delete normalized[prop];
+      }
+    });
+    if (item.value === "") {
+      delete item.value;
+    }
+    return normalized;
+  }
+  updateFilter(newItem) {
+    this.filterConfig = this.filterConfig.map(item => {
+      newItem = this.normalizeItem(newItem);
+      if (item.id === newItem.id) {
+        if (ObjectUtils.objectToString(item) != ObjectUtils.objectToString(newItem)) {
+          this.calculateUpdateSequence(newItem);
+        }
+        return newItem;
+      }
+      return item;
+    }).sort((a, b) => this._filtersComparator(a, b));
+  }
+  getAddListItems() {
+    const hiddenItems = this.filterConfig
+      .filter(item => !item.visible && this.isListable(item));
+    const footerItems = [{ name: PERSONALIZED_FILTER, label: this.getMessage("snkFilterBar.customFilter"), iconName: "tune", kind: "FOOTER" }];
+    if (this.allowDefault) {
+      footerItems.push({ name: DEFAULT_FILTER, label: this.getMessage("snkFilterBar.defaultFilter"), iconName: "configuration", kind: "FOOTER" });
+    }
+    return hiddenItems.map(filter => { return { name: filter.id, label: filter.label, kind: "FILTER", iconName: null }; })
+      .concat(footerItems);
+  }
+  getActiveClass() {
+    const filterApplied = this.filterConfig.filter(item => item.value != undefined).length > 0;
+    return filterApplied ? "sc-snk-filter-bar snk-filter-bar__filter-list-items-button--active" : "";
+  }
+  isListable(item, allowPersonalized = false) {
+    return item.type !== FilterItemType.DEFAULT_FILTER && (allowPersonalized || item.type !== FilterItemType.PERSONALIZED);
+  }
+  getAppliedListItems() {
+    const appliedItems = this.filterConfig
+      .filter(item => this.isActiveFilter(item) && this.isListable(item, true));
+    return appliedItems.map(filter => {
+      return { name: filter.id, label: filter.label, kind: "FILTER", iconName: null };
+    }).concat([
+      { name: CLEAR_ALL_FILTERS, label: this.getMessage("snkFilterBar.clearAllFilters"), iconName: "cleaning", kind: "FOOTER" }
+    ]);
+  }
+  addPersonalizedFilters(personalizedItems) {
+    const activeFilters = {};
+    personalizedItems.forEach(item => {
+      if (item.active) {
+        activeFilters[item.id] = true;
+      }
+    });
+    this.filterConfig = this.filterConfig.map(item => {
+      var _a, _b;
+      if (item.type === FilterItemType.PERSONALIZED) {
+        const visible = activeFilters[item.id];
+        if (!item.visible && visible) {
+          this.calculateUpdateSequence(item);
+          if (((_b = (_a = item.props) === null || _a === void 0 ? void 0 : _a.personalizedFilter) === null || _b === void 0 ? void 0 : _b.parameters) != undefined) {
+            this._pendingFilters.push(item.id);
+          }
+        }
+        return this.normalizeItem(visible ? Object.assign(Object.assign({}, item), { visible }) : Object.assign(Object.assign({}, item), { visible, value: undefined, fixed: undefined }));
+      }
+      return item;
+    }).sort((a, b) => this._filtersComparator(a, b));
+  }
+  openDefaultFilterModal() {
+    const filterModal = document.createElement("snk-filter-modal");
+    const defaultFilter = this.filterConfig.filter(item => item.type === FilterItemType.DEFAULT_FILTER);
+    filterModal.getMessage = (key, props) => this.getMessage(key, props);
+    filterModal.modalTitle = this.getMessage("snkFilterBar.modalDefaultFilterTitle");
+    filterModal.infoText = this.getMessage(defaultFilter.length == 0 ? "snkFilterBar.modalInfoTextCreateDefault" : "snkFilterBar.modalInfoTextEditDefault");
+    filterModal.items = defaultFilter.map(item => {
+      return { id: item.id, active: true, enabled: false, label: item.label };
+    });
+    filterModal.processModalAction = (_action) => {
+      this._application.closeModal();
+    };
+    this._application.showModal(filterModal);
+  }
+  openPersonalizedModal() {
+    const filterModal = document.createElement("snk-filter-modal");
+    const personalizedFilter = this.filterConfig
+      .filter(item => item.type === FilterItemType.PERSONALIZED)
+      .sort((itemA, itemB) => StringUtils.compare(itemA.label, itemB.label));
+    filterModal.getMessage = (key, props) => this.getMessage(key, props);
+    filterModal.modalTitle = this.getMessage("snkFilterBar.modalPersonalizedFilterTitle");
+    filterModal.modalSubTitle = this.getMessage("snkFilterBar.modalPersonalizedFilterSubTitle");
+    filterModal.okButtonLabel = this.getMessage("snkFilterBar.modalOkButtonLabel");
+    filterModal.cancelButtonLabel = this.getMessage("snkFilterBar.modalCancelButtonLabel");
+    filterModal.infoText = this.getMessage("snkFilterBar.modalInfoTextCreateEditPersonalized");
+    filterModal.useSearch = true;
+    filterModal.items = personalizedFilter.map(item => {
+      return { id: item.id, active: item.visible, enabled: true, label: item.label };
+    });
+    filterModal.processModalAction = (action) => {
+      if (action === ModalAction.CANCEL) {
+        // O Botão de cancelar, tem efeito específico:
+        //  - Desmarcar todos os filtros personalizados.
+        filterModal.items = filterModal.items.map(item => {
+          return Object.assign(Object.assign({}, item), { active: false });
+        });
+      }
+      else {
+        if (action === ModalAction.OK) {
+          this.addPersonalizedFilters(filterModal.items);
+        }
+        this._application.closeModal();
+      }
+    };
+    this._application.showModal(filterModal);
+  }
+  clearFilters() {
+    let changed = false;
+    this.filterConfig = this.filterConfig.map(item => {
+      if (item.value != undefined) {
+        changed = true;
+      }
+      return Object.assign(Object.assign({}, item), { value: undefined });
+    }).sort((a, b) => this._filtersComparator(a, b));
+    return changed;
+  }
+  loadPermitions() {
+    this._application.isUserSup().then(value => this.allowDefault = value);
+  }
+  loadConfigFromApplication() {
+    this._application.getFilterBarConfig(this.configName)
+      .then((filters) => {
+      this.filterConfig = filters.map(item => this.normalizeItem(item));
+      if (this.dataUnit) {
+        this.dataUnit.loadData();
+      }
+    })
+      .catch(reason => {
+      throw new ErrorException(this.getMessage("snkFilterBar.failToLoadConfig"), reason);
+    });
+  }
+  attachDataUnit() {
+    if (this.dataUnit == undefined) {
+      let parent = this._element.parentElement;
+      while (parent) {
+        if (parent.tagName.toUpperCase() === "SNK-DATA-UNIT") {
+          const snkDataUnit = parent;
+          this.dataUnit = snkDataUnit.dataUnit;
+          if (this.dataUnit) {
+            this.registryFilterProvider();
+          }
+          else {
+            snkDataUnit.addEventListener("dataUnitReady", (evt) => {
+              this.dataUnit = evt.detail;
+              this.registryFilterProvider();
+            });
+          }
+          break;
+        }
+      }
+      parent = parent.parentElement;
+    }
+    else {
+      this.registryFilterProvider();
+    }
+  }
+  filterChangeListener(evt) {
+    this.updateFilter(evt.detail);
+  }
+  addFilterHandler(itemName) {
+    const filterItem = this.filterConfig.find(currentFilter => currentFilter.id === itemName);
+    if (itemName === PERSONALIZED_FILTER) {
+      this.openPersonalizedModal();
+    }
+    else if (itemName === DEFAULT_FILTER) {
+      this.openDefaultFilterModal();
+    }
+    else if (filterItem) {
+      this._pendingFilters.push(itemName);
+      this.updateFilter(Object.assign(Object.assign({}, filterItem), { visible: true }));
+    }
+  }
+  appliedFilterHandler(itemName) {
+    if (itemName === CLEAR_ALL_FILTERS) {
+      if (this.clearFilters()) {
+        this._application.info(this.getMessage("snkFilterBar.successfullyCleaned"), { iconName: "check" });
+      }
+    }
+    else {
+      const filterItemElement = this._element.querySelector("#filter-" + itemName);
+      if (filterItemElement) {
+        filterItemElement.showUp(true);
+      }
+    }
+  }
+  componentWillLoad() {
+    this._application = ApplicationContext.getContextValue("__SNK__APPLICATION__");
+    if (this._application) {
+      this.loadPermitions();
+      this.loadConfigFromApplication();
+    }
+    this.attachDataUnit();
+  }
+  componentDidRender() {
+    this.processPendingFilter();
+  }
+  render() {
+    if (!this.dataUnit || !this.filterConfig || this.filterConfig.length === 0) {
+      return undefined;
+    }
+    return (h(Host, null, h("ez-scroller", { direction: "horizontal" }, this.getFilterItems()), h("snk-filter-list", { id: APPLIED_FILTERS, onFocusin: () => this.itemFocused(APPLIED_FILTERS), items: this.getAppliedListItems(), getMessage: (key, params) => this.getMessage(key, params), emptyText: this.getMessage("snkFilterBar.emptyAppliedFiltersList"), findFilterText: this.getMessage("snkFilterBar.findFilter"), iconName: "filter", class: "ez-padding-left--medium", buttonClass: this.getActiveClass(), onSnkItemSelected: evt => this.appliedFilterHandler(evt.detail) }), h("snk-filter-list", { id: ADD_FILTER, onFocusin: () => this.itemFocused(ADD_FILTER), items: this.getAddListItems(), label: this.getMessage("snkFilterBar.addFilter"), getMessage: (key, params) => this.getMessage(key, params), emptyText: this.getMessage("snkFilterBar.emptyFiltersList"), findFilterText: this.getMessage("snkFilterBar.findField"), class: "ez-padding-left--medium", onSnkItemSelected: evt => this.addFilterHandler(evt.detail) }, h("ez-icon", { slot: "leftIcon", class: "ez-padding-right--small", iconName: "plus" }))));
+  }
+  static get is() { return "snk-filter-bar"; }
+  static get encapsulation() { return "scoped"; }
+  static get originalStyleUrls() {
+    return {
+      "$": ["snk-filter-bar.css"]
+    };
+  }
+  static get styleUrls() {
+    return {
+      "$": ["snk-filter-bar.css"]
+    };
+  }
+  static get properties() {
+    return {
+      "dataUnit": {
+        "type": "unknown",
+        "mutable": true,
+        "complexType": {
+          "original": "DataUnit",
+          "resolved": "DataUnit",
+          "references": {
+            "DataUnit": {
+              "location": "import",
+              "path": "@sankhyalabs/core"
+            }
+          }
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "Recebe o DataUnit do ambiente. Se n\u00E3o for informado, procura pela refer\u00EAncia\ndo SnkDataUnit. Necess\u00E1rio para se registrar como provedor de filtros."
+        }
+      },
+      "configName": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "Eventualmente poderemos ter mais de uma barra de filtros. Essa propriedade\nserve para separar a configura\u00E7\u00E3o de cada uma."
+        },
+        "attribute": "config-name",
+        "reflect": false
+      },
+      "filterConfig": {
+        "type": "unknown",
+        "mutable": true,
+        "complexType": {
+          "original": "Array<SnkFilterItemConfig>",
+          "resolved": "SnkFilterItemConfig[]",
+          "references": {
+            "Array": {
+              "location": "global"
+            },
+            "SnkFilterItemConfig": {
+              "location": "import",
+              "path": "./filter-item/snk-filter-item"
+            }
+          }
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "Lista de todos os filtros dispon\u00EDveis ao usu\u00E1rio."
+        }
+      }
+    };
+  }
+  static get states() {
+    return {
+      "allowDefault": {}
+    };
+  }
+  static get elementRef() { return "_element"; }
+  static get watchers() {
+    return [{
+        "propName": "filterConfig",
+        "methodName": "observeFilterConfig"
+      }];
+  }
+  static get listeners() {
+    return [{
+        "name": "filterChange",
+        "method": "filterChangeListener",
+        "target": undefined,
+        "capture": false,
+        "passive": false
+      }];
+  }
+}

package/dist/collection/components/snk-form/snk-form.css

@@ -0,0 +1,38 @@
+:host {
+  display: block;
+}
+
+.snk-form {
+  position: relative;
+
+  /*public*/
+  padding: var(--space--large);
+  padding-top: var(--space--medium);
+}
+
+.snk-form__header {
+  position: relative;
+
+  /*public*/
+  padding-top: var(--space--medium);
+  padding-bottom: var(--space--medium);
+  margin-bottom: var(--space--medium);
+}
+
+.snk-form__header--fixed {
+  position: sticky;
+  top: 0;
+
+  /*public*/
+  background: var(--background--body);
+  z-index: var(--more-visible, 2);
+  padding-left: var(--space--large);
+  padding-right: var(--space--large);
+  margin-left: calc(var(--space--large) * -1);
+  margin-right: calc(var(--space--large) * -1);
+  width: calc(100% + (var(--space--large) * 2));
+}
+
+.snk-form__form--hidden {
+  display: none;
+}