@dwp/govuk-casa 6.8.4 → 6.9.0

package/lib/ConfigIngestor.js

@@ -8,9 +8,9 @@ const echo = (a) => (a);
 /**
  * Validate allow page edit flag.
  *
- * @param {boolean} allowPageEdit Flag
- * @throws {TypeError} for invalid argument type
- * @returns {boolean} flag
+ * @param {boolean} allowPageEdit Flag.
+ * @throws {TypeError} For invalid argument type.
+ * @returns {boolean} Flag.
  */
 function validateAllowPageEdit(allowPageEdit = false) {
   if (typeof allowPageEdit !== 'boolean') {
@@ -22,9 +22,9 @@ function validateAllowPageEdit(allowPageEdit = false) {
 /**
  * Validate use sticky edit flag.
  *
- * @param {boolean} useStickyEdit Flag
- * @throws {TypeError} for invalid argument type
- * @returns {boolean} flag
+ * @param {boolean} useStickyEdit Flag.
+ * @throws {TypeError} For invalid argument type.
+ * @returns {boolean} Flag.
  */
 function validateUseStickyEdit(useStickyEdit = false) {
   if (typeof useStickyEdit !== 'boolean') {
@@ -36,12 +36,13 @@ function validateUseStickyEdit(useStickyEdit = false) {
 /**
  * Validates directory and checks that it is writeable.
  *
- * @param {string} compiledAssetsDir Directory
- * @throws {ReferenceError} for missing directory value
- * @throws {Error} for missing directory
- * @returns {string} directory
+ * @param {string} compiledAssetsDir Directory.
+ * @param {boolean} skipAssetsGeneration skip static assets generation
+ * @throws {ReferenceError} For missing directory value.
+ * @throws {Error} For missing directory.
+ * @returns {string} Directory.
  */
-function validateCompiledAssetsDir(compiledAssetsDir) {
+function validateCompiledAssetsDir(compiledAssetsDir, skipAssetsGeneration = false) {
   if (typeof compiledAssetsDir === 'undefined') {
     throw new ReferenceError('Compiled assets directory required (compiledAssetsDir)');
   }
@@ -50,7 +51,10 @@ function validateCompiledAssetsDir(compiledAssetsDir) {
   try {
     /* eslint-disable no-bitwise */
     const constants = fs.constants || fs;
-    fs.accessSync(cad, constants.F_OK | constants.R_OK | constants.W_OK);
+    const permissions = skipAssetsGeneration
+      ? (constants.F_OK | constants.R_OK)
+      : (constants.F_OK | constants.R_OK | constants.W_OK);
+    fs.accessSync(cad, permissions);
   } catch (err) {
     if (err.code === 'ENOENT') {
       err.message = 'Compiled assets directory missing (compiledAssetsDir)';
@@ -64,10 +68,10 @@ function validateCompiledAssetsDir(compiledAssetsDir) {
 /**
  * Validate and sanitise CSP directives.
  *
- * @param {object} csp CSP directive and values pairs
- * @throws {TypeError} for invalid argument type
- * @throws {Error} for scriptSources warning
- * @returns {object} validated CSPs
+ * @param {object} csp CSP directive and values pairs.
+ * @throws {TypeError} For invalid argument type.
+ * @throws {Error} For scriptSources warning.
+ * @returns {object} Validated CSPs.
  */
 function validateContentSecurityPolicies(csp) {
   const validCspDirectives = [
@@ -130,10 +134,10 @@ function validateContentSecurityPolicies(csp) {
 /**
  * Validates and sanitises headers object.
  *
- * @param {object} headers Object to validate
- * @param {function} cb Callback function that receives the validated value
- * @throws {TypeError} for invalid object
- * @returns {object} sanitised headers object
+ * @param {object} headers Object to validate.
+ * @param {Function} cb Callback function that receives the validated value.
+ * @throws {TypeError} For invalid object.
+ * @returns {object} Sanitised headers object.
  */
 function validateHeadersObject(headers = {}, cb = echo) {
   if (Object.prototype.toString.call(headers) !== '[object Object]') {
@@ -143,13 +147,13 @@ function validateHeadersObject(headers = {}, cb = echo) {
 }
 
 /**
-* Validates and sanitises disabled headers.
-*
-* @param {array} disabled Array of disabled headers
-* @throws {SyntaxError} for invalid headers
-* @throws {TypeError} for invalid type
-* @returns {array} array of disabled headers
-*/
+ * Validates and sanitises disabled headers.
+ *
+ * @param {Array} disabled Array of disabled headers.
+ * @throws {SyntaxError} For invalid headers.
+ * @throws {TypeError} For invalid type.
+ * @returns {Array} Array of disabled headers.
+ */
 function validateHeadersDisabled(disabled = []) {
   if (!Array.isArray(disabled)) {
     throw new TypeError('Disabled headers must be an array (headers.disabled)');
@@ -165,10 +169,10 @@ function validateHeadersDisabled(disabled = []) {
 /**
  * Validates and sanitises i18n obejct.
  *
- * @param {object} i18n Object to validate
- * @param {function} cb Callback function that receives the validated value
- * @throws {TypeError} for invalid object
- * @returns {object} sanitised i18n object
+ * @param {object} i18n Object to validate.
+ * @param {Function} cb Callback function that receives the validated value.
+ * @throws {TypeError} For invalid object.
+ * @returns {object} Sanitised i18n object.
  */
 function validateI18nObject(i18n, cb = echo) {
   if (Object.prototype.toString.call(i18n) !== '[object Object]') {
@@ -180,10 +184,10 @@ function validateI18nObject(i18n, cb = echo) {
 /**
  * Validates and sanitises i18n directory.
  *
- * @param {array} dirs Array of directories
- * @throws {SyntaxError} for invalid directories
- * @throws {TypeError} for invalid type
- * @returns {array} array of directories
+ * @param {Array} dirs Array of directories.
+ * @throws {SyntaxError} For invalid directories.
+ * @throws {TypeError} For invalid type.
+ * @returns {Array} Array of directories.
  */
 function validateI18nDirs(dirs) {
   if (typeof dirs === 'undefined') {
@@ -202,10 +206,10 @@ function validateI18nDirs(dirs) {
 /**
  * Validates and sanitises i18n locales.
  *
- * @param {array} locales Array of locales
- * @throws {SyntaxError} for invalid locales
- * @throws {TypeError} for invalid type
- * @returns {array} array of locales
+ * @param {Array} locales Array of locales.
+ * @throws {SyntaxError} For invalid locales.
+ * @throws {TypeError} For invalid type.
+ * @returns {Array} Array of locales.
  */
 function validateI18nLocales(locales) {
   if (typeof locales === 'undefined') {
@@ -224,9 +228,9 @@ function validateI18nLocales(locales) {
 /**
  * Validates and returns the custom mount controller function.
  *
- * @param {function} controller Function for mounting middlware onto Express app
- * @throws {TypeError} for incorrect type
- * @returns {function} controller
+ * @param {Function} controller Function for mounting middlware onto Express app.
+ * @throws {TypeError} For incorrect type.
+ * @returns {Function} Controller.
  */
 function validateMountController(controller) {
   if (!['undefined', 'function'].includes(typeof controller)) {
@@ -240,10 +244,10 @@ function validateMountController(controller) {
 /**
  * Validates and sanitises mount url.
  *
- * @param {string} mountUrl URL from which Express app will be served
- * @param {string} name Name of the URL type (Mount URL, or Proxy Mount URL)
- * @throws {SyntaxError} for invalid URL
- * @returns {string} sanitised URL
+ * @param {string} mountUrl URL from which Express app will be served.
+ * @param {string} name Name of the URL type (Mount URL, or Proxy Mount URL).
+ * @throws {SyntaxError} For invalid URL.
+ * @returns {string} Sanitised URL.
  */
 function validateMountUrl(mountUrl, name = 'Mount URL') {
   if (typeof mountUrl === 'undefined') {
@@ -258,9 +262,9 @@ function validateMountUrl(mountUrl, name = 'Mount URL') {
 /**
  * Validate phase.
  *
- * @param {string} phase Service phase (alpha | beta | live)
- * @throws {SyntaxError} for invalid phase value
- * @returns {string} Phase
+ * @param {string} phase Service phase (alpha | beta | live).
+ * @throws {SyntaxError} For invalid phase value.
+ * @returns {string} Phase.
  */
 function validatePhase(phase) {
   if (typeof phase === 'undefined') {
@@ -275,9 +279,9 @@ function validatePhase(phase) {
 /**
  * Validate service name.
  *
- * @param {string} serviceName Service name
- * @throws {SyntaxError} for invalid phase value
- * @returns {string} Phase
+ * @param {string} serviceName Service name.
+ * @throws {SyntaxError} For invalid phase value.
+ * @returns {string} Phase.
  */
 function validateServiceName(serviceName) {
   if (typeof serviceName === 'undefined') {
@@ -292,9 +296,9 @@ function validateServiceName(serviceName) {
 /**
  * Validates and returns the custom session expiry controller function.
  *
- * @param {function} controller Function to handle custom session expiry
- * @throws {TypeError} for incorrect type
- * @returns {function} controller
+ * @param {Function} controller Function to handle custom session expiry.
+ * @throws {TypeError} For incorrect type.
+ * @returns {Function} Controller.
  */
 function validateSessionExpiryController(controller) {
   if (!['undefined', 'function'].includes(typeof controller)) {
@@ -308,10 +312,10 @@ function validateSessionExpiryController(controller) {
 /**
  * Validates and sanitises sessions obejct.
  *
- * @param {string} sessions Object to validate
- * @param {function} cb Callback function that receives the validated value
- * @throws {TypeError} for invalid object
- * @returns {object} sanitised sessions object
+ * @param {string} sessions Object to validate.
+ * @param {Function} cb Callback function that receives the validated value.
+ * @throws {TypeError} For invalid object.
+ * @returns {object} Sanitised sessions object.
  */
 function validateSessionsObject(sessions, cb = echo) {
   if (typeof sessions !== 'object') {
@@ -323,10 +327,10 @@ function validateSessionsObject(sessions, cb = echo) {
 /**
  * Validates and sanitises views obejct.
  *
- * @param {object} views Object to validate
- * @param {function} cb Callback function that receives the validated value
- * @throws {TypeError} for invalid object
- * @returns {object} sanitised views object
+ * @param {object} views Object to validate.
+ * @param {Function} cb Callback function that receives the validated value.
+ * @throws {TypeError} For invalid object.
+ * @returns {object} Sanitised views object.
  */
 function validateViewsObject(views, cb = echo) {
   if (typeof views !== 'object') {
@@ -338,10 +342,10 @@ function validateViewsObject(views, cb = echo) {
 /**
  * Validates and sanitises view directory.
  *
- * @param {array} dirs Array of directories
- * @throws {SyntaxError} for invalid directories
- * @throws {TypeError} for invalid type
- * @returns {array} array of directories
+ * @param {Array} dirs Array of directories.
+ * @throws {SyntaxError} For invalid directories.
+ * @throws {TypeError} For invalid type.
+ * @returns {Array} Array of directories.
  */
 function validateViewsDirs(dirs) {
   if (typeof dirs === 'undefined') {
@@ -360,10 +364,10 @@ function validateViewsDirs(dirs) {
 /**
  * Validates and sanitises sessions secret.
  *
- * @param {string} secret Session secret
- * @throws {ReferenceError} for missing value type
- * @throws {TypeError} for invalid value
- * @returns {string} secret
+ * @param {string} secret Session secret.
+ * @throws {ReferenceError} For missing value type.
+ * @throws {TypeError} For invalid value.
+ * @returns {string} Secret.
  */
 function validateSessionsSecret(secret) {
   if (typeof secret === 'undefined') {
@@ -377,10 +381,10 @@ function validateSessionsSecret(secret) {
 /**
  * Validates and sanitises sessions ttl.
  *
- * @param {int} ttl Session ttl (seconds)
- * @throws {ReferenceError} for missing value type
- * @throws {TypeError} for invalid value
- * @returns {int} ttl
+ * @param {number} ttl Session ttl (seconds).
+ * @throws {ReferenceError} For missing value type.
+ * @throws {TypeError} For invalid value.
+ * @returns {number} Ttl.
  */
 function validateSessionsTtl(ttl) {
   if (typeof ttl === 'undefined') {
@@ -394,10 +398,10 @@ function validateSessionsTtl(ttl) {
 /**
  * Validates and sanitises sessions name.
  *
- * @param {string} name Session name
- * @throws {ReferenceError} for missing value type
- * @throws {TypeError} for invalid value
- * @returns {string} name
+ * @param {string} name Session name.
+ * @throws {ReferenceError} For missing value type.
+ * @throws {TypeError} For invalid value.
+ * @returns {string} Name.
  */
 function validateSessionsName(name) {
   if (typeof name === 'undefined') {
@@ -411,10 +415,10 @@ function validateSessionsName(name) {
 /**
  * Validates and sanitises sessions secure flag.
  *
- * @param {bool} secure Session secure flag
- * @throws {ReferenceError} for missing value type
- * @throws {TypeError} for invalid value
- * @returns {string} name
+ * @param {boolean} secure Session secure flag.
+ * @throws {ReferenceError} For missing value type.
+ * @throws {TypeError} For invalid value.
+ * @returns {string} Name.
  */
 function validateSessionsSecure(secure) {
   if (typeof secure === 'undefined') {
@@ -428,8 +432,8 @@ function validateSessionsSecure(secure) {
 /**
  * Validates and sanitises sessions store.
  *
- * @param {function} store Session store
- * @returns {function} store
+ * @param {Function} store Session store.
+ * @returns {Function} Store.
  */
 function validateSessionsStore(store) {
   if (typeof store === 'undefined') {
@@ -442,9 +446,9 @@ function validateSessionsStore(store) {
 /**
  * Validates and sanitises sessions cookie url path.
  *
- * @param {string} cookiePath Session cookie url path
- * @param {string} defaultPath Default path if none specified
- * @returns {string} cookie path
+ * @param {string} cookiePath Session cookie url path.
+ * @param {string} defaultPath Default path if none specified.
+ * @returns {string} Cookie path.
  */
 function validateSessionsCookiePath(cookiePath, defaultPath = '/') {
   if (typeof cookiePath === 'undefined') {
@@ -461,9 +465,10 @@ function validateSessionsCookiePath(cookiePath, defaultPath = '/') {
  * Lax
  * None
  *
- * @param {mixed} cookieSameSite Session cookie "sameSite" flag
- * @param {mixed} defaultFlag Default path if none specified
+ * @param {any} cookieSameSite Session cookie "sameSite" flag
+ * @param {any} defaultFlag Default path if none specified
  * @returns {boolean} cookie path
+ * @throws {TypeError} When invalid arguments are provided
  */
 function validateSessionsCookieSameSite(cookieSameSite, defaultFlag) {
   const validValues = [true, false, 'Strict', 'Lax', 'None'];
@@ -482,12 +487,26 @@ function validateSessionsCookieSameSite(cookieSameSite, defaultFlag) {
   return value;
 }
 
+/**
+ * Validate skip assets generation flag.
+ *
+ * @param {boolean} skipAssetsGeneration Flag.
+ * @throws {TypeError} For invalid argument type.
+ * @returns {boolean} Flag.
+ */
+function validateSkipAssetsGeneration(skipAssetsGeneration = false) {
+  if (typeof skipAssetsGeneration !== 'boolean') {
+    throw new TypeError('Skip assets generation flag must be a boolean (skipAssetsGeneration)');
+  }
+  return skipAssetsGeneration;
+}
+
 /**
  * Ingest, validate, sanitise and manipulate configuration parameters.
  *
- * @param {object} config Config to ingest
- * @throws {Error|SyntaxError|TypeError} for invalid config values
- * @returns {object} Immutable config object
+ * @param {object} config Config to ingest.
+ * @throws {Error|SyntaxError|TypeError} For invalid config values.
+ * @returns {object} Immutable config object.
  */
 function ingest(config = {}) {
   const validatedMountUrl = validateMountUrl(config.mountUrl);
@@ -499,8 +518,13 @@ function ingest(config = {}) {
     // Use "sticky" edit mode
     useStickyEdit: validateUseStickyEdit(config.useStickyEdit),
 
+    // Skip assets Generation
+    skipAssetsGeneration: validateSkipAssetsGeneration(config.skipAssetsGeneration),
+
     // Directory to store compiled assets
-    compiledAssetsDir: validateCompiledAssetsDir(config.compiledAssetsDir),
+    compiledAssetsDir: validateCompiledAssetsDir(
+      config.compiledAssetsDir, config.skipAssetsGeneration,
+    ),
 
     // Content security policies
     csp: validateContentSecurityPolicies(config.csp),
@@ -584,4 +608,5 @@ module.exports = {
   validateSessionsTtl,
   validateViewsObject,
   validateViewsDirs,
+  validateSkipAssetsGeneration,
 };

package/lib/GatherModifier.js

@@ -2,7 +2,7 @@
  * @deprecated Do not use this file in new applications.
  *
  * Use this instead:
- * const { gatherModifiers } = require('@dwp/govuk-casa');
+ * const { gatherModifiers } = require('@dwp/govuk-casa');.
  */
 
 const util = require('util');

package/lib/I18n.js

@@ -6,7 +6,6 @@
  *   const I18n = require('govuk-casa/lib/I18n')(localeDirs, supportedLocales);
  *
  * This essentially iniialises the I18n singleton object.
-
  */
 
 const npath = require('path');
@@ -22,7 +21,7 @@ class Translator {
   /**
    * Constructor.
    *
-   * @param  {string} lang Language to use for all translations
+   * @param  {string} lang Language to use for all translations.
    */
   constructor(lang) {
     if (typeof lang !== 'string') {
@@ -34,7 +33,7 @@ class Translator {
   /**
    * Retrieve the language.
    *
-   * @return {string} Language code
+   * @returns {string} Language code.
    */
   getLanguage() {
     return this.language;
@@ -49,8 +48,9 @@ class Translator {
    *   t('Pay £${fee}', {fee:100}) = Pay £100
    *
    * @param  {string} key String to translate
-   * @param  {...mixed} subs Replacements
-   * @return {string} Translated string
+   * @param  {...any} subs Replacements
+   * @returns {string} Translated string
+   * @throws {Error} When a function substitution is used
    */
   t(key, ...subs) {
     const k = (key || '').split(':');
@@ -85,11 +85,11 @@ module.exports = function TranslaterInit(localeDirs, supportedLocales) {
    *    "person": {
    *      "title": {
    *        "label": "Miss"
-   *      }
-   *    }
-   *  }
+   *      }.
+   *    }.
+   *  }.
    *
-   * ... results in the new object, written to `tgt`:
+   * ... Results in the new object, written to `tgt`:
    *  {
    *    "person.title.label": "Miss"
    *  }
@@ -113,8 +113,9 @@ module.exports = function TranslaterInit(localeDirs, supportedLocales) {
   /**
    * Load the locale into the `LOCALE_DATA` object.
    *
-   * @param  {string} locale Locale to load (e.g. "en")
-   * @return {void}
+   * @param  {string} locale Locale to load (e.g. "en").
+   * @returns {void}
+   * @throws {Error} When locale is missing
    */
   function loadLocale(locale) {
     try {

package/lib/JourneyContext.js

@@ -4,7 +4,7 @@
  *
  * - Data gathered during the journey
  * - Validation errors on that data
- * - Navigation information about how the user got where they are
+ * - Navigation information about how the user got where they are.
  */
 const clonedeep = require('fast-copy');
 const { isObjectType } = require('./Util.js');
@@ -13,7 +13,7 @@ const privates = new WeakMap();
 
 class JourneyContext {
   /**
-   * Constructor
+   * Constructor.
    *
    * `data` is the "single source of truth" for all data gathered during the
    * user's journey. This is referred to as the "canonical data model".
@@ -27,9 +27,9 @@ class JourneyContext {
    * `nav` holds information about the current navigation state. Currently this
    * comprises of the language in which the user is navigating the service.
    *
-   * @param {object} data Entire journey data
-   * @param {object} validation Page errors (indexed by waypoint id)
-   * @param {object} nav Navigation context
+   * @param {object} data Entire journey data.
+   * @param {object} validation Page errors (indexed by waypoint id).
+   * @param {object} nav Navigation context.
    */
   constructor(data = {}, validation = {}, nav = {}) {
     privates.set(this, { data, validation, nav });
@@ -38,7 +38,7 @@ class JourneyContext {
   /**
    * Turn this instance into an object that can be stringified.
    *
-   * @returns {object} Plain object
+   * @returns {object} Plain object.
    */
   toObject() {
     return Object.assign(Object.create(null), {
@@ -51,8 +51,8 @@ class JourneyContext {
   /**
    * Create a new JourneyContext using the plain object.
    *
-   * @param {object} obj Object
-   * @returns {JourneyContext} Instance
+   * @param {object} obj Object.
+   * @returns {JourneyContext} Instance.
    */
   static fromObject(obj = {}) {
     return new JourneyContext(
@@ -86,7 +86,7 @@ class JourneyContext {
    *   ...
    * }
    *
-   * @return {object} Data context
+   * @returns {object} Data context
    */
   getData() {
     return privates.get(this).data;
@@ -100,8 +100,9 @@ class JourneyContext {
    * instance, its `fieldReader()` method will be called to transform the
    * internal context data into a format suitable for populating an HTML form.
    *
-   * @param  {string | PageMeta} page Page waypoint ID, or PageMeta object
-   * @return {object} Page data
+   * @param  {string | PageMeta} page Page waypoint ID, or PageMeta object.
+   * @returns {object} Page data.
+   * @throws {TypeError} When page is invalid.
    */
   getDataForPage(page) {
     const priv = privates.get(this);
@@ -129,8 +130,8 @@ class JourneyContext {
   /**
    * Overwrite the data context with a new object.
    *
-   * @param {object} data Data that will overwrite all existing data
-   * @return {JourneyContext} Chain
+   * @param {object} data Data that will overwrite all existing data.
+   * @returns {JourneyContext} Chain.
    */
   setData(data) {
     const priv = privates.get(this);
@@ -149,7 +150,8 @@ class JourneyContext {
    *
    * @param {string | PageMeta} page Page waypoint ID, or PageMeta object
    * @param {object} webFormData Data to overwrite with
-   * @return {JourneyContext} Chain
+   * @returns {JourneyContext} Chain
+   * @throws {TypeError} When page is invalid.
    */
   setDataForPage(page, webFormData) {
     const priv = privates.get(this);
@@ -180,7 +182,7 @@ class JourneyContext {
   /**
    * Return validation errors for all pages.
    *
-   * @return {object} All page validation errors
+   * @returns {object} All page validation errors.
    */
   getValidationErrors() {
     return privates.get(this).validation;
@@ -191,8 +193,8 @@ class JourneyContext {
    * completely will, by default, prevent onward traversal from this page. See
    * the traversal logic in Plan class.
    *
-   * @param {string} pageId Page ID
-   * @return {JourneyContext} Chain
+   * @param {string} pageId Page ID.
+   * @returns {JourneyContext} Chain.
    */
   removeValidationStateForPage(pageId) {
     const priv = privates.get(this);
@@ -207,8 +209,8 @@ class JourneyContext {
    * you want to remove any knowledge of validation success/failure, use
    * `removeValidationStateForPage()` instead.
    *
-   * @param {string} pageId Page ID
-   * @return {JourneyContext} Chain
+   * @param {string} pageId Page ID.
+   * @returns {JourneyContext} Chain.
    */
   clearValidationErrorsForPage(pageId) {
     const priv = privates.get(this);
@@ -220,9 +222,10 @@ class JourneyContext {
   /**
    * Set validation errors for a page.
    *
-   * @param {string} pageId Page ID
-   * @param {object} errors Errors index by field name (as generated by Validation.processor)
-   * @return {JourneyContext} Chain
+   * @param {string} pageId Page ID.
+   * @param {object} errors Errors index by field name (as generated by Validation.processor).
+   * @returns {JourneyContext} Chain.
+   * @throws {SyntaxError} When errors are invalid.
    */
   setValidationErrorsForPage(pageId, errors = {}) {
     const priv = privates.get(this);
@@ -247,8 +250,8 @@ class JourneyContext {
    * Return the validation errors associated with the page's currently held data
    * context (if any).
    *
-   * @param {string} pageId Page ID
-   * @return {object} An object of errors, indexed by field name
+   * @param {string} pageId Page ID.
+   * @returns {object} An object of errors, indexed by field name.
    */
   getValidationErrorsForPage(pageId) {
     return privates.get(this).validation[pageId] || Object.create(null);
@@ -258,8 +261,8 @@ class JourneyContext {
    * Determine whether the specified page has any errors in its validation
    * context.
    *
-   * @param {string} pageId Page ID
-   * @returns {boolean} Result
+   * @param {string} pageId Page ID.
+   * @returns {boolean} Result.
    */
   hasValidationErrorsForPage(pageId) {
     return Object.keys(this.getValidationErrorsForPage(pageId)).length > 0;
@@ -280,8 +283,8 @@ class JourneyContext {
   /**
    * Set language of the context.
    *
-   * @param {string} language Language to set (ISO 639-1 2-letter code)
-   * @returns {JourneyContext} Chain
+   * @param {string} language Language to set (ISO 639-1 2-letter code).
+   * @returns {JourneyContext} Chain.
    */
   setNavigationLanguage(language = 'en') {
     const priv = privates.get(this);
@@ -293,8 +296,8 @@ class JourneyContext {
   /**
    * Convenience function to test if page is valid.
    *
-   * @param {string} pageId Page ID
-   * @return {boolean} True if the page is valid
+   * @param {string} pageId Page ID.
+   * @returns {boolean} True if the page is valid.
    */
   isPageValid(pageId) {
     return privates.get(this).validation[pageId] === null;