@companieshouse/ch-node-utils 1.3.14 → 1.3.15

package/README.md

@@ -82,14 +82,14 @@ Available as a normal npm dependency([here on npmjs](https://www.npmjs.com/packa
 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 companies (conditional)
 - Your filings
 - Companies you follow
 - Basket
 - Manage account
 - Sign out
 
-The "Authorised agent" menu item appears conditionally if the logged user has ACSP membership.
+The "Authorised agent" menu item appears conditionally if the logged user has ACSP membership. The "Your companies" menu items appears conditionally until the service is live.
 
 #### Usage
 
@@ -107,6 +107,7 @@ The macro requires the following parameters:
 - `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'`. 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`.
+- `displayYourCompanies`: A flag for displaying the "Your companies" menu item. It should be set to `'yes` if this menu iten needs to be displayed.
 
 #### Localization
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@companieshouse/ch-node-utils",
-  "version": "1.3.14",
+  "version": "1.3.15",
   "author": "companieshouse",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

package/templates/navbar.njk

@@ -60,11 +60,12 @@ It receives:
 - 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
+- displayYourCompanies: a flag indicating whether to display the 'Your companies' menu item
 #}
-{% macro addPredefinedNavbar(userDisplayText, chsMonitorGuiUrl, lang, displayAuthorisedAgent) %}
+{% macro addPredefinedNavbar(userDisplayText, chsMonitorGuiUrl, lang, displayAuthorisedAgent, displayYourCompanies) %}
     {% 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" },
+        { id: "your-companies", href: "/your-companies", displayText: lang.yourCompanies or "Your companies" } if displayYourCompanies === "yes",
         { id: "your-filings", href: "/user/transactions", displayText: lang.yourFilings or "Your filings" },
         { id: "companies-you-follow", href: chsMonitorGuiUrl, displayText: lang.companiesYouFollow or "Companies you follow" },
         { id: "basket", href: "/basket", displayText: lang.basket or "Basket" },
@@ -74,4 +75,4 @@ It receives:
 
     {{ addNavbar("/signin", menuItems, userDisplayText, lang) }}
 
-{% endmacro %}
+{% endmacro %}