@ecodev/natural 38.1.0 → 40.0.0

package/bundles/ecodev-natural.umd.js

@@ -3372,7 +3372,7 @@
      * Components inheriting from this class can be used as standalone with input attributes.
      *
      * Usage :
-     * <natural-my-listing [forcedVariables]="{filter:...}" [initialColumns]="['col1']" [persistSearch]="false">
+     * <natural-my-listing [forcedVariables]="{filter:...}" [selectedColumns]="['col1']" [persistSearch]="false">
      */
     // @dynamic
     var NaturalAbstractList = /** @class */ (function (_super) {
@@ -3388,7 +3388,7 @@
             /**
              * Columns list after interaction with <natural-columns-picker>
              */
-            _this._selectedColumns = [];
+            _this.columnsForTable = [];
             /**
              * The default column selection that automatically happened after <natural-columns-picker> initialization
              */
@@ -3639,7 +3639,7 @@
          * Uses data provided by router such as:
          *
          * - `route.data.forcedVariables`
-         * - `route.data.initialColumns`
+         * - `route.data.selectedColumns`
          */
         NaturalAbstractList.prototype.initFromRoute = function () {
             // Variables
@@ -3647,8 +3647,8 @@
                 this.applyForcedVariables(this.route.snapshot.data.forcedVariables);
             }
             // Columns
-            if (this.route.snapshot.data.initialColumns) {
-                this.initialColumns = this.route.snapshot.data.initialColumns;
+            if (this.route.snapshot.data.selectedColumns) {
+                this.selectedColumns = this.route.snapshot.data.selectedColumns;
             }
         };
         NaturalAbstractList.prototype.getDataObservable = function () {
@@ -3674,6 +3674,11 @@
             if (sorting) {
                 this.variablesManager.set('sorting', { sorting: sorting });
             }
+            // Columns
+            var persistedColumns = this.persistenceService.get('col', this.route, storageKey);
+            if (typeof persistedColumns === 'string') {
+                this.selectedColumns = persistedColumns.split(',');
+            }
             // Natural search : ns
             this.naturalSearchSelections = fromUrl(this.persistenceService.get('ns', this.route, storageKey));
             this.translateSearchAndRefreshList(this.naturalSearchSelections, true);
@@ -3731,34 +3736,21 @@
                 this.variablesManager.set('sorting', { sorting: variables.sorting });
             }
         };
-        Object.defineProperty(NaturalAbstractList.prototype, "selectedColumns", {
-            get: function () {
-                return this._selectedColumns;
-            },
-            set: function (columns) {
-                this._selectedColumns = columns;
-                if (!this.persistSearch || this.isPanel) {
-                    return;
-                }
-                // The first selection we receive is the default one made by <natural-columns-picker>
-                if (!this.defaultSelectedColumns) {
-                    this.defaultSelectedColumns = columns;
-                    // Now that we know the defaults, we can try to reload from persistence
-                    var storageKey = this.getStorageKey();
-                    var persistedColumns = this.persistenceService.get('col', this.route, storageKey);
-                    if (typeof persistedColumns === 'string') {
-                        this.selectedColumns = persistedColumns.split(',');
-                    }
-                }
-                else {
-                    // Persist only if wanted columns are different from default selection
-                    var value = lodashEs.isEqual(this.defaultSelectedColumns, columns) ? null : columns.join(',');
-                    this.persistenceService.persist('col', value, this.route, this.getStorageKey());
-                }
-            },
-            enumerable: false,
-            configurable: true
-        });
+        NaturalAbstractList.prototype.selectColumns = function (columns) {
+            this.columnsForTable = columns;
+            if (!this.persistSearch || this.isPanel) {
+                return;
+            }
+            // The first selection we receive is the default one made by <natural-columns-picker>
+            if (!this.defaultSelectedColumns) {
+                this.defaultSelectedColumns = columns;
+            }
+            else {
+                // Persist only if wanted columns are different from default selection
+                var value = lodashEs.isEqual(this.defaultSelectedColumns, columns) ? null : columns.join(',');
+                this.persistenceService.persist('col', value, this.route, this.getStorageKey());
+            }
+        };
         return NaturalAbstractList;
     }(NaturalAbstractPanel));
     NaturalAbstractList.decorators = [
@@ -3770,7 +3762,7 @@
     ]; };
     NaturalAbstractList.propDecorators = {
         persistSearch: [{ type: i0.Input }],
-        initialColumns: [{ type: i0.Input }],
+        selectedColumns: [{ type: i0.Input }],
         forcedVariables: [{ type: i0.Input }]
     };
     var templateObject_1$6, templateObject_2$1, templateObject_3$1, templateObject_4$1;
@@ -4870,20 +4862,38 @@
         function NaturalColumnsPickerComponent(changeDetectorRef) {
             this.changeDetectorRef = changeDetectorRef;
             /**
-             * Emit a list of column keys whenever the selection changes
+             * Emit a list of valid and selected column keys whenever the selection changes
              */
             this.selectionChange = new i0.EventEmitter();
-            this.defaultSelectionChange = new i0.EventEmitter();
+            /**
+             * Available columns are defined by options in the template
+             */
             this.availableColumns = null;
+            /**
+             * Displayed options in the dropdown menu
+             */
             this.displayedColumns = [];
             this.ngUnsubscribe = new rxjs.Subject();
         }
-        Object.defineProperty(NaturalColumnsPickerComponent.prototype, "selection", {
+        Object.defineProperty(NaturalColumnsPickerComponent.prototype, "selections", {
+            /**
+             * Set the columns that are wanted but might be unavailable.
+             *
+             * If a column is unavailable it will be ignored silently. To know what columns were actually applied
+             * you should use `selectionChange`.
+             *
+             * It is often set once on component initialization, but it can also be set again later in the lifespan of the component.
+             */
             set: function (columns) {
                 var _a;
+                this._selections = columns;
+                if (!columns || !this.availableColumns) {
+                    return;
+                }
                 (_a = this.availableColumns) === null || _a === void 0 ? void 0 : _a.forEach(function (col) {
                     col.checked = columns.includes(col.key);
                 });
+                this.updateColumns();
             },
             enumerable: false,
             configurable: true
@@ -4900,8 +4910,10 @@
             var _this = this;
             var _a, _b, _c;
             (_a = this.availableColumns) === null || _a === void 0 ? void 0 : _a.forEach(function (col) {
-                col.checked = _this.initialSelection ? _this.initialSelection.includes(col.key) : col.checked;
+                var _a;
+                col.checked = ((_a = _this._selections) === null || _a === void 0 ? void 0 : _a.length) ? _this._selections.includes(col.key) : col.checked;
             });
+            // Show options only for columns that are not hidden
             this.displayedColumns = (_c = (_b = this.availableColumns) === null || _b === void 0 ? void 0 : _b.filter(function (col) { return !col.hidden; })) !== null && _c !== void 0 ? _c : [];
         };
         NaturalColumnsPickerComponent.prototype.updateColumns = function () {
@@ -4926,10 +4938,8 @@
         { type: i0.ChangeDetectorRef }
     ]; };
     NaturalColumnsPickerComponent.propDecorators = {
-        selection: [{ type: i0.Input }],
+        selections: [{ type: i0.Input }],
         selectionChange: [{ type: i0.Output }],
-        defaultSelectionChange: [{ type: i0.Output }],
-        initialSelection: [{ type: i0.Input }],
         availableColumns: [{ type: i0.ContentChildren, args: [NaturalColumnsPickerColumnDirective,] }]
     };