@eeacms/volto-cca-policy 1.0.11 → 1.0.12

package/CHANGELOG.md

@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+### [1.0.12](https://github.com/eea/volto-cca-policy/compare/1.0.11...1.0.12) - 24 August 2026
+
+#### :bug: Bug Fixes
+
+- fix: disable unavailable navigator guide options [kreafox - [`4b114c2`](https://github.com/eea/volto-cca-policy/commit/4b114c2b0ea7a6a6528ae8ae378c2e671b640945)]
+
+#### :nail_care: Enhancements
+
+- change: add custom hook for guide facet options and add tests [kreafox - [`872eb9b`](https://github.com/eea/volto-cca-policy/commit/872eb9b35c41fc2094c605b113411448a8cef9a8)]
+
+#### :hammer_and_wrench: Others
+
+- test: increase utility coverage [kreafox - [`d9c3db8`](https://github.com/eea/volto-cca-policy/commit/d9c3db8cc6fb91ead00f83b822f6fe48c26a70b1)]
 ### [1.0.11](https://github.com/eea/volto-cca-policy/compare/1.0.10...1.0.11) - 21 August 2026
 
 ### [1.0.10](https://github.com/eea/volto-cca-policy/compare/1.0.9...1.0.10) - 19 August 2026
@@ -288,7 +301,9 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 #### :hammer_and_wrench: Others
 
 - test: pin Chromium version 149 to work with Cypress [valentinab25 - [`659ec82`](https://github.com/eea/volto-cca-policy/commit/659ec823dd71fe592a3a7accda22effbe1fb07bc)]
-## [1.0.0](https://github.com/eea/volto-cca-policy/compare/1.0.0-alpha.23...1.0.0) - 12 June 2026
+## [1.0.0](https://github.com/eea/volto-cca-policy/compare/1.0.0-alpha.24...1.0.0) - 12 June 2026
+
+### [1.0.0-alpha.24](https://github.com/eea/volto-cca-policy/compare/1.0.0-alpha.23...1.0.0-alpha.24) - 24 August 2026
 
 ### [1.0.0-alpha.23](https://github.com/eea/volto-cca-policy/compare/1.0.0-alpha.22...1.0.0-alpha.23) - 19 August 2026
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-cca-policy",
-  "version": "1.0.11",
+  "version": "1.0.12",
   "description": "@eeacms/volto-cca-policy: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/components/Search/NavigatorGuide/NavigatorGuideContentView.jsx

@@ -8,6 +8,8 @@ import URLManager from '@elastic/search-ui/lib/cjs/URLManager';
 import { useSearchContext } from '@eeacms/search/lib/hocs';
 import guideSteps from '../../../search/navigator_guide/guideSteps';
 import { navigatorGuideStepAtom } from '../../../state';
+import { mergeGuideOptions } from './utils';
+import useGuideFacetOptions from './useGuideFacetOptions';
 
 const messages = defineMessages({
   noSteps: {
@@ -111,6 +113,7 @@ const NavigatorGuideContentView = ({ appConfig }) => {
     totalResults,
   } = searchContext;
   const steps = guideSteps;
+  const allFacetOptions = useGuideFacetOptions(appConfig, steps);
   const [storedActiveStep, setActiveStep] = useAtom(navigatorGuideStepAtom);
   const activeStep =
     Number.isInteger(storedActiveStep) &&
@@ -122,11 +125,16 @@ const NavigatorGuideContentView = ({ appConfig }) => {
   const selectedValues =
     (filters || []).find((filter) => filter.field === step?.field)?.values ||
     [];
-  const options = getFacetOptions(facets, step?.field);
-  const isLastStep = activeStep === steps.length - 1;
   const hasSelections = steps.some(({ field }) =>
     isStepSelected(filters, field),
   );
+  const options = mergeGuideOptions(
+    allFacetOptions?.[step?.field],
+    getFacetOptions(facets, step?.field),
+    selectedValues,
+    hasSelections,
+  );
+  const isLastStep = activeStep === steps.length - 1;
   const selectedStepLabels = steps
     .filter(({ field }) => isStepSelected(filters, field))
     .map(({ label }) =>
@@ -262,10 +270,12 @@ const NavigatorGuideContentView = ({ appConfig }) => {
                   key={option.value}
                   className={`navigator-guide-option${
                     selectedValues.includes(option.value) ? ' selected' : ''
-                  }`}
+                  }${option.disabled ? ' disabled' : ''}`}
+                  aria-disabled={option.disabled || undefined}
                 >
                   <Checkbox
                     checked={selectedValues.includes(option.value)}
+                    disabled={option.disabled}
                     onChange={() => toggleValue(option.value)}
                   />
                   <span>{option.value}</span>

package/src/components/Search/NavigatorGuide/useGuideFacetOptions.js

@@ -0,0 +1,27 @@
+import React from 'react';
+import { getFacetOptions } from '@eeacms/search/components/SearchApp/useFacetsWithAllOptions';
+
+const useGuideFacetOptions = (appConfig, steps) => {
+  const [allFacetOptions, setAllFacetOptions] = React.useState({});
+
+  React.useEffect(() => {
+    let isCurrent = true;
+    const stepFields = steps.map(({ field }) => field);
+
+    getFacetOptions(appConfig, stepFields)
+      .then((facetOptions) => {
+        if (isCurrent) setAllFacetOptions(facetOptions);
+      })
+      .catch(() => {
+        // Live facet options remain available if the supplementary request fails.
+      });
+
+    return () => {
+      isCurrent = false;
+    };
+  }, [appConfig, steps]);
+
+  return allFacetOptions;
+};
+
+export default useGuideFacetOptions;

package/src/components/Search/NavigatorGuide/useGuideFacetOptions.test.js

@@ -0,0 +1,58 @@
+import { act, renderHook } from '@testing-library/react-hooks';
+import { getFacetOptions } from '@eeacms/search/components/SearchApp/useFacetsWithAllOptions';
+import useGuideFacetOptions from './useGuideFacetOptions';
+
+jest.mock(
+  '@eeacms/search/components/SearchApp/useFacetsWithAllOptions',
+  () => ({ getFacetOptions: jest.fn() }),
+);
+
+const flushPromises = () => act(() => Promise.resolve());
+
+describe('useGuideFacetOptions', () => {
+  const appConfig = { facets: [] };
+  const steps = [{ field: 'sector' }, { field: 'stage' }];
+
+  beforeEach(() => {
+    getFacetOptions.mockReset();
+  });
+
+  it('loads the complete option list for every guide field', async () => {
+    const facetOptions = { sector: ['Energy'], stage: ['Step 1'] };
+    getFacetOptions.mockResolvedValue(facetOptions);
+
+    const { result } = renderHook(() => useGuideFacetOptions(appConfig, steps));
+    await flushPromises();
+
+    expect(getFacetOptions).toHaveBeenCalledWith(appConfig, [
+      'sector',
+      'stage',
+    ]);
+    expect(result.current).toEqual(facetOptions);
+  });
+
+  it('keeps the fallback state when loading fails', async () => {
+    getFacetOptions.mockRejectedValue(new Error('Search unavailable'));
+
+    const { result } = renderHook(() => useGuideFacetOptions(appConfig, steps));
+    await flushPromises();
+
+    expect(result.current).toEqual({});
+  });
+
+  it('does not update state after unmounting', async () => {
+    let resolveRequest;
+    getFacetOptions.mockReturnValue(
+      new Promise((resolve) => {
+        resolveRequest = resolve;
+      }),
+    );
+
+    const { unmount } = renderHook(() =>
+      useGuideFacetOptions(appConfig, steps),
+    );
+    unmount();
+    resolveRequest({ sector: ['Energy'] });
+    await flushPromises();
+  });
+});

package/src/components/Search/NavigatorGuide/utils.js

@@ -0,0 +1,30 @@
+export const mergeGuideOptions = (
+  availableValues = [],
+  facetOptions = [],
+  selectedValues = [],
+  hasGuideSelections = false,
+) => {
+  const optionsByValue = new Map(
+    facetOptions.map(({ value, count }) => [value, { value, count }]),
+  );
+
+  availableValues.forEach((value) => {
+    if (!optionsByValue.has(value)) {
+      optionsByValue.set(value, { value, count: 0 });
+    }
+  });
+
+  selectedValues.forEach((value) => {
+    if (!optionsByValue.has(value)) {
+      optionsByValue.set(value, { value, count: 0 });
+    }
+  });
+
+  return Array.from(optionsByValue.values()).map((option) => ({
+    ...option,
+    disabled:
+      hasGuideSelections &&
+      option.count === 0 &&
+      !selectedValues.includes(option.value),
+  }));
+};

package/src/components/Search/NavigatorGuide/utils.test.js

@@ -0,0 +1,40 @@
+import { mergeGuideOptions } from './utils';
+
+describe('Navigator Guide utilities', () => {
+  it('keeps unavailable values and marks them as disabled', () => {
+    expect(
+      mergeGuideOptions(
+        ['Step 1', 'Step 2', 'Step 6'],
+        [
+          { value: 'Step 1', count: 4 },
+          { value: 'Step 2', count: 2 },
+        ],
+        [],
+        true,
+      ),
+    ).toEqual([
+      { value: 'Step 1', count: 4, disabled: false },
+      { value: 'Step 2', count: 2, disabled: false },
+      { value: 'Step 6', count: 0, disabled: true },
+    ]);
+  });
+
+  it('keeps a selected zero-count value enabled so it can be removed', () => {
+    expect(mergeGuideOptions([], [], ['Step 6'], true)).toEqual([
+      { value: 'Step 6', count: 0, disabled: false },
+    ]);
+  });
+
+  it('keeps every value enabled before the guide has been refined', () => {
+    expect(mergeGuideOptions(['Step 1', 'Step 6'], [], [])).toEqual([
+      { value: 'Step 1', count: 0, disabled: false },
+      { value: 'Step 6', count: 0, disabled: false },
+    ]);
+  });
+
+  it('falls back to live facet options while the full list is loading', () => {
+    expect(mergeGuideOptions([], [{ value: 'Energy', count: 3 }], [])).toEqual([
+      { value: 'Energy', count: 3, disabled: false },
+    ]);
+  });
+});

package/src/utils.test.js

@@ -0,0 +1,127 @@
+import { flattenToAppURL } from '@plone/volto/helpers/Url/Url';
+import {
+  blockAvailableInMission,
+  extractPlanNameAndURL,
+  filterBlocks,
+  formatTextToHTML,
+  getBaseUrl,
+  getFilteredBlocks,
+  hasTypeOfBlock,
+  isEmpty,
+  normalizeImageFileName,
+} from './utils';
+
+jest.mock('@plone/volto/helpers/Url/Url', () => ({
+  flattenToAppURL: jest.fn((url) => url.replace('https://example.com', '')),
+}));
+
+describe('general utilities', () => {
+  it('checks whether blocks are available inside and outside Mission', () => {
+    expect(blockAvailableInMission({}, { id: 'text' })).toBe(false);
+    expect(
+      blockAvailableInMission(
+        { '@id': 'https://example.com/en/mission/page' },
+        { id: 'mkh_map' },
+      ),
+    ).toBe(false);
+    expect(
+      blockAvailableInMission(
+        { '@id': 'https://example.com/en/mission/page' },
+        { id: 'text' },
+      ),
+    ).toBe(true);
+    expect(
+      blockAvailableInMission(
+        { '@id': 'https://example.com/en/page' },
+        { id: 'rastBlock' },
+      ),
+    ).toBe(true);
+  });
+
+  it('resolves a block base URL from the supported properties', () => {
+    expect(
+      getBaseUrl({ data: { href: [{ '@id': 'https://example.com/page' }] } }),
+    ).toBe('/page');
+    expect(getBaseUrl({ path: '/from-path' })).toBe('/from-path');
+    expect(getBaseUrl({ location: { pathname: '/from-location' } })).toBe(
+      '/from-location',
+    );
+    expect(getBaseUrl({})).toBe('');
+    expect(flattenToAppURL).toHaveBeenCalledTimes(3);
+  });
+
+  it('finds nested block types and removes selected block types', () => {
+    expect(
+      hasTypeOfBlock({ blocks: { child: { '@type': 'listing' } } }, 'listing'),
+    ).toBe(true);
+    expect(hasTypeOfBlock({ child: null }, 'listing')).toBe(false);
+
+    expect(
+      filterBlocks(
+        {
+          blocks: {
+            one: { '@type': 'text' },
+            two: { '@type': 'listing' },
+          },
+          blocks_layout: { items: ['one', 'two'] },
+        },
+        ['listing'],
+      ),
+    ).toEqual({
+      blocks: { one: { '@type': 'text' } },
+      blocks_layout: { items: ['one'] },
+      hasBlockTypes: true,
+    });
+  });
+
+  it('formats escaped text, paragraphs, bullets, and links as HTML', () => {
+    expect(formatTextToHTML()).toBe('');
+    expect(formatTextToHTML('Simple text')).toBe('<p>Simple text</p>');
+    expect(formatTextToHTML('First\\n\\nSecond')).toBe('First</p><p>Second');
+    expect(formatTextToHTML('Item\\no next')).toBe('<p>Item<br />• next</p>');
+    expect(formatTextToHTML('See https://example.com')).toContain(
+      '<a href="https://example.com"',
+    );
+  });
+
+  it('keeps only parent blocks without the excluded nested type', () => {
+    const result = getFilteredBlocks(
+      {
+        blocks: {
+          keep: { '@type': 'group', blocks: { child: { '@type': 'text' } } },
+          exclude: {
+            '@type': 'group',
+            data: { blocks: { child: { '@type': 'map' } } },
+          },
+          other: { '@type': 'text' },
+        },
+        blocks_layout: { items: ['keep', 'exclude', 'other'] },
+      },
+      'group',
+      'map',
+    );
+
+    expect(result.keptKeys).toEqual(['keep']);
+    expect(result.blocks_layout.items).toEqual(['keep']);
+    expect(result.hasMatches).toBe(true);
+  });
+
+  it('extracts plan links and normalizes common values', () => {
+    expect(extractPlanNameAndURL()).toEqual({ name: '', url: '' });
+    expect(
+      extractPlanNameAndURL('Adaptation plan (https://example.com/plan)'),
+    ).toEqual({ name: 'Adaptation plan', url: 'https://example.com/plan' });
+    expect(
+      extractPlanNameAndURL(
+        'Plan https://example.com/source https://example.com/document',
+      ),
+    ).toEqual({ name: 'Plan', url: 'https://example.com/document' });
+
+    expect(isEmpty()).toBe(true);
+    expect(isEmpty([])).toBe(true);
+    expect(isEmpty(['value'])).toBe(false);
+    expect(normalizeImageFileName()).toBe('');
+    expect(normalizeImageFileName('map(final).png')).toBe('map-final.png');
+    expect(normalizeImageFileName('map(final)')).toBe('map-final-');
+  });
+});

package/theme/globals/navigator.less

@@ -1004,6 +1004,12 @@ body.searchlib-page .searchapp-navigatorCatalogueSearch {
       background: fade(@primaryColor, 5%);
     }
 
+    &.disabled {
+      background: #f5f5f5;
+      color: @navigatorInactiveColor;
+      opacity: 0.65;
+    }
+
     > span {
       flex: 1;
     }