@madgex/fert 6.0.1 → 6.0.2

package/constants.js

@@ -1,57 +1,53 @@
-const fs = require('node:fs');
-const path = require('node:path');
-const os = require('node:os');
+import fs from 'node:fs';
+import path from 'node:path';
+import os from 'node:os';
 
-const { version: VERSION } = JSON.parse(fs.readFileSync(path.resolve(__dirname, './package.json')).toString());
+export const { version: VERSION } = JSON.parse(
+  fs.readFileSync(path.resolve(import.meta.dirname, './package.json')).toString(),
+);
 
-const ONE_MINUTE = 60000;
-const ONE_HOUR = ONE_MINUTE * 60;
-const ONE_DAY = ONE_HOUR * 24;
-const ONE_WEEK = ONE_DAY * 7;
+export const ONE_MINUTE = 60000;
+export const ONE_HOUR = ONE_MINUTE * 60;
+export const ONE_DAY = ONE_HOUR * 24;
+export const ONE_WEEK = ONE_DAY * 7;
 
-module.exports = {
-  VERSION,
-  TMP_DIR: fs.realpathSync(os.tmpdir()),
-  FERT_PACKAGE_DIR: path.resolve('./'),
-  CUSTOM_TEMPLATES_DIR: './pages',
-  AWS_REGION: 'eu-west-1',
-  PROPERTY_ID_API: 'https://property-identification-api.cs.madgexhosting.net/properties/',
-  ASSETS_API_URL: 'https://asset-store.job.madgexhosting.net',
-  BRAND_JSON_FILENAME: 'brand.json',
-  FERT_CONFIG_FILENAME: 'fert.config.js',
-  FERT_SERVICE_CONFIG_FILENAME: 'fert.service.config.js',
-  ASSET_STORE_API: 'https://asset-store-api.{env}.madgexhosting.net/',
-  UPLOAD_DIR: 'dist',
-  /**
-   * use `jobseekers-frontend` AWS keys for asset-store access, even for all services (e.g. recruiterservices-frontend).
-   * 💡 Technically this should be `fert-service` key. It does not make sense to create `recruiterservices-frontend` with access too.
-   * Possibly one to refactor in the future.
-   * */
-  AWS_PARAM_NAME:
-    '/{Environment_Name}/jobboard/kong/internal/consumer-key/jobseekers-frontend_{fertConfig.client.rootClientPropertyId}',
-  /**
-   * important to have the correct service name and cpid so assets are uploaded to the correct unique place per-service.
-   */
-  REMOTE_UPLOAD_BASE: '/api/assets/{fertConfig.serviceName}/{fertConfig.clientPropertyId}',
-  /**
-   * invalidates the real asset store key path, which is related to `REMOTE_UPLOAD_BASE`
-   * asset-store puts things in `rootClientPropertyId` based on the AWS_PARAM_NAME used, and the rest of the path relates to `REMOTE_UPLOAD_BASE`
-   */
-  ASSET_STORE_INVALIDATION_PATH: `/{fertConfig.client.rootClientPropertyId}/{fertConfig.serviceName}/{fertConfig.clientPropertyId}/*`,
-  /**
-   * cloud backend cache busting for updated assets.
-   * assumption that assets are accessed on each service via a similar root.
-   * e.g.
-   * www.bigworkbag.com/_/jobseekers-frontend/assets/my-asset.png
-   * recruiter.bigworkbag.com/_/recruiterservices-frontend/assets/my-asset.png
-   */
-  BRANDED_SITE_INVALIDATION_PATH: `/_/{fertConfig.serviceName}/assets/*`,
-  ASSET_STORE_USER_GUID: 'a386d4b6-f2df-4b80-ad1f-0349e23f530b',
-  ONE_MINUTE,
-  ONE_HOUR,
-  ONE_DAY,
-  ONE_WEEK,
-  CONFIG_API:
-    'https://configuration-api.job.madgexhosting.net/configs/override/{cpid}/production/clientconfig/{config}',
-  CONFIG_DIR: 'config',
-};
+export const TMP_DIR = fs.realpathSync(os.tmpdir());
+export const FERT_PACKAGE_DIR = path.resolve('./');
+export const CUSTOM_TEMPLATES_DIR = './pages';
+export const AWS_REGION = 'eu-west-1';
+export const PROPERTY_ID_API = 'https://property-identification-api.cs.madgexhosting.net/properties/';
+export const ASSETS_API_URL = 'https://asset-store.job.madgexhosting.net';
+export const BRAND_JSON_FILENAME = 'brand.json';
+export const FERT_CONFIG_FILENAME = 'fert.config.js';
+export const FERT_SERVICE_CONFIG_FILENAME = 'fert.service.config.js';
+export const ASSET_STORE_API = 'https://asset-store-api.{env}.madgexhosting.net/';
+export const UPLOAD_DIR = 'dist';
+/**
+ * use `jobseekers-frontend` AWS keys for asset-store access, even for all services (e.g. recruiterservices-frontend).
+ * 💡 Technically this should be `fert-service` key. It does not make sense to create `recruiterservices-frontend` with access too.
+ * Possibly one to refactor in the future.
+ * */
+export const AWS_PARAM_NAME =
+  '/{Environment_Name}/jobboard/kong/internal/consumer-key/jobseekers-frontend_{fertConfig.client.rootClientPropertyId}';
+/**
+ * important to have the correct service name and cpid so assets are uploaded to the correct unique place per-service.
+ */
+export const REMOTE_UPLOAD_BASE = '/api/assets/{fertConfig.serviceName}/{fertConfig.clientPropertyId}';
+/**
+ * invalidates the real asset store key path, which is related to `REMOTE_UPLOAD_BASE`
+ * asset-store puts things in `rootClientPropertyId` based on the AWS_PARAM_NAME used, and the rest of the path relates to `REMOTE_UPLOAD_BASE`
+ */
+export const ASSET_STORE_INVALIDATION_PATH = `/{fertConfig.client.rootClientPropertyId}/{fertConfig.serviceName}/{fertConfig.clientPropertyId}/*`;
+/**
+ * cloud backend cache busting for updated assets.
+ * assumption that assets are accessed on each service via a similar root.
+ * e.g.
+ * www.bigworkbag.com/_/jobseekers-frontend/assets/my-asset.png
+ * recruiter.bigworkbag.com/_/recruiterservices-frontend/assets/my-asset.png
+ */
+export const BRANDED_SITE_INVALIDATION_PATH = `/_/{fertConfig.serviceName}/assets/*`;
+export const ASSET_STORE_USER_GUID = 'a386d4b6-f2df-4b80-ad1f-0349e23f530b';
+
+export const CONFIG_API =
+  'https://configuration-api.job.madgexhosting.net/configs/override/{cpid}/production/clientconfig/{config}';
+export const CONFIG_DIR = 'config';

package/eslint.config.js

@@ -0,0 +1,19 @@
+// eslint-disable-next-line n/no-unpublished-import
+import madgexConfig from '@madgex/eslint-config-madgex';
+
+export default [
+  {
+    ignores: [
+      '**/dist',
+      '**/temp',
+      '**/dist',
+      '**/*.json',
+      '**/*.json',
+      '**/.eslintrc.js',
+      '**/node_modules',
+      '**/repo-template',
+      'eslint.config.mjs',
+    ],
+  },
+  ...madgexConfig,
+];

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@madgex/fert",
-  "version": "6.0.1",
+  "version": "6.0.2",
   "description": "Tool to help build the V6 branding",
   "bin": {
     "fert": "./bin/cli.js"
   },
-  "type": "commonjs",
+  "type": "module",
   "scripts": {
     "lint": "eslint .",
     "format": "prettier --write .",
     "lint-staged": "lint-staged",
     "semantic-release": "semantic-release",
-    "test": "node --test ./bin/**/*.test.js",
+    "test": "node --test --experimental-test-module-mocks \"./bin/**/*.test.js\"",
     "prepare": "husky"
   },
   "repository": {
@@ -36,25 +36,26 @@
     "@private/header-footer-podlet-server": "github:wiley/madgex-header-footer-podlet",
     "axios": "^1.9.0",
     "cac": "^6.7.14",
-    "chalk": "4.1.2",
-    "chokidar": "^3.5.3",
+    "chalk": "^5.4.1",
+    "chokidar4": "npm:chokidar@^4.0.3",
     "debug": "^4.4.0",
     "dedent": "^1.5.3",
     "find-up-simple": "^1.0.1",
-    "flat-cache": "^4.0.0",
+    "flat-cache": "^6.1.8",
     "form-data": "^4.0.2",
+    "joi": "^17.13.3",
     "lodash": "^4.17.21",
     "nunjucks": "^3.2.4",
     "open": "8.4.2",
     "ora": "5.4.1",
     "prompts": "^2.4.2",
-    "rimraf": "^5.0.5",
+    "rimraf": "^6.0.1",
     "sass": "^1.87.0",
     "simple-git": "^3.27.0",
     "simple-update-notifier": "^2.0.0",
     "uuid-validate": "^0.0.3",
-    "vite": "^4.5.14",
-    "vite-plugin-static-copy": "^0.17.1"
+    "vite": "^6.3.4",
+    "vite-plugin-static-copy": "^2.3.1"
   },
   "devDependencies": {
     "@commitlint/cli": "^19.8.0",
@@ -63,7 +64,6 @@
     "@madgex/prettier-config-madgex": "^2.0.0",
     "eslint": "^9.25.1",
     "husky": "^9.1.7",
-    "joi": "^17.13.3",
     "lint-staged": "^15.5.1",
     "prettier": "^3.5.3",
     "semantic-release": "^24.2.3"

package/server/extensions/error-logging.js

@@ -1,4 +1,4 @@
-module.exports = [
+export default [
   {
     type: 'onPreResponse',
     method: async (request, h) => {

package/server/index.js

@@ -1,103 +1,7 @@
-const Hapi = require('@hapi/hapi');
-const Toys = require('@hapipal/toys');
-const path = require('node:path');
-const { log } = require('../bin/utils/logging');
-const podletServer = require('@private/header-footer-podlet-server');
-const { VERSION, PROPERTY_ID_API, ASSETS_API_URL } = require('../constants');
+import { devServer } from './server';
 
-exports.devServer = async ({ start, fertConfig = {} } = {}) => {
-  const server = Hapi.server({
-    port: 0, // 0 === random unused port
-    host: fertConfig.cli?.host ?? 'localhost',
-  });
+process.on('unhandledRejection', (err) => {
+  throw err;
+});
 
-  // "the path prefix used to locate static resources (files and view templates) when relative paths are used"
-  // https://hapi.dev/api/?v=21.3.2#-serverpathrelativeto
-  server.path(fertConfig.workingDir);
-
-  // make incoming fertConfig available server-wide
-  server.decorate('server', 'fertConfig', ({ update } = {}) => {
-    if (update) {
-      // eslint-disable-next-line no-param-reassign
-      fertConfig = update;
-    }
-
-    return fertConfig;
-  });
-
-  // load in the podletServer to the dev servers app namespace
-  // server.app.podletServer = await podletServer({ start: false, fertConfig });
-  await server.register({
-    plugin: podletServer,
-    options: {
-      version: `${VERSION}-fert`,
-      isFert: true,
-      isProd: false,
-      templatePath: [path.resolve(fertConfig.workingDir, 'templates')],
-      clientPropertiesApi: PROPERTY_ID_API,
-      assetsApiUrl: ASSETS_API_URL,
-      layout: fertConfig.serviceName,
-    },
-    routes: { prefix: '/_podlet' },
-  });
-
-  // add template support to hapi and setup the nunjucks engine
-  await server.register([
-    // require('blipp'),
-    require('@hapi/vision'),
-    require('@hapi/inert'),
-    {
-      plugin: require('./plugins/hapi-vite'),
-      options: {
-        watch: ['/templates/**/*', '/public/tokens/**/*'].map((p) => path.join(fertConfig.workingDir, p)),
-        root: path.resolve(fertConfig.workingDir),
-        entry: path.join(fertConfig.workingDir, fertConfig.entry),
-        log: log.debug,
-      },
-    },
-  ]);
-
-  server.views(require('./view-manager')(server));
-
-  // mocked logged in
-  Toys.auth.strategy(server, 'mock-user', (request, h) => {
-    if (Object.prototype.hasOwnProperty.call(request.query, 'loggedin')) {
-      const user = {
-        email: 'email@madgex.com',
-        firstName: 'Samus',
-        lastName: 'Aran',
-        userId: 'b5699145-e867-4b47-8b18-f81247948dbb',
-        username: 'Samus Aran',
-      };
-
-      return h.authenticated({ credentials: user });
-    }
-
-    return h.continue;
-  });
-
-  // routes
-  server.route(require('./routes/public')({ fertConfig }));
-  server.route(require('./routes/views'));
-  server.ext(require('./extensions/error-logging'));
-
-  if (start) {
-    await server.start();
-
-    log.debug(`Hapi server started at ${server.info.uri}`);
-
-    return server;
-  }
-
-  await server.initialize();
-
-  return server;
-};
-
-if (require.main === module) {
-  exports.devServer({ start: true });
-
-  process.on('unhandledRejection', (err) => {
-    throw err;
-  });
-}
+devServer({ start: true });

package/server/plugins/hapi-vite.js

@@ -1,6 +1,8 @@
-const { createServer } = require('vite');
-const chokidar = require('chokidar');
-const Hoek = require('@hapi/hoek');
+// eslint-disable-next-line n/no-unsupported-features/node-builtins
+import { glob } from 'node:fs/promises';
+import { createServer } from 'vite';
+import chokidar from 'chokidar4';
+import * as Hoek from '@hapi/hoek';
 
 const internals = {};
 
@@ -10,7 +12,7 @@ internals.defaults = {
   log: console.log,
 };
 
-module.exports = {
+export default {
   name: 'hapi-vite',
   register: async (server, options = {}) => {
     // eslint-disable-next-line no-param-reassign
@@ -41,7 +43,8 @@ module.exports = {
         await server.app.viteServer.listen();
 
         if (options.watch && options.watch.length) {
-          chokidar.watch(options.watch).on('all', (event, path) => {
+          const watchList = await Array.fromAsync(glob(options.watch));
+          chokidar.watch(watchList).on('all', (event, path) => {
             log(event, path);
             if (event === 'add' || event === 'change') {
               server.app.viteServer.ws.send({

package/server/routes/public.js

@@ -1,4 +1,6 @@
-module.exports = ({ fertConfig }) => [
+import { fileURLToPath } from 'node:url';
+
+export default ({ fertConfig }) => [
   {
     method: 'get',
     path: `/_/${fertConfig.serviceName}/assets/{p*}`,
@@ -31,7 +33,7 @@ module.exports = ({ fertConfig }) => [
     path: '/design-system.css',
     handler: {
       file: {
-        path: require.resolve('@madgex/design-system/index.css'),
+        path: fileURLToPath(import.meta.resolve('@madgex/design-system/index.css')),
         confine: false, // allow access outside of the fert project (helpful during dev)
       },
     },

package/server/routes/views.js

@@ -1,11 +1,9 @@
-const fs = require('fs');
-const path = require('node:path');
-const { CUSTOM_TEMPLATES_DIR } = require('../../constants');
+import fs from 'node:fs';
+import path from 'node:path';
+import Joi from 'joi';
+import { CUSTOM_TEMPLATES_DIR } from '../../constants.js';
 
-// eslint-disable-next-line n/no-unpublished-require
-const Joi = require('joi');
-
-module.exports = {
+export default {
   method: 'GET',
   path: '/{page*}',
   handler: async (request, h) => {

package/server/server.js

@@ -0,0 +1,104 @@
+import path from 'node:path';
+import Hapi from '@hapi/hapi';
+import Toys from '@hapipal/toys';
+import Vision from '@hapi/vision';
+import Inert from '@hapi/inert';
+import HapiVite from './plugins/hapi-vite.js';
+import viewManager from './view-manager.js';
+
+import { log } from '../bin/utils/logging.js';
+import podletServer from '@private/header-footer-podlet-server';
+import { VERSION, PROPERTY_ID_API, ASSETS_API_URL } from '../constants.js';
+
+import routesPublic from './routes/public.js';
+import routesViews from './routes/views.js';
+import extensionErrorLogging from './extensions/error-logging.js';
+
+export async function devServer({ start, fertConfig = {} } = {}) {
+  const server = Hapi.server({
+    port: 0, // 0 === random unused port
+    host: fertConfig.cli?.host ?? 'localhost',
+  });
+
+  // "the path prefix used to locate static resources (files and view templates) when relative paths are used"
+  // https://hapi.dev/api/?v=21.3.2#-serverpathrelativeto
+  server.path(fertConfig.workingDir);
+
+  // make incoming fertConfig available server-wide
+  server.decorate('server', 'fertConfig', ({ update } = {}) => {
+    if (update) {
+      // eslint-disable-next-line no-param-reassign
+      fertConfig = update;
+    }
+
+    return fertConfig;
+  });
+
+  // load in the podletServer to the dev servers app namespace
+  // server.app.podletServer = await podletServer({ start: false, fertConfig });
+  await server.register({
+    plugin: podletServer,
+    options: {
+      version: `${VERSION}-fert`,
+      isFert: true,
+      isProd: false,
+      templatePath: [path.resolve(fertConfig.workingDir, 'templates')],
+      clientPropertiesApi: PROPERTY_ID_API,
+      assetsApiUrl: ASSETS_API_URL,
+      layout: fertConfig.serviceName,
+    },
+    routes: { prefix: '/_podlet' },
+  });
+
+  // add template support to hapi and setup the nunjucks engine
+  await server.register([
+    Vision,
+    Inert,
+    {
+      plugin: HapiVite,
+      options: {
+        watch: ['/templates/**/*', '/public/tokens/**/*'].map((p) => path.join(fertConfig.workingDir, p)),
+        root: path.resolve(fertConfig.workingDir),
+        entry: path.join(fertConfig.workingDir, fertConfig.entry),
+        log: log.debug,
+      },
+    },
+  ]);
+
+  server.views(viewManager(server));
+
+  // mocked logged in
+  Toys.auth.strategy(server, 'mock-user', (request, h) => {
+    if (Object.prototype.hasOwnProperty.call(request.query, 'loggedin')) {
+      const user = {
+        email: 'email@madgex.com',
+        firstName: 'Samus',
+        lastName: 'Aran',
+        userId: 'b5699145-e867-4b47-8b18-f81247948dbb',
+        username: 'Samus Aran',
+      };
+
+      return h.authenticated({ credentials: user });
+    }
+
+    return h.continue;
+  });
+
+  // routes
+  server.route(routesPublic({ fertConfig }));
+  server.route(routesViews);
+
+  server.ext(extensionErrorLogging);
+
+  if (start) {
+    await server.start();
+
+    log.debug(`Hapi server started at ${server.info.uri}`);
+
+    return server;
+  }
+
+  await server.initialize();
+
+  return server;
+}

package/server/view-manager.js

@@ -1,8 +1,8 @@
-const Nunjucks = require('nunjucks');
-const path = require('node:path');
-const { CUSTOM_TEMPLATES_DIR } = require('../constants');
+import path from 'node:path';
+import Nunjucks from 'nunjucks';
+import { CUSTOM_TEMPLATES_DIR } from '../constants.js';
 
-module.exports = (server) => {
+export default (server) => {
   const fertConfig = server.fertConfig();
 
   return {
@@ -31,7 +31,7 @@ module.exports = (server) => {
     },
     path: [
       path.join(fertConfig.workingDir, CUSTOM_TEMPLATES_DIR), // user-created 'pages'
-      path.join(__dirname, './templates'), // fert-local base templates
+      path.join(import.meta.dirname, './templates'), // fert-local base templates
     ],
     isCached: false,
     async context(request) {

package/vite.config.js

@@ -1,10 +1,10 @@
-const { defineConfig } = require('vite');
-const { viteStaticCopy } = require('vite-plugin-static-copy');
+import { defineConfig } from 'vite';
+import { viteStaticCopy } from 'vite-plugin-static-copy';
 
-module.exports = defineConfig({
+export default defineConfig({
   build: {
     // generate manifest.json in outDir
-    manifest: true,
+    manifest: 'manifest.json',
   },
   plugins: [
     viteStaticCopy({