@beinformed/ui 1.9.0-beta.6 → 1.9.1

package/src/models/attributes/AttributeDataHelper.js

@@ -267,9 +267,10 @@ class AttributeDataHelper {
       const pickedContent = pick(this._attribute.content, [
         "header",
         "label",
-        "description",
         "elements",
+        "layouthint",
       ]);
+
       if (Object.keys(pickedContent).length > 0) {
         return pickedContent;
       }

package/src/models/attributes/AttributeModel.js

@@ -14,12 +14,11 @@ import ConceptDetailModel from "../concepts/ConceptDetailModel";
 
 import { MANDATORY, DISABLED } from "../../constants/LayoutHints";
 import {
-  ALL_CONTENT_IN_DATA_SETTING,
   ATTRIBUTE_WIDTH,
   TIMEVERSION_FILTER_NAME,
 } from "../../constants/Constants";
 
-import { getSetting } from "../../constants/Settings";
+import { getSetting, hasAllContentInData } from "../../constants/Settings";
 
 import {
   IllegalArgumentException,
@@ -952,7 +951,7 @@ export default class AttributeModel extends BaseModel {
    * Indicates if content comes from the data service
    */
   get hasContentFromData(): boolean {
-    return getSetting(ALL_CONTENT_IN_DATA_SETTING, true);
+    return hasAllContentInData();
   }
 
   /**

package/src/models/attributes/ChoiceAttributeOptionModel.js

@@ -4,21 +4,18 @@ import ChoiceAttributeOptionCollection from "./ChoiceAttributeOptionCollection";
 
 import { DateUtil } from "../../utils/datetime/DateTimeUtil";
 import { has } from "../../utils/helpers/objects";
-import {
-  ALL_CONTENT_IN_DATA_SETTING,
-  TIMEVERSION_FILTER_NAME,
-} from "../../constants/Constants";
+import { TIMEVERSION_FILTER_NAME } from "../../constants/Constants";
 import { TITLE } from "../../constants/LayoutHints";
+import { hasAllContentInData } from "../../constants/Settings";
 
 import LinkCollection from "../links/LinkCollection";
 import AttributeCollection from "./AttributeCollection";
 import ConceptDetailModel from "../concepts/ConceptDetailModel";
+import AttributeContent from "./AttributeContent";
 
 import type { ModularUIModel } from "../types";
 import type ListItemModel from "../list/ListItemModel";
 import type LinkModel from "../links/LinkModel";
-import { getSetting } from "../../constants";
-import AttributeContent from "./AttributeContent";
 
 /**
  */
@@ -358,7 +355,7 @@ class ChoiceAttributeOptionModel extends BaseModel {
    * Indicates if content comes from the data service
    */
   get hasContentFromData(): boolean {
-    return getSetting(ALL_CONTENT_IN_DATA_SETTING, true);
+    return hasAllContentInData();
   }
 
   /**

package/src/models/attributes/HelptextAttributeModel.js

@@ -26,6 +26,16 @@ export default class HelptextAttributeModel extends LabelAttributeModel {
    * Get helptext text
    */
   get text(): string | null {
-    return this.getContribution("text");
+    const dataText = this.getData("value");
+    if (dataText) {
+      return dataText.message ?? dataText;
+    }
+
+    const contributionText = this.getContribution("text");
+    if (contributionText) {
+      return contributionText.message ?? contributionText;
+    }
+
+    return null;
   }
 }

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

@@ -2,6 +2,12 @@ import AttributeContent from "../AttributeContent";
 import SectionModel from "../../content/SectionModel";
 
 const json = {
+  header: {
+    label: "Header label",
+    description: {
+      message: "Dit is de beschrijving",
+    },
+  },
   label: "Blaastest geslaagd",
   elements: [
     {
@@ -38,7 +44,7 @@ const json = {
           {
             type: "Description",
             label: "Description",
-            text: "Dit is een text fragment",
+            text: { message: "Dit is een text fragment" },
           },
         ],
       },
@@ -147,6 +153,8 @@ describe("AttributeContent", () => {
   it("Handles basic content elements", () => {
     const content = new AttributeContent(json);
     expect(content.label).toBe("Blaastest geslaagd");
+    expect(content.header.label).toBe("Header label");
+    expect(content.header.description).toBe("Dit is de beschrijving");
     expect(content.properties).toHaveLength(2);
     expect(content.textfragments).toHaveLength(1);
     expect(content.sections).toHaveLength(1);
@@ -218,6 +226,6 @@ describe("AttributeContent", () => {
   it("can retrieve all content", () => {
     const content = new AttributeContent(json);
 
-    expect(content.all).toHaveLength(4);
+    expect(content.elements).toHaveLength(4);
   });
 });

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

@@ -499,18 +499,20 @@ describe("attributeDataHelper", () => {
       key: "results",
       content: {
         InvestigationNecessary: {
+          header: {
+            label: "label",
+            description: "description",
+          },
           elements: [
             {
               textFragmentElement: {
                 label: "Text fragment: Description",
                 textfragments: [
                   {
-                    type: "Description",
-                    label: "Description",
                     text: "Text fragment for investigation necessary",
                   },
                 ],
-                "layout-hint": ["full"],
+                layouthint: ["full"],
               },
             },
           ],
@@ -536,6 +538,10 @@ describe("attributeDataHelper", () => {
     expect(firstChild.dynamicschemaId).toBe("results.InvestigationNecessary");
     expect(firstChild.key).toBe("InvestigationNecessary");
     expect(firstChild.value).toBe(true);
+    expect(firstChild.content.header).toStrictEqual({
+      label: "label",
+      description: "description",
+    });
     expect(firstChild.content.elements).toHaveLength(1);
 
     expect(firstChild.dynamicschema).toBeUndefined();

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

@@ -1,7 +1,7 @@
 import HelptextAttributeModel from "../HelptextAttributeModel";
 
 describe("helptextAttributeModel", () => {
-  it("should be able to create an empty HelptextAttribute object", () => {
+  it("should be able to create a HelptextAttribute object", () => {
     const attribute = new HelptextAttributeModel();
 
     expect(attribute).toBeInstanceOf(HelptextAttributeModel);
@@ -15,4 +15,42 @@ describe("helptextAttributeModel", () => {
 
     expect(attributeWithText.text).toBe("Example helptext text");
   });
+
+  it("should be able to handle content in data", () => {
+    const attributeWithText = new HelptextAttributeModel(
+      {
+        key: "CarDetails",
+        value: {
+          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>",
+        },
+        static: true,
+        dynamicschemaId: "CarDetails",
+        isResult: false,
+        children: [],
+        content: null,
+      },
+      {
+        type: "string",
+        label: "Car details",
+        mandatory: false,
+        readonly: true,
+        text: {
+          id: "CarDetails.text",
+          message:
+            "<p>Currently the person drives in a ${PersonPrivateCar}, although his favorite cars are ${PersonFavoriteCars}. Less favorite cars of the person are ${PersonLessFavoriteCars}.</p>",
+        },
+      }
+    );
+
+    expect(attributeWithText.text).toBe(
+      "<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>"
+    );
+  });
 });

package/src/models/caseview/CaseViewModel.js

@@ -76,11 +76,19 @@ export default class CaseViewModel extends DetailModel {
   }
 
   /**
+   * Retrieve the case label, this can be configured with a case property with the layout hint 'title'
    */
   get label(): string {
     return this.casename ? this.casename.value : "";
   }
 
+  /**
+   * Retrieve the label that was configured on the caseview
+   */
+  get viewLabel(): string {
+    return this.getContribution("label", "");
+  }
+
   /**
    * Check if an introtext exists for this caseview
    */
@@ -92,14 +100,16 @@ export default class CaseViewModel extends DetailModel {
    * Getting the introduction text configured on the case view
    */
   get introtext(): string {
-    if (this.contributions.texts) {
-      const text = this.contributions.texts.find(
-        (item) => item.type === "master"
-      );
+    if (this.data._text) {
+      return this.data._text.message ?? this.data._text;
+    }
 
-      if (text) {
-        return text.text;
-      }
+    if (this.contributions.text) {
+      return this.contributions.text.message ?? this.contributions.text;
+    }
+
+    if (Array.isArray(this.contributions.texts)) {
+      return this.contributions.texts[0].text;
     }
 
     return "";

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

@@ -1,6 +1,9 @@
 import CaseViewModel from "../CaseViewModel";
 import DetailModel from "../../detail/DetailModel";
 
+import caseviewJson from "./caseview.json";
+import caseviewContributionsJson from "./caseviewContributions.json";
+
 describe("caseViewModel", () => {
   it("should be able to create an empty casedetail", () => {
     const caseview = new CaseViewModel({});
@@ -10,200 +13,81 @@ describe("caseViewModel", () => {
 
   it("should be able to create a casedetail from a typical modular UI json structure", () => {
     const caseDetail = new CaseViewModel({
+      key: "Book",
+      data: caseviewJson,
+      contributions: caseviewContributionsJson,
+    });
+
+    expect(caseDetail).toBeInstanceOf(CaseViewModel);
+    expect(caseDetail).toBeInstanceOf(DetailModel);
+
+    expect(caseDetail.key).toBe("Book");
+    expect(caseDetail.id).toBe(24);
+
+    expect(caseDetail.casename.value).toBe("The safety of objects");
+  });
+
+  it("should be able to handle different kind of introtext", () => {
+    const caseviewOldStructure = new CaseViewModel({
+      key: "Book",
+      data: caseviewJson,
+      contributions: caseviewContributionsJson,
+    });
+
+    expect(caseviewOldStructure.introtext).toBe("<p>This is introtext</p>");
+
+    const caseviewFromDataPlain = new CaseViewModel({
       key: "Book",
       data: {
-        _links: {
-          self: {
-            href: "/books/book/24",
-          },
-          api_doc: {
-            href: "/api-docs/books/book/24",
-          },
-          contributions: {
-            href: "/contributions/books/book/24",
-          },
-          Creator: {
-            href: "/books/book/24/creator",
-          },
-          Editions: {
-            href: "/books/book/24/editions",
-          },
-          Activities: {
-            href: "/books/book/24/activities",
-          },
-          taskgroup: [
-            {
-              href: "/books/book/24/Tasks",
-              name: "Tasks",
-            },
-          ],
+        _text: "<p>This is introtext</p>",
+        ...caseviewJson,
+      },
+      contributions: caseviewContributionsJson,
+    });
+
+    expect(caseviewFromDataPlain.introtext).toBe("<p>This is introtext</p>");
+
+    const caseviewFromDataApplicationMessage = new CaseViewModel({
+      key: "Book",
+      data: {
+        ...caseviewJson,
+        _text: {
+          message: "<p>This is introtext</p>",
         },
-        _id: 24,
-        CaseName: "The safety of objects",
-        CaseType: "Book",
-        Owner: "Arnold",
-        Format: "Paperback",
-        ISBN10: "1847087302",
-        ISBN13: "9781847087300",
-        Language: "EN",
-        NumberOfPages: 176,
-        State: "Registered",
       },
+      contributions: caseviewContributionsJson,
+    });
+
+    expect(caseviewFromDataApplicationMessage.introtext).toBe(
+      "<p>This is introtext</p>"
+    );
+
+    const caseviewFromNewContributionsRawTextMessage = new CaseViewModel({
+      key: "Book",
+      data: caseviewJson,
       contributions: {
-        label: "Book",
-        resourcetype: "CaseView",
-        texts: [
-          {
-            type: "master",
-            text: "<p>This view contains all the data about this book. It contains a list of the creators and editions. A person can be an author(1) or an illustrator(2)<br /><br />This is a list of books that is ordered by the role (author (1), co-author, illustrator(2)) of the person that contributed to the book.<br /><br />1) An author is broadly defined as &quot;the person who originated or gave existence to anything&quot; and whose authorship determines responsibility for what was created. Narrowly defined, an author is the originator of any written work and can also be described as a writer.<br /><br />2) An illustrator is an artist who specializes in enhancing writing or elucidating concepts by providing a visual representation that corresponds to the content of the associated text or idea. The illustration may be intended to clarify complicated concepts or objects that are difficult to describe textually, which is the reason illustrations are often found in children&#39;s books.<br /></p>",
-          },
-        ],
-        _links: {
-          panel: [
-            {
-              name: "Creator",
-              label: "Creator",
-              resourcetype: "CaseRelationListPanel",
-            },
-            {
-              name: "Editions",
-              label: "Editions",
-              resourcetype: "RecordListPanel",
-            },
-            {
-              name: "Activities",
-              label: "Activities",
-              resourcetype: "GroupingPanel",
-            },
-          ],
-          taskgroup: [
-            {
-              name: "Tasks",
-              label: "Tasks",
-              resourcetype: "TaskGroup",
-            },
-          ],
-        },
-        metadata: {
-          _id: {
-            label: "Id",
-            type: "integer",
-          },
+        ...caseviewContributionsJson,
+        text: {
+          message: "<p>This is introtext</p>",
         },
-        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",
-                },
-              ],
-            },
-          },
-          {
-            Format: {
-              label: "Format",
-              type: "string",
-              multiplechoice: false,
-              layouthint: ["combobox"],
-              options: [
-                {
-                  code: "Hardcover",
-                  label: "Hardcover",
-                },
-                {
-                  code: "Paperback",
-                  label: "Paperback",
-                },
-                {
-                  code: "Ebook",
-                  label: "Ebook",
-                },
-                {
-                  code: "Audio",
-                  label: "Audio book",
-                },
-              ],
-            },
-          },
-          {
-            ISBN10: {
-              label: "ISBN10",
-              type: "string",
-              displaysize: 50,
-            },
-          },
-          {
-            ISBN13: {
-              label: "ISBN13",
-              type: "string",
-              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,
-            },
-          },
-        ],
       },
     });
 
-    expect(caseDetail).toBeInstanceOf(CaseViewModel);
-    expect(caseDetail).toBeInstanceOf(DetailModel);
+    expect(caseviewFromNewContributionsRawTextMessage.introtext).toBe(
+      "<p>This is introtext</p>"
+    );
 
-    expect(caseDetail.key).toBe("Book");
-    expect(caseDetail.id).toBe(24);
+    const caseviewFromNewContributionsSimpleMessage = new CaseViewModel({
+      key: "Book",
+      data: caseviewJson,
+      contributions: {
+        ...caseviewContributionsJson,
+        text: "<p>This is introtext</p>",
+      },
+    });
 
-    expect(caseDetail.casename.value).toBe("The safety of objects");
+    expect(caseviewFromNewContributionsSimpleMessage.introtext).toBe(
+      "<p>This is introtext</p>"
+    );
   });
 });

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

@@ -0,0 +1,38 @@
+{
+  "_links": {
+    "self": {
+      "href": "/books/book/24"
+    },
+    "api_doc": {
+      "href": "/api-docs/books/book/24"
+    },
+    "contributions": {
+      "href": "/contributions/books/book/24"
+    },
+    "Creator": {
+      "href": "/books/book/24/creator"
+    },
+    "Editions": {
+      "href": "/books/book/24/editions"
+    },
+    "Activities": {
+      "href": "/books/book/24/activities"
+    },
+    "taskgroup": [
+      {
+        "href": "/books/book/24/Tasks",
+        "name": "Tasks"
+      }
+    ]
+  },
+  "_id": 24,
+  "CaseName": "The safety of objects",
+  "CaseType": "Book",
+  "Owner": "Arnold",
+  "Format": "Paperback",
+  "ISBN10": "1847087302",
+  "ISBN13": "9781847087300",
+  "Language": "EN",
+  "NumberOfPages": 176,
+  "State": "Registered"
+}