VIA-226 JS Refactor to module style and add recursive check

Author: james-salt4-nhs

pact/all.pact.ts

@@ -1,10 +1,10 @@
 import axios, { AxiosResponse } from "axios";
 import dotenv from 'dotenv';
-import { matchRSVResponse } from "./pact-helpers";
+import { matchRSVResponse } from "./helpers";
 
 describe('Content API', () => {
   beforeAll(async () => {
-    dotenv.config({path: ".env.local"});  // Load environment variables from .env file
+    dotenv.config({path: ".env.local"});
   });
 
   test("vaccineContent contract", async () => {

pact/helpers/Matchers.ts

@@ -0,0 +1,3 @@
+export const dateMatcher = (actual: string) => {
+  expect(Date.parse(actual)).not.toBeNaN();
+}

pact/helpers/index.ts

@@ -0,0 +1 @@
+export { matchContentAPIResponse as matchRSVResponse } from "./model/ContentAPIResponse";

pact/helpers/model/Breadcrumb.ts

@@ -0,0 +1,28 @@
+export type BreadcrumbListItem = {
+  "@type": "ListItem";
+  "position": number;
+  "item": {
+    "@id": string;
+    "name": string;
+    "genre": string[];
+  }
+}
+
+export type Breadcrumb = {
+  "@context": "http://schema.org";
+  "@type": "BreadcrumbList";
+  "itemListElement": BreadcrumbListItem[];
+}
+
+export const matchBreadcrumbListItem = (actual: BreadcrumbListItem, position: number) => {
+  expect(actual["position"]).toBe(position);
+}
+
+export const matchBreadcrumb = (actual: Breadcrumb) => {
+  expect(actual["itemListElement"].length).not.toBe(0);
+  let cur;
+  for (let i = 0; i < actual["itemListElement"].length; i++) {
+    cur = actual["itemListElement"][i];
+    matchBreadcrumbListItem(cur, i);
+  }
+}

pact/helpers/model/ContentAPIResponse.ts

@@ -0,0 +1,76 @@
+import { Breadcrumb, matchBreadcrumb } from "./Breadcrumb";
+import { HealthTopicContent } from "./HealthTopicContent";
+import { LinkRole, matchRelatedLink } from "./LinkRole";
+import { matchWebPageElement, WebPageElement } from "./WebPageElement";
+import { dateMatcher } from "../Matchers";
+
+export type ContentAPIResponse = {
+  "@context": "http://schema.org";
+  "@type": "MedicalWebPage";
+  "name": "RSV vaccine";
+  "copyrightHolder": {
+    "@type": "Organization";
+    "name": "Crown Copyright";
+  }
+  "license": "https://developer.api.nhs.uk/terms";
+  "author": {
+    "url": "https://www.nhs.uk";
+    "logo": "https://assets.nhs.uk/nhsuk-cms/images/nhs-attribution.width-510.png";
+    "email": "[email protected]";
+    "@type": "Organization";
+    "name": "NHS website";
+  }
+  "about": {
+    "name": "RSV vaccine";
+    "@type": "WebPage";
+    "alternatename": ["Respiratory syncytial virus (RSV) vaccine"];
+  }
+  "description": string;
+  "url": string
+  "genre": ["Vaccine"];
+  "keywords": "";
+  "dateModified": string;
+  "lastReviewed": string[];
+  "breadcrumb": Breadcrumb;
+  "hasPart": HealthTopicContent[];
+  "relatedLink": LinkRole[];
+  "contentSubTypes": [];
+  "mainEntityOfPage": WebPageElement[]
+}
+
+export const matchMainEntityOfPage = (actual: WebPageElement[]) => {
+  let outer;
+  expect(actual.length).toBeGreaterThanOrEqual(1);
+  for (let i = 0; i < actual.length; i++) {
+    outer = actual[i];
+    matchWebPageElement(outer, i);
+  }
+}
+
+export const matchParts = (actual: HealthTopicContent[]) => {
+  expect(actual.length).not.toBe(0);
+  let outer, inner;
+  for (let i = 0; i < actual.length; i++) {
+    outer = actual[i];
+    expect(outer["@type"]).toBe("HealthTopicContent");
+    expect(actual[i].hasPart.length).not.toBe(0);
+    for (let j = 0; j < outer["hasPart"].length; j++) {
+      inner = outer["hasPart"][j];
+      expect(inner["@type"]).toBe("WebPageElement");
+    }
+  }
+}
+
+export const matchLastReviewed = (actual: string[]) => {
+  expect(actual.length).not.toBe(0);
+  for (const dateString in actual) dateMatcher(dateString);
+}
+
+export const matchContentAPIResponse = (actual: ContentAPIResponse) => {
+  dateMatcher(actual["dateModified"]);
+  matchBreadcrumb(actual["breadcrumb"]);
+  matchLastReviewed(actual["lastReviewed"]);
+  matchParts(actual["hasPart"]);
+  matchRelatedLink(actual.relatedLink)
+  matchMainEntityOfPage(actual["mainEntityOfPage"]);
+}

pact/helpers/model/HealthTopicContent.ts

@@ -0,0 +1,10 @@
+import { WebPageElement } from "@project/pact/helpers/model/WebPageElement";
+
+export type HealthTopicContent = {
+  "@type": string;
+  "hasHealthAspect": string;
+  "url": string;
+  "description": string;
+  "hasPart": WebPageElement[];
+  "headline": string;
+}

pact/helpers/model/LinkRole.ts

@@ -0,0 +1,17 @@
+export type LinkRole = {
+  "@type": string;
+  "url": string;
+  "name": string;
+  "linkRelationship": string;
+  "position": number;
+}
+
+export const matchRelatedLink = (actual: LinkRole[]) => {
+  let outer;
+  expect(actual.length).not.toBe(0);
+  for (let i = 0; i < actual.length; i++) {
+    outer = actual[i];
+    expect(outer["@type"]).toBe("LinkRole");
+    expect(outer["position"]).toBe(i);
+  }
+}

pact/helpers/model/WebPageElement.ts

@@ -0,0 +1,20 @@
+export type WebPageElement = {
+  "@type": string;
+  "text": string;
+  "headline"?: string;
+  "position"?: number;
+  "identifier"?: number;
+  "name"?: "lead paragraph" | "section heading" | "markdown";
+  "mainEntityOfPage"?: WebPageElement[];
+}
+
+export const matchWebPageElement = (actual: WebPageElement, position: number) => {
+  if (actual.position) expect(actual.position).toBe(position);
+  if (actual.position) expect(actual.identifier).toBeDefined();
+  if (actual.identifier) expect(actual.position).toBeDefined();
+  if (actual.mainEntityOfPage) {
+    for (let i = 0; i < actual.mainEntityOfPage.length; i++) {
+      matchWebPageElement(actual.mainEntityOfPage[i], i);
+    }
+  }
+}