@companieshouse/ch-node-utils 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Companies House
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,2 @@
+# ch-node-utils
+set of node utils which can be used across repos/projects

package/lib/constants/constants.d.ts

@@ -0,0 +1 @@
+export declare const QUERY_PAR_LANG = "lang";

package/lib/constants/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QUERY_PAR_LANG = void 0;
+exports.QUERY_PAR_LANG = "lang";
+//# sourceMappingURL=constants.js.map

package/lib/constants/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG,MAAM,CAAA"}

package/lib/index.d.ts

@@ -0,0 +1,7 @@
+import SubDirs from "./utils/subDirs";
+import LanguageNames, { NamedIsoCode } from "./utils/languageNames";
+import i18nCh from "./utils/i18nCh";
+import LocalesService from "./services/locales/locales.service";
+import { LocalesMiddleware } from "./middleware/manageLocales.middleware";
+import { QUERY_PAR_LANG } from "./constants/constants";
+export { SubDirs, NamedIsoCode, LanguageNames, i18nCh, LocalesMiddleware, LocalesService, QUERY_PAR_LANG };

package/lib/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QUERY_PAR_LANG = exports.LocalesService = exports.LocalesMiddleware = exports.i18nCh = exports.LanguageNames = exports.NamedIsoCode = exports.SubDirs = void 0;
+const tslib_1 = require("tslib");
+const subDirs_1 = tslib_1.__importDefault(require("./utils/subDirs"));
+exports.SubDirs = subDirs_1.default;
+const languageNames_1 = tslib_1.__importStar(require("./utils/languageNames"));
+exports.LanguageNames = languageNames_1.default;
+Object.defineProperty(exports, "NamedIsoCode", { enumerable: true, get: function () { return languageNames_1.NamedIsoCode; } });
+const i18nCh_1 = tslib_1.__importDefault(require("./utils/i18nCh"));
+exports.i18nCh = i18nCh_1.default;
+const locales_service_1 = tslib_1.__importDefault(require("./services/locales/locales.service"));
+exports.LocalesService = locales_service_1.default;
+const manageLocales_middleware_1 = require("./middleware/manageLocales.middleware");
+Object.defineProperty(exports, "LocalesMiddleware", { enumerable: true, get: function () { return manageLocales_middleware_1.LocalesMiddleware; } });
+const constants_1 = require("./constants/constants");
+Object.defineProperty(exports, "QUERY_PAR_LANG", { enumerable: true, get: function () { return constants_1.QUERY_PAR_LANG; } });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,sEAAsC;AAQnC,kBARI,iBAAO,CAQJ;AAPV,+EAAkE;AAS/D,wBATI,uBAAa,CASJ;AADb,6FARoB,4BAAY,OAQpB;AAPf,oEAAoC;AASjC,iBATI,gBAAM,CASJ;AART,iGAA+D;AAU5D,yBAVI,yBAAc,CAUJ;AATjB,oFAAyE;AAQtE,kGARM,4CAAiB,OAQN;AAPpB,qDAAsD;AASnD,+FATM,0BAAc,OASN"}

package/lib/middleware/manageLocales.middleware.d.ts

@@ -0,0 +1,2 @@
+import { RequestHandler } from "express";
+export declare function LocalesMiddleware(): RequestHandler;

package/lib/middleware/manageLocales.middleware.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalesMiddleware = void 0;
+const tslib_1 = require("tslib");
+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"));
+function LocalesMiddleware() {
+    return (req, res, next) => {
+        var _a;
+        console.log("----------X2 (ManageLocales) ------------");
+        let lang = (req.query[constants_1.QUERY_PAR_LANG] ||
+            req.body.lang ||
+            ((_a = req.session) === null || _a === void 0 ? void 0 : _a.getExtraData(constants_1.QUERY_PAR_LANG)));
+        console.log(`=====1=====Mng Loc ....(init lang=${lang}) - body:${req.body.lang}`);
+        console.log("body:");
+        console.log(req.body);
+        console.log("=====2=====Mng Loc");
+        if (lang === undefined || !languageNames_1.default.isSupportedLocale(locales_service_1.default.getInstance().localesFolder, lang)) {
+            lang = "en";
+        }
+        if (req.session) {
+            req.session.setExtraData(constants_1.QUERY_PAR_LANG, lang);
+        }
+        req.lang = lang;
+        const [pathWithoutQuery] = req.url.split("?");
+        req.url = pathWithoutQuery;
+        const currentUrl = `${req.protocol}://${req.get("host")}${pathWithoutQuery}`;
+        res.locals.currentUrl = currentUrl;
+        res.locals.htmlLang = lang;
+        res.locals.pageTitleLang = lang;
+        res.locals.mainLang = lang;
+        return next();
+    };
+}
+exports.LocalesMiddleware = LocalesMiddleware;
+//# sourceMappingURL=manageLocales.middleware.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"manageLocales.middleware.js","sourceRoot":"","sources":["../../src/middleware/manageLocales.middleware.ts"],"names":[],"mappings":";;;;AACA,sDAAuD;AACvD,kGAAgE;AAEhE,mFAAoD;AAEpD,SAAgB,iBAAiB;IAC3B,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;;QACxD,OAAO,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAA;QAE7D,IAAI,IAAI,GAAuB,CAAS,GAAG,CAAC,KAAK,CAAC,0BAAc,CAAC;YACjC,GAAG,CAAC,IAAI,CAAC,IAAI;aACb,MAAA,GAAG,CAAC,OAAO,0CAAE,YAAY,CAAS,0BAAc,CAAC,CAAA,CAAC,CAAA;QAClF,OAAO,CAAC,GAAG,CAAC,qCAAqC,IAAI,YAAY,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QAGjF,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QACpB,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAGrB,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;QAClC,IAAI,IAAI,KAAK,SAAS,IAAI,CAAE,uBAAa,CAAC,iBAAiB,CAAE,yBAAc,CAAC,WAAW,EAAE,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE;YAC1G,IAAI,GAAG,IAAI,CAAA;SACf;QACD,IAAI,GAAG,CAAC,OAAO,EAAE;YACf,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,0BAAc,EAAE,IAAI,CAAC,CAAA;SAC/C;QACD,GAAG,CAAC,IAAI,GAAG,IAAI,CAAA;QACf,MAAM,CAAC,gBAAgB,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAC7C,GAAG,CAAC,GAAG,GAAG,gBAAgB,CAAA;QAE1B,MAAM,UAAU,GAAG,GAAG,GAAG,CAAC,QAAQ,MAAM,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,gBAAgB,EAAE,CAAA;QAC5E,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,UAAU,CAAA;QAGlC,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;IACf,CAAC,CAAA;AACH,CAAC;AAnCD,8CAmCC"}

package/lib/services/locales/locales.service.d.ts

@@ -0,0 +1,9 @@
+import i18nCh from "../../utils/i18nCh";
+export default class LocalesService {
+    private static instance;
+    enabled: Boolean;
+    localesFolder: string;
+    i18nCh: i18nCh;
+    private constructor();
+    static getInstance(localesFolder?: string, enabled?: Boolean): LocalesService;
+}

package/lib/services/locales/locales.service.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const i18nCh_1 = tslib_1.__importDefault(require("../../utils/i18nCh"));
+class LocalesService {
+    constructor(localesFolder, enabled) {
+        console.log("----------X0 (construct) ------------");
+        this.enabled = enabled;
+        this.localesFolder = localesFolder;
+        this.i18nCh = i18nCh_1.default.getInstance(localesFolder);
+        console.log(`enabled: ${this.enabled} / path: ${this.localesFolder}`);
+        console.log(`enabled: ${this.enabled} / path: ${this.localesFolder} / i18nCh: ${this.i18nCh}`);
+    }
+    static getInstance(localesFolder = "locales", enabled = false) {
+        console.log("----------X0 (getInst) ------------");
+        if (!LocalesService.instance) {
+            LocalesService.instance = new LocalesService(localesFolder, enabled);
+        }
+        return LocalesService.instance;
+    }
+}
+exports.default = LocalesService;
+//# sourceMappingURL=locales.service.js.map

package/lib/services/locales/locales.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"locales.service.js","sourceRoot":"","sources":["../../../src/services/locales/locales.service.ts"],"names":[],"mappings":";;;AAAA,wEAAwC;AAExC,MAAqB,cAAc;IAOhC,YAAoB,aAAqB,EAAE,OAAgB;QACxD,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAA;QAEpD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,MAAM,GAAG,gBAAM,CAAC,WAAW,CAAC,aAAa,CAAC,CAAA;QAC/C,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,CAAC,OAAO,YAAY,IAAI,CAAC,aAAa,EAAE,CAAC,CAAA;QACrE,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,CAAC,OAAO,YAAY,IAAI,CAAC,aAAa,cAAc,IAAI,CAAC,MAAM,EAAE,CAAC,CAAA;IACjG,CAAC;IAIM,MAAM,CAAC,WAAW,CAAC,gBAAwB,SAAS,EAAE,UAAmB,KAAK;QAClF,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAA;QAClD,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE;YAC3B,cAAc,CAAC,QAAQ,GAAG,IAAI,cAAc,CAAC,aAAa,EAAE,OAAO,CAAC,CAAA;SACtE;QACD,OAAO,cAAc,CAAC,QAAQ,CAAC;IAClC,CAAC;CACH;AA1BD,iCA0BC"}

package/lib/utils/i18nCh.d.ts

@@ -0,0 +1,13 @@
+export default class i18nCh {
+    private static instance;
+    private i18nInst;
+    private localesFolder;
+    private nameSpaces;
+    private constructor();
+    static getInstance(localesFolder?: string, nameSpaces?: string[], lang?: string): i18nCh;
+    private loadAllNamespaces;
+    private changeLanguage;
+    resolveNamespacesKeys(lang: string, vars?: any): any;
+    resolveSingleKey(key: string, lang: string, vars?: any): string;
+    loadNamespaces(nameSpaces?: string[]): void;
+}

package/lib/utils/i18nCh.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const i18next_1 = tslib_1.__importDefault(require("i18next"));
+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"));
+class i18nCh {
+    constructor(localesFolder = "", nameSpaces = [], lang = "en") {
+        this.nameSpaces = [];
+        try {
+            if (!localesFolder) {
+                throw new Error("i18nCh initialization error: path to locales must be provided");
+            }
+            this.localesFolder = localesFolder;
+            if (nameSpaces.length === 0) {
+                nameSpaces = this.loadAllNamespaces();
+            }
+            this.nameSpaces = nameSpaces;
+            this.i18nInst = i18next_1.default;
+            this.i18nInst
+                .use(i18next_fs_backend_1.default)
+                .init({
+                initImmediate: false,
+                ns: nameSpaces,
+                partialBundledLanguages: true,
+                lng: lang,
+                fallbackLng: "en",
+                preload: (0, fs_1.readdirSync)(localesFolder).filter((fileName) => {
+                    const joinedPath = path_1.default.join(localesFolder, fileName);
+                    return (0, fs_1.lstatSync)(joinedPath).isDirectory();
+                }),
+                backend: {
+                    loadPath: path_1.default.join(localesFolder, `{{lng}}/{{ns}}.json`)
+                }
+            });
+        }
+        catch (err) {
+            throw err;
+        }
+    }
+    static getInstance(localesFolder, nameSpaces, lang) {
+        if (!i18nCh.instance) {
+            i18nCh.instance = new i18nCh(localesFolder, nameSpaces, lang);
+        }
+        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"));
+                }
+            });
+        }
+        return jsonFiles;
+    }
+    changeLanguage(lang) {
+        this.i18nInst.changeLanguage(lang, (err) => {
+            if (err)
+                throw new Error(`i18nCh changeLanguage error: ${err}`);
+        });
+    }
+    resolveNamespacesKeys(lang, vars = {}) {
+        let data = {};
+        try {
+            if (this.i18nInst && this.nameSpaces) {
+                this.changeLanguage(lang);
+                const keysValuesList = this.i18nInst.getDataByLanguage("en");
+                if (keysValuesList !== undefined) {
+                    for (const [ns, value] of Object.entries(keysValuesList)) {
+                        console.log(`${ns}: ${this.nameSpaces}`);
+                        if (this.nameSpaces.includes(ns)) {
+                            console.log(`${ns}`);
+                            for (const [key] of Object.entries(value)) {
+                                console.log(`${key}`);
+                                data[key] = this.i18nInst.t(key, { lng: lang, ns: ns, vars });
+                            }
+                        }
+                    }
+                }
+            }
+        }
+        catch (err) {
+            throw err;
+        }
+        return data;
+    }
+    resolveSingleKey(key, lang, vars = {}) {
+        let t = key;
+        if (this.i18nInst) {
+            try {
+                this.changeLanguage(lang);
+                t = this.i18nInst.t(key, { lng: lang, ns: this.nameSpaces, vars });
+                console.log(`searched for key:${key} lang:${lang} and got: ${t}`);
+            }
+            catch (err) {
+                throw err;
+            }
+        }
+        return t;
+    }
+    loadNamespaces(nameSpaces = []) {
+        if (nameSpaces.length > 0 && this.i18nInst) {
+            this.i18nInst.loadNamespaces(nameSpaces, (err) => {
+                throw new Error(`i18nCh loadNamespaces error - unable to load namespaces: ${nameSpaces} - ${err}`);
+            });
+        }
+    }
+}
+exports.default = i18nCh;
+//# sourceMappingURL=i18nCh.js.map

package/lib/utils/i18nCh.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i18nCh.js","sourceRoot":"","sources":["../../src/utils/i18nCh.ts"],"names":[],"mappings":";;;AAAA,8DAA6B;AAC7B,oFAAwC;AACxC,wDAA2B;AAC3B,iDAA+C;AAE/C,MAAqB,MAAM;IAQxB,YAAoB,aAAa,GAAG,EAAE,EAAE,aAAuB,EAAE,EAAE,IAAI,GAAG,IAAI;QAHtE,eAAU,GAAa,EAAE,CAAC;QAI/B,IAAI;YACD,IAAI,CAAC,aAAa,EAAE;gBAEjB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAA;aAClF;YACD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;YAClC,IAAK,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC3B,UAAU,GAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;aACzC;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;SACP;QACD,OAAO,GAAG,EAAE;YACT,MAAM,GAAG,CAAC;SACZ;IACJ,CAAC;IAGM,MAAM,CAAC,WAAW,CAAC,aAAsB,EAAE,UAAqB,EAAE,IAAa;QACnF,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACnB,MAAM,CAAC,QAAQ,GAAG,IAAI,MAAM,CAAC,aAAa,EAAE,UAAU,EAAE,IAAI,CAAE,CAAC;SACjE;QACD,OAAO,MAAM,CAAC,QAAQ,CAAC;IAC1B,CAAC;IAIO,iBAAiB;QACtB,MAAM,SAAS,GAAa,EAAE,CAAC;QAE/B,IAAI,IAAI,CAAC,aAAa,EAAE;YACrB,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;oBAC3B,SAAS,CAAC,IAAI,CAAE,cAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;iBAChD;YACP,CAAC,CAAC,CAAC;SACR;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;YACA,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAG;gBACpC,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;oBAChC,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;wBACvD,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;wBACzC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;4BAC/B,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;4BACrB,KAAK,MAAM,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gCACxC,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC;gCACtB,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;6BAC9D;yBACH;qBACH;iBACH;aACH;SACJ;QACD,OAAO,GAAG,EAAE;YACT,MAAM,GAAG,CAAC;SACZ;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;YACf,IAAI;gBACI,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,OAAO,CAAC,GAAG,CAAC,oBAAoB,GAAG,SAAS,IAAI,aAAa,CAAC,EAAE,CAAC,CAAA;aACxE;YACD,OAAO,GAAG,EAAE;gBACT,MAAM,GAAG,CAAC;aACZ;SACR;QACD,OAAO,CAAC,CAAA;IACX,CAAC;IAGM,cAAc,CAAE,aAAuB,EAAE;QAC7C,IAAK,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE;YAC1C,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;SACJ;IACJ,CAAC;CACH;AAhID,yBAgIC"}

package/lib/utils/languageNames.d.ts

@@ -0,0 +1,14 @@
+export declare class NamedIsoCode {
+    IsoCode: string;
+    Name: string;
+    constructor(IsoCode: string, Name: string);
+}
+export default class LanguageNames {
+    static getNamesArray(isoCodes: string[]): string[];
+    static getNativeNamesArray(isoCodes: string[]): string[];
+    static getNamesObjectArray(isoCodes: string[]): NamedIsoCode[];
+    static getNativeNamesObjectArray(isoCodes: string[]): NamedIsoCode[];
+    private static _customSort;
+    static sourceLocales(localesDir: string): NamedIsoCode[];
+    static isSupportedLocale(localesDir: string, locale: string): boolean;
+}

package/lib/utils/languageNames.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NamedIsoCode = void 0;
+const tslib_1 = require("tslib");
+const iso_639_1_1 = tslib_1.__importDefault(require("iso-639-1"));
+const subDirs_js_1 = tslib_1.__importDefault(require("./subDirs.js"));
+class NamedIsoCode {
+    constructor(IsoCode, Name) {
+        this.IsoCode = IsoCode;
+        this.Name = Name;
+    }
+}
+exports.NamedIsoCode = NamedIsoCode;
+class LanguageNames {
+    static getNamesArray(isoCodes) {
+        return isoCodes.map((isoCode) => iso_639_1_1.default.getName(isoCode));
+    }
+    static getNativeNamesArray(isoCodes) {
+        return isoCodes.map((isoCode) => iso_639_1_1.default.getNativeName(isoCode));
+    }
+    static getNamesObjectArray(isoCodes) {
+        return isoCodes.map((isoCode) => (new NamedIsoCode(isoCode, iso_639_1_1.default.getName(isoCode))));
+    }
+    static getNativeNamesObjectArray(isoCodes) {
+        return isoCodes.map((isoCode) => (new NamedIsoCode(isoCode, iso_639_1_1.default.getNativeName(isoCode))));
+    }
+    static _customSort(a, b) {
+        if (a === "en") {
+            return -1;
+        }
+        if (b === "en") {
+            return 1;
+        }
+        return a.localeCompare(b);
+    }
+    static sourceLocales(localesDir) {
+        const localesArray = subDirs_js_1.default.getSubDirs(localesDir);
+        return LanguageNames.getNativeNamesObjectArray(localesArray.sort(LanguageNames._customSort));
+    }
+    static isSupportedLocale(localesDir, locale) {
+        return subDirs_js_1.default.getSubDirs(localesDir).includes(locale);
+    }
+}
+exports.default = LanguageNames;
+//# sourceMappingURL=languageNames.js.map

package/lib/utils/languageNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"languageNames.js","sourceRoot":"","sources":["../../src/utils/languageNames.ts"],"names":[],"mappings":";;;;AAAA,kEAAgC;AAChC,sEAAmC;AAEnC,MAAa,YAAY;IACtB,YAAmB,OAAe,EAAS,IAAY;QAApC,YAAO,GAAP,OAAO,CAAQ;QAAS,SAAI,GAAJ,IAAI,CAAQ;IACvD,CAAC;CACH;AAHD,oCAGC;AAED,MAAqB,aAAa;IAC/B,MAAM,CAAC,aAAa,CAAC,QAAkB;QACpC,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,mBAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9D,CAAC;IAED,MAAM,CAAC,mBAAmB,CAAC,QAAkB;QAC1C,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,mBAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,CAAC,mBAAmB,CAAC,QAAkB;QAE1C,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,YAAY,CAAC,OAAO,EAAE,mBAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAE,CAAC;IAC5F,CAAC;IAED,MAAM,CAAC,yBAAyB,CAAC,QAAkB;QAEhD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,YAAY,CAAC,OAAO,EAAE,mBAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAE,CAAC;IAClG,CAAC;IAKO,MAAM,CAAC,WAAW,CAAC,CAAS,EAAE,CAAS;QAC/C,IAAI,CAAC,KAAK,IAAI,EAAE;YAAE,OAAO,CAAC,CAAC,CAAC;SAAE;QAC9B,IAAI,CAAC,KAAK,IAAI,EAAE;YAAE,OAAQ,CAAC,CAAC;SAAE;QAE9B,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,aAAa,CAAE,UAAkB;QACrC,MAAO,YAAY,GAAG,oBAAO,CAAC,UAAU,CAAE,UAAU,CAAC,CAAC;QACtD,OAAO,aAAa,CAAC,yBAAyB,CAAE,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC;IACjG,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAE,UAAkB,EAAE,MAAc;QACzD,OAAO,oBAAO,CAAC,UAAU,CAAE,UAAU,CAAC,CAAC,QAAQ,CAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;CACH;AArCD,gCAqCC"}

package/lib/utils/subDirs.d.ts

@@ -0,0 +1,3 @@
+export default class SubDirs {
+    static getSubDirs(dirPath: string): string[];
+}

package/lib/utils/subDirs.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const path_1 = tslib_1.__importDefault(require("path"));
+class SubDirs {
+    static getSubDirs(dirPath) {
+        const contents = fs_1.default.readdirSync(dirPath);
+        const subDirectories = contents.filter((item) => {
+            const itemPath = path_1.default.join(dirPath, item);
+            return fs_1.default.statSync(itemPath).isDirectory();
+        });
+        return subDirectories;
+    }
+}
+exports.default = SubDirs;
+//# sourceMappingURL=subDirs.js.map

package/lib/utils/subDirs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subDirs.js","sourceRoot":"","sources":["../../src/utils/subDirs.ts"],"names":[],"mappings":";;;AAAA,oDAAsB;AACtB,wDAAwB;AAExB,MAAqB,OAAO;IACzB,MAAM,CAAC,UAAU,CAAE,OAAe;QAE/B,MAAM,QAAQ,GAAG,YAAE,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAGzC,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YAC7C,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC1C,OAAO,YAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACzB,CAAC;CACH;AAbD,0BAaC"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@companieshouse/ch-node-utils",
+  "version": "0.1.0",
+  "author": "companieshouse",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "lib",
+    "templates"
+  ],
+  "description": "set of node utils which can be used across repos/projects",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/companieshouse/ch-node-utils"
+  },
+  "scripts": {
+    "prebuild": "rm -rf ./lib",
+    "build": "tsc",
+    "_test": "mocha --recursive test/**/*.spec.ts",
+    "test": "echo 'would execute: mocha --recursive test/**/*.spec.ts'",
+    "_lint": "eslint 'src/*.ts' 'src/**/*.ts' 'test/**/*.ts'",
+    "lint": "echo would execute: eslint 'src/*.ts' 'src/**/*.ts' 'test/**/*.ts'",
+    "_lint:fix": "eslint 'src/*.ts' 'src/**/*.ts' 'test/**/*.ts' --fix",
+    "lint:fix": "echo would execute: eslint 'src/*.ts' 'src/**/*.ts' 'test/**/*.ts' --fix",
+    "_coverage": "nyc npm test",
+    "coverage": "echo 'would execute: nyc npm test'",
+    "_test:coverage": "nyc --check-coverage --reporter=text-summary npm run test",
+    "test:coverage": "echo 'would execute: nyc --check-coverage --reporter=text-summary npm run test'",
+    "_coverage:report": "nyc --reporter=lcov --reporter=text npm run test",
+    "coverage:report": "echo 'would execute: nyc --reporter=lcov --reporter=text npm run test'",
+    "_analyse-code": "sonar-scanner",
+    "analyse-code": "echo 'would execute: sonar-scanner'",
+    "prepublishOnly": "[ ! -d node_modules ] && npm install; tsc",
+    "postpublish": "rm -rf lib"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@companieshouse/node-session-handler": "^4.1.9",
+    "express": "^4.18.2",
+    "i18next": "^23.4.6",
+    "i18next-fs-backend": "^2.1.5",
+    "iso-639-1": "^3.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.17",
+    "@types/i18next": "^13.0.0",
+    "@types/node": "^20.5.7",
+    "typescript": "^5.2.2"
+  },
+  "bugs": {
+    "url": "https://github.com/companieshouse/ch-node-utils/issues"
+  },
+  "homepage": "https://github.com/companieshouse/ch-node-utils#readme"
+}

package/templates/add-lang-to-url.njk

@@ -0,0 +1,33 @@
+{#
+macro to add the lang=... query params in a url passed in as arg
+Note: the url is amended only if the 'langInSession' var is not defined/pushed to the template.
+      If the var is defined, that means that the lang can be retrieved, in the backend,
+      from the session, so no need to add that in the url.
+      If a url is "extra-service" (it doesn't point back to the service which loaded this template)
+      then there is no session to retrieve the lang=... value from, in this case, the lang=...
+      query parm could be required even though the 'langInSession' is defined.
+      Another case is when the value stored in a session is old (i.e. the user clicked
+      a change of language), even in this scenario we want to send the lang=... value
+      via a url query param instead of retrieveing the old one from the session.
+      To force a url change regardless of anything, an optional 'force' boolean-arg is added.
+It receives:
+- url:   the url to amend
+- lang:  the value for lang=.... (i.e. 'en') }
+- force: to force the url amend. regardless of 'langInSession'
+#}
+{% macro addLangToUrl(url, lang='en', force=false) %}
+{% if not langInSession or force %}    {# check if the url amend is required #}
+   {% if url.includes('?') %}          {# check if there are query params already #}
+      {% set regExp = r/([\?&]lang=)[^&]*/g %}
+      {% if regExp.test(url) %}
+         {% set url = url.replace(regExp, '$1' + lang) %} {# already present. Amend #}
+      {% else %}
+         {% set url = url + '&lang=' + lang %}  {# not already present. Add it #}
+      {% endif %}
+   {% else %}
+      {% set url = url + '?lang=' + lang %}   {# there are no args at all. Add it #}
+   {% endif %}
+   {% set url = url.replace(r/\?&/, '?') %}  {# in case of original url just 1 single '?' #}
+{% endif %}
+{{ url }}
+{% endmacro %}

package/templates/locales-banner.njk

@@ -0,0 +1,27 @@
+{#
+template to be reused in all the services to display the locales menu/banner.
+It receives:
+- languageEnabled: to keep all hidden if feature-flag is off
+- languages: array of pairs {.Name (i.e. 'English')   .IsoCode (i.e. 'en') }
+- currentUrl: self-url. It's used to resend to the backend the same request wih the proper
+              query parameter ("lang=..") set
+              (i.e. https://.....<self>....../?lang=cy)
+#}
+
+<div class="govuk-width-container ">
+    <div class="govuk-grid-column-full no-padd">
+        <nav class="govuk-language-select" aria-label="Language switcher">
+            <ul class="govuk-language-select__list">
+            {% if languageEnabled %}
+               {% for l in languages %}
+                <li class="govuk-language-select__list-item">
+                    <a href="{{lang2url.addLangToUrl(currentUrl, l.IsoCode, true)}}" lang={{l.IsoCode}} rel="alternate" class="govuk-link" >
+                        <span aria-hidden="true">{{l.Name}}</span>
+                    </a>
+                </li>
+               {% endfor %}
+            {% endif %}
+            </ul>
+        </nav>
+    </div>
+</div>