NXT-163 Adjustments for new indev api data

johnholland-nice · johnholland-nice · commit 2a71ea679a35 · 2024-01-08T14:26:11.000Z
diff --git a/web/src/__mocks__/__data__/inDev/guidance/gid-dg10086/documents/empty-conversion/chapter/recommendations.json b/web/src/__mocks__/__data__/inDev/guidance/gid-dg10086/documents/empty-conversion/chapter/recommendations.json
@@ -1 +1 @@
-{"_links":{"self":[{}]},"eTag":"01000000-0000-0017-0000-000000000007","pdfLink":null,"content":null,"sections":[]}
+{"_links":{"self":[{}]},"eTag":"01000000-0000-0017-0000-000000000007","content":null,"pdfLink":null,"title":"","chapterTitle": "","chapters":[],"sections":[]}
diff --git a/web/src/__mocks__/__data__/inDev/guidance/gid-dg10086/documents/empty-conversion/html.json b/web/src/__mocks__/__data__/inDev/guidance/gid-dg10086/documents/empty-conversion/html.json
@@ -1 +1 @@
-{"_links":{"self":[{}]},"eTag":"01000000-0000-0017-0000-000000000007","pdfLink":null,"content":null,"sections":[]}
+{"_links":{"self":[{}]},"eTag":"01000000-0000-0017-0000-000000000007","content":null,"pdfLink":null,"title":"","chapterTitle": "","chapters":[],"sections":[]}
diff --git a/web/src/__mocks__/__data__/inDev/guidance/gid-dg10086/documents/final-scope-html-conversion/chapter/not-a-real-chapter.json b/web/src/__mocks__/__data__/inDev/guidance/gid-dg10086/documents/final-scope-html-conversion/chapter/not-a-real-chapter.json
@@ -1 +1 @@
-{"_links":{"self":[{}]},"eTag":"01000000-0000-0017-0000-000000000007","pdfLink":null,"content":null,"sections":[]}
+{"_links":{"self":[{}]},"eTag":"01000000-0000-0017-0000-000000000007","content":null,"pdfLink":null,"title":"","chapterTitle": "","chapters":[],"sections":[]}
diff --git a/web/src/__mocks__/__data__/inDev/guidance/gid-dg10086/documents/final-scope-html-conversion/chapter/recommendations.json b/web/src/__mocks__/__data__/inDev/guidance/gid-dg10086/documents/final-scope-html-conversion/chapter/recommendations.json
diff --git a/web/src/__mocks__/__data__/inDev/guidance/gid-dg10086/documents/final-scope-html-conversion/html.json b/web/src/__mocks__/__data__/inDev/guidance/gid-dg10086/documents/final-scope-html-conversion/html.json
@@ -3,7 +3,9 @@
   "eTag": "01000000-0000-0017-0000-000000000007",
   "content": "<div class=\"chapter\" title=\"Overview\" id=\"0-1-overview\" xmlns=\"http://www.w3.org/1999/xhtml\">\r\n  <h2 class=\"title\">\r\n    <a id=\"overview\" style=\"position:relative\" class=\"annotator-chapter\" data-heading-type=\"chapter\"></a>Overview<span class=\"annotator-adder\"></span></h2>\r\n  <p>This guideline covers care for women of any age (including girls and young women under 18) who request an abortion. It aims to improve the organisation of services and make them easier for women to access. Detailed recommendations on conducting abortions at different gestational stages are also included, to ensure that women get the safest and most effective care possible. </p>\r\n</div>",
   "pdfLink": "/guidance/GID-DG10086/documents/final-scope-pdf",
-  "sections": [
+  "title": "Some document title",
+  "chapterTitle": "Overview",
+  "chapters": [
     {
       "slug": "overview",
       "title": "Overview",
@@ -14,5 +16,11 @@
       "title": "Recommendations",
       "href": "/guidance/GID-DG10086/documents/final-scope-html-conversion/chapter/recommendations"
     }
+  ],
+  "sections": [
+    {
+      "slug": "0-1-who-is-it-for",
+      "title": "Who is it for?"
+    }
   ]
 }
diff --git a/web/src/components/ProjectDisplayWordConversion/ProjectDisplayWordConversion.test.tsx b/web/src/components/ProjectDisplayWordConversion/ProjectDisplayWordConversion.test.tsx
@@ -8,13 +8,14 @@ import {
 
 const props: ProjectDisplayWordConversionProps = {
 	content: mockConvertedDocumentFeed.content,
-	sections: mockConvertedDocumentFeed.sections,
+	chapters: mockConvertedDocumentFeed.chapters,
 	inPageNavLinks: [],
 	pdfLink: "/guidance/GID-DG10086/documents/final-scope-pdf",
 	currentChapter: "",
 	currentUrl:
 		"/guidance/topic-selection/gid-dg10086/documents/final-scope-html-conversion",
 	resourceFileTitle: "Test converted document",
+	sections: mockConvertedDocumentFeed.sections,
 };
 
 describe("ProjectDisplayWordConversion", () => {
@@ -29,7 +30,7 @@ describe("ProjectDisplayWordConversion", () => {
 		const { getAllByRole } = within(chapterNavList);
 		const chapterNavListItems = getAllByRole("listitem");
 		expect(chapterNavList).toBeInTheDocument();
-		expect(chapterNavListItems.length).toEqual(props.sections.length);
+		expect(chapterNavListItems.length).toEqual(props.chapters.length);
 	});
 
 	it("should render the first chapter menu item as active with index as slug", () => {
diff --git a/web/src/components/ProjectDisplayWordConversion/ProjectDisplayWordConversion.tsx b/web/src/components/ProjectDisplayWordConversion/ProjectDisplayWordConversion.tsx
@@ -26,12 +26,13 @@ export const ProjectDisplayWordConversion: FC<
 	ProjectDisplayWordConversionProps
 > = ({
 	content,
-	sections,
+	chapters,
 	inPageNavLinks,
 	pdfLink,
 	currentChapter,
 	currentUrl,
 	resourceFileTitle,
+	//sections,
 }) => {
 	// find chapter slug in url string
 	const currentUrlChapterSlugIndex = currentChapter
@@ -56,9 +57,9 @@ export const ProjectDisplayWordConversion: FC<
 			const chapterSlug =
 				prevOrNextArrayIndex === 0
 					? ""
-					: `/chapter/${sections[prevOrNextArrayIndex].slug}`;
+					: `/chapter/${chapters[prevOrNextArrayIndex].slug}`;
 			const prevOrNextObject = {
-				text: sections[prevOrNextArrayIndex].title,
+				text: chapters[prevOrNextArrayIndex].title,
 				destination: `${currentUrlNoChapter}${chapterSlug}`,
 				elementType: Link,
 			};
@@ -86,23 +87,23 @@ export const ProjectDisplayWordConversion: FC<
 					</Button>
 				)}
 				<StackedNav aria-label="chapters">
-					{sections.map((section, index) => {
-						const chapterSlug = index === 0 ? "" : `/chapter/${section.slug}`;
+					{chapters.map((chapter, index) => {
+						const chapterSlug = index === 0 ? "" : `/chapter/${chapter.slug}`;
 						const destination = `${currentUrlNoChapter}${chapterSlug}`;
 						const isCurrentChapter =
-							section.slug === currentChapter ||
+							chapter.slug === currentChapter ||
 							(currentChapter === "" && index === 0);
 
 						if (isCurrentChapter) currentChapterArrayIndex = index;
 
 						return (
 							<StackedNavLink
-								key={section.slug}
+								key={chapter.slug}
 								destination={destination}
 								elementType={Link}
 								isCurrent={isCurrentChapter}
 							>
-								{section.title}
+								{chapter.title}
 							</StackedNavLink>
 						);
 					})}
@@ -150,12 +151,12 @@ export const ProjectDisplayWordConversion: FC<
 				<PrevNext
 					{...generatePrevNextLinks(
 						currentChapterArrayIndex - 1,
-						sections.length,
+						chapters.length,
 						true
 					)}
 					{...generatePrevNextLinks(
 						currentChapterArrayIndex + 1,
-						sections.length,
+						chapters.length,
 						false
 					)}
 				/>
diff --git a/web/src/feeds/inDev/types.ts b/web/src/feeds/inDev/types.ts
@@ -627,12 +627,17 @@ export type resourceInPageNavLink = {
 	title: string;
 };
 
-export type niceIndevConvertedDocumentSection = {
+export type niceIndevConvertedDocumentChapter = {
 	slug: string;
 	title: string;
 	href: string;
 };
 
+export type niceIndevConvertedDocumentSection = {
+	slug: string;
+	title: string;
+};
+
 export type niceIndevConvertedDocument = {
 	_links?: {
 		self: [
@@ -641,8 +646,11 @@ export type niceIndevConvertedDocument = {
 			}
 		];
 	};
-	pdfLink: string | null;
 	eTag?: string | null;
 	content: string;
-	sections: niceIndevConvertedDocumentSection[];
+	pdfLink: string | null;
+	title?: string;
+	chapterTitle?: string;
+	chapters: niceIndevConvertedDocumentChapter[];
+	sections?: niceIndevConvertedDocumentSection[];
 };
diff --git a/web/src/pages/indicators/indevelopment/[slug]/documents/[resourceTitleId]/chapter/[chapterSlug].page.tsx b/web/src/pages/indicators/indevelopment/[slug]/documents/[resourceTitleId]/chapter/[chapterSlug].page.tsx
@@ -16,7 +16,7 @@ import {
 import {
 	IndevFileResource,
 	IndevSchedule,
-	niceIndevConvertedDocument,
+	niceIndevConvertedDocumentChapter,
 	niceIndevConvertedDocumentSection,
 	ProjectDetail,
 	resourceInPageNavLink,
@@ -39,8 +39,11 @@ export type DocumentsChapterHTMLPageProps = {
 		isConvertedDocument: boolean;
 		resourceFileHTML: string;
 		resourceFileChapters: {
-			allChapters: niceIndevConvertedDocumentSection[];
-			currentChapter: string;
+			allChapters: niceIndevConvertedDocumentChapter[];
+			currentChapter: {
+				title: string;
+				sections?: niceIndevConvertedDocumentSection[];
+			};
 			currentUrl: string;
 		};
 		resourceInPageNavLinks: resourceInPageNavLink[];
@@ -109,12 +112,13 @@ export default function DocumentsChapterHTMLPage({
 			{resource.isConvertedDocument ? (
 				<ProjectDisplayWordConversion
 					content={resource.resourceFileHTML}
-					sections={resource.resourceFileChapters.allChapters}
+					chapters={resource.resourceFileChapters.allChapters}
 					inPageNavLinks={resource.resourceInPageNavLinks}
 					pdfLink={resource.resourceFilePdfLink}
-					currentChapter={resource.resourceFileChapters.currentChapter}
+					currentChapter={resource.resourceFileChapters.currentChapter.title}
 					currentUrl={resource.resourceFileChapters.currentUrl}
 					resourceFileTitle={resource.resourceFileTitle}
+					sections={resource.resourceFileChapters.currentChapter.sections}
 				/>
 			) : (
 				<>
@@ -219,8 +223,11 @@ export const getServerSideProps: GetServerSideProps<
 	}
 
 	const resourceFileChapters = {
-		allChapters: resourceFileHTML.sections || [],
-		currentChapter: chapterSlug,
+		allChapters: resourceFileHTML.chapters || [],
+		currentChapter: {
+			title: chapterSlug,
+			sections: resourceFileHTML.sections,
+		},
 		currentUrl: `${projectPath}/documents/${params.resourceTitleId}`,
 	};
 
diff --git a/web/src/pages/indicators/indevelopment/[slug]/documents/[resourceTitleId]/index.page.tsx b/web/src/pages/indicators/indevelopment/[slug]/documents/[resourceTitleId]/index.page.tsx
@@ -16,7 +16,7 @@ import {
 import {
 	IndevFileResource,
 	IndevSchedule,
-	niceIndevConvertedDocument,
+	niceIndevConvertedDocumentChapter,
 	niceIndevConvertedDocumentSection,
 	ProjectDetail,
 	resourceInPageNavLink,
@@ -39,8 +39,11 @@ export type DocumentHTMLPageProps = {
 		isConvertedDocument: boolean;
 		resourceFileHTML: string;
 		resourceFileChapters: {
-			allChapters: niceIndevConvertedDocumentSection[];
-			currentChapter: string;
+			allChapters: niceIndevConvertedDocumentChapter[];
+			currentChapter: {
+				title: string;
+				sections?: niceIndevConvertedDocumentSection[];
+			};
 			currentUrl: string;
 		};
 		resourceInPageNavLinks: resourceInPageNavLink[];
@@ -109,12 +112,13 @@ export default function DocumentsHTMLPage({
 			{resource.isConvertedDocument ? (
 				<ProjectDisplayWordConversion
 					content={resource.resourceFileHTML}
-					sections={resource.resourceFileChapters.allChapters}
+					chapters={resource.resourceFileChapters.allChapters}
 					inPageNavLinks={resource.resourceInPageNavLinks}
 					pdfLink={resource.resourceFilePdfLink}
-					currentChapter={resource.resourceFileChapters.currentChapter}
+					currentChapter={resource.resourceFileChapters.currentChapter.title}
 					currentUrl={resource.resourceFileChapters.currentUrl}
 					resourceFileTitle={resource.resourceFileTitle}
+					sections={resource.resourceFileChapters.currentChapter.sections}
 				/>
 			) : (
 				<>
@@ -208,8 +212,11 @@ export const getServerSideProps: GetServerSideProps<
 	}
 
 	const resourceFileChapters = {
-		allChapters: resourceFileHTML.sections || [],
-		currentChapter: "",
+		allChapters: resourceFileHTML.chapters || [],
+		currentChapter: {
+			title: "",
+			sections: resourceFileHTML.sections,
+		},
 		currentUrl: `${projectPath}/documents/${params.resourceTitleId}`,
 	};
 

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{"_links":{"self":[{}]},"eTag":"01000000-0000-0017-0000-000000000007","pdfLink":null,"content":null,"sections":[]}`
	`1`	`+{"_links":{"self":[{}]},"eTag":"01000000-0000-0017-0000-000000000007","content":null,"pdfLink":null,"title":"","chapterTitle": "","chapters":[],"sections":[]}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,9 @@`
`3`	`3`	`"eTag": "01000000-0000-0017-0000-000000000007",`
`4`	`4`	"content": "<div class=\"chapter\" title=\"Overview\" id=\"0-1-overview\" xmlns=\"http://www.w3.org/1999/xhtml\">\r\n <h2 class=\"title\">\r\n <a id=\"overview\" style=\"position:relative\" class=\"annotator-chapter\" data-heading-type=\"chapter\"></a>Overview<span class=\"annotator-adder\"></span></h2>\r\n <p>This guideline covers care for women of any age (including girls and young women under 18) who request an abortion. It aims to improve the organisation of services and make them easier for women to access. Detailed recommendations on conducting abortions at different gestational stages are also included, to ensure that women get the safest and most effective care possible. </p>\r\n</div>",
`5`	`5`	`"pdfLink": "/guidance/GID-DG10086/documents/final-scope-pdf",`
`6`		`- "sections": [`
	`6`	`+ "title": "Some document title",`
	`7`	`+ "chapterTitle": "Overview",`
	`8`	`+ "chapters": [`
`7`	`9`	`{`
`8`	`10`	`"slug": "overview",`
`9`	`11`	`"title": "Overview",`
`@@ -14,5 +16,11 @@`
`14`	`16`	`"title": "Recommendations",`
`15`	`17`	`"href": "/guidance/GID-DG10086/documents/final-scope-html-conversion/chapter/recommendations"`
`16`	`18`	`}`
	`19`	`+ ],`
	`20`	`+ "sections": [`
	`21`	`+ {`
	`22`	`+ "slug": "0-1-who-is-it-for",`
	`23`	`+ "title": "Who is it for?"`
	`24`	`+ }`
`17`	`25`	`]`
`18`	`26`	`}`