@beinformed/ui 1.60.5 → 1.61.0

package/src/models/content/__tests__/formalsource-toc.json

@@ -0,0 +1,119 @@
+{
+  "content": {
+    "filter": {
+      "booleanfilter": {
+        "param": "complete",
+        "name": "complete",
+        "value": "false"
+      },
+      "stringfilter": {
+        "param": "searchTerm",
+        "name": "searchTerm"
+      },
+      "entryDate": {
+        "param": "entryDate",
+        "name": "entryDate",
+        "value": "2025-05-28"
+      }
+    },
+    "_links": {
+      "self": {
+        "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource"
+      },
+      "api_doc": {
+        "href": "/api-docs/v3/content/(content-identifier)"
+      },
+      "contributions": {
+        "href": "/contributions/content/(content-identifier)"
+      }
+    },
+    "label": "Grant Funding Agreement - Terms and Conditions",
+    "sections": [
+      {
+        "_links": {
+          "self": {
+            "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter1"
+          }
+        },
+        "_id": "Chapter1",
+        "label": "1. Introduction"
+      },
+      {
+        "_links": {
+          "self": {
+            "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter2"
+          }
+        },
+        "_id": "Chapter2",
+        "label": "2. Grant Offer",
+        "sections": [
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter2_1"
+              }
+            },
+            "_id": "Chapter2_1",
+            "label": "2.1 Payment of Grant"
+          },
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter2_2"
+              }
+            },
+            "_id": "Chapter2_2",
+            "label": "2.2 Purpose of Funding"
+          }
+        ]
+      },
+      {
+        "_links": {
+          "self": {
+            "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter3"
+          }
+        },
+        "_id": "Chapter3",
+        "label": "3. Amount of Grant"
+      },
+      {
+        "_links": {
+          "self": {
+            "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter4"
+          }
+        },
+        "_id": "Chapter4",
+        "label": "4. Purpose of Grant"
+      },
+      {
+        "_links": {
+          "self": {
+            "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter5"
+          }
+        },
+        "_id": "Chapter5",
+        "label": "5. Eligibility of Grant",
+        "sections": [
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter5_1"
+              }
+            },
+            "_id": "Chapter5_1",
+            "label": "5.1 Eligibility Criteria"
+          }
+        ]
+      },
+      {
+        "_links": {
+          "self": {
+            "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/AnnexA"
+          }
+        },
+        "_id": "AnnexA",
+        "label": "Annex A. Innovation levels research grant projects"
+      }
+    ]
+  }
+}

package/src/models/form/FormObjectModel.js

@@ -18,8 +18,19 @@ import type {
 import LayoutHintCollection from "../layouthint/LayoutHintCollection";
 
 import type LinkModel from "../links/LinkModel";
-import type { MessageParameters } from "../../i18n";
 import type ErrorResponse from "../error/ErrorResponse";
+import type { MessageParameters } from "../../i18n";
+
+type ErrorObject = {
+  anchor: {
+    objectid: string,
+    elementid?: string,
+  },
+  id: string,
+  message: string,
+  properties: MessageParameters,
+  layouthint: Array<string>,
+};
 
 /**
  * Form Object
@@ -474,22 +485,12 @@ export default class FormObjectModel extends BaseModel {
   /**
    * Convert error json from a form service to validation messages on the form object and attributes
    */
-  handleErrorValidations(
-    errors: Array<{
-      anchor: {
-        objectid: string,
-        elementid?: string,
-      },
-      id: string,
-      message: string,
-      properties: MessageParameters,
-      layouthint: Array<string>,
-    }>,
-  ) {
+  handleErrorValidations(errors: Array<ErrorObject>) {
     const attributeErrors = [];
 
-    errors.forEach((error) => {
-      if (error.anchor?.objectid === this.key) {
+    errors
+      .filter((error) => error.anchor?.objectid === this.key)
+      .forEach((error) => {
         if (has(error.anchor, "elementid")) {
           attributeErrors.push(error);
         } else {
@@ -500,8 +501,7 @@ export default class FormObjectModel extends BaseModel {
             new LayoutHintCollection(error.layouthint),
           );
         }
-      }
-    });
+      });
 
     this.attributeCollection.updateValidations(attributeErrors);
   }
@@ -509,15 +509,18 @@ export default class FormObjectModel extends BaseModel {
   /**
    * Convert missing json from a form service to mandatory validation constraints and messages
    */
-  handleMissingValidations(missing: {
-    anchors: Array<
-      | {
-          elements: Array<{ elementid: string }>,
-          objectid?: string,
-        }
-      | { anchor: { elementid: string, objectid?: string } },
-    >,
-  }) {
+  handleMissingValidations(
+    missing: {
+      anchors: Array<
+        | {
+            elements: Array<{ elementid: string }>,
+            objectid?: string,
+          }
+        | { anchor: { elementid: string, objectid?: string } },
+      >,
+    },
+    errors: Array<ErrorObject>,
+  ) {
     const attributeErrors = [];
 
     for (const anchor of missing.anchors) {
@@ -538,6 +541,17 @@ export default class FormObjectModel extends BaseModel {
       }
     }
 
+    errors
+      .filter(
+        (error) =>
+          error.id === "Constraint.Mandatory" &&
+          error.anchor?.objectid === this.key &&
+          has(error.anchor, "elementid"),
+      )
+      .forEach((error) => {
+        attributeErrors.push(error);
+      });
+
     this.attributeCollection.updateValidations(attributeErrors);
   }
 
@@ -552,7 +566,7 @@ export default class FormObjectModel extends BaseModel {
 
     // missing attribute errors
     if (Array.isArray(data.missing?.anchors)) {
-      this.handleMissingValidations(data.missing);
+      this.handleMissingValidations(data.missing, data.errors);
     }
 
     this.dynamicValidationsLoaded = true;

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

@@ -0,0 +1,79 @@
+import { ModularUIResponse } from "../../../modularui";
+
+import initialData from "./FormValidationDataInitial.json";
+import contributions from "./FormValidationContributions.json";
+import updateData from "./FormValidationDataUpdate1.json";
+import updateData2 from "./FormValidationDataUpdate2.json";
+
+import FormModel from "../FormModel";
+
+describe("Form validation update", () => {
+  it("should be able to update the validations of a form", () => {
+    const response = ModularUIResponse.create({
+      key: "Form",
+      data: initialData,
+      contributions: contributions,
+    });
+
+    const form = new FormModel(response);
+    const formModel = form.currentFormObject;
+
+    const validation = formModel.getAttributeByKey("Validation");
+    const compareWith = formModel.getAttributeByKey("CompareWith");
+    const optional = formModel.getAttributeByKey("ThisOneIsOptional");
+
+    expect(validation.mandatory).toBe(true);
+    expect(compareWith.mandatory).toBe(true);
+    expect(optional.mandatory).toBe(false);
+
+    const newForm = form.clone();
+    newForm.currentFormObject.updateAttribute(validation, "test");
+
+    expect(validation.mandatory).toBe(true);
+    expect(compareWith.mandatory).toBe(true);
+    expect(optional.mandatory).toBe(false);
+
+    const updateResponse = ModularUIResponse.create({
+      key: "Form",
+      data: updateData,
+      contributions: contributions,
+    });
+    const updateForm = new FormModel(updateResponse);
+
+    newForm.updateValidations(updateForm.data);
+
+    expect(
+      newForm.currentFormObject.getAttributeByKey("Validation").mandatory,
+    ).toBe(true);
+    expect(
+      newForm.currentFormObject.getAttributeByKey("CompareWith").mandatory,
+    ).toBe(true);
+    expect(
+      newForm.currentFormObject.getAttributeByKey("ThisOneIsOptional")
+        .mandatory,
+    ).toBe(false);
+
+    const newForm2 = form.clone();
+    newForm2.currentFormObject.updateAttribute(validation, "");
+
+    const update2Response = ModularUIResponse.create({
+      key: "Form",
+      data: updateData2,
+      contributions: contributions,
+    });
+    const update2Form = new FormModel(update2Response);
+
+    newForm.updateValidations(update2Form.data);
+
+    expect(
+      newForm.currentFormObject.getAttributeByKey("Validation").mandatory,
+    ).toBe(true);
+    expect(
+      newForm.currentFormObject.getAttributeByKey("CompareWith").mandatory,
+    ).toBe(true);
+    expect(
+      newForm.currentFormObject.getAttributeByKey("ThisOneIsOptional")
+        .mandatory,
+    ).toBe(false);
+  });
+});

package/src/models/form/__tests__/FormValidationContributions.json

@@ -0,0 +1,45 @@
+{
+  "ValidationMakesItOptional": {
+    "label": "Validation makes it optional",
+    "resourcetype": "Form",
+    "actiontype": "form",
+    "objects": {
+      "ValidationMakesItOptional": {
+        "dynamicObject": false,
+        "repeatable": false,
+        "dynamicValidations": true,
+        "label": "Validation makes it optional",
+        "mandatory": true,
+        "attributes": [
+          {
+            "Validation": {
+              "type": "string",
+              "label": "Validation",
+              "mandatory": true,
+              "displaysize": 50,
+              "maxLength": 255
+            }
+          },
+          {
+            "CompareWith": {
+              "type": "string",
+              "label": "Compare with",
+              "mandatory": true,
+              "displaysize": 50,
+              "maxLength": 255
+            }
+          },
+          {
+            "ThisOneIsOptional": {
+              "type": "string",
+              "label": "This one is optional",
+              "mandatory": false,
+              "displaysize": 50,
+              "maxLength": 255
+            }
+          }
+        ]
+      }
+    }
+  }
+}

package/src/models/form/__tests__/FormValidationDataInitial.json

@@ -0,0 +1,33 @@
+{
+  "formresponse": {
+    "_links": {
+      "self": {
+        "href": "/all-cases/validation-makes/validation-makes-it-optional"
+      },
+      "api_doc": {
+        "href": "/api-docs/v3/all-cases/validation-makes/validation-makes-it-optional"
+      },
+      "contributions": {
+        "href": "/contributions/all-cases/validation-makes/validation-makes-it-optional"
+      }
+    },
+    "missing": {
+      "anchors": [
+        {
+          "objectid": "ValidationMakesItOptional",
+          "elements": [
+            {
+              "elementid": "Validation"
+            },
+            {
+              "elementid": "CompareWith"
+            },
+            {
+              "elementid": "ThisOneIsOptional"
+            }
+          ]
+        }
+      ]
+    }
+  }
+}

package/src/models/form/__tests__/FormValidationDataUpdate1.json

@@ -0,0 +1,25 @@
+{
+  "formresponse": {
+    "_links": {
+      "self": {
+        "href": "/all-cases/validation-makes/validation-makes-it-optional"
+      },
+      "api_doc": {
+        "href": "/api-docs/v3/all-cases/validation-makes/validation-makes-it-optional"
+      },
+      "contributions": {
+        "href": "/contributions/all-cases/validation-makes/validation-makes-it-optional"
+      }
+    },
+    "errors": [
+      {
+        "anchor": {
+          "objectid": "ValidationMakesItOptional",
+          "elementid": "CompareWith"
+        },
+        "id": "Constraint.Mandatory",
+        "message": "Field is mandatory"
+      }
+    ]
+  }
+}

package/src/models/form/__tests__/FormValidationDataUpdate2.json

@@ -0,0 +1,33 @@
+{
+  "formresponse": {
+    "_links": {
+      "self": {
+        "href": "/all-cases/validation-makes/validation-makes-it-optional"
+      },
+      "api_doc": {
+        "href": "/api-docs/v3/all-cases/validation-makes/validation-makes-it-optional"
+      },
+      "contributions": {
+        "href": "/contributions/all-cases/validation-makes/validation-makes-it-optional"
+      }
+    },
+    "missing": {
+      "anchors": [
+        {
+          "objectid": "ValidationMakesItOptional",
+          "elementid": "Validation"
+        }
+      ]
+    },
+    "errors": [
+      {
+        "anchor": {
+          "objectid": "ValidationMakesItOptional",
+          "elementid": "CompareWith"
+        },
+        "id": "Constraint.Mandatory",
+        "message": "Field is mandatory"
+      }
+    ]
+  }
+}

package/src/redux/_modularui/ModularUIActions.js

@@ -81,9 +81,10 @@ export const resetModularUI = (): ResetModularUIAction => ({
 export const updateStatus = (
   key: string,
   status: $Keys<typeof MODULARUI_STATUS>,
+  requestOptions: any,
 ): UpdateStatusAction => ({
   type: "MODULARUI/STATUS",
-  payload: { key, status },
+  payload: { key, status, requestOptions },
 });
 
 /**
@@ -177,13 +178,31 @@ export const loadModularUI =
     key: string,
     href: Href | string,
     options?: RequestModularUIOptions,
+    retryCount: number = 3,
+    retryDelay: number = 200,
   ): ThunkAction =>
   (dispatch: Dispatch, getState) => {
     const modularuiStore = getState()?.modularui;
-    if (
-      modularuiStore &&
-      modularuiStore[key]?.status === MODULARUI_STATUS.LOADING
-    ) {
+    const currentRequest = modularuiStore?.[key];
+
+    const isLoading = currentRequest?.status === MODULARUI_STATUS.LOADING;
+
+    if (isLoading) {
+      const isDifferentRequest =
+        currentRequest.requestOptions?.href?.toString() !== href.toString();
+      if (isDifferentRequest && retryCount > 0) {
+        return new Promise((resolve) => {
+          setTimeout(() => {
+            resolve(
+              dispatch(
+                loadModularUI(key, href, options, retryCount - 1, retryDelay),
+              ),
+            );
+          }, retryDelay);
+        });
+      }
+
+      // Same request is already loading — do nothing
       return Promise.resolve();
     }
 

package/src/redux/_modularui/ModularUIMiddleware.js

@@ -150,7 +150,7 @@ const handleFetch = (
 
   const modularuiRequest = createRequest(requestOptions);
 
-  dispatch(updateStatus(key, MODULARUI_STATUS.LOADING));
+  dispatch(updateStatus(key, MODULARUI_STATUS.LOADING, requestOptions));
 
   return modularuiRequest
     .fetch()

package/src/redux/_modularui/ModularUIReducer.js

@@ -11,7 +11,15 @@ import type { ModularUIModel } from "../../models";
  */
 const updateStatus = (
   state: ModularUIState,
-  { key, status }: { key: string, status: $Keys<typeof MODULARUI_STATUS> },
+  {
+    key,
+    status,
+    requestOptions,
+  }: {
+    key: string,
+    status: $Keys<typeof MODULARUI_STATUS>,
+    requestOptions: any,
+  },
 ) => {
   // model should always be available when status is not loading
   if (status !== MODULARUI_STATUS.LOADING && !state[key]) {
@@ -24,6 +32,7 @@ const updateStatus = (
       ...state[key],
       status,
       lastModification: Date.now(),
+      requestOptions: requestOptions || state[key]?.requestOptions,
     },
   };
 };

package/src/redux/_modularui/__tests__/actions.spec.js

@@ -72,7 +72,11 @@ describe("modularui actions", () => {
     expect(store.getActions()).toStrictEqual([
       {
         type: "MODULARUI/STATUS",
-        payload: { key: "application", status: MODULARUI_STATUS.LOADING },
+        payload: {
+          key: "application",
+          status: MODULARUI_STATUS.LOADING,
+          requestOptions: undefined,
+        },
       },
     ]);
   });

package/src/redux/_modularui/types.js

@@ -21,6 +21,7 @@ export type ModelEntry = {
   +status: string,
   +model: ModularUIModel,
   +lastModification: number,
+  +requestOptions?: any,
 };
 
 export type ModularUIState = {
@@ -111,6 +112,7 @@ export type UpdateStatusAction = {
   payload: {
     key: string,
     status: $Keys<MODULARUI_STATUS>,
+    requestOptions: any,
   },
 };
 

package/src/utils/helpers/text.js

@@ -10,7 +10,7 @@ export const retrieveText = (
   text:
     | string
     | { id?: string, message: string, properties?: { [key: string]: any } },
-): string => {
+): string | null => {
   if (typeof text === "string") {
     return text;
   }
@@ -19,5 +19,5 @@ export const retrieveText = (
     return text.message;
   }
 
-  return "";
+  return null;
 };