@dwp/govuk-casa 8.2.3 → 8.2.4

package/dist/routes/journey.d.ts

@@ -1,7 +1,31 @@
-export default function journeyRouter({ globalHooks, pages, plan, csrfMiddleware, }: {
-    globalHooks: any;
-    pages: any;
-    plan: any;
-    csrfMiddleware: any;
-}): MutableRouter;
+/**
+ * Create an instance of the router for all waypoints visited during a Journey
+ * through the Plan.
+ *
+ * @access private
+ * @param {JourneyRouterOptions} opts Options
+ * @returns {MutableRouter} Router
+ */
+export default function journeyRouter({ globalHooks, pages, plan, csrfMiddleware, }: JourneyRouterOptions): MutableRouter;
+/**
+ * Options to configure static router
+ */
+export type JourneyRouterOptions = {
+    /**
+     * Global hooks
+     */
+    globalHooks: GlobalHook[];
+    /**
+     * Page definitions
+     */
+    pages: Page[];
+    /**
+     * Plan
+     */
+    plan: Plan;
+    /**
+     * Middleware for providing CSRF controls
+     */
+    csrfMiddleware: Function[];
+};
 import MutableRouter from "../lib/MutableRouter.js";

package/dist/routes/journey.js

@@ -15,6 +15,25 @@ const waypoint_url_js_1 = __importDefault(require("../lib/waypoint-url.js"));
 const logger_js_1 = __importDefault(require("../lib/logger.js"));
 const utils_js_1 = require("../lib/utils.js");
 const log = (0, logger_js_1.default)('routes:journey');
+/**
+ * @access private
+ * @param {import('../casa.js').GlobalHook} GlobalHook
+ */
+/**
+ * @access private
+ * @param {import('../casa.js').Page} Page
+ */
+/**
+ * @access private
+ * @param {import('../casa.js').Plan} Plan
+ */
+/**
+ * @typedef {object} JourneyRouterOptions Options to configure static router
+ * @property {GlobalHook[]} globalHooks Global hooks
+ * @property {Page[]} pages Page definitions
+ * @property {Plan} plan Plan
+ * @property {Function[]} csrfMiddleware Middleware for providing CSRF controls
+ */
 const renderMiddlewareFactory = (view, contextFactory) => [
     (req, res, next) => {
         res.render(view, Object.assign({ 
@@ -29,6 +48,14 @@ const renderMiddlewareFactory = (view, contextFactory) => [
         });
     },
 ];
+/**
+ * Create an instance of the router for all waypoints visited during a Journey
+ * through the Plan.
+ *
+ * @access private
+ * @param {JourneyRouterOptions} opts Options
+ * @returns {MutableRouter} Router
+ */
 function journeyRouter({ globalHooks, pages, plan, csrfMiddleware, }) {
     // Router
     const router = new MutableRouter_js_1.default();

package/dist/routes/static.d.ts

@@ -5,6 +5,7 @@
 /**
  * Create a router for serving CASA's static assets.
  *
+ * @access private
  * @param {StaticOptions} options Options
  * @returns {MutableRouter} ExpressJS Router instance
  */

package/dist/routes/static.js

@@ -20,6 +20,7 @@ const oneDay = 86400000;
 /**
  * Create a router for serving CASA's static assets.
  *
+ * @access private
  * @param {StaticOptions} options Options
  * @returns {MutableRouter} ExpressJS Router instance
  */
@@ -34,7 +35,7 @@ function staticRouter({ maxAge = 3600000, } = {}) {
         res.set('cache-control', 'public');
         res.set('pragma', 'cache');
         res.set('expires', new Date(Date.now() + oneDay).toUTCString());
-        const { pathname } = new url_1.URL((_a = req === null || req === void 0 ? void 0 : req.originalUrl) !== null && _a !== void 0 ? _a : '', 'http://placeholder.test/');
+        const { pathname } = new url_1.URL((_a = req === null || req === void 0 ? void 0 : req.originalUrl) !== null && _a !== void 0 ? _a : '', 'https://placeholder.test/');
         if (pathname.substr(-4) === '.css') {
             // Just needed for our in-memory CSS assets
             res.set('content-type', 'text/css');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "8.2.3",
+  "version": "8.2.4",
   "description": "A framework for building GOVUK Collect-And-Submit-Applications",
   "repository": {
     "type": "git",
@@ -32,6 +32,7 @@
     "build:prepare": "rm -rf dist/* && mkdir -p dist/assets/js/ && mkdir -p dist/assets/css/",
     "build:sources": "tsc -p tsconfig-cjs.json && ./scripts/fixup.sh",
     "build:css-assets": "node scripts/compile-sass.js",
+    "build:api-docs": "npx jsdoc -c ./jsdoc.json -d ./docs/api/ --debug -P '' -r -R ./README.md --verbose -t ./node_modules/docdash ./src",
     "prepare": "npm run build",
     "upgrade-deps": "OD=$(npm outdated --long --parseable); echo \"$OD\" | grep ':devDependencies:' | awk -F: '{ print $4 }' | xargs npm i -DE; echo \"$OD\" | grep ':dependencies:' | awk -F: '{ print $4 }' | xargs npm i -E",
     "standard-version": "node scripts/standard-version.js"
@@ -49,8 +50,8 @@
     "express-session": "1.17.3",
     "govuk-frontend": "4.0.1",
     "graphlib": "2.1.8",
-    "helmet": "5.0.2",
-    "i18next": "21.8.2",
+    "helmet": "5.1.0",
+    "i18next": "21.8.4",
     "i18next-http-middleware": "3.2.0",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",
@@ -61,30 +62,34 @@
     "validator": "13.7.0"
   },
   "devDependencies": {
-    "@babel/core": "7.17.12",
+    "@babel/core": "7.18.0",
     "@babel/eslint-parser": "7.17.0",
-    "@babel/preset-env": "7.17.12",
+    "@babel/preset-env": "7.18.0",
     "@commitlint/config-conventional": "17.0.0",
+    "@ckeditor/jsdoc-plugins": "30.1.0",
     "@dwp/casa-spiderplan": "2.4.0",
     "@dwp/casa-spiderplan-a11y-plugin": "0.1.4",
     "@dwp/casa-spiderplan-zap-plugin": "0.1.1",
     "@dwp/eslint-config-base": "6.0.0",
     "@types/express": "4.17.13",
-    "@types/node": "17.0.34",
+    "@types/node": "17.0.35",
     "@types/nunjucks": "3.2.1",
     "babel-eslint": "10.1.0",
     "c8": "7.11.3",
     "chai": "4.3.6",
-    "cheerio": "1.0.0-rc.10",
+    "cheerio": "1.0.0-rc.11",
     "commitlint": "17.0.0",
-    "eslint": "8.15.0",
-    "eslint-plugin-no-unsafe-regex": "1.0.0",
+    "eslint": "8.16.0",
+    "docdash": "1.2.0",
     "eslint-plugin-security": "1.5.0",
-    "eslint-plugin-sonarjs": "0.13.0",
     "fast-check": "2.25.0",
     "husky": "8.0.1",
     "mocha": "10.0.0",
-    "sass": "1.51.0",
+    "sass": "1.52.1",
+    "eslint-plugin-no-unsafe-regex": "1.0.0",
+    "eslint-plugin-sonarjs": "0.13.0",
+    "jsdoc": "3.6.10",
+    "jsdoc-tsimport-plugin": "1.0.5",
     "sinon": "14.0.0",
     "sinon-chai": "3.7.0",
     "standard-version": "9.5.0",

package/views/casa/components/character-count/README.md

@@ -11,7 +11,7 @@ Custom parameters:
 Basic example:
 
 ```nunjucks
-{% from "casa/components/character-count/macro.njk" import casaGovukCharacterCount %}
+{% from "casa/components/character-count/macro.njk" import casaGovukCharacterCount with context %}
 
 casaGovukCharacterCount({
   name: "name",

package/views/casa/components/input/README.md

@@ -11,7 +11,7 @@ Custom parameters:
 Basic example:
 
 ```nunjucks
-{% from "casa/components/input/macro.njk" import casaGovukInput %}
+{% from "casa/components/input/macro.njk" import casaGovukInput with context %}
 
 casaGovukInput({
   name: "name",

package/views/casa/components/radios/README.md

@@ -13,7 +13,7 @@ Custom parameters:
 Basic example:
 
 ```nunjucks
-{% from "casa/components/radios/macro.njk" import casaGovukRadios %}
+{% from "casa/components/radios/macro.njk" import casaGovukRadios with context %}
 
 {{ casaGovukRadios({
   name: 'myInput',
@@ -32,7 +32,7 @@ Basic example:
 If you want one of the radio items to toggle the display of an element:
 
 ```nunjucks
-{% from "casa/components/radios/macro.njk" import casaGovukRadios %}
+{% from "casa/components/radios/macro.njk" import casaGovukRadios with context %}
 
 {% set panel %}
   This panel will remain hidden until the "Yes" radio button is chosen

package/views/casa/components/textarea/README.md

@@ -11,7 +11,7 @@ Custom parameters:
 Basic example:
 
 ```nunjucks
-{% from "casa/components/textarea/macro.njk" import casaGovukTextarea %}
+{% from "casa/components/textarea/macro.njk" import casaGovukTextarea with context %}
 
 casaGovukTextarea({
   name: "name",