@sankhyalabs/sankhyablocks 8.15.0-dev.8 → 8.15.0-dev.81

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

@@ -13,6 +13,8 @@ export class SnkCrud {
   constructor() {
     this._keyDownHandler = async (event) => this.keyDownListener(event);
     this._viewHistory = [];
+    this._customEditors = new Map();
+    this._customRenders = new Map();
     this._dataUnit = undefined;
     this._dataState = undefined;
     this.attachmentRegisterKey = undefined;
@@ -20,6 +22,7 @@ export class SnkCrud {
     this._canEdit = undefined;
     this._resourceID = undefined;
     this.configName = undefined;
+    this.filterBarTitle = undefined;
     this.selectionToastConfig = undefined;
     this.showActionButtons = false;
     this.actionsList = undefined;
@@ -30,6 +33,12 @@ export class SnkCrud {
     this.presentationMode = PresentationMode.PRIMARY;
     this.messagesBuilder = undefined;
     this.useEnterLikeTab = false;
+    this.gridLegacyConfigName = undefined;
+    this.filterBarLegacyConfigName = undefined;
+    this.formLegacyConfigName = undefined;
+    this.disablePersonalizedFilter = undefined;
+    this.autoLoad = undefined;
+    this.autoFocus = true;
     this.customContainerId = `SNK-CRUD-CUSTOM-CONTAINER-${StringUtils.generateUUID()}`;
   }
   /**
@@ -65,6 +74,49 @@ export class SnkCrud {
   async getFilterBar() {
     return await this._snkGrid.getFilterBar();
   }
+  /**
+   * Registra um editor customizado para campos da grade e formulário.
+   */
+  async addCustomEditor(fieldName, customEditor) {
+    if (this._guidesViewer && this._snkGrid) {
+      this._guidesViewer.addCustomEditor(fieldName, customEditor);
+      this._snkGrid.addCustomEditor(fieldName, customEditor);
+      return;
+    }
+    const newCustomEditors = new Map(this._customEditors);
+    newCustomEditors.set(fieldName, customEditor);
+    this._customEditors = newCustomEditors;
+  }
+  /**
+   * Registra um render customizado para colunas da grid.
+   */
+  async addGridCustomRender(fieldName, customRender) {
+    if (this._snkGrid) {
+      this._snkGrid.addGridCustomRender(fieldName, customRender);
+      return;
+    }
+    const newCustomRenders = new Map(this._customRenders);
+    newCustomRenders.set(fieldName, customRender);
+    this._customRenders = newCustomRenders;
+  }
+  /**
+   * 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];
   }
@@ -89,6 +141,12 @@ export class SnkCrud {
   setViewMode(viewMode) {
     this._viewStack.show(viewMode);
     this._currentViewMode = viewMode;
+    if (viewMode === VIEW_MODE.GRID) {
+      this._snkGrid.setFocus();
+    }
+    else if (viewMode === VIEW_MODE.FORM) {
+      this._guidesViewer.setFocus();
+    }
   }
   openConfig(viewMode) {
     this._snkConfigurator.close();
@@ -118,6 +176,29 @@ export class SnkCrud {
     const joinedPrimaryKeys = recordCriteria.map(({ value }) => value).join('_');
     return joinedPrimaryKeys;
   }
+  setCustomRenders() {
+    if (!this._snkGrid) {
+      return;
+    }
+    for (const [fieldName, customRender] of this._customRenders) {
+      this._snkGrid.addGridCustomRender(fieldName, customRender);
+      this._customRenders.delete(fieldName);
+    }
+  }
+  setCustomEditors() {
+    if (!this._snkGrid || !this._guidesViewer) {
+      return;
+    }
+    for (const [fieldName, customEditor] of this._customEditors) {
+      this._guidesViewer.addCustomEditor(fieldName, customEditor);
+      this._snkGrid.addCustomEditor(fieldName, customEditor);
+      this._customEditors.delete(fieldName);
+    }
+  }
+  componentDidRender() {
+    this.setCustomRenders();
+    this.setCustomEditors();
+  }
   componentWillLoad() {
     this._application = ApplicationContext.getContextValue("__SNK__APPLICATION__");
     let parent = this._element.parentElement;
@@ -140,12 +221,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;
@@ -161,8 +237,29 @@ 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 && rmPrecision !== 0) {
+        continue;
+      }
+      await this.setFieldProp(field, 'precision', rmPrecision);
+      await this.setFieldProp(field, 'prettyPrecision', rmPrecision);
+    }
+    ;
+  }
   async initKeyboardManager() {
-    const keyboardManager = await this._application.getKeyboardManager();
+    var _a;
+    const keyboardManager = await ((_a = this._application) === null || _a === void 0 ? void 0 : _a.getKeyboardManager());
     if (keyboardManager) {
       const dataUnit = this._dataUnit || await this._snkDataUnit.getDataUnit();
       async function saveDataUnitHandlingFocus() {
@@ -179,39 +276,40 @@ export class SnkCrud {
           element.focus();
       }
       keyboardManager
-        .bind("F6", this.toggleView.bind(this), { description: "Alterna entre modo formulário e grade." })
-        .bind("F7", saveDataUnitHandlingFocus.bind(this), { description: "Salva os dados." })
-        .bind("ctrl + \\", saveDataUnitHandlingFocus.bind(this), { description: "Salva os dados." })
-        .bind("F8", dataUnit.addRecord.bind(dataUnit), { description: "Adiciona um novo registro." })
-        .bind("F9", dataUnit.removeSelectedRecords.bind(dataUnit), { description: "Remove o registro selecionado." })
-        .bind("ctrl + F9", dataUnit.removeSelectedRecords.bind(dataUnit), { description: "Remove o registro selecionado." })
+        .bind("F6", this.toggleView.bind(this), { description: "Alterna entre modo formulário e grade.", element: this._element })
+        .bind("F7", saveDataUnitHandlingFocus.bind(this), { description: "Salva os dados.", element: this._element })
+        .bind("ctrl + \\", saveDataUnitHandlingFocus.bind(this), { description: "Salva os dados.", element: this._element })
+        .bind("F8", dataUnit.addRecord.bind(dataUnit), { description: "Adiciona um novo registro.", element: this._element })
+        .bind("F9", dataUnit.removeSelectedRecords.bind(dataUnit), { description: "Remove o registro selecionado.", element: this._element })
+        .bind("ctrl + F9", dataUnit.removeSelectedRecords.bind(dataUnit), { description: "Remove o registro selecionado.", element: this._element })
         .bind("ctrl + .", () => {
         if (dataUnit.getSelectionInfo().records.length === 0) {
           return dataUnit.selectFirst();
         }
         return dataUnit.nextRecord();
       }, {
-        description: "Avança para o próximo registro."
+        description: "Avança para o próximo registro.", element: this._element
       })
-        .bind("ctrl + ,", dataUnit.previousRecord.bind(dataUnit), { description: "Retorna ao registro anterior." })
+        .bind("ctrl + ,", dataUnit.previousRecord.bind(dataUnit), { description: "Retorna ao registro anterior.", element: this._element })
         .bind("F5", async () => {
         const currentView = await this._viewStack.getSelectedIndex();
         if (VIEW_MODE.GRID === currentView) {
           dataUnit.loadData();
         }
-      }, { description: "Atualiza os dados." })
+      }, { description: "Atualiza os dados.", element: this._element })
         .bind("Escape", () => {
         if (dataUnit.isDirty()) {
           dataUnit.cancelEdition();
         }
       }, {
         debounceTime: 1000,
-        description: "Cancela uma ação."
+        description: "Cancela uma ação.", element: this._element
       });
     }
   }
   async removeShortcuts() {
-    const keyboardManager = await this._application.getKeyboardManager();
+    var _a;
+    const keyboardManager = await ((_a = this._application) === null || _a === void 0 ? void 0 : _a.getKeyboardManager());
     if (keyboardManager) {
       keyboardManager
         .unbind("F6")
@@ -278,7 +376,7 @@ export class SnkCrud {
       return;
     }
     this._snkDataUnit.ignoreSaveMessage = this._currentViewMode === VIEW_MODE.GRID;
-    return (h(Host, null, h("ez-view-stack", { ref: (ref) => this._viewStack = ref, "data-element-id": "crud" }, h("stack-item", null, h("snk-grid", { ref: (ref) => this._snkGrid = ref, "data-element-id": "crud_grid", configName: this.configName, onGridDoubleClick: () => this.gridToForm(true), taskbarManager: this.taskbarManager, onActionClick: evt => this.executeAction(evt.detail), messagesBuilder: this.messagesBuilder, actionsList: this.actionsList, statusResolver: this.statusResolver, multipleSelection: this.multipleSelection, presentationMode: this.presentationMode, selectionToastConfig: this.selectionToastConfig, useEnterLikeTab: this.useEnterLikeTab, canEdit: this._canEdit, resourceID: this._resourceID }, h("slot", { name: "GRID_TASKBAR_CUSTOM_ELEMENTS" }), h("slot", { name: "GRID_HEADER_CUSTOM_ELEMENTS" }), h("slot", { name: "SnkGridHeader" }), h("slot", { name: "SnkGridFooter" }), h("slot", { name: "SnkGridTaskBar" }))), h("stack-item", null, h("snk-guides-viewer", { ref: ref => this._guidesViewer = ref, entityPath: this._snkDataUnit.entityName, messagesBuilder: this.messagesBuilder, onExit: () => this.setViewMode(VIEW_MODE.GRID), dataState: this._dataState, dataUnit: this._dataUnit, actionsList: this.actionsList, taskbarManager: this.taskbarManager, configName: this.configName, onActionClick: evt => this.executeAction(evt.detail), presentationMode: this.presentationMode, "data-element-id": "crud_form", canEdit: this._canEdit, resourceID: this._resourceID, detailTaskbarCustomContainerId: this.customContainerId }, h("slot", { name: "GUIDES_VIEWER_TASKBAR_CUSTOM_ELEMENTS" }), h("slot", { name: "SnkFormTaskBar" }))), h("stack-item", null, h("snk-attach", { registerKey: this.attachmentRegisterKey, messagesBuilder: this.messagesBuilder, entityName: this._snkDataUnit.entityName, onBack: this.backView.bind(this) })), h("snk-configurator", { ref: (ref) => this._snkConfigurator = ref, viewMode: this._currentViewMode, messagesBuilder: this.messagesBuilder, onConfigSelected: (evt) => this.setViewMode(evt.detail), onOpenConfig: (evt) => this.openConfig(evt.detail), showActionButtons: this.showActionButtons, onSave: evt => this.handleConfiguratorEvent(evt, 'SAVE'), onCancel: evt => this.handleConfiguratorEvent(evt, 'CANCEL'), resourceID: this._resourceID, customContainerId: this.customContainerId })), h("div", { id: `${this.customContainerId}` }, h("slot", { name: "SnkConfigContainerSlot" }), h("slot", { name: "DETAIL_GRID_HEADER_CUSTOM_ELEMENTS" }), h("slot", { name: "DETAIL_GRID_TASKBAR_CUSTOM_ELEMENTS" }), h("slot", { name: "DETAIL_TASKBAR_CUSTOM_ELEMENTS" }))));
+    return (h(Host, null, h("ez-view-stack", { ref: (ref) => this._viewStack = ref, "data-element-id": "crud" }, h("stack-item", null, h("snk-grid", { ref: (ref) => this._snkGrid = ref, filterBarTitle: this.filterBarTitle, "data-element-id": "crud_grid", configName: this.configName, onGridDoubleClick: () => this.gridToForm(true), taskbarManager: this.taskbarManager, onActionClick: evt => this.executeAction(evt.detail), messagesBuilder: this.messagesBuilder, actionsList: this.actionsList, statusResolver: this.statusResolver, multipleSelection: this.multipleSelection, presentationMode: this.presentationMode, recordsValidator: this.recordsValidator, selectionToastConfig: this.selectionToastConfig, useEnterLikeTab: this.useEnterLikeTab, canEdit: this._canEdit, resourceID: this._resourceID, disablePersonalizedFilter: this.disablePersonalizedFilter, gridLegacyConfigName: this.gridLegacyConfigName, filterBarLegacyConfigName: this.filterBarLegacyConfigName, autoLoad: this.autoLoad, autoFocus: this.autoFocus }, h("slot", { name: "GRID_TASKBAR_CUSTOM_ELEMENTS" }), h("slot", { name: "GRID_HEADER_CUSTOM_ELEMENTS" }), h("slot", { name: "SnkGridHeader" }), h("slot", { name: "SnkGridFooter" }), h("slot", { name: "SnkGridTaskBar" }))), h("stack-item", null, h("snk-guides-viewer", { ref: ref => this._guidesViewer = ref, entityPath: this._snkDataUnit.entityName, messagesBuilder: this.messagesBuilder, onExit: () => this.setViewMode(VIEW_MODE.GRID), dataState: this._dataState, dataUnit: this._dataUnit, actionsList: this.actionsList, taskbarManager: this.taskbarManager, configName: this.configName, onActionClick: evt => this.executeAction(evt.detail), presentationMode: this.presentationMode, "data-element-id": "crud_form", canEdit: this._canEdit, recordsValidator: this.recordsValidator, resourceID: this._resourceID, detailTaskbarCustomContainerId: this.customContainerId, formLegacyConfigName: this.formLegacyConfigName }, h("slot", { name: "GUIDES_VIEWER_TASKBAR_CUSTOM_ELEMENTS" }), h("slot", { name: "SnkFormTaskBar" }))), h("stack-item", null, h("snk-attach", { registerKey: this.attachmentRegisterKey, messagesBuilder: this.messagesBuilder, entityName: this._snkDataUnit.entityName, onBack: this.backView.bind(this) })), h("snk-configurator", { ref: (ref) => this._snkConfigurator = ref, viewMode: this._currentViewMode, messagesBuilder: this.messagesBuilder, onConfigSelected: (evt) => this.setViewMode(evt.detail), onOpenConfig: (evt) => this.openConfig(evt.detail), showActionButtons: this.showActionButtons, onSave: evt => this.handleConfiguratorEvent(evt, 'SAVE'), onCancel: evt => this.handleConfiguratorEvent(evt, 'CANCEL'), resourceID: this._resourceID, customContainerId: this.customContainerId })), h("div", { id: `${this.customContainerId}` }, h("slot", { name: "SnkConfigContainerSlot" }), h("slot", { name: "DETAIL_GRID_HEADER_CUSTOM_ELEMENTS" }), h("slot", { name: "DETAIL_GRID_TASKBAR_CUSTOM_ELEMENTS" }), h("slot", { name: "DETAIL_TASKBAR_CUSTOM_ELEMENTS" }))));
   }
   static get is() { return "snk-crud"; }
   static get encapsulation() { return "scoped"; }
@@ -311,6 +409,23 @@ export class SnkCrud {
         "attribute": "config-name",
         "reflect": false
       },
+      "filterBarTitle": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "T\u00EDtulo que ser\u00E1 apresentado na barra de filtros"
+        },
+        "attribute": "filter-bar-title",
+        "reflect": false
+      },
       "selectionToastConfig": {
         "type": "unknown",
         "mutable": false,
@@ -514,6 +629,109 @@ export class SnkCrud {
         "attribute": "use-enter-like-tab",
         "reflect": false,
         "defaultValue": "false"
+      },
+      "gridLegacyConfigName": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "Chave da configura\u00E7\u00E3o legado da grade."
+        },
+        "attribute": "grid-legacy-config-name",
+        "reflect": false
+      },
+      "filterBarLegacyConfigName": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "Chave da configura\u00E7\u00E3o legado da barra de filtros."
+        },
+        "attribute": "filter-bar-legacy-config-name",
+        "reflect": false
+      },
+      "formLegacyConfigName": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "Chave da configura\u00E7\u00E3o legado do formul\u00E1rio."
+        },
+        "attribute": "form-legacy-config-name",
+        "reflect": false
+      },
+      "disablePersonalizedFilter": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [],
+          "text": "Desabilita a apresenta\u00E7\u00E3o da op\u00E7\u00E3o de filtros personalizados na filter bar (chip de filtros)\ne no modal lateral de filtros (container de filtros personalizados)."
+        },
+        "attribute": "disable-personalized-filter",
+        "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"
       }
     };
   }
@@ -685,6 +903,128 @@ export class SnkCrud {
           "text": "Retorna o elemento da filter-bar da grade.",
           "tags": []
         }
+      },
+      "addCustomEditor": {
+        "complexType": {
+          "signature": "(fieldName: string, customEditor: ICustomEditor) => Promise<void>",
+          "parameters": [{
+              "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) => Promise<void>",
+          "parameters": [{
+              "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": []
+        }
+      },
+      "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": []
+        }
       }
     };
   }