@beinformed/ui 1.9.0-beta.9 → 1.9.3

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"
+}

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

@@ -0,0 +1,147 @@
+{
+  "label": "Book",
+  "resourcetype": "CaseView",
+  "texts": [
+    {
+      "type": "master",
+      "text": "<p>This is introtext</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"
+    }
+  },
+  "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
+      }
+    }
+  ]
+}

package/src/models/concepts/__mock__/business_scenario.js

@@ -1,13 +1,26 @@
 import BusinessScenarioModel from "../BusinessScenarioModel";
 import ModularUIResponse from "../../../modularui/ModularUIResponse";
+import ConceptDetailModel from "../ConceptDetailModel";
 
 import data from "./business_scenario_data.json";
 import contributions from "./conceptdetail_contributions.json";
 
+import stepData from "./business_scenario_step.json";
+import conceptType from "./concepttype";
+
 const response = ModularUIResponse.create({
   key: "business_scenario",
   data,
   contributions,
 });
+const scenario = new BusinessScenarioModel(response);
+
+const stepResponse = ModularUIResponse.create({
+  key: "business_scenario_step",
+  data: stepData,
+  contributions,
+});
+const step = new ConceptDetailModel(stepResponse);
+step.conceptType = conceptType;
 
-export default new BusinessScenarioModel(response);
+export { scenario, step };

package/src/models/concepts/__mock__/business_scenario_step.json

@@ -0,0 +1,64 @@
+{
+  "concept": {
+    "_id": "StaandehoudingScSt",
+    "_links": {
+      "self": {
+        "href": "/concepts/Incident/Business design/Business scenario/Scenario incident.bixml/StaandehoudingScSt"
+      },
+      "api_doc": {
+        "href": "/api-docs/v3/concepts/(knowledge-model-identifier)/(concept-identifier)"
+      },
+      "contributions": {
+        "href": "/contributions/concepts/(knowledge-model-identifier)/(concept-identifier)"
+      },
+      "concepttype": {
+        "href": "/concepttypes/Library/KMTs/Business scenarios.bixml/ScenarioStep"
+      }
+    },
+    "filter": {
+      "entryDate": {
+        "param": "entryDate",
+        "name": "entryDate",
+        "value": "2020-11-20"
+      }
+    },
+    "conceptLabel": "Staandehouding",
+    "taxonomyType": "default",
+    "relations": [
+      {
+        "relationLabel": "performed by",
+        "relationType": "performedBy",
+        "relationDirection": "outgoing",
+        "concept": {
+          "_links": {
+            "self": {
+              "href": "/concepts/Incident/Business design/Business scenario/Scenario incident.bixml/Agent"
+            },
+            "concepttype": {
+              "href": "/concepttypes/Library/KMTs/Business scenarios.bixml/Persona"
+            }
+          },
+          "conceptLabel": "Agent",
+          "_id": "Agent"
+        }
+      },
+      {
+        "relationLabel": "consists of",
+        "relationType": "consistsOf",
+        "relationDirection": "incoming",
+        "concept": {
+          "_links": {
+            "self": {
+              "href": "/concepts/Incident/Business design/Business scenario/Scenario incident.bixml/ScenarioIncident"
+            },
+            "concepttype": {
+              "href": "/concepttypes/Library/KMTs/Business scenarios.bixml/BusinessScenario"
+            }
+          },
+          "conceptLabel": "Scenario incident",
+          "_id": "ScenarioIncident"
+        }
+      }
+    ]
+  }
+}

package/src/models/concepts/__mock__/conceptdetail.js

@@ -1,18 +1,27 @@
 import ConceptDetailModel from "../ConceptDetailModel";
+import ConceptTypeDetailModel from "../ConceptTypeDetailModel";
 import ModularUIResponse from "../../../modularui/ModularUIResponse";
 
 import data from "./conceptdetail_data.json";
 import contributions from "./conceptdetail_contributions.json";
+import conceptTypeData from "./concepttype_Calculation.json";
+import conceptTypeContributions from "./concepttype_contributions.json";
 
-import conceptType from "./concepttype";
-
-const response = ModularUIResponse.create({
-  key: "conceptdetail",
+const conceptResponse = ModularUIResponse.create({
+  key: "concept",
   data,
   contributions,
 });
 
-const conceptDetail = new ConceptDetailModel(response);
+const conceptTypeResponse = ModularUIResponse.create({
+  key: "concepttype",
+  data: conceptTypeData,
+  contributions: conceptTypeContributions,
+});
+
+const conceptType = new ConceptTypeDetailModel(conceptTypeResponse);
+
+const conceptDetail = new ConceptDetailModel(conceptResponse);
 conceptDetail.conceptType = conceptType;
 
-export default conceptDetail;
+export { conceptDetail };