VIA-299 SB extract data for warning callout component fro content API response.

Author: acerathereinspirative-nhs-nvir

src/services/content-api/parsers/content-filter-service.test.ts

@@ -11,13 +11,14 @@ import {
 } from "@src/services/content-api/parsers/content-filter-service";
 import {
   ContentApiVaccineResponse,
+  HeadingWithContent,
   MainEntityOfPage,
   VaccinePageContent,
   VaccinePageSection,
   VaccinePageSubsection,
 } from "@src/services/content-api/types";
 import { genericVaccineContentAPIResponse } from "@test-data/content-api/data";
-import { contentWithoutBenefitsHealthAspect } from "@test-data/content-api/helpers";
+import { contentWithoutBenefitsHealthAspect, contentWithoutCallout } from "@test-data/content-api/helpers";
 
 describe("Content Filter", () => {
   describe("_extractDescriptionForVaccine", () => {
@@ -693,5 +694,30 @@ describe("Content Filter", () => {
 
       expect(pageCopyForFlu.whatVaccineIsFor).toBeUndefined();
     });
+
+    it("should return all parts for callout section", () => {
+      const expectedCallout: HeadingWithContent = {
+        heading: "Callout heading",
+        content: "<p>Callout content</p>",
+      };
+
+      const pageCopyForRsv: VaccinePageContent = getFilteredContentForVaccine(
+        VaccineType.RSV,
+        JSON.stringify(genericVaccineContentAPIResponse),
+      );
+
+      expect(pageCopyForRsv.callout).toEqual(expectedCallout);
+    });
+
+    it("should not return callout section when Callout is missing", () => {
+      const responseWithoutCallout = contentWithoutCallout();
+
+      const pageCopyForFlu: VaccinePageContent = getFilteredContentForVaccine(
+        VaccineType.RSV,
+        JSON.stringify(responseWithoutCallout),
+      );
+
+      expect(pageCopyForFlu.callout).toBeUndefined();
+    });
   });
 });

src/services/content-api/parsers/content-filter-service.ts

@@ -3,6 +3,7 @@ import { getFilteredContentForWhoopingCoughVaccine } from "@src/services/content
 import {
   ContentApiVaccineResponse,
   HasPartSubsection,
+  HeadingWithContent,
   MainEntityOfPage,
   Overview,
   VaccinePageContent,
@@ -113,6 +114,45 @@ const _extractAnyOtherSubsection = (part: HasPartSubsection): VaccinePageSubsect
   };
 };
 
+const _findCalloutElement = (response: ContentApiVaccineResponse): HasPartSubsection | undefined => {
+  for (const section of response.mainEntityOfPage) {
+    if (section.hasPart && Array.isArray(section.hasPart)) {
+      const callout = section.hasPart.find((element) => element.name === "Callout");
+      if (callout) {
+        return callout;
+      }
+    }
+  }
+  return undefined;
+};
+
+function _hasCallout(response: ContentApiVaccineResponse): boolean {
+  return !!_findCalloutElement(response);
+}
+
+function _extractCalloutHeading(response: ContentApiVaccineResponse): string {
+  const calloutElement = _findCalloutElement(response);
+
+  if (!calloutElement || !calloutElement.text) {
+    return "";
+  }
+
+  const match = calloutElement.text.match(/<h3>(.*?)<\/h3>/);
+  return match ? match[1] : "";
+}
+
+function _extractCalloutContent(response: ContentApiVaccineResponse): string {
+  const calloutElement = _findCalloutElement(response);
+
+  if (!calloutElement || !calloutElement.text) {
+    return "";
+  }
+
+  const content = calloutElement.text.replace(/<h3>.*?<\/h3>/, "").trim();
+
+  return content;
+}
+
 const _removeExcludedHyperlinks = (subsections: VaccinePageSubsection[]) => {
   const nbsHyperlinkPattern: RegExp =
     /<a [^>]*?href="[^>]*?\/nhs-services\/vaccination-and-booking-services\/book-[^>]*?>(.*?)<\/a>/g;
@@ -208,6 +248,11 @@ const getFilteredContentForStandardVaccine = (apiContent: string): VaccinePageCo
     subsections: _extractPartsForAspect(content, "SideEffectsHealthAspect"),
   };
 
+  let callout: HeadingWithContent | undefined;
+  if (_hasCallout(content)) {
+    callout = { heading: _extractCalloutHeading(content), content: _extractCalloutContent(content) };
+  }
+
   const webpageLink: URL = new URL(content.webpage);
 
   return {
@@ -217,6 +262,7 @@ const getFilteredContentForStandardVaccine = (apiContent: string): VaccinePageCo
     howToGetVaccine,
     vaccineSideEffects,
     webpageLink,
+    callout,
   };
 };
 

src/services/content-api/types.ts

@@ -109,6 +109,7 @@ export type VaccinePageContent = {
   howToGetVaccine: VaccinePageSection;
   vaccineSideEffects: VaccinePageSection;
   webpageLink: URL;
+  callout?: HeadingWithContent;
 };
 
 export type StyledPageSection = {
@@ -128,6 +129,7 @@ export type StyledVaccineContent = {
   howToGetVaccine: StyledPageSection;
   vaccineSideEffects: StyledPageSection;
   webpageLink: URL;
+  callout?: HeadingWithContent;
 };
 
 export type ContentApiVaccinationsResponse = {

test-data/content-api/data.tsx

@@ -554,6 +554,20 @@ export const genericVaccineContentAPIResponse: ContentApiVaccineResponse = {
         },
       ],
     },
+    {
+      identifier: "0",
+      name: "section heading",
+      position: 1,
+      "@type": "WebPageElement",
+      hasPart: [
+        {
+          position: 0,
+          "@type": "WebPageElement",
+          name: "Callout",
+          text: "<h3>Callout heading</h3><p>Callout content</p>",
+        },
+      ],
+    },
   ],
   webpage: new URL("https://www.nhs.uk/vaccinations/generic-vaccine/"),
 };

test-data/content-api/helpers.ts

@@ -11,4 +11,21 @@ const contentWithoutBenefitsHealthAspect = () => {
   return responseWithoutBenefitsHealthAspect;
 };
 
-export { contentWithoutBenefitsHealthAspect };
+const contentWithoutCallout = (): ContentApiVaccineResponse => {
+  const responseWithoutCallout: ContentApiVaccineResponse = {
+    ...genericVaccineContentAPIResponse,
+    mainEntityOfPage: genericVaccineContentAPIResponse.mainEntityOfPage.map((section) => {
+      // Callouts are nested deep inside 'section heading' elements
+      if (section.hasPart && Array.isArray(section.hasPart)) {
+        return {
+          ...section,
+          hasPart: section.hasPart.filter((element) => element.name !== "Callout"),
+        };
+      }
+      return section;
+    }),
+  };
+  return responseWithoutCallout;
+};
+
+export { contentWithoutBenefitsHealthAspect, contentWithoutCallout };