@cccsaurora/howler-ui 2.14.0-dev.269 → 2.14.0-dev.272

package/rest/index.ts

@@ -1,12 +0,0 @@
-import type { HowlerResponse } from '@cccsaurora/howler-ui/api';
-
-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 }]>;
-  // eslint-disable-next-line semi
-}

package/setupTests.ts

@@ -1,17 +0,0 @@
-/// <reference types="vitest" />
-import * as matchers from '@testing-library/jest-dom/matchers';
-import '@testing-library/jest-dom/vitest';
-import { configure } from '@testing-library/react';
-import { server } from 'tests/server';
-
-// Extend vitest with the dom matchers from jest-dom.
-expect.extend(matchers);
-
-// tell React Testing Library to look for id as the testId.
-configure({ testIdAttribute: 'id' });
-
-beforeAll(() => server.listen());
-
-afterEach(() => server.resetHandlers());
-
-afterAll(() => server.close());

package/utils/Throttler.ts

@@ -1,43 +0,0 @@
-export default class Throttler {
-  private throttleId: number = null;
-
-  private delayId: number = null;
-
-  private msec: number = null;
-
-  constructor(msec: number) {
-    this.msec = msec;
-    this.debounce = this.debounce.bind(this);
-  }
-
-  public throttle(fn: () => void): void {
-    if (!this.throttleId) {
-      fn();
-      this.throttleId = setTimeout(() => {
-        this.throttleId = null;
-      }, this.msec) as unknown as number;
-    }
-  }
-
-  public debounce(fn: () => void): void {
-    if (this.delayId) {
-      clearTimeout(this.delayId);
-    }
-    this.delayId = setTimeout(fn, this.msec) as unknown as number;
-  }
-
-  public delayAsync(fn: (...args: any[]) => Promise<any>, ...args: any[]): Promise<any> {
-    if (this.delayId) {
-      clearTimeout(this.delayId);
-    }
-    return new Promise((resolve, reject) => {
-      this.delayId = setTimeout(async () => {
-        try {
-          resolve(await fn?.(...args));
-        } catch (error) {
-          reject(error);
-        }
-      }, this.msec) as unknown as number;
-    });
-  }
-}

package/utils/actionUtils.ts

@@ -1,112 +0,0 @@
-import type { ActionOperation, ActionOperationStep } from '@cccsaurora/howler-ui/models/ActionTypes';
-import type { Operation } from '@cccsaurora/howler-ui/models/entities/generated/Operation';
-
-/**
- * A simple validation function to ensure we have all the necessary arguments filled out.
- * @param step The step to validate
- * @param values The context to validate on
- * @returns whether all the necessary arguments have been filled in the given step
- */
-export const checkArgsAreFilled = (step: ActionOperationStep, values: string) => {
-  if (!values) {
-    return false;
-  }
-
-  const parsedValues = JSON.parse(values);
-  return Object.keys(step.args).every(arg => !!parsedValues[arg]);
-};
-
-/**
- * Convert a raw list of keyt value pairs into a context object used in other util functions. Converts it into a list like so:
- *
- * {
- *  "key": "value"
- * }
- * is converted to:
- * ["key:value"]
- *
- * Which is the format used for conditionals throughout the action specification.
- *
- * @param values The raw values object to convert
- * @returns a list representing the current context
- */
-const buildContext = (values: string = '{}') => Object.entries(JSON.parse(values)).map(tuple => tuple.join(':'));
-
-/**
- * Take the raw options object as specified by the server and get a list of usable options, filtered using the current values suppled for the action entry.
- * @param options The raw list of options from the server
- * @param arg The argument for which we are parsing options
- * @param context The values provided so far by the user
- * @returns a list of options matching the current context
- */
-export const getOptionsByContext = (
-  options: ActionOperationStep['options'],
-  arg: string,
-  context: string
-): string[] => {
-  if (!options[arg]) {
-    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] as string[];
-  }
-
-  // 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.
-  //
-  // options = {
-  //  "status:open": [] // would match if values["status"] === "open"
-  // }
-  //
-  // 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] as string[]) ?? [];
-};
-
-/**
- * Get a list of arguments to display based on the current context, using the current values supplied for the action entry.
- * @param args a complete list of all arguments in the action
- * @param values the current list of values provided by the user
- * @returns A list of arguments to display
- */
-export const getArgsByContext = (args: ActionOperationStep['args'], values: string): string[] =>
-  Object.entries(args)
-    .filter(([_, conditions]) => {
-      // If the array is empty, we always want to show this argument
-      if (conditions.length < 1) {
-        return true;
-      }
-
-      const context = buildContext(values);
-
-      // Note that the .some(...) here means the arguments are ORed together, not ANDed. So:
-      // "arg_to_show": ["status:open", "assignment:goose"]
-      // Will show if only one of these two conditions is valid.
-      return conditions.some(c => context.includes(c));
-    })
-    .map(([arg, _]) => arg);
-
-/**
- * Check to see if a given action has all the data necessary to execute successfully
- * @param data The user-provided data
- * @param action The action to validate
- * @returns whether the action is ready to execute
- */
-export const operationReady = (data: Operation['data_json'], action: ActionOperation) => {
-  if (!data) {
-    return false;
-  }
-
-  const parsedData = JSON.parse(data);
-  return (
-    action &&
-    getArgsByContext(
-      action.steps.reduce((acc, _step) => ({ ...acc, ..._step.args }), {}),
-      data
-    ).every(v => !!parsedData[v])
-  );
-};

package/utils/constants.tsx

@@ -1,131 +0,0 @@
-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 dayjs from 'dayjs';
-import type { ReactElement } from 'react';
-
-export const HOWLER_API = import.meta.env.VITE_API;
-export const LOCAL = HOWLER_API === 'MOCK';
-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 enum StorageKey {
-  DISABLE_FEATURE_WARNING = 'disable.feature.warning',
-  DEFAULT_VIEW = 'default.view',
-  PROVIDER = 'provider',
-  REFRESH_TOKEN = 'refresh_token',
-  USERNAME = 'username',
-  APP_TOKEN = 'app_token',
-  TOKEN_EXPIRY = 'token_expiry',
-  NEXT_LOCATION = 'next.location',
-  NEXT_SEARCH = 'next.search',
-  LAYOUT_TYPE = 'layout.type',
-  SHOW_DETAILS = 'hit.panel.details',
-  TIMEZONE = 'timezone',
-  DEV_MODE = 'dev_mode',
-  DASHBOARD_LAYOUT = 'dashboard_layout',
-  DEFAULT_FIELDS = 'default_fields',
-  HIT_LAYOUT = 'hit_layout',
-  HIT_SHORTCUTS = 'hit_shortcuts',
-  FORCE_DROPDOWN = 'force_dropdown',
-  VIEWER_ORIENTATION = 'viewer_orientation',
-  ETAG = 'etag',
-  AXIOS_CACHE = 'axios.cache',
-  LAST_SEEN = 'hit_last_seen',
-  MOCK_SEARCH_QUERY_STORE = 'mock_search_query_store',
-  MOCK_FAVOURITES_STORE = 'mock_favourite_store',
-  COMPACT_JSON = 'compact_json_view',
-  FLATTEN_JSON = 'flatten_json_view',
-  FORCE_DRAWER = 'force_drawer',
-  LAST_VIEW = 'last_view',
-  ONLY_RULES = 'only_rules',
-  PAGE_COUNT = 'page_count',
-  SEARCH_PANE_WIDTH = 'search_pane_width',
-  GRID_COLLAPSE_COLUMN = 'grid_collapse_column',
-  QUERY_HISTORY = 'query_history',
-  LOGIN_NONCE = 'login_nonce',
-  DISPLAY_TYPE = 'display_type'
-}
-
-export const MOCK_SEARCH_QUERY_STORE = `${MY_LOCAL_STORAGE_PREFIX}.${StorageKey.MOCK_SEARCH_QUERY_STORE}`;
-export const MOCK_FAVOURITES_STORE = `${MY_LOCAL_STORAGE_PREFIX}.${StorageKey.MOCK_FAVOURITES_STORE}`;
-
-export const VALID_ACTION_TRIGGERS = ['create', 'promote', 'demote'];
-
-const CURRENT_TIME = dayjs();
-
-export const minutes = [CURRENT_TIME.get('minute'), CURRENT_TIME.add(30, 'minute').get('minute')].sort();
-export const hours = [
-  CURRENT_TIME.get('hour'),
-  CURRENT_TIME.add(3, 'hour').get('hour'),
-  CURRENT_TIME.add(6, 'hour').get('hour'),
-  CURRENT_TIME.add(9, 'hour').get('hour'),
-  CURRENT_TIME.add(12, 'hour').get('hour'),
-  CURRENT_TIME.add(15, 'hour').get('hour'),
-  CURRENT_TIME.add(18, 'hour').get('hour'),
-  CURRENT_TIME.add(21, 'hour').get('hour')
-].sort((a, b) => a - b);
-
-/**
- * Precomputed crontabs for the intervals. This will introduce some natural load-balancing as jobs run at completely different minutes/hours.
- */
-export const RULE_INTERVALS = [
-  { key: 'rule.interval.thirty.minutes', crontab: `${minutes.join(',')} * * * *` },
-  { key: 'rule.interval.one.hour', crontab: `${CURRENT_TIME.get('minute')} * * * *` },
-  { key: 'rule.interval.three.hours', crontab: `${CURRENT_TIME.get('minute')} ${hours.join(',')} * * *` },
-  {
-    key: 'rule.interval.six.hours',
-    crontab: `${CURRENT_TIME.get('minute')} ${hours
-      .filter((_, index) => index % 2 === hours.indexOf(CURRENT_TIME.get('hour')) % 2)
-      .join(',')} * * *`
-  },
-  { key: 'rule.interval.one.day', crontab: `${CURRENT_TIME.get('minute')} ${CURRENT_TIME.get('hour')} * * *` }
-];
-
-export const DATE_RANGES = [
-  'date.range.1.day',
-  'date.range.3.day',
-  'date.range.1.week',
-  'date.range.1.month',
-  'date.range.all',
-  'date.range.custom'
-];
-
-interface LabelData {
-  icon?: ReactElement;
-  color?: string;
-}
-
-export const LABEL_TYPES: Record<string, LabelData> = {
-  insight: { icon: <PsychologyAlt fontSize="small" />, color: '#FFFFFF' }, //brain icon
-  mitigation: { icon: <LocalPolice fontSize="small" />, color: blue[600] }, //police badge
-  victim: { icon: <MoodBad fontSize="small" />, color: pink[400] }, //crime outline
-  campaign: { icon: <Timeline fontSize="small" />, color: orange[900] }, //net graph?
-  threat: { icon: <NewReleases fontSize="small" />, color: red[400] },
-  operation: { icon: <Star fontSize="small" />, color: yellow[600] },
-  generic: {},
-  assignments: {},
-  tuning: {}
-};

package/utils/hitFunctions.ts

@@ -1,10 +0,0 @@
-import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
-
-export const getUserList = (hit: Hit): Set<string> => {
-  const ids = new Set<string>();
-  if (hit) {
-    hit.howler?.log?.forEach(l => ids.add(l.user));
-    hit.howler?.comment?.forEach(c => ids.add(c.user), ids);
-  }
-  return ids;
-};

package/utils/localStorage.ts

@@ -1,54 +0,0 @@
-import type { LoginResponse } from '@cccsaurora/howler-ui/api/auth/login';
-import { MY_LOCAL_STORAGE_PREFIX, StorageKey } from './constants';
-
-const buildName = (name: string) => `${MY_LOCAL_STORAGE_PREFIX}.${name}`;
-
-/**
- * **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 const removeStored = (name: StorageKey) => {
-  localStorage.removeItem(buildName(name));
-};
-
-/**
- * **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 const setStored = (name: StorageKey, item: any) => {
-  localStorage.setItem(buildName(name), JSON.stringify(item));
-};
-
-/**
- * **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 const getStored = <T = string>(name?: StorageKey): T => {
-  try {
-    return JSON.parse(localStorage.getItem(buildName(name))) as T;
-  } catch (e) {
-    // Migrating from the old system, some values were not JSON encoded. Decoding them will cause an exception.
-    // Obviously, this is not optimal, but it's the only way to get Typescript to play nice.
-    // When this is called, T will be type string.
-    return localStorage.getItem(buildName(name)) as unknown as T;
-  }
-};
-
-export const saveLoginCredential = (loginRes: LoginResponse) => {
-  if (loginRes.app_token) {
-    setStored(StorageKey.APP_TOKEN, loginRes.app_token);
-    if (loginRes.refresh_token) {
-      setStored(StorageKey.REFRESH_TOKEN, loginRes.refresh_token);
-      setStored(StorageKey.PROVIDER, loginRes.provider);
-    }
-    return true;
-  }
-
-  removeStored(StorageKey.REFRESH_TOKEN);
-  removeStored(StorageKey.APP_TOKEN);
-  removeStored(StorageKey.PROVIDER);
-  return false;
-};

package/utils/menuUtils.ts

@@ -1,274 +0,0 @@
-import type { AppLeftNavElement, AppLeftNavGroup, AppLeftNavItem } from '../commons/components/app/AppConfigs';
-import { MainMenuInsertOperation } from '../plugins/store';
-import { isNil } from 'lodash-es';
-
-class AppMenuBuilder {
-  private items: AppLeftNavElement[];
-  private indexMap: Record<string | number, { index: number; parent?: number }>;
-
-  constructor(defaultMenu: AppLeftNavElement[]) {
-    this.items = defaultMenu;
-    this.updateMenuMap();
-  }
-
-  /**
-   * 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 }[]) {
-    for (const operation of operations) {
-      switch (operation.operation) {
-        case MainMenuInsertOperation.Insert:
-          // Inserts at end or adds to sub-elements
-          this.insert(operation.targetId, operation.item);
-          break;
-        case MainMenuInsertOperation.InsertBefore:
-          // Inserts before target element
-          this.insertBefore(operation.targetId, operation.item);
-          break;
-        case MainMenuInsertOperation.InsertAfter:
-          // Inserts after target element
-          this.insertAfter(operation.targetId, operation.item);
-          break;
-      }
-      this.updateMenuMap();
-    }
-  }
-
-  /**
-   * Get the completed menu structure
-   */
-  get menu() {
-    return this.items;
-  }
-
-  /**
-   * 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) {
-    const menuLocation = this.indexOfMenuId(targetId);
-    const target = this.menuFromIndex(menuLocation.index, menuLocation.subIndex);
-
-    if (!Array.isArray(target) && this.isGroupElement(target)) {
-      if (item.type === 'divider') {
-        console.warn(
-          `Skipping DIVIDER Operation: INSERT on Target: ${targetId}, Dividers cannot be inserted to sub-menus`
-        );
-        return;
-      }
-      const group = target.element;
-      const newItem: AppLeftNavItem = { ...(item.element as AppLeftNavItem), nested: true };
-      group.items = [...group.items, newItem];
-      return;
-    }
-
-    if (Array.isArray(target)) {
-      target.push(item);
-      return;
-    }
-
-    if (menuLocation.index !== -1 && isNil(menuLocation.subIndex)) {
-      if (item.type === 'divider') {
-        console.warn(
-          `Skipping DIVIDER Operation: INSERT on Target: ${targetId}, Dividers cannot be inserted to sub-menus`
-        );
-        return;
-      }
-
-      if (!this.isItemElement(target)) {
-        return;
-      }
-
-      const header = target.element;
-      const inserted: AppLeftNavItem = { ...(item.element as AppLeftNavItem), nested: true };
-
-      const newGroup: AppLeftNavElement = {
-        type: 'group',
-        element: {
-          id: header.id,
-          open: true,
-          i18nKey: header.i18nKey,
-          title: header.text,
-          userPropValidators: header.userPropValidators,
-          icon: header.icon as React.ReactElement<any>,
-          items: [inserted]
-        } as AppLeftNavGroup
-      };
-
-      this.items[menuLocation.index] = newGroup;
-      return;
-    }
-  }
-
-  /**
-   * 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) {
-    const menuLocation = this.indexOfMenuId(targetId);
-
-    if (!isNil(menuLocation.subIndex)) {
-      if (item.type === 'divider') {
-        console.warn(
-          `Skipping DIVIDER Operation: INSERT on Target: ${targetId}, Dividers cannot be inserted to sub-menus`
-        );
-        return;
-      }
-      const parentElement = this.menuFromIndex(menuLocation.index);
-      if (!Array.isArray(parentElement) && this.isGroupElement(parentElement)) {
-        const group = parentElement.element;
-        const newItem: AppLeftNavItem = { ...(item.element as AppLeftNavItem), nested: true };
-        group.items = [
-          ...group.items.slice(0, menuLocation.subIndex),
-          newItem,
-          ...group.items.slice(menuLocation.subIndex)
-        ];
-      }
-      return;
-    }
-
-    // Root level insertion before target index
-    if (menuLocation.index < 0) {
-      menuLocation.index = 0;
-    }
-    this.items = [...this.items.slice(0, menuLocation.index), item, ...this.items.slice(menuLocation.index)];
-  }
-
-  /**
-   * 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) {
-    const menuLocation = this.indexOfMenuId(targetId);
-
-    if (!isNil(menuLocation.subIndex)) {
-      if (item.type === 'divider') {
-        console.warn(
-          `Skipping DIVIDER Operation: INSERT on Target: ${targetId}, Dividers cannot be inserted to sub-menus`
-        );
-        return;
-      }
-      const parentElement = this.menuFromIndex(menuLocation.index);
-      if (!Array.isArray(parentElement) && this.isGroupElement(parentElement)) {
-        const group = parentElement.element;
-        const newItem: AppLeftNavItem = { ...(item.element as AppLeftNavItem), nested: true };
-        group.items = [
-          ...group.items.slice(0, menuLocation.subIndex + 1),
-          newItem,
-          ...group.items.slice(menuLocation.subIndex + 1)
-        ];
-      }
-      return;
-    }
-
-    // Root level insertion after target index
-    if (menuLocation.index < 0) {
-      menuLocation.index = this.items.length;
-    }
-    this.items = [...this.items.slice(0, menuLocation.index + 1), item, ...this.items.slice(menuLocation.index + 1)];
-  }
-
-  /**
-   * 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 } {
-    if (id === 'root') {
-      // Root item so return entire menu
-      return { index: -1 };
-    } else if (id in this.indexMap) {
-      // Item exists, check if it's a subitem
-      if ('parent' in this.indexMap[id]) {
-        return { index: this.indexMap[id].parent, subIndex: this.indexMap[id].index };
-      }
-      return { index: this.indexMap[id].index };
-    } else {
-      throw new Error(`Menu element with id of '${id}' not found.`);
-    }
-  }
-
-  /**
-   *  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 {
-    if (index === -1) {
-      return this.items;
-    }
-    if (isNil(subIndex)) {
-      return this.items[index];
-    }
-    const menuItem = this.items[index];
-    if (menuItem.type === 'group') {
-      return menuItem.element.items[subIndex];
-    }
-    throw new Error(`Menu item at index ${index} is not a group and does not have sub-items.`);
-  }
-
-  /**
-   * Determine if provided element is a group element
-   *
-   * @param elem Element to check
-   * @private
-   */
-  private isGroupElement(elem: unknown): elem is { type: 'group'; element: AppLeftNavGroup } {
-    return !!elem && typeof elem === 'object' && (elem as AppLeftNavElement).type === 'group';
-  }
-
-  /**
-   * Determine if provided element is an item element
-   *
-   * @param elem Element to check
-   * @private
-   */
-  private isItemElement(elem: unknown): elem is { type: 'item'; element: AppLeftNavItem } {
-    return !!elem && typeof elem === 'object' && (elem as AppLeftNavElement).type === 'item';
-  }
-
-  /**
-   * Creates a flat list of menu items and subitems by menu id
-   * for quick lookup.
-   *
-   * @private
-   */
-  private updateMenuMap() {
-    const indexMap: Record<string | number, { index: number; parent?: number }> = {};
-    for (let index = 0; index < this.items.length; index++) {
-      const menuItem = this.items[index];
-      if (menuItem.type === 'divider') {
-        continue;
-      }
-      indexMap[menuItem.element.id] = { index };
-      if (menuItem.type === 'group') {
-        for (let subIndex = 0; subIndex < menuItem.element.items.length; subIndex++) {
-          const subMenuItem = menuItem.element.items[subIndex];
-          indexMap[subMenuItem.id] = { index: subIndex, parent: index };
-        }
-      }
-    }
-    this.indexMap = indexMap;
-  }
-}
-
-export default AppMenuBuilder;