@defra/lis-infra-ui-services 0.22.0 → 0.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/lis-infra-ui-services",
-  "version": "0.22.0",
+  "version": "0.23.0",
   "description": "UI-Services shared definitions for the livestock taxonomy topology.",
   "main": "src/index.js",
   "repository": {
@@ -19,7 +19,6 @@
     "./duration": "./src/duration.js",
     "./errors": "./src/errors/index.js",
     "./maintenance": "./src/maintenance.js",
-    "./navigation": "./src/navigation.js",
     "./nunjucks/build-navigation": "./src/nunjucks/build-navigation.js",
     "./nunjucks/context": "./src/nunjucks/context.js",
     "./nunjucks/filters": "./src/nunjucks/filters.js",

package/src/components/autocomplete.scss

@@ -1,7 +1,7 @@
-@use "accessible-autocomplete/dist/accessible-autocomplete.min.css";
-@use "govuk-frontend" as *;
+@use 'accessible-autocomplete/dist/accessible-autocomplete.min.css';
+@use 'govuk-frontend' as *;
 
 .app-autocomplete .autocomplete__input.govuk-input--error,
 .app-autocomplete .autocomplete__hint.govuk-input--error {
-  border-color: govuk-functional-colour("error");
+  border-color: govuk-functional-colour('error');
 }

package/src/components/search-form.scss

@@ -1,6 +1,6 @@
 // Modelled on govuk_publishing_components' gem-c-search (large, on-white
 // variant): https://github.com/alphagov/govuk_publishing_components
-@use "govuk-frontend" as *;
+@use 'govuk-frontend' as *;
 
 $lis-search-form-input-size: 50px;
 
@@ -11,7 +11,7 @@ $lis-search-form-input-size: 50px;
 .lis-search-form__wrapper {
   display: table;
   width: 100%;
-  background: govuk-colour("white");
+  background: govuk-colour('white');
 }
 
 .lis-search-form__input {
@@ -22,12 +22,13 @@ $lis-search-form-input-size: 50px;
   height: $lis-search-form-input-size;
   margin: 0;
   padding: govuk-em(6, 19);
-  border: $govuk-border-width-form-element solid govuk-functional-colour("input-border");
+  border: $govuk-border-width-form-element solid
+    govuk-functional-colour('input-border');
   border-right-width: 0;
   @include govuk-font($size: 19);
 
   &:focus {
-    outline: $govuk-focus-width solid govuk-functional-colour("focus");
+    outline: $govuk-focus-width solid govuk-functional-colour('focus');
     outline-offset: 0;
     box-shadow: inset 0 0 0 $govuk-border-width-form-element;
     border-right-width: $govuk-border-width-form-element;
@@ -48,20 +49,21 @@ $lis-search-form-input-size: 50px;
   padding: 0;
   border: 0;
   border-radius: 0;
-  background-color: govuk-colour("blue");
-  color: govuk-colour("white");
+  background-color: govuk-colour('blue');
+  color: govuk-colour('white');
   text-indent: -5000px;
   overflow: hidden;
   cursor: pointer;
 
   &:hover {
-    background-color: govuk-colour("blue", $variant: "shade-25");
+    background-color: govuk-colour('blue', $variant: 'shade-25');
   }
 
   &:focus {
-    outline: $govuk-focus-width solid govuk-functional-colour("focus");
+    outline: $govuk-focus-width solid govuk-functional-colour('focus');
     outline-offset: 0;
-    box-shadow: inset 0 0 0 ($govuk-border-width-form-element * 2) govuk-colour("black");
+    box-shadow: inset 0 0 0 ($govuk-border-width-form-element * 2)
+      govuk-colour('black');
   }
 }
 

package/src/components/sortable-paginated-table.scss

@@ -1,24 +1,24 @@
-@use "govuk-frontend" as *;
+@use 'govuk-frontend' as *;
 
 .lis-sortable-table__link {
   display: inline-flex;
   align-items: center;
-  color: govuk-functional-colour("brand");
+  color: govuk-functional-colour('brand');
   text-decoration: none;
 
   &:visited,
   &:hover {
-    color: govuk-functional-colour("brand");
+    color: govuk-functional-colour('brand');
     text-decoration: none;
   }
 
   &:focus {
     outline: none;
-    color: govuk-functional-colour("focus-text");
-    background-color: govuk-functional-colour("focus");
+    color: govuk-functional-colour('focus-text');
+    background-color: govuk-functional-colour('focus');
     box-shadow:
-      0 -2px govuk-functional-colour("focus"),
-      0 4px govuk-functional-colour("focus-text");
+      0 -2px govuk-functional-colour('focus'),
+      0 4px govuk-functional-colour('focus-text');
   }
 }
 
@@ -37,9 +37,9 @@
   // The GOV.UK non-text focus state - yellow alone has too little contrast
   // against a white page. Both rings sit outside the box, clear of the text.
   &:focus {
-    outline: $govuk-focus-width solid govuk-functional-colour("focus");
+    outline: $govuk-focus-width solid govuk-functional-colour('focus');
     outline-offset: $govuk-focus-width;
-    box-shadow: 0 0 0 $govuk-focus-width govuk-functional-colour("focus-text");
+    box-shadow: 0 0 0 $govuk-focus-width govuk-functional-colour('focus-text');
   }
 
   // A header never wraps - on a narrow screen the table scrolls inside the

package/src/components/sub-navigation.scss

@@ -1,4 +1,4 @@
-@use "govuk-frontend" as *;
+@use 'govuk-frontend' as *;
 
 .lis-sub-navigation {
   margin-bottom: govuk-spacing(6);
@@ -12,14 +12,14 @@
 
   @include govuk-media-query($from: tablet) {
     width: 100%;
-    box-shadow: inset 0 -1px 0 govuk-functional-colour("border");
+    box-shadow: inset 0 -1px 0 govuk-functional-colour('border');
   }
 }
 
 .lis-sub-navigation__item {
   display: block;
   margin-top: -1px;
-  box-shadow: inset 0 -1px 0 govuk-functional-colour("border");
+  box-shadow: inset 0 -1px 0 govuk-functional-colour('border');
   @include govuk-font-size(19);
 
   &:last-child {
@@ -38,7 +38,7 @@
   display: block;
   position: relative;
   padding: 12px 0 12px govuk-spacing(3);
-  color: govuk-functional-colour("link");
+  color: govuk-functional-colour('link');
   text-decoration: none;
 
   @include govuk-media-query($from: tablet) {
@@ -46,37 +46,37 @@
   }
 
   &:visited {
-    color: govuk-functional-colour("link");
+    color: govuk-functional-colour('link');
   }
 
   &:hover {
-    color: govuk-functional-colour("link-hover");
+    color: govuk-functional-colour('link-hover');
   }
 
   &:focus {
-    color: govuk-functional-colour("focus-text");
-    background-color: govuk-functional-colour("focus");
+    color: govuk-functional-colour('focus-text');
+    background-color: govuk-functional-colour('focus');
     box-shadow:
-      0 -2px govuk-functional-colour("focus"),
-      0 4px govuk-functional-colour("focus-text");
+      0 -2px govuk-functional-colour('focus'),
+      0 4px govuk-functional-colour('focus-text');
     text-decoration: none;
     outline: none;
   }
 
-  &[aria-current="page"] {
+  &[aria-current='page'] {
     position: relative;
-    color: govuk-functional-colour("link-active");
+    color: govuk-functional-colour('link-active');
     text-decoration: none;
 
     &::before {
-      content: "";
+      content: '';
       display: block;
       position: absolute;
       bottom: 0;
       left: 0;
       width: 5px;
       height: 100%;
-      background-color: govuk-functional-colour("link");
+      background-color: govuk-functional-colour('link');
 
       @include govuk-media-query($from: tablet) {
         width: 100%;

package/src/nunjucks/context.js

@@ -57,12 +57,11 @@ function createPermissionCheck(request) {
  */
 
 /**
- * @param {{ config: object, buildNavigation: Function, getRequestBasePath: Function, logger: object, readFileSync: Function, moduleId?: string, errorPages?: ErrorPageLinks }} options
+ * @param {{ config: object, getRequestBasePath: Function, logger: object, readFileSync: Function, moduleId?: string, errorPages?: ErrorPageLinks }} options
  * @returns {Function}
  */
 export function createNunjucksContextBuilder({
   config,
-  buildNavigation,
   getRequestBasePath,
   logger,
   readFileSync,
@@ -106,7 +105,8 @@ export function createNunjucksContextBuilder({
       sectionName,
       serviceUrl: '/',
       breadcrumbs: [],
-      navigation: buildNavigation(request),
+      // No primary navigation links for now: only the service name and Sign out.
+      navigation: [],
       isSignedIn: Boolean(request?.auth?.credentials?.user),
       isFrontOffice: requestHubId === 'front-office',
       isBackOffice: requestHubId === 'back-office',

package/src/nunjucks/context.test.js

@@ -23,7 +23,6 @@ test('createNunjucksContextBuilder resolves built asset paths from the Vite mani
   const loggerMessages = []
   const contextBuilder = createNunjucksContextBuilder({
     config: createConfig(),
-    buildNavigation: () => [],
     getRequestBasePath: () => '',
     logger: {
       error(loggedError, message) {
@@ -52,7 +51,6 @@ test('createNunjucksContextBuilder falls back to the source asset path without l
   const loggerMessages = []
   const contextBuilder = createNunjucksContextBuilder({
     config: createConfig(),
-    buildNavigation: () => [],
     getRequestBasePath: () => '',
     logger: {
       error(loggedError, message) {
@@ -77,7 +75,6 @@ test('createNunjucksContextBuilder resolves sectionName from the module registry
   const loggerMessages = []
   const contextBuilder = createNunjucksContextBuilder({
     config: createConfig(),
-    buildNavigation: () => [],
     getRequestBasePath: () => '',
     logger: {
       error(loggedError, message) {
@@ -98,7 +95,6 @@ test('createNunjucksContextBuilder leaves sectionName null when no moduleId is g
   const loggerMessages = []
   const contextBuilder = createNunjucksContextBuilder({
     config: createConfig(),
-    buildNavigation: () => [],
     getRequestBasePath: () => '',
     logger: {
       error(loggedError, message) {
@@ -118,7 +114,6 @@ test('createNunjucksContextBuilder logs once when the Vite manifest is unavailab
   const loggerMessages = []
   const contextBuilder = createNunjucksContextBuilder({
     config: createConfig({ isProduction: true }),
-    buildNavigation: () => [],
     getRequestBasePath: () => '',
     logger: {
       error(loggedError, message) {
@@ -143,7 +138,6 @@ test('createNunjucksContextBuilder always sets serviceUrl to the hub root even w
   const loggerMessages = []
   const contextBuilder = createNunjucksContextBuilder({
     config: createConfig(),
-    buildNavigation: () => [],
     getRequestBasePath: () => '/cattle/register',
     logger: {
       error(loggedError, message) {
@@ -169,7 +163,6 @@ test('createNunjucksContextBuilder always sets serviceUrl to the hub root even w
 function createSignedInContextBuilder() {
   return createNunjucksContextBuilder({
     config: createConfig(),
-    buildNavigation: () => [],
     getRequestBasePath: () => '',
     logger: { error: () => undefined },
     readFileSync: () => '{}'
@@ -213,7 +206,6 @@ describe('createNunjucksContextBuilder() hub flags', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}',
@@ -237,7 +229,6 @@ describe('createNunjucksContextBuilder() hub flags', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}',
@@ -261,7 +252,6 @@ describe('createNunjucksContextBuilder() hub flags', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}',
@@ -281,7 +271,6 @@ describe('createNunjucksContextBuilder() hub flags', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}',
@@ -307,7 +296,6 @@ describe('createNunjucksContextBuilder() errorPages', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -330,7 +318,6 @@ describe('createNunjucksContextBuilder() errorPages', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}',
@@ -357,7 +344,6 @@ describe('createNunjucksContextBuilder() errorPages', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}',
@@ -383,7 +369,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -413,7 +398,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -443,7 +427,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -473,7 +456,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -503,7 +485,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -524,7 +505,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -553,7 +533,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'
@@ -580,7 +559,6 @@ describe('createNunjucksContextBuilder() hasPermission()', () => {
     // Arrange
     const contextBuilder = createNunjucksContextBuilder({
       config: createConfig(),
-      buildNavigation: () => [],
       getRequestBasePath: () => '',
       logger: {},
       readFileSync: () => '{}'

package/src/nunjucks/plugin.js

@@ -5,10 +5,7 @@ import hapiVision from '@hapi/vision'
 import { createRequire } from 'node:module'
 import { fileURLToPath } from 'node:url'
 
-import { getBasePathForModule } from '@defra/lis-hubs-infra-registry'
-
 import { createNunjucksContextBuilder } from './context.js'
-import { buildPrimaryNavigation } from './build-navigation.js'
 import * as filters from './filters.js'
 import * as globals from './globals.js'
 
@@ -168,7 +165,6 @@ export function createNunjucksConfig({
   moduleId,
   errorPages
 }) {
-  const basePath = moduleId ? getBasePathForModule(moduleId) : ''
   const projectRoot = config.get('root')
   const infrastructureRoot = path.resolve(
     path.dirname(fileURLToPath(import.meta.url)),
@@ -185,15 +181,8 @@ export function createNunjucksConfig({
     govukFrontendRoot
   })
 
-  const buildNavigation = (request) =>
-    buildPrimaryNavigation({
-      request,
-      basePath
-    })
-
   const context = createNunjucksContextBuilder({
     config,
-    buildNavigation,
     getRequestBasePath,
     logger,
     readFileSync,

package/src/nunjucks/plugin.test.js

@@ -4,15 +4,12 @@ import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
 import { tmpdir } from 'node:os'
 import path from 'node:path'
 import nunjucks from 'nunjucks'
-import { getBasePathForModule } from '@defra/lis-hubs-infra-registry'
 import { createNunjucksConfig } from './plugin.js'
 
 vi.mock('nunjucks')
-vi.mock('@defra/lis-hubs-infra-registry')
 
 const mocks = {
-  nunjucksConfigure: vi.mocked(nunjucks.configure),
-  getBasePathForModule: vi.mocked(getBasePathForModule)
+  nunjucksConfigure: vi.mocked(nunjucks.configure)
 }
 
 function createProjectRoot() {
@@ -49,25 +46,6 @@ describe('createNunjucksConfig()', () => {
     rmSync(projectRoot, { recursive: true, force: true })
   })
 
-  test('resolves the base path from the module registry when moduleId is given', () => {
-    // Arrange
-    mocks.getBasePathForModule.mockReturnValue('/cattle/register')
-    const config = {
-      get: vi.fn((key) => (key === 'root' ? projectRoot : false))
-    }
-
-    // Act
-    createNunjucksConfig({
-      config,
-      logger: {},
-      getRequestBasePath: vi.fn(),
-      moduleId: 'cattle-register'
-    })
-
-    // Assert
-    expect(mocks.getBasePathForModule).toHaveBeenCalledWith('cattle-register')
-  })
-
   test('defaults to an empty base path when no moduleId is given', () => {
     // Arrange
     const config = {
@@ -82,7 +60,6 @@ describe('createNunjucksConfig()', () => {
     })
 
     // Assert
-    expect(mocks.getBasePathForModule).not.toHaveBeenCalled()
     expect(nunjucksConfig.plugin).toBeDefined()
   })
 

package/src/navigation.js

@@ -1 +0,0 @@
-export { buildPrimaryNavigation } from './nunjucks/build-navigation.js'

package/src/nunjucks/build-navigation.js

@@ -1,61 +0,0 @@
-import { MODULES } from '@defra/lis-hubs-infra-registry'
-import { SUPPORTED_SPECIES, SUPPORTED_TAXONOMIES } from '../index.js'
-
-/** @import { Request } from '@hapi/hapi' */
-
-/**
- * @param {{ request: Request, basePath?: string }} options
- * @returns {object[]}
- */
-export function buildPrimaryNavigation({ request, basePath = '' }) {
-  const currentSpecies = getCurrentSpecies({ request, basePath })
-  const profileItem = {
-    text: 'Profile',
-    href: '/profile',
-    current: request?.path === '/profile' && !currentSpecies?.id
-  }
-  const permittedSpecies = request?.auth?.credentials?.authorizedSpecies
-
-  if (!Array.isArray(permittedSpecies) || permittedSpecies.length === 0) {
-    return []
-  }
-
-  return [
-    ...permittedSpecies.map((species) => ({
-      text: species.label,
-      href: getSpeciesHomePath(species),
-      current: species.id === currentSpecies?.id
-    })),
-    profileItem
-  ]
-}
-
-function getSpeciesHomePath(species) {
-  const homeModule = MODULES.find(
-    (module) => module.id === `${species.id}-home`
-  )
-
-  return homeModule?.path ?? `/${species.id}`
-}
-
-function getCurrentSpecies({ request, basePath }) {
-  for (const path of [request?.path, basePath]) {
-    if (typeof path !== 'string' || path.length === 0) {
-      continue
-    }
-
-    const [speciesSlug, taxonomySlug] = path.split('/').filter(Boolean)
-
-    const matchingTaxonomy = SUPPORTED_TAXONOMIES.find(
-      (taxonomy) => taxonomy.slug === taxonomySlug
-    )
-    const matchingSpecies = SUPPORTED_SPECIES.find(
-      (species) => species.slug === speciesSlug
-    )
-    if (matchingTaxonomy && matchingSpecies) {
-      return matchingSpecies
-    }
-  }
-
-  return null
-}

package/src/nunjucks/build-navigation.test.js

@@ -1,62 +0,0 @@
-import assert from 'node:assert/strict'
-import { test } from 'vitest'
-
-import { buildPrimaryNavigation } from './build-navigation.js'
-
-test('buildPrimaryNavigation renders species already authorized by the host', () => {
-  const navigation = buildPrimaryNavigation({
-    request: {
-      path: '/',
-      auth: {
-        credentials: {
-          authorizedSpecies: [
-            { id: 'cattle', label: 'Cattle' },
-            { id: 'sheep', label: 'Sheep' }
-          ]
-        }
-      }
-    }
-  })
-
-  assert.deepEqual(
-    navigation.map((item) => item.text),
-    ['Cattle', 'Sheep', 'Profile']
-  )
-})
-
-test('buildPrimaryNavigation renders no items when the user has no authorized species', () => {
-  const navigation = buildPrimaryNavigation({
-    request: { path: '/', app: {} }
-  })
-
-  assert.deepEqual(navigation, [])
-})
-
-test('buildPrimaryNavigation marks the profile item as current on the profile route', () => {
-  const navigation = buildPrimaryNavigation({
-    request: {
-      path: '/profile',
-      auth: {
-        credentials: {
-          authorizedSpecies: [{ id: 'cattle', label: 'Cattle' }]
-        }
-      }
-    }
-  })
-
-  assert.equal(navigation.at(-1)?.text, 'Profile')
-  assert.equal(navigation.at(-1)?.current, true)
-})
-
-test('buildPrimaryNavigation ignores the legacy request.app.authorizedSpecies', () => {
-  const navigation = buildPrimaryNavigation({
-    request: {
-      path: '/',
-      app: {
-        authorizedSpecies: [{ id: 'cattle', label: 'Cattle' }]
-      }
-    }
-  })
-
-  assert.deepEqual(navigation, [])
-})