@cccsaurora/howler-ui 2.17.0-dev.564 → 2.17.0-dev.617

package/package.json

@@ -101,7 +101,7 @@
     "internal-slot": "1.0.7"
   },
   "type": "module",
-  "version": "2.17.0-dev.564",
+  "version": "2.17.0-dev.617",
   "exports": {
     "./i18n": "./i18n.js",
     "./index.css": "./index.css",
@@ -129,8 +129,10 @@
     "./components/app/providers/*": "./components/app/providers/*.js",
     "./components/app/hooks/*": "./components/app/hooks/*.js",
     "./components/elements/display/*": "./components/elements/display/*.js",
+    "./components/elements/observable/*": "./components/elements/observable/*.js",
     "./components/elements/hit/*": "./components/elements/hit/*.js",
     "./components/elements/view/*": "./components/elements/view/*.js",
+    "./components/elements/case/*": "./components/elements/case/*.js",
     "./components/elements/addons/*": "./components/elements/addons/*.js",
     "./components/elements/display/handlebars/*": "./components/elements/display/handlebars/*.js",
     "./components/elements/display/modals/*": "./components/elements/display/modals/*.js",
@@ -172,6 +174,8 @@
     "./components/routes/help/*": "./components/routes/help/*.js",
     "./components/routes/admin/*": "./components/routes/admin/*.js",
     "./components/routes/settings/*": "./components/routes/settings/*.js",
+    "./components/routes/observables/*": "./components/routes/observables/*.js",
+    "./components/routes/cases/*": "./components/routes/cases/*.js",
     "./components/routes/action/edit/*": "./components/routes/action/edit/*.js",
     "./components/routes/action/view/*": "./components/routes/action/view/*.js",
     "./components/routes/action/shared/*": "./components/routes/action/shared/*.js",
@@ -187,6 +191,11 @@
     "./components/routes/help/markdown/fr/*.md": "./components/routes/help/markdown/fr/*.md.js",
     "./components/routes/help/markdown/en/*.md": "./components/routes/help/markdown/en/*.md.js",
     "./components/routes/admin/users/*": "./components/routes/admin/users/*.js",
+    "./components/routes/cases/modals/*": "./components/routes/cases/modals/*.js",
+    "./components/routes/cases/hooks/*": "./components/routes/cases/hooks/*.js",
+    "./components/routes/cases/detail/*": "./components/routes/cases/detail/*.js",
+    "./components/routes/cases/detail/sidebar/*": "./components/routes/cases/detail/sidebar/*.js",
+    "./components/routes/cases/detail/aggregates/*": "./components/routes/cases/detail/aggregates/*.js",
     "./commons/components/*": "./commons/components/*.js",
     "./commons/components/breadcrumbs/*": "./commons/components/breadcrumbs/*.js",
     "./commons/components/app/*": "./commons/components/app/*.js",
@@ -212,6 +221,8 @@
     "./locales/en/help/*.json": "./locales/en/help/*.json",
     "./api/overview/*": "./api/overview/*.js",
     "./api/overview": "./api/overview/index.js",
+    "./api/v2/*": "./api/v2/*.js",
+    "./api/v2": "./api/v2/index.js",
     "./api/action/*": "./api/action/*.js",
     "./api/action": "./api/action/index.js",
     "./api/auth/*": "./api/auth/*.js",
@@ -234,6 +245,10 @@
     "./api/hit": "./api/hit/index.js",
     "./api/view/*": "./api/view/*.js",
     "./api/view": "./api/view/index.js",
+    "./api/v2/search/*": "./api/v2/search/*.js",
+    "./api/v2/search": "./api/v2/search/index.js",
+    "./api/v2/case/*": "./api/v2/case/*.js",
+    "./api/v2/case": "./api/v2/case/index.js",
     "./api/analytic/comments/*": "./api/analytic/comments/*.js",
     "./api/analytic/comments": "./api/analytic/comments/index.js",
     "./api/analytic/notebooks/*": "./api/analytic/notebooks/*.js",

package/plugins/clue/components/ClueTypography.js

@@ -3,8 +3,8 @@ import EnrichedTypography from '@cccsaurora/clue-ui/components/EnrichedTypograph
 import { Typography } from '@mui/material';
 import { memo } from 'react';
 import { useType } from '../utils';
-const ClueTypography = ({ children, value, context, field, hit, ...props }) => {
-    const type = useType(hit, field, value);
+const ClueTypography = ({ children, value, context, field, obj, ...props }) => {
+    const type = useType(obj, field, value);
     if (!type) {
         return _jsx(Typography, { ...props, children: children ?? value });
     }

package/plugins/clue/utils.d.ts

@@ -1,2 +1,3 @@
 import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
-export declare const useType: (hit?: Hit, field?: string, value?: string) => any;
+import type { Observable } from '@cccsaurora/howler-ui/models/entities/generated/Observable';
+export declare const useType: (hit?: Hit | Observable, field?: string, value?: string) => any;

package/utils/constants.d.ts

@@ -5,9 +5,9 @@ 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: string;
-    evidence: string;
-    hit: string;
+    alert: "warning";
+    evidence: "error";
+    hit: "primary";
 };
 export declare const STATUS_COLORS: {
     open: string;

package/utils/typeUtils.d.ts

@@ -0,0 +1,7 @@
+import type { Case } from '@cccsaurora/howler-ui/models/entities/generated/Case';
+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';
+export declare const isHit: (obj: WithMetadata<any>) => obj is Hit;
+export declare const isCase: (obj: WithMetadata<any>) => obj is Case;
+export declare const isObservable: (obj: WithMetadata<any>) => obj is Observable;

package/utils/typeUtils.js

@@ -0,0 +1,18 @@
+export const isHit = (obj) => {
+    if (obj.__index === 'hit') {
+        return true;
+    }
+    return false;
+};
+export const isCase = (obj) => {
+    if (obj.__index === 'case') {
+        return true;
+    }
+    return false;
+};
+export const isObservable = (obj) => {
+    if (obj.__index === 'observable') {
+        return true;
+    }
+    return false;
+};

package/components/elements/display/icons/BundleButton.d.ts

@@ -1,6 +0,0 @@
-import type { FC } from 'react';
-declare const BundleButton: FC<{
-    ids: string[];
-    disabled?: boolean;
-}>;
-export default BundleButton;

package/components/elements/display/icons/BundleButton.js

@@ -1,32 +0,0 @@
-import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
-import { AccountTree } from '@mui/icons-material';
-import { ListItemText, Menu, MenuItem, Typography } from '@mui/material';
-import TuiIconButton from '@cccsaurora/howler-ui/components/elements/addons/buttons/CustomIconButton';
-import { useCallback, useState } from 'react';
-import { useTranslation } from 'react-i18next';
-import { useNavigate } from 'react-router-dom';
-const BundleButton = ({ ids, disabled = false }) => {
-    const { t } = useTranslation();
-    const navigate = useNavigate();
-    const [anchorEl, setAnchorEl] = useState(null);
-    const onClick = useCallback((event) => {
-        if (ids.length === 1) {
-            navigate(`/bundles/${ids[0]}`);
-        }
-        else {
-            setAnchorEl(event.currentTarget);
-        }
-    }, [ids, navigate]);
-    const handleClose = useCallback(() => setAnchorEl(null), []);
-    return (_jsxs(_Fragment, { children: [_jsx(TuiIconButton, { size: "small", tooltip: t(`hit.panel.bundles.open${ids.length > 1 ? '' : '.prompt'}`), onClick: onClick, disabled: disabled, "aria-disabled": disabled, "aria-haspopup": "true", "aria-controls": anchorEl ? 'bundle-action-menu' : undefined, "aria-expanded": anchorEl ? 'true' : undefined, children: _jsx(AccountTree, {}) }), _jsx(Menu, { id: "bundle-action-menu", anchorEl: anchorEl, open: !!anchorEl, onClose: handleClose, MenuListProps: {
-                    dense: true,
-                    'aria-labelledby': `bundle-button`
-                }, anchorOrigin: {
-                    vertical: 'bottom',
-                    horizontal: 'right'
-                }, transformOrigin: {
-                    vertical: 'top',
-                    horizontal: 'right'
-                }, children: ids.map(id => (_jsx(MenuItem, { onClick: () => navigate(`/bundles/${id}`), children: _jsx(ListItemText, { primary: t('hit.panel.bundles.open.prompt'), secondary: _jsx(Typography, { variant: "caption", color: "text.secondary", children: id }) }) }, id))) })] }));
-};
-export default BundleButton;

package/components/routes/help/BundleDocumentation.d.ts

@@ -1,3 +0,0 @@
-import type { FC } from 'react';
-declare const BundleDocumentation: FC;
-export default BundleDocumentation;

package/components/routes/help/BundleDocumentation.js

@@ -1,12 +0,0 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-import Markdown from '@cccsaurora/howler-ui/components/elements/display/Markdown';
-import { useMemo } from 'react';
-import { useTranslation } from 'react-i18next';
-import BUNDLES_EN from './markdown/en/bundles.md';
-import BUNDLES_FR from './markdown/fr/bundles.md';
-const BundleDocumentation = () => {
-    const { i18n } = useTranslation();
-    const md = useMemo(() => (i18n.language === 'en' ? BUNDLES_EN : BUNDLES_FR), [i18n.language]);
-    return _jsx(Markdown, { md: md });
-};
-export default BundleDocumentation;

package/components/routes/help/markdown/en/bundles.md.js

@@ -1 +0,0 @@
-export default "<!-- docs/ingestion/bundles.md -->\n\n# Howler Hit Bundles\n\nHit bundles can be used to easily package together a large number of similar alerts, allowing analysts to easily triage them as a single incident. For example, consider a single computer that repeatedly makes a network call to `baddomain.ru` - while an alert may be generated for every instance of this computer hitting that domain, it makes sense for analysts to treat all these alerts as a single case.\n\n## Creating bundles through the Howler Client\n\nThere are a couple of ways to create a bundle through the howler client:\n\n```python\nfrom howler_client import get_client\n\nhowler = get_client(\"https://howler.dev.analysis.cyber.gc.ca\")\n\n\"\"\"Creating a howler bundle and the hits at the same time\"\"\"\nhowler.bundle.create(\n    # First argument is the bundle hit\n    {\n        \"howler.analytic\": \"example-test\",\n        \"howler.score\": 0\n    },\n    # Second argument is a hit or list of hits to include in the bundle\n    [\n        {\n            \"howler.analytic\": \"example-test\",\n            \"howler.score\": 0\n        },\n        {\n            \"howler.analytic\": \"example-test\",\n            \"howler.score\": 0\n        }\n    ]\n)\n\n\"\"\"Creating a howler bundle from existing hits\"\"\"\nhowler.bundle.create(\n    {\n        \"howler.analytic\": \"example-test\",\n        \"howler.score\": 0,\n        \"howler.hits\": [\"YcUsL8QsjmwwIdstieROk\", \"6s7MztwuSvz6tM0PgGJhvz\"]\n    },\n    # Note: In future releases, you won't need to include this argument\n    []\n)\n\n\n\"\"\"Creating from a map\"\"\"\nbundle_hit = {\n    \"score\": 0,\n    \"bundle\": True\n}\n\nmap = {\n    \"score\": [\"howler.score\"],\n    \"bundle\": [\"howler.is_bundle\"]\n}\n\nhowler.bundle.create_from_map(\"example-test\", bundle_hit, map, [{\"score\": 0}])\n```\n\n## Viewing bundles on the Howler UI\n\nIn order to view created bundles on the Howler UI, you can use the query `howler.is_bundle:true`. This will provide a list of created bundles you can look through.\n\nClicking on a bundle will open up a slightly different search UI to normal. In this case, we automatically filter the search results to include only hits that are included in the bundle. To make this obvious, the header representing the bundle will appear above the search bar.\n\nYou can continue to filter through hits using the same queries as usual, and view them as usual. When triaging a bundle, assessing it will apply this assessment to all hits in the bundle, **except those that have already been triaged**. That is, if the bundle is open, all open hits will be assessed when you assess it.\n\nBundles also have a **Summary** tab not available for regular hits. This summary tab will aid you in aggregating data about all the hits in the bundle. Simply open the tab and click \"Create Summary\". Note that this may take some time, as a large number of queries are being run to aggregate the data.\n"

package/components/routes/help/markdown/fr/bundles.md.js

@@ -1 +0,0 @@
-export default "<!-- docs/ingestion/bundles.fr.md -->\n\n# Les groupes des hits Howler\n\nLes groupes des hits peuvent \u00eatre utilis\u00e9s pour regrouper facilement un grand nombre d'alertes similaires, ce qui permet aux analystes de les traiter comme un seul incident. Prenons l'exemple d'un ordinateur qui effectue \u00e0 plusieurs reprises un appel r\u00e9seau vers `baddomain.ru` - bien qu'une alerte puisse \u00eatre g\u00e9n\u00e9r\u00e9e pour chaque cas o\u00f9 cet ordinateur acc\u00e8de \u00e0 ce domaine, il est logique que les analystes traitent toutes ces alertes comme un seul et m\u00eame cas.\n\n## Cr\u00e9ation de groupes via le client Howler\n\nIl y a plusieurs fa\u00e7ons de cr\u00e9er un groupe via le client Howler:\n\n```python\nfrom howler_client import get_client\n\nhowler = get_client(\"https://howler.dev.analysis.cyber.gc.ca\")\n\n\"\"\"Cr\u00e9ation simultan\u00e9e d'un groupe howler et de hits\"\"\"\nhowler.bundle.create(\n    # Le premier argument est le hit de l'offre group\u00e9e\n    {\n        \"howler.analytic\": \"example-test\",\n        \"howler.score\": 0\n    },\n    # Le deuxi\u00e8me argument est un hit ou une liste de hits \u00e0 inclure dans l'offre group\u00e9e.\n    [\n        {\n            \"howler.analytic\": \"example-test\",\n            \"howler.score\": 0\n        },\n        {\n            \"howler.analytic\": \"example-test\",\n            \"howler.score\": 0\n        }\n    ]\n)\n\n\"\"\"Cr\u00e9ation d'un groupe howler \u00e0 partir de hits existants\"\"\"\nhowler.bundle.create(\n    {\n        \"howler.analytic\": \"example-test\",\n        \"howler.score\": 0,\n        \"howler.hits\": [\"YcUsL8QsjmwwIdstieROk\", \"6s7MztwuSvz6tM0PgGJhvz\"]\n    },\n    # Noter: Dans les prochaines versions, vous n'aurez plus besoin d'inclure cet argument.\n    []\n)\n\n\n\"\"\"Cr\u00e9ation \u00e0 partir d'une carte\"\"\"\nbundle_hit = {\n    \"score\": 0,\n    \"bundle\": True\n}\n\nmap = {\n    \"score\": [\"howler.score\"],\n    \"bundle\": [\"howler.is_bundle\"]\n}\n\nhowler.bundle.create_from_map(\"example-test\", bundle_hit, map, [{\"score\": 0}])\n```\n\n## Visualiser les groupes sur l'interface utilisateur de Howler\n\nAfin de visualiser les groupes cr\u00e9\u00e9s sur l'interface utilisateur de Howler, vous pouvez utiliser la requ\u00eate `howler.is_bundle:true`. Cela fournira une liste de groupes cr\u00e9\u00e9s que vous pourrez consulter.\n\nEn cliquant sur un groupe, vous ouvrirez une interface de recherche l\u00e9g\u00e8rement diff\u00e9rente de l'interface normale. Dans ce cas, nous filtrons automatiquement les r\u00e9sultats de la recherche pour n'inclure que les r\u00e9sultats inclus dans le groupe. Pour que cela soit \u00e9vident, l'en-t\u00eate repr\u00e9sentant le groupe appara\u00eet au-dessus de la barre de recherche.\n\nVous pouvez continuer \u00e0 filtrer les r\u00e9sultats en utilisant les m\u00eames requ\u00eates que d'habitude et \u00e0 les visualiser comme d'habitude. Lors du triage d'un groupe, son \u00e9valuation s'appliquera \u00e0 tous les hits du groupe, **sauf ceux qui ont d\u00e9j\u00e0 \u00e9t\u00e9 tri\u00e9s**. En d'autres termes, si le groupe est ouvert, tous les hits ouverts seront \u00e9valu\u00e9s lorsque vous l'\u00e9valuerez.\n\nLes groupes disposent \u00e9galement d'un onglet **R\u00e9sum\u00e9** qui n'est pas disponible pour les hits ordinaires. Cet onglet vous aidera \u00e0 regrouper les donn\u00e9es relatives \u00e0 tous les r\u00e9sultats du groupe. Il suffit d'ouvrir l'onglet et de cliquer sur \"Cr\u00e9er un sommaire\". Notez que cette op\u00e9ration peut prendre un certain temps, car un grand nombre de requ\u00eates sont ex\u00e9cut\u00e9es pour agr\u00e9ger les donn\u00e9es.\n"

package/components/routes/hits/search/BundleParentMenu.d.ts

@@ -1,6 +0,0 @@
-import type { Hit } from '@cccsaurora/howler-ui/models/entities/generated/Hit';
-import type { FC } from 'react';
-declare const BundleParentMenu: FC<{
-    bundle: Hit;
-}>;
-export default BundleParentMenu;

package/components/routes/hits/search/BundleParentMenu.js

@@ -1,32 +0,0 @@
-import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
-import { AccountTree } from '@mui/icons-material';
-import { IconButton, Paper, Popover, Skeleton, Stack, Tooltip } from '@mui/material';
-import api from '@cccsaurora/howler-ui/api';
-import HowlerCard from '@cccsaurora/howler-ui/components/elements/display/HowlerCard';
-import HitBanner from '@cccsaurora/howler-ui/components/elements/hit/HitBanner';
-import { HitLayout } from '@cccsaurora/howler-ui/components/elements/hit/HitLayout';
-import { useCallback, useEffect, useState } from 'react';
-import { useTranslation } from 'react-i18next';
-import { useNavigate } from 'react-router-dom';
-const BundleParentMenu = ({ bundle }) => {
-    const { t } = useTranslation();
-    const navigate = useNavigate();
-    const [parentAnchor, setParentAnchor] = useState(null);
-    const [parentHits, setParentHits] = useState([]);
-    const onSelect = useCallback((bundleId) => {
-        navigate(`/bundles/${bundleId}?span=date.range.all&query=howler.id%3A*`);
-        setParentAnchor(null);
-    }, [navigate]);
-    useEffect(() => {
-        if (!parentAnchor) {
-            return;
-        }
-        api.search.hit
-            .post({ query: `howler.id:(${bundle.howler.bundles.join(' OR ')})` })
-            .then(response => setParentHits(response.items));
-    }, [bundle.howler.bundles, parentAnchor]);
-    return (_jsxs(_Fragment, { children: [_jsx(Tooltip, { title: t('hit.bundle.parents.show'), children: _jsx(IconButton, { size: "small", onClick: event => setParentAnchor(event.currentTarget), children: _jsx(AccountTree, { fontSize: "small" }) }) }), _jsx(Popover, { open: !!parentAnchor, anchorEl: parentAnchor, anchorOrigin: { vertical: 'top', horizontal: 'left' }, transformOrigin: { horizontal: 'right', vertical: 'top' }, onClose: () => setParentAnchor(null), children: _jsx(Paper, { sx: { p: 1, minWidth: '750px' }, children: _jsx(Stack, { spacing: 1, children: parentHits.length < 1
-                            ? bundle.howler.bundles.map(id => _jsx(Skeleton, { variant: "rounded", height: "100px" }, id))
-                            : parentHits.map(parent => (_jsx(HowlerCard, { sx: { p: 1, cursor: 'pointer' }, onClick: () => onSelect(parent.howler.id), children: _jsx(HitBanner, { hit: parent, layout: HitLayout.DENSE }) }, parent.howler.id))) }) }) })] }));
-};
-export default BundleParentMenu;