@dwp/govuk-casa 8.7.4 → 8.7.5

package/dist/casa.d.ts

@@ -446,6 +446,27 @@ export type PlanArbiterParams = {
     traverseOptions: PlanTraverseOptions;
 };
 export type PlanArbiter = (route: PlanArbiterParams) => PlanRoute[];
+/**
+ * Journey Context Object
+ */
+export type JourneyContextObject = {
+    /**
+     * Data
+     */
+    data?: Record<string, any> | undefined;
+    /**
+     * Validation state
+     */
+    validation?: any;
+    /**
+     * Navigation meta
+     */
+    nav?: any;
+    /**
+     * Identity meta
+     */
+    identity?: any;
+};
 import configure from "./lib/configure.js";
 import validators from "./lib/validators/index.js";
 import field from "./lib/field.js";

package/dist/casa.js

@@ -299,3 +299,10 @@ exports.nunjucksFilters = nunjucksFilters;
  * @param {PlanArbiterParams} route Route metadata
  * @returns {PlanRoute[]} Returns all routes, excluding those that the arbiter could eliminate
  */
+/**
+ * @typedef {object} JourneyContextObject Journey Context Object
+ * @property {Record<string,any>} [data] Data
+ * @property {any} [validation] Validation state
+ * @property {any} [nav] Navigation meta
+ * @property {any} [identity] Identity meta
+ */

package/dist/lib/JourneyContext.d.ts

@@ -10,6 +10,10 @@
  * @access private
  * @typedef {import('../casa').ContextEvent} ContextEvent
  */
+/**
+ * @access private
+ * @typedef {import('../casa').JourneyContextObject} JourneyContextObject
+ */
 /**
  * @access private
  * @typedef {import('express').Request} ExpressRequest
@@ -23,19 +27,10 @@ export default class JourneyContext {
     /**
      * Create a new JourneyContext using the plain object.
      *
-     * @param {object} obj Object.
-     * @param {object} obj.data Data
-     * @param {object} obj.validation Validation state
-     * @param {object} obj.nav Navigation meta
-     * @param {object} obj.identity Identity meta
+     * @param {JourneyContextObject} obj Object.
      * @returns {JourneyContext} Instance.
      */
-    static fromObject({ data, validation, nav, identity, }?: {
-        data: object;
-        validation: object;
-        nav: object;
-        identity: object;
-    }): JourneyContext;
+    static fromObject({ data, validation, nav, identity, }?: JourneyContextObject): JourneyContext;
     /**
      * Construct a new ephemeral JourneyContext instance with a unique ID.
      *
@@ -184,20 +179,20 @@ export default class JourneyContext {
      * `identity` holds information that helps uniquely identify this context
      * among a group of contexts stored in the session.
      *
-     * @param {Record<string,unknown>} data Entire journey data.
+     * @param {Record<string,any>} data Entire journey data.
      * @param {object} validation Page errors (indexed by waypoint id).
      * @param {object} nav Navigation context.
      * @param {object} identity Some metadata for identifying this context among others.
      */
-    constructor(data?: Record<string, unknown>, validation?: object, nav?: object, identity?: object);
+    constructor(data?: Record<string, any>, validation?: object, nav?: object, identity?: object);
     /**
      * Clone into an object that can be stringified.
      *
-     * @returns {object} Plain object.
+     * @returns {JourneyContextObject} Plain object.
      */
-    toObject(): object;
-    set data(arg: Record<string, unknown>);
-    get data(): Record<string, unknown>;
+    toObject(): JourneyContextObject;
+    set data(arg: Record<string, any>);
+    get data(): Record<string, any>;
     get validation(): object;
     get nav(): object;
     get identity(): object;
@@ -354,5 +349,6 @@ export default class JourneyContext {
 export type Page = import('../casa').Page;
 export type ContextEventHandler = import('../casa').ContextEventHandler;
 export type ContextEvent = import('../casa').ContextEvent;
+export type JourneyContextObject = import('../casa').JourneyContextObject;
 export type ExpressRequest = import('express').Request;
 import ValidationError from "./ValidationError.js";

package/dist/lib/JourneyContext.js

@@ -54,6 +54,10 @@ const log = (0, logger_js_1.default)('lib:journey-context');
  * @access private
  * @typedef {import('../casa').ContextEvent} ContextEvent
  */
+/**
+ * @access private
+ * @typedef {import('../casa').JourneyContextObject} JourneyContextObject
+ */
 /**
  * @access private
  * @typedef {import('express').Request} ExpressRequest
@@ -88,7 +92,7 @@ class JourneyContext {
      * `identity` holds information that helps uniquely identify this context
      * among a group of contexts stored in the session.
      *
-     * @param {Record<string,unknown>} data Entire journey data.
+     * @param {Record<string,any>} data Entire journey data.
      * @param {object} validation Page errors (indexed by waypoint id).
      * @param {object} nav Navigation context.
      * @param {object} identity Some metadata for identifying this context among others.
@@ -111,7 +115,7 @@ class JourneyContext {
     /**
      * Clone into an object that can be stringified.
      *
-     * @returns {object} Plain object.
+     * @returns {JourneyContextObject} Plain object.
      */
     toObject() {
         return Object.assign(Object.create(null), {
@@ -124,11 +128,7 @@ class JourneyContext {
     /**
      * Create a new JourneyContext using the plain object.
      *
-     * @param {object} obj Object.
-     * @param {object} obj.data Data
-     * @param {object} obj.validation Validation state
-     * @param {object} obj.nav Navigation meta
-     * @param {object} obj.identity Identity meta
+     * @param {JourneyContextObject} obj Object.
      * @returns {JourneyContext} Instance.
      */
     static fromObject({ data = Object.create(null), validation = Object.create(null), nav = Object.create(null), identity = Object.create(null), } = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "8.7.4",
+  "version": "8.7.5",
   "description": "A framework for building GOVUK Collect-And-Submit-Applications",
   "repository": {
     "type": "git",
@@ -76,15 +76,15 @@
     "@dwp/casa-spiderplan-a11y-plugin": "0.1.8",
     "@dwp/casa-spiderplan-zap-plugin": "0.1.4",
     "@dwp/eslint-config-base": "6.0.0",
-    "@types/express": "4.17.14",
-    "@types/node": "18.11.13",
+    "@types/express": "4.17.15",
+    "@types/node": "18.11.16",
     "@types/nunjucks": "3.2.1",
     "c8": "7.12.0",
     "chai": "4.3.7",
     "cheerio": "1.0.0-rc.12",
     "commitlint": "17.3.0",
     "docdash": "2.0.0",
-    "eslint": "8.29.0",
+    "eslint": "8.30.0",
     "eslint-plugin-no-unsafe-regex": "1.0.0",
     "eslint-plugin-security": "1.5.0",
     "eslint-plugin-sonarjs": "0.17.0",
@@ -92,8 +92,8 @@
     "jsdoc": "4.0.0",
     "jsdoc-tsimport-plugin": "1.0.5",
     "mocha": "10.2.0",
-    "sass": "1.56.2",
-    "sinon": "14.0.2",
+    "sass": "1.57.0",
+    "sinon": "15.0.1",
     "sinon-chai": "3.7.0",
     "supertest": "6.3.3",
     "typescript": "4.9.4"