@dwp/govuk-casa 8.2.4 → 8.2.5

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [8.2.5](https://github.com/dwp/govuk-casa/compare/8.2.3...8.2.5) (2022-06-01)
+
+
+### Bug Fixes
+
+* serve statics correctly from deeply nested apps ([0fd00a5](https://github.com/dwp/govuk-casa/commit/0fd00a5f10de28706afe87a993072d3184e3c7aa))
+
 ### [8.2.3](https://github.com/dwp/govuk-casa/compare/8.2.2...8.2.3) (2022-05-23)
 
 ### [8.2.2](https://github.com/dwp/govuk-casa/compare/8.2.1...8.2.2) (2022-05-23)

package/dist/casa.d.ts

@@ -1,5 +1,5 @@
 export type PageField = import('./lib/field').PageField;
-export type ContextEventHandler = (journeyContext: JourneyContext, previousContext: JourneyContext) => void;
+export type ContextEventHandler = (opts: object, journeyContext: JourneyContext, previousContext: JourneyContext, session: object) => void;
 export type ContextEvent = {
     /**
      * Waypoint to watch for changes
@@ -108,13 +108,14 @@ export type IPlugin = {
     /**
      * Modify the app config
      */
-    configure?: Function | undefined;
+    configure?: PluginConfigureFunction | undefined;
     /**
      * Modify post-configuration artifacts
      */
-    bootstrap?: Function | undefined;
+    bootstrap?: PluginBootstrapFunction | undefined;
 };
-export type PluginConfigureFunction = (config: object) => any;
+export type PluginConfigureFunction = (config: ConfigurationOptions) => any;
+export type PluginBootstrapFunction = (config: ConfigureResult) => any;
 export type HelmetConfigurator = (config: object) => object;
 export type Mounter = (app: import('express').Express, opts: object, route?: string | undefined) => import('express').Express;
 export type MutableRouter = import('./lib/index').MutableRouter;
@@ -153,11 +154,15 @@ export type ConfigurationOptions = {
     /**
      * CASA Plan
      */
-    plan: Plan;
+    plan?: Plan | undefined;
     /**
      * Handlers for JourneyContext events
      */
     events?: ContextEvent[] | undefined;
+    /**
+     * Helmet configuration manipulator function
+     */
+    helmetConfigurator?: HelmetConfigurator | undefined;
 };
 /**
  * Result of a call to configure() function
@@ -211,6 +216,10 @@ export type ConfigureResult = {
      * Function used to mount all CASA artifacts onto an ExpressJS app
      */
     mount: Mounter;
+    /**
+     * Ingested config supplied to `configure()`
+     */
+    config: ConfigurationOptions;
 };
 /**
  * Configuration for generating a ValidationError.

package/dist/casa.js

@@ -55,8 +55,10 @@ exports.nunjucksFilters = nunjucksFilters;
  */
 /**
  * @callback ContextEventHandler
- * @param {JourneyContext} journeyContext Context including changes
- * @param {JourneyContext} previousContext Context prior to changes
+ * @param {object} opts Options
+ * @param {JourneyContext} opts.journeyContext Context including changes
+ * @param {JourneyContext} opts.previousContext Context prior to changes
+ * @param {object} opts.session Request session object
  * @returns {void}
  */
 /**
@@ -99,12 +101,16 @@ exports.nunjucksFilters = nunjucksFilters;
  */
 /**
  * @typedef {object} IPlugin Plugin interface
- * @property {Function} [configure] Modify the app config
- * @property {Function} [bootstrap] Modify post-configuration artifacts
+ * @property {PluginConfigureFunction} [configure] Modify the app config
+ * @property {PluginBootstrapFunction} [bootstrap] Modify post-configuration artifacts
  */
 /**
  * @callback PluginConfigureFunction
- * @param {object} config Options
+ * @param {ConfigurationOptions} config Options
+ */
+/**
+ * @callback PluginBootstrapFunction
+ * @param {ConfigureResult} config Options
  */
 /**
  * @callback HelmetConfigurator
@@ -115,7 +121,7 @@ exports.nunjucksFilters = nunjucksFilters;
  * @callback Mounter
  * @param {import('express').Express} app Express application
  * @param {object} opts Mounting options
- * @param {string} [opts.route=/] Optional route to attach all middleware/routers too
+ * @param {string} [opts.route='/'] Optional route to attach all middleware/routers too
  * @returns {import('express').Express} The prepared ExpressJS app instance
  */
 /**
@@ -132,8 +138,9 @@ exports.nunjucksFilters = nunjucksFilters;
  * @property {GlobalHook[]} [hooks=[]] Hooks to apply
  * @property {IPlugin[]} [plugins=[]] Plugins
  * @property {I18nOptions[]} [i18n] I18n configuration
- * @property {Plan} plan CASA Plan
+ * @property {Plan} [plan] CASA Plan
  * @property {ContextEvent[]} [events=[]] Handlers for JourneyContext events
+ * @property {HelmetConfigurator} [helmetConfigurator] Helmet configuration manipulator function
  */
 /**
  * @typedef {object} ConfigureResult Result of a call to configure() function
@@ -149,6 +156,7 @@ exports.nunjucksFilters = nunjucksFilters;
  * @property {import('express').RequestHandler[]} i18nMiddleware I18n preparation middleware
  * @property {import('express').RequestHandler} bodyParserMiddleware Body parsing middleware
  * @property {Mounter} mount Function used to mount all CASA artifacts onto an ExpressJS app
+ * @property {ConfigurationOptions} config Ingested config supplied to `configure()`
  */
 /**
  * Configuration for generating a ValidationError.

package/dist/lib/JourneyContext.js

@@ -466,10 +466,19 @@ class JourneyContext {
      * @returns {void}
      */
     static initContextStore(session) {
+        // For existing sessions that were created prior to `journeyContextList`
+        // being remodelled as an array, we need to convert the "legacy" structure
+        // into an equivalent array.
+        if (isPlainObject(session === null || session === void 0 ? void 0 : session.journeyContextList)) {
+            log.trace('Session context list already initialised as an object (legacy structure). Will convert from object to array.');
+            /* eslint-disable-next-line no-param-reassign */
+            session.journeyContextList = Object.entries(session.journeyContextList);
+        }
+        // Initialise new context list in the session
         if (!has(session, 'journeyContextList')) {
             log.trace('Initialising session with a default journey context list');
             /* eslint-disable-next-line no-param-reassign */
-            session.journeyContextList = Object.create(null);
+            session.journeyContextList = [];
             const defaultContext = new JourneyContext();
             defaultContext.identity.id = JourneyContext.DEFAULT_CONTEXT_ID;
             JourneyContext.putContext(session, defaultContext);
@@ -515,10 +524,11 @@ class JourneyContext {
      * @returns {JourneyContext} The discovered JourneyContext instance
      */
     static getContextById(session, id) {
-        if (has(session === null || session === void 0 ? void 0 : session.journeyContextList, id)) {
+        const list = new Map(session === null || session === void 0 ? void 0 : session.journeyContextList);
+        if (list.has(id)) {
             // ESLint disabled as `id` has been verified as an "own" property
             /* eslint-disable-next-line security/detect-object-injection */
-            return JourneyContext.fromObject(session.journeyContextList[id]);
+            return JourneyContext.fromObject(list.get(id));
         }
         return undefined;
     }
@@ -531,7 +541,8 @@ class JourneyContext {
      */
     static getContextByName(session, name) {
         if (session) {
-            const context = Object.values(session.journeyContextList).find((c) => (c.identity.name === name));
+            const list = new Map(session === null || session === void 0 ? void 0 : session.journeyContextList);
+            const context = [...list.values()].find((c) => (c.identity.name === name));
             if (context) {
                 return JourneyContext.fromObject(context);
             }
@@ -547,7 +558,8 @@ class JourneyContext {
      */
     static getContextsByTag(session, tag) {
         if (session) {
-            return Object.values(session.journeyContextList).filter((c) => { var _a; return ((_a = c.identity.tags) === null || _a === void 0 ? void 0 : _a.includes(tag)); }).map((c) => (JourneyContext.fromObject(c)));
+            const list = new Map(session === null || session === void 0 ? void 0 : session.journeyContextList);
+            return [...list.values()].filter((c) => { var _a; return ((_a = c.identity.tags) === null || _a === void 0 ? void 0 : _a.includes(tag)); }).map((c) => (JourneyContext.fromObject(c)));
         }
         return undefined;
     }
@@ -559,7 +571,7 @@ class JourneyContext {
      */
     static getContexts(session) {
         if (has(session, 'journeyContextList')) {
-            return Object.values(session.journeyContextList).map((contextObj) => (JourneyContext.fromObject(contextObj)));
+            return session.journeyContextList.map(([, contextObj]) => (JourneyContext.fromObject(contextObj)));
         }
         return [];
     }
@@ -594,8 +606,10 @@ class JourneyContext {
             event: 'context-change',
             session,
         });
+        const list = new Map(session.journeyContextList);
+        list.set(context.identity.id, context.toObject());
         /* eslint-disable-next-line no-param-reassign */
-        session.journeyContextList[context.identity.id] = context.toObject();
+        session.journeyContextList = [...list.entries()];
     }
     /**
      * Remove a context from the session store.
@@ -617,10 +631,10 @@ class JourneyContext {
      * @returns {void}
      */
     static removeContextById(session, id) {
-        if (session && has(session.journeyContextList, id)) {
-            // ESLint disabled as `id` has been verified as an "own" property
-            /* eslint-disable-next-line security/detect-object-injection, no-param-reassign */
-            delete session.journeyContextList[id];
+        var _a;
+        const index = ((_a = session === null || session === void 0 ? void 0 : session.journeyContextList) !== null && _a !== void 0 ? _a : []).findIndex(([contextId]) => contextId === id);
+        if (index > -1) {
+            session.journeyContextList.splice(index, 1);
         }
     }
     /**

package/dist/lib/configure.js

@@ -51,6 +51,7 @@ function configure(config = {}) {
         plugin.configure(config);
     });
     // Extract config
+    const ingestedConfig = (0, configuration_ingestor_js_1.default)(config);
     const { mountUrl, views = [], session = {
         secret: 'secret',
         name: 'casasession',
@@ -62,7 +63,7 @@ function configure(config = {}) {
     }, pages = [], plan = null, hooks = [], plugins = [], events = [], i18n = {
         dirs: [],
         locales: ['en', 'cy'],
-    }, helmetConfigurator = undefined, } = (0, configuration_ingestor_js_1.default)(config);
+    }, helmetConfigurator = undefined, } = ingestedConfig;
     // Prepare all page hooks so they are prefixed with the `journey.` scope.
     pages.forEach((page) => {
         var _a;
@@ -214,6 +215,8 @@ function configure(config = {}) {
         dataMiddleware,
         // Mount function
         mount,
+        // Ingested config
+        config: ingestedConfig,
     };
     // Bootstrap all plugins
     plugins.filter((p) => p.bootstrap).forEach((plugin) => plugin === null || plugin === void 0 ? void 0 : plugin.bootstrap(configOutput));

package/dist/lib/utils.js

@@ -148,7 +148,7 @@ function validateHookName(hookName) {
     if (!hookName.length) {
         throw new SyntaxError('Hook name must not be empty');
     }
-    if (!hookName.match(/^([a-z]+\.|)[a-z]+$/i)) {
+    if (!hookName.match(/^([a-z_]+\.|)[a-z_]+$/i)) {
         throw new SyntaxError('Hook name must match either <scope>.<hookname> or <hookname> formats');
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "8.2.4",
+  "version": "8.2.5",
   "description": "A framework for building GOVUK Collect-And-Submit-Applications",
   "repository": {
     "type": "git",