@sankhyalabs/sankhyablocks 8.15.0-dev.61 → 8.15.0-dev.63

package/dist/collection/collection-manifest.json

@@ -1,8 +1,8 @@
 {
   "entries": [
     "./components/snk-filter-bar/filter-item/snk-filter-item.js",
-    "./components/snk-application/snk-application.js",
     "./components/snk-data-unit/snk-data-unit.js",
+    "./components/snk-application/snk-application.js",
     "./components/snk-taskbar/snk-taskbar.js",
     "./components/snk-filter-bar/filter-list/snk-filter-list.js",
     "./components/snk-print-selector/snk-print-selector.js",

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

@@ -347,7 +347,7 @@ export class SnkApplication {
    * Cria o DataUnit a partir do nome da entidade. É possível armazená-lo no cache
    * passando o dataUnitName, assim, se mais de uma chamada for feita, o mesmo DataUnit será usado.
    */
-  async createDataunit(entityName, dataUnitName, parentDataUnit, configName, resourceID) {
+  async createDataunit(entityName, dataUnitName, parentDataUnit, configName, resourceID, options) {
     if (resourceID == undefined) {
       resourceID = this.applicationResourceID;
     }
@@ -357,21 +357,29 @@ export class SnkApplication {
       duPromisses.push(new PendingPromise(resolve, reject));
       if (!waitingDu) {
         const dataUnit = this.dataUnitFetcher.getDataUnit(entityName, resourceID, parentDataUnit, configName);
-        dataUnit.loadMetadata().then(() => {
-          if (dataUnitName) {
-            this.updateDataunitCache(undefined, dataUnitName, dataUnit);
-          }
-          while (duPromisses.length > 0) {
-            duPromisses.pop().resolve(dataUnit);
-          }
-        }).catch(reason => {
-          while (duPromisses.length > 0) {
-            duPromisses.pop().reject(reason);
-          }
-        });
+        if (options === null || options === void 0 ? void 0 : options.skipLoadMetadata) {
+          this.processResolveDataUnit(dataUnit, dataUnitName, duPromisses);
+        }
+        else {
+          dataUnit.loadMetadata().then(() => {
+            this.processResolveDataUnit(dataUnit, dataUnitName, duPromisses);
+          }).catch(reason => {
+            while (duPromisses.length > 0) {
+              duPromisses.pop().reject(reason);
+            }
+          });
+        }
       }
     });
   }
+  processResolveDataUnit(dataUnit, dataUnitName, duPromisses) {
+    if (dataUnitName) {
+      this.updateDataunitCache(undefined, dataUnitName, dataUnit);
+    }
+    while (duPromisses.length > 0) {
+      duPromisses.pop().resolve(dataUnit);
+    }
+  }
   /**
    * Atualiza o cache de dataunits da aplicação.
    * @param oldName - Nome do dataunit que está em cache.
@@ -387,14 +395,14 @@ export class SnkApplication {
   /**
    * Obtem um DataUnit do cache ou cria um caso ainda não tenha sido criado.
    */
-  async getDataUnit(entityName, dataUnitName, parentDataUnit, configName, resourceID) {
+  async getDataUnit(entityName, dataUnitName, parentDataUnit, configName, resourceID, options) {
     return new Promise((resolve, reject) => {
       const dataUnit = this._duCache.get(dataUnitName);
       if (dataUnit) {
         resolve(dataUnit);
       }
       else {
-        this.createDataunit(entityName, dataUnitName, parentDataUnit, configName, resourceID).then(dataUnit => {
+        this.createDataunit(entityName, dataUnitName, parentDataUnit, configName, resourceID, options).then(dataUnit => {
           resolve(dataUnit);
         }).catch(reason => reject(reason));
       }
@@ -1678,7 +1686,7 @@ export class SnkApplication {
       },
       "createDataunit": {
         "complexType": {
-          "signature": "(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>",
+          "signature": "(entityName: string, dataUnitName?: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string, options?: GetDataUnitOptions) => Promise<DataUnit>",
           "parameters": [{
               "tags": [],
               "text": ""
@@ -1694,6 +1702,9 @@ export class SnkApplication {
             }, {
               "tags": [],
               "text": ""
+            }, {
+              "tags": [],
+              "text": ""
             }],
           "references": {
             "Promise": {
@@ -1702,6 +1713,9 @@ export class SnkApplication {
             "DataUnit": {
               "location": "import",
               "path": "@sankhyalabs/core"
+            },
+            "GetDataUnitOptions": {
+              "location": "global"
             }
           },
           "return": "Promise<DataUnit>"
@@ -1760,7 +1774,7 @@ export class SnkApplication {
       },
       "getDataUnit": {
         "complexType": {
-          "signature": "(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string) => Promise<DataUnit>",
+          "signature": "(entityName: string, dataUnitName: string, parentDataUnit?: DataUnit, configName?: string, resourceID?: string, options?: GetDataUnitOptions) => Promise<DataUnit>",
           "parameters": [{
               "tags": [],
               "text": ""
@@ -1776,6 +1790,9 @@ export class SnkApplication {
             }, {
               "tags": [],
               "text": ""
+            }, {
+              "tags": [],
+              "text": ""
             }],
           "references": {
             "Promise": {
@@ -1784,6 +1801,9 @@ export class SnkApplication {
             "DataUnit": {
               "location": "import",
               "path": "@sankhyalabs/core"
+            },
+            "GetDataUnitOptions": {
+              "location": "global"
             }
           },
           "return": "Promise<DataUnit>"

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

@@ -70,6 +70,24 @@ export class SnkCrud {
   async getFilterBar() {
     return await this._snkGrid.getFilterBar();
   }
+  /**
+   * Registra um formatador de valores para uma coluna da grid.
+   */
+  async addCustomValueFormatter(columnName, customFormatter) {
+    this._snkGrid.addCustomValueFormatter(columnName, customFormatter);
+  }
+  /**
+   * Remove o formatador de valores de uma coluna da grid.
+   */
+  async removeCustomValueFormatter(columnName) {
+    this._snkGrid.removeCustomValueFormatter(columnName);
+  }
+  /**
+   * Altera/adiciona uma propriedade nos metadados do campo.
+   */
+  async setFieldProp(fieldName, propName, value) {
+    await this._guidesViewer.setFieldProp(fieldName, propName, value);
+  }
   currentViewModeWatcher(currentView) {
     this._viewHistory = [...this._viewHistory.slice(-1), currentView];
   }
@@ -145,12 +163,7 @@ export class SnkCrud {
         else {
           this.initDataUnit();
         }
-        this._snkDataUnit.addEventListener("dataStateChange", async ({ detail: dataState }) => {
-          this._dataState = dataState;
-          if (dataState.selectedRecord !== undefined) {
-            this.attachmentRegisterKey = await this.getAttachmentRegisterKey();
-          }
-        });
+        this._snkDataUnit.addEventListener("dataStateChange", this.handleDataStateChange.bind(this));
         break;
       }
       parent = parent.parentElement;
@@ -166,6 +179,26 @@ export class SnkCrud {
     this.removeShortcuts();
     window.removeEventListener("keydown", this._keyDownHandler);
   }
+  async handleDataStateChange(evt) {
+    var _a;
+    this._dataState = evt.detail;
+    if (this._dataState.selectedRecord !== undefined) {
+      this.attachmentRegisterKey = await this.getAttachmentRegisterKey();
+    }
+    const fieldsWithRmPrecision = await this._snkDataUnit.getFieldsWithRmPrecision();
+    for (const field of fieldsWithRmPrecision || []) {
+      if (!field) {
+        continue;
+      }
+      const rmPrecision = (_a = this._dataState.rowMetadata) === null || _a === void 0 ? void 0 : _a.getProp('rm_precision', field);
+      if (!rmPrecision) {
+        continue;
+      }
+      await this.setFieldProp(field, 'precision', rmPrecision);
+      await this.setFieldProp(field, 'prettyPrecision', rmPrecision);
+    }
+    ;
+  }
   async initKeyboardManager() {
     var _a;
     const keyboardManager = await ((_a = this._application) === null || _a === void 0 ? void 0 : _a.getKeyboardManager());
@@ -777,6 +810,76 @@ export class SnkCrud {
           "text": "Retorna o elemento da filter-bar da grade.",
           "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": []
+        }
+      },
+      "setFieldProp": {
+        "complexType": {
+          "signature": "(fieldName: string, propName: string, value: any) => Promise<void>",
+          "parameters": [{
+              "tags": [],
+              "text": ""
+            }, {
+              "tags": [],
+              "text": ""
+            }, {
+              "tags": [],
+              "text": ""
+            }],
+          "references": {
+            "Promise": {
+              "location": "global"
+            }
+          },
+          "return": "Promise<void>"
+        },
+        "docs": {
+          "text": "Altera/adiciona uma propriedade nos metadados do campo.",
+          "tags": []
+        }
       }
     };
   }

package/dist/collection/components/snk-crud/subcomponents/snk-form-view.js

@@ -3,6 +3,7 @@ import { Host, h } from "@stencil/core";
 import { DataBinder } from "@sankhyalabs/ezui/dist/collection/utils/form";
 export class SnkFormView {
   constructor() {
+    this._fieldProps = new Map();
     this.levelPath = undefined;
     this.label = undefined;
     this.name = undefined;
@@ -16,12 +17,29 @@ export class SnkFormView {
     this.canFix = true;
     this.recordsValidator = undefined;
     this.fieldToFocus = undefined;
+    this.fieldsProps = undefined;
   }
   async showUp() {
     if (this._formView) {
       this._formView.showUp();
     }
   }
+  /**
+   * Altera/adiciona uma propriedade nos metadados do campo.
+   */
+  async setFieldProp(fieldName, propName, value) {
+    const props = this._fieldProps.get(fieldName) || [];
+    this._fieldProps.set(fieldName, [...props, { propName, value }]);
+  }
+  async observeFieldsProps(newValue) {
+    for (const field in newValue) {
+      const fieldProps = newValue[field];
+      const propNames = Object.keys(fieldProps);
+      for (const propName of propNames) {
+        await this.setFieldProp(field, propName, fieldProps[propName]);
+      }
+    }
+  }
   changeFix() {
     this.fixed = !this.fixed;
     this.emitEvent("fixed");
@@ -80,7 +98,11 @@ export class SnkFormView {
       this._dataBinder.onDisconnectedCallback();
     }
   }
+  componentDidLoad() {
+    this.observeFieldsProps(this.fieldsProps);
+  }
   componentDidRender() {
+    this.setFieldProps();
     if (this.fieldToFocus == undefined) {
       return;
     }
@@ -92,6 +114,17 @@ export class SnkFormView {
       this.snkRequestClearFieldToFocus.emit();
     });
   }
+  setFieldProps() {
+    if (!this._formView) {
+      return;
+    }
+    for (const [fieldName, propsToChange] of this._fieldProps) {
+      propsToChange.forEach(prop => {
+        this._formView.setFieldProp(fieldName, prop.propName, prop.value);
+        this._fieldProps.delete(fieldName);
+      });
+    }
+  }
   render() {
     return (h(Host, { class: "ez-box__container" }, h("div", { class: "summary-header ez-flex ez-size-width--full" }, h("div", { class: "ez-flex ez-text ez-title--primary ez-text--bold ez-flex--justify-start ez-flex--align-items-center ez-col--sd-9" }, this.levelPath ? h("span", { class: "level-path" }, this.levelPath + " /") : undefined, this.label), h("div", { class: "ez-flex ez-flex--justify-end ez-col--sd-3" }, this.canFix &&
       h("ez-button", { class: "ez-padding-left--medium", mode: "icon", size: "small", iconName: this.fixed ? "un-pin" : "push-pin", "data-element-id": ElementIDUtils.getInternalIDInfo("toggleFixed_ezFormCard"), onClick: () => this.changeFix(), title: this.fixed ? "Desafixar" : "Fixar" }), this.canExpand &&
@@ -361,6 +394,21 @@ export class SnkFormView {
         },
         "attribute": "field-to-focus",
         "reflect": false
+      },
+      "fieldsProps": {
+        "type": "unknown",
+        "mutable": false,
+        "complexType": {
+          "original": "object",
+          "resolved": "object",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "Lista de propriedades que ser\u00E3o alteradas/adicionadas por coluna."
+        }
       }
     };
   }
@@ -441,7 +489,38 @@ export class SnkFormView {
           "text": "",
           "tags": []
         }
+      },
+      "setFieldProp": {
+        "complexType": {
+          "signature": "(fieldName: string, propName: string, value: any) => Promise<void>",
+          "parameters": [{
+              "tags": [],
+              "text": ""
+            }, {
+              "tags": [],
+              "text": ""
+            }, {
+              "tags": [],
+              "text": ""
+            }],
+          "references": {
+            "Promise": {
+              "location": "global"
+            }
+          },
+          "return": "Promise<void>"
+        },
+        "docs": {
+          "text": "Altera/adiciona uma propriedade nos metadados do campo.",
+          "tags": []
+        }
       }
     };
   }
+  static get watchers() {
+    return [{
+        "propName": "fieldsProps",
+        "methodName": "observeFieldsProps"
+      }];
+  }
 }

package/dist/collection/components/snk-crud/subcomponents/snk-guides-viewer.js

@@ -33,6 +33,7 @@ export class SnkGuidesViewer {
     this._formEditorConfigManager = undefined;
     this._formEditorDataUnit = undefined;
     this._fieldToGetFocus = undefined;
+    this._fieldsProps = {};
   }
   observeDataUnit() {
     this.loadGuides(true);
@@ -63,6 +64,15 @@ export class SnkGuidesViewer {
   async findField() {
     await openFieldSearch(this._moreOptions, this._fieldSearch);
   }
+  /**
+   * Altera/adiciona uma propriedade nos metadados do campo.
+   */
+  async setFieldProp(fieldName, propName, value) {
+    const newFieldsProps = {
+      [fieldName]: Object.assign(Object.assign({}, this._fieldsProps[fieldName]), { [propName]: value })
+    };
+    this._fieldsProps = Object.assign(Object.assign({}, this._fieldsProps), newFieldsProps);
+  }
   exitViewer() {
     if (this.dataUnit.isDirty()) {
       this.dataUnit.cancelEdition({ after: () => this.exit.emit() });
@@ -205,7 +215,7 @@ export class SnkGuidesViewer {
       if (sheet == undefined) {
         return;
       }
-      return h("snk-form-view", { levelPath: params.levelPath, label: sheet.label, name: formName, fields: sheet.fields, formMetadata: params.formMetadata, dataUnit: params.dataUnit, recordsValidator: params.recordsValidator, contracted: (cardConfig === null || cardConfig === void 0 ? void 0 : cardConfig.presentation) === "CONTRACTED", fixed: cardConfig === null || cardConfig === void 0 ? void 0 : cardConfig.fixed, summaryFields: (_b = (_a = params.formConfig) === null || _a === void 0 ? void 0 : _a.summary) === null || _b === void 0 ? void 0 : _b.get(formName), fieldToFocus: params.fieldToFocus, key: formName, onSnkRequestClearFieldToFocus: _ => { var _a; return (_a = params.onRequestClearFieldToFocus) === null || _a === void 0 ? void 0 : _a.call(params); } });
+      return h("snk-form-view", { levelPath: params.levelPath, label: sheet.label, name: formName, fields: sheet.fields, formMetadata: params.formMetadata, dataUnit: params.dataUnit, recordsValidator: params.recordsValidator, contracted: (cardConfig === null || cardConfig === void 0 ? void 0 : cardConfig.presentation) === "CONTRACTED", fixed: cardConfig === null || cardConfig === void 0 ? void 0 : cardConfig.fixed, summaryFields: (_b = (_a = params.formConfig) === null || _a === void 0 ? void 0 : _a.summary) === null || _b === void 0 ? void 0 : _b.get(formName), fieldToFocus: params.fieldToFocus, key: formName, onSnkRequestClearFieldToFocus: _ => { var _a; return (_a = params.onRequestClearFieldToFocus) === null || _a === void 0 ? void 0 : _a.call(params); }, fieldsProps: params.fieldsProps });
     })));
   }
   wrapDetail(levels, content) {
@@ -254,7 +264,7 @@ export class SnkGuidesViewer {
       const sheet = this._masterFormMetadata.getSheet(cardId);
       if (sheet) {
         const cardConfig = (_c = (_b = this.masterFormConfig) === null || _b === void 0 ? void 0 : _b.cardsState) === null || _c === void 0 ? void 0 : _c.get(cardId);
-        content = h("snk-form-view", { ref: ref => this._mainForm = ref, fixed: cardConfig === null || cardConfig === void 0 ? void 0 : cardConfig.fixed, summaryFields: (_e = (_d = this.masterFormConfig) === null || _d === void 0 ? void 0 : _d.summary) === null || _e === void 0 ? void 0 : _e.get(cardId), name: cardId, label: sheet.label, fields: sheet.fields, dataUnit: this.dataUnit, formMetadata: this._masterFormMetadata, recordsValidator: this.recordsValidator, fieldToFocus: this._fieldToGetFocus, key: guideId, onSnkRequestClearFieldToFocus: _ => this.clearFieldToFocusHandler() }, this.presentationMode == PresentationMode.SECONDARY && this.buildTaskBar());
+        content = h("snk-form-view", { ref: ref => this._mainForm = ref, fixed: cardConfig === null || cardConfig === void 0 ? void 0 : cardConfig.fixed, summaryFields: (_e = (_d = this.masterFormConfig) === null || _d === void 0 ? void 0 : _d.summary) === null || _e === void 0 ? void 0 : _e.get(cardId), name: cardId, label: sheet.label, fields: sheet.fields, dataUnit: this.dataUnit, formMetadata: this._masterFormMetadata, recordsValidator: this.recordsValidator, fieldToFocus: this._fieldToGetFocus, key: guideId, onSnkRequestClearFieldToFocus: _ => this.clearFieldToFocusHandler(), fieldsProps: this._fieldsProps }, this.presentationMode == PresentationMode.SECONDARY && this.buildTaskBar());
       }
     }
     return content;
@@ -460,7 +470,8 @@ export class SnkGuidesViewer {
       dataUnit: this.dataUnit,
       recordsValidator: this.recordsValidator,
       fieldToFocus: this._fieldToGetFocus,
-      onRequestClearFieldToFocus: this.clearFieldToFocusHandler.bind(this)
+      onRequestClearFieldToFocus: this.clearFieldToFocusHandler.bind(this),
+      fieldsProps: this._fieldsProps
     }), this.getContent())), h("snk-configurator", { ref: (ref) => this._snkConfigurator = ref, viewMode: this.getConfigViewMode(), onConfigSelected: (evt) => this.changeConfigViewMode(evt.detail), messagesBuilder: this.messagesBuilder, onOpenConfig: (evt) => this.openConfig(evt.detail), resourceID: this.resourceID })));
   }
   static get is() { return "snk-guides-viewer"; }
@@ -774,7 +785,8 @@ export class SnkGuidesViewer {
       "_guides": {},
       "_formEditorConfigManager": {},
       "_formEditorDataUnit": {},
-      "_fieldToGetFocus": {}
+      "_fieldToGetFocus": {},
+      "_fieldsProps": {}
     };
   }
   static get events() {
@@ -874,6 +886,31 @@ export class SnkGuidesViewer {
           "text": "Abre o localizador de campos",
           "tags": []
         }
+      },
+      "setFieldProp": {
+        "complexType": {
+          "signature": "(fieldName: string, propName: string, value: any) => Promise<void>",
+          "parameters": [{
+              "tags": [],
+              "text": ""
+            }, {
+              "tags": [],
+              "text": ""
+            }, {
+              "tags": [],
+              "text": ""
+            }],
+          "references": {
+            "Promise": {
+              "location": "global"
+            }
+          },
+          "return": "Promise<void>"
+        },
+        "docs": {
+          "text": "Altera/adiciona uma propriedade nos metadados do campo.",
+          "tags": []
+        }
       }
     };
   }

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

@@ -7,26 +7,31 @@ export class CommonsExporter {
   }
   async getColumnsMetadata() {
     var _a;
-    const columnsState = await ((_a = this.grid) === null || _a === void 0 ? void 0 : _a.getColumnsState());
-    return this.buildColumnsMetadata(columnsState);
+    this.columnsState = await ((_a = this.grid) === null || _a === void 0 ? void 0 : _a.getColumnsState()) || [];
+    return await this.buildColumnsMetadata(this.columnsState);
   }
-  buildColumnsMetadata(gridColumns) {
+  getColumnsState() {
+    return this.columnsState;
+  }
+  async buildColumnsMetadata(gridColumns) {
+    var _a, _b;
     const columnsMetadata = [];
-    gridColumns === null || gridColumns === void 0 ? void 0 : gridColumns.forEach((column) => {
-      var _a, _b;
+    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") {
-        return;
+        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
+        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) {
@@ -42,7 +47,8 @@ export class CommonsExporter {
         };
         columnsMetadata.push(descriptionColumn);
       }
-    });
+    }
+    ;
     return columnsMetadata || [];
   }
 }

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

@@ -48,6 +48,11 @@ export default class ClientSideExporterProvider extends CommonsExporter {
     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);
   }
 }