@companieshouse/ch-node-utils 1.3.7 → 1.3.9

package/README.md

@@ -77,10 +77,11 @@ Available as a normal npm dependency([here on npmjs](https://www.npmjs.com/packa
 |`CH_NODE_UTILS_DROP_LANG_QUERY_PARAM`| It could be set to [drop the lang="xx" query param](https://github.com/companieshouse/ch-node-utils/blob/f9e5c47a86206f0b12e4e536c4c459db16747631/src/middleware/manageLocales.middleware.ts#L25) from the current URL ([see Example](https://github.com/companieshouse/docker-chs-development/blob/842c61245adcbba02a6316847fc4f9d94c52410d/services/modules/dissolution/dissolution-web.docker-compose.yaml#L50)) |
 |`CH_NODE_UTILS_LOG_LVL`| It could be set to ["TRACE" or "DEBUG" (case insensitive)](https://github.com/companieshouse/ch-node-utils/blob/24bc717477d21082439d1b460108cb0d60465f0f/src/utils/log.ts#L2) to dump internal info while inside ch-node-utils ([see Example](https://github.com/companieshouse/docker-chs-development/blob/842c61245adcbba02a6316847fc4f9d94c52410d/services/modules/dissolution/dissolution-web.docker-compose.yaml#L49))|
 
-### Menu navigation bar
-A menu navigation bar component has been added to make it easier to add links pointing to new services when needed. There are two Nunjucks macros: one that adds a menu navigation bar with the provided items and another that adds a menu navigation bar with predefined items. The latter internally uses the former and at the moment contains links to the following service:
+### Menu Navigation Bar
 
-- Authorised agent
+A menu navigation bar component has been added to make it easier to add links pointing to new services when needed. There are two Nunjucks macros: one that adds a menu navigation bar with the provided items and another that adds a menu navigation bar with predefined items. The latter internally uses the former and currently contains links to the following services:
+
+- Authorised agent (conditional)
 - Your companies
 - Your filings
 - Companies you follow
@@ -90,7 +91,30 @@ A menu navigation bar component has been added to make it easier to add links po
 
 The "Authorised agent" menu item appears conditionally if the logged user has ACSP membership.
 
-The navbar requires importing language files from the `locales` folder in ch-node-utils and making them available to all Nunjuck templates using the [`addGlobal()` function](https://mozilla.github.io/nunjucks/api.html#addglobal) in `app.ts`. At the moment only English and Welsh language versions are supported. It also requires a flag `displayAuthorisedAgent` set the same way for displaying the "Authorised agent" menu item. If the logged user has ACSP membership, this flag should be set to `'yes'`.
+#### Usage
+
+To use the predefined navbar, import the macro and call it with the required parameters:
+
+```nunjucks
+{% from "navbar.njk" import addPredefinedNavbar %}
+
+{{ addPredefinedNavbar(userEmailAddress, chsMonitorGuiUrl, lang, displayAuthorisedAgent) }}
+```
+
+The macro requires the following parameters:
+
+- `userEmailAddress`: The email address of the logged-in user
+- `chsMonitorGuiUrl`: The URL for the "Companies you follow" link
+- `lang`: An object containing language-specific strings for localization
+- `displayAuthorisedAgent`: A flag for displaying the "Authorised agent" menu item. If the logged user has ACSP membership, this flag should be set to `'yes'`
+
+#### Localization
+
+The navbar uses translations from `@companieshouse/ch-node-utils` (this) package. To set this up:
+
+1. Ensure the `@companieshouse/ch-node-utils` package is installed. i.e `npm i @companieshouse/ch-node-utils`
+2. Update your i18 middleware to load and merge translations from both sources. (`@companieshouse/ch-node-utils/locales`)
+3. Add the `@companieshouse/ch-node-utils/templates` directory to the Nunjucks loader paths.
 
 The navbar also requires the use of styles provided in the [ch.gov.uk.css](https://github.com/companieshouse/cdn.ch.gov.uk/blob/master/app/assets/stylesheets/ch.gov.uk.css) stylesheet (you can either add the provided link to the head section or include specific styles in your own stylesheet)
 
@@ -99,4 +123,3 @@ The navbar also requires the use of styles provided in the [ch.gov.uk.css](https
 It also requires the [navbar.js](https://github.com/companieshouse/cdn.ch.gov.uk/blob/master/app/assets/javascripts/lib/navbar.js) script to be added to the footer to make the navbar work in mobile mode
 
 `<script src="{{ cdnHost }}/javascripts/lib/navbar.js"></script>`
-

package/lib/constants/constants.d.ts

@@ -1 +1,4 @@
 export declare const QUERY_PAR_LANG = "lang";
+export declare const NODE_MODULES_LOCALES_PATH = "node_modules/@companieshouse/ch-node-utils/locales";
+export declare const SHARED_NAVBAR_NAMESPACE = "ch-node-utils-navbar";
+export declare const SHARED_NUNJUCKS_TRANSLATION_NAMESPACES: Set<string>;

package/lib/constants/constants.js

@@ -1,5 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QUERY_PAR_LANG = void 0;
+exports.SHARED_NUNJUCKS_TRANSLATION_NAMESPACES = exports.SHARED_NAVBAR_NAMESPACE = exports.NODE_MODULES_LOCALES_PATH = exports.QUERY_PAR_LANG = void 0;
 exports.QUERY_PAR_LANG = "lang";
+exports.NODE_MODULES_LOCALES_PATH = 'node_modules/@companieshouse/ch-node-utils/locales';
+exports.SHARED_NAVBAR_NAMESPACE = "ch-node-utils-navbar";
+exports.SHARED_NUNJUCKS_TRANSLATION_NAMESPACES = new Set([
+    exports.SHARED_NAVBAR_NAMESPACE
+]);
 //# sourceMappingURL=constants.js.map

package/lib/constants/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG,MAAM,CAAA"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG,MAAM,CAAA;AACvB,QAAA,yBAAyB,GAAG,oDAAoD,CAAC;AACjF,QAAA,uBAAuB,GAAG,sBAAsB,CAAA;AAChD,QAAA,sCAAsC,GAAG,IAAI,GAAG,CAAC;IAC5D,+BAAuB;CACxB,CAAC,CAAC"}

package/lib/middleware/manageLocales.middleware.js

@@ -6,7 +6,9 @@ const constants_1 = require("../constants/constants");
 const locales_service_1 = tslib_1.__importDefault(require("../services/locales/locales.service"));
 const languageNames_1 = tslib_1.__importDefault(require("../utils/languageNames"));
 const log_1 = tslib_1.__importDefault(require("../utils/log"));
+const locales_1 = require("../utils/locales");
 function LocalesMiddleware() {
+    (0, locales_1.copyLocales)();
     return (req, res, next) => {
         var _a;
         (0, log_1.default)("---------- LocalesMiddleware ------------");

package/lib/middleware/manageLocales.middleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"manageLocales.middleware.js","sourceRoot":"","sources":["../../src/middleware/manageLocales.middleware.ts"],"names":[],"mappings":";;;;AACA,sDAAuD;AACvD,kGAAiE;AACjE,mFAAoD;AACpD,+DAA+B;AAE/B,SAAgB,iBAAiB;IAC9B,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;;QAExD,IAAA,aAAG,EAAC,2CAA2C,CAAC,CAAA;QAChD,IAAI,IAAI,GAAuB,CAAS,GAAG,CAAC,KAAK,CAAC,0BAAc,CAAC;YAChC,GAAG,CAAC,IAAI,CAAC,IAAI;aACb,MAAA,GAAG,CAAC,OAAO,0CAAE,YAAY,CAAS,0BAAc,CAAC,CAAA,CAAC,CAAA;QACnF,IAAA,aAAG,EAAC,0DAA0D,IAAI,YAAY,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAA;QAC/F,IAAI,IAAI,KAAK,SAAS,IAAI,CAAE,uBAAa,CAAC,iBAAiB,CAAE,yBAAc,CAAC,WAAW,EAAE,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,CAAC;YAC3G,IAAI,GAAG,IAAI,CAAA;QACjB,CAAC;QACD,IAAA,aAAG,EAAC,uCAAuC,IAAI,GAAG,CAAC,CAAA;QACnD,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YACf,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,0BAAc,EAAE,IAAI,CAAC,CAAA;QACjD,CAAC;QACD,GAAG,CAAC,IAAI,GAAG,IAAI,CAAA;QAEf,IAAI,UAAU,GAAG,GAAG,CAAC,GAAG,CAAA;QACxB,IAAI,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,CAAC;YAInD,IAAI,IAAI,GAAG,IAAI,GAAG,CAAC,WAAW,GAAG,CAAC,GAAG,EAAE,CAAC,CAAA;YACxC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,0BAAc,CAAC,CAAA;YACxC,UAAU,GAAG,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,CAAA;YAC7C,IAAA,aAAG,EAAC,gCAAgC,0BAAc,2BAA2B,UAAU,GAAG,CAAC,CAAA;QAC9F,CAAC;QAED,GAAG,CAAC,GAAG,GAAG,UAAU,CAAA;QACpB,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,GAAG,GAAG,CAAC,QAAQ,MAAM,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,UAAU,EAAE,CAAA;QAG3E,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAA;QAC1B,GAAG,CAAC,MAAM,CAAC,aAAa,GAAG,IAAI,CAAA;QAC/B,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAA;QAE1B,OAAO,IAAI,EAAE,CAAA;IAChB,CAAC,CAAA;AACJ,CAAC;AAtCD,8CAsCC"}
+{"version":3,"file":"manageLocales.middleware.js","sourceRoot":"","sources":["../../src/middleware/manageLocales.middleware.ts"],"names":[],"mappings":";;;;AACA,sDAAuD;AACvD,kGAAiE;AACjE,mFAAoD;AACpD,+DAA+B;AAC/B,8CAA+C;AAE/C,SAAgB,iBAAiB;IAC9B,IAAA,qBAAW,GAAE,CAAC;IACd,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;;QAExD,IAAA,aAAG,EAAC,2CAA2C,CAAC,CAAA;QAChD,IAAI,IAAI,GAAuB,CAAS,GAAG,CAAC,KAAK,CAAC,0BAAc,CAAC;YAChC,GAAG,CAAC,IAAI,CAAC,IAAI;aACb,MAAA,GAAG,CAAC,OAAO,0CAAE,YAAY,CAAS,0BAAc,CAAC,CAAA,CAAC,CAAA;QACnF,IAAA,aAAG,EAAC,0DAA0D,IAAI,YAAY,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAA;QAC/F,IAAI,IAAI,KAAK,SAAS,IAAI,CAAE,uBAAa,CAAC,iBAAiB,CAAE,yBAAc,CAAC,WAAW,EAAE,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,CAAC;YAC3G,IAAI,GAAG,IAAI,CAAA;QACjB,CAAC;QACD,IAAA,aAAG,EAAC,uCAAuC,IAAI,GAAG,CAAC,CAAA;QACnD,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YACf,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,0BAAc,EAAE,IAAI,CAAC,CAAA;QACjD,CAAC;QACD,GAAG,CAAC,IAAI,GAAG,IAAI,CAAA;QAEf,IAAI,UAAU,GAAG,GAAG,CAAC,GAAG,CAAA;QACxB,IAAI,OAAO,CAAC,GAAG,CAAC,mCAAmC,EAAE,CAAC;YAInD,IAAI,IAAI,GAAG,IAAI,GAAG,CAAC,WAAW,GAAG,CAAC,GAAG,EAAE,CAAC,CAAA;YACxC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,0BAAc,CAAC,CAAA;YACxC,UAAU,GAAG,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,EAAE,CAAA;YAC7C,IAAA,aAAG,EAAC,gCAAgC,0BAAc,2BAA2B,UAAU,GAAG,CAAC,CAAA;QAC9F,CAAC;QAED,GAAG,CAAC,GAAG,GAAG,UAAU,CAAA;QACpB,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,GAAG,GAAG,CAAC,QAAQ,MAAM,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,UAAU,EAAE,CAAA;QAG3E,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAA;QAC1B,GAAG,CAAC,MAAM,CAAC,aAAa,GAAG,IAAI,CAAA;QAC/B,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAA;QAE1B,OAAO,IAAI,EAAE,CAAA;IAChB,CAAC,CAAA;AACJ,CAAC;AAvCD,8CAuCC"}

package/lib/utils/i18nCh.d.ts

@@ -6,8 +6,10 @@ export default class i18nCh {
     private constructor();
     static getInstance(localesFolder?: string, nameSpaces?: string[], lang?: string): i18nCh;
     private loadAllNamespaces;
+    private loadNamespacesFromPath;
     private changeLanguage;
     resolveNamespacesKeys(lang: string, vars?: any): any;
     resolveSingleKey(key: string, lang: string, vars?: any): string;
     loadNamespaces(nameSpaces?: string[]): void;
+    getResourceBundle(lng: string, ns: string): any;
 }

package/lib/utils/i18nCh.js

@@ -6,6 +6,7 @@ const i18next_fs_backend_1 = tslib_1.__importDefault(require("i18next-fs-backend
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_1 = tslib_1.__importStar(require("fs"));
 const log_1 = tslib_1.__importDefault(require("./log"));
+const constants_1 = require("../constants/constants");
 class i18nCh {
     constructor(localesFolder = "", nameSpaces = [], lang = "en") {
         this.nameSpaces = [];
@@ -47,15 +48,23 @@ class i18nCh {
         return i18nCh.instance;
     }
     loadAllNamespaces() {
-        const jsonFiles = [];
-        if (this.localesFolder) {
-            fs_1.default.readdirSync(path_1.default.join(this.localesFolder, "en")).forEach((file) => {
-                if (path_1.default.extname(file) === ".json") {
-                    jsonFiles.push(path_1.default.basename(file, ".json"));
-                }
-            });
+        if (!this.localesFolder) {
+            return [];
+        }
+        const projectRootNamespaces = this.loadNamespacesFromPath(path_1.default.join(this.localesFolder, "en"));
+        const nodeModulesNamespaces = this.loadNamespacesFromPath(path_1.default.join(constants_1.NODE_MODULES_LOCALES_PATH, "en"));
+        return [...new Set([...projectRootNamespaces, ...nodeModulesNamespaces])];
+    }
+    loadNamespacesFromPath(folderPath) {
+        try {
+            return fs_1.default.readdirSync(folderPath)
+                .filter(file => path_1.default.extname(file) === ".json")
+                .map(file => path_1.default.basename(file, ".json"));
+        }
+        catch (error) {
+            (0, log_1.default)(`Error reading directory ${folderPath}: ${error}`);
+            return [];
         }
-        return jsonFiles;
     }
     changeLanguage(lang) {
         this.i18nInst.changeLanguage(lang, (err) => {
@@ -109,6 +118,9 @@ class i18nCh {
             });
         }
     }
+    getResourceBundle(lng, ns) {
+        return this.i18nInst.getResourceBundle(lng, ns);
+    }
 }
 exports.default = i18nCh;
 //# sourceMappingURL=i18nCh.js.map

package/lib/utils/i18nCh.js.map

@@ -1 +1 @@
-{"version":3,"file":"i18nCh.js","sourceRoot":"","sources":["../../src/utils/i18nCh.ts"],"names":[],"mappings":";;;AAAA,8DAA6B;AAC7B,oFAAwC;AACxC,wDAA2B;AAC3B,iDAA+C;AAC/C,wDAAwB;AAExB,MAAqB,MAAM;IAQxB,YAAoB,aAAa,GAAG,EAAE,EAAE,aAAuB,EAAE,EAAE,IAAI,GAAG,IAAI;QAHtE,eAAU,GAAa,EAAE,CAAC;QAI/B,IAAI,CAAC;YACF,IAAI,CAAC,aAAa,EAAE,CAAC;gBAElB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAA;YACnF,CAAC;YACD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;YAClC,IAAK,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,UAAU,GAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC1C,CAAC;YACD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;YAE5B,IAAI,CAAC,QAAQ,GAAG,iBAAO,CAAA;YACvB,IAAI,CAAC,QAAQ;iBACT,GAAG,CAAC,4BAAO,CAAC;iBACZ,IAAI,CAAC;gBACN,aAAa,EAAE,KAAK;gBACpB,EAAE,EAAE,UAAU;gBACd,uBAAuB,EAAE,IAAI;gBAC7B,GAAG,EAAE,IAAI;gBACT,WAAW,EAAE,IAAI;gBACjB,OAAO,EAAE,IAAA,gBAAW,EAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACrD,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA;oBACrD,OAAO,IAAA,cAAS,EAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAA;gBAC7C,CAAC,CAAC;gBACF,OAAO,EAAE;oBACN,QAAQ,EAAE,cAAI,CAAC,IAAI,CAAC,aAAa,EAAE,qBAAqB,CAAC;iBAC3D;aACA,CAAC,CAAA;QACR,CAAC;QACD,OAAO,GAAG,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACb,CAAC;IACJ,CAAC;IAGM,MAAM,CAAC,WAAW,CAAC,aAAsB,EAAE,UAAqB,EAAE,IAAa;QACnF,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,MAAM,CAAC,QAAQ,GAAG,IAAI,MAAM,CAAC,aAAa,EAAE,UAAU,EAAE,IAAI,CAAE,CAAC;QAClE,CAAC;QACD,OAAO,MAAM,CAAC,QAAQ,CAAC;IAC1B,CAAC;IAIO,iBAAiB;QACtB,MAAM,SAAS,GAAa,EAAE,CAAC;QAE/B,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACtB,YAAE,CAAC,WAAW,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAClE,IAAI,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,EAAE,CAAC;oBAClC,SAAS,CAAC,IAAI,CAAE,cAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;gBACjD,CAAC;YACJ,CAAC,CAAC,CAAC;QACN,CAAC;QACD,OAAO,SAAS,CAAC;IACpB,CAAC;IAGO,cAAc,CAAE,IAAY;QACjC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;YACvC,IAAI,GAAG;gBAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,GAAG,EAAE,CAAC,CAAA;QACnE,CAAC,CAAC,CAAC;IACN,CAAC;IAIM,qBAAqB,CAAE,IAAY,EAAE,OAAY,EAAE;QACvD,IAAI,IAAI,GAAQ,EAAE,CAAC;QAEnB,IAAI,CAAC;YACD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAG,CAAC;gBACrC,IAAI,CAAC,cAAc,CAAE,IAAI,CAAC,CAAA;gBAC1B,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBAC7D,IAAK,cAAc,KAAK,SAAS,EAAE,CAAC;oBACjC,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;wBACxD,IAAA,aAAG,EAAC,GAAG,EAAE,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;wBACjC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;4BAChC,IAAA,aAAG,EAAC,GAAG,EAAE,EAAE,CAAC,CAAC;4BACb,KAAK,MAAM,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gCACzC,IAAA,aAAG,EAAC,GAAG,GAAG,EAAE,CAAC,CAAC;gCACd,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,EAAC,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAC,CAAC,CAAC;4BAC/D,CAAC;wBACJ,CAAC;oBACJ,CAAC;gBACJ,CAAC;YACJ,CAAC;QACL,CAAC;QACD,OAAO,GAAG,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACb,CAAC;QAED,OAAO,IAAI,CAAC;IACf,CAAC;IAGM,gBAAgB,CAAE,GAAW,EAAE,IAAY,EAAE,OAAY,EAAE;QAC/D,IAAI,CAAC,GAAG,GAAG,CAAA;QACP,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,IAAI,CAAC;gBACG,IAAI,CAAC,cAAc,CAAE,IAAI,CAAC,CAAA;gBAC1B,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,EAAC,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,EAAC,CAAC,CAAA;gBAChE,IAAA,aAAG,EAAC,oBAAoB,GAAG,SAAS,IAAI,aAAa,CAAC,EAAE,CAAC,CAAA;YACjE,CAAC;YACD,OAAO,GAAG,EAAE,CAAC;gBACV,MAAM,GAAG,CAAC;YACb,CAAC;QACT,CAAC;QACD,OAAO,CAAC,CAAA;IACX,CAAC;IAGM,cAAc,CAAE,aAAuB,EAAE;QAC7C,IAAK,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC3C,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;gBAE9C,MAAM,IAAI,KAAK,CAAC,4DAA4D,UAAU,MAAM,GAAG,EAAE,CAAC,CAAA;YACrG,CAAC,CAAC,CAAA;QACL,CAAC;IACJ,CAAC;CACH;AAhID,yBAgIC"}
+{"version":3,"file":"i18nCh.js","sourceRoot":"","sources":["../../src/utils/i18nCh.ts"],"names":[],"mappings":";;;AAAA,8DAA6B;AAC7B,oFAAwC;AACxC,wDAA2B;AAC3B,iDAA+C;AAC/C,wDAAwB;AACxB,sDAAmE;AAEnE,MAAqB,MAAM;IAQxB,YAAoB,aAAa,GAAG,EAAE,EAAE,aAAuB,EAAE,EAAE,IAAI,GAAG,IAAI;QAHtE,eAAU,GAAa,EAAE,CAAC;QAI/B,IAAI,CAAC;YACF,IAAI,CAAC,aAAa,EAAE,CAAC;gBAElB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAA;YACnF,CAAC;YACD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;YAClC,IAAK,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC5B,UAAU,GAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC1C,CAAC;YACD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;YAE5B,IAAI,CAAC,QAAQ,GAAG,iBAAO,CAAA;YACvB,IAAI,CAAC,QAAQ;iBACT,GAAG,CAAC,4BAAO,CAAC;iBACZ,IAAI,CAAC;gBACN,aAAa,EAAE,KAAK;gBACpB,EAAE,EAAE,UAAU;gBACd,uBAAuB,EAAE,IAAI;gBAC7B,GAAG,EAAE,IAAI;gBACT,WAAW,EAAE,IAAI;gBACjB,OAAO,EAAE,IAAA,gBAAW,EAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE;oBACrD,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA;oBACrD,OAAO,IAAA,cAAS,EAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAA;gBAC7C,CAAC,CAAC;gBACF,OAAO,EAAE;oBACN,QAAQ,EAAE,cAAI,CAAC,IAAI,CAAC,aAAa,EAAE,qBAAqB,CAAC;iBAC3D;aACA,CAAC,CAAA;QACR,CAAC;QACD,OAAO,GAAG,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACb,CAAC;IACJ,CAAC;IAGM,MAAM,CAAC,WAAW,CAAC,aAAsB,EAAE,UAAqB,EAAE,IAAa;QACnF,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,MAAM,CAAC,QAAQ,GAAG,IAAI,MAAM,CAAC,aAAa,EAAE,UAAU,EAAE,IAAI,CAAE,CAAC;QAClE,CAAC;QACD,OAAO,MAAM,CAAC,QAAQ,CAAC;IAC1B,CAAC;IAIO,iBAAiB;QACtB,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC;QACb,CAAC;QAED,MAAM,qBAAqB,GAAG,IAAI,CAAC,sBAAsB,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;QAC/F,MAAM,qBAAqB,GAAG,IAAI,CAAC,sBAAsB,CAAC,cAAI,CAAC,IAAI,CAAC,qCAAyB,EAAE,IAAI,CAAC,CAAC,CAAC;QAEtG,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,qBAAqB,EAAE,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IAEO,sBAAsB,CAAC,UAAkB;QAC9C,IAAI,CAAC;YACF,OAAO,YAAE,CAAC,WAAW,CAAC,UAAU,CAAC;iBAChC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC;iBAC9C,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,cAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACd,IAAA,aAAG,EAAC,2BAA2B,UAAU,KAAK,KAAK,EAAE,CAAC,CAAC;YACvD,OAAO,EAAE,CAAC;QACb,CAAC;IACJ,CAAC;IAIO,cAAc,CAAE,IAAY;QACjC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;YACvC,IAAI,GAAG;gBAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,GAAG,EAAE,CAAC,CAAA;QACnE,CAAC,CAAC,CAAC;IACN,CAAC;IAIM,qBAAqB,CAAE,IAAY,EAAE,OAAY,EAAE;QACvD,IAAI,IAAI,GAAQ,EAAE,CAAC;QAEnB,IAAI,CAAC;YACD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAG,CAAC;gBACrC,IAAI,CAAC,cAAc,CAAE,IAAI,CAAC,CAAA;gBAC1B,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBAC7D,IAAK,cAAc,KAAK,SAAS,EAAE,CAAC;oBACjC,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;wBACxD,IAAA,aAAG,EAAC,GAAG,EAAE,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;wBACjC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;4BAChC,IAAA,aAAG,EAAC,GAAG,EAAE,EAAE,CAAC,CAAC;4BACb,KAAK,MAAM,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gCACzC,IAAA,aAAG,EAAC,GAAG,GAAG,EAAE,CAAC,CAAC;gCACd,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,EAAC,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAC,CAAC,CAAC;4BAC/D,CAAC;wBACJ,CAAC;oBACJ,CAAC;gBACJ,CAAC;YACJ,CAAC;QACL,CAAC;QACD,OAAO,GAAG,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACb,CAAC;QAED,OAAO,IAAI,CAAC;IACf,CAAC;IAGM,gBAAgB,CAAE,GAAW,EAAE,IAAY,EAAE,OAAY,EAAE;QAC/D,IAAI,CAAC,GAAG,GAAG,CAAA;QACP,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChB,IAAI,CAAC;gBACG,IAAI,CAAC,cAAc,CAAE,IAAI,CAAC,CAAA;gBAC1B,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,EAAE,EAAC,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,EAAC,CAAC,CAAA;gBAChE,IAAA,aAAG,EAAC,oBAAoB,GAAG,SAAS,IAAI,aAAa,CAAC,EAAE,CAAC,CAAA;YACjE,CAAC;YACD,OAAO,GAAG,EAAE,CAAC;gBACV,MAAM,GAAG,CAAC;YACb,CAAC;QACT,CAAC;QACD,OAAO,CAAC,CAAA;IACX,CAAC;IAGM,cAAc,CAAE,aAAuB,EAAE;QAC7C,IAAK,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC3C,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;gBAE9C,MAAM,IAAI,KAAK,CAAC,4DAA4D,UAAU,MAAM,GAAG,EAAE,CAAC,CAAA;YACrG,CAAC,CAAC,CAAA;QACL,CAAC;IACJ,CAAC;IAEM,iBAAiB,CAAC,GAAW,EAAE,EAAU;QAC7C,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACnD,CAAC;CAEH;AA/ID,yBA+IC"}

package/lib/utils/locales.d.ts

@@ -0,0 +1 @@
+export declare function copyLocales(): void;

package/lib/utils/locales.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.copyLocales = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const constants_1 = require("../constants/constants");
+const log_1 = tslib_1.__importDefault(require("./log"));
+function copyLocales() {
+    const sources = [constants_1.NODE_MODULES_LOCALES_PATH, `../${constants_1.NODE_MODULES_LOCALES_PATH}`];
+    const targets = ["../locales", "./locales"];
+    const copied = sources.some(src => targets.some(target => {
+        try {
+            fs_1.default.cpSync(src, target, { recursive: true });
+            (0, log_1.default)(`Locales copied from ${src} to ${target}`);
+            return true;
+        }
+        catch (_) {
+            return false;
+        }
+    }));
+    if (!copied) {
+        (0, log_1.default)("Unable to copy locales from any source to any target");
+    }
+}
+exports.copyLocales = copyLocales;
+//# sourceMappingURL=locales.js.map

package/lib/utils/locales.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"locales.js","sourceRoot":"","sources":["../../src/utils/locales.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AACpB,sDAAmE;AACnE,wDAAwB;AAExB,SAAgB,WAAW;IACzB,MAAM,OAAO,GAAG,CAAC,qCAAyB,EAAE,MAAM,qCAAyB,EAAE,CAAC,CAAC;IAC/E,MAAM,OAAO,GAAG,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;IAE5C,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAC9B,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;QACpB,IAAI,CAAC;YACH,YAAE,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5C,IAAA,aAAG,EAAC,uBAAuB,GAAG,OAAO,MAAM,EAAE,CAAC,CAAC;YAC/C,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC,CACL,CAAC;IAEF,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,IAAA,aAAG,EAAC,sDAAsD,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC;AAnBD,kCAmBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@companieshouse/ch-node-utils",
-  "version": "1.3.7",
+  "version": "1.3.9",
   "author": "companieshouse",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -40,7 +40,8 @@
     "express": "^4.18.3",
     "i18next": "^23.10.1",
     "i18next-fs-backend": "^2.3.1",
-    "iso-639-1": "^3.1.2"
+    "iso-639-1": "^3.1.2",
+    "tslib": "^2.3.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.21",

package/templates/navbar.njk

@@ -26,8 +26,9 @@ It receives:
     - href: the URL of the page the menu item will point to
     - displayText: the text to display in the anchor
 - userDisplayText: a text identifying the logged user, e.g. email address or name
+- lang: an object containing language-specific strings for localization
 #}
-{% macro addNavbar(signInHref, menuItems, userDisplayText) %}
+{% macro addNavbar(signInHref, menuItems, userDisplayText, lang) %}
     <div class="js-toggle-nav" id="global-nav">
         <nav role="navigation" class="content" aria-label="{{ lang.mainNavbar or 'The main navigation bar' }}">
             {% if userDisplayText %}
@@ -57,8 +58,10 @@ A macro that adds a menu navigation bar with predefined items.
 It receives:
 - userDisplayText: a text identifying the logged user, e.g. email address or name
 - chsMonitorGuiUrl: the URL for the 'Companies you follow' link
+- lang: an object containing language-specific strings for localization
+- displayAuthorisedAgent: a flag indicating whether to display the 'Authorised agent' menu item
 #}
-{% macro addPredefinedNavbar(userDisplayText, chsMonitorGuiUrl) %}
+{% macro addPredefinedNavbar(userDisplayText, chsMonitorGuiUrl, lang, displayAuthorisedAgent) %}
     {% set menuItems = [
         { id: "authorised-agent", href: "/authorised-agent", displayText: lang.authorisedAgent or "Authorised agent" } if displayAuthorisedAgent === "yes",
         { id: "your-companies", href: "/your-companies", displayText: lang.yourCompanies or "Your companies" },
@@ -69,6 +72,6 @@ It receives:
         { id: "user-signout", href: "/signout", displayText: lang.signOut or "Sign out" }
     ] | reject("falsy") %}
 
-    {{ addNavbar("/signin", menuItems, userDisplayText) }}
+    {{ addNavbar("/signin", menuItems, userDisplayText, lang) }}
 
-{% endmacro %}
+{% endmacro %}