@benwatsonuk/govuk-pages-plugin 1.0.0

package/dist/assets/images/page-types/text-input.svg

@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="200px" height="160px" viewBox="0 0 200 160" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <!-- Generator: Sketch 52.5 (67469) - http://www.bohemiancoding.com/sketch -->
+    <title>Question page/Text input</title>
+    <desc>Created with Sketch.</desc>
+    <defs>
+        <rect x="2" y="4" width="8.99672131" height="8" id="rect-1"></rect>
+    </defs>
+    <g id="Symbols" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <g id="Screen/Question-page/Text-input">
+            <g id="Question-page/Text-input">
+                <g id="_Canvas/Browser">
+                    <rect id="BG" fill="#FFFFFF" x="1" y="1" width="196" height="156"></rect>
+                    <rect id="Top-Bar" fill="#F2F2F2" x="1" y="1" width="196" height="11"></rect>
+                    <rect id="Divider" fill="#DEE0E2" x="1" y="11" width="196" height="1"></rect>
+                    <path d="M7.96153846,8 C6.87821068,8 6,7.1045695 6,6 C6,4.8954305 6.87821068,4 7.96153846,4 C9.04486624,4 9.92307692,4.8954305 9.92307692,6 C9.92307692,7.1045695 9.04486624,8 7.96153846,8 Z M14.5,8 C13.4166722,8 12.5384615,7.1045695 12.5384615,6 C12.5384615,4.8954305 13.4166722,4 14.5,4 C15.5833278,4 16.4615385,4.8954305 16.4615385,6 C16.4615385,7.1045695 15.5833278,8 14.5,8 Z M21.0384615,8 C19.9551338,8 19.0769231,7.1045695 19.0769231,6 C19.0769231,4.8954305 19.9551338,4 21.0384615,4 C22.1217893,4 23,4.8954305 23,6 C23,7.1045695 22.1217893,8 21.0384615,8 Z" id="Combined-Shape" fill="#DEE0E2"></path>
+                    <polygon id="BG_Border_Top_2B99C93C-C2D2-47D8-92D7-E97EC61A7761" fill="#0B0C0C" points="0 0 200 0 197 1 1 1"></polygon>
+                    <polygon id="BG_Border_Right_2B99C93C-C2D2-47D8-92D7-E97EC61A7761" fill="#0B0C0C" points="200 0 200 160 197 157 197 1"></polygon>
+                    <polygon id="BG_Border_Bottom_2B99C93C-C2D2-47D8-92D7-E97EC61A7761" fill="#0B0C0C" points="200 160 0 160 1 157 197 157"></polygon>
+                    <polygon id="BG_Border_Left_2B99C93C-C2D2-47D8-92D7-E97EC61A7761" fill="#0B0C0C" points="0 160 0 0 1 1 1 157"></polygon>
+                </g>
+                <g id="Button/Primary" transform="translate(5.000000, 92.000000)" fill="#00823B">
+                    <g id="Fill/$button-colour">
+                        <rect id="Rectangle" x="0" y="0" width="32" height="8"></rect>
+                    </g>
+                </g>
+                <g id="Text/Heading/Large" transform="translate(5.000000, 44.000000)" fill="#0B0C0C">
+                    <g id="Fill/$text-colour">
+                        <rect id="Rectangle" x="0" y="0" width="120" height="12"></rect>
+                    </g>
+                </g>
+                <g id="Object/Header" transform="translate(3.000000, 12.000000)">
+                    <g id="👑Crown">
+                        <image x="2" y="4" width="8.99672131" height="8" xlink:href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEgAAABACAYAAAC5vjEqAAAABGdBTUEAALGOfPtRkwAAB/9JREFUeAHtmv913EYOx6V793+UCo7pYDsIr4JsB0dXcEoF4VWwuQrWHayvAm4qWHVAXQVyKlA+X2pAgdgZLi1Llmwv3oOAAb74MZghRev54uJM5wmcJ3CewOtN4PL1Sj9Uvr+/r9DEObq9vLy8zTm+GxsDauASNd/NIEobZTJXpenIV4r7ruwMossMafcWhvC3t9AEPfwv00fOloF9gyZuy8pvi3WVuUFVwExivO+b0xlGB9/BW3itDSIPsNEh2dYYtrCw3Tc3iNKGtFnYkwZwil5lQG/lHfRmf1v9vXTKp+wcdwVGfMHH3F7yrRE91qmnL/fBSVF9t+xgTz2LxS9RsB3sqWPhH7PhneMB6IsfMbAruIc9qeeXv6kU2fqqTtemFjUArktxPXI4ZaR0o14nz6KG+2RcNCCwOkA/7BQ+iG26US8jUnFfMOqNr5zw2qS4Mh/6Fh6x6DrxSOONxNHA4+bQK9jyTg4lYRFFmuCtp2eRlFRTc9RaIUDaVDzJjfm9BLfJJF2KVY3G8qG3mVzeVBv2yZJsuqZ2QpUlwlb5Shm9ETbFZtyDacAIZ4S1z4CHx8wwkmCaDM5M9QKMsJVwIulwnXjZzQK8huPJ++vd4c+RYoYiyF0OkGzDR+BDi0OTucfLwleGSxs6mCMjdwmjw439G7yzfBi2ZkxSMWvzZyUATbRErYJwqoHYqJKPm0Hv4CL54oA2RSC+gJ2BPv6WA6ShqydP6tkOsPWOoFe+5kQHOBd458Fg1cQ1XMNDYfOz3sElijeoLwGxTx4z1tpkiYYb5HrQQao39Tgenvys4/AwjdRajiMJpBthGeUooGAgVI2VqLEwABryKRo3B7CZAdeW95ScySHX+BgqT/ynxh8zyT/O+Cau9GX9bmJ8WPyO772zr51eUkdMiv09A3yXamZcWdPcXsozYHrVzHTbbKkZY8qn2ySuIhRbC5+iNhOnPot5Iz6uiZ2rW0X8ZE1wA8dndPwtNgF/5iLVQsxS85llsuFU3Iaq2vNRrctcNMAr7Kvke7F/6KU6ehGrXo70KPzE4yP57ET9iqRi0c1L1XlI/8SfNLmGc6QTXT8x7fOHqRn4kDpVcxu4dLLP2gB19E7Zwl1i6dWzFikko84VrL1qz6IDPD0YGeTJ0OSbpVDjgjgb7hcZaKkP2elFGz7eZCEoYRFH9DgkXP2R+9HQFHIPZmBqqE9wNfZqQ1JtWD2Ieni2F/z6hVSi4SPVvoOqmSHM+RSmSRtmhT75omX9JUm11YOogtXbHFUzTj32VzagGdxJ178CoiZxE2wvvkw161Ao9hbc80v9VrO/Sd8AtcnHqH00hHUd1lr+Ar+XUiI2pNP9d8kf7P+l2Q/BFpeqGamOhrDes/4t2GypmTwQza7gOzjS1jAlGQPSui/hvR2svS8KaQbzwceUdJB9LkkJb3Zitpk4zWJ6YTDomdvAHbyDG0syJ8H18BHNxZiPIL1U1UyJ5Lsy/JwsJFh6UHpZa88dvIGruVqDD5CaV+BmDox/C0cqnjrAyYZZ651VotrXBjSJDb5DJsnsEwBew9Aei3l9jQsBU4CmaTQMiIUSVZMAFrIZ0MldxNkajHLXtpZk3bpYU9uAWeM4lddiTVY+h3Qc6rdJugZkpL4auDwsnGoiUpuSKcG19EjY4wZVaAXXcOXxrDtYpOYGH1IH08NGPcrQKLKCbSNdyCWfaqhWA3tqPdZ0ANfwMGhk6wOSvjZsVio4BKlwlWyTBpUg+WrkIWEkeqdLHYuix/wdthaWNOpQok2+8Qahr2Vw5OtLV09V3CS2DhZVcDNojz/G/DFuXKfAu8eYodGtWw8nqwBs3u4gR+rBCuBpj7zLDa3L0y8MG99D4HVTjbYovhftubL8szIE9qw9NQrG0HjjKd0KgvNNWZia06kbSZctUuvyRN/culEcgNhz74JaYSJlv6T5KGsB3iZwlaSJnwt285u8Qfkn/MEMSd669Uf0X6n3I/I/zq4PQ9l+hYUxujUlSeVWjZtgj8sqGax385tdf/NqzbhIhmnrNO1E75SAtd2ELmF16p6urBDGxul1Ainfytktn9yts+sFbLVrZ2+c7h8dxauXBu5g0bWwSMsjabr8Yy7LuUgS2CsaUjI1oaLSa1iNjy9tdPmt6PjOiYXAKFa4cTjCsN7CRuN7I/lUa6gb89ka/yEFC+cPp2NdwVa3kR8WTtRbjk+WBLdDiocfGyVAVfI66ZWkEfbNA/T+3mxR4q8s3vuw9bDRcEuDv8ZZeZvXLRA59Gk+i0EqfhicMLBRa9hPlmTQMDzVc0kAPqkwca0vkvR2rpb3hfjJgDxOOlgNytN42yJ20ZpMO5ftDn3yaPgk+HqHldp6f04Hcx1i/PI6F+NtquED0IuPDL4VrD0Y7XyuJ+lkWlu2JFVgHZNh2yZ/FD0GbUInpxspln4NH+BTJIywMV45ezhHk3eYegW0hv1wFHe0j7ivy2jIrZUY+1Xw3bDWf/b+AVahCn5LdEszH+A/4V/gFezpY/qU8LYjfemAdCLNUfTXbXjPgN6d2kL2QzET9EfG9rWbdPtP0tIbdEUmPWbfEv3IDfp4akOLblBKtD+V7Cvy75cMR/uxP9ov2Zses3oJ0GH2Tpd6C/9fymfQP4itXLxud3wBO3dW1V4W0acMaE/G31JW6SIrdIM+XFdOZi/HaxG/cetU2w/u52Qz3z6tz+I8gfMEzhM4T+A8gfMEzhM4T6Awgb8AnAfEoKwkFKUAAAAASUVORK5CYII="></image>
+                        <use fill="#0B0C0C" fill-rule="evenodd" xlink:href="#rect-1"></use>
+                    </g>
+                    <text id="🖊️Global_Header_Text" font-family="Helvetica" font-size="8" font-weight="normal" fill="#0B0C0C">
+                        <tspan x="13" y="11">GOV.UK</tspan>
+                    </text>
+                    <g id="Fill/$link-colour" transform="translate(2.000000, 15.000000)" fill="#005EA5" fill-rule="evenodd">
+                        <rect id="Rectangle" x="0" y="0" width="188" height="1"></rect>
+                    </g>
+                </g>
+                <g id="Question/Text-input" transform="translate(5.000000, 64.000000)">
+                    <g id="Form/Text-input" transform="translate(0.000000, 8.000000)">
+                        <g id="Fill/$black" fill="#0B0C0C">
+                            <rect id="Rectangle" x="0" y="0" width="96" height="12"></rect>
+                        </g>
+                        <rect id="Inside" fill="#FFFFFF" x="2" y="2" width="92" height="8"></rect>
+                    </g>
+                    <g id="Form/Label" fill="#0B0C0C">
+                        <g id="Fill/$text-colour">
+                            <rect id="Rectangle" x="0" y="0" width="64" height="4"></rect>
+                        </g>
+                    </g>
+                </g>
+                <g id="Object/Back" transform="translate(5.000000, 32.000000)" fill="#6F777B">
+                    <g id="Fill/$secondary-text-colour">
+                        <rect id="Rectangle" x="0" y="0" width="16" height="2"></rect>
+                    </g>
+                </g>
+            </g>
+        </g>
+    </g>
+</svg>

package/dist/assets/javascripts/all.js

@@ -0,0 +1 @@
+console.log("Page Flow Plugin loaded");

package/dist/assets/styles/all.scss

@@ -0,0 +1,2 @@
+@import "scss/variables";
+@import "scss/pages";

package/dist/assets/styles/scss/_pages.scss

@@ -0,0 +1,169 @@
+.govuk-pages-plugin {
+
+  .screenPreviewContainer {
+    height: 400px;
+    overflow: hidden;
+    border: 1px solid #000;
+    .screenPreview {
+      width: 200%;
+      height: 800px;
+      transform: scale(0.5);
+      transform-origin: 0 0;
+      background: none;
+      border: 0;
+    }
+  }
+
+  .page-flow-feedback {
+    &--positive {
+      color: #00a33b;
+    }
+    &--negative {
+      color: #a33038;
+    }
+  }
+
+  .page-flow--stages, .user-flow--stages {
+    @extend .govuk-body;
+    padding: 0;
+  }
+  .user-flow-item--stage {
+    display: inline-block;
+  }
+
+  .user-flow-page-item {
+    border-top: 1px solid #333;
+    padding-top:1em;
+    //margin-bottom: 2em;
+  }
+
+  .page-flow-item--stage, .user-flow-item--stage {
+    border-top: 10px solid;
+    .page-flow-stage-descriptor {
+      padding: 2px 10px;
+      display: block;
+      //padding: 5px;
+    }
+    &--1 {
+      border-color: $stage-color--1;
+    }
+    &--2 {
+      border-color: $stage-color--2;
+    }
+    &--3 {
+      border-color: $stage-color--3;
+    }
+    &--4 {
+      border-color: $stage-color--4;
+    }
+    &--authentication {
+      border-color: $stage-color--authentication;
+    }
+    &--documents {
+      border-color: $stage-color--documents;
+    }
+    &--notifications, &--notifications {
+      border-color: $stage-color--notifications;
+    }
+    &:last-of-type {
+      .page-flow-item--page{
+        &:last-of-type {
+          &:before {
+            display: none;
+          }
+        }
+      }
+    }
+  }
+
+  .page-flow--pages, .user-flow--pages {
+    @extend .govuk-body;
+    padding: 0;
+    .page-flow-item--page {
+      display: inline-block;
+      font-size: 14px;
+      width: 130px;
+      //min-height: 200px;
+      vertical-align: top;
+      position: relative;
+      .page-flow-item-screen-icon {
+        width: 100px;
+        height: 100px;
+        display: block;
+        background-repeat: no-repeat;
+        &--email {
+          background-image: url($icons + '/email.svg');
+          -webkit-background-size: contain;
+          background-size: contain;
+        }
+        &--text-input {
+          background-image: url($icons + '/text-input.svg');
+          -webkit-background-size: contain;
+          background-size: contain;
+        }
+        &--dashboard, &--content-page {
+          background-image: url($icons + '/content-page.svg');
+          -webkit-background-size: contain;
+          background-size: contain;
+        }
+        &--radio-input {
+          background-image: url($icons + '/radio-input.svg');
+          -webkit-background-size: contain;
+          background-size: contain;
+        }
+        &--checkbox-input {
+          background-image: url($icons + '/checkbox-input.svg');
+          -webkit-background-size: contain;
+          background-size: contain;
+        }
+        &--check-answers {
+          background-image: url($icons + '/check-answers.svg');
+          -webkit-background-size: contain;
+          background-size: contain;
+        }
+        &--confirmation {
+          background-image: url($icons + '/confirmation.svg');
+          -webkit-background-size: contain;
+          background-size: contain;
+        }
+        &--task-list {
+          background-image: url($icons + '/task-list.svg');
+          -webkit-background-size: contain;
+          background-size: contain;
+        }
+        &--start-page {
+          background-image: url($icons + '/start-page.svg');
+          -webkit-background-size: contain;
+          background-size: contain;
+        }
+        &--checkbox-page {
+          background-image: url($icons + '/checkbox-page.svg');
+          -webkit-background-size: contain;
+          background-size: contain;
+        }
+      }
+    }
+  }
+  .user-flow--pages {
+    @extend .page-flow--pages;
+    .page-flow-item--page {
+      display: inline-block;
+      font-size: 14px;
+      width: 170px;
+      //min-height: 200px;
+      vertical-align: top;
+      position: relative;
+
+      &:before {
+        content: "";
+        position: absolute;
+        background: url($page-flow-images + '/arrow.svg') no-repeat;
+        background-size: contain;
+        width: 78px;
+        left: 92px;
+        height: 20px;
+        top: 35px;
+      }
+    }
+  }
+}

package/dist/assets/styles/scss/_variables.scss

@@ -0,0 +1,19 @@
+// Assets - these can all be overridden
+$page-flow-assets: '/extension-assets/govuk-page-flow-plugin/app/assets/';
+$page-flow-images: $page-flow-assets + 'images/';
+$icons: $page-flow-images + 'page-types';
+
+// Stock colours for stages
+$stage-color--1: #006c56;
+$stage-color--2: #00beb7;
+$stage-color--3: pink;
+$stage-color--4: #f47738;
+$stage-color--5: #ccc;
+$stage-color--6: #005ea5;
+$stage-color--7: #004432;
+$stage-color--8: #f47738;
+$stage-color--9: #3b1f5f;
+$stage-color--10: #ffdd00;
+$stage-color--documents: purple;
+$stage-color--notifications: teal;
+$stage-color--authentication: crimson;

package/dist/functions/pages/getPages.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPages = void 0;
+const validate_1 = require("../../validate");
+const getPages = (pages) => {
+    const validatedPages = (0, validate_1.validatePagesArray)(pages);
+    return validatedPages;
+};
+exports.getPages = getPages;

package/dist/functions/stages/getStages.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapPagesToStages = exports.getStagesWithPages = exports.getStages = void 0;
+const validate_1 = require("../../validate");
+// Get and validate stages from the provided input
+const getStages = (stages) => {
+    const validatedStages = (0, validate_1.validateStagesArray)(stages);
+    return validatedStages;
+};
+exports.getStages = getStages;
+// Get and validate stages and relevant pages from the provided input. Return an array of Stage objects containing relevant pages.
+const getStagesWithPages = (stages, pages) => {
+    const validatedStages = (0, validate_1.validateStagesArray)(stages);
+    const validatedPages = (0, validate_1.validatePagesArray)(pages);
+    return (0, exports.mapPagesToStages)(validatedStages, validatedPages);
+};
+exports.getStagesWithPages = getStagesWithPages;
+// Below this point is just the helper function used internally for the above functions
+// This function does the heavy lifting of mapping pages to their relevant stages
+const mapPagesToStages = (stages, pages) => {
+    let allPages = [...pages]; // Create a copy to avoid mutating the original
+    const stagesWithPages = stages.map((stage) => {
+        // Filter pages that belong to this stage
+        const pagesForStage = pages.filter((page) => page.stage && page.stage.main === stage.id);
+        // Only add the stage if it has pages (after all, why return empty stages?)
+        if (pagesForStage.length > 0) {
+            // Remove the filtered pages from allPages to get unused pages
+            allPages = allPages.filter(page => !pagesForStage.some(p => p.id === page.id));
+            // Map sub-stages with their relevant pages
+            let subStagesWithPages;
+            if (stage.subStages) {
+                subStagesWithPages = stage.subStages.map((subStage) => {
+                    // Filter pages that belong to this sub-stage
+                    const pagesForSubStage = pagesForStage.filter((page) => page.stage && page.stage.subStage === subStage.id);
+                    if (pagesForSubStage.length > 0) {
+                        return {
+                            id: subStage.id,
+                            title: subStage.title,
+                            description: subStage.description,
+                            pages: pagesForSubStage
+                        };
+                    }
+                }).filter(subStage => subStage !== undefined);
+            }
+            return {
+                id: stage.id,
+                title: stage.title,
+                description: stage.description,
+                subStages: subStagesWithPages,
+                pages: pagesForStage
+            };
+        }
+    }).filter(stage => stage !== undefined);
+    // add allPages to a misc category and bolt on to stagesWithPages
+    if (allPages.length > 0) {
+        stagesWithPages.push({
+            id: "unassigned",
+            title: "Unassigned",
+            description: "Pages not assigned to any stage or sub-stage",
+            pages: allPages
+        });
+    }
+    return stagesWithPages;
+};
+exports.mapPagesToStages = mapPagesToStages;

package/dist/index.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.govukPagesPlugin = exports.stageIndex = exports.stageIndexData = exports.pageIndex = exports.pageIndexData = void 0;
+const express_1 = require("express");
+const getPages_1 = require("./functions/pages/getPages");
+const getStages_1 = require("./functions/stages/getStages");
+/*--- UTILITIES (used by supplied routes AND made available to plugin users) ---*/
+const pageIndexData = (pages) => {
+    return (0, getPages_1.getPages)(pages);
+};
+exports.pageIndexData = pageIndexData;
+const pageIndex = (pages, pageType) => {
+    pageType = pageType || "page-index";
+    return (req, res) => {
+        res.render(pageType, { pages: pages });
+    };
+};
+exports.pageIndex = pageIndex;
+const stageIndexData = (stages, pages) => {
+    return (0, getStages_1.getStagesWithPages)(stages, pages);
+};
+exports.stageIndexData = stageIndexData;
+const stageIndex = (stages, pages, pageType) => {
+    pageType = pageType || "stage-index";
+    return (req, res) => {
+        res.render(pageType, { stages: (0, exports.stageIndexData)(stages, pages) });
+    };
+};
+exports.stageIndex = stageIndex;
+// Add user flows, etc here later
+/*--- THE MAIN USER ROUTES ---*/
+const govukPagesPlugin = (pages, stages, pageType) => {
+    pageType = pageType || "page-index"; // Options can be 'all', 'page-index', 'stage-index' - in future could be 'user-flow-index', etc
+    const router = (0, express_1.Router)();
+    // This is the default offering from the plugin - it is expected that must users will use this. It should be robust
+    router.get("/", (0, exports.pageIndex)((0, exports.pageIndexData)(pages), pageType));
+    return router;
+};
+exports.govukPagesPlugin = govukPagesPlugin;

package/dist/schema.json

@@ -0,0 +1,89 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "required": ["mode"],
+    "properties": {
+        "mode": {
+            "type": "string",
+            "enum": ["pages", "stages"]
+        }
+    },
+    "allOf": [
+        {
+            "if": {
+                "properties": { "mode": { "const": "pages" } }
+            },
+            "then": { "$ref": "#/definitions/pages" },
+            "else": { "$ref": "#/definitions/stages" }
+        }
+    ],
+    "definitions": {
+        "pages": {
+            "type": "object",
+            "required": ["mode", "pages"],
+            "properties": {
+                "mode": { "const": "pages" },
+                "pages": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "required": ["id", "title", "route"],
+                        "properties": {
+                            "id": { "type": "integer" },
+                            "title": { "type": "string" },
+                            "route": { "type": "string" },
+                            "type": { "type": ["string", "null"] },
+                            "stage": {
+                                "type": ["object"],
+                                "properties": {
+                                    "main": { "type": ["string"] },
+                                    "subStage": { "type": ["integer", "string"] }
+                                },
+                                "additionalProperties": false
+                            },
+                            "description": { "type": ["string", "null"] }
+                        },
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "additionalProperties": false
+        },
+        "stages": {
+            "type": "object",
+            "required": ["mode", "stages"],
+            "properties": {
+                "mode": { "const": "stages" },
+                "stages": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "required": ["id", "title", "route"],
+                        "properties": {
+                            "id": { "type": "string" },
+                            "title": { "type": "string" },
+                            "route": { "type": "string" },
+                            "description": { "type": ["string", "null"] },
+                            "subStages": {
+                                "type": "array",
+                                "items": {
+                                    "type": "object",
+                                    "required": ["id", "title"],
+                                    "properties": {
+                                        "id": { "type": ["string", "integer"] },
+                                        "title": { "type": "string" },
+                                        "route": { "type": "string" },
+                                        "description": { "type": ["string", "null"] }
+                                    },
+                                    "additionalProperties": true
+                                }
+                            }
+                        },
+                        "additionalProperties": true
+                    }
+                }
+            },
+            "additionalProperties": false
+        }
+    }
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/validate.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validatePagesArray = validatePagesArray;
+exports.validateStagesArray = validateStagesArray;
+const ajv_1 = __importDefault(require("ajv"));
+const schema_json_1 = __importDefault(require("./schema.json"));
+const ajv = new ajv_1.default({ allErrors: true, strict: false });
+const validate = ajv.compile(schema_json_1.default);
+function validatePagesArray(pages) {
+    var _a;
+    if (!validate({ mode: "pages", pages: pages })) {
+        const message = (_a = validate.errors) === null || _a === void 0 ? void 0 : _a.map(err => `${err.instancePath || "Pages"} ${err.message}`).join("\n");
+        throw new Error(`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:\n${message}`);
+    }
+    return pages;
+}
+function validateStagesArray(stages) {
+    var _a;
+    if (!validate({ mode: "stages", stages: stages })) {
+        const message = (_a = validate.errors) === null || _a === void 0 ? void 0 : _a.map(err => `${err.instancePath || "Stages"} ${err.message}`).join("\n");
+        throw new Error(`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:\n${message}`);
+    }
+    return stages;
+}

package/dist/views/page-index.html

@@ -0,0 +1,34 @@
+{% extends "layouts/main.html" %}
+
+{% block pageTitle %}
+  Page Index
+{% endblock %}
+
+{% block beforeContent %}
+  {% from "govuk/components/back-link/macro.njk" import govukBackLink %}
+
+  {{ govukBackLink({
+    text: "Back",
+    href: "javascript:history.back(-1);"
+  }) }}
+{% endblock %}
+
+{% block content %}
+
+      <div class="page-index ">
+        <h1 class="govuk-heading-l">Page Index</h1>
+        {% from "govuk/components/details/macro.njk" import govukDetails %}
+
+        {{ govukDetails({
+          summaryText: "What is the 'Page Index'?",
+          html: "<p>This page contains links to tracked pages in this prototype. It is useful for navigating the prototype without having to go through flows.</p><p class='govuk-body-s'> Note, the prototype might contain more pages than are listed here.</p>"
+        }) }} 
+
+        <ul class="govuk-list govuk-list--number">
+          {% for page in pages %}
+            <li><a href="{{ page.route }}">{{ page.title }}</a></li>
+          {% endfor %}
+        </ul>
+      </div>
+
+{% endblock %}

package/dist/views/stage-index.html

@@ -0,0 +1,41 @@
+{% extends "layouts/main.html" %}
+
+{% block pageTitle %}
+  Stage Index
+{% endblock %}
+
+{% block beforeContent %}
+  {% from "govuk/components/back-link/macro.njk" import govukBackLink %}
+
+  {{ govukBackLink({
+    text: "Back",
+    href: "javascript:history.back(-1);"
+  }) }}
+{% endblock %}
+
+{% block content %}
+
+      <div class="page-index ">
+        <h1 class="govuk-heading-l">Stage Index</h1>
+        {% from "govuk/components/details/macro.njk" import govukDetails %}
+
+        {{ govukDetails({
+          summaryText: "What is the 'Stage Index'?",
+          html: "<p>This page contains links to tracked pages in this prototype, these pages are grouped by the 'stages' that they are assigned to. It is useful for navigating the prototype without having to go through flows.</p><p>'Stages' are defined by the plugin user but can be throught about as logical groups of pages that work to achieve a common goal, such as 'authenticating' or 'registering'.</p><p class='govuk-body-s'> Note, the prototype might contain more pages than are listed here.</p>"
+        }) }} 
+        <!-- {{ stages | dump  }} -->
+          {% for stage in stages %}
+            <h2>{{ stage.title }}</h2>
+            {% if stage.description %}
+            <p class="govuk-body-s">{{ stage.description }}</p>
+            {% endif %}
+            <ol>
+            {% for page in stage.pages %}
+              <li><a href="{{ page.route }}">{{ page.title }}</a>{% if page.description %} - <span class="govuk-body-s">{{ page.description }}</span> {% endif %}</li>
+            {% endfor %}
+            </ol>
+            <hr/>
+          {% endfor %}
+      </div>
+
+{% endblock %}

package/govuk-prototype-kit.config.json

@@ -0,0 +1,12 @@
+{
+	"meta": {
+		"description": "This plugin provides the ability to list desired pages in an index or user-flow view."
+	},
+	"nunjucksPaths": ["/dist/views"],
+  "assets": [
+    "/dist/assets"
+  ],
+  "sass": [
+    "/dist/assets/styles/all.scss"
+  ]
+}

package/index.js

@@ -0,0 +1,22 @@
+module.exports = (router) => {
+  /**
+   * Start url
+   *
+   * Redirects a user to the start of our journey
+   *
+   */
+  router.get("/dwp-alternative-formats-plugin/start", (req, res) => {
+    res.redirect("/dwp-alternative-formats-plugin/v2/journey-1/");
+  });
+  /**
+   * Clear data
+   *
+   * Clears only alternative formats dwp-alternative-formats-plugin/v1/journey-3 data
+   *
+   */
+  router.post("/dwp-alternative-formats-plugin/v2/journey-1/clear-data", (req, res) => {
+    req.session.data.altFormatsV2Journey1 = {};
+
+    res.redirect("./clear-data-success");
+  });
+};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@benwatsonuk/govuk-pages-plugin",
+  "author": "BenWatsonUK",
+  "description": "A plugin to visualise selected pages of a GOV.UK prototype with a linear user journey or page index.",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "homepage": "https://github.com/benwatsonuk/govuk-pages-plugin",
+  "bugs": {
+    "url": "https://github.com/benwatsonuk/govuk-pages-plugin/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/benwatsonuk/govuk-pages-plugin.git"
+  },
+  "scripts": {
+    "test": "mocha --require ts-node/register",
+    "clean": "rimraf dist",
+    "build": "npm run clean && tsc && cpx \"src/{assets,views}/**/*\" dist"
+  },
+  "dependencies": {
+    "express": "^4.18.2",
+    "nunjucks": "^3.2.4"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.6",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^25.0.8",
+    "ajv": "^8.17.1",
+    "chai": "^4.3.7",
+    "cpx": "^1.5.0",
+    "json-schema-to-typescript": "^15.0.4",
+    "mocha": "^10.2.0",
+    "nyc": "^15.1.0",
+    "rimraf": "^6.1.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  }
+}