@beinformed/ui 1.28.7 → 1.30.0

package/src/models/form/FormModel.js

@@ -27,6 +27,7 @@ import type { ModularUIResponse } from "../../modularui";
 import type ErrorResponse from "../error/ErrorResponse";
 import type LinkModel from "../links/LinkModel";
 import LayoutHintCollection from "../layouthint/LayoutHintCollection";
+import AttributeSetModel from "../attributes/AttributeSetModel";
 
 /**
  */
@@ -611,11 +612,36 @@ class FormModel extends ResourceModel {
   }
 
   /**
+   * Get the result data as plain json object
    */
   getSuccessData(): ?Object {
     return this.data.success?.data;
   }
 
+  /**
+   * Retrieve an object where each property is a result data attribute set
+   */
+  getResultData(): ?{
+    [key: string]: AttributeSetModel,
+  } {
+    const resultDataKeys = Object.keys(this.contributions.resultdata) ?? [];
+    const successData = this.getSuccessData() ?? {};
+
+    const resultdata: {
+      [key: string]: AttributeSetModel,
+    } = {};
+
+    for (const resultDataKey of resultDataKeys) {
+      resultdata[resultDataKey] = new AttributeSetModel(
+        resultDataKey,
+        successData[resultDataKey],
+        this.contributions.resultdata[resultDataKey]
+      );
+    }
+
+    return resultdata;
+  }
+
   /**
    */
   get resultData(): ?Object {

package/src/models/form/__tests__/FormResultData.spec.js

@@ -0,0 +1,86 @@
+import ModularUIResponse from "../../../modularui/ModularUIResponse";
+import FormModel from "../FormModel";
+
+describe("formModel with result data", () => {
+  it("should be able to create a FormModel with result data", () => {
+    const data = ModularUIResponse.create({
+      data: {
+        formresponse: {
+          _links: {
+            self: { href: "/rebuild-db/database-actions/rebuild-db-server" },
+            api_doc: {
+              href: "/api-docs/v3/rebuild-db/database-actions/rebuild-db-server",
+            },
+            contributions: {
+              href: "/contributions/rebuild-db/database-actions/rebuild-db-server",
+            },
+          },
+          success: { redirect: "/", data: { out: { money: 10 } } },
+        },
+      },
+      contributions: {
+        RebuildDBServer: {
+          label: "Rebuild DB server",
+          resourcetype: "Form",
+          actiontype: "form",
+          objects: {
+            AttributeSet: {
+              dynamicObject: false,
+              repeatable: false,
+              dynamicValidations: false,
+              label: "Rebuild DB",
+              mandatory: false,
+              attributes: [
+                {
+                  Dummy: {
+                    type: "string",
+                    label: "Dummy (not visible)",
+                    mandatory: false,
+                    readonly: true,
+                    layouthint: ["label"],
+                  },
+                },
+              ],
+            },
+          },
+          resultdata: {
+            out: {
+              repeatable: false,
+              label: "Result data",
+              introText: {
+                id: "out.Introtext",
+                message: "<p>uit</p>",
+              },
+              attributes: [
+                {
+                  money: {
+                    type: "number",
+                    label: "Money",
+                    mandatory: false,
+                    decimalSeparator: ",",
+                    layouthint: ["money"],
+                    format: "#,##0.00",
+                    groupingSeparator: ".",
+                    currencySymbol: "€",
+                  },
+                },
+              ],
+            },
+          },
+        },
+      },
+    });
+
+    const form = new FormModel(data);
+
+    const resultData = form.getResultData();
+    expect(resultData.out.key).toBe("out");
+    expect(resultData.out.label).toBe("Result data");
+    expect(resultData.out.attributeCollection.size).toBe(1);
+    expect(resultData.out.attributeCollection.first.label).toBe("Money");
+    expect(resultData.out.attributeCollection.first.readonlyvalue).toBe(
+      "10,00"
+    );
+    expect(resultData.out.attributeCollection.first.currencySymbol).toBe("€");
+  });
+});

package/src/models/index.js

@@ -41,6 +41,8 @@ export { default as BaseLayoutHintRule } from "./attributes/layouthint-rules/Bas
 export { default as DependentAttribute } from "./attributes/layouthint-rules/DependentAttribute";
 export { default as RemainingTotalUploadSize } from "./attributes/layouthint-rules/RemainingTotalUploadSize";
 
+import { default as LayoutHintCollection } from "./layouthint/LayoutHintCollection";
+
 import { default as CaseViewModel } from "./caseview/CaseViewModel";
 
 import { default as BusinessScenarioModel } from "./concepts/BusinessScenarioModel";
@@ -168,6 +170,7 @@ export {
   FilterModel,
   RangeFilterModel,
   ConceptIndexFilterModel,
+  LayoutHintCollection,
 };
 
 export type * from "./types";

package/types/models/form/FormModel.d.ts

@@ -181,8 +181,15 @@ declare class FormModel extends ResourceModel {
      */
     get redirectLocation(): Href;
     /**
+     * Get the result data as plain json object
      */
     getSuccessData(): Object | null;
+    /**
+     * Retrieve an object where each property is a result data attribute set
+     */
+    getResultData(): {
+        [key: string]: AttributeSetModel;
+    };
     /**
      */
     get resultData(): Object;
@@ -307,6 +314,7 @@ import ErrorCollection from "../error/ErrorCollection";
 import Href from "../href/Href";
 import Parameter from "../parameter/Parameter";
 import ErrorResponse from "../error/ErrorResponse";
+import AttributeSetModel from "../attributes/AttributeSetModel";
 import { ModularUIResponse } from "../../modularui";
 import { ModularUIModel } from "../types";
 import { AttributeType } from "../types";