@dwp/govuk-casa 7.0.6 → 8.0.0-beta1

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 -->

package/casa.js

@@ -1,208 +0,0 @@
-/**
- * CASA configuration entry point.
- *
- * Once your CASA app instance is created, you must attach your own project
- * route handlers to the Express router generated by CASA; available in the
- * `.router` property of the returned CASA app instance.
- */
-
-const util = require('util');
-
-// Globals
-// @deprecated
-global.GOVUK_CASA_DIR = __dirname;
-
-// Deps
-const expressJs = require('express');
-const favicon = require('serve-favicon');
-const path = require('path');
-const nutil = require('util');
-
-const logger = require('./lib/Logger.js')('boot');
-const I18n = require('./lib/I18n.js');
-const { ingest } = require('./lib/ConfigIngestor.js');
-const Util = require('./lib/Util.js');
-
-const endSession = require('./lib/bootstrap/end-session.js');
-const loadDefinitionsConstructor = require('./lib/bootstrap/load-definitions.js');
-
-const mwCsrfProtection = require('./middleware/page/csrf.js');
-const mwHeaders = require('./middleware/headers/index.js');
-const mwI18n = require('./middleware/i18n/index.js');
-const mwMount = require('./middleware/mount/index.js');
-const mwNunjucks = require('./middleware/nunjucks/index.js');
-const mwSession = require('./middleware/session/index.js');
-const mwStatic = require('./middleware/static/index.js');
-const mwVariables = require('./middleware/variables/index.js');
-
-// Ingest config
-function ingestConfig(config) {
-  try {
-    const validatedConfig = ingest(config);
-    const jsonConfig = JSON.stringify(validatedConfig, (k, v) => (['store', 'secret'].indexOf(k) > -1 ? '[NOT PARSED]' : v));
-    logger.info('Parsed config: %s', jsonConfig);
-    return validatedConfig;
-  } catch (ex) {
-    throw new Error(nutil.format('[CONFIG ERROR] %s', ex.message));
-  }
-}
-
-// Make an I18nUtility instance
-function i18nFactory(dirs = [], locales = []) {
-  const localeDirs = [
-    path.resolve(__dirname, './locales'),
-    ...dirs,
-  ];
-  return I18n(localeDirs, locales);
-}
-
-// Mount all the required CASA middleware
-function mountCasaMiddleware(app, config, i18nUtility) {
-  const staticModulePaths = {
-    govukFrontend: Util.resolveModulePath('govuk-frontend', module.paths),
-    govukTemplateJinja: Util.resolveModulePath('govuk_template_jinja', module.paths),
-    govukCasa: __dirname,
-  };
-
-  // Serve default, implicit favicon
-  app.use(config.proxyMountUrl, favicon(require.resolve('govuk-frontend/govuk/assets/images/favicon.ico')));
-
-  mwHeaders(app, config.csp, config.headers.disabled);
-  mwMount(app, config.mountUrl);
-  mwStatic({
-    app,
-    mountUrl: config.mountUrl,
-    proxyMountUrl: config.proxyMountUrl,
-    compiledAssetsDir: config.compiledAssetsDir,
-    npmPackages: staticModulePaths,
-  });
-  mwNunjucks(app, config.views.dirs, staticModulePaths.govukFrontend);
-  mwSession(
-    app,
-    config.mountUrl,
-    config.sessionExpiryController,
-    {
-      secure: config.sessions.secure,
-      store: config.sessions.store,
-      name: config.sessions.name,
-      secret: config.sessions.secret,
-      cookiePath: config.sessions.cookiePath,
-      cookieSameSite: config.sessions.cookieSameSite,
-      ttl: config.sessions.ttl,
-    },
-  );
-  mwI18n(app, config.i18n.locales, i18nUtility);
-  mwVariables(app, config.mountUrl, config.phase, config.serviceName);
-}
-
-/**
- * Prepare an Express app to run as a CASA application.
- *
- * @param {express} expressApp The ExpressJS app to decorate.
- * @param {object} config CASA configuration.
- * @returns {object} CASA assets.
- */
-function CasaBootstrap(expressApp, config) {
-  // Create a Router instance on which some CASA middleware will be mounted
-  const expressRouter = expressJs.Router();
-
-  // Ingest config
-  const validatedConfig = ingestConfig(config);
-
-  // Create a configured I18n utility instance
-  const i18nUtility = i18nFactory(validatedConfig.i18n.dirs, validatedConfig.i18n.locales);
-
-  // Prepare a `casa` namespace on both the request and response `locals`
-  // objects, which will house various variables, accumulated through middleware.
-  expressApp.use((req, res, next) => {
-    req.casa = Object.create(null);
-    res.locals.casa = Object.create(null);
-    next();
-  });
-
-  // Mount all CASA pre-journey middleware, allowing `mountController` - if
-  // specified - to control the mounting order
-  const mountCallback = mountCasaMiddleware.bind(null, expressApp, validatedConfig, i18nUtility);
-  if (typeof validatedConfig.mountController === 'function') {
-    validatedConfig.mountController.call({ expressApp, expressRouter }, mountCallback);
-  } else {
-    mountCallback();
-  }
-
-  // Mount the router onto the path defined in `proxyMountUrl`.
-  // This must be done after all CASA middleware has been mounted.
-  expressApp.use(validatedConfig.proxyMountUrl, expressRouter);
-  logger.info('Routes mounted onto %s', validatedConfig.proxyMountUrl);
-
-  return {
-    config: validatedConfig,
-    router: expressRouter,
-    loadDefinitions: loadDefinitionsConstructor(expressApp, expressRouter, validatedConfig),
-    csrfMiddleware: mwCsrfProtection,
-    endSession,
-  };
-}
-
-/* eslint-disable global-require */
-const modules = {
-  // Bootstrap
-  configure: CasaBootstrap,
-  ConfigIngestor: require('./lib/ConfigIngestor.js'),
-  middleware: require('./middleware/index.js'),
-  endSession: require('./lib/bootstrap/end-session.js'),
-
-  // Page meta
-  gatherModifiers: require('./lib/gather-modifiers/index.js'),
-  PageDirectory: require('./lib/PageDirectory.js'),
-
-  // Validation
-  validationRules: require('./lib/validation/rules/index.js'),
-  validationProcessor: require('./lib/validation/processor.js'),
-  arrayObjectFieldValidation: require('./lib/validation/ArrayObjectField.js'),
-  objectFieldValidation: require('./lib/validation/ObjectField.js'),
-  simpleFieldValidation: require('./lib/validation/SimpleField.js'),
-  ValidationError: require('./lib/validation/ValidationError.js'),
-  ValidatorFactory: require('./lib/validation/ValidatorFactory.js'),
-
-  // User journey elements
-  Plan: require('./lib/Plan.js'),
-  JourneyContext: require('./lib/JourneyContext.js'),
-
-  // Utilities
-  utils: require('./lib/utils/index.js'),
-};
-
-// Add test utilities
-// Here we're using lazy-loading as the test utils will only be needed during
-// development/build rather than runtime.
-Object.defineProperty(modules, 'testutils', {
-  get: () => (require('./test/utils/index.js')),
-});
-
-module.exports = modules;
-
-/* -------------------------------------------------------- Deprecated assets */
-
-const JourneyMapDeprecated = require('./lib/JourneyMap.js');
-const JourneyRoadDeprecated = require('./lib/JourneyRoad.js');
-
-module.exports.JourneyData = function JourneyData(...args) {
-  return util.deprecate(
-    () => new module.exports.JourneyContext(...args),
-    'JourneyData is deprecated. Use JourneyContext instead.',
-  )();
-}
-
-module.exports.JourneyRoad = function JourneyRoad(...args) {
-  return util.deprecate(
-    () => new JourneyRoadDeprecated(...args),
-    'JourneyRoad is deprecated. Use Plan for building user journey plans instead.',
-  )();
-}
-
-module.exports.JourneyMap = function JourneyMap(...args) {
-  return util.deprecate(
-    () => new JourneyMapDeprecated(...args),
-    'JourneyMap is deprecated. Use Plan for building user journey plans instead.',
-  )();
-}

package/definitions/review-page.js

@@ -1,60 +0,0 @@
-/**
- * Definition for the built-in 'review' page in CASA.
- */
-
-const JourneyContext = require('../lib/JourneyContext.js');
-const { rules, SimpleField } = require('../lib/validation/index.js');
-const { createGetRequest } = require('../lib/utils/index.js');
-
-module.exports = function reviewPageDefinition(pagesMeta = {}) {
-  return {
-    view: 'casa/review/review.njk',
-    fieldValidators: {
-      reviewed: SimpleField([
-        rules.required,
-      ]),
-    },
-    hooks: {
-      prerender(req, res, next) {
-        req.casa = req.casa || Object.create(null);
-
-        // Determine active journey in order to define the "edit origin" URL,
-        // and make journey data and errors available to templates
-        const userJourney = req.casa.plan;
-        const { journeyOrigin } = req.casa;
-        res.locals.changeUrlPrefix = `${res.locals.casa.mountUrl}${journeyOrigin.originId || ''}/`.replace(/\/+/g, '/');
-        res.locals.journeyContext = req.casa.journeyContext.getData();
-        res.locals.reviewErrors = req.casa.journeyContext.getValidationErrors();
-
-        // Determine which pages have been traversed in the user's journey in
-        // order to get to this review point (not all journey waypoints will
-        // have been touched, but may contain data which needs to be ignored)
-        let waypointsTraversed;
-        const traversalOptions = {
-          startWaypoint: journeyOrigin.waypoint,
-        };
-        if (req.casa.journeyContext) {
-          waypointsTraversed = userJourney.traverse(req.casa.journeyContext, traversalOptions);
-        } else {
-          waypointsTraversed = userJourney.traverse(new JourneyContext(), traversalOptions);
-        }
-        res.locals.reviewBlocks = waypointsTraversed.map((waypointId) => {
-          const meta = pagesMeta[waypointId] || Object.create(null);
-          return meta.reviewBlockView ? {
-            waypointId,
-            waypointEditUrl: createGetRequest({
-              mountUrl: res.locals.casa.mountUrl,
-              waypoint: `${journeyOrigin.originId || ''}/${waypointId}`,
-              editMode: true,
-              editOrigin: req.editOriginUrl,
-              contextId: req.casa.journeyContext.identity.id,
-            }),
-            reviewBlockView: meta.reviewBlockView,
-          } : null;
-        }).filter((o) => o !== null);
-
-        next();
-      },
-    },
-  };
-};