@dwp/govuk-casa 7.0.8 → 8.0.0-beta2

package/README.md

@@ -1,33 +1,38 @@
 # CASA 
 
-A framework of ExpressJS middleware for building services based on the [GOV.UK Design System](https://design-system.service.gov.uk/).
+A framework for building forms based on the [GOV.UK Design System](https://design-system.service.gov.uk/).
 
-### Support
-
-CASA is maintained by the [DWP Engineering Practice](mailto:open-source@engineering.digital.dwp.gov.uk).
-
-### Contributing
-
-If you'd like to contribute any changes, enhancements or report issues, please take a look at our [contribution guide](CONTRIBUTING.md).
 
 ## Features
 
 * Adopts the [GOVUK Design System](https://design-system.service.gov.uk/) which provides well-researched, accessible markup out of the box
-* Handles complex, conditional journey routing logic so you easily tailor users' journeys on the fly
-* Provides basic protection against some [OWASP Top Ten](https://www.owasp.org/index.php/Category:OWASP_Top_Ten_Project) vulnerabilities such as XSS, CSRF
-* Choose your own session management extension for customised data storage (e.g. apply encryption as required)
-* Shallow learning curve
+* Handles complex journey routing so you can easily tailor users' journeys to provide the best experience
+* Multi-language support
+* A small core, but highly extensible through hook and plugin mechanisms
+* Built on ExpressJS so offers a shallow learning curve
+* Distributable supports both ES6 and CommonJS codebases
 
-## Requirements
-
-CASA aims to maintain support for the **latest LTS version** of NodeJS, and requires at least version `6.4.0` of npm. See the [NodeJS release schedule](https://nodejs.org/en/about/releases/) for more information.
 
 ## Getting started
 
-To get started quickly, take a look through the ["barebones" example application](examples/barebones/). This provides you with a basic application out of the box, covering most features of CASA.
+```bash
+npm -E @dwp/govuk-casa
+```
+
+* [Documentation](docs/index.md)
+* [Examples](examples/)
 
-Alternatively, read through our **[Guides](docs/guide.md)** to start building an understanding of the core concepts involved in building a CASA app.
 
 ## Migrating between versions
 
 A series of migration guides are provided in [`docs/migration-guides/`](docs/migration-guides/) that should help you upgrade between major versions of CASA.
+
+
+## Support
+
+CASA is maintained by the [DWP Engineering Practice](mailto:open-source@engineering.digital.dwp.gov.uk).
+
+
+## Contributing
+
+If you'd like to contribute any changes, enhancements or report issues, please take a look at our [contribution guide](CONTRIBUTING.md) and [design guidelines](docs/contributors/index.md). 

package/dist/mjs/esm-wrapper.js

@@ -1,5 +1,8 @@
 // Basic wrapper to act as the package entrypoint for ESM applications
 // ref: https://redfin.engineering/node-modules-at-war-why-commonjs-and-es-modules-cant-get-along-9617135eeca1
+// The `../casa.js` reference here is correct. This file will be copied into
+// `dist/` in the right location at build time, which will resolve that file
+// path correctly.
 import casa from '../casa.js';
 
 export const { configure } = casa;
@@ -7,5 +10,12 @@ export const { validators } = casa;
 export const { field } = casa;
 export const { Plan } = casa;
 export const { JourneyContext } = casa;
+export const { ValidatorFactory } = casa;
 export const { ValidationError } = casa;
+
+// Utilities
 export const { waypointUrl } = casa;
+export const { endSession } = casa;
+
+// Nunjucks filters
+export const { nunjucksFilters } = casa;

package/package.json

@@ -1,110 +1,85 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "7.0.8",
-  "description": "Framework for creating basic GOVUK Collect-And-Submit-Applications",
-  "main": "casa.js",
+  "version": "8.0.0-beta2",
+  "description": "A framework for building GOVUK Collect-And-Submit-Applications",
+  "main": "dist/casa.js",
+  "module": "dist/mjs/casa.js",
+  "exports": {
+    "import": "./dist/mjs/esm-wrapper.js",
+    "require": "./dist/casa.js"
+  },
+  "typings": "dist/casa.d.ts",
   "files": [
-    "/definitions/**/*",
-    "/dist/**/*",
-    "/lib/**/*",
-    "/locales/**/*",
-    "/middleware/**/*",
-    "/test/utils/**/*",
-    "/src/scss/*",
-    "/src/browserconfig.xml",
-    "/views/**/*",
-    "/index.js",
-    "/casa.js",
-    "/**/*.d.ts",
-    "!/**/*/.DS_Store",
-    "!/**/*/.gitkeep",
-    "!/examples/**/*",
-    "!/test/unit/testdata/**/*"
+    "dist/**/*",
+    "locales/**/*",
+    "views/**/*"
   ],
   "engines": {
-    "node": ">=14.0.0 <17.0.0"
+    "node": ">=14.17.2"
   },
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:dwp/govuk-casa.git"
+  "scripts": {
+    "pipeline": "npm test && npm run test:e2e && npm run lint",
+    "test": "mocha './tests/**/*.test.js'",
+    "test:e2e": "spiderplan --worker-init ./tests/e2e/worker-init.js --language en ./tests/e2e/personas/**/*.yaml",
+    "test:combined": "npm test; npm run test:e2e",
+    "lint": "eslint .",
+    "coverage": "c8 npm run test:combined",
+    "build": "npm run build:prepare && npm run build:sources && npm run build:css-assets",
+    "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",
+    "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"
   },
+  "keywords": [],
+  "author": "DWP Digital",
+  "license": "ISC",
+  "type": "module",
   "dependencies": {
-    "body-parser": "1.19.0",
-    "colors": "1.4.0",
+    "cookie-parser": "1.4.6",
     "csurf": "1.11.0",
     "debug": "4.3.3",
-    "dot-object": "2.1.4",
-    "fast-copy": "2.1.1",
-    "fs-extra": "10.0.0",
+    "deepmerge": "4.2.2",
+    "express": "4.17.1",
+    "express-session": "1.17.2",
     "govuk-frontend": "3.14.0",
-    "govuk_template_jinja": "0.26.0",
     "graphlib": "2.1.8",
-    "klaw-sync": "6.0.0",
-    "lodash.merge": "4.6.2",
+    "helmet": "4.6.0",
+    "i18next": "21.6.0",
+    "i18next-http-middleware": "3.1.4",
+    "js-yaml": "4.1.0",
+    "lodash": "4.17.21",
     "luxon": "2.1.1",
     "nunjucks": "3.2.3",
-    "serve-favicon": "2.5.0",
-    "uid-safe": "2.1.5",
     "uuid": "8.3.2",
-    "validator": "13.7.0"
+    "validator": "^13.7.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "15.0.0",
+    "@babel/core": "7.16.0",
+    "@babel/eslint-parser": "7.16.3",
+    "@babel/preset-env": "7.16.4",
     "@commitlint/config-conventional": "15.0.0",
-    "@commitlint/travis-cli": "15.0.0",
-    "@dwp/commitlint-config-base": "1.2.0",
+    "@dwp/casa-spiderplan": "2.0.0",
+    "@dwp/casa-spiderplan-a11y-plugin": "0.1.3",
+    "@dwp/casa-spiderplan-zap-plugin": "0.1.1",
     "@dwp/eslint-config-base": "5.0.1",
-    "@stryker-mutator/core": "5.5.1",
-    "@stryker-mutator/html-reporter": "3.1.0",
-    "@stryker-mutator/javascript-mutator": "4.0.0",
-    "@stryker-mutator/mocha-framework": "4.0.0",
-    "@stryker-mutator/mocha-runner": "5.5.1",
-    "autocannon": "7.5.0",
+    "@types/express": "4.17.13",
+    "@types/node": "16.11.12",
+    "@types/nunjucks": "3.2.0",
+    "babel-eslint": "10.1.0",
+    "c8": "7.10.0",
     "chai": "4.3.4",
-    "chai-as-promised": "7.1.1",
-    "chai-http": "4.3.0",
-    "cheerio": "1.0.0-rc.10",
-    "conventional-changelog-cli": "2.1.1",
+    "commitlint": "15.0.0",
     "eslint": "7.32.0",
     "eslint-plugin-no-unsafe-regex": "1.0.0",
     "eslint-plugin-sonarjs": "0.11.0",
-    "express": "4.17.1",
-    "express-session": "1.17.2",
+    "fast-check": "2.20.0",
     "husky": "7.0.4",
-    "jsdom": "19.0.0",
-    "minimatch": "3.0.4",
     "mocha": "9.1.3",
-    "nyc": "15.1.0",
-    "proxyquire": "2.1.3",
     "sass": "1.44.0",
     "sinon": "12.0.1",
     "sinon-chai": "3.7.0",
     "supertest": "6.1.6",
-    "uglify-js": "3.14.4",
-    "yargs": "17.3.0"
-  },
-  "peerDependencies": {
-    "express": "4.x",
-    "express-session": "1.x"
-  },
-  "scripts": {
-    "pipeline": "npm test && npm run compliance && npm run quality && npm run security:vulnerable-packages && (npm outdated || true)",
-    "compliance": "npm run compliance:lint",
-    "compliance:lint": "eslint .",
-    "test": "npm run test:unit --silent && npm run test:integration --silent",
-    "test:unit": "mocha -R spec \"./test/unit/**/*.test.js\"",
-    "test:integration": "mocha -R spec \"./test/integration/**/*.test.js\"",
-    "test:performance": "node ./test/performance/plan.test.js",
-    "quality": "npm run quality:coverage",
-    "quality:coverage": "nyc npm test",
-    "quality:mutation": "stryker run",
-    "security": "npm run security:vulnerable-packages",
-    "security:vulnerable-packages": "npm audit --production --registry=https://registry.npmjs.org --json | node -e 'a=JSON.parse(fs.readFileSync(\"/dev/stdin\",\"utf-8\")).metadata.vulnerabilities;process.exit(a.high+a.critical);'",
-    "package:changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
-    "compile-static-assets": "node ./scripts/compile-sass.js && node ./scripts/compile-js.js",
-    "prepare": "npm run compile-static-assets --silent; husky install",
-    "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"
-  },
-  "author": "DWP <open-source@engineering.digital.dwp.gov.uk>",
-  "license": "ISC"
+    "typescript": "4.5.3"
+  }
 }

package/views/casa/components/checkboxes/template.njk

@@ -16,6 +16,7 @@
   id: params.id if params.id else 'f-' + params.name + '-wrapper' | safe
 }) %}
 
+
 {# Add checked flag to chosen inputs #}
 {% set mergedItems = [] %}
 {% for item in params.items %}
@@ -30,6 +31,7 @@
   {% set mergedItems = (mergedItems.push(item), mergedItems) %}
 {% endfor %}
 
+
 {# Merge parameters #}
 {% set mergedParams = mergeObjects(params, {
   name: fieldName,
@@ -43,11 +45,12 @@
 
 {# Ensure that the first item has the id matching `f-<name>` in order for error summary linkage to work #}
 {% if not mergedParams.items[0].id %}
-  {% set mergedParams = mergeObjectsDeep(mergedParams, {
+  {% set mergedParams = mergeObjects(mergedParams, {
     items: [{
       id: 'f-' + params.name
     }]
   }) %}
 {% endif %}
 
+
 {{ govukCheckboxes(mergedParams) }}

package/views/casa/components/date-input/template.njk

@@ -21,7 +21,7 @@
   namePrefix: '',
   attributes: mergedAttributes,
   items: [
-    mergeObjectsDeep({
+    mergeObjects({
       label: t('macros:dateInput.day'),
       classes: 'govuk-input--width-2 ' + (inputErrorClass if includes(fieldErrors[0].focusSuffix, '[dd]') or not hasSuffixHighlights)
     }, params.items[0] if params.items[0] else {}, {
@@ -29,7 +29,7 @@
       name: params.namePrefix + '[dd]',
       value: params.casaValue.dd
     }),
-    mergeObjectsDeep({
+    mergeObjects({
       label: t('macros:dateInput.month'),
       classes: 'govuk-input--width-2 ' + (inputErrorClass if includes(fieldErrors[0].focusSuffix, '[mm]') or not hasSuffixHighlights)
     }, params.items[1] if params.items[1] else {}, {
@@ -37,7 +37,7 @@
       name: params.namePrefix + '[mm]',
       value: params.casaValue.mm
     }),
-    mergeObjectsDeep({
+    mergeObjects({
       label: t('macros:dateInput.year'),
       classes: 'govuk-input--width-4 ' + (inputErrorClass if includes(fieldErrors[0].focusSuffix, '[yyyy]') or not hasSuffixHighlights)
     }, params.items[2] if params.items[2] else {}, {

package/views/casa/components/journey-form/README.md

@@ -10,6 +10,7 @@ A "Continue" button (and "Cancel" link if in edit mode) will also be added.
 {% from "casa/components/journey-form/macro.njk" import casaJourneyForm with context %}
 
 {% call casaJourneyForm({
+  formUrl: '/form/url',
   csrfToken: casa.csrfToken,
   inEditMode: true,
   editOriginUrl: '/url/to/review/page',
@@ -23,7 +24,7 @@ A "Continue" button (and "Cancel" link if in edit mode) will also be added.
 Which will render something like this:
 
 ```html
-<form action="#" method="post" autocomplete="off" novalidate class="casa-journey-form">
+<form action="/form/url" method="post" autocomplete="off" novalidate class="casa-journey-form">
   <input type="hidden" name="_csrf" value="..." />
   <input type="hidden" name="edit" value="true" />
   <input type="hidden" name="editorigin" value="/url/to/review/page" />
@@ -47,6 +48,7 @@ Note that the submit button is configured to prevent double-clicks and avoid dup
 
 | Name | Type | Required | Description |
 |------|------|----------|-------------|
+| `formUrl` | string | Yes | The form's "action", available in a `formUrl` template variable |
 | `csrfToken` | string | Yes | Token used to protect form from CSRF (available to user's templates via the global `casa.csrfToken` variable) |
 | `inEditMode` | boolean | No | Toggle edit-mode of the form (available to page templates using default GET/POST handlers via the local `inEditMode` variable) |
 | `editOriginUrl` | string | No | Absolute URL to the page from which the edit request came (defaults to `review`) (available to user's templates using default GET/POST handlers via the local `editOriginUrl` variable) |

package/views/casa/components/journey-form/template.njk

@@ -1,6 +1,6 @@
 {% from "govuk/components/button/macro.njk" import govukButton %}
 
-<form action="#" method="post" autocomplete="off" novalidate class="casa-journey-form">
+<form action="{{ params.formUrl }}" method="post" autocomplete="off" novalidate class="casa-journey-form">
   <input type="hidden" name="_csrf" value="{{ params.csrfToken }}" />
   {% if params.inEditMode %}<input type="hidden" name="edit" value="true" />{% endif %}
   {% if params.inEditMode and params.editOriginUrl %}<input type="hidden" name="editorigin" value="{{ params.editOriginUrl }}" />{% endif %}

package/views/casa/components/postal-address-object/template.njk

@@ -14,7 +14,7 @@
     {% if fieldAddress1Errors %}
       {% set fieldAttributes = mergeObjects(fieldAttributes, {'data-validation': {fn: params.name + '[address1]', va: fieldAddress1Errors[0].validator} | dump}) %}
     {% endif %}
-    {{ govukInput(mergeObjectsDeep({
+    {{ govukInput(mergeObjects({
       label: {
         html: t('macros:postalAddressObject.address1')
       },
@@ -33,7 +33,7 @@
     {% if fieldAddress2Errors %}
       {% set fieldAttributes = mergeObjects(fieldAttributes, {'data-validation': {fn: params.name + '[address2]', va: fieldAddress2Errors[0].validator} | dump}) %}
     {% endif %}
-    {{ govukInput(mergeObjectsDeep({
+    {{ govukInput(mergeObjects({
       label: {
         html: t('macros:postalAddressObject.address2')
       },
@@ -54,7 +54,7 @@
   {% if fieldErrors %}
     {% set fieldAttributes = mergeObjects(fieldAttributes, {'data-validation': {fn: params.name + '[address3]', va: fieldErrors[0].validator} | dump}) %}
   {% endif %}
-  {{ govukInput(mergeObjectsDeep({
+  {{ govukInput(mergeObjects({
     classes: "govuk-!-width-two-thirds",
     label: {
       html: t('macros:postalAddressObject.address3')
@@ -75,7 +75,7 @@
   {% if fieldErrors %}
     {% set fieldAttributes = mergeObjects(fieldAttributes, {'data-validation': {fn: params.name + '[address4]', va: fieldErrors[0].validator} | dump}) %}
   {% endif %}
-  {{ govukInput(mergeObjectsDeep({
+  {{ govukInput(mergeObjects({
     classes: "govuk-!-width-two-thirds",
     label: {
       html: t('macros:postalAddressObject.address4')
@@ -96,7 +96,7 @@
   {% if fieldErrors %}
     {% set fieldAttributes = mergeObjects(fieldAttributes, {'data-validation': {fn: params.name + '[postcode]', va: fieldErrors[0].validator} | dump}) %}
   {% endif %}
-  {{ govukInput(mergeObjectsDeep({
+  {{ govukInput(mergeObjects({
     classes: "govuk-input--width-10",
     label: {
       html: t('macros:postalAddressObject.postcode')

package/views/casa/components/radios/template.njk

@@ -36,7 +36,7 @@
 
 {# Ensure that the first item has the id matching `f-<name>` in order for error summary linkage to work #}
 {% if not mergedParams.items[0].id %}
-  {% set mergedParams = mergeObjectsDeep(mergedParams, {
+  {% set mergedParams = mergeObjects(mergedParams, {
     items: [{
       id: 'f-' + params.name
     }]

package/views/casa/errors/static.njk

@@ -0,0 +1,11 @@
+{% extends "casa/layouts/main.njk" %}
+
+{% block pageTitle %}
+  Sorry, there is a problem with the service
+{% endblock %}
+
+{% block content %}
+  <h1 class="govuk-heading-xl">Sorry, there is a problem with the service</h1>
+
+  <p class="govuk-body">Try again in a few moments.</p>
+{% endblock %}

package/views/casa/layouts/journey.njk

@@ -1,21 +1,16 @@
 {% extends "casa/layouts/main.njk" %}
 
 {% from "govuk/components/back-link/macro.njk" import govukBackLink %}
+{% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
+{% from "casa/components/journey-form/macro.njk" import casaJourneyForm with context %}
+
 
 {# Automatically apply padding with/without back link #}
 {% set mainClasses %}{{ mainClasses }} govuk-main-wrapper--auto-spacing{% endset %}
 
 
+{# Add back link, if appropriate #}
 {% block beforeContent %}
-  {# Phase banner #}
-  {# TODO: remove phase variable - just get template author to override a `casa/partials/phase_banner.njk` template #}
-  {% if casa.phase == 'alpha' %}
-    {% include "casa/partials/phase_banner_alpha.njk" %}
-  {% elseif casa.phase == 'beta' %}
-    {% include "casa/partials/phase_banner_beta.njk" %}
-  {% endif %}
-
-  {# Add back link, if appropriate #}
   {% if not inEditMode and casa.journeyPreviousUrl %}
     {{ govukBackLink({
       text: t('common:back'),
@@ -30,3 +25,25 @@
   {{- t("error:documentTtlePrefix") if formErrors -}}
   {% block casaPageTitle %}{% endblock %}
 {%- endblock %}
+
+
+{# A default content block. Override this if you want a customised form #}
+{% block content %}
+  {% if formErrorsGovukArray %}
+    {{ govukErrorSummary({
+      titleText: t("error:summary.h1"),
+      descriptionText: errorDescription or t('error:summary.defaultDescription'),
+      errorList: formErrorsGovukArray
+    }) }}
+  {% endif %}
+
+  {% call casaJourneyForm({
+    formUrl: formUrl,
+    csrfToken: casa.csrfToken,
+    inEditMode: inEditMode,
+    editOriginUrl: editOriginUrl,
+    activeContextId: activeContextId
+  }) %}
+    {% block journey_form %}{% endblock %}
+  {% endcall %}
+{% endblock %}

package/views/casa/layouts/main.njk

@@ -1,7 +1,5 @@
 {% extends "govuk/template.njk" %}
 
-{% set assetPath = govuk.assetPath %}
-
 
 {% block head %}
   {% include "casa/partials/styles.njk" %}
@@ -12,29 +10,18 @@
   {# Harcoding content for the skip link as t() may not be availble on some error pages #}
   {{ govukSkipLink({
     href: '#main-content',
-    text: 'Neidio i\'r prif gynnwys' if locale === 'cy' else 'Skip to main content'
+    text: "Neidio i'r prif gynnwys" if locale === 'cy' else 'Skip to main content'
   }) }}
 {% endblock %}
 
 
-{% block bodyStart %}
-  <div id="global-cookie-message" class="js-hidden">
-    {% include "casa/partials/cookie_message.njk" %}
-  </div>
-{% endblock %}
-
-
 {% block header %}
-  {{ govukHeader(govuk.components.header) }}
-{% endblock %}
-
-
-{% block beforeContent %}
-  {% if casa.phase == 'alpha' %}
-    {% include "casa/partials/phase_banner_alpha.njk" %}
-  {% elseif casa.phase == 'beta' %}
-    {% include "casa/partials/phase_banner_beta.njk" %}
-  {% endif %}
+  {{ govukHeader({
+    assetsPath: assetPath + "/images",
+    serviceName: t('common:serviceName') if t else '',
+    serviceUrl: casa.mountUrl,
+    homepageUrl: "https://www.gov.uk/"
+  }) }}
 {% endblock %}
 
 

package/views/casa/partials/scripts.njk

@@ -1,5 +1,10 @@
 <!-- CASA -->
-<script src="{{ casa.mountUrl }}govuk/frontend/js/all.js?{{ casa.packageVersions.govukFrontend }}"></script>
-<script src="{{ casa.mountUrl }}govuk/frontend/js/govuk-template.js?{{ casa.packageVersions.govukTemplateJinja }}"></script>
-<script src="{{ casa.mountUrl }}govuk/casa/js/casa.js?{{ casa.packageVersions.casaMain }}"></script>
+<script src="{{ casa.mountUrl }}govuk/assets/js/all.js?{{ casaVersion }}"></script>
+<script nonce="{{ cspNonce }}">
+window.GOVUKFrontend.initAll();
+if (window.history.replaceState) {
+  // Prevent re-submission of POST on refreshing page
+  window.history.replaceState(null, null, window.location.href);
+};
+</script>
 <!-- /CASA -->

package/views/casa/partials/styles.njk

@@ -1,6 +1,6 @@
 <!-- CASA -->
-<!--[if gt IE 8]><!--><link href="{{ casa.mountUrl }}govuk/casa/css/casa.css?{{ casa.packageVersions.casaMain }}" rel="stylesheet" /><!--<![endif]-->
+<!--[if gt IE 8]><!--><link href="{{ casa.mountUrl }}casa/assets/css/casa.css?{{ casaVersion }}" rel="stylesheet" /><!--<![endif]-->
 <!--[if lte IE 8]>
-<link href="{{ casa.mountUrl }}govuk/casa/css/casa-ie8.css?{{ casa.packageVersions.casaMain }}" rel="stylesheet" />
+<link href="{{ casa.mountUrl }}casa/assets/css/casa-ie8.css?{{ casaVersion }}" rel="stylesheet" />
 <![endif]-->
 <!-- /CASA -->