@sankhyalabs/sankhyablocks 9.2.0-ms.8 → 9.2.0-rc.1

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

@@ -1,10 +1,10 @@
-import { h, Fragment, } from '@stencil/core';
-import { Action as DUAction, ApplicationContext, ElementIDUtils, StringUtils, KeyboardManager } from '@sankhyalabs/core';
+import { Fragment, h, } from '@stencil/core';
+import { Action as DUAction, ApplicationContext, ElementIDUtils, KeyboardManager, StringUtils, } from '@sankhyalabs/core';
 import { TaskbarElement } from '../snk-taskbar/elements/taskbar-elements';
 import { ConfigStorage } from '../../lib/configs/ConfigStorage';
 import { ExporterStrategy, PresentationMode } from '../../lib/@types';
 import TaskbarProcessor from '../snk-taskbar/processor/taskbar-processor';
-import store from "../../lib/store";
+import store from '../../lib/store';
 import SnkMultiSelectionListDataSource from './filtercolumn/SnkMultiSelectionListDataSource';
 import { SelectionMode } from '@sankhyalabs/core/dist/dataunit/DataUnit';
 import { CrudUtils } from '../../lib';
@@ -19,23 +19,23 @@ export class SnkGrid {
     this._customRenders = new Map();
     this._keyboardManager = new KeyboardManager();
     this._topTaskbarProcessor = new TaskbarProcessor({
-      "snkGridTopTaskbar.regular": ["FORM_MODE", "CONFIGURATOR", "INSERT"],
-      "snkGridTopTaskbar.regular.secondary": ["FORM_MODE", "CONFIGURATOR", "INSERT"],
-      "snkGridTopTaskbar.regular.singleTaskbar": [],
-      "snkGridTopTaskbar.finish_edition": ["CANCEL", "SAVE", this.handleAddFormMode()],
-      "snkGridTopTaskbar.finish_edition.secondary": [],
-      "snkGridTopTaskbar.finish_edition.singleTaskbar": [],
+      'snkGridTopTaskbar.regular': ['FORM_MODE', 'CONFIGURATOR', 'INSERT'],
+      'snkGridTopTaskbar.regular.secondary': ['FORM_MODE', 'CONFIGURATOR', 'INSERT'],
+      'snkGridTopTaskbar.regular.singleTaskbar': [],
+      'snkGridTopTaskbar.finish_edition': ['CANCEL', 'SAVE', this.handleAddFormMode()],
+      'snkGridTopTaskbar.finish_edition.secondary': [],
+      'snkGridTopTaskbar.finish_edition.singleTaskbar': [],
     });
     this._headerTaskbarProcessor = new TaskbarProcessor({
-      "snkGridHeaderTaskbar.unselected": ["REFRESH", "DATA_EXPORTER", "ACTIONS_BUTTON", "MORE_OPTIONS"],
-      "snkGridHeaderTaskbar.selected": this.getGridHeaderSelectedBtns(),
-      "snkGridHeaderTaskbar.detail.unselected": ["REFRESH", "MORE_OPTIONS"],
-      "snkGridHeaderTaskbar.detail.selected": ["UPDATE", "ATTACH", "CLONE", "REMOVE", "MORE_OPTIONS", "DIVIDER", "REFRESH"],
-      "snkGridHeaderTaskbar.singleTaskbar.unselected": ["INSERT", "FORM_MODE", "CONFIGURATOR", "REFRESH", "DATA_EXPORTER", "ACTIONS_BUTTON", "MORE_OPTIONS"],
-      "snkGridHeaderTaskbar.singleTaskbar.selected": ["UPDATE", "CLONE", "REMOVE", "MORE_OPTIONS", "DIVIDER", "ATTACH", "FORM_MODE", "CONFIGURATOR", "REFRESH", "DATA_EXPORTER", "ACTIONS_BUTTON"],
-      "snkGridHeaderTaskbar.singleTaskbar.detail.unselected": ["INSERT", "FORM_MODE", "CONFIGURATOR", "REFRESH", "MORE_OPTIONS"],
-      "snkGridHeaderTaskbar.singleTaskbar.detail.selected": ["UPDATE", "ATTACH", "CLONE", "REMOVE", "MORE_OPTIONS", "DIVIDER", "FORM_MODE", "CONFIGURATOR", "REFRESH"],
-      "snkGridHeaderTaskbar.singleTaskbar.finish_edition": ["CANCEL", "SAVE", this.handleAddFormMode()]
+      'snkGridHeaderTaskbar.unselected': ['REFRESH', 'DATA_EXPORTER', 'ACTIONS_BUTTON', 'MORE_OPTIONS'],
+      'snkGridHeaderTaskbar.selected': this.getGridHeaderSelectedBtns(),
+      'snkGridHeaderTaskbar.detail.unselected': ['REFRESH', 'MORE_OPTIONS'],
+      'snkGridHeaderTaskbar.detail.selected': ['UPDATE', 'ATTACH', 'CLONE', 'REMOVE', 'MORE_OPTIONS', 'DIVIDER', 'REFRESH'],
+      'snkGridHeaderTaskbar.singleTaskbar.unselected': ['INSERT', 'FORM_MODE', 'CONFIGURATOR', 'REFRESH', 'DATA_EXPORTER', 'ACTIONS_BUTTON', 'MORE_OPTIONS'],
+      'snkGridHeaderTaskbar.singleTaskbar.selected': ['UPDATE', 'CLONE', 'REMOVE', 'MORE_OPTIONS', 'DIVIDER', 'ATTACH', 'FORM_MODE', 'CONFIGURATOR', 'REFRESH', 'DATA_EXPORTER', 'ACTIONS_BUTTON'],
+      'snkGridHeaderTaskbar.singleTaskbar.detail.unselected': ['INSERT', 'FORM_MODE', 'CONFIGURATOR', 'REFRESH', 'MORE_OPTIONS'],
+      'snkGridHeaderTaskbar.singleTaskbar.detail.selected': ['UPDATE', 'ATTACH', 'CLONE', 'REMOVE', 'MORE_OPTIONS', 'DIVIDER', 'FORM_MODE', 'CONFIGURATOR', 'REFRESH'],
+      'snkGridHeaderTaskbar.singleTaskbar.finish_edition': ['CANCEL', 'SAVE', this.handleAddFormMode()],
     });
     this.dataUnitInterceptor = {
       interceptAction: async (action) => {
@@ -43,7 +43,7 @@ export class SnkGrid {
           return await this.interceptMetadataLoaded(action);
         }
         return action;
-      }
+      },
     };
     this._dataUnit = undefined;
     this._dataState = undefined;
@@ -91,12 +91,15 @@ export class SnkGrid {
     const btns = [
       TaskbarElement.UPDATE, TaskbarElement.CLONE, TaskbarElement.REMOVE,
       TaskbarElement.MORE_OPTIONS, TaskbarElement.DIVIDER, TaskbarElement.ATTACH, TaskbarElement.FORM_MODE,
-      TaskbarElement.CONFIGURATOR, TaskbarElement.REFRESH, TaskbarElement.DATA_EXPORTER, TaskbarElement.ACTIONS_BUTTON
+      TaskbarElement.CONFIGURATOR, TaskbarElement.REFRESH, TaskbarElement.DATA_EXPORTER, TaskbarElement.ACTIONS_BUTTON,
     ];
     if (this.multipleEditionEnabled)
       btns.unshift(TaskbarElement.UPDATE_MULTIPLE);
     return btns;
   }
+  async refreshColumnFilterDataSource() {
+    await this._grid.refreshColumnFilterDataSource();
+  }
   /**
    * Recarrega a configuração da grade.
    * @description Este método força o recarregamento da configuração da grade a partir do `ConfigStorage`. A operação é assíncrona, mas o método não aguarda sua conclusão.
@@ -252,7 +255,7 @@ export class SnkGrid {
     this.loadConfig();
   }
   handleAddFormMode() {
-    return this.enableGridInsert ? TaskbarElement.FORM_MODE : "";
+    return this.enableGridInsert ? TaskbarElement.FORM_MODE : '';
   }
   openGridConfig() {
     this._grid.getColumnsState()
@@ -296,6 +299,17 @@ export class SnkGrid {
       ConfigStorage.addGridLegacyConfig(this.configName, this.gridLegacyConfigName);
     }
   }
+  hasCalculatedFields(columnNames) {
+    let hasCalculatedFields = false;
+    columnNames.forEach(name => {
+      var _a;
+      const field = this._dataUnit.getField(name);
+      if (((_a = field.properties) === null || _a === void 0 ? void 0 : _a.calculated) === 'true') {
+        hasCalculatedFields = true;
+      }
+    });
+    return hasCalculatedFields;
+  }
   gridConfigChangeHandler(evt) {
     const config = this.normalizeGridConfig(evt.detail);
     ConfigStorage.saveGridConfig(config, this.configName, this.resourceID);
@@ -311,11 +325,25 @@ export class SnkGrid {
     });
     evt.stopPropagation();
   }
+  async hasToForceClientSideExporter() {
+    if (!this._grid) {
+      return false;
+    }
+    const filters = await this._grid.getAppliedColumnFilters();
+    const columnNames = filters.map(filter => filter.name.replace('FILTRO_COLUNA_', ''));
+    return this.hasCalculatedFields(columnNames);
+  }
   async dataExporterProviderStore() {
-    const dataExporterProvider = this.strategyExporter === ExporterStrategy.SERVER_SIDE
-      ? new ServerSideExporterProvider(this._dataUnit, this._grid)
-      : new ClientSideExporterProvider(this._dataUnit, this._grid);
-    store.set("exporterProviders", Object.assign(Object.assign({}, store.get("exporterProviders")), { [this.configName]: dataExporterProvider }));
+    /**
+     * O ServerSideExporterProvider do SankhyaOm não suporta a filtragem de campos calculados.
+     * Por esse motivo, precisamos verificar os filtros aplicados no momento e recriar o dataExporterProvider conforme necessário.
+     * Se houver campos calculados, forçamos o uso do clientSide, caso contrário é seguido o fluxo padrão.
+     */
+    const forceClientSide = await this.hasToForceClientSideExporter();
+    const dataExporterProvider = (forceClientSide || this.strategyExporter === ExporterStrategy.CLIENT_SIDE)
+      ? new ClientSideExporterProvider(this._dataUnit, this._grid)
+      : 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 };
@@ -364,15 +392,15 @@ export class SnkGrid {
     }
   }
   componentWillLoad() {
-    this._application = ApplicationContext.getContextValue("__SNK__APPLICATION__");
+    this._application = ApplicationContext.getContextValue('__SNK__APPLICATION__');
     //TODO: substituir pelo metodo nativo closest
     let parent = this._element.parentElement;
     while (parent) {
-      if (parent.tagName.toUpperCase() === "SNK-DATA-UNIT") {
+      if (parent.tagName.toUpperCase() === 'SNK-DATA-UNIT') {
         this._snkDataUnit = parent;
         this._dataUnit = this._snkDataUnit.dataUnit;
         if (!this._dataUnit) {
-          this._snkDataUnit.addEventListener("dataUnitReady", (evt) => {
+          this._snkDataUnit.addEventListener('dataUnitReady', (evt) => {
             this._dataUnit = evt.detail;
             this.finishLoading();
           });
@@ -382,8 +410,8 @@ export class SnkGrid {
         }
         if (!this.messagesBuilder)
           this.messagesBuilder = this._snkDataUnit.messagesBuilder;
-        this._snkDataUnit.addEventListener("dataStateChange", this.handleDataStateChange.bind(this));
-        this._snkDataUnit.addEventListener("cancelEdition", () => {
+        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) {
             this._dataUnit.clearSelection();
@@ -446,23 +474,23 @@ export class SnkGrid {
     var _a, _b;
     const hasSelectedRecord = this._dataState && !!((_a = this._dataState.selectionInfo) === null || _a === void 0 ? void 0 : _a.length);
     const taskbarIdPrefixLookup = {
-      primary: this.isDetail ? "snkGridHeaderTaskbar.detail" : "snkGridHeaderTaskbar",
-      secondary: this.isDetail ? "snkGridHeaderTaskbar.detail" : "snkGridHeaderTaskbar",
-      singleTaskbar: this.isDetail ? "snkGridHeaderTaskbar.singleTaskbar.detail" : "snkGridHeaderTaskbar.singleTaskbar"
+      primary: this.isDetail ? 'snkGridHeaderTaskbar.detail' : 'snkGridHeaderTaskbar',
+      secondary: this.isDetail ? 'snkGridHeaderTaskbar.detail' : 'snkGridHeaderTaskbar',
+      singleTaskbar: this.isDetail ? 'snkGridHeaderTaskbar.singleTaskbar.detail' : 'snkGridHeaderTaskbar.singleTaskbar',
     };
     const taskbarIdPrefix = taskbarIdPrefixLookup[this.presentationMode];
     let headerTaskbarId = hasSelectedRecord ? `${taskbarIdPrefix}.selected` : `${taskbarIdPrefix}.unselected`;
     if (((_b = this._dataState) === null || _b === void 0 ? void 0 : _b.isDirty) && this.presentationMode === PresentationMode.SINGLE_TASKBAR) {
-      headerTaskbarId = "snkGridHeaderTaskbar.singleTaskbar.finish_edition";
+      headerTaskbarId = 'snkGridHeaderTaskbar.singleTaskbar.finish_edition';
     }
     return headerTaskbarId;
   }
   getTopTaskBarId() {
     var _a;
     const suffixLookup = {
-      primary: "",
-      secondary: ".secondary",
-      singleTaskbar: ".singleTaskbar"
+      primary: '',
+      secondary: '.secondary',
+      singleTaskbar: '.singleTaskbar',
     };
     const sufix = suffixLookup[this.presentationMode];
     if ((_a = this._dataState) === null || _a === void 0 ? void 0 : _a.isDirty) {
@@ -472,9 +500,9 @@ export class SnkGrid {
   }
   getPrimaryButton() {
     const primaryButtonLookup = {
-      primary: "INSERT",
-      secondary: "",
-      singleTaskbar: "INSERT"
+      primary: 'INSERT',
+      secondary: '',
+      singleTaskbar: 'INSERT',
     };
     return primaryButtonLookup[this.presentationMode];
   }
@@ -514,10 +542,10 @@ export class SnkGrid {
   getActionsSettingsList() {
     const hardList = [{
         value: StringUtils.generateUUID(),
-        label: this.messagesBuilder.getMessage("snkGrid.findColumn", {}),
+        label: this.messagesBuilder.getMessage('snkGrid.findColumn', {}),
         disableCloseOnSelect: true,
         eagerInitialize: true,
-        itemBuilder: (_, item) => this.getColumnSearch(item)
+        itemBuilder: (_, item) => this.getColumnSearch(item),
       }];
     return hardList;
   }
@@ -545,7 +573,9 @@ export class SnkGrid {
       return undefined;
     }
     return (h("div", { class: "snk-grid__container ez-flex ez-flex--column ez-flex-item--auto ez-padding--large ez-box--no-outline", tabindex: "0" }, h("div", { class: "snk-grid__header ez-margin-bottom--extra-small" }, 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, autoLoad: this.autoLoad, enableLockManagerLoadingComp: this.enableLockManagerLoadingComp }), 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 ez-padding-top--extra-small", "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', actionsSettingsList: this.getActionsSettingsList() }, 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, enableGridInsert: this.enableGridInsert, enableContinuousInsert: this._enableContinuousInsert, enableLockManagerTaskbarClick: this.enableLockManagerTaskbarClick, enableLockManagerLoadingComp: this.enableLockManagerLoadingComp, outlineMode: this.outlineMode, useSearchColumn: this.useSearchColumn, suppressHorizontalScroll: this.suppressHorizontalScroll, paginationCounterMode: this.paginationCounterMode, suppressCheckboxColumn: this.suppressCheckboxColumn, compact: this.compact }, h("snk-taskbar", { id: 'teste', dataUnit: this._dataUnit, configName: this.configName, messagesBuilder: this.messagesBuilder, "data-element-id": "grid_left", buttons: this.getGridHeaderButtons(), 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, actionsSettingsList: this.getActionsSettingsList() }, h("slot", { name: this.gridHeaderCustomSlotId }))), h("div", { class: "ez-col ez-col--sd-12 snk-grid-container__footer" }, h("slot", { name: "SnkGridFooter" })), h("ez-popup", { size: "medium", heightMode: "auto", useHeader: false, opened: this._popUpGridConfig, onEzClosePopup: () => 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, enableLockManagerLoadingComp: this.enableLockManagerLoadingComp }), 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 ez-padding-top--extra-small", "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', actionsSettingsList: this.getActionsSettingsList() }, 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);
+      }, onEzColumnFilterChanged: async () => await this.dataExporterProviderStore(), 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, enableGridInsert: this.enableGridInsert, enableContinuousInsert: this._enableContinuousInsert, enableLockManagerTaskbarClick: this.enableLockManagerTaskbarClick, enableLockManagerLoadingComp: this.enableLockManagerLoadingComp, outlineMode: this.outlineMode, useSearchColumn: this.useSearchColumn, suppressHorizontalScroll: this.suppressHorizontalScroll, paginationCounterMode: this.paginationCounterMode, suppressCheckboxColumn: this.suppressCheckboxColumn, suppressFilterColumn: this.suppressFilterColumn, compact: this.compact }, h("snk-taskbar", { id: 'teste', dataUnit: this._dataUnit, configName: this.configName, messagesBuilder: this.messagesBuilder, "data-element-id": "grid_left", buttons: this.getGridHeaderButtons(), 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, actionsSettingsList: this.getActionsSettingsList() }, h("slot", { name: this.gridHeaderCustomSlotId }))), h("div", { class: "ez-col ez-col--sd-12 snk-grid-container__footer" }, h("slot", { name: "SnkGridFooter" })), h("ez-popup", { size: "medium", heightMode: "auto", useHeader: false, opened: this._popUpGridConfig, onEzClosePopup: () => 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"; }
@@ -1291,6 +1321,22 @@ export class SnkGrid {
   }
   static get methods() {
     return {
+      "refreshColumnFilterDataSource": {
+        "complexType": {
+          "signature": "() => Promise<void>",
+          "parameters": [],
+          "references": {
+            "Promise": {
+              "location": "global"
+            }
+          },
+          "return": "Promise<void>"
+        },
+        "docs": {
+          "text": "",
+          "tags": []
+        }
+      },
       "reloadConfig": {
         "complexType": {
           "signature": "() => Promise<void>",

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

@@ -1,3 +1,21 @@
+/**
+ * Componente responsável pela criação, edição e gerenciamento de filtros personalizados.
+ *
+ * Permite alternar entre os modos assistente e avançado, salvar, cancelar e manipular filtros.
+ *
+ * @component
+ * @example
+ * <snk-personalized-filter
+ *    entityUri="sua/entidade"
+ *    filterId="idFiltro"
+ *    configName="nomeConfig"
+ *    resourceID="resourceId"
+ *    isDefaultFilter={false}
+ *    messagesBuilder={messagesBuilderInstance}
+ *    onEzSave={handler}
+ *    onEzCancel={handler}
+ * />
+ */
 import { h, Host, Fragment } from '@stencil/core';
 import { ApplicationContext, StringUtils } from '@sankhyalabs/core';
 import { PersonalizedFilterUtils } from './subcomponents/snk-filter-param-config/utils/PersonalizedFilterUtils';
@@ -34,8 +52,10 @@ export class SnkPersonalizedFilter {
     this.resourceID = undefined;
     this.isDefaultFilter = false;
   }
-  /*
-   * Cria um novo filtro se não houver nenhum filtro existente
+  /**
+   * Cria um novo filtro personalizado caso não exista nenhum.
+   * @method
+   * @returns {Promise<void>}
    */
   async createPersonalizedFilter() {
     const newPersonalizedFilter = {
@@ -71,6 +91,12 @@ export class SnkPersonalizedFilter {
     this._originalFilterAssistent = ObjectUtils.copy(newPersonalizedFilter);
     this._filterAssistent = ObjectUtils.copy(newPersonalizedFilter);
   }
+  /**
+   * Carrega o filtro personalizado com base no identificador informado.
+   * @watch filterId
+   * @param newValue Novo valor do filtroId.
+   * @param oldValue Valor anterior do filtroId.
+   */
   loadFilter(newValue, oldValue) {
     if (newValue == null || oldValue == newValue || this.resourceID == undefined) {
       return;
@@ -357,7 +383,10 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
           "text": "Respons\u00E1vel por flexibilizar e padronizar o uso de mensagens nos blocos de constru\u00E7\u00E3o."
         }
       },
@@ -372,8 +401,11 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Respons\u00E1vel por receber a URI da entidade."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
+          "text": "URI da entidade utilizada para buscar os campos dispon\u00EDveis para filtro."
         },
         "attribute": "entity-uri",
         "reflect": false
@@ -389,8 +421,11 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Id do filtro que ser\u00E1 carregado."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
+          "text": "Identificador do filtro a ser carregado."
         },
         "attribute": "filter-id",
         "reflect": false
@@ -406,8 +441,11 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Nome da configura\u00E7\u00E3o. Serve para distinguir v\u00E1rias inst\u00E2ncias do componente."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
+          "text": "Nome da configura\u00E7\u00E3o, utilizado para distinguir m\u00FAltiplas inst\u00E2ncias do componente."
         },
         "attribute": "config-name",
         "reflect": false
@@ -423,8 +461,11 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Nome da configura\u00E7\u00E3o. Serve para distinguir v\u00E1rias inst\u00E2ncias do componente."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }],
+          "text": "Identificador do recurso utilizado para salvar e recuperar filtros."
         },
         "attribute": "resource-i-d",
         "reflect": false
@@ -440,8 +481,14 @@ export class SnkPersonalizedFilter {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "Define se o filtro em quest\u00E3o \u00E9 um filtro padr\u00E3o."
+          "tags": [{
+              "name": "property",
+              "text": undefined
+            }, {
+              "name": "default",
+              "text": "false"
+            }],
+          "text": "Indica se o filtro \u00E9 o filtro padr\u00E3o do sistema."
         },
         "attribute": "is-default-filter",
         "reflect": false,
@@ -463,8 +510,11 @@ export class SnkPersonalizedFilter {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": ""
+          "tags": [{
+              "name": "event",
+              "text": undefined
+            }],
+          "text": "Evento emitido ao cancelar a personaliza\u00E7\u00E3o do filtro."
         },
         "complexType": {
           "original": "void",
@@ -478,8 +528,11 @@ export class SnkPersonalizedFilter {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": ""
+          "tags": [{
+              "name": "event",
+              "text": undefined
+            }],
+          "text": "Evento emitido ao salvar as altera\u00E7\u00F5es do filtro personalizado."
         },
         "complexType": {
           "original": "string",
@@ -493,8 +546,11 @@ export class SnkPersonalizedFilter {
         "cancelable": true,
         "composed": true,
         "docs": {
-          "tags": [],
-          "text": ""
+          "tags": [{
+              "name": "event",
+              "text": undefined
+            }],
+          "text": "Evento emitido ap\u00F3s salvar as altera\u00E7\u00F5es do filtro personalizado."
         },
         "complexType": {
           "original": "void",
@@ -521,8 +577,14 @@ export class SnkPersonalizedFilter {
           "return": "Promise<void>"
         },
         "docs": {
-          "text": "",
-          "tags": []
+          "text": "Cria um novo filtro personalizado caso n\u00E3o exista nenhum.",
+          "tags": [{
+              "name": "method",
+              "text": undefined
+            }, {
+              "name": "returns",
+              "text": undefined
+            }]
         }
       }
     };