@beinformed/ui 1.12.1 → 1.13.2

package/src/hooks/useModal.js

@@ -25,7 +25,7 @@ export const useModal: ModalHook = (modalId: string) => {
 
   const dispatch = useDispatch();
   const modal = useSelector(({ modals }) =>
-    modals.modals.find((modal) => modal.key === modalId)
+    modals.modals.find((m) => m.key === modalId)
   );
 
   const show = useCallback(() => {

package/src/hooks/useModularUI.js

@@ -38,8 +38,6 @@ export const useModularUI = (
 
   // dispatch loadModularUI
   useDeepCompareEffect(() => {
-    // console.info({ new: options }, { old: prevOptions.current });
-
     // prevent reloads when previous option had the isReload, but the new options not
     const isOldReload =
       prevHref.current === href &&

package/src/i18n/Locale.js

@@ -15,6 +15,7 @@ class Locale {
   _code: string;
   _messages: { [string]: string };
   _errors: { [string]: string };
+  _nativeName: ?string;
 
   constructor(locale: LocaleConfiguration) {
     this._code = locale.code;
@@ -22,6 +23,8 @@ class Locale {
     this._messages = this.fixPlaceHoldersInObject(locale.messages);
     this._errors = this.fixPlaceHoldersInObject(locale.errors);
 
+    this._nativeName = locale.nativeName;
+
     formatMessage.setup({
       missingTranslation: "ignore",
     });
@@ -38,6 +41,10 @@ class Locale {
    * Retrieve nativeName
    */
   get nativeName(): string {
+    if (this._nativeName) {
+      return this._nativeName;
+    }
+
     const aLocale = this.code.split("-");
 
     if (aLocale.length > 0) {

package/src/i18n/__tests__/Locale.spec.js

@@ -39,6 +39,20 @@ describe("locale", () => {
     expect(locale.getMessage("testMessage")).toBe("Updated message");
   });
 
+  it("can handle languages without iso-639-2 code", () => {
+    const locale = new Locale({
+      code: "pap",
+      nativeName: "Papiamento",
+      messages: {
+        descr: "Papiamento",
+      },
+      errors: {},
+    });
+
+    expect(locale.code).toBe("pap");
+    expect(locale.nativeName).toBe("Papiamento");
+  });
+
   it("throws on non exising locale", () => {
     const locale = new Locale({
       code: "NONEXISTING",

package/src/i18n/languages.js

@@ -200,6 +200,7 @@ const languages = {
     za: ["Zhuang", "Cuengh / Tôô / 壮语"],
     zh: ["Chinese", "中文"],
     zu: ["Zulu", "isiZulu"],
+    pap: ["Papiamento", "Papiamento"],
   },
 };
 

package/src/i18n/types.js

@@ -19,4 +19,5 @@ export type LocaleConfiguration = {
   code: string,
   messages: Object,
   errors?: Object,
+  nativeName?: string,
 };

package/src/models/attributes/AttributeContent.js

@@ -3,15 +3,19 @@ import { retrieveText } from "../../utils/helpers/text";
 import { hasAllContentInData } from "../../constants/Settings";
 import SectionModel from "../content/SectionModel";
 
+import LayoutHintCollection from "../layouthint/LayoutHintCollection";
+import { isPlainObject } from "../../utils";
+
 import type {
   ContentData,
+  ContentElementMapped,
   PropertyData,
+  PropertyElementMapped,
   TextFragmentData,
+  TextFragmentElementMapped,
   ContentAll,
 } from "../types";
 import type SubSectionModel from "../content/SubSectionModel";
-import LayoutHintCollection from "../layouthint/LayoutHintCollection";
-import { isPlainObject } from "../../utils";
 
 class AttributeContent {
   _content: ?ContentData;
@@ -116,51 +120,84 @@ class AttributeContent {
 
   /**
    */
-  getContentElements<T>(elementName: string, collectionName: string): Array<T> {
-    return this.elements
-      .filter((element) => elementName in element)
+  getContentElements<T>(elementName: string): Array<T> {
+    // $FlowIssue incompatible-return
+    return this.elements.filter((element) => elementName in element);
+  }
+
+  /**
+   */
+  getContentElementCollections<T>(
+    elementName: string,
+    collectionName: string
+  ): Array<T> {
+    return this.getContentElements(elementName)
       .map((element) => element[elementName][collectionName])
       .flat();
   }
 
+  /**
+   */
+  getContentElementCollectionByLabels<T, U>(
+    elementName: string,
+    collectionName: string,
+    labels: Array<string>
+  ): Array<U> {
+    return (
+      this.getContentElements<T>(elementName)
+        // $FlowIssue incompatible-use
+        .filter((element) => labels.includes(element[elementName].label))
+        // $FlowIssue incompatible-use
+        .map((element) => element[elementName][collectionName])
+        .flat()
+    );
+  }
+
   /**
    */
   get properties(): Array<PropertyData> {
-    return this.getContentElements<PropertyData>(
+    return this.getContentElementCollections<PropertyData>(
       "propertyElement",
       "properties"
     );
   }
 
   /**
-   * Get concept properties by id
+   * Get concept properties by property element label
    */
-  getConceptPropertiesByIds(ids: Array<string>): Array<PropertyData> {
-    return this.properties.filter((property) => ids.includes(property.type));
+  getConceptPropertiesByLabels(labels: Array<string>): Array<PropertyData> {
+    return this.getContentElementCollectionByLabels<
+      PropertyElementMapped,
+      PropertyData
+    >("propertyElement", "properties", labels);
   }
 
   /**
    */
   get textfragments(): Array<TextFragmentData> {
-    return this.getContentElements<TextFragmentData>(
+    return this.getContentElementCollections<TextFragmentData>(
       "textFragmentElement",
       "textfragments"
     );
   }
 
   /**
-   * Get concept text fragments by type
+   * Get concept text fragments by text fragment element label
    */
-  getTextFragmentByKeys(keys: Array<string>): Array<TextFragmentData> {
-    return this.textfragments.filter((textfragment) =>
-      keys.includes(textfragment.type)
-    );
+  getTextFragmentsByLabels(labels: Array<string>): Array<TextFragmentData> {
+    return this.getContentElementCollectionByLabels<
+      TextFragmentElementMapped,
+      TextFragmentData
+    >("textFragmentElement", "textfragments", labels);
   }
 
   /**
    */
   get sections(): Array<SectionModel> {
-    return this.getContentElements<SectionModel>("contentElement", "sections");
+    return this.getContentElementCollections<SectionModel>(
+      "contentElement",
+      "sections"
+    );
   }
 
   /**
@@ -169,6 +206,16 @@ class AttributeContent {
     return this.sections.filter((section) => types.includes(section.type));
   }
 
+  /**
+   * Get concept text fragments by text fragment element label
+   */
+  getSectionsByLabels(labels: Array<string>): Array<SectionModel> {
+    return this.getContentElementCollectionByLabels<
+      ContentElementMapped,
+      SectionModel
+    >("contentElement", "sections", labels);
+  }
+
   /**
    */
   getReferredSections(): Array<SectionModel | SubSectionModel> {

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__/StringAttributeModel.spec.js

@@ -110,6 +110,6 @@ describe("stringAttributeModel", () => {
 
     const clonedAttribute = attribute.clone();
 
-    expect(attribute === clonedAttribute).toBe(false);
+    expect(attribute).not.toBe(clonedAttribute);
   });
 });

package/src/models/base/__tests__/BaseModel.spec.js

@@ -73,13 +73,13 @@ describe("baseModel", () => {
     });
 
     const shallowClone = model.clone();
-    expect(model === shallowClone).toBe(false);
-    expect(model.data.prop === shallowClone.data.prop).toBe(true);
-    expect(model.data.prop.child === shallowClone.data.prop.child).toBe(true);
+    expect(model).not.toBe(shallowClone);
+    expect(model.data.prop).toBe(shallowClone.data.prop);
+    expect(model.data.prop.child).toBe(shallowClone.data.prop.child);
 
     const deepClone = model.clone(true);
-    expect(model === deepClone).toBe(false);
+    expect(model).not.toBe(deepClone);
     expect(model.data.prop === deepClone.data.prop).toBeFalsy();
-    expect(model.data.prop.child === deepClone.data.prop.child).toBe(true);
+    expect(model.data.prop.child).toBe(deepClone.data.prop.child);
   });
 });

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";
@@ -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>");

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