@beinformed/ui 1.60.6 → 1.61.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beinformed/ui",
-  "version": "1.60.6",
+  "version": "1.61.1",
   "description": "Toolbox for be informed javascript layouts",
   "license": "SEE LICENSE IN LICENSE.md",
   "bugs": "https://support.beinformed.com",
@@ -68,9 +68,9 @@
     "styled-components": "^5.0.0"
   },
   "dependencies": {
-    "@babel/runtime-corejs3": "^7.27.0",
+    "@babel/runtime-corejs3": "^7.27.4",
     "@date-fns/tz": "^1.2.0",
-    "big.js": "^6.2.2",
+    "big.js": "^7.0.1",
     "date-fns": "^4.1.0",
     "deepmerge": "^4.3.1",
     "dequal": "^2.0.3",
@@ -86,18 +86,18 @@
     "timezone-soft": "^1.5.2"
   },
   "devDependencies": {
-    "@babel/cli": "^7.27.0",
-    "@babel/core": "^7.26.10",
-    "@babel/eslint-parser": "^7.27.0",
-    "@babel/eslint-plugin": "^7.27.0",
+    "@babel/cli": "^7.27.2",
+    "@babel/core": "^7.27.4",
+    "@babel/eslint-parser": "^7.27.1",
+    "@babel/eslint-plugin": "^7.27.1",
     "@babel/plugin-proposal-class-properties": "^7.18.6",
     "@babel/plugin-syntax-dynamic-import": "^7.8.3",
-    "@babel/plugin-transform-runtime": "^7.26.10",
-    "@babel/preset-env": "^7.26.9",
-    "@babel/preset-flow": "^7.25.9",
-    "@babel/preset-react": "^7.26.3",
-    "@commitlint/cli": "^19.8.0",
-    "@commitlint/config-conventional": "^19.8.0",
+    "@babel/plugin-transform-runtime": "^7.27.4",
+    "@babel/preset-env": "^7.27.2",
+    "@babel/preset-flow": "^7.27.1",
+    "@babel/preset-react": "^7.27.1",
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
     "@testing-library/dom": "^10.4.0",
     "@testing-library/react": "^16.3.0",
     "auditjs": "^4.0.46",
@@ -108,18 +108,18 @@
     "cross-env": "^7.0.3",
     "documentation": "^14.0.2",
     "eslint": "^8.57.0",
-    "eslint-config-prettier": "^10.1.2",
+    "eslint-config-prettier": "^10.1.5",
     "eslint-plugin-babel": "^5.3.1",
     "eslint-plugin-ft-flow": "^3.0.11",
-    "eslint-plugin-jest": "^28.11.0",
-    "eslint-plugin-jsdoc": "^50.6.9",
+    "eslint-plugin-jest": "^28.12.0",
+    "eslint-plugin-jsdoc": "^50.7.1",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-you-dont-need-lodash-underscore": "^6.14.0",
     "flow-bin": "^0.200.1",
     "flow-copy-source": "^2.0.9",
     "flow-typed": "^3.9.0",
-    "hermes-eslint": "^0.28.0",
+    "hermes-eslint": "^0.28.1",
     "history": "^4.0.0",
     "husky": "^9.1.7",
     "jest": "^29.7.0",

package/src/models/attributes/AttributeContent.js

@@ -86,7 +86,7 @@ class AttributeContent {
                 layouthint: new LayoutHintCollection(layouthint),
                 textfragments: textfragments.map((textfragment) => ({
                   ...textfragment,
-                  text: retrieveText(textfragment.text),
+                  text: retrieveText(textfragment.text) || "",
                 })),
               },
             };

package/src/models/content/ContentTOCModel.js

@@ -7,11 +7,12 @@ import ContentLinkModel from "./ContentLinkModel";
 import ContentTypeModel from "./ContentTypeModel";
 import Href from "../href/Href";
 
-import { TIMEVERSION_FILTER_NAME } from "../../constants/Constants";
+import SectionModel from "./SectionModel";
 
+import { TIMEVERSION_FILTER_NAME } from "../../constants/Constants";
+import type LinkModel from "../links/LinkModel";
 import type { ModelOptions, ModularUIModel } from "../types";
 import type { ModularUIResponse } from "../../modularui";
-import type LinkModel from "../links/LinkModel";
 
 /**
  * Get content items recursively
@@ -34,6 +35,9 @@ const getItems = (
     if (item.items) {
       link.items = getItems(item.items, entryDate, modelOptions);
     }
+    if (item.sections) {
+      link.items = getItems(item.sections, entryDate, modelOptions);
+    }
 
     return link;
   });
@@ -60,10 +64,7 @@ export default class ContentTOCModel extends ResourceModel {
   /**
    */
   static isApplicableModel(data: ModularUIResponse): boolean {
-    return (
-      data.contributions.resourcetype &&
-      data.contributions.resourcetype === "ContentTOC"
-    );
+    return data.contributions?.resourcetype === "ContentTOC";
   }
 
   /**
@@ -120,9 +121,27 @@ export default class ContentTOCModel extends ResourceModel {
    * Get sub items of toc
    */
   get items(): Array<ContentLinkModel> {
-    return this.data.items
-      ? getItems(this.data.items, this.entryDate, this.modelOptions)
-      : [];
+    if (this.data.items) {
+      return getItems(this.data.items, this.entryDate, this.modelOptions);
+    }
+
+    if (this.data.sections) {
+      return getItems(this.data.sections, this.entryDate, this.modelOptions);
+    }
+
+    return [];
+  }
+
+  /**
+   */
+  get sections(): Array<SectionModel> {
+    if (this.data.sections) {
+      return this.data.sections.map(
+        (section) =>
+          new SectionModel(section, this.entryDate, this.modelOptions),
+      );
+    }
+    return [];
   }
 
   /**
@@ -182,4 +201,12 @@ export default class ContentTOCModel extends ResourceModel {
 
     return timeversionFilter?.attribute?.value ?? null;
   }
+
+  /**
+   */
+  get isCompleteSource(): boolean {
+    const completeFilter =
+      this.filterCollection.getFilterByAttributeKey("complete");
+    return completeFilter?.attribute?.value === "true";
+  }
 }

package/src/models/content/SectionModel.js

@@ -164,6 +164,17 @@ class SectionModel extends BaseModel {
     this._childSections = sections || [];
   }
 
+  /**
+   */
+  get sections(): Array<SectionModel> {
+    if (this.data.sections) {
+      return this.data.sections.map(
+        (section) =>
+          new SectionModel(section, this.entryDate, this.modelOptions),
+      );
+    }
+    return [];
+  }
   /**
    * Get sub sections
    */

package/src/models/content/SubSectionModel.js

@@ -49,7 +49,7 @@ export default class SubSectionModel extends BaseModel {
   /**
    * Retrieve html body
    */
-  get body(): string {
+  get body(): string | null {
     const body = this.getData("body", "");
     return retrieveText(body);
   }

package/src/models/content/__tests__/Formalsource.spec.js

@@ -0,0 +1,91 @@
+import { ModularUIResponse } from "../../../modularui";
+
+import toc from "./formalsource-toc.json";
+import complete from "./formalsource-complete.json";
+import contributions from "./formalsource-contributions.json";
+
+import section from "./formalsource-section.json";
+import sectionContributions from "./formalsource-section-contributions.json";
+
+import ContentTOCModel from "../ContentTOCModel";
+import ContentModel from "../ContentModel";
+
+describe("formalsource", () => {
+  it("TOC model", () => {
+    const response = ModularUIResponse.create({
+      key: "contentmodel",
+      data: toc,
+      contributions,
+    });
+
+    const tocModel = new ContentTOCModel(response);
+
+    expect(tocModel).toBeInstanceOf(ContentTOCModel);
+
+    expect(tocModel.label).toBe(
+      "Grant Funding Agreement - Terms and Conditions",
+    );
+
+    expect(tocModel.items).toHaveLength(6);
+    expect(tocModel.items[0].items).toBeUndefined();
+    expect(tocModel.items[1].items).toHaveLength(2);
+
+    expect(tocModel.isCompleteSource).toBe(false);
+
+    const firstSection = tocModel.items[0];
+    expect(firstSection.label).toBe("1. Introduction");
+  });
+
+  it("Complete model", () => {
+    const response = ModularUIResponse.create({
+      key: "contentmodel",
+      data: complete,
+      contributions,
+    });
+
+    const completeModel = new ContentTOCModel(response);
+
+    expect(completeModel).toBeInstanceOf(ContentTOCModel);
+
+    expect(completeModel.items).toHaveLength(6);
+    expect(completeModel.items[0].items).toBeUndefined();
+    expect(completeModel.items[1].items).toHaveLength(2);
+
+    expect(completeModel.sections).toHaveLength(6);
+    expect(completeModel.sections[0].sections).toHaveLength(0);
+    expect(completeModel.sections[1].sections).toHaveLength(2);
+
+    expect(completeModel.isCompleteSource).toBe(true);
+
+    const firstSection = completeModel.sections[0];
+    expect(firstSection.label).toBe("Introduction");
+    expect(firstSection.number).toBe("1.");
+    expect(firstSection.body).toBe(null);
+    expect(firstSection.subSections).toHaveLength(3);
+    expect(firstSection.subSections[0].body).toHaveLength(169);
+
+    const secondSection = completeModel.sections[1];
+    expect(secondSection.label).toBe("Grant Offer");
+    expect(secondSection.number).toBe("2.");
+    expect(secondSection.body).toBe(null);
+    expect(secondSection.sections[0].label).toBe("Payment of Grant");
+    expect(secondSection.sections[0].number).toBe("2.1");
+    expect(secondSection.sections[0].body).toHaveLength(222);
+  });
+
+  it("Section model", () => {
+    const response = ModularUIResponse.create({
+      key: "contentmodel",
+      data: section,
+      contributions: sectionContributions,
+    });
+    const sectionModel = new ContentModel(response);
+
+    expect(sectionModel.label).toBe("Grant Offer");
+    expect(sectionModel.number).toBe("2.");
+    expect(sectionModel.body).toBe(null);
+    expect(sectionModel.subSections).toHaveLength(0);
+
+    expect(sectionModel.childSectionLinks).toHaveLength(2);
+  });
+});

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

@@ -0,0 +1,234 @@
+{
+  "content": {
+    "filter": {
+      "complete": {
+        "param": "complete",
+        "name": "complete",
+        "value": "true"
+      },
+      "searchTerm": {
+        "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)"
+      },
+      "relatedConcepts": {
+        "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/relatedConcepts"
+      }
+    },
+    "label": "Grant Funding Agreement - Terms and Conditions",
+    "sections": [
+      {
+        "_links": {
+          "self": {
+            "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter1"
+          }
+        },
+        "label": "Introduction",
+        "number": "1.",
+        "subSections": [
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter1#Chapter1_1"
+              }
+            },
+            "body": "<p>This document sets the Terms and Conditions of the Grant Funding Agreement and should be read in conjunction with the Grant Offer Letter and all relevant annexes.<\/p>"
+          },
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter1#Chapter1_2"
+              }
+            },
+            "body": "<p>This agreement does not give rise to contractual relations.<\/p>"
+          },
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter1#Chapter1_3"
+              }
+            },
+            "body": "<p>This agreement has been revised following wide consultation with Departmental strategic partners and is intended to replace any previous versions.<\/p>"
+          }
+        ]
+      },
+      {
+        "_links": {
+          "self": {
+            "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter2"
+          }
+        },
+        "label": "Grant Offer",
+        "number": "2.",
+        "sections": [
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter2_1"
+              }
+            },
+            "label": "Payment of Grant",
+            "number": "2.1",
+            "body": "<p>Payment of the grant is subject to you complying with these Terms and Conditions together with Annex F of the Grant Offer Letter and to such further conditions and requirements that we may from time to time specify.<\/p>"
+          },
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter2_2"
+              }
+            },
+            "label": "Purpose of Funding",
+            "number": "2.2",
+            "body": "<p>The grant will be paid only in respect of Eligible Expenditure incurred by you to deliver the funded activities. The grant must not be used to fund activities that may be partly-political in intention, use or presentation, or to propagate a religion or belief.<\/p>"
+          }
+        ]
+      },
+      {
+        "_links": {
+          "self": {
+            "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter3"
+          }
+        },
+        "label": "Amount of Grant",
+        "number": "3.",
+        "body": "<p>The maximum amount of the grant will be stipulated in the Grant Offer Letter; if subsequent years are to be funded, we will send you a formal statement of the amount of grant funding approved for the subsequent years. The amount of grant to be paid in any financial year will be decided by us after considering your estimates of income and expenditure in respect of the grant funded activities as set out in Annex F. The grant reimburses 100% of the agreed actions and activities eligible costs.<\/p>"
+      },
+      {
+        "_links": {
+          "self": {
+            "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter4"
+          }
+        },
+        "label": "Purpose of Grant",
+        "number": "4.",
+        "body": "<p>The purpose of the Research Grant is to support research activity in a topic area relevant to research practices. The research supported is to increase the evidence base for research and can cover a breadth of topics not limited to the following examples: relevant clinical areas (e.g. brain injury), research practices, sectors and settings, health economics.<\/p>"
+      },
+      {
+        "_links": {
+          "self": {
+            "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter5"
+          }
+        },
+        "label": "Eligibility of Grant",
+        "number": "5.",
+        "sections": [
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter5_1"
+              }
+            },
+            "label": "Eligibility Criteria",
+            "number": "5.1",
+            "body": "<p>Applications will need to meet the following eligibility criteria:<\/p>",
+            "subSections": [
+              {
+                "_links": {
+                  "self": {
+                    "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter5_1#Chapter5_1a"
+                  }
+                },
+                "number": "a.",
+                "body": "<p>The research project can be classified as innovative. This includes innovation levels 2 and 3 as described in Annex A.<\/p>"
+              },
+              {
+                "_links": {
+                  "self": {
+                    "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter5_1#Chapter5_1b"
+                  }
+                },
+                "number": "b.",
+                "body": "<p>The research project contributes to open source, which includes the following projects:<\/p>",
+                "subSections": [
+                  {
+                    "_links": {
+                      "self": {
+                        "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter5_1#Chapter5_1b1"
+                      }
+                    },
+                    "body": "<p>The product within the research project leads to new open source software artifacts.<\/p>"
+                  },
+                  {
+                    "_links": {
+                      "self": {
+                        "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter5_1#Chapter5_1b2"
+                      }
+                    },
+                    "body": "<p>The product creates software artifacts which will advance the discussion on open source contribution.<\/p>"
+                  },
+                  {
+                    "_links": {
+                      "self": {
+                        "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/Chapter5_1#Chapter5_1b3"
+                      }
+                    },
+                    "body": "<p>The product within the research project leads to patches for existing open source software artifacts.<\/p>"
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "_links": {
+          "self": {
+            "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/AnnexA"
+          }
+        },
+        "label": "Innovation levels research grant projects",
+        "number": "Annex A.",
+        "body": "<p>The following criteria are applied for innovation levels used for research grant applications.<\/p>",
+        "subSections": [
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/AnnexA#AnnexA_1"
+              }
+            },
+            "body": "<p>Level 3 innovation is the highest level. It implies that the product radically reinvents the future of certain human activities.<\/p>"
+          },
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/AnnexA#AnnexA_2"
+              }
+            },
+            "body": "<p>Level 2 innovation is the second highest level. It implies that the product substantially improves products, insights or methods.<\/p>"
+          },
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/AnnexA#AnnexA_3"
+              }
+            },
+            "body": "<p>Both level 2 and level 3 innovations are excluded by products which are likely to end up collecting dust on a shelf.<\/p>"
+          },
+          {
+            "_links": {
+              "self": {
+                "href": "/content/bundle-com.beinformed.source.GrantFundingAgreementTermsandConditions/Grant%20Funding%20Agreement.formalsource/AnnexA#AnnexA_4"
+              }
+            },
+            "body": "<p>Level 1 innovations only require the product to incrementally improves products, insights or methods.<\/p>"
+          }
+        ]
+      }
+    ]
+  }
+}

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

@@ -0,0 +1,110 @@
+{
+  "source": {
+    "label": "content",
+    "resourcetype": "Content",
+    "filter": [
+      {
+        "complete": {
+          "type": "choicefilter",
+          "label": "complete",
+          "layouthint": ["radiobutton"],
+          "multiplechoice": false,
+          "optionMode": "static",
+          "options": [
+            {
+              "key": "true",
+              "label": "Yes"
+            },
+            {
+              "key": "false",
+              "label": "No"
+            }
+          ]
+        }
+      },
+      {
+        "searchTerm": {
+          "type": "stringfilter",
+          "label": "searchTerm",
+          "multiplechoice": false
+        }
+      },
+      {
+        "entryDate": {
+          "type": "datefilter",
+          "label": "Entry date",
+          "format": "dd-MM-yyyy",
+          "formatlabel": "dd-mm-yyyy",
+          "operator": "greater-than-or-equal"
+        }
+      }
+    ],
+    "metadata": {
+      "contentIdentifier": {
+        "type": "string",
+        "label": "content identifier"
+      }
+    },
+    "attributes": [
+      {
+        "label": {
+          "type": "string",
+          "label": "source label"
+        }
+      },
+      {
+        "_links": {
+          "attributes": []
+        }
+      },
+      {
+        "sections": {
+          "attributes": [
+            {
+              "_id": {
+                "type": "string",
+                "label": "section identifier"
+              }
+            },
+            {
+              "label": {
+                "type": "string",
+                "label": "section label"
+              }
+            },
+            {
+              "number": {
+                "type": "string",
+                "label": "section number"
+              }
+            },
+            {
+              "body": {
+                "type": "string",
+                "label": "section body"
+              }
+            }
+          ]
+        }
+      },
+      {
+        "categories": {
+          "attributes": [
+            {
+              "_id": {
+                "type": "string",
+                "label": "category identifier"
+              }
+            },
+            {
+              "label": {
+                "type": "string",
+                "label": "section label"
+              }
+            }
+          ]
+        }
+      }
+    ]
+  }
+}