@cccsaurora/howler-ui 2.19.0-cases.863 → 2.19.0-dev.1023

package/components/app/App.js

@@ -26,13 +26,6 @@ import UserSearchProvider from '@cccsaurora/howler-ui/components/routes/admin/us
 import QueryBuilder from '@cccsaurora/howler-ui/components/routes/advanced/QueryBuilder';
 import AnalyticDetails from '@cccsaurora/howler-ui/components/routes/analytics/AnalyticDetails';
 import AnalyticSearch from '@cccsaurora/howler-ui/components/routes/analytics/AnalyticSearch';
-import CaseViewer from '@cccsaurora/howler-ui/components/routes/cases/CaseViewer';
-import Cases from '@cccsaurora/howler-ui/components/routes/cases/Cases';
-import CaseAssets from '@cccsaurora/howler-ui/components/routes/cases/detail/CaseAssets';
-import CaseDashboard from '@cccsaurora/howler-ui/components/routes/cases/detail/CaseDashboard';
-import CaseRules from '@cccsaurora/howler-ui/components/routes/cases/detail/CaseRules';
-import CaseTimeline from '@cccsaurora/howler-ui/components/routes/cases/detail/CaseTimeline';
-import ItemPage from '@cccsaurora/howler-ui/components/routes/cases/detail/ItemPage';
 import DossierEditor from '@cccsaurora/howler-ui/components/routes/dossiers/DossierEditor';
 import Dossiers from '@cccsaurora/howler-ui/components/routes/dossiers/Dossiers';
 import ActionDocumentation from '@cccsaurora/howler-ui/components/routes/help/ActionDocumentation';
@@ -47,7 +40,7 @@ import RetentionDocumentation from '@cccsaurora/howler-ui/components/routes/help
 import SearchDocumentation from '@cccsaurora/howler-ui/components/routes/help/SearchDocumentation';
 import TemplateDocumentation from '@cccsaurora/howler-ui/components/routes/help/TemplateDocumentation';
 import ViewDocumentation from '@cccsaurora/howler-ui/components/routes/help/ViewDocumentation';
-import RecordBrowser from '@cccsaurora/howler-ui/components/routes/hits/search/RecordBrowser';
+import HitBrowser from '@cccsaurora/howler-ui/components/routes/hits/search/HitBrowser';
 import HitViewer from '@cccsaurora/howler-ui/components/routes/hits/view/HitViewer';
 import Home from '@cccsaurora/howler-ui/components/routes/home';
 import OverviewViewer from '@cccsaurora/howler-ui/components/routes/overviews/OverviewViewer';
@@ -58,14 +51,16 @@ import Templates from '@cccsaurora/howler-ui/components/routes/templates/Templat
 import ViewComposer from '@cccsaurora/howler-ui/components/routes/views/ViewComposer';
 import Views from '@cccsaurora/howler-ui/components/routes/views/Views';
 import dayjs from 'dayjs';
+import 'dayjs/locale/fr-ca';
 import duration from 'dayjs/plugin/duration';
 import localizedFormat from 'dayjs/plugin/localizedFormat';
+import minMax from 'dayjs/plugin/minMax';
 import relativeTime from 'dayjs/plugin/relativeTime';
 import utc from 'dayjs/plugin/utc';
 import i18n from '@cccsaurora/howler-ui/i18n';
 import * as monaco from 'monaco-editor';
 import howlerPluginStore from '@cccsaurora/howler-ui/plugins/store';
-import { useContext, useEffect, useMemo } from 'react';
+import { useCallback, useContext, useEffect, useMemo } from 'react';
 import { I18nextProvider } from 'react-i18next';
 import { PluginProvider, usePluginStore } from 'react-pluggable';
 import { createBrowserRouter, Outlet, RouterProvider, useLocation, useNavigate } from 'react-router-dom';
@@ -79,11 +74,11 @@ import AvatarProvider from './providers/AvatarProvider';
 import CustomPluginProvider from './providers/CustomPluginProvider';
 import FavouriteProvider from './providers/FavouritesProvider';
 import FieldProvider from './providers/FieldProvider';
+import HitProvider from './providers/HitProvider';
 import LocalStorageProvider from './providers/LocalStorageProvider';
 import ModalProvider from './providers/ModalProvider';
 import OverviewProvider from './providers/OverviewProvider';
 import ParameterProvider from './providers/ParameterProvider';
-import RecordProvider from './providers/RecordProvider';
 import SocketProvider from './providers/SocketProvider';
 import UserListProvider from './providers/UserListProvider';
 import ViewProvider from './providers/ViewProvider';
@@ -91,6 +86,8 @@ dayjs.extend(utc);
 dayjs.extend(duration);
 dayjs.extend(relativeTime);
 dayjs.extend(localizedFormat);
+dayjs.extend(minMax);
+dayjs.locale(i18n.language === 'en' ? 'en' : 'fr-ca');
 loader.config({ monaco });
 const RoleRoute = ({ roles }) => {
     const appUser = useAppUser();
@@ -112,6 +109,13 @@ const MyApp = () => {
     const { setItems } = useAppSwitcher();
     const { get, set, remove } = useMyLocalStorage();
     const pluginStore = usePluginStore();
+    const onLanguageChange = useCallback((language) => dayjs.locale(language === 'en' ? 'en' : 'fr-ca'), []);
+    useEffect(() => {
+        i18n.on('languageChanged', onLanguageChange);
+        return () => {
+            i18n.off('languageChanged', onLanguageChange);
+        };
+    }, [onLanguageChange]);
     // Simulate app loading time...
     // e.g. fetching initial app data, etc.
     useEffect(() => {
@@ -156,7 +160,7 @@ const MyAppProvider = ({ children }) => {
     const mySitemap = useMySitemap();
     const myUser = useMyUser();
     const mySearch = useMySearch();
-    return (_jsx(ErrorBoundary, { children: _jsx(AppProvider, { preferences: myPreferences, theme: myTheme, sitemap: mySitemap, user: myUser, search: mySearch, children: _jsx(CustomPluginProvider, { children: _jsx(ErrorBoundary, { children: _jsx(ErrorBoundary, { children: _jsx(ViewProvider, { children: _jsx(AvatarProvider, { children: _jsx(ModalProvider, { children: _jsx(FieldProvider, { children: _jsx(LocalStorageProvider, { children: _jsx(SocketProvider, { children: _jsx(RecordProvider, { children: _jsx(OverviewProvider, { children: _jsx(AnalyticProvider, { children: _jsx(FavouriteProvider, { children: _jsx(UserListProvider, { children: children }) }) }) }) }) }) }) }) }) }) }) }) }) }) }) }));
+    return (_jsx(ErrorBoundary, { children: _jsx(AppProvider, { preferences: myPreferences, theme: myTheme, sitemap: mySitemap, user: myUser, search: mySearch, children: _jsx(CustomPluginProvider, { children: _jsx(ErrorBoundary, { children: _jsx(ErrorBoundary, { children: _jsx(ViewProvider, { children: _jsx(AvatarProvider, { children: _jsx(ModalProvider, { children: _jsx(FieldProvider, { children: _jsx(LocalStorageProvider, { children: _jsx(SocketProvider, { children: _jsx(HitProvider, { children: _jsx(OverviewProvider, { children: _jsx(AnalyticProvider, { children: _jsx(FavouriteProvider, { children: _jsx(UserListProvider, { children: children }) }) }) }) }) }) }) }) }) }) }) }) }) }) }) }));
 };
 const AppProviderWrapper = () => {
     return (_jsx(I18nextProvider, { i18n: i18n, defaultNS: "translation", children: _jsx(ApiConfigProvider, { children: _jsx(PluginProvider, { pluginStore: howlerPluginStore.pluginStore, children: _jsx(AppBarProvider, { children: _jsxs(MyAppProvider, { children: [_jsx(MyApp, {}), _jsx(Modal, {})] }) }) }) }) }));
@@ -180,45 +184,19 @@ const createRouter = () => createBrowserRouter([
             },
             {
                 path: 'hits',
-                element: _jsx(RecordBrowser, {})
+                element: _jsx(HitBrowser, {})
             },
             {
                 path: 'search',
-                element: _jsx(RecordBrowser, {})
+                element: _jsx(HitBrowser, {})
             },
             {
                 path: 'hits/:id',
                 element: _jsx(HitViewer, {})
             },
             {
-                path: 'cases',
-                element: _jsx(Cases, {})
-            },
-            {
-                path: 'cases/:id',
-                element: _jsx(ParameterProvider, { children: _jsx(CaseViewer, {}) }),
-                children: [
-                    {
-                        index: true,
-                        element: _jsx(CaseDashboard, {})
-                    },
-                    {
-                        path: 'assets',
-                        element: _jsx(CaseAssets, {})
-                    },
-                    {
-                        path: 'timeline',
-                        element: _jsx(CaseTimeline, {})
-                    },
-                    {
-                        path: 'rules',
-                        element: _jsx(CaseRules, {})
-                    },
-                    {
-                        path: '*',
-                        element: _jsx(ItemPage, {})
-                    }
-                ]
+                path: 'bundles/:id',
+                element: _jsx(HitBrowser, {})
             },
             {
                 path: 'templates',
@@ -258,7 +236,7 @@ const createRouter = () => createBrowserRouter([
             },
             {
                 path: 'views/:id',
-                element: _jsx(RecordBrowser, {})
+                element: _jsx(HitBrowser, {})
             },
             {
                 path: 'views/:id/edit',

package/components/app/hooks/useMatchers.d.ts

@@ -1,6 +1,6 @@
 import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
 import type { WithMetadata } from '@cccsaurora/howler-ui/models/WithMetadata';
-declare const useMatchers: (lazy?: boolean) => {
+declare const useMatchers: () => {
     getMatchingDossiers: (hit: WithMetadata<Hit>) => Promise<import("../../../models/entities/generated/Dossier").Dossier[]>;
     getMatchingOverview: (hit: WithMetadata<Hit>) => Promise<import("../../../models/entities/generated/Overview").Overview>;
     getMatchingTemplate: (hit: WithMetadata<Hit>) => Promise<import("../../../models/entities/generated/Template").Template>;

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 { RecordContext } from '../providers/RecordProvider';
-const useMatchers = (lazy = false) => {
-    const getRecord = useContextSelector(RecordContext, ctx => ctx.getRecord);
+import { HitContext } from '../providers/HitProvider';
+const useMatchers = () => {
+    const getHit = useContextSelector(HitContext, ctx => ctx.getHit);
     const getMatchingTemplate = useCallback(async (hit) => {
         if (!hit) {
             return null;
@@ -12,18 +12,15 @@ const useMatchers = (lazy = false) => {
         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 getRecord(hit.howler.id, true)).__template;
+            return (await getHit(hit.howler.id, true)).__template;
         }
         catch (e) {
             return null;
         }
-    }, [getRecord, lazy]);
+    }, [getHit]);
     const getMatchingOverview = useCallback(async (hit) => {
         if (!hit) {
             return null;
@@ -31,18 +28,15 @@ const useMatchers = (lazy = false) => {
         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 getRecord(hit.howler.id, true)).__overview;
+            return (await getHit(hit.howler.id, true)).__overview;
         }
         catch (e) {
             return null;
         }
-    }, [getRecord, lazy]);
+    }, [getHit]);
     const getMatchingDossiers = useCallback(async (hit) => {
         if (!hit) {
             return null;
@@ -50,18 +44,15 @@ const useMatchers = (lazy = false) => {
         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 getRecord(hit.howler.id, true)).__dossiers ?? [];
+            return (await getHit(hit.howler.id, true)).__dossiers ?? [];
         }
         catch (e) {
             return [];
         }
-    }, [getRecord, lazy]);
+    }, [getHit]);
     const getMatchingAnalytic = useCallback(async (hit) => {
         if (!hit) {
             return null;
@@ -69,17 +60,14 @@ const useMatchers = (lazy = false) => {
         if (has(hit, '__analytic')) {
             return hit.__analytic;
         }
-        if (lazy) {
-            return null;
-        }
         // This is a fallback in case metadata is not included.
         try {
-            return (await getRecord(hit.howler.id, true)).__analytic;
+            return (await getHit(hit.howler.id, true)).__analytic;
         }
         catch (e) {
             return null;
         }
-    }, [getRecord, lazy]);
+    }, [getHit]);
     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 { RecordContext } from '../providers/RecordProvider';
+import { HitContext } from '../providers/HitProvider';
 import useMatchers from './useMatchers';
 // Mock the useContextSelector hook
 vi.mock('use-context-selector', () => ({
@@ -40,14 +40,14 @@ const mockHitWithMetadata = {
     __overview: mockOverview,
     __dossiers: mockDossiers
 };
-const mockGetRecord = vi.fn();
+const mockGetHit = vi.fn();
 describe('useMatchers', () => {
     beforeEach(() => {
         vi.clearAllMocks();
         // Mock useContextSelector to return our mock getHit function
         useContextSelector.mockImplementation((context, selector) => {
-            if (context === RecordContext) {
-                return selector({ getRecord: mockGetRecord });
+            if (context === HitContext) {
+                return selector({ getHit: mockGetHit });
             }
             return null;
         });
@@ -69,25 +69,25 @@ describe('useMatchers', () => {
             const { result } = renderHook(() => useMatchers());
             const template = await result.current.getMatchingTemplate(mockHitWithMetadata);
             expect(template).toBe(mockTemplate);
-            expect(mockGetRecord).not.toHaveBeenCalled();
+            expect(mockGetHit).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 };
-            mockGetRecord.mockResolvedValue(hitWithFetchedMetadata);
+            mockGetHit.mockResolvedValue(hitWithFetchedMetadata);
             const { result } = renderHook(() => useMatchers());
             const template = await result.current.getMatchingTemplate(mockHit);
             expect(template).toBe(mockTemplate);
-            expect(mockGetRecord).toHaveBeenCalledWith('test-hit-id', true);
+            expect(mockGetHit).toHaveBeenCalledWith('test-hit-id', true);
         });
         it('should handle getHit rejection gracefully', async () => {
             const { has } = await import('lodash-es');
             has.mockReturnValue(false);
-            mockGetRecord.mockRejectedValue(new Error('Failed to fetch hit'));
+            mockGetHit.mockRejectedValue(new Error('Failed to fetch hit'));
             const { result } = renderHook(() => useMatchers());
             await expect(result.current.getMatchingTemplate(mockHit)).resolves.toBeNull();
-            expect(mockGetRecord).toHaveBeenCalledWith('test-hit-id', true);
+            expect(mockGetHit).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(mockGetRecord).not.toHaveBeenCalled();
+            expect(mockGetHit).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 };
-            mockGetRecord.mockResolvedValue(hitWithFetchedMetadata);
+            mockGetHit.mockResolvedValue(hitWithFetchedMetadata);
             const { result } = renderHook(() => useMatchers());
             const overview = await result.current.getMatchingOverview(mockHit);
             expect(overview).toBe(mockOverview);
-            expect(mockGetRecord).toHaveBeenCalledWith('test-hit-id', true);
+            expect(mockGetHit).toHaveBeenCalledWith('test-hit-id', true);
         });
         it('should handle getHit rejection gracefully', async () => {
             const { has } = await import('lodash-es');
             has.mockReturnValue(false);
-            mockGetRecord.mockRejectedValue(new Error('Failed to fetch hit'));
+            mockGetHit.mockRejectedValue(new Error('Failed to fetch hit'));
             const { result } = renderHook(() => useMatchers());
             await expect(result.current.getMatchingOverview(mockHit)).resolves.toBeNull();
-            expect(mockGetRecord).toHaveBeenCalledWith('test-hit-id', true);
+            expect(mockGetHit).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(mockGetRecord).not.toHaveBeenCalled();
+            expect(mockGetHit).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 };
-            mockGetRecord.mockResolvedValue(hitWithFetchedMetadata);
+            mockGetHit.mockResolvedValue(hitWithFetchedMetadata);
             const { result } = renderHook(() => useMatchers());
             const dossiers = await result.current.getMatchingDossiers(mockHit);
             expect(dossiers).toBe(mockDossiers);
-            expect(mockGetRecord).toHaveBeenCalledWith('test-hit-id', true);
+            expect(mockGetHit).toHaveBeenCalledWith('test-hit-id', true);
         });
         it('should handle getHit rejection gracefully', async () => {
             const { has } = await import('lodash-es');
             has.mockReturnValue(false);
-            mockGetRecord.mockRejectedValue(new Error('Failed to fetch hit'));
+            mockGetHit.mockRejectedValue(new Error('Failed to fetch hit'));
             const { result } = renderHook(() => useMatchers());
             await expect(result.current.getMatchingDossiers(mockHit)).resolves.toEqual([]);
-            expect(mockGetRecord).toHaveBeenCalledWith('test-hit-id', true);
+            expect(mockGetHit).toHaveBeenCalledWith('test-hit-id', true);
         });
     });
     describe('integration tests', () => {
@@ -177,7 +177,7 @@ describe('useMatchers', () => {
                 ...mockHit,
                 __template: mockTemplate
             };
-            mockGetRecord.mockResolvedValue({
+            mockGetHit.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);
-            mockGetRecord.mockResolvedValue({
+            mockGetHit.mockResolvedValue({
                 ...mockHit,
                 __template: undefined,
                 __overview: null,
@@ -213,7 +213,7 @@ describe('useMatchers', () => {
             expect(template).toBeUndefined();
             expect(overview).toBeNull();
             expect(dossiers).toEqual([]);
-            expect(mockGetRecord).toHaveBeenCalledTimes(3);
+            expect(mockGetHit).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 { RecordContext } from '../providers/RecordProvider';
+import { HitContext } from '../providers/HitProvider';
 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(RecordContext, ctx => ctx.records);
-    const getHit = useContextSelector(RecordContext, ctx => ctx.getRecord);
+    const { getAnalyticFromId } = useContext(AnalyticContext);
+    const hits = useContextSelector(HitContext, ctx => ctx.hits);
+    const getHit = useContextSelector(HitContext, ctx => ctx.getHit);
     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 && getAnalyticFromId) {
+            if (params.id) {
                 const analytic = await getAnalyticFromId(params.id);
                 if (analytic) {
                     setTitle(`${t('route.analytics.view')} - ${analytic.name}`);

package/components/app/providers/FavouritesProvider.js

@@ -26,10 +26,6 @@ const FavouriteProvider = ({ children }) => {
         if (favourites.length < 1) {
             return null;
         }
-        // The favourite list is fully represented, skip
-        if (favourites.length === viewElement?.element?.items?.length) {
-            return viewElement;
-        }
         const savedViews = await fetchViews(favourites);
         const items = sortBy(savedViews, 'title')
             .filter(view => !!view)
@@ -120,11 +116,11 @@ const FavouriteProvider = ({ children }) => {
         (async () => {
             const analyticElement = processAnalyticElement();
             if (analyticElement) {
-                newElements.splice(2, 0, analyticElement);
+                newElements.splice(1, 0, analyticElement);
             }
             const viewElement = await processViewElement();
             if (viewElement) {
-                newElements.splice(2, 0, viewElement);
+                newElements.splice(1, 0, viewElement);
             }
             leftNav.setElements(newElements);
         })();

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

@@ -0,0 +1,22 @@
+import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
+import type { WithMetadata } from '@cccsaurora/howler-ui/models/WithMetadata';
+import type { FC, PropsWithChildren } from 'react';
+export interface HitContextType {
+    hits: {
+        [index: string]: Hit;
+    };
+    selectedHits: Hit[];
+    addHitToSelection: (id: string) => void;
+    removeHitFromSelection: (id: string) => void;
+    clearSelectedHits: (except?: string) => void;
+    loadHits: (hits: Hit[]) => void;
+    updateHit: (newHit: Hit) => void;
+    getHit: (id: string, force?: boolean) => Promise<WithMetadata<Hit>>;
+}
+export declare const HitContext: import("use-context-selector").Context<HitContextType>;
+/**
+ * Central repository for storing individual hit data across the application. Allows efficient retrieval of hits across componenents.
+ */
+declare const HitProvider: FC<PropsWithChildren>;
+export declare const useHitContextSelector: <Selected>(selector: (value: HitContextType) => Selected) => Selected;
+export default HitProvider;

package/components/app/providers/{RecordProvider.js → HitProvider.js}

@@ -5,25 +5,25 @@ import { uniq } from 'lodash-es';
 import { useCallback, useContext, useEffect, useMemo, useRef, useState } from 'react';
 import { createContext, useContextSelector } from 'use-context-selector';
 import { SocketContext } from './SocketProvider';
-export const RecordContext = createContext(null);
+export const HitContext = createContext(null);
 /**
  * Central repository for storing individual hit data across the application. Allows efficient retrieval of hits across componenents.
  */
-const RecordProvider = ({ children }) => {
+const HitProvider = ({ children }) => {
     const { dispatchApi } = useMyApi();
     const { addListener, removeListener } = useContext(SocketContext);
     /**
      * The most immediate of two levels of caching, this ref stores the raw promises for each hit.
      * Rapidly updates, good for uses in-context where parallel updates my be occurring, i.e.
-     * when two cards request the same hit that's missing from the store. Used in getRecord for this reason.
+     * when two cards request the same hit that's missing from the store. Used in getHit for this reason.
      */
-    const recordRequests = useRef({});
+    const hitRequests = useRef({});
     /**
      * The "Authoritative" store of hits. Changes here will trigger rerenders, and essentially
      * caches the result of the above promises. Slower to update, so used outside of the hitcontext
      * where parallel requests aren't an issue.
      */
-    const [records, setRecords] = useState({});
+    const [hits, setHits] = useState({});
     const [selectedHitIds, setSelectedHitIds] = useState([]);
     // The central location where we propagate any changes from hits made via websockets into the repository. We just save every update,
     // instead of caching it across many components inconsistently as before.
@@ -31,8 +31,8 @@ const RecordProvider = ({ children }) => {
         if (data.hit) {
             // eslint-disable-next-line no-console
             console.debug('Received websocket update for hit', data.hit.howler.id);
-            recordRequests.current[data.hit.howler.id] = Promise.resolve(data.hit);
-            setRecords(_hits => ({
+            hitRequests.current[data.hit.howler.id] = Promise.resolve(data.hit);
+            setHits(_hits => ({
                 ..._hits,
                 [data.hit.howler.id]: {
                     ..._hits[data.hit.howler.id],
@@ -46,68 +46,68 @@ const RecordProvider = ({ children }) => {
         return () => removeListener('hits');
     }, [addListener, handler, removeListener]);
     /**
-     * A method to retrieve a record from the context. It first checks the hit state,
+     * A method to retrieve a hit from the context. It first checks the hit state,
      * then checks for ongoing requests, then finally executes a new request if necessary.
      */
-    const getRecord = useCallback(async (id, force = false) => {
-        if (!recordRequests.current[id] || force) {
-            recordRequests.current[id] = dispatchApi(api.hit.get(id, ['template', 'dossiers', 'analytic', 'overview']));
-            const newRecord = await recordRequests.current[id];
-            setRecords(_records => ({ ..._records, [id]: newRecord }));
+    const getHit = useCallback(async (id, force = false) => {
+        if (!hitRequests.current[id] || force) {
+            hitRequests.current[id] = dispatchApi(api.hit.get(id, ['template', 'dossiers', 'analytic', 'overview']));
+            const newHit = await hitRequests.current[id];
+            setHits(_hits => ({ ..._hits, [id]: newHit }));
         }
-        return recordRequests.current[id];
+        return hitRequests.current[id];
     }, [dispatchApi]);
     /**
      * Update a hit in the context locally
      */
-    const updateRecord = useCallback((newHit) => {
-        recordRequests.current[newHit.howler.id] = Promise.resolve(newHit);
-        setRecords(_hits => ({ ..._hits, [newHit.howler.id]: newHit }));
+    const updateHit = useCallback((newHit) => {
+        hitRequests.current[newHit.howler.id] = Promise.resolve(newHit);
+        setHits(_hits => ({ ..._hits, [newHit.howler.id]: newHit }));
     }, []);
     /**
      * Add a large number of hits to the cache. Used for results of searches.
      */
-    const loadRecords = useCallback((newHits) => {
+    const loadHits = useCallback((newHits) => {
         const mappedHits = newHits.map(hit => [hit.howler.id, hit]);
         mappedHits.forEach(([id, hit]) => {
-            recordRequests.current[id] = Promise.resolve(hit);
+            hitRequests.current[id] = Promise.resolve(hit);
         });
-        setRecords(_hits => ({ ..._hits, ...Object.fromEntries(mappedHits) }));
+        setHits(_hits => ({ ..._hits, ...Object.fromEntries(mappedHits) }));
     }, []);
-    const addRecordToSelection = useCallback((id) => {
+    const addHitToSelection = useCallback((id) => {
         setSelectedHitIds(_selected => uniq([..._selected, id]));
     }, []);
-    const removeRecordFromSelection = useCallback((id) => {
+    const removeHitFromSelection = useCallback((id) => {
         setSelectedHitIds(_selected => _selected.filter(_id => _id !== id));
     }, []);
-    const clearSelectedRecords = useCallback((except) => {
+    const clearSelectedHits = useCallback((except) => {
         setSelectedHitIds(!!except ? [except] : []);
     }, []);
-    const selectedRecords = useMemo(() => selectedHitIds.map(id => records[id]).filter(hit => !!hit), [records, selectedHitIds]);
+    const selectedHits = useMemo(() => selectedHitIds.map(id => hits[id]).filter(hit => !!hit), [hits, selectedHitIds]);
     useEffect(() => {
         selectedHitIds.forEach(id => {
-            if (!recordRequests.current[id]) {
-                getRecord(id);
+            if (!hitRequests.current[id]) {
+                getHit(id);
             }
         });
-    }, [getRecord, selectedHitIds]);
+    }, [getHit, selectedHitIds]);
     useEffect(() => {
-        Object.entries(records).forEach(([id, hit]) => {
-            recordRequests.current[id] = Promise.resolve(hit);
+        Object.entries(hits).forEach(([id, hit]) => {
+            hitRequests.current[id] = Promise.resolve(hit);
         });
-    }, [records]);
-    return (_jsx(RecordContext.Provider, { value: {
-            records,
-            getRecord,
-            updateRecord,
-            selectedRecords,
-            addRecordToSelection,
-            removeRecordFromSelection,
-            clearSelectedRecords,
-            loadRecords
+    }, [hits]);
+    return (_jsx(HitContext.Provider, { value: {
+            hits,
+            getHit,
+            updateHit,
+            selectedHits,
+            addHitToSelection,
+            removeHitFromSelection,
+            clearSelectedHits,
+            loadHits
         }, children: children }));
 };
-export const useRecordContextSelector = (selector) => {
-    return useContextSelector(RecordContext, selector);
+export const useHitContextSelector = (selector) => {
+    return useContextSelector(HitContext, selector);
 };
-export default RecordProvider;
+export default HitProvider;

package/components/app/providers/{RecordSearchProvider.d.ts → HitSearchProvider.d.ts}

@@ -1,17 +1,17 @@
 import type { HowlerSearchResponse } from '@cccsaurora/howler-ui/api/search';
 import { useMyLocalStorageItem } from '@cccsaurora/howler-ui/components/hooks/useMyLocalStorage';
 import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
-import type { Observable } from '@cccsaurora/howler-ui/models/entities/generated/Observable';
 import type { WithMetadata } from '@cccsaurora/howler-ui/models/WithMetadata';
 import { type Dispatch, type FC, type PropsWithChildren, type SetStateAction } from 'react';
 export interface QueryEntry {
     [query: string]: string;
 }
-export interface RecordSearchContextType {
+export interface HitSearchContextType {
     displayType: 'list' | 'grid';
     searching: boolean;
     error: string | null;
-    response: HowlerSearchResponse<WithMetadata<Hit | Observable>> | null;
+    response: HowlerSearchResponse<WithMetadata<Hit>> | null;
+    bundleId: string | null;
     fzfSearch: boolean;
     setDisplayType: (type: 'list' | 'grid') => void;
     setFzfSearch: Dispatch<SetStateAction<boolean>>;
@@ -20,6 +20,6 @@ export interface RecordSearchContextType {
     queryHistory: QueryEntry;
     setQueryHistory: ReturnType<typeof useMyLocalStorageItem>[1];
 }
-export declare const RecordSearchContext: import("use-context-selector").Context<RecordSearchContextType>;
-declare const RecordSearchProvider: FC<PropsWithChildren>;
-export default RecordSearchProvider;
+export declare const HitSearchContext: import("use-context-selector").Context<HitSearchContextType>;
+declare const HitSearchProvider: FC<PropsWithChildren>;
+export default HitSearchProvider;