@beinformed/ui 1.12.1 → 1.13.2

package/src/models/form/FormModel.js

@@ -598,6 +598,12 @@ class FormModel extends ResourceModel {
     return this._redirectLocation || this.successRedirect;
   }
 
+  /**
+   */
+  getSuccessData(): Object {
+    return this.data.success?.data;
+  }
+
   /**
    * Href handling
    */
@@ -664,15 +670,26 @@ class FormModel extends ResourceModel {
    * Handle form tokens to indicate concurrent form use
    */
   get tokens(): Array<string> {
-    return this._tokens ?? this.data.tokens ?? [];
+    if (!this._tokens) {
+      this._tokens = this.data.tokens ?? [];
+    }
+    return this._tokens;
   }
 
   /**
+   * Replaces all tokens with the given collection of tokens
    */
   set tokens(tokens: Array<string>) {
     this._tokens = tokens;
   }
 
+  /**
+   * Removes all tokens from the form
+   */
+  removeTokens() {
+    this._tokens = [];
+  }
+
   /**
    * Keep track of changed form
    */

package/src/models/form/__tests__/FormModel.getters.spec.js

@@ -73,6 +73,21 @@ describe("formModel getters", () => {
 
     form.tokens = ["Token"];
     expect(form.tokens).toHaveLength(1);
+
+    const formJSON = {
+      formresponse: {
+        tokens: ["form-token"],
+      },
+    };
+
+    const formData = ModularUIResponse.create({
+      data: formJSON,
+      contributions: FormContributionsJSON,
+    });
+    const formWithToken = new FormModel(formData);
+    expect(formWithToken.tokens).toStrictEqual(["form-token"]);
+    formWithToken.removeTokens();
+    expect(formWithToken.tokens).toHaveLength(0);
   });
 
   it("can handle last modification", () => {

package/src/models/list/ListItemCollection.js

@@ -1,13 +1,50 @@
 // @flow
 import BaseCollection from "../base/BaseCollection";
 import ActionCollection from "../actions/ActionCollection";
+import ListItemModel from "../list/ListItemModel";
 
-import type ListItemModel from "../list/ListItemModel";
+import ConfigurationException from "../../exceptions/ConfigurationException";
+
+import type ListModel from "../list/ListModel";
 
 /**
  * Collection of list items
  */
 class ListItemCollection extends BaseCollection<ListItemModel> {
+  /**
+   * Create a list item collection from the given list
+   */
+  static createFromList(list: ListModel): ListItemCollection {
+    const _embedded = list.getData("_embedded");
+    if (_embedded != null) {
+      if (Array.isArray(_embedded)) {
+        throw new ConfigurationException(
+          `One record panel with multiple tables is not supported, place all types in one panel for the panel with key ${list.key}`
+        );
+      }
+
+      const dynamicschema = list.getData("dynamicschema");
+
+      const collection = _embedded.results.map((resultItem) => {
+        const [key] = Object.keys(resultItem);
+        const listitemData = resultItem[key];
+        listitemData.dynamicschema = dynamicschema;
+
+        const listitemContributions = list.contributions.results[key];
+
+        return ListItemModel.createFromListResult(
+          key,
+          listitemData,
+          listitemContributions
+        );
+      });
+
+      return new ListItemCollection(collection);
+    }
+
+    return new ListItemCollection();
+  }
+
   /**
    */
   get additionalDetailRoutePath(): string {

package/src/models/list/ListItemModel.js

@@ -14,6 +14,21 @@ import type LinkCollection from "../links/LinkCollection";
  * List Item
  */
 export default class ListItemModel extends DetailModel {
+  /**
+   */
+  static createFromListResult(
+    key: string,
+    data: Object,
+    contributions: Object
+  ): ListItemModel {
+    const listitemInput = new ModularUIResponse();
+    listitemInput.key = key;
+    listitemInput.data = data;
+    listitemInput.contributions = contributions;
+
+    return new ListItemModel(listitemInput);
+  }
+
   /**
    */
   static createFromChoiceAttributeOption(

package/src/models/list/ListModel.js

@@ -1,6 +1,4 @@
 // @flow
-import { ConfigurationException } from "../../exceptions";
-
 import ModularUIResponse from "../../modularui/ModularUIResponse";
 
 import ListItemCollection from "../list/ListItemCollection";
@@ -113,54 +111,12 @@ export default class ListModel extends ResourceModel {
     return "";
   }
 
-  /**
-   * Create a listitem collection from the data and contributions of a list
-   */
-  createListItemCollection(): ListItemCollection {
-    const listitemCollection = new ListItemCollection();
-
-    const _embedded = this.getData("_embedded");
-    if (_embedded !== null) {
-      if (Array.isArray(_embedded)) {
-        throw new ConfigurationException(
-          `One record panel with multiple tables is not supported, place all types in one panel for the panel with key ${this.key}`
-        );
-      }
-
-      listitemCollection.collection = _embedded.results.map((result) =>
-        this.createListItem(result)
-      );
-    }
-
-    return listitemCollection;
-  }
-
-  /**
-   * Create a ListItem
-   */
-  createListItem(resultItem: Object): ListItemModel {
-    const [key] = Object.keys(resultItem);
-    const listitemData = resultItem[key];
-    const listitemContributions = this.contributions.results[key];
-
-    if (this.data.dynamicschema) {
-      listitemData.dynamicschema = this.data.dynamicschema;
-    }
-
-    const listitemModelInput = new ModularUIResponse();
-    listitemModelInput.key = key;
-    listitemModelInput.data = listitemData;
-    listitemModelInput.contributions = listitemContributions;
-
-    return new ListItemModel(listitemModelInput);
-  }
-
   /**
    * Getting the results
    */
   get listItemCollection(): ListItemCollection {
     if (!this._listItemCollection) {
-      this._listItemCollection = this.createListItemCollection();
+      this._listItemCollection = ListItemCollection.createFromList(this);
     }
 
     return this._listItemCollection;

package/src/models/list/__tests__/ListItemCollection.spec.js

@@ -0,0 +1,22 @@
+import ListItemCollection from "../ListItemCollection";
+
+import caselist from "../__mock__/caselist";
+
+describe("listItemCollection spec", () => {
+  it("should be able to create an empty collection", () => {
+    const collection = new ListItemCollection();
+
+    expect(collection).toBeInstanceOf(ListItemCollection);
+    expect(collection.additionalDetailRoutePath).toBe("__NON_EXISTING_ROUTE__");
+  });
+
+  it("can create a ListItemCollection from list items", () => {
+    const collection = ListItemCollection.createFromList(caselist);
+    expect(collection).toBeInstanceOf(ListItemCollection);
+
+    expect(collection.additionalDetailRoutePath).toBe(
+      "(/books/books/34/contributors|/books/books/34/publishedbypublishinghouse|/books/books/35/contributors|/books/books/35/publishedbypublishinghouse|/books/books/36/contributors|/books/books/36/publishedbypublishinghouse|/books/books/37/contributors|/books/books/37/publishedbypublishinghouse|/books/books/38/contributors|/books/books/38/publishedbypublishinghouse|/books/books/39/contributors|/books/books/39/publishedbypublishinghouse|/books/books/42/contributors|/books/books/42/publishedbypublishinghouse|/books/books/45/contributors|/books/books/45/publishedbypublishinghouse|/books/books/46/contributors|/books/books/46/publishedbypublishinghouse|/books/books/47/contributors|/books/books/47/publishedbypublishinghouse)"
+    );
+    expect(collection.actionCollection).toHaveLength(42);
+  });
+});

package/src/models/list/__tests__/ListModel.spec.js

@@ -24,8 +24,6 @@ describe("listModel spec", () => {
     expect(list.headers).toHaveLength(0);
 
     expect(list.introtext).toBe("");
-
-    expect(typeof list.createListItem).toBe("function");
   });
 
   it("should be able to create a list from a typical modular ui response", () => {

package/src/models/panels/__tests__/GroupingPanelModel.spec.js

@@ -2,13 +2,14 @@ import GroupingPanelModel from "../GroupingPanelModel";
 
 import panelJson from "./groupingPanel.json";
 import panelContributionsJson from "./groupingPanelContributions.json";
-import CaseViewModel from "../../caseview/CaseViewModel";
 
 describe("groupingPanelModel", () => {
   it("should be able to create an empty GroupingPanelModel object", () => {
     const groupingPanel = new GroupingPanelModel();
 
     expect(groupingPanel).toBeInstanceOf(GroupingPanelModel);
+    expect(groupingPanel.type).toBe("GroupingPanel");
+    expect(groupingPanel.introtext).toBe("");
 
     expect(
       GroupingPanelModel.isApplicableModel({
@@ -51,10 +52,24 @@ describe("groupingPanelModel", () => {
     expect(groupingPanel.panelLinks).toHaveLength(1);
 
     expect(groupingPanel.hasIntroText()).toBe(true);
+
+    expect(groupingPanel.getInitialChildModelLinks()).toHaveLength(4);
+  });
+
+  it("can handle local taskgroups", () => {
+    const groupingPanel = new GroupingPanelModel({
+      key: "AskingQuestions",
+      data: panelJson,
+      contributions: panelContributionsJson,
+    });
+
+    expect(groupingPanel.hasTaskGroups()).toBe(true);
+    expect(groupingPanel.hasTasks()).toBe(true);
+    expect(groupingPanel.taskGroupCollection).toHaveLength(1);
   });
 
   it("should be able to handle different kind of introtext", () => {
-    const groupingPanelOldStructure = new CaseViewModel({
+    const groupingPanelOldStructure = new GroupingPanelModel({
       key: "Book",
       data: panelJson,
       contributions: panelContributionsJson,
@@ -64,7 +79,7 @@ describe("groupingPanelModel", () => {
       "<p>This is introtext</p>"
     );
 
-    const groupingPanelFromDataPlain = new CaseViewModel({
+    const groupingPanelFromDataPlain = new GroupingPanelModel({
       key: "Book",
       data: {
         _content: { text: { message: "<p>This is introtext</p>" } },
@@ -77,7 +92,7 @@ describe("groupingPanelModel", () => {
       "<p>This is introtext</p>"
     );
 
-    const groupingPanelFromDataApplicationMessage = new CaseViewModel({
+    const groupingPanelFromDataApplicationMessage = new GroupingPanelModel({
       key: "Book",
       data: {
         ...panelJson,
@@ -94,29 +109,31 @@ describe("groupingPanelModel", () => {
       "<p>This is introtext</p>"
     );
 
-    const groupingPanelFromNewContributionsRawTextMessage = new CaseViewModel({
-      key: "Book",
-      data: panelJson,
-      contributions: {
-        ...panelContributionsJson,
-        text: {
-          message: "<p>This is introtext</p>",
+    const groupingPanelFromNewContributionsRawTextMessage =
+      new GroupingPanelModel({
+        key: "Book",
+        data: panelJson,
+        contributions: {
+          ...panelContributionsJson,
+          text: {
+            message: "<p>This is introtext</p>",
+          },
         },
-      },
-    });
+      });
 
     expect(groupingPanelFromNewContributionsRawTextMessage.introtext).toBe(
       "<p>This is introtext</p>"
     );
 
-    const groupingPanelFromNewContributionsSimpleMessage = new CaseViewModel({
-      key: "Book",
-      data: panelJson,
-      contributions: {
-        ...panelContributionsJson,
-        text: "<p>This is introtext</p>",
-      },
-    });
+    const groupingPanelFromNewContributionsSimpleMessage =
+      new GroupingPanelModel({
+        key: "Book",
+        data: panelJson,
+        contributions: {
+          ...panelContributionsJson,
+          text: "<p>This is introtext</p>",
+        },
+      });
 
     expect(groupingPanelFromNewContributionsSimpleMessage.introtext).toBe(
       "<p>This is introtext</p>"

package/src/models/panels/__tests__/groupingPanel.json

@@ -26,5 +26,24 @@
         "name": "TextFragments"
       }
     ]
-  }
+  },
+  "taskgroups": [
+    {
+      "name": "taskgroup",
+      "actions": [
+        {
+          "name": "delivery",
+          "method": "POST",
+          "href": "/books/book/24/activities/delivery",
+          "fields": [
+            {
+              "name": "PrintAssignmentID",
+              "type": "number",
+              "value": null
+            }
+          ]
+        }
+      ]
+    }
+  ]
 }

package/src/models/panels/__tests__/groupingPanelContributions.json

@@ -42,5 +42,18 @@
         "resourcetype": "TaskGroup"
       }
     ]
-  }
+  },
+  "taskgroups": [
+    {
+      "name": "taskgroup",
+      "label": "taskgroup",
+      "actions": [
+        {
+          "name": "delivery",
+          "label": "delivery",
+          "type": "form"
+        }
+      ]
+    }
+  ]
 }

package/src/models/process/__tests__/ProcessStatusSettingsModel.spec.js

@@ -1,4 +1,5 @@
 import ProcessStatusSettingsModel from "../ProcessStatusSettingsModel";
+import { DateUtil } from "../../../utils";
 
 describe("processStatusSettingsModel", () => {
   it("should be able to create an empty ProcessStatusSettingsModel object", () => {
@@ -37,5 +38,15 @@ describe("processStatusSettingsModel", () => {
     expect(processStatus.isApplicable).toBeTruthy();
     expect(processStatus.isCompleted).toBeFalsy();
     expect(processStatus.isNeeded).toBeTruthy();
+
+    expect(processStatus.state).toBeNull();
+    expect(processStatus.canComplete).toBeNull();
+
+    expect(processStatus.referenceDate).toBe(DateUtil.now());
+
+    expect(processStatus.links).toHaveLength(1);
+    expect(processStatus.conceptLink.href.path).toBe(
+      "/concepts/Research grant/Business design/Constraints/Eligible for research grant.bixml/EligibleResearchGrant"
+    );
   });
 });

package/src/models/types.js

@@ -215,21 +215,21 @@ export type ContentElement = {
   },
 };
 
-type PropertyElementMapped = {
+export type PropertyElementMapped = {
   propertyElement: {
     label: string,
     layouthint: LayoutHintCollection,
     properties: Array<PropertyData>,
   },
 };
-type TextFragmentElementMapped = {
+export type TextFragmentElementMapped = {
   textFragmentElement: {
     label: string,
     layouthint: LayoutHintCollection,
     textfragments: Array<TextFragmentData>,
   },
 };
-type ContentElementMapped = {
+export type ContentElementMapped = {
   contentElement: {
     label: string,
     layouthint: LayoutHintCollection,

package/src/modularui/ModularUIRequest.js

@@ -386,6 +386,20 @@ class ModularUIRequest {
     return Promise.resolve();
   }
 
+  /**
+   * Retrieve an object of key: link
+   */
+  dataLinksPerName(dataLinks: any): { [linkName: string]: any } {
+    if (Array.isArray(dataLinks)) {
+      const links = {};
+      for (const dataLink of dataLinks) {
+        links[dataLink.name] = dataLink;
+      }
+      return links;
+    }
+    return dataLinks;
+  }
+
   /**
    * Check if links are empty and hide them when hide-when-empty hint exists
    */
@@ -393,42 +407,44 @@ class ModularUIRequest {
     dataLinks: any,
     contributionLinks: any
   ): Promise<Object | Array<Object>> {
+    const linksPerName = this.dataLinksPerName(dataLinks);
+    const hideWhenEmptyLinks = contributionLinks.filter((contributionLink) =>
+      contributionLink.layouthint?.includes(HIDE_WHEN_EMPTY)
+    );
+
     const isHiddenListChecks = [];
-    for (const contributionLink of contributionLinks) {
-      if (contributionLink.layouthint?.includes(HIDE_WHEN_EMPTY)) {
-        const dataLink = Array.isArray(dataLinks)
-          ? dataLinks.find((link) => link.name === contributionLink.name)
-          : dataLinks[contributionLink.name];
-
-        if (dataLink?.href) {
-          isHiddenListChecks.push(
-            this.isHiddenList(contributionLink.name, dataLink.href)
-          );
-        }
+
+    for (const contributionLink of hideWhenEmptyLinks) {
+      const dataLink = linksPerName[contributionLink.name];
+      if (dataLink?.href) {
+        isHiddenListChecks.push(
+          this.isHiddenList(contributionLink.name, dataLink.href)
+        );
       }
     }
 
-    return Promise.all(isHiddenListChecks).then((hiddenLinks) => {
-      let newDataLinks;
-      if (Array.isArray(dataLinks)) {
-        newDataLinks = dataLinks.filter(
-          (dataLink) => !hiddenLinks.includes(dataLink.name)
-        );
-      } else {
-        newDataLinks = {};
+    return Promise.all(isHiddenListChecks).then(
+      (hiddenLinks: Array<string>) => {
+        if (Array.isArray(dataLinks)) {
+          return dataLinks.filter(
+            (dataLink) => !hiddenLinks.includes(dataLink.name)
+          );
+        }
+
+        const newDataLinks = {};
         for (const dataLinkKey in dataLinks) {
           if (!hiddenLinks.includes(dataLinkKey)) {
             newDataLinks[dataLinkKey] = dataLinks[dataLinkKey];
           }
         }
+        return newDataLinks;
       }
-      return newDataLinks;
-    });
+    );
   }
 
   /**
    */
-  isHiddenList(name: string, href: string): Promise<?string> {
+  isHiddenList(name: string, href: string): Promise<string> {
     return universalFetch({
       ...this.options,
       url: `${BASE}${href}`,

package/src/utils/browser/Cookies.js

@@ -1,4 +1,6 @@
 // @flow
+import Cookies from "js-cookie";
+
 import { BASE } from "../../constants/Constants";
 
 type CookieOptions = {
@@ -7,18 +9,17 @@ type CookieOptions = {
   secure?: boolean,
 };
 
+type CookieAttributes = {
+  path: string,
+  expires?: number,
+  sameSite?: string,
+  secure?: boolean,
+};
+
 /**
  */
 const getCookie = (name: string): null | string => {
-  if (typeof document !== "undefined") {
-    const value = `;${document.cookie}`;
-    const parts = value.split(`; ${name}=`);
-    if (parts.length === 2) {
-      return parts.pop().split(";").shift();
-    }
-  }
-
-  return null;
+  return Cookies.get(name);
 };
 
 /**
@@ -28,31 +29,24 @@ const setCookie = (
   value: any,
   { days, sameSite = "Strict", secure }: CookieOptions = {}
 ) => {
-  if (typeof document !== "undefined") {
-    const valuePart = `${name}=${value || ""}`;
-
-    let expires = "";
-    if (days) {
-      const date = new Date();
-      date.setTime(date.getTime() + days * 24 * 60 * 60 * 1000);
-      expires = `; expires=${date.toUTCString()}`;
-    }
-    let sameSitePart = "";
-    if (sameSite) {
-      sameSitePart = `; SameSite=${sameSite}`;
-    }
-    const securePart = secure ? "Secure" : "";
-
-    document.cookie = `${valuePart}${expires}${sameSitePart}${securePart}; path=${BASE}`;
+  const attributes: CookieAttributes = { path: BASE };
+  if (days) {
+    attributes.expires = days;
+  }
+  if (sameSite) {
+    attributes.sameSite = sameSite;
+  }
+  if (secure) {
+    attributes.secure = secure;
   }
+
+  Cookies.set(name, value, attributes);
 };
 
 /**
  */
 const clearCookie = (name: string) => {
-  if (typeof document !== "undefined") {
-    document.cookie = `${name}=; Max-Age=-99999999;`;
-  }
+  Cookies.remove(name, { path: BASE });
 };
 
 export { getCookie, setCookie, clearCookie };

package/src/utils/browser/__tests__/Cookies.spec.js

@@ -0,0 +1,51 @@
+import { getCookie, setCookie, clearCookie } from "../Cookies";
+
+describe("cookies util", () => {
+  beforeEach(() => {
+    Object.defineProperty(
+      window.document,
+      "cookie",
+      (function (cookies) {
+        return {
+          get: function _get() {
+            const output = [];
+            for (const cookieName in cookies) {
+              output.push(cookieName + "=" + cookies[cookieName]);
+            }
+            return output.join("; ");
+          },
+          set: function _set(s) {
+            const indexOfSeparator = s.indexOf("=");
+            const key = s.substr(0, indexOfSeparator);
+            const value = s.substring(indexOfSeparator + 1);
+            const valueWithoutAttributes = value.substr(0, value.indexOf(";"));
+
+            if (valueWithoutAttributes === "") {
+              delete cookies[key];
+            } else {
+              cookies[key] = value;
+            }
+            return key + "=" + value;
+          },
+          reset: function _reset() {
+            cookies = {};
+          },
+          configurable: true,
+        };
+      })({})
+    );
+  });
+
+  it("should be able retrieve cookies by name", () => {
+    setCookie("newCookie", "test");
+    expect(getCookie("newCookie")).toBe("test");
+
+    setCookie("newCookie2", "test2");
+    expect(getCookie("newCookie")).toBe("test");
+    expect(getCookie("newCookie2")).toBe("test2");
+
+    clearCookie("newCookie2");
+    expect(getCookie("newCookie")).toBe("test");
+    expect(getCookie("newCookie2")).toBeUndefined();
+  });
+});