@dwp/govuk-casa 7.0.9 → 7.1.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 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.
 
+## [7.1.0](https://github.com/dwp/govuk-casa/compare/7.0.9...7.1.0) (2022-09-06)
+
+
+### Features
+
+* add date format option to formatDateObject filter ([f20fbab](https://github.com/dwp/govuk-casa/commit/f20fbaba430e56f489106ad9b8a58cf85fb38910))
+* Applied ability to disable generation of static assets ([6686d24](https://github.com/dwp/govuk-casa/commit/6686d240116e8c292c5da0b9c8a737a72f365ded))
+
 ### [7.0.9](https://github.com/dwp/govuk-casa/compare/7.0.8...7.0.9) (2022-01-13)
 
 

package/casa.js

@@ -75,6 +75,7 @@ function mountCasaMiddleware(app, config, i18nUtility) {
     proxyMountUrl: config.proxyMountUrl,
     compiledAssetsDir: config.compiledAssetsDir,
     npmPackages: staticModulePaths,
+    skipAssetsGeneration: config.skipAssetsGeneration,
   });
   mwNunjucks(app, config.views.dirs, staticModulePaths.govukFrontend);
   mwSession(

package/lib/ConfigIngestor.js

@@ -37,11 +37,12 @@ function validateUseStickyEdit(useStickyEdit = false) {
  * Validates directory and checks that it is writeable.
  *
  * @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)';
@@ -483,6 +487,20 @@ 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.
  *
@@ -500,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),
@@ -585,4 +608,5 @@ module.exports = {
   validateSessionsTtl,
   validateViewsObject,
   validateViewsDirs,
+  validateSkipAssetsGeneration,
 };

package/lib/view-filters/formatDateObject.js

@@ -13,11 +13,11 @@ const { DateTime } = require('luxon');
  *   object - {dd:'', mm:'', yyyy:''}
  *
  * @param  {object} date Date (see supported formats above)
- * @param  {object} config Holds locale
+ * @param  {object} config Holds locale and luxon date format
  * @returns {string} Formatted date
  */
 module.exports = function formatDateObject(date, config = {}) {
-  const { locale = 'en' } = config;
+  const { locale = 'en', format = 'd MMMM yyyy' } = config;
 
   if (
     Object.prototype.toString.call(date) === '[object Object]'
@@ -29,7 +29,7 @@ module.exports = function formatDateObject(date, config = {}) {
       year: Math.max(0, parseInt(date.yyyy, 10)),
       month: Math.max(0, parseInt(date.mm, 10)),
       day: Math.max(1, parseInt(date.dd, 10)),
-    }).setLocale(locale).toFormat('d MMMM yyyy');
+    }).setLocale(locale).toFormat(format);
   }
   return 'INVALID DATE OBJECT';
 };

package/middleware/static/index.js

@@ -39,6 +39,7 @@ const onehour = 3600000;
  *    govukFrontend: govuk-frontend npm package path <string>,
  *    govukTemplateJinja: govuk_template_jinja npm package path <string>
  *    govukCasa: @dwp/govuk-casa npm package path <string>
+ *  skipAssetsGeneration: boolean value to determine whether to skip the preparation of assets
  *
  * @param {object} args See above
  * @returns {void}
@@ -55,6 +56,7 @@ module.exports = (args) => {
       govukTemplateJinja = '',
       govukCasa = '',
     } = Object.create(null),
+    skipAssetsGeneration,
   } = args;
 
   const compiledAssetsDir = path.resolve(cAssetsDir);
@@ -74,13 +76,15 @@ module.exports = (args) => {
 
   const prefixCasa = `${proxyMountUrl}/govuk/casa`.replace(/\/+/g, '/');
 
-  logger.trace('Calling prepare-assets');
-  mwPrepareAssets({
-    logger,
-    npmGovukCasa: govukCasa,
-    compiledAssetsDir,
-    mountUrl,
-  });
+  if (!skipAssetsGeneration) {
+    logger.trace('Calling prepare-assets');
+    mwPrepareAssets({
+      logger,
+      npmGovukCasa: govukCasa,
+      compiledAssetsDir,
+      mountUrl,
+    });
+  }
 
   logger.trace('Calling serve-assets');
   mwServeAssets({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dwp/govuk-casa",
-  "version": "7.0.9",
+  "version": "7.1.0",
   "description": "Framework for creating basic GOVUK Collect-And-Submit-Applications",
   "main": "casa.js",
   "files": [