@dwp/govuk-casa 9.5.1 → 9.6.0

package/src/casa.js

@@ -9,6 +9,7 @@ import ValidationError from "./lib/ValidationError.js";
 import MutableRouter from "./lib/MutableRouter.js";
 import waypointUrl from "./lib/waypoint-url.js";
 import endSession from "./lib/end-session.js";
+import { generateGovukErrors } from "./routes/journey.js";
 import * as nunjucksFilters from "./lib/nunjucks-filters.js";
 import * as constants from "./lib/constants.js";
 import * as contextIdGenerators from "./lib/context-id-generators.js";
@@ -28,6 +29,7 @@ export {
   // Utilities
   waypointUrl,
   endSession,
+  generateGovukErrors,
 
   // Nunjucks filters
   nunjucksFilters,
@@ -88,6 +90,8 @@ export {
 /**
  * @typedef {object} I18nOptions
  * @property {string[]} dirs Directories to search for locale dictionaries
+ * @property {string | false} [fallbackLng=false] Fallback language to use if
+ *   translations aren't available for a given key. Default is `false`
  * @property {string[]} [locales=['en', 'cy']] Supported locales. Default is
  *   `['en', 'cy']`
  */
@@ -186,6 +190,8 @@ export {
  *   generator
  * @property {symbol | Function} [errorVisibility] Option to keep page errors
  *   active on GET request
+ * @property {boolean} [govukRebrand=false] Sets whether you wish to use the
+ *   govuk rebrand. Default is `false`
  */
 
 /**

package/src/lib/configuration-ingestor.js

@@ -124,6 +124,34 @@ export function validateI18nLocales(locales = ["en", "cy"]) {
   return locales;
 }
 
+/**
+ * Validates the i18n fallback language.
+ *
+ * @param {string} [fallback] Locale
+ * @param {Array} locales Array of valid locales.
+ * @returns {string} Fallback locale
+ * @throws {SyntaxError} For invalid locales.
+ * @throws {TypeError} For invalid type.
+ * @access private
+ */
+export function validateI18nFallbackLng(fallback, locales = ["en", "cy"]) {
+  if (fallback === undefined) {
+    return false;
+  }
+  if (typeof fallback !== "string") {
+    throw new TypeError(
+      "I18n fallback language must be a string (i18n.fallbackLng)",
+    );
+  }
+  if (!locales.includes(fallback)) {
+    throw new SyntaxError(
+      "I18n fallback language must be included in the locales array (i18n.fallbackLng)",
+    );
+  }
+
+  return fallback;
+}
+
 /**
  * Validates and sanitises mount url.
  *
@@ -606,6 +634,24 @@ export function validateContextIdGenerator(generator) {
   return generator;
 }
 
+/**
+ * Validates the govuk rebrand feature flag.
+ *
+ * @param {boolean} [govukRebrand] Govuk rebrand feature flag
+ * @returns {boolean | true} Boolean.
+ * @throws {TypeError} For invalid feagure flag is set.
+ * @access private
+ */
+export function validateGovukRebrand(govukRebrand) {
+  if (govukRebrand === undefined) {
+    return false;
+  }
+  if (typeof govukRebrand !== "boolean") {
+    throw new TypeError("govukRebrand must be a boolean");
+  }
+  return govukRebrand;
+}
+
 /**
  * Ingest, validate, sanitise and manipulate configuration parameters.
  *
@@ -620,6 +666,7 @@ export default function ingest(config = {}) {
     i18n: validateI18nObject(config.i18n, (i18n) => ({
       dirs: validateI18nDirs(i18n.dirs),
       locales: validateI18nLocales(i18n.locales),
+      fallbackLng: validateI18nFallbackLng(i18n.fallbackLng, i18n.locales),
     })),
 
     // URL that will prefix all URLs in the browser address bar
@@ -669,6 +716,8 @@ export default function ingest(config = {}) {
 
     // Context ID generator
     contextIdGenerator: validateContextIdGenerator(config.contextIdGenerator),
+
+    govukRebrand: validateGovukRebrand(config.govukRebrand),
   };
 
   // Freeze to modifications

package/src/lib/configure.js

@@ -81,6 +81,7 @@ export default function configure(config = {}) {
     formMaxParams,
     formMaxBytes,
     contextIdGenerator,
+    govukRebrand = false,
   } = ingestedConfig;
 
   // Prepare all page hooks so they are prefixed with the `journey.` scope.
@@ -100,6 +101,7 @@ export default function configure(config = {}) {
       resolve(dirname, "../../views"),
       resolve(createRequire(dirname).resolve("govuk-frontend"), "../../"),
     ],
+    govukRebrand,
   });
 
   // Prepare mandatory middleware
@@ -133,6 +135,7 @@ export default function configure(config = {}) {
     plan,
     events,
     contextIdGenerator,
+    govukRebrand,
   });
 
   // Prepare form middleware and its constituent parts
@@ -182,6 +185,8 @@ export default function configure(config = {}) {
     // Nunjucks environment, so it can be attached to other ExpressJS instances
     // using `nunjucksEnv.express(myApp); myApp.set('view engine', 'njk');`.
     nunjucksEnv,
+    // govuk rebrand flag
+    govukRebrand,
 
     // Mandatory middleware. User must add these to their ExpressJS app.
     preMiddleware,

package/src/lib/nunjucks.js

@@ -20,10 +20,11 @@ import {
  * Create a Nunjucks environment.
  *
  * @param {NunjucksOptions} options Nunjucks options
+ * @param {boolean} govukRebrand GovukRebrand flag
  * @returns {Environment} Nunjucks Environment instance
  * @access private
  */
-export default function nunjucksConfig({ views = [] }) {
+export default function nunjucksConfig({ views = [], govukRebrand }) {
   // Prepare a single Nunjucks environment for all responses to use. Note that
   // we cannot prepare response-specific global functions/filters if we use a
   // single environment, but the performance gains of doing so are significant.
@@ -50,6 +51,7 @@ export default function nunjucksConfig({ views = [] }) {
     JSON.parse(readFileSync(resolve(dirname, "../../package.json"))).version,
   );
 
+  env.addGlobal("govukRebrand", govukRebrand);
   env.addGlobal("mergeObjects", mergeObjects);
   env.addGlobal("includes", includes);
   env.addGlobal("formatDateObject", formatDateObject);

package/src/middleware/data.js

@@ -43,9 +43,16 @@ const editOrigin = (req) => {
  * @param {Plan} opts.plan CASA Plan
  * @param {ContextEventHandler[]} opts.events Event handlers
  * @param {ContextIdGenerator} opts.contextIdGenerator Content ID generator
+ * @param {boolean} ops.govukRebrand Govuk rebrand feature flag
+ * @param opts.govukRebrand
  * @returns {RequestHandler[]} Middleware functions
  */
-export default function dataMiddleware({ plan, events, contextIdGenerator }) {
+export default function dataMiddleware({
+  plan,
+  events,
+  contextIdGenerator,
+  govukRebrand,
+}) {
   return [
     (req, res, next) => {
       /* ------------------------------------------------ Request decorations */
@@ -124,7 +131,8 @@ export default function dataMiddleware({ plan, events, contextIdGenerator }) {
       //   htmlLang = req.language is provided by i18n-http-middleware
       //   assetPath = used for linking to static assets in the govuk-frontend module
       res.locals.htmlLang = req.language;
-      res.locals.assetPath = `${staticMountUrl}govuk/assets`;
+      const rebrandAssetPath = govukRebrand ? "/rebrand" : "";
+      res.locals.assetPath = `${staticMountUrl}govuk/assets${rebrandAssetPath}`;
 
       // Function for building URLs. This will be curried with the `mountUrl`,
       // `journeyContext`, `edit` and `editOrigin` for convenience. This means

package/src/routes/journey.js

@@ -27,6 +27,14 @@ const log = logger("routes:journey");
  * @access private
  */
 
+/** @typedef {import("../casa.js").ValidationError} ValidationError */
+
+/**
+ * @typedef {object} GovUkErrorObject
+ * @property {string} text Error message text
+ * @property {string} href Error message anchor href
+ */
+
 /**
  * @typedef {object} JourneyRouterOptions Options to configure static router
  * @property {GlobalHook[]} globalHooks Global hooks
@@ -62,13 +70,14 @@ const renderMiddlewareFactory = (view, contextFactory) => [
 ];
 
 /**
- * Generate page validation error
+ * Generate page validation errors
  *
- * @param {object} errors Object of page validation error
- * @param {object} req Casa request object
- * @returns {object[]} Array of error objects
+ * @param {Record<string, ValidationError>} errors Object of page validation
+ *   errors
+ * @param {import("express").Request} req Casa request object
+ * @returns {GovUkErrorObject[]} Array of error objects
  */
-const generateGovukErrors = (errors, req) =>
+export const generateGovukErrors = (errors, req) =>
   Object.values(errors || {}).map(([error]) => ({
     text: req.t(error.summary, error.variables),
     href: error.fieldHref,

package/views/casa/layouts/main.njk

@@ -1,5 +1,5 @@
 {% extends "govuk/template.njk" %}
-
+{% from "govuk/components/service-navigation/macro.njk" import govukServiceNavigation %}
 
 {% block head %}
   {% include "casa/partials/styles.njk" %}
@@ -16,13 +16,26 @@
 
 
 {% block header %}
-  {{ govukHeader({
-    assetsPath: assetPath + "/images",
-    serviceName: t('common:serviceName') if t else '',
-    serviceUrl: casa.mountUrl,
-    homepageUrl: "https://www.gov.uk/",
-    useTudorCrown: true
-  }) }}
+
+  {% if govukRebrand %}
+    {{ govukHeader({
+      homepageUrl: "https://www.gov.uk/"
+    }) }}
+    {% block serviceNavigation %}
+      {{ govukServiceNavigation({
+        serviceName: t('common:serviceName') if t else '',
+        serviceUrl: casa.mountUrl
+      }) }}
+    {% endblock %}
+  {% else %}
+    {{ govukHeader({
+        assetsPath: assetPath + "/images",
+        serviceName: t('common:serviceName') if t else '',
+        serviceUrl: casa.mountUrl,
+        homepageUrl: "https://www.gov.uk/",
+        useTudorCrown: true
+      }) }}
+  {% endif %}
 {% endblock %}