@beinformed/ui 1.65.13 → 1.65.14

package/src/models/sorting/SortOptionModel.js

@@ -1,114 +0,0 @@
-// @flow
-import type { GroupModel } from "../grouping/GroupingModel";
-
-import ListHref from "../href/ListHref";
-
-/**
- */
-class SortOptionModel {
-  _key: string;
-  _label: string;
-  _group: ?GroupModel;
-  _sortorder: "desc" | "asc" = "desc";
-  _selected: boolean = false;
-
-  /**
-   */
-  constructor(key: string, label?: string, group?: ?GroupModel) {
-    this._key = key;
-    this._group = group;
-
-    if (label) {
-      this._label = label;
-    } else if (group) {
-      const attribute = group.getAttributeByKey(key);
-      if (attribute) {
-        this._label = attribute.label;
-      }
-    }
-  }
-
-  /**
-   */
-  reset() {
-    this.selected = false;
-    this.sortorder = "desc";
-  }
-
-  /**
-   */
-  get selected(): boolean {
-    return this._selected;
-  }
-
-  /**
-   */
-  set selected(selected: boolean) {
-    this._selected = selected;
-  }
-
-  /**
-   */
-  get key(): string {
-    return this._key;
-  }
-
-  /**
-   */
-  get value(): string {
-    return `${this.key} ${this.sortorder}`;
-  }
-
-  /**
-   */
-  get oppositeDirection(): "asc" | "desc" {
-    return this.sortorder === "desc" ? "asc" : "desc";
-  }
-
-  /**
-   */
-  get oppositeValue(): string {
-    return `${this.key} ${this.oppositeDirection}`;
-  }
-
-  /**
-   */
-  get label(): string {
-    return this._label;
-  }
-
-  /**
-   */
-  get sortorder(): "desc" | "asc" {
-    return this._sortorder;
-  }
-
-  /**
-   */
-  set sortorder(sortorder: "desc" | "asc") {
-    this._sortorder = sortorder;
-  }
-
-  /**
-   */
-  get group(): ?GroupModel {
-    return this._group;
-  }
-
-  /**
-   */
-  getHref(listHref: ListHref): ListHref {
-    const listhref = new ListHref(listHref);
-    const hasPage = listhref.prefix
-      ? listhref.hasParameter("page", listhref.prefix)
-      : listhref.hasParameter("page");
-    if (hasPage) {
-      listhref.page = 1;
-    }
-    listhref.sort = this.oppositeValue;
-
-    return listhref;
-  }
-}
-
-export default SortOptionModel;

package/src/models/sorting/SortingModel.js

@@ -1,140 +0,0 @@
-// @flow
-import { has } from "../../utils/helpers/objects";
-
-import BaseCollection from "../base/BaseCollection";
-import SortOptionModel from "../sorting/SortOptionModel";
-import ListHref from "../href/ListHref";
-
-import type GroupingModel from "../grouping/GroupingModel";
-import IllegalArgumentException from "../../exceptions/IllegalArgumentException";
-
-/**
- */
-class SortingModel extends BaseCollection<SortOptionModel> {
-  /**
-   */
-  constructor(
-    contributions: Object,
-    labels: { [key: string]: string },
-    grouping: GroupingModel,
-    currentSort: string,
-  ) {
-    super();
-
-    if (has(contributions?.sorting, "attributes")) {
-      this.collection = contributions.sorting.attributes.map((attributeKey) => {
-        const label = labels[attributeKey];
-        const group = grouping && grouping.getGroupByAttributeKey(attributeKey);
-
-        return new SortOptionModel(attributeKey, label, group);
-      });
-
-      this.setSelected(currentSort);
-    }
-  }
-
-  /**
-   */
-  get name(): string {
-    return "sort";
-  }
-
-  /**
-   */
-  get value(): string {
-    return this.filter((option) => option.selected)
-      .map((option) => option.value)
-      .join(",");
-  }
-
-  /**
-   */
-  set value(value: string) {
-    this.reset();
-    this.setSelected(value);
-  }
-
-  /**
-   */
-  get param(): string {
-    return this.value;
-  }
-
-  /**
-   */
-  get options(): Array<SortOptionModel> {
-    return this.collection;
-  }
-
-  /**
-   */
-  reset() {
-    this.collection.forEach((option) => option.reset());
-  }
-  /**
-   */
-  setSelected(value: string = "") {
-    value.split(",").forEach((sortItem) => {
-      const [key, direction] = sortItem.split(" ");
-
-      this.collection.forEach((option) => {
-        if (option.key === key) {
-          option.selected = true;
-          if (direction === "asc") {
-            option.sortorder = "asc";
-          } else if (direction === "desc") {
-            option.sortorder = "desc";
-          }
-        }
-      });
-    });
-  }
-
-  /**
-   * Retrieve a sort option from the model that can be used in the querystring to set it in the opposite direction
-   * For example a sort option in the model with key books and direction descending will be retrieved as 'Books asc'
-   */
-  getUpdateQuerystring(optionKey: string): string {
-    if (!optionKey) {
-      throw new IllegalArgumentException(
-        "Missing option key as input argument",
-      );
-    }
-
-    return this.filter((option) => option.key === optionKey)
-      .map((option) =>
-        option.key === optionKey ? option.oppositeValue : option.value,
-      )
-      .join(",");
-  }
-
-  /**
-   * @see {@link SortingModel#getUpdateQuerystring}
-   */
-  getUpdateQuerystringBySortOption(sortOption: SortOptionModel): string {
-    if (!(sortOption instanceof SortOptionModel)) {
-      throw new IllegalArgumentException(
-        "Missing SortOptionModel as input argument",
-      );
-    }
-
-    return this.getUpdateQuerystring(sortOption.key);
-  }
-
-  /**
-   */
-  createListHref(listHref: ListHref, sortOption: SortOptionModel): ListHref {
-    const listhref = new ListHref(listHref);
-    const hasPage = listhref.prefix
-      ? listhref.hasParameter("page", listhref.prefix)
-      : listhref.hasParameter("page");
-    if (hasPage) {
-      listhref.page = 1;
-    }
-    listhref.sort = this.getUpdateQuerystringBySortOption(sortOption);
-
-    return listhref;
-  }
-}
-
-export default SortingModel;

package/src/models/sorting/__tests__/SortingModel.spec.js

@@ -1,96 +0,0 @@
-import SortingModel from "../SortingModel";
-
-import caseList from "../../list/__mock__/caselist";
-import IllegalArgumentException from "../../../exceptions/IllegalArgumentException";
-import ListHref from "../../href/ListHref";
-
-const ISBN10_DESC = "ISBN10 desc";
-const ISBN10_ASC = "ISBN10 asc";
-
-describe("sortingModel", () => {
-  it("should be able to create an empty sorting instance", () => {
-    const sorting = new SortingModel();
-
-    expect(sorting).toBeInstanceOf(SortingModel);
-
-    expect(sorting.options).toHaveLength(0);
-    expect(sorting.name).toBe("sort");
-    expect(sorting.value).toBe("");
-    expect(sorting.param).toBe("");
-  });
-
-  it("can consume a typical modular UI json sorting structure", () => {
-    const { sorting } = caseList;
-    expect(sorting.options).toHaveLength(4);
-    expect(sorting.name).toBe("sort");
-    expect(sorting.value).toBe("");
-    expect(sorting.param).toBe("");
-  });
-
-  it("can change sorting", () => {
-    const { sorting } = caseList;
-    sorting.setSelected(ISBN10_DESC);
-
-    expect(sorting.value).toBe(ISBN10_DESC);
-    expect(sorting.param).toStrictEqual(ISBN10_DESC);
-
-    const descSelected = sorting.options.find((option) => option.selected);
-    expect(descSelected.key).toBe("ISBN10");
-    expect(descSelected.sortorder).toBe("desc");
-    expect(descSelected.value).toBe(ISBN10_DESC);
-    expect(descSelected.oppositeValue).toBe(ISBN10_ASC);
-
-    sorting.setSelected(ISBN10_ASC);
-
-    expect(sorting.value).toBe(ISBN10_ASC);
-    expect(sorting.param).toBe(ISBN10_ASC);
-
-    const ascSelected = sorting.options.find((option) => option.selected);
-    expect(ascSelected.key).toBe("ISBN10");
-    expect(ascSelected.sortorder).toBe("asc");
-    expect(ascSelected.value).toBe(ISBN10_ASC);
-    expect(ascSelected.oppositeValue).toBe(ISBN10_DESC);
-  });
-
-  it("can retrieve the querystring from option key", () => {
-    const { sorting } = caseList;
-
-    sorting.setSelected(ISBN10_DESC);
-    expect(sorting.value).toBe(ISBN10_DESC);
-
-    const qs = sorting.getUpdateQuerystring("ISBN10");
-    expect(qs).toBe(ISBN10_ASC);
-
-    expect(() => sorting.getUpdateQuerystring()).toThrow(
-      IllegalArgumentException,
-    );
-  });
-
-  it("can retrieve the querystring from sort option", () => {
-    const { sorting } = caseList;
-
-    sorting.setSelected(ISBN10_DESC);
-    expect(sorting.value).toBe(ISBN10_DESC);
-
-    const qs = sorting.getUpdateQuerystringBySortOption(sorting.options[0]);
-    expect(qs).toBe(ISBN10_ASC);
-
-    expect(() => sorting.getUpdateQuerystring()).toThrow(
-      IllegalArgumentException,
-    );
-  });
-
-  it("can retrieve a list href with the given sort option in the opposite direction", () => {
-    const { sorting, selfhref } = caseList;
-
-    expect(() => sorting.createListHref()).toThrow(IllegalArgumentException);
-    expect(() => sorting.createListHref("")).toThrow(IllegalArgumentException);
-
-    const listHref = sorting.createListHref(selfhref, sorting.options[0]);
-    expect(listHref).toBeInstanceOf(ListHref);
-
-    expect(listHref.toString()).toBe(
-      "/books/books?pagesize=10&Language=EN&page=1&sort=ISBN10%20asc",
-    );
-  });
-});

package/src/models/tab/TabModel.js

@@ -1,160 +0,0 @@
-// @flow
-import TaskGroupCollection from "../taskgroup/TaskGroupCollection";
-import ResourceModel from "../base/ResourceModel";
-import TaskGroupModel from "../taskgroup/TaskGroupModel";
-import ActionCollection from "../actions/ActionCollection";
-
-import type { ModularUIModel } from "../types";
-import type { ModularUIResponse } from "../../modularui";
-import type LinkModel from "../links/LinkModel";
-import type LinkCollection from "../links/LinkCollection";
-
-/**
- * Describes a TabModel
- */
-export default class TabModel extends ResourceModel {
-  _actionCollection: ActionCollection;
-  _taskGroupCollection: TaskGroupCollection;
-
-  /**
-   */
-  constructor(modularuiResponse: ModularUIResponse) {
-    super(modularuiResponse);
-
-    this.createTaskGroupCollection();
-
-    this._actionCollection = new ActionCollection(
-      this.data.actions,
-      this.contributions.actions,
-      this.modelOptions,
-    );
-  }
-
-  /**
-   */
-  get type(): string {
-    return "Tab";
-  }
-
-  /**
-   */
-  static get modelName(): string {
-    return "TabModel";
-  }
-
-  /**
-   */
-  static isApplicableModel(data: ModularUIResponse): boolean {
-    return (
-      data.contributions.resourcetype &&
-      (data.contributions.resourcetype.endsWith("Tab") ||
-        data.contributions.resourcetype.endsWith("KnowledgeBank"))
-    );
-  }
-
-  /**
-   */
-  getInitialChildModelLinks(): Array<LinkModel> {
-    return this.links.getLinksByGroup("taskgroup", "actions").all;
-  }
-
-  /**
-   */
-  setChildModels(models: Array<ModularUIModel>) {
-    const taskGroups = [];
-
-    for (let i = 0; i < models.length; i++) {
-      if (models[i] instanceof TaskGroupModel) {
-        taskGroups.push(models[i]);
-      }
-    }
-
-    this.taskGroupCollection.add(taskGroups);
-  }
-
-  /**
-   */
-  get searchLink(): ?LinkModel {
-    return this.links.getLinksByGroup("search").first;
-  }
-
-  /**
-   */
-  createTaskGroupCollection() {
-    this.taskGroupCollection = this.data.taskgroups
-      ? this.data.taskgroups
-          .map((taskgroup) => {
-            const taskgroupContributions = this.contributions.taskgroups.find(
-              (taskgroupContribution) =>
-                taskgroupContribution.name === taskgroup.name,
-            );
-
-            if (taskgroupContributions) {
-              return TaskGroupModel.create(
-                taskgroup.name,
-                taskgroup,
-                taskgroupContributions,
-                this.modelOptions,
-              );
-            }
-
-            return null;
-          })
-          .filter((taskgroup) => taskgroup != null)
-      : [];
-  }
-
-  /**
-   * Getting the taskgrouppanels on the tab
-   */
-  get taskGroupCollection(): TaskGroupCollection {
-    return this._taskGroupCollection;
-  }
-
-  /**
-   * Setting the taskgroup panel collection
-   */
-  set taskGroupCollection(taskgroups: Array<TaskGroupModel>) {
-    this._taskGroupCollection = new TaskGroupCollection(taskgroups);
-  }
-
-  /**
-   * Getting the label of the tab
-   */
-  get label(): string {
-    return this.getContribution("label", "");
-  }
-
-  /**
-   * Getting the component links on the tab
-   */
-  get components(): LinkCollection {
-    return this.links.getLinksByGroup("component", "search");
-  }
-
-  /**
-   */
-  get actionCollection(): ActionCollection {
-    return this._actionCollection;
-  }
-
-  /**
-   * Has component links
-   */
-  hasComponents(): boolean {
-    return this.components.size > 0;
-  }
-
-  /**
-   * Has taskgroups
-   */
-  hasTaskGroups(): boolean {
-    return this.taskGroupCollection && this.taskGroupCollection?.hasItems;
-  }
-
-  /**
-   */
-  hasActions(): boolean {
-    return this.actionCollection && this.actionCollection.hasItems;
-  }
-}

package/src/models/tab/__mock__/contributions.json

@@ -1,77 +0,0 @@
-{
-  "tab": {
-    "label": "Books",
-    "resourcetype": "Tab",
-    "_links": {
-      "component": [
-        {
-          "name": "Books",
-          "label": "Books",
-          "layouthint": ["CardView", "ListView", "TableView"],
-          "resourcetype": "CaseList"
-        },
-        {
-          "name": "BooksByPersonRole",
-          "label": "Books by person role",
-          "resourcetype": "CaseList"
-        },
-        {
-          "name": "BookPrints",
-          "label": "Book prints",
-          "resourcetype": "DatastoreList"
-        },
-        {
-          "name": "LatestBooks",
-          "label": "Latest books",
-          "resourcetype": "DatastoreList"
-        }
-      ],
-      "taskgroup": [
-        {
-          "name": "GeneralTasks",
-          "label": "General tasks",
-          "resourcetype": "TaskGroup"
-        },
-        {
-          "name": "BookTasks",
-          "label": "Book tasks",
-          "resourcetype": "TaskGroup"
-        }
-      ],
-      "search": [
-        {
-          "name": "Search",
-          "label": "Search",
-          "resourcetype": ""
-        }
-      ]
-    },
-    "taskgroups": [
-      {
-        "name": "GeneralTasks",
-        "actions": [
-          {
-            "name": "CreatePersonRef",
-            "label": "Create person",
-            "type": "form"
-          },
-          {
-            "name": "UpdatePasswordOfCurrentUser_ref",
-            "label": "Update password of current user",
-            "type": "form"
-          }
-        ]
-      },
-      {
-        "name": "BookTasks",
-        "actions": [
-          {
-            "name": "AddauthorRef",
-            "label": "Add author",
-            "type": "form"
-          }
-        ]
-      }
-    ]
-  }
-}

package/src/models/tab/__mock__/data.json

@@ -1,20 +0,0 @@
-{
-  "tab": {
-    "_links": {
-      "self": { "href": "/books" },
-      "api_doc": { "href": "/api-docs/books" },
-      "contributions": { "href": "/contributions/books" },
-      "component": [
-        { "href": "/books/books", "name": "Books" },
-        { "href": "/books/booksbypersonrole", "name": "BooksByPersonRole" },
-        { "href": "/books/BookPrints", "name": "BookPrints" },
-        { "href": "/books/LatestBooks", "name": "LatestBooks" }
-      ],
-      "taskgroup": [
-        { "href": "/books/GeneralTasks", "name": "GeneralTasks" },
-        { "href": "/books/BookTasks", "name": "BookTasks" }
-      ],
-      "search": [{ "href": "/books/search", "name": "Search" }]
-    }
-  }
-}

package/src/models/tab/__mock__/personContributions.json

@@ -1,35 +0,0 @@
-{
-  "tab": {
-    "label": "Persons",
-    "resourcetype": "Tab",
-    "_links": {
-      "component": [
-        {
-          "name": "Persons",
-          "label": "Persons",
-          "layouthint": ["icon:account"],
-          "resourcetype": "CaseList"
-        },
-        {
-          "name": "AuthorsAndCo_authors",
-          "label": "Authors and co-authors",
-          "layouthint": ["icon:account-edit"],
-          "resourcetype": "CaseList"
-        },
-        {
-          "name": "InformationAboutAuthors",
-          "label": "Information about authors",
-          "layouthint": ["icon:information"],
-          "resourcetype": "DatastoreList"
-        }
-      ],
-      "search": [
-        {
-          "name": "SearchPersons",
-          "label": "Search persons",
-          "resourcetype": ""
-        }
-      ]
-    }
-  }
-}

package/src/models/tab/__mock__/personData.json

@@ -1,21 +0,0 @@
-{
-  "tab": {
-    "_links": {
-      "self": { "href": "/persons" },
-      "api_doc": { "href": "/api-docs/v3/persons" },
-      "contributions": { "href": "/contributions/persons" },
-      "component": [
-        { "href": "/persons/persons", "name": "Persons" },
-        {
-          "href": "/persons/authors-and-co-authors",
-          "name": "AuthorsAndCo_authors"
-        },
-        {
-          "href": "/persons/information-about-authors",
-          "name": "InformationAboutAuthors"
-        }
-      ],
-      "search": [{ "href": "/persons/search", "name": "SearchPersons" }]
-    }
-  }
-}

package/src/models/tab/__mock__/tab.js

@@ -1,14 +0,0 @@
-// @flow
-import TabModel from "../TabModel";
-import ModularUIResponse from "../../../modularui/ModularUIResponse";
-
-import data from "./data.json";
-import contributions from "./contributions.json";
-
-const response = ModularUIResponse.create({
-  key: "tab",
-  data,
-  contributions,
-});
-
-export default (new TabModel(response): TabModel);

package/src/models/tab/__mock__/tabPerson.js

@@ -1,14 +0,0 @@
-// @flow
-import TabModel from "../TabModel";
-import ModularUIResponse from "../../../modularui/ModularUIResponse";
-
-import data from "./personData.json";
-import contributions from "./personContributions.json";
-
-const response = ModularUIResponse.create({
-  key: "person",
-  data,
-  contributions,
-});
-
-export default (new TabModel(response): TabModel);