@beinformed/ui 1.11.0 → 1.13.0

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

@@ -39,7 +39,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 +51,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/form/FormModel.js

@@ -153,14 +153,14 @@ class FormModel extends ResourceModel {
    */
   getButtonLabel(
     buttonType: "cancel" | "previous" | "next" | "finish"
-  ): string {
+  ): string | null {
     // cancel button labels are defined on the form
     if (buttonType === "cancel") {
-      return get(this.buttonLabels, "cancel", "");
+      return get(this.buttonLabels, "cancel", null);
     }
 
     // all other form related button labels are defined on the object
-    return get(this.currentFormObject?.buttonLabels, buttonType, "");
+    return get(this.currentFormObject?.buttonLabels, buttonType, null);
   }
 
   /**
@@ -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) {

package/src/models/list/ListModel.js

@@ -98,8 +98,8 @@ export default class ListModel extends ResourceModel {
    * Getting the introduction text
    */
   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) {

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

@@ -40,7 +40,7 @@ describe("listDetailModel", () => {
     const listdetailFromDataPlain = new ListDetailModel({
       key: "Book",
       data: {
-        _text: "<p>This is introtext</p>",
+        _content: { text: { message: "<p>This is introtext</p>" } },
         ...data.Book,
       },
       contributions: contributions.Book,
@@ -52,8 +52,10 @@ describe("listDetailModel", () => {
       key: "Book",
       data: {
         ...data.Book,
-        _text: {
-          message: "<p>This is introtext</p>",
+        _content: {
+          text: {
+            message: "<p>This is introtext</p>",
+          },
         },
       },
       contributions: contributions.Book,

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

@@ -69,7 +69,7 @@ describe("listModel spec", () => {
     const listFromDataPlain = new ListModel({
       key: "Books",
       data: {
-        text: "<p>This is introtext</p>",
+        content: { text: { message: "<p>This is introtext</p>" } },
         ...mockList.Books,
       },
       contributions: mockListContributions.Books,
@@ -81,8 +81,10 @@ describe("listModel spec", () => {
       key: "Books",
       data: {
         ...mockList.Books,
-        text: {
-          message: "<p>This is introtext</p>",
+        content: {
+          text: {
+            message: "<p>This is introtext</p>",
+          },
         },
       },
       contributions: mockListContributions.Books,

package/src/models/panels/GroupingPanelModel.js

@@ -85,8 +85,8 @@ export default class GroupingPanelModel extends ResourceModel {
    * Getting the introduction text configured on the grouping panel
    */
   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) {

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

@@ -67,7 +67,7 @@ describe("groupingPanelModel", () => {
     const groupingPanelFromDataPlain = new CaseViewModel({
       key: "Book",
       data: {
-        _text: "<p>This is introtext</p>",
+        _content: { text: { message: "<p>This is introtext</p>" } },
         ...panelJson,
       },
       contributions: panelContributionsJson,
@@ -81,8 +81,10 @@ describe("groupingPanelModel", () => {
       key: "Book",
       data: {
         ...panelJson,
-        _text: {
-          message: "<p>This is introtext</p>",
+        _content: {
+          text: {
+            message: "<p>This is introtext</p>",
+          },
         },
       },
       contributions: panelContributionsJson,

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,