feat: add normalize setter to SelectionModel and FilteringModel

Author: NarrowsProjects

lib/public/components/Filters/common/FilterModel.js

@@ -57,6 +57,17 @@ export class FilterModel extends Observable {
         throw new Error('Abstract function call');
     }
 
+    /**
+     * Sets filters from normalised values to submodels in needed.
+     *
+     * @param {string|number|object|string[]|number[]|null} _value The value used to set filters
+     * @return {void} the normalized value
+     * @abstract
+     */
+    set normalized(_value) {
+        throw new Error('Abstract function call');
+    }
+
     /**
      * Returns the observable notified any time there is a visual change which has no impact on the actual filter value
      *

lib/public/components/common/selection/SelectionModel.js

@@ -42,6 +42,12 @@ export class SelectionModel extends Observable {
         super();
         const { availableOptions = [], defaultSelection = [], multiple = true, allowEmpty = true } = configuration || {};
 
+        /**
+         * @type {SelectionOption[]}
+         * @protected
+         */
+        this._selectionBacklog = [];
+
         /**
          * @type {RemoteData<SelectionOption[]>|SelectionOption[]}
          * @protected
@@ -243,14 +249,20 @@ export class SelectionModel extends Observable {
     }
 
     /**
-     * Defines the list of available options
+     * Defines the list of available options and if there is a selection backlog, these will be applied
      *
      * @param {RemoteData<SelectionOption[], *>|SelectionOption[]} availableOptions the new available options
      * @return {void}
      */
     setAvailableOptions(availableOptions) {
         this._availableOptions = availableOptions;
         this.visualChange$.notify();
+
+        if (this._selectionBacklog.length) {
+            this.selectedOptions = this._selectionBacklog;
+            this._selectionBacklog = [];
+            this.notify();
+        }
     }
 
     /**
@@ -315,12 +327,19 @@ export class SelectionModel extends Observable {
     }
 
     /**
-     * Define (overrides) the list of currently selected options
+     * Define (overrides) the list of currently selected options.
+     * Invalid selection options are excluded
      *
      * @param {SelectionOption[]} selected the list of selected options
      */
     set selectedOptions(selected) {
-        this._selectedOptions = selected;
+        let { options } = this;
+
+        if (this.options instanceof RemoteData) {
+            options = options.isSuccess() ? options.payload : [];
+        }
+
+        this._selectedOptions = options.filter((option) => selected.some(({ value }) => String(value) === String(option.value)));;
     }
 
     /**
@@ -332,6 +351,23 @@ export class SelectionModel extends Observable {
         return this._defaultSelection;
     }
 
+    /**
+     * Sets selected options based on a comma-seperated string.
+     * Accounts for the options being either RemoteData or an array.
+     *
+     * @return {string}
+     */
+    set normalized(value) {
+        const options = value.split(',').map((option) => ({ value: option }));
+        const postponeSelection = this.options instanceof RemoteData || ! this.options?.length;
+
+        if (postponeSelection) {
+            this._selectionBacklog = options;
+        } else {
+            this.selectedOptions = options;
+        }
+    }
+
     /**
      * Returns the normalized value of the selection
      *