@benwatsonuk/govuk-pages-plugin 1.0.0

package/test/data/outputs.ts

@@ -0,0 +1,197 @@
+export const getPagesTest = {
+    output: [
+    {
+        id: 1,
+        title: "Title 1",
+        type: "email",
+        description: "A description about item 1",
+        route: "/a/a/1",    
+        stage: {
+            main: "stage1",
+            subStage: 1,
+        }
+    },
+    {
+        id: 2,
+        title: 'Title 2',
+        type: 'email',
+        description: 'A description about item 2',
+        route: '/b/b/2',
+        stage: {
+            main: "stage2",
+            subStage: 2,
+        }
+    },
+    {
+        id: 3,
+        title: 'Title 3',
+        type: 'email',
+        description: 'A description about item 3',
+        route: '/a/b/3'
+    }
+    ]
+} 
+
+export const getStagesTest = {
+    output: [
+    {
+        id: "stage1",
+        title: "Stage 1",
+        description: "A description about stage 1",
+        route: "/a",
+        subStages: [
+            {
+            id: 1,
+            title: "Sub-stage 1-1",
+            description: "A description about sub-stage 1-1",
+            route: "/a/a",
+            },
+            {
+            id: 2,
+            title: "Sub-stage 1-2",
+            description: "A description about sub-stage 1-2",
+            route: "/a/b",
+            },
+        ],
+        },{
+        id: "stage2",
+        title: "Stage 2",
+        description: "A description about stage 2",
+        route: "/b",
+        subStages: [
+            {
+            id: 1,
+            title: "Sub-stage 2-1",
+            description: "A description about sub-stage 2-1",
+            route: "/b/a",
+            },
+            {
+            id: 2,
+            title: "Sub-stage 2-2",
+            description: "A description about sub-stage 2-2",
+            route: "/b/b",
+            },
+        ],
+    }
+]
+}
+
+export const getStagesWithPagesTestA = {
+    output: [
+   {
+        id: "unassigned",
+        title: "Unassigned",
+        description: "Pages not assigned to any stage or sub-stage",
+        pages: [
+            {
+            id: 1,
+            title: "Title 1",
+            type: "email",
+            description: "A description about item 1",
+            route: "/a/a/1",
+            },
+            {
+            id: 2,
+            title: "Title 2",
+            type: "email",
+            description: "A description about item 2",
+            route: "/a/b/2",
+            },
+        ],
+    }]
+}
+
+export const getStagesWithPagesTestB = {
+    output: [
+    {
+        id: "stage1",
+        title: "Stage 1",
+        description: "A description about stage 1",
+        subStages: [
+            {
+            id: 1,
+            title: "Sub-stage 1-1",
+            description: "A description about sub-stage 1-1",
+            pages: [
+                {
+                id: 1,
+                title: "Title 1",
+                type: "email",
+                description: "A description about item 1",
+                route: "/a/a/1",
+                stage: {
+                    main: "stage1",
+                    subStage: 1,
+                }
+                },
+            ],
+            }
+        ],
+        pages: [
+            {
+            id: 1,
+            title: "Title 1",
+            type: "email",
+            description: "A description about item 1",
+            route: "/a/a/1",
+            stage: {
+                main: "stage1",
+                subStage: 1,
+            }
+            },
+        ],
+    },
+    {
+        id: "stage2",
+        title: "Stage 2",
+        description: "A description about stage 2",
+        subStages: [
+            {
+            id: 2,
+            title: "Sub-stage 2-2",
+            description: "A description about sub-stage 2-2",
+            pages: [
+                {
+                id: 2,
+                title: "Title 2",
+                type: "email",
+                description: "A description about item 2",
+                route: "/b/b/2",
+                stage: {
+                    main: "stage2",
+                    subStage: 2,
+                }
+                },
+            ],
+            },
+            ],
+            pages: [
+                {
+                id: 2,
+                title: "Title 2",
+                type: "email",
+                description: "A description about item 2",
+                route: "/b/b/2",
+                stage: {
+                    main: "stage2",
+                    subStage: 2,
+                }
+                },
+            ],
+        },
+        {
+            id: "unassigned",
+            title: "Unassigned",
+            description: "Pages not assigned to any stage or sub-stage",
+            pages: [
+                {
+                id: 3,
+                title: "Title 3",
+                type: "email",
+                description: "A description about item 3",
+                route: "/a/b/3",
+                },
+            ],
+        }
+    ]
+}

package/test/data/pages.ts

@@ -0,0 +1,61 @@
+import { PagesArray } from '../../src/types.js';
+
+export const validPages: PagesArray = [
+  {
+    id: 1,
+    title: 'Title 1',
+    type: 'email',
+    description: 'A description about item 1',
+    route: '/a/a/1',
+    stage: {main: 'stage1', subStage: 1}
+  },
+  {
+    id: 2,
+    title: 'Title 2',
+    type: 'email',
+    description: 'A description about item 2',
+    route: '/b/b/2',
+    stage: {main: 'stage2', subStage: 2}
+  },
+  {
+    id: 3,
+    title: 'Title 3',
+    type: 'email',
+    description: 'A description about item 3',
+    route: '/a/b/3'
+  }
+];
+
+export const invalidPages: any = [
+  {
+    badValue: 1,
+    anotherBadValue: 'Title 1',
+    type: 'email',
+    description: 'A description about item 1',
+    route: '/a/a/1'
+  },
+  {
+    badValue: 2,
+    anotherBadValue: 'Title 2',
+    type: 'email',
+    description: 'A description about item 2',
+    route: '/a/b/2'
+  }
+];
+
+export const pagesWithNoStages: PagesArray = [
+  {
+    id: 1,
+    title: 'Title 1',
+    type: 'email',
+    description: 'A description about item 1',
+    route: '/a/a/1'
+  },
+  {
+    id: 2,
+    title: 'Title 2',
+    type: 'email',
+    description: 'A description about item 2',
+    route: '/a/b/2'
+  }
+];

package/test/data/stages.ts

@@ -0,0 +1,87 @@
+import { StagesArray } from '../../src/types.js';
+
+export const validStages: StagesArray = [
+  {
+    id: 'stage1',
+    title: 'Stage 1',
+    description: 'A description about stage 1',
+    route: '/a',
+    subStages: [
+      {
+        id: 1,
+        title: 'Sub-stage 1-1',
+        description: 'A description about sub-stage 1-1',
+        route: '/a/a'
+      },
+    {
+        id: 2,
+        title: 'Sub-stage 1-2',
+        description: 'A description about sub-stage 1-2',
+        route: '/a/b'
+      }
+    ]
+  },
+    {
+    id: 'stage2',
+    title: 'Stage 2',
+    description: 'A description about stage 2',
+    route: '/b',
+    subStages: [
+      {
+        id: 1,
+        title: 'Sub-stage 2-1',
+        description: 'A description about sub-stage 2-1',
+        route: '/b/a'
+      },
+    {
+        id: 2,
+        title: 'Sub-stage 2-2',
+        description: 'A description about sub-stage 2-2',
+        route: '/b/b'
+      }
+    ]
+  }
+];
+
+export const invalidStages: any = [
+  {
+    badValue: 'stage1',
+    anotherBadValue: 'Stage 1',
+    description: 'A description about stage 1',
+    route: '/a',
+    subStages: [
+      {
+        id: 1,
+        title: 'Sub-stage 1-1',
+        description: 'A description about sub-stage 1-1',
+        route: '/a/a'
+      },
+    {
+        id: 2,
+        title: 'Sub-stage 1-2',
+        description: 'A description about sub-stage 1-2',
+        route: '/a/b'
+      }
+    ]
+  },
+    {
+    id: 'stage2',
+    title: 'Stage 2',
+    description: 'A description about stage 2',
+    route: '/b',
+    subStages: [
+      {
+        id: 1,
+        title: 'Sub-stage 2-1',
+        description: 'A description about sub-stage 2-1',
+        route: '/b/a'
+      },
+    {
+        id: 2,
+        title: 'Sub-stage 2-2',
+        description: 'A description about sub-stage 2-2',
+        route: '/b/b'
+      }
+    ]
+  }
+];

package/test/getPages.test.js

@@ -0,0 +1,19 @@
+const expect = require('chai').expect
+
+const getPages = require('../src/functions/pages/getPages.ts')
+const {validPages, invalidPages} = require('./data/pages.ts')
+const outputs = require('./data/outputs.ts')
+
+describe('Basic getPages functions', () => {
+    describe('getPages', () => {
+      it('should return a simple array of pages when VALID pages JSON is provided', () => {
+        const result = getPages.getPages(validPages)
+        const output = outputs.getPagesTest.output
+        expect(result).to.eql(output)
+      })
+      
+      it('should return a useful error when INVALID pages JSON is provided', () => {
+        expect(() => getPages.getPages(invalidPages)).to.throw("Invalid array of PAGES passed to govuk-pages-plugin - please check the documentation to ensure the JSON schema you are passing matches what is expected")
+      })
+    });
+});

package/test/getStages.test.js

@@ -0,0 +1,46 @@
+const expect = require('chai').expect
+
+const getStages = require('../src/functions/stages/getStages.ts')
+const {validStages, invalidStages} = require('./data/stages.ts')
+const {validPages, invalidPages, pagesWithNoStages} = require('./data/pages.ts')
+const outputs = require('./data/outputs.ts')
+
+describe('Basic getStages functions', () => {
+    describe('getStages', () => {
+      it('should return a simple array of stages when VALID stages JSON is provided', () => {
+        const result = getStages.getStages(validStages)
+        const output = outputs.getStagesTest.output
+        expect(result).to.eql(output)
+      })
+
+      it('should return a useful error when INVALID stages JSON is provided', () => {
+        expect(() => getStages.getStages(invalidStages)).to.throw("Invalid array of STAGES passed to govuk-pages-plugin - please check the documentation to ensure the JSON schema you are passing matches what is expected")
+      })
+    });
+
+     describe('getStagesWithPages', () => {
+      it('should return an array of stages with pages inside when VALID stages and pages JSON are provided', () => {
+        const result = getStages.getStagesWithPages(validStages, validPages)
+        const output = outputs.getStagesWithPagesTestB.output
+        expect(result).to.eql(output)
+      })
+
+      it('should return an array with a single "Unassigned" stage with all unassigned pages inside when VALID stages and pages JSON are provided but pages have no parent stage', () => {
+        const result = getStages.getStagesWithPages(validStages, pagesWithNoStages)
+        const output = outputs.getStagesWithPagesTestA.output
+        expect(result).to.eql(output)
+      })
+
+      it('should return a useful error when INVALID stages but VALID pages JSON is provided', () => {
+        expect(() => getStages.getStagesWithPages(invalidStages, validPages)).to.throw("Invalid array of STAGES passed to govuk-pages-plugin - please check the documentation to ensure the JSON schema you are passing matches what is expected")
+      })
+
+      it('should return a useful error when INVALID stages and INVALID pages JSON is provided', () => {
+        expect(() => getStages.getStagesWithPages(invalidStages, invalidPages)).to.throw("Invalid array of STAGES passed to govuk-pages-plugin - please check the documentation to ensure the JSON schema you are passing matches what is expected")
+      })
+
+      it('should return a useful error when VALID stages and INVALID pages JSON is provided', () => {
+        expect(() => getStages.getStagesWithPages(validStages, invalidPages)).to.throw("Invalid array of PAGES passed to govuk-pages-plugin - please check the documentation to ensure the JSON schema you are passing matches what is expected")
+      })
+    });
+});

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2019",
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "declaration": false,
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "esModuleInterop": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src"]
+}