Fix after rebase

Author: martinboulais

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

@@ -22,6 +22,7 @@ export class TagFilterModel extends FilterModel {
     /**
      * Constructor
      *
+     * @param {ObservableData<RemoteData<Tag[], ApiError>>} tags$ observable remote data of tags list
      * @param {SelectionOption[]} [operators] optionally the list of available operators for the filter
      * @constructor
      */

lib/public/components/Filters/common/filters/ComparisonSelectionModel.js

@@ -11,7 +11,7 @@
  * or submit itself to any jurisdiction.
  */
 
-import { SelectionDropdownModel } from '../../../common/selection/dropdown/SelectionDropdownModel.js';
+import { SelectionModel } from '../../../common/selection/SelectionModel.js';
 
 const numericalComparisonOptions = Object.freeze([
     { value: '<' },
@@ -24,7 +24,7 @@ const numericalComparisonOptions = Object.freeze([
 /**
  * Model storing state of a selection of comparison operator
  */
-export class ComparisonSelectionModel extends SelectionDropdownModel {
+export class ComparisonSelectionModel extends SelectionModel {
     /**
      * Constructor
      */

lib/public/components/Filters/common/filters/NumericalComparisonFilterModel.js

@@ -43,7 +43,6 @@ export class NumericalComparisonFilterModel extends FilterModel {
         this._addSubmodel(this._operandInputModel);
 
         this._operatorSelectionModel = new ComparisonSelectionModel();
-        this._operatorSelectionModel.visualChange$.bubbleTo(this._visualChange$);
         this._operatorSelectionModel.observe(() => this._operandInputModel.raw ? this.notify() : this._visualChange$.notify());
     }
 

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

@@ -14,11 +14,8 @@ import { Observable, RemoteData } from '/js/src/index.js';
 import { SelectionModel } from './SelectionModel.js';
 
 /**
- * @typedef SelectionOption A picker option, with the actual value and its string representation
- * @property {number|string} value The id of the object this is used to see if it is checked.
- * @property {Component} [label] The representation of the option (if null, value is used as label)
- * @property {string} [rawLabel] The string only representation of the option, useful if the label is not a string
- * @property {string} [selector] If the value of the option is not a valid CSS, this is used to define option's id
+ * @typedef {SelectionModelConfiguration} FilterableRemoteSelectionModelConfiguration
+ * @property {RemoteData<SelectionOption[], *>} [availableOptions=[]] the list of available options
  */
 
 /**
@@ -27,7 +24,7 @@ import { SelectionModel } from './SelectionModel.js';
 export class FilterableRemoteSelectionModel extends Observable {
     /**
      * Constructor
-     * @param {SelectionModelConfiguration} [configuration] the model's configuration
+     * @param {FilterableRemoteSelectionModelConfiguration} [configuration] the model's configuration
      */
     constructor(configuration) {
         super();
@@ -47,6 +44,7 @@ export class FilterableRemoteSelectionModel extends Observable {
 
         this._visualChange$ = new Observable();
 
+        this._selectionModel = RemoteData.notAsked();
         this.setAvailableOptions(availableOptions);
     }
 
@@ -65,7 +63,7 @@ export class FilterableRemoteSelectionModel extends Observable {
      * @return {void}
      */
     reset() {
-        this.selectionModel.match({
+        this._selectionModel.match({
             Success: (selectionModel) => selectionModel.reset(),
             Other: () => {
                 // Do nothing
@@ -80,7 +78,7 @@ export class FilterableRemoteSelectionModel extends Observable {
      * @return {boolean} true if the selection is empty
      */
     get isEmpty() {
-        return this.selectionModel.match({
+        return this._selectionModel.match({
             Success: (selectionModel) => selectionModel.isEmpty,
             Other: () => true,
         });
@@ -124,17 +122,17 @@ export class FilterableRemoteSelectionModel extends Observable {
                     multiple: this._multiple,
                     allowEmpty: this._allowEmpty,
                 });
-                this.selectionModel = RemoteData.success(selectionModel);
+                this._selectionModel = RemoteData.success(selectionModel);
                 selectionModel.bubbleTo(this);
             },
             Loading: () => {
-                this.selectionModel = RemoteData.loading();
+                this._selectionModel = RemoteData.loading();
             },
             Failure: (error) => {
-                this.selectionModel = RemoteData.failure(error);
+                this._selectionModel = RemoteData.failure(error);
             },
             NotAsked: () => {
-                this.selectionModel = RemoteData.notAsked();
+                this._selectionModel = RemoteData.notAsked();
             },
         });
 
@@ -144,28 +142,31 @@ export class FilterableRemoteSelectionModel extends Observable {
     /**
      * Return the **values** of the currently selected options
      *
-     * Do not use this getter to modify the selected list but use the `selected` setter to define the new selected list and to notify observers
-     *
      * @return {string[]|number[]} the values of the selected options
      */
     get selected() {
-        return this.selectionModel.match({
+        return this._selectionModel.match({
             Success: (selectionModel) => selectionModel.selected,
             Other: () => [],
         });
     }
 
     /**
-     * If the selection allows one and only one selection, current will return the currently selected option. In any other case it will throw an
-     * error
-     *
-     * @return {string|number} the current selection
+     * Return the list of available options
      */
-    get current() {
-        if (this._allowEmpty || this._multiple) {
-            throw new Error('"current" is available only in non-multiple select that do not allow empty value');
-        }
+    get options() {
+        return this._selectionModel.match({
+            Success: (selectionModel) => selectionModel.options,
+            Other: () => [],
+        });
+    }
 
-        return this.selected[0];
+    /**
+     * Return the underlying selection model
+     *
+     * @return {RemoteData<SelectionModel, ApiError>} the selection model
+     */
+    get selectionModel() {
+        return this._selectionModel;
     }
 }

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

@@ -1,13 +1,22 @@
+import { Observable } from '/js/src/index.js';
+
 /**
  * @typedef SelectionModelConfiguration
  * @property {SelectionOption[]} [availableOptions=[]] the list of available options
  * @property {SelectionOption[]} [defaultSelection=[]] the default selection
  * @property {boolean} [multiple=true] if true, the selection can contain more than one element. Else, any selection will
  *     discard the previous one
- * @property {allowEmpty} [allowEmpty=true] if true, the selection can be empty. Else, deselect will be cancelled if it leads to
+ * @property {boolean} [allowEmpty=true] if true, the selection can be empty. Else, deselect will be cancelled if it leads to
  *     empty selection
  */
-import { Observable } from '/js/src/index.js';
+
+/**
+ * @typedef SelectionOption A picker option, with the actual value and its string representation
+ * @property {number|string} value The id of the object this is used to see if it is checked.
+ * @property {Component} [label] The representation of the option (if null, value is used as label)
+ * @property {string} [rawLabel] The string only representation of the option, useful if the label is not a string
+ * @property {string} [selector] If the value of the option is not a valid CSS, this is used to define option's id
+ */
 
 /**
  * Model to store any custom user selection of pre-defined options