@cccsaurora/howler-ui 3.1.0-dev.1466 → 3.1.0-dev.1602

package/rest/FetchClient.test.js

@@ -38,6 +38,9 @@ describe('FetchClient', () => {
         const payload = { api_response: { items: [] } };
         mockFetch(200, payload);
         const result = await client.fetch('/api/v1/hit');
+        if (!result) {
+            throw new Error('Expected a response body.');
+        }
         expect(result[0]).toEqual(payload);
         expect(result[1]).toBe(200);
     });
@@ -47,11 +50,11 @@ describe('FetchClient', () => {
         const callArgs = spy.mock.calls[0][1];
         expect(callArgs.body).toBe(JSON.stringify({ key: 'val' }));
     });
-    it('sends null body when no body is provided', async () => {
+    it('omits the body when no body is provided', async () => {
         const spy = mockFetch(200, {});
         await client.fetch('/api/v1/hit', 'get');
         const callArgs = spy.mock.calls[0][1];
-        expect(callArgs.body).toBeNull();
+        expect(callArgs.body).toBeUndefined();
     });
     it('forwards custom headers to fetch', async () => {
         const spy = mockFetch(200, {});
@@ -59,10 +62,10 @@ describe('FetchClient', () => {
         const callArgs = spy.mock.calls[0][1];
         expect(callArgs.headers.Authorization).toBe('******');
     });
-    it('returns null for a 204 No Content response', async () => {
+    it('returns undefined for a 204 No Content response', async () => {
         mockFetch(204, null);
         const result = await client.fetch('/api/v1/hit', 'delete');
-        expect(result).toBeNull();
+        expect(result).toBeUndefined();
     });
     it('works with a PUT method', async () => {
         const spy = mockFetch(200, {});

package/rest/index.d.ts

@@ -1,6 +1,7 @@
 import type { HowlerResponse } from '@cccsaurora/howler-ui/api';
+export type RestResponse<R> = [HowlerResponse<R>, number, {
+    [index: string]: any;
+}];
 export default interface RestClient {
-    fetch<R>(url: string, method: 'get' | 'post' | 'put' | 'delete', body?: any, params?: URLSearchParams, headers?: HeadersInit): Promise<[HowlerResponse<R>, number, {
-        [index: string]: any;
-    }]>;
+    fetch<R>(url: string, method: 'get' | 'post' | 'put' | 'delete', body?: any, params?: URLSearchParams, headers?: HeadersInit): Promise<RestResponse<R> | undefined>;
 }

package/setupTests.d.ts

@@ -1 +1,4 @@
 import '@testing-library/jest-dom/vitest';
+declare global {
+    var IS_REACT_ACT_ENVIRONMENT: boolean;
+}

package/tests/MockLocalStorage.js

@@ -1,8 +1,9 @@
+// @ts-nocheck
 export default class MockLocalStorage {
     constructor() {
         Object.defineProperty(this, 'getItem', {
             enumerable: false,
-            value: vi.fn(key => (this[key] !== undefined ? this[key] : null))
+            value: vi.fn(key => (this[key] !== undefined && this[key] !== null ? this[key] : null))
         });
         Object.defineProperty(this, 'setItem', {
             enumerable: false,

package/tests/mocks.d.ts

@@ -4,7 +4,7 @@
  */
 export declare const setupContextSelectorMock: () => void;
 /**
- * Sets up a mock for react-router-dom with common defaults
+ * Sets up a mock for react-router with common defaults
  * @param options - Override specific router behavior
  */
 export declare const setupReactRouterMock: () => {
@@ -15,7 +15,7 @@ export declare const setupReactRouterMock: () => {
         search: string;
     };
     mockParams: {
-        id: any;
+        id: undefined;
     };
 };
 /**

package/tests/mocks.js

@@ -22,7 +22,7 @@ export const setupContextSelectorMock = () => {
     afterAll(() => vi.resetModules());
 };
 /**
- * Sets up a mock for react-router-dom with common defaults
+ * Sets up a mock for react-router with common defaults
  * @param options - Override specific router behavior
  */
 export const setupReactRouterMock = () => {
@@ -31,8 +31,8 @@ export const setupReactRouterMock = () => {
     const mockSearchParams = vi.hoisted(() => new URLSearchParams());
     const mockSetParams = vi.hoisted(() => vi.fn());
     beforeAll(() => {
-        vi.mock('react-router-dom', async () => {
-            const actual = await vi.importActual('react-router-dom');
+        vi.mock('react-router', async () => {
+            const actual = await vi.importActual('react-router');
             return {
                 ...actual,
                 Link: forwardRef(({ to, children, ...props }, ref) => (_jsx("a", { ref: ref, href: to, ...props, children: children }))),

package/tests/server-handlers.js

@@ -92,7 +92,7 @@ const handlers = [
         ]
     })),
     http.post('/api/v1/search/facet/hit', async ({ request }) => {
-        const payload = await request.json();
+        const payload = (await request.json());
         let facetResponse = Object.fromEntries(payload.fields.map(field => [field, { 'facet 1': 1, 'facet 2': 2 }]));
         if (payload.filters?.[0]?.includes('analytic')) {
             facetResponse = Object.fromEntries(payload.fields.map(field => [field, { 'Analytic 1': 1, 'Analytic 2': 2 }]));

package/utils/Throttler.js

@@ -1,7 +1,7 @@
 export default class Throttler {
     throttleId = null;
     delayId = null;
-    msec = null;
+    msec;
     constructor(msec) {
         this.msec = msec;
         this.debounce = this.debounce.bind(this);

package/utils/actionUtils.d.ts

@@ -28,4 +28,4 @@ export declare const getArgsByContext: (args: ActionOperationStep['args'], value
  * @param action The action to validate
  * @returns whether the action is ready to execute
  */
-export declare const operationReady: (data: Operation['data_json'], action: ActionOperation) => boolean;
+export declare const operationReady: (data?: Operation['data_json'], action?: ActionOperation) => boolean;

package/utils/actionUtils.js

@@ -34,12 +34,13 @@ const buildContext = (values = '{}') => Object.entries(JSON.parse(values)).map(t
  * @returns a list of options matching the current context
  */
 export const getOptionsByContext = (options, arg, context) => {
-    if (!options[arg]) {
+    const argOptions = options[arg];
+    if (!argOptions) {
         return [];
     }
     // If it's just an array, there's no special conditional logic to deal with - we just return the array
-    if (Array.isArray(options[arg])) {
-        return options[arg];
+    if (Array.isArray(argOptions)) {
+        return argOptions;
     }
     // Build the context up from the raw values, and check to see if any of the context values matches the conditionals provided in the options.
     // i.e.
@@ -50,8 +51,11 @@ export const getOptionsByContext = (options, arg, context) => {
     //
     // Note that this restricts the options to a single key:value pair.
     // For more complex cases down the road (if those end up existing), we'll need to improve this
-    const matchingKey = buildContext(context).find(key => !!options[arg][key]);
-    return options[arg][matchingKey] ?? [];
+    const matchingKey = buildContext(context).find(key => !!argOptions[key]);
+    if (!matchingKey) {
+        return [];
+    }
+    return argOptions[matchingKey] ?? [];
 };
 /**
  * Get a list of arguments to display based on the current context, using the current values supplied for the action entry.
@@ -79,7 +83,7 @@ export const getArgsByContext = (args, values) => Object.entries(args)
  * @returns whether the action is ready to execute
  */
 export const operationReady = (data, action) => {
-    if (!data) {
+    if (!data || !action) {
         return false;
     }
     const parsedData = JSON.parse(data);

package/utils/classificationParser.js

@@ -1,4 +1,6 @@
 // pulled from https://github.com/CybercentreCanada/assemblyline-ui-frontend/blob/master/src/helpers/classificationParser.ts
+import { isNil } from 'lodash-es';
+import { notNil } from './utils';
 export const defaultParts = {
     lvlIdx: 0,
     lvl: '',
@@ -17,7 +19,7 @@ export const getLevelText = (lvl, c12nDef, format, isMobile) => {
     if (c12nDef != null && lvl != null) {
         text = c12nDef.levels_map[lvl.toString()];
     }
-    if (text === undefined || text == null) {
+    if (isNil(text)) {
         //ERROR: `Classification level number '${lvl}' was not found in your classification definition.`
         /* eslint-disable no-console */
         console.error(`[classificationParser] Classification level number '${lvl}' was not found in your classification definition.`);
@@ -35,13 +37,13 @@ const getLevelIndex = (c12n, c12nDef) => {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars, no-unused-vars
     const [level, unused, _x] = c12n?.split(/\/\/(.*)/) ?? [null, null, null];
     const c12nLvl = level?.toUpperCase();
-    if (c12nDef.levels_map[c12nLvl] !== undefined) {
+    if (notNil(c12nDef.levels_map[c12nLvl])) {
         retIndex = c12nDef.levels_map[c12nLvl];
     }
-    else if (c12nDef.levels_map_lts[c12nLvl] !== undefined) {
+    else if (notNil(c12nDef.levels_map_lts[c12nLvl])) {
         retIndex = c12nDef.levels_map[c12nDef.levels_map_lts[c12nLvl]];
     }
-    else if (c12nDef.levels_aliases[c12nLvl] !== undefined) {
+    else if (notNil(c12nDef.levels_aliases[c12nLvl])) {
         retIndex = c12nDef.levels_map[c12nDef.levels_aliases[c12nLvl]];
     }
     else {
@@ -188,7 +190,7 @@ const getGroups = (groupParts, c12nDef, format, isMobile, autoSelect = false) =>
     // Check if there are any forbidden group assignments
     for (const subgroup of g2Set) {
         const limitedToGroup = c12nDef.params_map?.[subgroup]?.limited_to_group;
-        if (limitedToGroup !== null && limitedToGroup !== undefined) {
+        if (notNil(limitedToGroup)) {
             if (g1Set.size > 1 || (g1Set.size === 1 && !g1Set.has(limitedToGroup))) {
                 // ERROR: `Subgroup ${subgroup} is limited to group ${limitedToGroup} (found: ${Array.from(g1Set).toString()})`
                 // just log the error and leave it
@@ -413,15 +415,6 @@ export const normalizedClassification = (parts, c12nDef, format, isMobile, skipA
     }
     return out;
 };
-const levelList = (c12nDef) => {
-    const out = [];
-    for (const i in c12nDef.levels_map) {
-        if (!isNaN(parseInt(i))) {
-            out.push(c12nDef.levels_map[i]);
-        }
-    }
-    return out;
-};
 export const defaultClassificationValidator = {
     disabled: defaultDisabled,
     parts: defaultParts
@@ -463,64 +456,64 @@ export const applyClassificationRules = (parts, c12nDef, format, isMobile, userC
             }
         }
     }
-    for (const partName in partsToCheck) {
-        if ({}.hasOwnProperty.call(partsToCheck, partName)) {
-            const part = retParts[partsToCheck[partName]];
-            for (const value of part) {
-                let triggerAutoSelect = false;
-                if (value) {
-                    if (value in requireLvl) {
-                        if (retParts.lvlIdx < requireLvl[value]) {
-                            retParts.lvlIdx = requireLvl[value];
-                            retParts.lvl = getLevelText(requireLvl[value], c12nDef, format, isMobile);
-                        }
-                        const levels = levelList(c12nDef);
-                        for (const l of levels) {
-                            if (c12nDef.levels_map[l] < requireLvl[value]) {
-                                disabledList.levels.push(l);
-                            }
+    for (const partName of partsToCheck) {
+        const part = retParts[partName];
+        for (const value of part) {
+            let triggerAutoSelect = false;
+            if (value) {
+                if (value in requireLvl) {
+                    if (retParts.lvlIdx < requireLvl[value]) {
+                        retParts.lvlIdx = requireLvl[value];
+                        retParts.lvl = getLevelText(requireLvl[value], c12nDef, format, isMobile);
+                    }
+                    for (const [levelIndex, levelLabel] of Object.entries(c12nDef.levels_map)) {
+                        const numericLevel = Number.parseInt(levelIndex, 10);
+                        if (!Number.isNaN(numericLevel) && numericLevel < requireLvl[value]) {
+                            disabledList.levels.push(levelLabel);
                         }
                     }
-                    if (value in requireGroup) {
-                        const valueLong = c12nDef.groups_map_stl[requireGroup[value]] || requireGroup[value];
-                        const valueShort = c12nDef.groups_map_lts[requireGroup[value]] || requireGroup[value];
-                        if (!retParts.groups.includes(valueLong) && !retParts.groups.includes(valueShort)) {
-                            retParts.groups.push(valueShort);
-                            for (const group of c12nDef.groups_auto_select) {
-                                const gLong = c12nDef.groups_map_stl[group] || group;
-                                const gShort = c12nDef.groups_map_lts[group] || group;
-                                if (!retParts.groups.includes(gShort) && !retParts.groups.includes(gLong)) {
-                                    retParts.groups.push(group);
-                                }
+                }
+                if (value in requireGroup) {
+                    const requiredGroup = requireGroup[value];
+                    const valueLong = c12nDef.groups_map_stl[requiredGroup] || requiredGroup;
+                    const valueShort = c12nDef.groups_map_lts[requiredGroup] || requiredGroup;
+                    if (!retParts.groups.includes(valueLong) && !retParts.groups.includes(valueShort)) {
+                        retParts.groups.push(valueShort);
+                        for (const group of c12nDef.groups_auto_select) {
+                            const gLong = c12nDef.groups_map_stl[group] || group;
+                            const gShort = c12nDef.groups_map_lts[group] || group;
+                            if (!retParts.groups.includes(gShort) && !retParts.groups.includes(gLong)) {
+                                retParts.groups.push(group);
                             }
                         }
                     }
-                    if (value in limitedToGroup) {
-                        for (const gShort in c12nDef.groups_map_stl) {
-                            const lgShort = c12nDef.groups_map_lts[limitedToGroup[value]] || limitedToGroup[value];
-                            if (gShort !== lgShort) {
-                                const gLong = c12nDef.groups_map_stl[gShort];
-                                disabledList.groups.push(gShort);
-                                if (retParts.groups.includes(gShort)) {
-                                    retParts.groups.splice(retParts.groups.indexOf(gShort), 1);
-                                }
-                                else if (retParts.groups.includes(gLong)) {
-                                    retParts.groups.splice(retParts.groups.indexOf(gLong), 1);
-                                }
+                }
+                if (value in limitedToGroup) {
+                    const limitedGroup = limitedToGroup[value];
+                    for (const gShort in c12nDef.groups_map_stl) {
+                        const lgShort = c12nDef.groups_map_lts[limitedGroup] || limitedGroup;
+                        if (gShort !== lgShort) {
+                            const gLong = c12nDef.groups_map_stl[gShort];
+                            disabledList.groups.push(gShort);
+                            if (retParts.groups.includes(gShort)) {
+                                retParts.groups.splice(retParts.groups.indexOf(gShort), 1);
+                            }
+                            else if (retParts.groups.includes(gLong)) {
+                                retParts.groups.splice(retParts.groups.indexOf(gLong), 1);
                             }
                         }
                     }
-                    if (!userClassification && partsToCheck[partName] === 'groups') {
-                        triggerAutoSelect = true;
-                    }
                 }
-                if (triggerAutoSelect) {
-                    for (const group of c12nDef.groups_auto_select) {
-                        const gLong = c12nDef.groups_map_stl[group] || group;
-                        const gShort = c12nDef.groups_map_lts[group] || group;
-                        if (!retParts.groups.includes(gLong) && !retParts.groups.includes(gShort)) {
-                            retParts.groups.push(group);
-                        }
+                if (!userClassification && partName === 'groups') {
+                    triggerAutoSelect = true;
+                }
+            }
+            if (triggerAutoSelect) {
+                for (const group of c12nDef.groups_auto_select) {
+                    const gLong = c12nDef.groups_map_stl[group] || group;
+                    const gShort = c12nDef.groups_map_lts[group] || group;
+                    if (!retParts.groups.includes(gLong) && !retParts.groups.includes(gShort)) {
+                        retParts.groups.push(group);
                     }
                 }
             }

package/utils/constants.d.ts

@@ -4,23 +4,6 @@ export declare const LOCAL: boolean;
 export declare const VERSION: any;
 export declare const MY_LOCAL_STORAGE_PREFIX = "howler.ui";
 export declare const MY_SESSION_STORAGE_PREFIX = "howler.ui.cache";
-export declare const ESCALATION_COLORS: {
-    alert: 'warning';
-    evidence: 'error';
-    hit: 'primary';
-};
-export declare const STATUS_COLORS: {
-    open: string;
-    'in-progress': string;
-    resolved: string;
-};
-export declare const PROVIDER_COLORS: {
-    HBS: "#303f9f";
-    NBS: "#ff4081";
-    CBS: "#00796b";
-    howler: string;
-    unknown: "#616161";
-};
 export declare enum StorageKey {
     DISABLE_FEATURE_WARNING = "disable.feature.warning",
     DEFAULT_VIEW = "default.view",

package/utils/constants.js

@@ -1,6 +1,6 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { LocalPolice, MoodBad, NewReleases, PsychologyAlt, Star, Timeline } from '@mui/icons-material';
-import { blue, grey, indigo, orange, pink, red, teal, yellow } from '@mui/material/colors';
+import { blue, orange, pink, red, yellow } from '@mui/material/colors';
 import dayjs from 'dayjs';
 export const HOWLER_API = import.meta.env.VITE_API;
 export const LOCAL = HOWLER_API === 'MOCK';
@@ -8,23 +8,6 @@ export const VERSION = import.meta.env.VITE_VERSION;
 // A constant that will be used as prefix of all local storage keys.
 export const MY_LOCAL_STORAGE_PREFIX = 'howler.ui';
 export const MY_SESSION_STORAGE_PREFIX = `${MY_LOCAL_STORAGE_PREFIX}.cache`;
-export const ESCALATION_COLORS = {
-    alert: 'warning',
-    evidence: 'error',
-    hit: 'primary'
-};
-export const STATUS_COLORS = {
-    open: 'primary',
-    'in-progress': 'warning',
-    resolved: 'success'
-};
-export const PROVIDER_COLORS = {
-    HBS: indigo[700],
-    NBS: pink.A200,
-    CBS: teal[700],
-    howler: '#1769bb',
-    unknown: grey[700]
-};
 export var StorageKey;
 (function (StorageKey) {
     StorageKey["DISABLE_FEATURE_WARNING"] = "disable.feature.warning";

package/utils/exampleHit.d.ts

@@ -0,0 +1,2 @@
+import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
+export declare const getExampleHit: () => Hit;

package/utils/exampleHit.js

@@ -0,0 +1,18 @@
+import hitsData from './hit.json';
+const isRecord = (value) => {
+    return typeof value === 'object' && value !== null;
+};
+const isHitFixture = (value) => {
+    if (!isRecord(value) || typeof value.timestamp !== 'string' || !isRecord(value.howler)) {
+        return false;
+    }
+    const { analytic, assignment, hash, id } = value.howler;
+    return [analytic, assignment, hash, id].every(field => typeof field === 'string');
+};
+export const getExampleHit = () => {
+    const hit = Object.values(hitsData.GET)[0];
+    if (!isHitFixture(hit)) {
+        throw new Error('The example hit fixture is missing required Hit fields.');
+    }
+    return Object.assign(structuredClone(hit), { __index: 'hit' });
+};

package/utils/localStorage.d.ts

@@ -11,11 +11,11 @@ export declare const removeStored: (name: StorageKey) => void;
  * If you want to edit localStorage items inside a React component, use
  * src/components/hooks/useMyLocalStorage.tsx.
  */
-export declare const setStored: (name: StorageKey, item: any) => void;
+export declare const setStored: (name: StorageKey, item: unknown) => void;
 /**
  * **IMPORTANT**: This function should only be used OUTSIDE of the React tree.
  * If you want to edit localStorage items inside a React component, use
  * src/components/hooks/useMyLocalStorage.tsx.
  */
-export declare const getStored: <T = string>(name?: StorageKey) => T;
+export declare const getStored: <T = string>(name: StorageKey) => T | null;
 export declare const saveLoginCredential: (loginRes: LoginResponse) => boolean;

package/utils/localStorage.js

@@ -23,7 +23,7 @@ export const setStored = (name, item) => {
  */
 export const getStored = (name) => {
     try {
-        return JSON.parse(localStorage.getItem(buildName(name)));
+        return JSON.parse(localStorage.getItem(buildName(name)) ?? 'null');
     }
     catch {
         // Migrating from the old system, some values were not JSON encoded. Decoding them will cause an exception.

package/utils/menuUtils.d.ts

@@ -1,89 +1,3 @@
-import type { AppLeftNavElement, AppLeftNavItem } from '../commons/components/app/AppConfigs';
-declare class AppMenuBuilder {
-    private items;
-    private indexMap;
-    constructor(defaultMenu: AppLeftNavElement[]);
-    /**
-     * Applies a collection of Menu Operation objects created by the plugin system
-     *
-     * @param operations Operations created by the plugin system
-     */
-    applyOperations(operations: {
-        operation: string;
-        targetId: string;
-        item: AppLeftNavElement;
-    }[]): void;
-    /**
-     * Get the completed menu structure
-     */
-    get menu(): AppLeftNavElement[];
-    /**
-     * Insert provided menu item at the menu object identified by targetId.
-     *
-     * If the target menu is a group then item will be placed at end of sub items
-     *
-     * If the target menu is a standard item then group will be created and new item added, warning this removes
-     * the route from the new group parent item, be sure to add it back.
-     *
-     * If the target is 'root' then item will be added to end of root menu
-     *
-     * @param targetId Identifier of menu to insert to
-     * @param item Menu Item to insert
-     */
-    insert(targetId: string, item: AppLeftNavElement): void;
-    /**
-     * Insert provided menu item before the menu object identified by targetId.
-     *
-     * @param targetId Identifier of menu to insert to
-     * @param item Menu Item to insert
-     */
-    insertBefore(targetId: string, item: AppLeftNavElement): void;
-    /**
-     * Insert provided menu item after the menu object identified by targetId.
-     *
-     * @param targetId Identifier of menu to insert to
-     * @param item Menu Item to insert
-     */
-    insertAfter(targetId: string, item: AppLeftNavElement): void;
-    /**
-     * Locates menu location in menu structure by menu id.
-     *
-     * @param id Menu Id to search for
-     * @return {index: number, subIndex: number} A dictionary containing indexes needed to access Menu Item
-     */
-    indexOfMenuId(id: string): {
-        index: number;
-        subIndex?: number;
-    };
-    /**
-     *  Grabs a menu by indexes, helper function to account for an index of -1
-     *  to represent the root menu
-     *
-     * @param index First level index
-     * @param subIndex Second level index
-     * @return {} Menu item
-     */
-    menuFromIndex(index: number, subIndex?: number): AppLeftNavElement[] | AppLeftNavElement | AppLeftNavItem;
-    /**
-     * Determine if provided element is a group element
-     *
-     * @param elem Element to check
-     * @private
-     */
-    private isGroupElement;
-    /**
-     * Determine if provided element is an item element
-     *
-     * @param elem Element to check
-     * @private
-     */
-    private isItemElement;
-    /**
-     * Creates a flat list of menu items and subitems by menu id
-     * for quick lookup.
-     *
-     * @private
-     */
-    private updateMenuMap;
-}
-export default AppMenuBuilder;
+import type { LeftNavMenuProps } from '@tui/core';
+import type { MainMenuOperation } from '@cccsaurora/howler-ui/plugins/store';
+export declare const applyMainMenuOperations: (root: LeftNavMenuProps, operations: readonly MainMenuOperation[]) => LeftNavMenuProps;