@beinformed/ui 1.12.0 → 1.13.1

package/src/models/attributes/__tests__/AttributeContent.spec.js

@@ -13,10 +13,8 @@ const json = {
     {
       propertyElement: {
         label: "Properties",
-        id: "properties",
         properties: [
           {
-            type: "Gemiddelde",
             label: "Gemiddelde",
             value: "80%",
           },
@@ -26,10 +24,8 @@ const json = {
     {
       propertyElement: {
         label: "Second Properties",
-        id: "secondProperties",
         properties: [
           {
-            type: "SecondGemiddelde",
             label: "Second Gemiddelde",
             value: "20%",
           },
@@ -38,20 +34,15 @@ const json = {
     },
     {
       textFragmentElement: {
-        label: "Description",
-        id: "Description",
+        label: "Description TextFragment",
         textfragments: [
-          {
-            type: "Description",
-            label: "Description",
-            text: { message: "Dit is een text fragment" },
-          },
+          { id: "Description", text: { message: "Dit is een text fragment" } },
         ],
       },
     },
     {
       contentElement: {
-        label: "Description",
+        label: "Description Content",
         sections: [
           {
             id: "Alert",
@@ -160,26 +151,29 @@ describe("AttributeContent", () => {
     expect(content.sections).toHaveLength(1);
 
     const firstProperty = content.properties[0];
-    expect(firstProperty.type).toBe("Gemiddelde");
     expect(firstProperty.label).toBe("Gemiddelde");
     expect(firstProperty.value).toBe("80%");
 
     const firstTextFragment = content.textfragments[0];
-    expect(firstTextFragment.type).toBe("Description");
-    expect(firstTextFragment.label).toBe("Description");
     expect(firstTextFragment.text).toBe("Dit is een text fragment");
   });
 
   it("Can ask for elements by type", () => {
     const content = new AttributeContent(json);
 
-    expect(content.getConceptPropertiesByIds("not-existing")).toHaveLength(0);
-    expect(content.getTextFragmentByKeys("not-existing")).toHaveLength(0);
+    expect(content.getConceptPropertiesByLabels("not-existing")).toHaveLength(
+      0
+    );
+    expect(content.getTextFragmentsByLabels("not-existing")).toHaveLength(0);
     expect(content.getSectionsByType("not-existing")).toHaveLength(0);
+    expect(content.getSectionsByLabels("not-existing")).toHaveLength(0);
 
-    expect(content.getConceptPropertiesByIds("Gemiddelde")).toHaveLength(1);
-    expect(content.getTextFragmentByKeys("Description")).toHaveLength(1);
+    expect(content.getConceptPropertiesByLabels("Properties")).toHaveLength(1);
+    expect(
+      content.getTextFragmentsByLabels("Description TextFragment")
+    ).toHaveLength(1);
     expect(content.getSectionsByType("Reference")).toHaveLength(1);
+    expect(content.getSectionsByLabels("Description Content")).toHaveLength(1);
   });
 
   it("Creates ContentModel when sections available", () => {

package/src/models/attributes/__tests__/HelptextAttributeModel.spec.js

@@ -9,7 +9,14 @@ describe("helptextAttributeModel", () => {
     expect(attribute.text).toBeNull();
 
     const attributeWithText = new HelptextAttributeModel(
-      {},
+      {
+        key: "CarDetails",
+        content: null,
+        static: true,
+        dynamicschemaId: "CarDetails",
+        isResult: false,
+        children: [],
+      },
       { text: "Example helptext text" }
     );
 
@@ -20,21 +27,22 @@ describe("helptextAttributeModel", () => {
     const attributeWithText = new HelptextAttributeModel(
       {
         key: "CarDetails",
-        value: {
-          id: "CarDetails.text",
-          properties: {
-            PersonPrivateCar: "Ferrari GTO",
-            PersonLessFavoriteCars: "Mercedes",
-            PersonFavoriteCars: "BMW 5 Series, Fiat Panda",
+        content: {
+          text: {
+            id: "CarDetails.text",
+            properties: {
+              PersonPrivateCar: "Ferrari GTO",
+              PersonLessFavoriteCars: "Mercedes",
+              PersonFavoriteCars: "BMW 5 Series, Fiat Panda",
+            },
+            message:
+              "<p>Currently the person drives in a Ferrari GTO, although his favorite cars are BMW 5 Series, Fiat Panda. Less favorite cars of the person are Mercedes.</p>",
           },
-          message:
-            "<p>Currently the person drives in a Ferrari GTO, although his favorite cars are BMW 5 Series, Fiat Panda. Less favorite cars of the person are Mercedes.</p>",
         },
         static: true,
         dynamicschemaId: "CarDetails",
         isResult: false,
         children: [],
-        content: null,
       },
       {
         type: "string",

package/src/models/caseview/CaseViewModel.js

@@ -6,6 +6,8 @@ import TaskGroupModel from "../taskgroup/TaskGroupModel";
 
 import { TITLE } from "../../constants/LayoutHints";
 
+import IllegalStateException from "../../exceptions/IllegalStateException";
+
 import type { ModularUIModel, AttributeType } from "../types";
 import type { ModularUIResponse } from "../../modularui";
 import type LinkCollection from "../links/LinkCollection";
@@ -100,8 +102,8 @@ export default class CaseViewModel extends DetailModel {
    * Getting the introduction text configured on the case view
    */
   get introtext(): string {
-    if (this.data._text) {
-      return this.data._text.message ?? this.data._text;
+    if (this.data._content) {
+      return this.data._content.text.message;
     }
 
     if (this.contributions.text) {
@@ -122,7 +124,7 @@ export default class CaseViewModel extends DetailModel {
     const selfLink = this.links.getLinkByKey("self");
 
     if (selfLink === null) {
-      throw new Error("No self href available");
+      throw new IllegalStateException("No self href available");
     }
 
     return new Href(selfLink.href);

package/src/models/caseview/__tests__/CaseViewModel.spec.js

@@ -2,13 +2,26 @@ import CaseViewModel from "../CaseViewModel";
 import DetailModel from "../../detail/DetailModel";
 
 import caseviewJson from "./caseview.json";
+import caseviewLocalTaskgroupJson from "./caseview_local_taskgroup.json";
 import caseviewContributionsJson from "./caseviewContributions.json";
 
+import IllegalStateException from "../../../exceptions/IllegalStateException";
+
 describe("caseViewModel", () => {
   it("should be able to create an empty casedetail", () => {
     const caseview = new CaseViewModel({});
 
     expect(caseview).toBeInstanceOf(CaseViewModel);
+    expect(caseview.getInitialChildModelLinks()).toHaveLength(0);
+    expect(caseview.panelLinks).toHaveLength(0);
+    expect(caseview.introtext).toBe("");
+  });
+
+  it("throws when no self link is available", () => {
+    const caseview = new CaseViewModel({});
+    expect(() => {
+      caseview.selfhref;
+    }).toThrow(IllegalStateException);
   });
 
   it("should be able to create a casedetail from a typical modular UI json structure", () => {
@@ -18,6 +31,8 @@ describe("caseViewModel", () => {
       contributions: caseviewContributionsJson,
     });
 
+    expect(caseDetail.viewLabel).toBe("Book");
+    expect(caseDetail.hasIntroText()).toBe(true);
     expect(caseDetail).toBeInstanceOf(CaseViewModel);
     expect(caseDetail).toBeInstanceOf(DetailModel);
 
@@ -25,13 +40,35 @@ describe("caseViewModel", () => {
     expect(caseDetail.id).toBe(24);
 
     expect(caseDetail.casename.value).toBe("The safety of objects");
+
+    expect(caseDetail.hasTaskGroups()).toBe(false);
+  });
+
+  it("should be able to handle local taskgroup", () => {
+    const caseDetail = new CaseViewModel({
+      key: "Book",
+      data: caseviewLocalTaskgroupJson,
+      contributions: caseviewContributionsJson,
+    });
+
+    expect(caseDetail.hasTaskGroups()).toBe(true);
+    expect(caseDetail.taskGroupCollection).toHaveLength(1);
   });
 
   it("should be able to handle different kind of introtext", () => {
     const caseviewOldStructure = new CaseViewModel({
       key: "Book",
       data: caseviewJson,
-      contributions: caseviewContributionsJson,
+      contributions: {
+        ...caseviewContributionsJson,
+        text: undefined,
+        texts: [
+          {
+            type: "master",
+            text: "<p>This is introtext</p>",
+          },
+        ],
+      },
     });
 
     expect(caseviewOldStructure.introtext).toBe("<p>This is introtext</p>");
@@ -39,7 +76,7 @@ describe("caseViewModel", () => {
     const caseviewFromDataPlain = new CaseViewModel({
       key: "Book",
       data: {
-        _text: "<p>This is introtext</p>",
+        _content: { text: { message: "<p>This is introtext</p>" } },
         ...caseviewJson,
       },
       contributions: caseviewContributionsJson,
@@ -51,8 +88,10 @@ describe("caseViewModel", () => {
       key: "Book",
       data: {
         ...caseviewJson,
-        _text: {
-          message: "<p>This is introtext</p>",
+        _content: {
+          text: {
+            message: "<p>This is introtext</p>",
+          },
         },
       },
       contributions: caseviewContributionsJson,

package/src/models/caseview/__tests__/caseview.json

@@ -4,10 +4,13 @@
       "href": "/books/book/24"
     },
     "api_doc": {
-      "href": "/api-docs/books/book/24"
+      "href": "/api-docs/v3/books/book/(case-id)"
     },
     "contributions": {
-      "href": "/contributions/books/book/24"
+      "href": "/contributions/books/book/(case-id)"
+    },
+    "Details": {
+      "href": "/books/book/24/details"
     },
     "Creator": {
       "href": "/books/book/24/creator"
@@ -19,6 +22,14 @@
       "href": "/books/book/24/activities"
     },
     "taskgroup": [
+      {
+        "href": "/books/book/24/contributors-tasks",
+        "name": "Contributors"
+      },
+      {
+        "href": "/books/book/24/delivery-tasks",
+        "name": "Delivery"
+      },
       {
         "href": "/books/book/24/Tasks",
         "name": "Tasks"
@@ -35,4 +46,4 @@
   "Language": "EN",
   "NumberOfPages": 176,
   "State": "Registered"
-}
+}

package/src/models/caseview/__tests__/caseviewContributions.json

@@ -1,14 +1,17 @@
 {
   "label": "Book",
   "resourcetype": "CaseView",
-  "texts": [
-    {
-      "type": "master",
-      "text": "<p>This is introtext</p>"
-    }
-  ],
+  "text": {
+    "id": "Book_master",
+    "message": "<p>This is introtext</p>"
+  },
   "_links": {
     "panel": [
+      {
+        "name": "Details",
+        "label": "Details",
+        "resourcetype": "CasePropertiesPanel"
+      },
       {
         "name": "Creator",
         "label": "Creator",
@@ -27,12 +30,35 @@
     ],
     "taskgroup": [
       {
-        "name": "Tasks",
-        "label": "Tasks",
+        "name": "Contributors",
+        "label": "Contributors",
+        "resourcetype": "TaskGroup"
+      },
+      {
+        "name": "Delivery",
+        "label": "Delivery",
+        "resourcetype": "TaskGroup"
+      },
+      {
+        "name": "Book",
+        "label": "Book",
         "resourcetype": "TaskGroup"
       }
     ]
   },
+  "taskgroups": [
+    {
+      "name": "Book",
+      "label": "Book",
+      "actions": [
+        {
+          "name": "delete-book",
+          "label": "Delete book",
+          "type": "form"
+        }
+      ]
+    }
+  ],
   "metadata": {
     "_id": {
       "label": "Id",
@@ -42,44 +68,25 @@
   "attributes": [
     {
       "CaseName": {
-        "label": "Case name",
-        "type": "string",
-        "layouthint": ["title"]
-      }
-    },
-    {
-      "CaseType": {
-        "label": "Case type",
-        "type": "string",
-        "layouthint": ["type"]
-      }
-    },
-    {
-      "Owner": {
-        "label": "Case owner",
-        "type": "string",
-        "layouthint": ["owner"]
-      }
-    },
-    {
-      "State": {
-        "label": "State",
         "type": "string",
-        "layouthint": ["state"],
-        "options": [
-          {
-            "code": "Registered",
-            "label": "Registered"
-          }
-        ]
+        "label": "Dossiernaam",
+        "layouthint": [
+          "title"
+        ],
+        "displaysize": 50,
+        "maxLength": 255
       }
     },
     {
       "Format": {
-        "label": "Format",
         "type": "string",
+        "label": "Format",
+        "optionMode": "static",
         "multiplechoice": false,
-        "layouthint": ["combobox"],
+        "layouthint": [
+          "combobox"
+        ],
+        "enumerated": true,
         "options": [
           {
             "code": "Hardcover",
@@ -102,46 +109,10 @@
     },
     {
       "ISBN10": {
-        "label": "ISBN10",
-        "type": "string",
-        "displaysize": 50
-      }
-    },
-    {
-      "ISBN13": {
-        "label": "ISBN13",
         "type": "string",
+        "label": "ISBN10",
         "displaysize": 50
       }
-    },
-    {
-      "Language": {
-        "label": "Language",
-        "type": "string",
-        "multiplechoice": false,
-        "layouthint": ["radiobutton"],
-        "options": [
-          {
-            "code": "EN",
-            "label": "English"
-          },
-          {
-            "code": "DU",
-            "label": "Dutch"
-          }
-        ]
-      }
-    },
-    {
-      "NumberOfPages": {
-        "label": "Number of pages",
-        "type": "number",
-        "format": "0",
-        "groupingSeparator": ".",
-        "decimalSeparator": ",",
-        "minimum": 1,
-        "maximum": 1000
-      }
     }
   ]
-}
+}

package/src/models/caseview/__tests__/caseview_local_taskgroup.json

@@ -0,0 +1,57 @@
+{
+  "_links": {
+    "self": {
+      "href": "/books/book/24"
+    },
+    "api_doc": {
+      "href": "/api-docs/v3/books/book/(case-id)"
+    },
+    "contributions": {
+      "href": "/contributions/books/book/(case-id)"
+    },
+    "Details": {
+      "href": "/books/book/24/details"
+    },
+    "Creator": {
+      "href": "/books/book/24/creator"
+    },
+    "Editions": {
+      "href": "/books/book/24/editions"
+    },
+    "Activities": {
+      "href": "/books/book/24/activities"
+    },
+    "taskgroup": [
+      {
+        "href": "/books/book/24/contributors-tasks",
+        "name": "Contributors"
+      },
+      {
+        "href": "/books/book/24/delivery-tasks",
+        "name": "Delivery"
+      }
+    ]
+  },
+  "taskgroups": [
+    {
+      "name": "Book",
+      "actions": [
+        {
+          "name": "delete-book",
+          "method": "POST",
+          "href": "/books/book/24/delete-book"
+        }
+      ]
+    }
+  ],
+  "_id": 24,
+  "CaseName": "The safety of objects",
+  "CaseType": "Book",
+  "Owner": "Arnold",
+  "Format": "Paperback",
+  "ISBN10": "1847087302",
+  "ISBN13": "9781847087300",
+  "Language": "EN",
+  "NumberOfPages": 176,
+  "State": "Registered"
+}

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/FormObjectModel.js

@@ -296,16 +296,14 @@ export default class FormObjectModel extends BaseModel {
    */
   get introText(): string {
     if (this.data.content?.text) {
-      return this.data.content.text.message ?? this.data.content.text;
+      return this.data.content.text.message;
     }
 
     if (this.contributions.text?.message) {
       return this.contributions.text.message;
     }
 
-    return (
-      this.contributions.introText?.message ?? this.contributions.introText
-    );
+    return this.contributions.introText;
   }
 
   /**

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/form/__tests__/FormObjectModel.spec.js

@@ -19,7 +19,7 @@ const data = {
 const contributions = {
   repeatable: false,
   label: "Create person",
-  introText: { id: "IntroTextID", message: "This is introtext" },
+  text: { id: "IntroTextID", message: "This is introtext" },
   attributes: [
     {
       Name: {
@@ -122,13 +122,15 @@ describe("formObjectModel", () => {
     const contributions2 = {
       repeatable: false,
       label: "Create person",
-      introText: { id: "IntroTextID", message: "This is new introtext" },
       attributes: [],
     };
 
     const data2 = {};
 
-    const formObject = new FormObjectModel(data2, contributions2);
+    const formObject = new FormObjectModel(data2, {
+      ...contributions2,
+      text: { id: "IntroTextID", message: "This is new introtext" },
+    });
     expect(formObject.introText).toBe("This is new introtext");
 
     const formObject2 = new FormObjectModel(data2, {
@@ -151,4 +153,28 @@ describe("formObjectModel", () => {
     const formObject = new FormObjectModel(data2, contributions2);
     expect(formObject.introText).toBe("This is new text");
   });
+
+  it("can handle new text in data", () => {
+    const contributions2 = {
+      repeatable: false,
+      label: "Create person",
+      text: { id: "IntroTextID", message: "This is new text ${USER.ID}" },
+      attributes: [],
+    };
+
+    const data2 = {
+      content: {
+        text: {
+          id: "IntroTextID",
+          message: "This is new text 1",
+          properties: {
+            "USER.ID": "1",
+          },
+        },
+      },
+    };
+
+    const formObject = new FormObjectModel(data2, contributions2);
+    expect(formObject.introText).toBe("This is new text 1");
+  });
 });

package/src/models/list/ListDetailModel.js

@@ -137,8 +137,8 @@ export default class ListDetailModel extends DetailModel {
    * Getting the introduction text configured on the case view
    */
   get introtext(): string {
-    if (this.data._text) {
-      return this.data._text.message ?? this.data._text;
+    if (this.data._content) {
+      return this.data._content.text.message;
     }
 
     if (this.contributions.text) {