@cccsaurora/howler-ui 2.19.0-dev.1151 → 2.19.0-dev.1260

package/components/app/hooks/useMatchers.js

@@ -2,9 +2,9 @@
 import { has } from 'lodash-es';
 import { useCallback } from 'react';
 import { useContextSelector } from 'use-context-selector';
-import { HitContext } from '../providers/HitProvider';
-const useMatchers = () => {
-    const getHit = useContextSelector(HitContext, ctx => ctx.getHit);
+import { RecordContext } from '../providers/RecordProvider';
+const useMatchers = (lazy = false) => {
+    const getRecord = useContextSelector(RecordContext, ctx => ctx.getRecord);
     const getMatchingTemplate = useCallback(async (hit) => {
         if (!hit) {
             return null;
@@ -12,15 +12,18 @@ const useMatchers = () => {
         if (has(hit, '__template')) {
             return hit.__template;
         }
+        if (lazy) {
+            return null;
+        }
         // This is a fallback in case metadata is not included. In most cases templates are shown, the template metadata
         // should also exist
         try {
-            return (await getHit(hit.howler.id, true)).__template;
+            return (await getRecord(hit.howler.id, true)).__template;
         }
         catch (e) {
             return null;
         }
-    }, [getHit]);
+    }, [getRecord, lazy]);
     const getMatchingOverview = useCallback(async (hit) => {
         if (!hit) {
             return null;
@@ -28,15 +31,18 @@ const useMatchers = () => {
         if (has(hit, '__overview')) {
             return hit.__overview;
         }
+        if (lazy) {
+            return null;
+        }
         // This is a fallback in case metadata is not included. In most cases templates are shown, the template metadata
         // should also exist
         try {
-            return (await getHit(hit.howler.id, true)).__overview;
+            return (await getRecord(hit.howler.id, true)).__overview;
         }
         catch (e) {
             return null;
         }
-    }, [getHit]);
+    }, [getRecord, lazy]);
     const getMatchingDossiers = useCallback(async (hit) => {
         if (!hit) {
             return null;
@@ -44,15 +50,18 @@ const useMatchers = () => {
         if (has(hit, '__dossiers')) {
             return hit.__dossiers;
         }
+        if (lazy) {
+            return null;
+        }
         // This is a fallback in case metadata is not included. In most cases templates are shown, the template metadata
         // should also exist
         try {
-            return (await getHit(hit.howler.id, true)).__dossiers ?? [];
+            return (await getRecord(hit.howler.id, true)).__dossiers ?? [];
         }
         catch (e) {
             return [];
         }
-    }, [getHit]);
+    }, [getRecord, lazy]);
     const getMatchingAnalytic = useCallback(async (hit) => {
         if (!hit) {
             return null;
@@ -60,14 +69,17 @@ const useMatchers = () => {
         if (has(hit, '__analytic')) {
             return hit.__analytic;
         }
+        if (lazy) {
+            return null;
+        }
         // This is a fallback in case metadata is not included.
         try {
-            return (await getHit(hit.howler.id, true)).__analytic;
+            return (await getRecord(hit.howler.id, true)).__analytic;
         }
         catch (e) {
             return null;
         }
-    }, [getHit]);
+    }, [getRecord, lazy]);
     return {
         getMatchingDossiers,
         getMatchingOverview,

package/components/app/hooks/useMatchers.test.js

@@ -1,7 +1,7 @@
 import { renderHook } from '@testing-library/react';
 import { useContextSelector } from 'use-context-selector';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
-import { HitContext } from '../providers/HitProvider';
+import { RecordContext } from '../providers/RecordProvider';
 import useMatchers from './useMatchers';
 // Mock the useContextSelector hook
 vi.mock('use-context-selector', () => ({
@@ -40,14 +40,14 @@ const mockHitWithMetadata = {
     __overview: mockOverview,
     __dossiers: mockDossiers
 };
-const mockGetHit = vi.fn();
+const mockGetRecord = vi.fn();
 describe('useMatchers', () => {
     beforeEach(() => {
         vi.clearAllMocks();
         // Mock useContextSelector to return our mock getHit function
         useContextSelector.mockImplementation((context, selector) => {
-            if (context === HitContext) {
-                return selector({ getHit: mockGetHit });
+            if (context === RecordContext) {
+                return selector({ getRecord: mockGetRecord });
             }
             return null;
         });
@@ -69,25 +69,25 @@ describe('useMatchers', () => {
             const { result } = renderHook(() => useMatchers());
             const template = await result.current.getMatchingTemplate(mockHitWithMetadata);
             expect(template).toBe(mockTemplate);
-            expect(mockGetHit).not.toHaveBeenCalled();
+            expect(mockGetRecord).not.toHaveBeenCalled();
         });
         it('should fetch hit with metadata when template is not present', async () => {
             const { has } = await import('lodash-es');
             has.mockReturnValue(false);
             const hitWithFetchedMetadata = { ...mockHit, __template: mockTemplate };
-            mockGetHit.mockResolvedValue(hitWithFetchedMetadata);
+            mockGetRecord.mockResolvedValue(hitWithFetchedMetadata);
             const { result } = renderHook(() => useMatchers());
             const template = await result.current.getMatchingTemplate(mockHit);
             expect(template).toBe(mockTemplate);
-            expect(mockGetHit).toHaveBeenCalledWith('test-hit-id', true);
+            expect(mockGetRecord).toHaveBeenCalledWith('test-hit-id', true);
         });
         it('should handle getHit rejection gracefully', async () => {
             const { has } = await import('lodash-es');
             has.mockReturnValue(false);
-            mockGetHit.mockRejectedValue(new Error('Failed to fetch hit'));
+            mockGetRecord.mockRejectedValue(new Error('Failed to fetch hit'));
             const { result } = renderHook(() => useMatchers());
             await expect(result.current.getMatchingTemplate(mockHit)).resolves.toBeNull();
-            expect(mockGetHit).toHaveBeenCalledWith('test-hit-id', true);
+            expect(mockGetRecord).toHaveBeenCalledWith('test-hit-id', true);
         });
     });
     describe('getMatchingOverview', () => {
@@ -107,25 +107,25 @@ describe('useMatchers', () => {
             const { result } = renderHook(() => useMatchers());
             const overview = await result.current.getMatchingOverview(mockHitWithMetadata);
             expect(overview).toBe(mockOverview);
-            expect(mockGetHit).not.toHaveBeenCalled();
+            expect(mockGetRecord).not.toHaveBeenCalled();
         });
         it('should fetch hit with metadata when overview is not present', async () => {
             const { has } = await import('lodash-es');
             has.mockReturnValue(false);
             const hitWithFetchedMetadata = { ...mockHit, __overview: mockOverview };
-            mockGetHit.mockResolvedValue(hitWithFetchedMetadata);
+            mockGetRecord.mockResolvedValue(hitWithFetchedMetadata);
             const { result } = renderHook(() => useMatchers());
             const overview = await result.current.getMatchingOverview(mockHit);
             expect(overview).toBe(mockOverview);
-            expect(mockGetHit).toHaveBeenCalledWith('test-hit-id', true);
+            expect(mockGetRecord).toHaveBeenCalledWith('test-hit-id', true);
         });
         it('should handle getHit rejection gracefully', async () => {
             const { has } = await import('lodash-es');
             has.mockReturnValue(false);
-            mockGetHit.mockRejectedValue(new Error('Failed to fetch hit'));
+            mockGetRecord.mockRejectedValue(new Error('Failed to fetch hit'));
             const { result } = renderHook(() => useMatchers());
             await expect(result.current.getMatchingOverview(mockHit)).resolves.toBeNull();
-            expect(mockGetHit).toHaveBeenCalledWith('test-hit-id', true);
+            expect(mockGetRecord).toHaveBeenCalledWith('test-hit-id', true);
         });
     });
     describe('getMatchingDossiers', () => {
@@ -145,25 +145,25 @@ describe('useMatchers', () => {
             const { result } = renderHook(() => useMatchers());
             const dossiers = await result.current.getMatchingDossiers(mockHitWithMetadata);
             expect(dossiers).toBe(mockDossiers);
-            expect(mockGetHit).not.toHaveBeenCalled();
+            expect(mockGetRecord).not.toHaveBeenCalled();
         });
         it('should fetch hit with metadata when dossiers are not present', async () => {
             const { has } = await import('lodash-es');
             has.mockReturnValue(false);
             const hitWithFetchedMetadata = { ...mockHit, __dossiers: mockDossiers };
-            mockGetHit.mockResolvedValue(hitWithFetchedMetadata);
+            mockGetRecord.mockResolvedValue(hitWithFetchedMetadata);
             const { result } = renderHook(() => useMatchers());
             const dossiers = await result.current.getMatchingDossiers(mockHit);
             expect(dossiers).toBe(mockDossiers);
-            expect(mockGetHit).toHaveBeenCalledWith('test-hit-id', true);
+            expect(mockGetRecord).toHaveBeenCalledWith('test-hit-id', true);
         });
         it('should handle getHit rejection gracefully', async () => {
             const { has } = await import('lodash-es');
             has.mockReturnValue(false);
-            mockGetHit.mockRejectedValue(new Error('Failed to fetch hit'));
+            mockGetRecord.mockRejectedValue(new Error('Failed to fetch hit'));
             const { result } = renderHook(() => useMatchers());
             await expect(result.current.getMatchingDossiers(mockHit)).resolves.toEqual([]);
-            expect(mockGetHit).toHaveBeenCalledWith('test-hit-id', true);
+            expect(mockGetRecord).toHaveBeenCalledWith('test-hit-id', true);
         });
     });
     describe('integration tests', () => {
@@ -177,7 +177,7 @@ describe('useMatchers', () => {
                 ...mockHit,
                 __template: mockTemplate
             };
-            mockGetHit.mockResolvedValue({
+            mockGetRecord.mockResolvedValue({
                 ...mockHit,
                 __overview: mockOverview,
                 __dossiers: mockDossiers
@@ -200,7 +200,7 @@ describe('useMatchers', () => {
         it('should handle empty or undefined metadata gracefully', async () => {
             const { has } = await import('lodash-es');
             has.mockReturnValue(false);
-            mockGetHit.mockResolvedValue({
+            mockGetRecord.mockResolvedValue({
                 ...mockHit,
                 __template: undefined,
                 __overview: null,
@@ -213,7 +213,7 @@ describe('useMatchers', () => {
             expect(template).toBeUndefined();
             expect(overview).toBeNull();
             expect(dossiers).toEqual([]);
-            expect(mockGetHit).toHaveBeenCalledTimes(3);
+            expect(mockGetRecord).toHaveBeenCalledTimes(3);
         });
         it('should maintain referential equality of returned functions', () => {
             const { result, rerender } = renderHook(() => useMatchers());

package/components/app/hooks/useTitle.js

@@ -5,23 +5,23 @@ import { useTranslation } from 'react-i18next';
 import { useLocation, useParams, useSearchParams } from 'react-router-dom';
 import { useContextSelector } from 'use-context-selector';
 import { AnalyticContext } from '../providers/AnalyticProvider';
-import { HitContext } from '../providers/HitProvider';
+import { RecordContext } from '../providers/RecordProvider';
 const useTitle = () => {
     const { t } = useTranslation();
     const location = useLocation();
     const params = useParams();
     const searchParams = useSearchParams()[0];
     const sitemap = useMySitemap();
-    const { getAnalyticFromId } = useContext(AnalyticContext);
-    const hits = useContextSelector(HitContext, ctx => ctx.hits);
-    const getHit = useContextSelector(HitContext, ctx => ctx.getHit);
+    const { getAnalyticFromId } = useContext(AnalyticContext) ?? {};
+    const hits = useContextSelector(RecordContext, ctx => ctx.records);
+    const getHit = useContextSelector(RecordContext, ctx => ctx.getRecord);
     const setTitle = useCallback((title) => {
         document.querySelector('title').innerHTML = title;
     }, []);
     const runChecks = useCallback(async () => {
         const searchType = location.pathname.replace(/^\/(\w+)(\/.+)?$/, '$1').replace(/s$/, '');
         if (searchType === 'analytic') {
-            if (params.id) {
+            if (params.id && getAnalyticFromId) {
                 const analytic = await getAnalyticFromId(params.id);
                 if (analytic) {
                     setTitle(`${t('route.analytics.view')} - ${analytic.name}`);

package/components/app/providers/FavouritesProvider.js

@@ -116,11 +116,11 @@ const FavouriteProvider = ({ children }) => {
         (async () => {
             const analyticElement = processAnalyticElement();
             if (analyticElement) {
-                newElements.splice(1, 0, analyticElement);
+                newElements.splice(2, 0, analyticElement);
             }
             const viewElement = await processViewElement();
             if (viewElement) {
-                newElements.splice(1, 0, viewElement);
+                newElements.splice(2, 0, viewElement);
             }
             leftNav.setElements(newElements);
         })();

package/components/app/providers/GridColumnsProvider.js

@@ -5,8 +5,8 @@ import { useParams } from 'react-router-dom';
 import { useContextSelector } from 'use-context-selector';
 import { StorageKey } from '@cccsaurora/howler-ui/utils/constants';
 import { parsePixelSizeStringToInt } from '@cccsaurora/howler-ui/utils/stringUtils';
-import { HitSearchContext } from './HitSearchProvider';
 import { ParameterContext } from './ParameterProvider';
+import { RecordSearchContext } from './RecordSearchProvider';
 import { ViewContext } from './ViewProvider';
 export const GridColumnsContext = createContext(null);
 /**
@@ -30,7 +30,7 @@ const GridColumnsProvider = ({ children, viewSource = 'params' }) => {
     const pathViewIds = useMemo(() => (routeParams.id ? [routeParams.id] : []), [routeParams.id]);
     const viewIds = viewSource === 'params' ? parameterViewIds : pathViewIds;
     const getCurrentViews = useContextSelector(ViewContext, ctx => ctx.getCurrentViews);
-    const setDisplayType = useContextSelector(HitSearchContext, ctx => ctx.setDisplayType);
+    const setDisplayType = useContextSelector(RecordSearchContext, ctx => ctx.setDisplayType);
     // --- Local storage state (user's personal preferences) ---
     const [localStorageColumns, setLocalStorageColumns] = useMyLocalStorageItem(StorageKey.GRID_COLUMNS, [
         'howler.outline.threat',

package/components/app/providers/GridColumnsProvider.test.js

@@ -4,8 +4,8 @@ import { useContext } from 'react';
 import { setupContextSelectorMock, setupLocalStorageMock, setupReactRouterMock } from '@cccsaurora/howler-ui/tests/mocks';
 import { StorageKey } from '@cccsaurora/howler-ui/utils/constants';
 import GridColumnsProvider, { GridColumnsContext } from './GridColumnsProvider';
-import { HitSearchContext } from './HitSearchProvider';
 import { ParameterContext } from './ParameterProvider';
+import { RecordSearchContext } from './RecordSearchProvider';
 import { ViewContext } from './ViewProvider';
 setupContextSelectorMock();
 setupReactRouterMock();
@@ -17,7 +17,7 @@ const mockSetDisplayType = vi.fn();
 const mockViewsContext = {
     getCurrentViews: mockGetCurrentViews
 };
-const mockHitSearchContext = {
+const mockRecordSearchContext = {
     setDisplayType: mockSetDisplayType
 };
 const makeWrapper = (parameterViewIds = [], routeId) => {
@@ -25,7 +25,7 @@ const makeWrapper = (parameterViewIds = [], routeId) => {
     const parameterContextValue = {
         views: parameterViewIds
     };
-    const Wrapper = ({ children }) => (_jsx(ParameterContext.Provider, { value: parameterContextValue, children: _jsx(ViewContext.Provider, { value: mockViewsContext, children: _jsx(HitSearchContext.Provider, { value: mockHitSearchContext, children: _jsx(GridColumnsProvider, { viewSource: routeId ? 'path' : 'params', children: children }) }) }) }));
+    const Wrapper = ({ children }) => (_jsx(ParameterContext.Provider, { value: parameterContextValue, children: _jsx(ViewContext.Provider, { value: mockViewsContext, children: _jsx(RecordSearchContext.Provider, { value: mockRecordSearchContext, children: _jsx(GridColumnsProvider, { viewSource: routeId ? 'path' : 'params', children: children }) }) }) }));
     return Wrapper;
 };
 const _prefixStorageKey = (key) => `howler.ui.${key}`;

package/components/app/providers/ModalProvider.d.ts

@@ -1,6 +1,7 @@
 import type { FC, PropsWithChildren, ReactNode } from 'react';
 export interface ModalOptions {
     disableClose?: boolean;
+    height?: number | string | null;
     maxWidth?: string;
     maxHeight?: string;
 }

package/components/app/providers/ParameterProvider.d.ts

@@ -1,3 +1,4 @@
+import type { SearchIndex } from '@cccsaurora/howler-ui/api/v2/search';
 import type { FC, PropsWithChildren } from 'react';
 export interface ParameterContextType {
     selected?: string;
@@ -6,6 +7,7 @@ export interface ParameterContextType {
     trackTotalHits: boolean;
     sort?: string;
     span?: string;
+    indexes?: SearchIndex[];
     filters?: string[];
     startDate?: string;
     endDate?: string;
@@ -19,16 +21,36 @@ export interface ParameterContextType {
     addFilter: (filter: string) => void;
     removeFilter: (filter: string) => void;
     setFilter: (index: number, filter: string) => void;
-    clearFilters: () => void;
+    resetFilters: () => void;
+    addIndex: (index: SearchIndex) => void;
+    removeIndex: (index: SearchIndex) => void;
+    setIndex: (position: number, index: SearchIndex) => void;
+    setIndexes: (indexes: SearchIndex[]) => void;
+    resetIndexes: () => void;
     addView: (view: string) => void;
     removeView: (view: string) => void;
     setView: (index: number, view: string) => void;
-    clearViews: () => void;
+    resetViews: () => void;
+}
+interface SearchValues {
+    selected: string;
+    query: string;
+    sort: string;
+    span: string;
+    indexes: SearchIndex[];
+    filters: string[];
+    views: string[];
+    startDate: string;
+    endDate: string;
+    offset: number;
+    trackTotalHits: boolean;
 }
 export declare const ParameterContext: import("use-context-selector").Context<ParameterContextType>;
 /**
  * Context responsible for tracking updates to query operations in hit and view search.
  */
-declare const ParameterProvider: FC<PropsWithChildren>;
+declare const ParameterProvider: FC<PropsWithChildren<{
+    defaults?: Partial<SearchValues>;
+}>>;
 export declare const useParameterContextSelector: <Selected>(selector: (value: ParameterContextType) => Selected) => Selected;
 export default ParameterProvider;