@beinformed/ui 1.65.12 → 1.65.14

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

@@ -1,122 +0,0 @@
-{
-  "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)"
-      },
-      "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"
-          }
-        },
-        "_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/contentconfiguration/ContentConfiguration.js

@@ -1,70 +0,0 @@
-// @flow
-import ContentConfigurationQuestions from "./ContentConfigurationQuestions";
-import ContentConfigurationResults from "./ContentConfigurationResults";
-import ContentConfigurationEndResults from "./ContentConfigurationEndResults";
-
-/**
- * Content definition for questions, results, given answers etc.
- * Mostly maps to the Instrument questions configuration of Be Informed
- */
-export default class ContentConfiguration {
-  _config: Object;
-
-  /**
-   */
-  constructor(contentConfiguration: Object) {
-    this._config = contentConfiguration || null;
-  }
-
-  /**
-   */
-  get questions(): null | ContentConfigurationQuestions {
-    if (this._config === null || !this._config.questions) {
-      return null;
-    }
-
-    return new ContentConfigurationQuestions(this._config.questions);
-  }
-
-  /**
-   */
-  isConfiguredIntermediateResultAttribute(attributeKey: string): boolean {
-    if (this.intermediateResults === null) {
-      return false;
-    }
-
-    return this.intermediateResults.attributes.includes(attributeKey);
-  }
-
-  /**
-   */
-  get intermediateResults(): null | ContentConfigurationResults {
-    if (this._config === null || !this._config.intermediateResults) {
-      return null;
-    }
-
-    return new ContentConfigurationResults(this._config.intermediateResults);
-  }
-
-  /**
-   */
-  isConfiguredEndResultAttribute(attributeKey: string): boolean {
-    if (this.endResults === null) {
-      return false;
-    }
-
-    return this.endResults.config.some((item) =>
-      item.attributes.includes(attributeKey),
-    );
-  }
-
-  /**
-   */
-  get endResults(): null | ContentConfigurationEndResults {
-    if (this._config === null || !this._config.results) {
-      return null;
-    }
-
-    return new ContentConfigurationEndResults(this._config.results);
-  }
-}

package/src/models/contentconfiguration/ContentConfigurationElements.js

@@ -1,152 +0,0 @@
-// @flow
-import LayoutHintCollection from "../layouthint/LayoutHintCollection";
-
-/**
- * Get element configuration of instrument questions
- */
-class ContentConfigurationElements {
-  _hasConfiguration: boolean;
-  _elementConfiguration: Array<Object>;
-
-  /**
-   */
-  constructor(elementConfiguration: ?Array<Object>) {
-    this._hasConfiguration = elementConfiguration != null;
-    this._elementConfiguration =
-      elementConfiguration == null ? [] : elementConfiguration;
-  }
-
-  /**
-   */
-  includeLayoutHints(hints: Array<string>): ContentConfigurationElements {
-    const contentIncludeLayoutHint = this._elementConfiguration.filter(
-      (elementConfig) => {
-        const [key] = Object.keys(elementConfig);
-        const config = elementConfig[key];
-
-        if (!config || !config.layouthint) {
-          return false;
-        }
-
-        return config.layouthint.some((hint) => hints.includes(hint));
-      },
-    );
-
-    return new ContentConfigurationElements(contentIncludeLayoutHint);
-  }
-
-  /**
-   */
-  excludeLayoutHints(hints: Array<string>): ContentConfigurationElements {
-    const contentExcludeLayoutHint = this._elementConfiguration.filter(
-      (elementConfig) => {
-        const [key] = Object.keys(elementConfig);
-        const config = elementConfig[key];
-
-        if (!config) {
-          return false;
-        } else if (!config.layouthint) {
-          return true;
-        }
-
-        return !config.layouthint.some((hint) => hints.includes(hint));
-      },
-    );
-
-    return new ContentConfigurationElements(contentExcludeLayoutHint);
-  }
-
-  /**
-   */
-  get config(): Array<Object> {
-    return this._elementConfiguration.map((elementConfig) => {
-      const [key] = Object.keys(elementConfig);
-      const config = elementConfig[key];
-
-      if (!config) {
-        return {};
-      }
-
-      return {
-        type: key,
-        label: config.label,
-        types:
-          config.labelTypes ||
-          config.propertyTypes ||
-          config.sectionReferenceTypes ||
-          config.textFragmentTypes,
-        layouthint: new LayoutHintCollection(config.layouthint),
-        icon: config.icon || "",
-      };
-    });
-  }
-
-  /**
-   */
-  hasConfig(): boolean {
-    return this._hasConfiguration;
-  }
-
-  /**
-   */
-  hasContent(): boolean {
-    return this.config.some(
-      (configElement) => configElement.type === "contentElement",
-    );
-  }
-
-  /**
-   * Retrieve if the configuration has an element that has a specific layouthint,
-   * makes it easy to indicate that the content needs to be presented in a certain way.
-   */
-  hasLayoutHint(hint: string): boolean {
-    return this.config.some((configElement) =>
-      configElement.layouthint.has(hint),
-    );
-  }
-
-  /**
-   * Returns config elements by given types
-   */
-  byTypes(types: Array<string> = []): Array<Object> {
-    if (!types || types.length === 0) {
-      return this.config;
-    }
-
-    return this.config.filter((config) => types.includes(config.type));
-  }
-
-  /**
-   * Get label config elements
-   */
-  get labelConfig(): Array<Object> {
-    return this.config.filter((config) => config.type === "labelElement");
-  }
-
-  /**
-   * Get all section reference types
-   */
-  getAllSectionReferenceTypes(): Array<any> {
-    const sectionReferences = [];
-
-    this.config
-      .filter((item) => item.type === "contentElement")
-      .forEach((item) => {
-        sectionReferences.push(...item.types);
-      });
-
-    return sectionReferences;
-  }
-
-  /**
-   * Retrieve all content element configuration by content type
-   */
-  getContentElementConfigBySectionReferenceType(type: string): Array<Object> {
-    return this.config.filter(
-      (config) =>
-        config.type === "contentElement" && config.types.includes(type),
-    );
-  }
-}
-
-export default ContentConfigurationElements;

package/src/models/contentconfiguration/ContentConfigurationEndResults.js

@@ -1,45 +0,0 @@
-// @flow
-import ContentConfigurationResults from "./ContentConfigurationResults";
-
-/**
- */
-class ContentConfigurationEndResults {
-  _configuration: Array<Object>;
-
-  /**
-   */
-  constructor(configuration: Array<Object>) {
-    this._configuration = configuration || [];
-  }
-
-  /**
-   */
-  get config(): Array<ContentConfigurationResults> {
-    return this._configuration
-      .filter((configElement) => {
-        const [key] = Object.keys(configElement);
-
-        return (
-          key === "decisionResult" ||
-          key === "classificationResult" ||
-          key === "calculatorResult"
-        );
-      })
-      .map((configElement) => {
-        const [key] = Object.keys(configElement);
-        return new ContentConfigurationResults(configElement[key]);
-      });
-  }
-
-  /**
-   */
-  getContentConfigurationElementsForAttribute(
-    attributeKey: string,
-  ): ContentConfigurationResults | null {
-    return (
-      this.config.find((item) => item.attributes.includes(attributeKey)) || null
-    );
-  }
-}
-
-export default ContentConfigurationEndResults;

package/src/models/contentconfiguration/ContentConfigurationQuestions.js

@@ -1,60 +0,0 @@
-// @flow
-import ContentConfigurationElements from "./ContentConfigurationElements";
-
-/**
- */
-class ContentConfigurationQuestions {
-  _configuration: Object;
-
-  /**
-   */
-  constructor(configuration: Object) {
-    this._configuration = configuration || null;
-  }
-
-  /**
-   */
-  hasConfig(): boolean {
-    return (
-      this.question.hasConfig() ||
-      this.options.hasConfig() ||
-      this.answers.hasConfig()
-    );
-  }
-
-  /**
-   */
-  get question(): ContentConfigurationElements {
-    if (this._configuration === null) {
-      return new ContentConfigurationElements([]);
-    }
-
-    return new ContentConfigurationElements(
-      this._configuration.questionElements,
-    );
-  }
-
-  /**
-   */
-  get options(): ContentConfigurationElements {
-    if (this._configuration === null) {
-      return new ContentConfigurationElements([]);
-    }
-
-    return new ContentConfigurationElements(this._configuration.optionElements);
-  }
-
-  /**
-   */
-  get answers(): ContentConfigurationElements {
-    if (this._configuration === null) {
-      return new ContentConfigurationElements([]);
-    }
-
-    return new ContentConfigurationElements(
-      this._configuration.givenAnswerElements,
-    );
-  }
-}
-
-export default ContentConfigurationQuestions;

package/src/models/contentconfiguration/ContentConfigurationResults.js

@@ -1,105 +0,0 @@
-// @flow
-import ContentConfigurationElements from "./ContentConfigurationElements";
-import LayoutHintCollection from "../layouthint/LayoutHintCollection";
-import { isPlainObject } from "../../utils";
-
-/**
- */
-class ContentConfigurationResults {
-  _configuration: Object;
-  _layouthint: LayoutHintCollection;
-
-  /**
-   */
-  constructor(configuration: Object) {
-    this._configuration = configuration || null;
-
-    this._layouthint = new LayoutHintCollection(configuration?.layouthint);
-  }
-
-  /**
-   */
-  get label(): string | null {
-    if (this._configuration === null) {
-      return null;
-    }
-
-    return this._configuration.label;
-  }
-
-  /**
-   */
-  get description(): string | null {
-    if (this._configuration === null) {
-      return null;
-    }
-
-    const description = this._configuration.description;
-    if (isPlainObject(description) && "message" in description) {
-      return description.message;
-    }
-
-    return description;
-  }
-
-  /**
-   */
-  get attributes(): Array<string> {
-    if (this._configuration === null) {
-      return [];
-    }
-
-    // An issue with mapped attributes is giving us the wrong attribute keys in the attributes property
-    // as a temporary fix a layouthint with the correct mapped attribute key can be set in the configuration of the end results
-    return [
-      ...this._configuration.attributes,
-      ...this.layouthint.all
-        .filter((hint) => hint.includes("attribute:"))
-        .map((hint) => hint.substring("attribute:".length)),
-    ];
-  }
-
-  /**
-   */
-  getFormConfigElement(elementKey: string): ContentConfigurationElements {
-    if (this._configuration === null) {
-      return new ContentConfigurationElements([]);
-    }
-
-    const configElement = this._configuration[elementKey];
-
-    return new ContentConfigurationElements(configElement);
-  }
-
-  /**
-   */
-  get calculatedResultElements(): ContentConfigurationElements {
-    return this.getFormConfigElement("calculatedResultElements");
-  }
-
-  /**
-   */
-  get positiveResultElements(): ContentConfigurationElements {
-    return this.getFormConfigElement("positiveResultElements");
-  }
-
-  /**
-   */
-  get negativeResultElements(): ContentConfigurationElements {
-    return this.getFormConfigElement("negativeResultElements");
-  }
-
-  /**
-   */
-  get resultElements(): ContentConfigurationElements {
-    return this.getFormConfigElement("resultElements");
-  }
-
-  /**
-   */
-  get layouthint(): LayoutHintCollection {
-    return this._layouthint;
-  }
-}
-
-export default ContentConfigurationResults;

package/src/models/contentconfiguration/__tests__/ContentConfigurationElements.spec.js

@@ -1,29 +0,0 @@
-import ContentConfigurationElements from "../ContentConfigurationElements";
-
-describe("contentConfigurationElements", () => {
-  it("should be able to create an instance of ContentConfigurationElements", () => {
-    const contentConfigElement = new ContentConfigurationElements();
-
-    expect(contentConfigElement).toBeInstanceOf(ContentConfigurationElements);
-  });
-
-  it("can exclude content by layouthint", () => {
-    const contentConfigElement = new ContentConfigurationElements([
-      { labelElement: { labelTypes: ["LongLabel"] } },
-      {
-        contentElement: {
-          sectionReferenceTypes: ["crDescription"],
-          layouthint: ["render-section-label", "POPUP"],
-        },
-      },
-    ]);
-
-    expect(contentConfigElement.config).toHaveLength(2);
-
-    const excludedLayouthint = contentConfigElement.excludeLayoutHints([
-      "POPUP",
-    ]);
-
-    expect(excludedLayouthint.config).toHaveLength(1);
-  });
-});

package/src/models/contentconfiguration/__tests__/ContentConfigurationResults.spec.js

@@ -1,101 +0,0 @@
-import ContentConfigurationResults from "../ContentConfigurationResults";
-import ContentConfigurationElements from "../ContentConfigurationElements";
-import LayoutHintCollection from "../../layouthint/LayoutHintCollection";
-
-describe("contentConfigurationResults", () => {
-  it("should be able to create an instance of ContentConfigurationResults", () => {
-    const contentConfigurationResults = new ContentConfigurationResults();
-
-    expect(contentConfigurationResults).toBeInstanceOf(
-      ContentConfigurationResults,
-    );
-    expect(contentConfigurationResults.label).toBeNull();
-    expect(contentConfigurationResults.description).toBeNull();
-    expect(contentConfigurationResults.attributes).toStrictEqual([]);
-    expect(contentConfigurationResults.getFormConfigElement()).toBeInstanceOf(
-      ContentConfigurationElements,
-    );
-    expect(contentConfigurationResults.calculatedResultElements).toBeInstanceOf(
-      ContentConfigurationElements,
-    );
-    expect(contentConfigurationResults.positiveResultElements).toBeInstanceOf(
-      ContentConfigurationElements,
-    );
-    expect(contentConfigurationResults.negativeResultElements).toBeInstanceOf(
-      ContentConfigurationElements,
-    );
-    expect(contentConfigurationResults.resultElements).toBeInstanceOf(
-      ContentConfigurationElements,
-    );
-    expect(contentConfigurationResults.layouthint).toBeInstanceOf(
-      LayoutHintCollection,
-    );
-  });
-
-  it("can handle configuration with description object", () => {
-    const message =
-      "<p>The property value is ${EstimatedPropertyValue} and my personal deposit is ${MortgageDeposit}. The mortgage is a repayment mortgage for a term of ${MortgageTermInYears} years. The rate type is ${InterestRateType} for a period of ${PeriodOfInterestRate}.</p>";
-
-    const contributions = {
-      label: "Total cost of mortgage",
-      description: {
-        id: "CalculatorResults.TotalCostOfMortgage.introText",
-        message,
-      },
-      layouthint: ["render-description:TotalCostOfMortgage"],
-      attributes: ["TotalCostOfMortgage"],
-      resultElements: [
-        {
-          labelElement: {
-            label: "Result label",
-            labelTypes: ["ResultLabel"],
-          },
-        },
-      ],
-    };
-
-    const contentConfigurationResults = new ContentConfigurationResults(
-      contributions,
-    );
-
-    expect(contentConfigurationResults.label).toBe("Total cost of mortgage");
-    expect(contentConfigurationResults.description).toBe(message);
-    expect(contentConfigurationResults.attributes).toStrictEqual([
-      "TotalCostOfMortgage",
-    ]);
-    expect(
-      contentConfigurationResults.calculatedResultElements.hasConfig(),
-    ).toBe(false);
-    expect(contentConfigurationResults.positiveResultElements.hasConfig()).toBe(
-      false,
-    );
-    expect(contentConfigurationResults.negativeResultElements.hasConfig()).toBe(
-      false,
-    );
-    expect(contentConfigurationResults.resultElements.hasConfig()).toBe(true);
-    expect(
-      contentConfigurationResults.resultElements.labelConfig,
-    ).toStrictEqual([
-      {
-        icon: "",
-        label: "Result label",
-        layouthint: new LayoutHintCollection(),
-        type: "labelElement",
-        types: ["ResultLabel"],
-      },
-    ]);
-  });
-
-  it("can handle configuration with description string", () => {
-    const message =
-      "<p>The property value is ${EstimatedPropertyValue} and my personal deposit is ${MortgageDeposit}. The mortgage is a repayment mortgage for a term of ${MortgageTermInYears} years. The rate type is ${InterestRateType} for a period of ${PeriodOfInterestRate}.</p>";
-
-    const contentConfigurationResults = new ContentConfigurationResults({
-      label: "Total cost of mortgage",
-      description: message,
-    });
-
-    expect(contentConfigurationResults.label).toBe("Total cost of mortgage");
-    expect(contentConfigurationResults.description).toBe(message);
-  });
-});