@companieshouse/ch-node-utils 1.3.10 → 1.3.12

package/README.md

@@ -106,7 +106,7 @@ 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'`
+- `displayAuthorisedAgent`: A flag for displaying the "Authorised agent" menu item. If the logged user has ACSP membership, this flag should be set to `'yes'`. If your service uses i18 middleware provided in the `@companieshouse/ch-node-utils` package, then this flag will be set to the correct value automatically. If not, you can use `isAuthorisedAgent` function from `./utils/sessionUtils`.
 
 #### Localization
 

package/lib/constants/constants.d.ts

@@ -2,3 +2,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>;
+export declare const ACSP_NUMBER_REGEX: RegExp;

package/lib/constants/constants.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SHARED_NUNJUCKS_TRANSLATION_NAMESPACES = exports.SHARED_NAVBAR_NAMESPACE = exports.NODE_MODULES_LOCALES_PATH = exports.QUERY_PAR_LANG = void 0;
+exports.ACSP_NUMBER_REGEX = 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
 ]);
+exports.ACSP_NUMBER_REGEX = /^[0-9A-Z-_]{0,32}$/i;
 //# 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;AACvB,QAAA,yBAAyB,GAAG,oDAAoD,CAAC;AACjF,QAAA,uBAAuB,GAAG,sBAAsB,CAAA;AAChD,QAAA,sCAAsC,GAAG,IAAI,GAAG,CAAC;IAC5D,+BAAuB;CACxB,CAAC,CAAC"}
+{"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;IAC1D,+BAAuB;CAC1B,CAAC,CAAC;AACU,QAAA,iBAAiB,GAAG,qBAAqB,CAAC"}

package/lib/index.d.ts

@@ -4,4 +4,5 @@ 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 };
+import { isAuthorisedAgent } from "./utils/sessionUtils";
+export { SubDirs, NamedIsoCode, LanguageNames, i18nCh, LocalesMiddleware, LocalesService, QUERY_PAR_LANG, isAuthorisedAgent };

package/lib/index.js

@@ -1,6 +1,6 @@
 "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;
+exports.isAuthorisedAgent = 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;
@@ -15,4 +15,6 @@ const manageLocales_middleware_1 = require("./middleware/manageLocales.middlewar
 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; } });
+const sessionUtils_1 = require("./utils/sessionUtils");
+Object.defineProperty(exports, "isAuthorisedAgent", { enumerable: true, get: function () { return sessionUtils_1.isAuthorisedAgent; } });
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,sEAAsC;AASlC,kBATG,iBAAO,CASH;AARX,+EAAoE;AAUhE,wBAVG,uBAAa,CAUH;AADb,6FAToB,4BAAY,OASpB;AARhB,oEAAoC;AAUhC,iBAVG,gBAAM,CAUH;AATV,iGAA+D;AAW3D,yBAXG,yBAAc,CAWH;AAVlB,oFAAyE;AASrE,kGATK,4CAAiB,OASL;AARrB,qDAAsD;AAUlD,+FAVK,0BAAc,OAUL;AATlB,uDAAyD;AAUrD,kGAVK,gCAAiB,OAUL"}

package/lib/middleware/manageLocales.middleware.js

@@ -6,6 +6,7 @@ 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 sessionUtils_1 = require("../utils/sessionUtils");
 function LocalesMiddleware() {
     return (req, res, next) => {
         var _a;
@@ -34,6 +35,9 @@ function LocalesMiddleware() {
         res.locals.htmlLang = lang;
         res.locals.pageTitleLang = lang;
         res.locals.mainLang = lang;
+        if ((0, sessionUtils_1.isAuthorisedAgent)(req.session)) {
+            res.locals.displayAuthorisedAgent = "yes";
+        }
         return next();
     };
 }

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,kGAAgE;AAChE,mFAAkD;AAClD,+DAA+B;AAC/B,wDAA0D;AAE1D,SAAgB,iBAAiB;IAC7B,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAE,EAAE;;QAEvD,IAAA,aAAG,EAAC,2CAA2C,CAAC,CAAA;QAChD,IAAI,IAAI,GAAuB,CAAS,GAAG,CAAC,KAAK,CAAC,0BAAc,CAAC;YAC7D,GAAG,CAAC,IAAI,CAAC,IAAI;aACb,MAAA,GAAG,CAAC,OAAO,0CAAE,YAAY,CAAS,0BAAc,CAAC,CAAA,CAAC,CAAA;QACtD,IAAA,aAAG,EAAC,0DAA0D,IAAI,YAAY,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAA;QAC/F,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,uBAAa,CAAC,iBAAiB,CAAC,yBAAc,CAAC,WAAW,EAAE,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,CAAC;YAC3G,IAAI,GAAG,IAAI,CAAA;QACf,CAAC;QACD,IAAA,aAAG,EAAC,uCAAuC,IAAI,GAAG,CAAC,CAAA;QACnD,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YACd,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,0BAAc,EAAE,IAAI,CAAC,CAAA;QAClD,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;YAIlD,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;QAC/F,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;QAG1B,IAAI,IAAA,gCAAiB,EAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACjC,GAAG,CAAC,MAAM,CAAC,sBAAsB,GAAG,KAAK,CAAC;QAC9C,CAAC;QAED,OAAO,IAAI,EAAE,CAAA;IACjB,CAAC,CAAA;AACL,CAAC;AA3CD,8CA2CC"}

package/lib/utils/sessionUtils.d.ts

@@ -0,0 +1,2 @@
+import { Session } from "@companieshouse/node-session-handler";
+export declare function isAuthorisedAgent(session: Session | undefined): boolean;

package/lib/utils/sessionUtils.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isAuthorisedAgent = void 0;
+const tslib_1 = require("tslib");
+const SessionKey_1 = require("@companieshouse/node-session-handler/lib/session/keys/SessionKey");
+const SignInInfoKeys_1 = require("@companieshouse/node-session-handler/lib/session/keys/SignInInfoKeys");
+const constants = tslib_1.__importStar(require("../constants/constants"));
+function isAuthorisedAgent(session) {
+    var _a;
+    const signInInfo = (_a = session === null || session === void 0 ? void 0 : session.data) === null || _a === void 0 ? void 0 : _a[SessionKey_1.SessionKey.SignInInfo];
+    const acspNumber = signInInfo === null || signInInfo === void 0 ? void 0 : signInInfo[SignInInfoKeys_1.SignInInfoKeys.AcspNumber];
+    return !!acspNumber && constants.ACSP_NUMBER_REGEX.test(acspNumber);
+}
+exports.isAuthorisedAgent = isAuthorisedAgent;
+;
+//# sourceMappingURL=sessionUtils.js.map

package/lib/utils/sessionUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessionUtils.js","sourceRoot":"","sources":["../../src/utils/sessionUtils.ts"],"names":[],"mappings":";;;;AACA,iGAA8F;AAC9F,yGAAsG;AACtG,0EAAoD;AAEpD,SAAgB,iBAAiB,CAAE,OAA4B;;IAC3D,MAAM,UAAU,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,0CAAG,uBAAU,CAAC,UAAU,CAAC,CAAC;IAC1D,MAAM,UAAU,GAAG,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAG,+BAAc,CAAC,UAAU,CAAW,CAAC;IACrE,OAAO,CAAC,CAAC,UAAU,IAAI,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AACxE,CAAC;AAJD,8CAIC;AAAA,CAAC"}

package/locales/en/ch-node-utils-navbar.json

@@ -1,6 +1,6 @@
 {
-    "mainNavbar": "The main navigation bar",
-    "clickToExpandOrCollapse": "Click to expand or collapse",
+    "mainNavbar": "Menu",
+    "clickToExpandOrCollapse": "Select to show or hide",
     "signInOrRegister": "Sign in / Register",
     "yourCompanies": "Your companies",
     "authorisedAgent": "Authorised agent",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@companieshouse/ch-node-utils",
-  "version": "1.3.10",
+  "version": "1.3.12",
   "author": "companieshouse",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -36,16 +36,18 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@companieshouse/node-session-handler": "^5.0.1",
+    "@companieshouse/node-session-handler": "^5.1.4",
     "express": "^4.18.3",
     "i18next": "^23.10.1",
     "i18next-fs-backend": "^2.3.1",
+    "ioredis": "^5.4.1",
     "iso-639-1": "^3.1.2",
     "tslib": "^2.3.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.21",
     "@types/i18next": "^13.0.0",
+    "@types/ioredis": "4.28.10",
     "@types/node": "^20.11.28",
     "typescript": "^5.4.2"
   },

package/templates/navbar.njk

@@ -30,10 +30,10 @@ It receives:
 #}
 {% 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' }}">
+        <nav role="navigation" class="content" aria-label="{{ lang.mainNavbar }}">
             {% if userDisplayText %}
                 <a href="#navigation" class="js-header-toggle menu">{{ userDisplayText }}
-                    <span class="govuk-visually-hidden">{{ lang.clickToExpandOrCollapse or 'Click to expand or collapse' }}</span>
+                    <span class="govuk-visually-hidden">{{ lang.clickToExpandOrCollapse }}</span>
                 </a>
             {% else %}
                 <a id="user-signin-mobile" href="{{ signInHref }}" class="sign-in govuk-link">{{ lang.signInOrRegister or 'Sign in / Register' }}</a>