@sankhyalabs/sankhyablocks 8.15.0-dev.7 → 8.15.0-dev.70

package/dist/collection/components/snk-data-exporter/interfaces/IExporterProvider.js

@@ -1 +1,54 @@
-export {};
+import { UserInterface } from '@sankhyalabs/core/dist/dataunit/metadata/UnitMetadata';
+import { DataType } from '@sankhyalabs/core';
+export class CommonsExporter {
+  constructor(dataUnit, grid) {
+    this.dataUnit = dataUnit;
+    this.grid = grid;
+  }
+  async getColumnsMetadata() {
+    var _a;
+    this.columnsState = await ((_a = this.grid) === null || _a === void 0 ? void 0 : _a.getColumnsState()) || [];
+    return await this.buildColumnsMetadata(this.columnsState);
+  }
+  getColumnsState() {
+    return this.columnsState;
+  }
+  async buildColumnsMetadata(gridColumns) {
+    var _a, _b;
+    const columnsMetadata = [];
+    for (const column of gridColumns) {
+      /**
+       * TODO: Analisar e criar uma melhor forma de tratar essa validação do "RECDESP".
+       */
+      if (column.hidden && column.name !== "RECDESP") {
+        continue;
+      }
+      const fieldData = (_a = this.dataUnit) === null || _a === void 0 ? void 0 : _a.getField(column.name);
+      const customFormatter = await this.grid.getCustomValueFormatter(column.name);
+      const columnData = {
+        label: column.label,
+        id: column.name,
+        width: (fieldData === null || fieldData === void 0 ? void 0 : fieldData.userInterface) === UserInterface.SEARCH ? 30 : column.width,
+        type: fieldData === null || fieldData === void 0 ? void 0 : fieldData.dataType,
+        userInterface: fieldData === null || fieldData === void 0 ? void 0 : fieldData.userInterface,
+        customFormatter
+      };
+      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,
+          descriptionFrom: fieldData.name
+        };
+        columnsMetadata.push(descriptionColumn);
+      }
+    }
+    ;
+    return columnsMetadata || [];
+  }
+}

package/dist/collection/components/snk-data-exporter/interfaces/IExporterStrategy.js

@@ -0,0 +1 @@
+export {};

package/dist/collection/components/snk-data-exporter/providers/ClientSideExporterProvider.js

@@ -0,0 +1,58 @@
+import { CommonsExporter } from "../interfaces/IExporterProvider";
+import { UserInterface } from "@sankhyalabs/core";
+import { getSelectedIDs } from "../utils/RecordIDUtils";
+import { DataExporterOption } from "../../../lib/@types";
+export default class ClientSideExporterProvider extends CommonsExporter {
+  getSelectedNumber() {
+    return this.dataUnit.getSelectionInfo().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 getSelectedIDs(this.dataUnit);
+  }
+  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__;
+  }
+  async getRecords() {
+    if (this.dataUnit.records.length === 0) {
+      return Promise.resolve([]);
+    }
+    const selectionInfo = this.dataUnit.getSelectionInfo();
+    const records = selectionInfo.isEmpty() || selectionInfo.isAllRecords() ? await selectionInfo.getAllRecords() : selectionInfo.records;
+    return Promise.resolve(records == undefined ? [] : records);
+  }
+  getHiddenOptions() {
+    return [
+      DataExporterOption.EXPORT_BY_EMAIL,
+      DataExporterOption.EXPORT_PDF_TO_EMAIL,
+      DataExporterOption.EXPORT_XLS_TO_EMAIL,
+      DataExporterOption.EXPORT_PAGE_TO_PDF,
+      DataExporterOption.EXPORT_PAGE_TO_XLS
+    ];
+  }
+  formatValue(record, column) {
+    const { id, descriptionFrom } = column;
+    const value = record[descriptionFrom || id];
+    if (value == undefined) {
+      return "";
+    }
+    if (descriptionFrom != undefined) {
+      return value.label;
+    }
+    const fieldDescriptor = this.dataUnit.getField(id);
+    if (fieldDescriptor.userInterface === UserInterface.SEARCH) {
+      return value.value;
+    }
+    if (column.customFormatter) {
+      const ezGridColumn = this.getColumnsState().find(columnState => column.id === columnState.name);
+      const formattedValue = column.customFormatter.format(value, ezGridColumn, record.__record__id__);
+      return formattedValue;
+    }
+    return this.dataUnit.getFormattedValue(id, value);
+  }
+}

package/dist/collection/components/snk-data-exporter/providers/ServerSideExporterProvider.js

@@ -0,0 +1,55 @@
+import { CommonsExporter } from "../interfaces/IExporterProvider";
+import { getSelectedIDs } from "../utils/RecordIDUtils";
+export default class ServerSideExporterProvider extends CommonsExporter {
+  getFilters() {
+    var _a;
+    return (_a = this.dataUnit) === null || _a === void 0 ? void 0 : _a.getAppliedFilters();
+  }
+  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() {
+    return this.dataUnit.getSelectionInfo().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 getSelectedIDs(this.dataUnit);
+  }
+  getOffset() {
+    return this.getExporterOffset(this.getPaginationInfo());
+  }
+  getPageSize() {
+    var _a;
+    return (_a = this.dataUnit) === null || _a === void 0 ? void 0 : _a.pageSize;
+  }
+  getExportLimit() {
+    return 5000;
+  }
+  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__;
+  }
+  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;
+  }
+}

package/dist/collection/components/snk-data-exporter/snk-data-exporter.js

@@ -4,17 +4,15 @@ import { ApplicationUtils, DialogType } from '@sankhyalabs/ezui/dist/collection/
 import { ItemBuilder } from './structure/ItemBuilder';
 import { DataExporterFormat, DataExporterOption, DataExporterType } from '../../lib/@types';
 import { REPORT_LAUNCHER_RESOURCE_ID } from '../../lib/utils/constants';
-import fetchDataExporter from '../../lib/http/data-fetcher/fetchers/fetchDataExporter';
 import fileViewer from '../../lib/utils/fileViewer';
 import getPersonalizedReports from '../../lib/http/data-fetcher/fetchers/fetchDataExporter/personalized-reports-fetcher';
 import { SnkDataUnit } from '../snk-data-unit/snk-data-unit';
-const LIMIT_PER_EXPORT = 5000;
+import ServerSideExporterStrategy from './exporter-strategy/ServerSideExporterStrategy';
+import ClientSideExporterStrategy from './exporter-strategy/ClientSideExporterStrategy';
 export class SnkDataExporter {
   constructor() {
     this._selectedNumber = 0;
     this._customPrefix = "$custom$";
-    this._items = [];
-    this._showDropdown = false;
     this._releasedToExport = [
       DataExporterOption.EXPORT_TO_PDF,
       DataExporterOption.EXPORT_TO_XLS,
@@ -24,6 +22,8 @@ export class SnkDataExporter {
       DataExporterOption.EXPORT_PAGE_TO_PDF,
       DataExporterOption.EXPORT_PAGE_TO_XLS
     ];
+    this._items = [];
+    this._showDropdown = false;
     this.provider = null;
     this.messagesBuilder = undefined;
   }
@@ -94,33 +94,16 @@ export class SnkDataExporter {
     if (this.provider == undefined || resolveProps == undefined || callbackResolver == undefined) {
       return;
     }
-    const filters = this.provider.getFilters();
-    const columns = await this.provider.getColumnsMetadata();
-    const sort = this.provider.getOrders();
-    const resourceURI = this.provider.getResourceURI();
-    const selectedIDs = this.provider.getSelectedIDs();
-    const option = resolveProps.exportOption;
-    const currentPageOptions = [
-      DataExporterOption.EXPORT_PAGE_TO_PDF,
-      DataExporterOption.EXPORT_PAGE_TO_XLS
-    ];
-    delete resolveProps.exportOption;
-    let params = Object.assign({ filters,
-      columns,
-      sort,
-      resourceURI, selectedIDs: selectedIDs.slice(0, LIMIT_PER_EXPORT) }, resolveProps);
-    if (currentPageOptions.includes(option) || resolveProps.type == "page") {
-      const offset = this.provider.getOffset();
-      const limit = this.provider.getLimit();
-      params = Object.assign(Object.assign({}, params), { offset,
-        limit, selectedIDs: [] });
-    }
-    else if (resolveProps.type == "all") {
-      params = Object.assign(Object.assign({}, params), { offset: 0, limit: LIMIT_PER_EXPORT, selectedIDs: [] });
-    }
-    fetchDataExporter(params)
+    this.getExporterStrategy().executeExport(resolveProps)
       .then((result) => callbackResolver(result))
-      .catch((exception) => ApplicationUtils.error(this.getMessage("snkDataExporter.message.exportError"), exception ? exception.statusMessage : this.getMessage("snkDataExporter.message.exportError")));
+      .catch((exception) => {
+      console.error(exception);
+      let { title, message, statusMessage } = exception || {};
+      ApplicationUtils.error(title || this.getMessage("snkDataExporter.message.exportError"), statusMessage || message || this.getMessage("snkDataExporter.message.unknownFailure"));
+    });
+  }
+  getExporterStrategy() {
+    return this.provider.getRecords == undefined ? new ServerSideExporterStrategy(this.provider) : new ClientSideExporterStrategy(this.provider);
   }
   getOptionKey(option) {
     return Object.keys(DataExporterOption)
@@ -129,7 +112,7 @@ export class SnkDataExporter {
     });
   }
   dispatchExporter(option) {
-    var _a;
+    var _a, _b, _c;
     const optionKey = this.getOptionKey(option);
     const fileType = (_a = DataExporterType[optionKey]) !== null && _a !== void 0 ? _a : DataExporterType.EXPORT_TO_PDF;
     const isDownload = DataExporterType[optionKey] === DataExporterType.EXPORT_TO_XLS;
@@ -138,7 +121,7 @@ export class SnkDataExporter {
       fileName: this._appLabel,
       titleGrid: this._appLabel,
       exportOption: option,
-      limit: LIMIT_PER_EXPORT
+      limit: (_c = (_b = this.provider) === null || _b === void 0 ? void 0 : _b.getExportLimit) === null || _c === void 0 ? void 0 : _c.call(_b)
     };
     this.resolveExporter(params, (response) => {
       fileViewer(Object.assign(Object.assign({}, response), { fileType,
@@ -146,7 +129,7 @@ export class SnkDataExporter {
     });
   }
   async processExporter(evt) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e, _f, _g;
     const item = evt === null || evt === void 0 ? void 0 : evt.detail;
     const exportCurrentPageOptions = [DataExporterOption.EXPORT_PAGE_TO_PDF, DataExporterOption.EXPORT_PAGE_TO_XLS];
     const isCustomReport = (_a = item === null || item === void 0 ? void 0 : item.id) === null || _a === void 0 ? void 0 : _a.includes(this._customPrefix);
@@ -154,18 +137,19 @@ export class SnkDataExporter {
       return;
     const selectedRecords = (_b = this.provider) === null || _b === void 0 ? void 0 : _b.getSelectedIDs();
     const totalRecords = (_c = this.provider) === null || _c === void 0 ? void 0 : _c.getTotalRecords();
-    const totalPerPage = (_d = this.provider) === null || _d === void 0 ? void 0 : _d.getLimit();
+    const totalPerPage = (_e = (_d = this.provider) === null || _d === void 0 ? void 0 : _d.getPageSize) === null || _e === void 0 ? void 0 : _e.call(_d);
+    const exportLimit = (_g = (_f = this.provider) === null || _f === void 0 ? void 0 : _f.getExportLimit) === null || _g === void 0 ? void 0 : _g.call(_f);
     let limitExceeded = false;
-    if ((exportCurrentPageOptions.includes(item === null || item === void 0 ? void 0 : item.id) && totalPerPage <= LIMIT_PER_EXPORT) || isCustomReport) {
+    if ((exportCurrentPageOptions.includes(item === null || item === void 0 ? void 0 : item.id) && totalPerPage <= exportLimit) || isCustomReport) {
       limitExceeded = false;
     }
     else if (selectedRecords === null || selectedRecords === void 0 ? void 0 : selectedRecords.length) {
-      limitExceeded = selectedRecords.length > LIMIT_PER_EXPORT;
+      limitExceeded = selectedRecords.length > exportLimit;
     }
-    else if (totalRecords > LIMIT_PER_EXPORT)
+    else if (totalRecords > exportLimit)
       limitExceeded = true;
     if (limitExceeded) {
-      const formattedLimit = LIMIT_PER_EXPORT.toLocaleString('pt-BR', { minimumFractionDigits: 0 });
+      const formattedLimit = exportLimit.toLocaleString('pt-BR', { minimumFractionDigits: 0 });
       const limitModalMessages = {
         title: this.getMessage("snkDataExporter.limitExceeded.title"),
         description: `
@@ -190,7 +174,7 @@ export class SnkDataExporter {
       this._showDropdown = false;
       return;
     }
-    if (!this._releasedToExport.includes(item === null || item === void 0 ? void 0 : item.id)) {
+    if (!this.getFilteredReleasedToExport().includes(item === null || item === void 0 ? void 0 : item.id)) {
       return;
     }
     if (item.id === DataExporterOption.EXPORT_BY_EMAIL) {
@@ -201,9 +185,20 @@ export class SnkDataExporter {
     }
     this._showDropdown = false;
   }
+  getFilteredReleasedToExport() {
+    var _a, _b;
+    if (this.provider == undefined) {
+      return this._releasedToExport;
+    }
+    const hiddenOptions = (_b = (_a = this.provider).getHiddenOptions) === null || _b === void 0 ? void 0 : _b.call(_a);
+    if (hiddenOptions == undefined) {
+      return this._releasedToExport;
+    }
+    return this._releasedToExport.filter(option => !hiddenOptions.includes(option));
+  }
   loadItems() {
     const items = [];
-    this._releasedToExport
+    this.getFilteredReleasedToExport()
       .forEach((option) => {
       var _a;
       (_a = this._itemBuilder) === null || _a === void 0 ? void 0 : _a.setExportOption(option, items);
@@ -211,8 +206,8 @@ export class SnkDataExporter {
     this.loadPersonalizedItems(items);
   }
   async loadPersonalizedItems(items) {
-    var _a;
-    const recordID = (_a = this.provider) === null || _a === void 0 ? void 0 : _a.getRecordID();
+    var _a, _b;
+    const recordID = (_b = (_a = this.provider) === null || _a === void 0 ? void 0 : _a.getRecordID) === null || _b === void 0 ? void 0 : _b.call(_a);
     if (recordID == undefined) {
       this._items = items;
       return;
@@ -228,18 +223,18 @@ export class SnkDataExporter {
     this._items = items;
   }
   openPersonalizedReports(option) {
-    var _a;
+    var _a, _b;
     const pkObject = [];
     const appId = (option === null || option === void 0 ? void 0 : option.replace(this._customPrefix, "")) || "";
-    (_a = this.provider) === null || _a === void 0 ? void 0 : _a.getSelectedIDs().forEach(({ name, type, value }, index) => {
-      const fields = [];
+    (_b = (_a = this.provider) === null || _a === void 0 ? void 0 : _a.getSelectedIDs) === null || _b === void 0 ? void 0 : _b.call(_a).forEach(({ name, type, value }, index) => {
+      const fields = {};
       fields['fields'] = [];
       // Se for o primeiro elemento, adiciona essa primeira PK
       if (index === 0) {
         pkObject[`PK_${name}`] = { type: this.parseDataType(type), value };
         pkObject['pks'] = [];
       }
-      const dataFields = { nome: name, tipo: type, valor: value };
+      const dataFields = { nome: `PK_${name}`, tipo: this.parseDataType(type), valor: value };
       fields['fields'].push(dataFields);
       pkObject['pks'].push(fields);
     });
@@ -256,8 +251,8 @@ export class SnkDataExporter {
     }
   }
   loadDropdown() {
-    var _a, _b;
-    this._selectedNumber = ((_b = (_a = this.provider) === null || _a === void 0 ? void 0 : _a.getSelectedIDs()) === null || _b === void 0 ? void 0 : _b.length) || 0;
+    var _a;
+    this._selectedNumber = ((_a = this.provider) === null || _a === void 0 ? void 0 : _a.getSelectedNumber()) || 0;
     this._itemBuilder = new ItemBuilder(this.getMessage.bind(this), this._selectedNumber);
     this.loadItems();
   }
@@ -367,8 +362,7 @@ export class SnkDataExporter {
   static get states() {
     return {
       "_items": {},
-      "_showDropdown": {},
-      "_releasedToExport": {}
+      "_showDropdown": {}
     };
   }
   static get elementRef() { return "_element"; }

package/dist/collection/components/snk-data-exporter/test/resources/ClientSideExporterStrategyResources.js

@@ -0,0 +1,88 @@
+import { DataType, StringUtils } from "@sankhyalabs/core";
+export const testMetadata = {
+  name: 'metadataName',
+  label: 'metadataLabel',
+  fields: [{
+      name: 'TESTFIELD',
+      label: 'Test label',
+      dataType: DataType.TEXT,
+    }]
+};
+export const recordId1 = StringUtils.generateUUID();
+export const recordId2 = StringUtils.generateUUID();
+export const testRecords = [
+  {
+    __record__id__: recordId1,
+    TESTFIELD: 'TESTVALUE'
+  },
+  {
+    __record__id__: recordId2,
+    TESTFIELD: 'TESTVALUE2'
+  },
+];
+export const dataFetcherPDFResponse = {
+  chavePDF: {
+    valor: 'KEYPDF'
+  },
+  permiteImprimir: {
+    valor: "S"
+  },
+  permiteExportar: {
+    valor: "S"
+  },
+  canSendEmail: {
+    valor: "S"
+  },
+};
+export const dataFetcherXLSResponse = {
+  chaveXLS: {
+    valor: 'KEYXLS'
+  },
+};
+export const exportPDFParams = {
+  methodName: 'exportToPDF',
+  fileName: '',
+  titleGrid: '',
+};
+export const exportXLSParams = {
+  methodName: 'exportToXLS',
+  fileName: '',
+  titleGrid: '',
+};
+export const serviceNamePDF = "GridPDFBuilderSP.buildPDFFromJson";
+export const serviceNameXLS = "GridXLSBuilderSP.buildXLSFromJson";
+export function buildExpectedResponse({ serviceName, titleGrid, value, align = 'left', type = 'S' }) {
+  return {
+    serviceName: serviceName,
+    requestBody: {
+      grid: {
+        titleGrid: titleGrid,
+        columns: {
+          column: [
+            {
+              align: align,
+              id: "TESTFIELD",
+              index: 1,
+              label: "Test label",
+              presentationType: "P",
+              type: type,
+              width: undefined,
+            }
+          ]
+        },
+        customOptions: {
+          xlsxExtension: false
+        },
+        rows: {
+          row: [
+            {
+              c1: {
+                $: value
+              }
+            }
+          ]
+        }
+      }
+    }
+  };
+}

package/dist/collection/components/snk-data-exporter/utils/RecordIDUtils.js

@@ -0,0 +1,38 @@
+import { DataType, JSUtils } from "@sankhyalabs/core";
+export const getSelectedIDs = (dataUnit) => {
+  const selectionInfo = dataUnit.getSelectionInfo();
+  if (selectionInfo === null || selectionInfo === void 0 ? void 0 : selectionInfo.isAllRecords()) {
+    return [];
+  }
+  const selectedRecordsIDsInfo = [];
+  const selectedRecords = selectionInfo === null || selectionInfo === void 0 ? void 0 : selectionInfo.recordIds;
+  if ((selectedRecords === null || selectedRecords === void 0 ? void 0 : selectedRecords.length) > 0) {
+    selectedRecords.forEach(recordId => {
+      if (!dataUnit.isNewRecord(recordId)) {
+        /*
+          Esse if foi necessário para tratar corretamente o ID
+          do record quando está sendo utilizado no modo standAlone
+          isso não faz a exportação da grid funcionar no modo standAlone
+          mas deixa de causar erro nas oprações de CRUD.
+        */
+        if (!JSUtils.isBase64(recordId)) {
+          selectedRecordsIDsInfo.push({
+            name: "__record__id__",
+            type: DataType.TEXT,
+            value: recordId
+          });
+          return;
+        }
+        const revertBase64ToObject = JSON.parse(window.atob(recordId));
+        Object.entries(revertBase64ToObject).forEach(([name, value]) => {
+          const metadataField = dataUnit === null || dataUnit === void 0 ? void 0 : dataUnit.getField(name);
+          if (metadataField == undefined) {
+            return;
+          }
+          selectedRecordsIDsInfo.push(Object.assign({ name, type: metadataField.dataType }, value));
+        });
+      }
+    });
+  }
+  return selectedRecordsIDsInfo;
+};