@beinformed/ui 1.65.5 → 1.65.7

package/src/hooks/useList.js

@@ -1,19 +1,38 @@
 // @flow
-import { useModularUIBasic } from "./useModularUIBasic";
+import { useHistory } from "react-router";
 import { useDispatch } from "react-redux";
+
+import { useModularUIBasic } from "./useModularUIBasic";
 import { HTTP_METHODS } from "../constants/Constants";
+
 import { loadModularUI } from "../redux";
+
 import DetailModel from "../models/detail/DetailModel";
 import ListModel from "../models/list/ListModel";
 import CaseSearchModel from "../models/search/CaseSearchModel";
 import ListDetailModel from "../models/list/ListDetailModel";
 import Href from "../models/href/Href";
+import FilterCollection from "../models/filters/FilterCollection";
+import AssignmentFilterModel from "../models/filters/AssignmentFilterModel";
+import FilterModel from "../models/filters/FilterModel";
 
 import type { HookOptions } from "./useModularUIBasic";
-import { useHistory } from "react-router";
+import type { AttributeType, IFilter } from "../models/types";
 
 type ListNavigationHook = {
   update: (list: ListModel, resetPage?: boolean) => void,
+  updateFilters: (list: ListModel, filters: FilterCollection) => void,
+  updateFilter: (
+    list: ListModel,
+    filter: IFilter,
+    value: string,
+    attribute?: AttributeType,
+  ) => void,
+  updateSort: (list: ListModel, sortOption: string) => void,
+  updatePage: (list: ListModel, page: number) => void,
+  updatePageSize: (list: ListModel, pagesize: number) => void,
+  resetFilters: (list: ListModel) => void,
+  removeFilter: (list: ListModel, filter: IFilter) => void,
 };
 
 /**
@@ -85,7 +104,60 @@ export const useListNavigation = (): ListNavigationHook => {
     }
   };
 
+  const updateFilters = (list: ListModel, filters: FilterCollection) => {
+    list.filterCollection = filters;
+    update(list, true);
+  };
+
+  const updateFilter = (
+    list: ListModel,
+    filter: IFilter,
+    value: string,
+    attribute?: AttributeType,
+  ) => {
+    if (attribute) {
+      filter.update(attribute, value);
+    } else if (filter instanceof AssignmentFilterModel) {
+      throw new Error("Need the attribute to update for AssigmentFilterModel");
+    } else if (filter instanceof FilterModel) {
+      filter.update(filter.attribute, value);
+    }
+    update(list, true);
+  };
+
+  const resetFilters = (list: ListModel) => {
+    list.filterCollection.reset();
+    update(list, true);
+  };
+
+  const removeFilter = (list: ListModel, filter: IFilter) => {
+    list.filterCollection.getFilterByName(filter.name)?.reset();
+    update(list, true);
+  };
+
+  const updateSort = (list: ListModel, sortOption: string) => {
+    list.sorting.value = sortOption;
+    update(list, true);
+  };
+
+  const updatePage = (list: ListModel, page: number) => {
+    list.paging.page = page;
+    update(list);
+  };
+
+  const updatePageSize = (list: ListModel, pagesize: number) => {
+    list.paging.pagesize.value = pagesize;
+    update(list);
+  };
+
   return {
     update,
+    updateFilters,
+    updateFilter,
+    updateSort,
+    updatePage,
+    updatePageSize,
+    resetFilters,
+    removeFilter,
   };
 };

package/src/hooks/usePanel.js

@@ -5,9 +5,10 @@ import Href from "../models/href/Href";
 import { useModularUIBasic } from "./useModularUIBasic";
 
 import type { HookOptions } from "./useModularUIBasic";
-import type GroupingPanelModel from "../models/panels/GroupingPanelModel";
-import type ListModel from "../models/list/ListModel";
-import type DetailModel from "../models/detail/DetailModel";
+import GroupingPanelModel from "../models/panels/GroupingPanelModel";
+import ListModel from "../models/list/ListModel";
+import DetailModel from "../models/detail/DetailModel";
+import CaseSearchModel from "../models/search/CaseSearchModel";
 
 const useUrl = (href?: string | Href, fromRoute: boolean = false) => {
   const [previousUrl, setPreviousUrl] = useState(null);
@@ -69,7 +70,8 @@ export const usePanel = (
 
   const url = useUrl(href, fromRoute || false);
   const basicOptions = {
-    expectedModels: ["List", "GroupingPanel", "Detail"],
+    expectedModels: ["List", "GroupingPanel", "Detail", "CaseSearch"],
+    targetModel: [ListModel, GroupingPanelModel, DetailModel, CaseSearchModel],
     ...(hookOptions: HookOptions),
   };
 

package/src/models/concepts/ConceptIndexModel.js

@@ -2,12 +2,14 @@
 import ResourceModel from "../base/ResourceModel";
 import ResourceCollection from "../base/ResourceCollection";
 import FilterCollection from "../filters/FilterCollection";
+import ConceptIndexFilterModel from "../filters/ConceptIndexFilterModel";
+import FilterModel from "../filters/FilterModel";
 import ConceptLinkModel from "./ConceptLinkModel";
 
 import { TIMEVERSION_FILTER_NAME } from "../../constants/Constants";
 
 import type { ModularUIResponse } from "../../modularui";
-import type { FilterType, ModularUIModel } from "../types";
+import type { ModularUIModel } from "../types";
 import type LinkModel from "../links/LinkModel";
 import type Href from "../href/Href";
 import type ErrorResponse from "../error/ErrorResponse";
@@ -122,8 +124,12 @@ export default class ConceptIndexModel extends ResourceModel {
   /**
    * Get index filter
    */
-  get indexfilter(): FilterType | null {
-    return this.filterCollection.getFilterByAttributeKey("index");
+  get indexfilter(): ConceptIndexFilterModel | null {
+    const indexFilter = this.filterCollection.getFilterByAttributeKey("index");
+    if (indexFilter instanceof ConceptIndexFilterModel) {
+      return indexFilter;
+    }
+    return null;
   }
 
   /**
@@ -144,15 +150,24 @@ export default class ConceptIndexModel extends ResourceModel {
   /**
    * get searchterm filter
    */
-  get searchtermfilter(): FilterType | null {
-    return this.filterCollection.getFilterByAttributeKey("label");
+  get searchtermfilter(): FilterModel | null {
+    const termFilter = this.filterCollection.getFilterByAttributeKey("label");
+    if (termFilter instanceof FilterModel) {
+      return termFilter;
+    }
+    return null;
   }
 
   /**
    * Get model category filter
    */
-  get modelCategoryFilter(): FilterType | null {
-    return this.filterCollection.getFilterByAttributeKey("modelCategory");
+  get modelCategoryFilter(): FilterModel | null {
+    const categoryFilter =
+      this.filterCollection.getFilterByAttributeKey("modelCategory");
+    if (categoryFilter instanceof FilterModel) {
+      return categoryFilter;
+    }
+    return null;
   }
 
   /**

package/src/models/filters/AssignmentFilterModel.js

@@ -1,13 +1,17 @@
 // @flow
 import BaseFilterModel from "../filters/BaseFilterModel";
 
-import type { AttributeType, ModelOptions } from "../types";
+import type { IFilter, AttributeType, ModelOptions } from "../types";
 import { IllegalStateException } from "../../exceptions";
 import createAttribute from "../attributes/_createAttribute";
+
 /**
  * Assignment filter consists of two filters: assignment type and user filter
  */
-export default class AssignmentFilterModel extends BaseFilterModel {
+export default class AssignmentFilterModel
+  extends BaseFilterModel
+  implements IFilter
+{
   _listKey: string;
   _assignmenttype: AttributeType;
   _user: AttributeType;
@@ -26,18 +30,6 @@ export default class AssignmentFilterModel extends BaseFilterModel {
     this._user = this.createUserModel();
   }
 
-  /**
-   */
-  get key(): ?string {
-    return this.data.name;
-  }
-
-  /**
-   */
-  get contextid(): string {
-    return this.getContribution("contextid", "");
-  }
-
   /**
    * Creates an assignmenttype model when assignmenttype json is present
    */

package/src/models/filters/BaseFilterModel.js

@@ -29,6 +29,12 @@ export default class BaseFilterModel extends BaseModel {
     }
   }
 
+  /**
+   */
+  get key(): string {
+    return this.data.name;
+  }
+
   /**
    * Get the type of a filter.
    */
@@ -72,6 +78,12 @@ export default class BaseFilterModel extends BaseModel {
     this._context = context;
   }
 
+  /**
+   */
+  get contextid(): string {
+    return this.getContribution("contextid", "");
+  }
+
   /**
    * Getting the context label
    */

package/src/models/filters/ConceptIndexFilterModel.js

@@ -2,12 +2,15 @@
 import FilterModel from "../filters/FilterModel";
 import ChoiceAttributeModel from "../attributes/ChoiceAttributeModel";
 
-import type { ModelOptions } from "../types";
+import type { IFilter, ModelOptions } from "../types";
 
 /**
  * The concept index model is a special filter used to index all first concept label letters in de modelcatalog.
  */
-export default class ConceptIndexFilterModel extends FilterModel {
+export default class ConceptIndexFilterModel
+  extends FilterModel
+  implements IFilter
+{
   /**
    * Construct a filter
    */

package/src/models/filters/FilterCollection.js

@@ -8,13 +8,13 @@ import ConceptIndexFilterModel from "../filters/ConceptIndexFilterModel";
 import CompositeAttributeModel from "../attributes/CompositeAttributeModel";
 import FilterModel from "../filters/FilterModel";
 
-import type { AttributeType, FilterType, ModelOptions } from "../types";
+import type { AttributeType, IFilter, ModelOptions } from "../types";
 import { PARAMETER_TYPES } from "../../constants";
 
 /**
  * Contains a collection of filters
  */
-export default class FilterCollection extends BaseCollection<FilterType> {
+export default class FilterCollection extends BaseCollection<IFilter> {
   /**
    * Construct a collection of filters
    */
@@ -68,7 +68,7 @@ export default class FilterCollection extends BaseCollection<FilterType> {
     data: Object,
     contributions: Object,
     modelOptions?: ModelOptions,
-  ): FilterType {
+  ): IFilter {
     const type = contributions.type || "stringfilter";
     if (type === "choicefilter" && filterKey === "index") {
       return new ConceptIndexFilterModel(data, contributions, modelOptions);
@@ -92,7 +92,7 @@ export default class FilterCollection extends BaseCollection<FilterType> {
   /**
    * Call the reset function on all filters
    *
-   * @see {FilterType#reset()}
+   * @see {IFilter#reset()}
    */
   reset(): FilterCollection {
     this.collection = this.collection.map((filter) => filter.reset());
@@ -134,10 +134,16 @@ export default class FilterCollection extends BaseCollection<FilterType> {
     );
   }
 
+  /**
+   */
+  getFilterByName(name: string): IFilter | null {
+    return this.find((filter) => filter.name === name) || null;
+  }
+
   /**
    * Getting the filter by name
    */
-  getFilterByAttributeKey(key: string): FilterType | null {
+  getFilterByAttributeKey(key: string): IFilter | null {
     return (
       this.find((filter) => {
         if (filter instanceof RangeFilterModel) {
@@ -148,7 +154,11 @@ export default class FilterCollection extends BaseCollection<FilterType> {
           return this.checkAssignmentFilterByAttributeKey(filter, key);
         }
 
-        return filter.attribute?.key === key;
+        if (filter instanceof FilterModel) {
+          return filter.attribute.key === key;
+        }
+
+        return false;
       }) || null
     );
   }
@@ -191,6 +201,13 @@ export default class FilterCollection extends BaseCollection<FilterType> {
     return this.collection.some((filter) => filter.isActive());
   }
 
+  /**
+   * Retrieve all filters with a value
+   */
+  getActiveFilters(): Array<IFilter> {
+    return this.collection.filter((filter) => filter.isActive());
+  }
+
   /**
    */
   get formdata(): { [string]: any } | null {

package/src/models/filters/FilterModel.js

@@ -3,11 +3,11 @@ import BaseFilterModel from "../filters/BaseFilterModel";
 import createAttribute from "../attributes/_createAttribute";
 import { IllegalStateException } from "../../exceptions";
 
-import type { AttributeType, FilterType, ModelOptions } from "../types";
+import type { AttributeType, IFilter, ModelOptions } from "../types";
 
 /**
  */
-export default class FilterModel extends BaseFilterModel {
+export default class FilterModel extends BaseFilterModel implements IFilter {
   _attribute: AttributeType | null = null;
 
   /**
@@ -103,7 +103,7 @@ export default class FilterModel extends BaseFilterModel {
   /**
    * Reset the value of this filter to undefined
    */
-  reset(): FilterType {
+  reset(): FilterModel {
     if (this.attribute) {
       this.attribute.reset();
     }

package/src/models/filters/RangeFilterModel.js

@@ -2,12 +2,12 @@
 import FilterModel from "../filters/FilterModel";
 
 import CompositeAttributeModel from "../attributes/CompositeAttributeModel";
-import type { AttributeType } from "../types";
+import type { AttributeType, IFilter } from "../types";
 
 /**
  * Range filter, for instance a date range filter or a number range filter
  */
-export default class RangeFilterModel extends FilterModel {
+export default class RangeFilterModel extends FilterModel implements IFilter {
   /**
    */
   update(attribute: AttributeType, value: string) {

package/src/models/filters/StringFilterModel.js

@@ -1,12 +1,12 @@
 // @flow
 
-import type { AttributeType, FilterType, ModelOptions } from "../types";
+import type { AttributeType, IFilter, ModelOptions } from "../types";
 import FilterModel from "./FilterModel";
 
 /**
  * StringFilterModel can handle string filters with multiple setting
  */
-export default class StringFilterModel extends FilterModel {
+export default class StringFilterModel extends FilterModel implements IFilter {
   _isValid: boolean = true;
   _value: string | null;
   _inputvalue: string;
@@ -58,7 +58,7 @@ export default class StringFilterModel extends FilterModel {
   /**
    * Reset the value of this filter to undefined
    */
-  reset(): FilterType {
+  reset(): StringFilterModel {
     this._inputvalue = "";
     this._value = null;
 

package/src/models/list/ListModel.js

@@ -20,7 +20,7 @@ import {
   SHOW_ONE_RESULT_AS_DETAIL,
 } from "../../constants/LayoutHints";
 
-import type { ModularUIModel, FilterType } from "../types";
+import type { ModularUIModel, IFilter } from "../types";
 import type LinkModel from "../links/LinkModel";
 
 /**
@@ -288,7 +288,7 @@ export default class ListModel extends ResourceModel {
   /**
    * Set filterCollection
    */
-  set filterCollection(filterCollection: FilterCollection | Array<FilterType>) {
+  set filterCollection(filterCollection: FilterCollection | Array<IFilter>) {
     if (Array.isArray(filterCollection)) {
       this._filterCollection.collection = filterCollection;
     } else {

package/src/models/search/CaseSearchModel.js

@@ -2,7 +2,7 @@
 import ListModel from "../list/ListModel";
 
 import type { ModularUIResponse } from "../../modularui";
-import type { FilterType } from "../types";
+import type { IFilter } from "../types";
 
 /**
  * Case search model
@@ -32,7 +32,7 @@ export default class CaseSearchModel extends ListModel {
   /**
    * Retrieve quick search filters
    */
-  getQuickSearchFilters(): Array<FilterType> {
+  getQuickSearchFilters(): Array<IFilter> {
     return this.filterCollection
       ? this.filterCollection.filter((filter) => filter.isQuickSearch())
       : [];

package/src/models/types.js

@@ -25,10 +25,6 @@ import type SectionModel from "./content/SectionModel";
 import type ContentTOCModel from "./content/ContentTOCModel";
 import type ContentTypeModel from "./content/ContentTypeModel";
 import type DetailModel from "./detail/DetailModel";
-import type AssignmentFilterModel from "./filters/AssignmentFilterModel";
-import type FilterModel from "./filters/FilterModel";
-import type RangeFilterModel from "./filters/RangeFilterModel";
-import type ConceptIndexFilterModel from "./filters/ConceptIndexFilterModel";
 import type FormModel from "./form/FormModel";
 import type ListDetailModel from "./list/ListDetailModel";
 import type ListModel from "./list/ListModel";
@@ -45,6 +41,7 @@ import type AttributeCollection from "./attributes/AttributeCollection";
 import type AttributeModel from "./attributes/AttributeModel";
 import type LayoutHintCollection from "./layouthint/LayoutHintCollection";
 import type ErrorResponse from "./error/ErrorResponse";
+import { PARAMETER_TYPES } from "../constants";
 
 export type ModularUIModel =
   | ApplicationModel
@@ -90,12 +87,6 @@ export type RangeChildAttributeType =
   | NumberAttributeModel
   | DatetimeAttributeModel;
 
-export type FilterType =
-  | AssignmentFilterModel
-  | FilterModel
-  | RangeFilterModel
-  | ConceptIndexFilterModel;
-
 export type FormErrorAnchor = {
   id: string,
   properties?: {
@@ -135,6 +126,33 @@ export type textfragmentJSON = {
   type: string,
 };
 
+export interface IFilter {
+  +type: string;
+  +parameterType: $Values<typeof PARAMETER_TYPES>;
+  +isMultiple: boolean;
+  context: Object;
+  +contextid: string;
+  +contextLabel: string;
+  listkey: string;
+  +label: string;
+  +key: string;
+  +name: string;
+  +param: string;
+  +params: Array<{ name: string, value: ?string }>;
+  isQuickSearch(): boolean;
+  +assistantMessage: string | null;
+  +value: string | { [string]: string } | null;
+  +inputvalue: string | { [string]: string };
+  hasValue(): boolean;
+  reset(): IFilter;
+  update(attribute: AttributeType, value: string): void;
+  isActive(): boolean;
+  +isValid: boolean;
+  +readonlyvalue: string | { [string]: string };
+  +formdata: { [string]: any } | null;
+  clone(): IFilter;
+}
+
 export interface IConstraintModel {
   +id: string;
   +defaultMessage: string;

package/src/react-server/serverUtil.js

@@ -22,9 +22,9 @@ import {
 
 import { getEnabledLocales } from "../constants/Settings";
 
-import { IllegalArgumentException } from "../exceptions";
+import IllegalArgumentException from "../exceptions/IllegalArgumentException";
 
-import { initModels } from "../redux";
+import { initModels } from "../redux/_modularui/ModularUIActions";
 import { getLocale } from "../redux/selectors/i18n";
 
 import ModularUIRequest from "../modularui/ModularUIRequest";