@sankhyalabs/sankhyablocks 8.15.1 → 8.16.0-dev.2

package/dist/collection/components/snk-grid/snk-grid.js

@@ -1,6 +1,5 @@
 import { h, Fragment } from '@stencil/core';
-import { ApplicationContext, DataType, ElementIDUtils, StringUtils } from '@sankhyalabs/core';
-import { UserInterface } from '@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata';
+import { Action as DUAction, ApplicationContext, ElementIDUtils, StringUtils } from '@sankhyalabs/core';
 import { TaskbarElement } from '../snk-taskbar/elements/taskbar-elements';
 import { ConfigStorage } from '../../lib/configs/ConfigStorage';
 import { PresentationMode } from '../../lib/@types';
@@ -10,8 +9,12 @@ import SnkMultiSelectionListDataSource from './filtercolumn/SnkMultiSelectionLis
 import { SelectionMode } from '@sankhyalabs/core/dist/dataunit/DataUnit';
 import { buildFieldSearch, openFieldSearch } from '../snk-taskbar/subcomponents/field-search';
 import { CrudUtils } from '../../lib';
+import RmPrecisionCustomValueFormatter from '../../lib/DefaultCustomFormatters/RmPrecisionCustomValueFormatter';
+import ServerSideExporterProvider from '../snk-data-exporter/providers/ServerSideExporterProvider';
 export class SnkGrid {
   constructor() {
+    this._customEditors = new Map();
+    this._customRenders = new Map();
     this._topTaskbarProcessor = new TaskbarProcessor({
       "snkGridTopTaskbar.regular": ["FORM_MODE", "CONFIGURATOR", "INSERT"],
       "snkGridTopTaskbar.regular.secondary": ["FORM_MODE", "CONFIGURATOR", "INSERT"],
@@ -31,6 +34,14 @@ export class SnkGrid {
       "snkGridHeaderTaskbar.singleTaskbar.detail.selected": ["UPDATE", "ATTACH", "CLONE", "REMOVE", "MORE_OPTIONS", "DIVIDER", "FORM_MODE", "CONFIGURATOR", "REFRESH"],
       "snkGridHeaderTaskbar.singleTaskbar.finish_edition": ["CANCEL", "SAVE"]
     });
+    this.dataUnitInterceptor = {
+      interceptAction: async (action) => {
+        if (action.type === DUAction.METADATA_LOADED) {
+          return await this.interceptMetadataLoaded(action);
+        }
+        return action;
+      }
+    };
     this._dataUnit = undefined;
     this._dataState = undefined;
     this._gridConfig = undefined;
@@ -57,6 +68,8 @@ export class SnkGrid {
     this.disablePersonalizedFilter = undefined;
     this.gridLegacyConfigName = undefined;
     this.filterBarLegacyConfigName = undefined;
+    this.autoLoad = undefined;
+    this.autoFocus = true;
   }
   /**
    * Exibe a janela de configurações da grade.
@@ -101,6 +114,42 @@ export class SnkGrid {
   async findColumn() {
     await openFieldSearch(this._moreOptions, this._columnSearch);
   }
+  /**
+   * Registra um editor customizado para campos da grade e formulário
+   */
+  async addCustomEditor(fieldName, customEditor, detailContext) {
+    if (this._grid) {
+      this._grid.addCustomEditor(fieldName, customEditor, detailContext);
+      return;
+    }
+    const newCustomEditors = new Map(this._customEditors);
+    newCustomEditors.set(fieldName, { customEditor, detailContext });
+    this._customEditors = newCustomEditors;
+  }
+  /**
+   * Registra um render customizado para colunas da grid.
+   */
+  async addGridCustomRender(fieldName, customRender, detailContext) {
+    if (this._grid) {
+      this._grid.addGridCustomRender(fieldName, customRender, detailContext);
+      return;
+    }
+    const newCustomRenders = new Map(this._customRenders);
+    newCustomRenders.set(fieldName, { customRender, detailContext });
+    this._customRenders = newCustomRenders;
+  }
+  /**
+   * Registra um formatador de valores para uma coluna da grid.
+   */
+  async addCustomValueFormatter(columnName, customFormatter) {
+    this._grid.addCustomValueFormatter(columnName, customFormatter);
+  }
+  /**
+   * Remove o formatador de valores de uma coluna da grid.
+   */
+  async removeCustomValueFormatter(columnName) {
+    this._grid.removeCustomValueFormatter(columnName);
+  }
   /**
    * Atribui o foco para a grade.
    */
@@ -161,106 +210,31 @@ export class SnkGrid {
     });
     evt.stopPropagation();
   }
-  buildColumnsMetadata(gridColumns) {
-    const columnsMetadata = [];
-    gridColumns === null || gridColumns === void 0 ? void 0 : gridColumns.forEach((column) => {
-      var _a, _b;
-      /**
-       * TODO: Analisar e criar uma melhor forma de tratar essa validação do "RECDESP".
-       */
-      if (column.hidden && column.name !== "RECDESP") {
-        return;
-      }
-      const fieldData = (_a = this._dataUnit) === null || _a === void 0 ? void 0 : _a.getField(column.name);
-      const columnData = {
-        label: column.label,
-        id: column.name,
-        width: column.width,
-        type: fieldData === null || fieldData === void 0 ? void 0 : fieldData.dataType,
-        userInterface: fieldData === null || fieldData === void 0 ? void 0 : fieldData.userInterface
-      };
-      columnsMetadata.push(columnData);
-      if (((_b = fieldData === null || fieldData === void 0 ? void 0 : fieldData.properties) === null || _b === void 0 ? void 0 : _b.DESCRIPTIONFIELD) != undefined) {
-        const mergedFrom = fieldData.properties.mergedFrom;
-        const descriptionField = `${fieldData.properties.ENTITYNAME}.${fieldData.properties.DESCRIPTIONFIELD}`;
-        const descriptionColumn = {
-          label: fieldData.properties.DESCRIPTIONENTITY,
-          id: `${mergedFrom ? (mergedFrom + ".") : ""}${descriptionField}`,
-          width: 200,
-          type: DataType.TEXT,
-          userInterface: UserInterface.LONGTEXT
-        };
-        columnsMetadata.push(descriptionColumn);
-      }
-    });
-    return columnsMetadata || [];
-  }
-  getPaginationInfo() {
-    var _a;
-    return (_a = this._dataUnit) === null || _a === void 0 ? void 0 : _a.getPaginationInfo();
-  }
-  getExporterOffset(paginationInfo) {
-    if (paginationInfo == undefined) {
-      return;
-    }
-    const offset = paginationInfo.firstRecord;
-    if (offset > 0) {
-      return (offset - 1);
-    }
-    return offset;
-  }
   async dataExporterProviderStore() {
-    var _a;
-    const selectedIDs = await ((_a = this._snkDataUnit) === null || _a === void 0 ? void 0 : _a.getSelectedRecordsIDsInfo());
-    const dataExporterProvider = {
-      getFilters: () => {
-        var _a;
-        return (_a = this._dataUnit) === null || _a === void 0 ? void 0 : _a.getAppliedFilters();
-      },
-      getColumnsMetadata: async () => {
-        var _a;
-        const columnsState = await ((_a = this._grid) === null || _a === void 0 ? void 0 : _a.getColumnsState());
-        return this.buildColumnsMetadata(columnsState);
-      },
-      getOrders: () => {
-        var _a;
-        return (_a = this._dataUnit) === null || _a === void 0 ? void 0 : _a.getSort();
-      },
-      getResourceURI: () => {
-        var _a;
-        return (_a = this._dataUnit) === null || _a === void 0 ? void 0 : _a.name;
-      },
-      getSelectedNumber: () => {
-        var _a, _b;
-        return (_b = (_a = this._dataState) === null || _a === void 0 ? void 0 : _a.selectionInfo) === null || _b === void 0 ? void 0 : _b.length;
-      },
-      getTotalRecords: () => {
-        var _a, _b, _c;
-        const { total } = ((_a = this._dataUnit) === null || _a === void 0 ? void 0 : _a.getPaginationInfo()) || {};
-        return total !== null && total !== void 0 ? total : (_c = (_b = this._dataUnit) === null || _b === void 0 ? void 0 : _b.records) === null || _c === void 0 ? void 0 : _c.length;
-      },
-      getSelectedIDs: () => {
-        return selectedIDs || [];
-      },
-      getOffset: () => {
-        return this.getExporterOffset(this.getPaginationInfo());
-      },
-      getLimit: () => {
-        var _a;
-        return (_a = this._dataUnit) === null || _a === void 0 ? void 0 : _a.pageSize;
-      },
-      getRecordID: () => {
-        var _a, _b, _c;
-        return (_c = (_b = (_a = this._dataUnit) === null || _a === void 0 ? void 0 : _a.records) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.__record__id__;
-      }
-    };
+    const dataExporterProvider = new ServerSideExporterProvider(this._dataUnit, this._grid);
     store.set("exporterProviders", Object.assign(Object.assign({}, store.get("exporterProviders")), { [this.configName]: dataExporterProvider }));
   }
   addElementID() {
     const dataInfo = { dataUnit: this._dataUnit };
     ElementIDUtils.addIDInfo(this._element, null, dataInfo);
   }
-  finshLoading() {
+  loadGridCustomFormatters(fields) {
+    if (!fields || !this._grid) {
+      return;
+    }
+    fields.forEach((field) => {
+      var _a;
+      if ((_a = field.properties) === null || _a === void 0 ? void 0 : _a.rm_precision) {
+        this.addCustomValueFormatter(field.name, this._rmPrecisionCustomValueFormatter);
+      }
+    });
+  }
+  async interceptMetadataLoaded(action) {
+    this.loadGridCustomFormatters(action.payload.fields);
+    return action;
+  }
+  finishLoading() {
+    this._dataUnit.addInterceptor(this.dataUnitInterceptor);
     CrudUtils.assertDefaultSorting(this._gridConfig, this._dataUnit);
     this.addElementID();
     if (this.columnFilterDataSource != undefined) {
@@ -268,6 +242,24 @@ export class SnkGrid {
       this.columnFilterDataSource.setDataUnit(this._dataUnit);
     }
   }
+  setCustomRenders() {
+    if (!this._grid) {
+      return;
+    }
+    for (const [fieldName, customRenderProps] of this._customRenders) {
+      this._grid.addGridCustomRender(fieldName, customRenderProps.customRender, customRenderProps.detailContext);
+      this._customRenders.delete(fieldName);
+    }
+  }
+  setCustomEditors() {
+    if (!this._grid) {
+      return;
+    }
+    for (const [fieldName, customEditorProps] of this._customEditors) {
+      this._grid.addCustomEditor(fieldName, customEditorProps.customEditor, customEditorProps.detailContext);
+      this._customEditors.delete(fieldName);
+    }
+  }
   componentWillLoad() {
     this._application = ApplicationContext.getContextValue("__SNK__APPLICATION__");
     //TODO: substituir pelo metodo nativo closest
@@ -279,17 +271,15 @@ export class SnkGrid {
         if (!this._dataUnit) {
           this._snkDataUnit.addEventListener("dataUnitReady", (evt) => {
             this._dataUnit = evt.detail;
-            this.finshLoading();
+            this.finishLoading();
           });
         }
         else {
-          this.finshLoading();
+          this.finishLoading();
         }
         if (!this.messagesBuilder)
           this.messagesBuilder = this._snkDataUnit.messagesBuilder;
-        this._snkDataUnit.addEventListener("dataStateChange", (evt) => {
-          this._dataState = evt.detail;
-        });
+        this._snkDataUnit.addEventListener("dataStateChange", this.handleDataStateChange.bind(this));
         this._snkDataUnit.addEventListener("cancelEdition", () => {
           var _a;
           if ((_a = this._dataState) === null || _a === void 0 ? void 0 : _a.recordsIsEmpty) {
@@ -300,9 +290,20 @@ export class SnkGrid {
       }
       parent = parent.parentElement;
     }
+    this._rmPrecisionCustomValueFormatter = new RmPrecisionCustomValueFormatter();
     this.addGridLegacyConfigName();
     this.loadConfig();
   }
+  componentDidRender() {
+    this._rmPrecisionCustomValueFormatter.setGrid(this._grid);
+    this.loadGridCustomFormatters(this._dataUnit.metadata.fields);
+    this.setCustomRenders();
+    this.setCustomEditors();
+  }
+  async handleDataStateChange(evt) {
+    this._dataState = evt.detail;
+    this._rmPrecisionCustomValueFormatter.setDataState(this._dataState);
+  }
   getHeaderDisabledButtons() {
     var _a;
     const disabledButtons = [];
@@ -415,7 +416,7 @@ export class SnkGrid {
       return undefined;
     }
     return (h("div", { class: "snk-grid__container ez-flex ez-flex--column ez-flex-item--auto ez-padding--large" }, h("div", { class: "snk-grid__header ez-margin-bottom--medium" }, this._showSnkFilterBar &&
-      h(Fragment, null, h("snk-filter-bar", { ref: (ref) => this._snkFilterBar = ref, title: this.filterBarTitle, dataUnit: this._dataUnit, "data-element-id": "gridFilter", class: "snk-grid__filter-bar ez-align--top", configName: this.configName, messagesBuilder: this.messagesBuilder, resourceID: this.resourceID, onConfigUpdated: evt => this.handleFilterConfigUpdated(evt.detail), disablePersonalizedFilter: this.disablePersonalizedFilter, filterBarLegacyConfigName: this.filterBarLegacyConfigName }), h("hr", { class: "ez-divider-vertical ez-divider--dark ez-margin-left--medium snk-grid__header-divider" })), h("snk-taskbar", { class: "ez-padding-left--medium", "data-element-id": "grid_top", key: "topTaskbar", configName: this.configName, dataUnit: this._dataUnit, messagesBuilder: this.messagesBuilder, buttons: this._topTaskbarProcessor.buttons, disabledButtons: this._topTaskbarProcessor.disabledButtons, customButtons: this._topTaskbarProcessor.customButtons, primaryButton: this.getPrimaryButton(), resourceID: this.resourceID, customContainerId: this.taskbarCustomContainerId, customSlotId: this.topTaskbarCustomSlotId, overflowStrategy: 'none' }, h("slot", { name: this.topTaskbarCustomSlotId }))), h("ez-grid", { ref: ref => this._grid = ref, class: (this.presentationMode === PresentationMode.SECONDARY ? "snk-grid-container__without-shadow " : "") + "snk-grid__table", "data-element-id": "embedded", dataUnit: this._dataUnit, key: "grid-" + this._snkDataUnit.entityName, config: this._gridConfig, onConfigChange: (evt) => { this.gridConfigChangeHandler(evt); }, onEzDoubleClick: (evt) => this.gridDoubleClick.emit(evt.detail), statusResolver: this.statusResolver, multipleSelection: this.multipleSelection, columnfilterDataSource: this.columnFilterDataSource, selectionToastConfig: this.selectionToastConfig, useEnterLikeTab: this.useEnterLikeTab, recordsValidator: this.recordsValidator, canEdit: this.canEdit }, h("snk-taskbar", { id: 'teste', dataUnit: this._dataUnit, configName: this.configName, messagesBuilder: this.messagesBuilder, "data-element-id": "grid_left", buttons: this._headerTaskbarProcessor.buttons, presentationMode: this.presentationMode, disabledButtons: this._headerTaskbarProcessor.disabledButtons, customButtons: this._headerTaskbarProcessor.customButtons, slot: "leftButtons", actionsList: this.getActionsList(), primaryButton: this.getPrimaryButton(), resourceID: this.resourceID, customContainerId: this.taskbarCustomContainerId, customSlotId: this.gridHeaderCustomSlotId }, h("slot", { name: this.gridHeaderCustomSlotId }))), h("div", { class: "ez-col ez-col--sd-12" }, h("slot", { name: "SnkGridFooter" })), h("ez-modal", { modalSize: "small", closeEsc: false, closeOutsideClick: false, opened: this._popUpGridConfig, onEzCloseModal: () => this.closeGridConfig() }, h("snk-grid-config", { ref: ref => this._snkGridConfig = ref, config: this._gridConfig, "data-element-id": this._element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME), selectedIndex: 0, configName: this.configName, onConfigChange: (evt) => this.modalConfigChangeHandler(evt), onConfigCancel: () => this.closeGridConfig(), resourceID: this.resourceID }))));
+      h(Fragment, null, h("snk-filter-bar", { ref: (ref) => this._snkFilterBar = ref, title: this.filterBarTitle, dataUnit: this._dataUnit, "data-element-id": "gridFilter", class: "snk-grid__filter-bar ez-align--top", configName: this.configName, messagesBuilder: this.messagesBuilder, resourceID: this.resourceID, onConfigUpdated: evt => this.handleFilterConfigUpdated(evt.detail), disablePersonalizedFilter: this.disablePersonalizedFilter, filterBarLegacyConfigName: this.filterBarLegacyConfigName, autoLoad: this.autoLoad }), h("hr", { class: "ez-divider-vertical ez-divider--dark ez-margin-left--medium snk-grid__header-divider" })), h("snk-taskbar", { class: "ez-padding-left--medium", "data-element-id": "grid_top", key: "topTaskbar", configName: this.configName, dataUnit: this._dataUnit, messagesBuilder: this.messagesBuilder, buttons: this._topTaskbarProcessor.buttons, disabledButtons: this._topTaskbarProcessor.disabledButtons, customButtons: this._topTaskbarProcessor.customButtons, primaryButton: this.getPrimaryButton(), resourceID: this.resourceID, customContainerId: this.taskbarCustomContainerId, customSlotId: this.topTaskbarCustomSlotId, overflowStrategy: 'none' }, h("slot", { name: this.topTaskbarCustomSlotId }))), h("ez-grid", { ref: ref => this._grid = ref, class: (this.presentationMode === PresentationMode.SECONDARY ? "snk-grid-container__without-shadow " : "") + "snk-grid__table", "data-element-id": "embedded", dataUnit: this._dataUnit, key: "grid-" + this._snkDataUnit.entityName, config: this._gridConfig, onConfigChange: (evt) => { this.gridConfigChangeHandler(evt); }, onEzDoubleClick: (evt) => this.gridDoubleClick.emit(evt.detail), statusResolver: this.statusResolver, multipleSelection: this.multipleSelection, columnfilterDataSource: this.columnFilterDataSource, selectionToastConfig: this.selectionToastConfig, useEnterLikeTab: this.useEnterLikeTab, recordsValidator: this.recordsValidator, canEdit: this.canEdit, autoFocus: this.autoFocus }, h("snk-taskbar", { id: 'teste', dataUnit: this._dataUnit, configName: this.configName, messagesBuilder: this.messagesBuilder, "data-element-id": "grid_left", buttons: this._headerTaskbarProcessor.buttons, presentationMode: this.presentationMode, disabledButtons: this._headerTaskbarProcessor.disabledButtons, customButtons: this._headerTaskbarProcessor.customButtons, slot: "leftButtons", actionsList: this.getActionsList(), primaryButton: this.getPrimaryButton(), resourceID: this.resourceID, customContainerId: this.taskbarCustomContainerId, customSlotId: this.gridHeaderCustomSlotId }, h("slot", { name: this.gridHeaderCustomSlotId }))), h("div", { class: "ez-col ez-col--sd-12" }, h("slot", { name: "SnkGridFooter" })), h("ez-modal", { modalSize: "small", closeEsc: false, closeOutsideClick: false, opened: this._popUpGridConfig, onEzCloseModal: () => this.closeGridConfig() }, h("snk-grid-config", { ref: ref => this._snkGridConfig = ref, config: this._gridConfig, "data-element-id": this._element.getAttribute(ElementIDUtils.DATA_ELEMENT_ID_ATTRIBUTE_NAME), selectedIndex: 0, configName: this.configName, onConfigChange: (evt) => this.modalConfigChangeHandler(evt), onConfigCancel: () => this.closeGridConfig(), resourceID: this.resourceID }))));
   }
   static get is() { return "snk-grid"; }
   static get encapsulation() { return "scoped"; }
@@ -826,6 +827,41 @@ export class SnkGrid {
         },
         "attribute": "filter-bar-legacy-config-name",
         "reflect": false
+      },
+      "autoLoad": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "Define se a carga dos dados ser\u00E1 feita assim que o componente for carregado."
+        },
+        "attribute": "auto-load",
+        "reflect": false
+      },
+      "autoFocus": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": true,
+        "docs": {
+          "tags": [],
+          "text": "Define se a grid ser\u00E1 focada ao ser carregada."
+        },
+        "attribute": "auto-focus",
+        "reflect": false,
+        "defaultValue": "true"
       }
     };
   }
@@ -979,6 +1015,109 @@ export class SnkGrid {
           "tags": []
         }
       },
+      "addCustomEditor": {
+        "complexType": {
+          "signature": "(fieldName: string, customEditor: ICustomEditor, detailContext?: string) => Promise<void>",
+          "parameters": [{
+              "tags": [],
+              "text": ""
+            }, {
+              "tags": [],
+              "text": ""
+            }, {
+              "tags": [],
+              "text": ""
+            }],
+          "references": {
+            "Promise": {
+              "location": "global"
+            },
+            "ICustomEditor": {
+              "location": "import",
+              "path": "@sankhyalabs/ezui/dist/types/utils"
+            }
+          },
+          "return": "Promise<void>"
+        },
+        "docs": {
+          "text": "Registra um editor customizado para campos da grade e formul\u00E1rio",
+          "tags": []
+        }
+      },
+      "addGridCustomRender": {
+        "complexType": {
+          "signature": "(fieldName: string, customRender: ICustomRender, detailContext?: string) => Promise<void>",
+          "parameters": [{
+              "tags": [],
+              "text": ""
+            }, {
+              "tags": [],
+              "text": ""
+            }, {
+              "tags": [],
+              "text": ""
+            }],
+          "references": {
+            "Promise": {
+              "location": "global"
+            },
+            "ICustomRender": {
+              "location": "import",
+              "path": "@sankhyalabs/ezui/dist/types/utils"
+            }
+          },
+          "return": "Promise<void>"
+        },
+        "docs": {
+          "text": "Registra um render customizado para colunas da grid.",
+          "tags": []
+        }
+      },
+      "addCustomValueFormatter": {
+        "complexType": {
+          "signature": "(columnName: string, customFormatter: ICustomFormatter) => Promise<void>",
+          "parameters": [{
+              "tags": [],
+              "text": ""
+            }, {
+              "tags": [],
+              "text": ""
+            }],
+          "references": {
+            "Promise": {
+              "location": "global"
+            },
+            "ICustomFormatter": {
+              "location": "import",
+              "path": "@sankhyalabs/ezui/dist/types/components/ez-grid/interfaces"
+            }
+          },
+          "return": "Promise<void>"
+        },
+        "docs": {
+          "text": "Registra um formatador de valores para uma coluna da grid.",
+          "tags": []
+        }
+      },
+      "removeCustomValueFormatter": {
+        "complexType": {
+          "signature": "(columnName: string) => Promise<void>",
+          "parameters": [{
+              "tags": [],
+              "text": ""
+            }],
+          "references": {
+            "Promise": {
+              "location": "global"
+            }
+          },
+          "return": "Promise<void>"
+        },
+        "docs": {
+          "text": "Remove o formatador de valores de uma coluna da grid.",
+          "tags": []
+        }
+      },
       "setFocus": {
         "complexType": {
           "signature": "() => Promise<void>",