@cccsaurora/howler-ui 2.12.0-dev.45 → 2.12.0-dev.48

package/api/auth/login.js

@@ -10,7 +10,6 @@ export const post = (body) => {
 export const get = (search) => {
     const nonce = localStorage.getItem(`${MY_LOCAL_STORAGE_PREFIX}.${StorageKey.LOGIN_NONCE}`);
     if (nonce) {
-        console.log('Adding nonce');
         search.set('nonce', JSON.parse(nonce));
         localStorage.removeItem(`${MY_LOCAL_STORAGE_PREFIX}.${StorageKey.LOGIN_NONCE}`);
     }

package/api/dossier/hit.js

@@ -1,3 +1,4 @@
+/* eslint-disable import/no-cycle */
 import { hget, joinAllUri } from '@cccsaurora/howler-ui/api';
 import { uri as parentUri } from '.';
 const uri = (id) => joinAllUri(parentUri(), 'hit', id);

package/api/dossier/index.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-cycle
 import { hdelete, hget, hpost, hput, joinAllUri, joinUri, uri as parentUri } from '@cccsaurora/howler-ui/api';
 import * as hit from './hit';
 export const uri = (id) => {

package/api/hit/comments/react.js

@@ -1,3 +1,4 @@
+// eslint-disable-next-line import/no-cycle
 import { hdelete, hput, joinUri } from '@cccsaurora/howler-ui/api';
 import { uri as parentUri } from '@cccsaurora/howler-ui/api/hit/comments';
 export const uri = (hit, comment) => {

package/components/elements/addons/buttons/index.d.ts

@@ -1,3 +1,3 @@
 export declare const MuiButtonColors: readonly ["inherit", "primary", "secondary", "success", "error", "info", "warning"];
 export type MuiButtonColorType = (typeof MuiButtonColors)[number];
-export declare function isMuiButtonColor(color: string): boolean;
+export declare const isMuiButtonColor: (color: string) => boolean;

package/components/elements/addons/buttons/index.js

@@ -1,4 +1,4 @@
 export const MuiButtonColors = ['inherit', 'primary', 'secondary', 'success', 'error', 'info', 'warning'];
-export function isMuiButtonColor(color) {
+export const isMuiButtonColor = (color) => {
     return MuiButtonColors.some(c => c === color);
-}
+};

package/components/elements/display/HandlebarsMarkdown.js

@@ -7,10 +7,11 @@ import { useTranslation } from 'react-i18next';
 import Throttler from '@cccsaurora/howler-ui/utils/Throttler';
 import { hashCode } from '@cccsaurora/howler-ui/utils/utils';
 import Markdown, {} from '../display/Markdown';
-import { helpers } from './handlebars/helpers';
+import { useHelpers } from './handlebars/helpers';
 const THROTTLER = new Throttler(500);
 const HandlebarsMarkdown = ({ md, object = {}, disableLinks = false }) => {
     const { t } = useTranslation();
+    const helpers = useHelpers();
     const [rendered, setRendered] = useState('');
     const [mdComponents, setMdComponents] = useState({});
     const handlebars = useMemo(() => {
@@ -28,7 +29,7 @@ const HandlebarsMarkdown = ({ md, object = {}, disableLinks = false }) => {
         return instance;
     }, []);
     useEffect(() => {
-        helpers().forEach(helper => {
+        helpers.forEach(helper => {
             if (handlebars.helpers[helper.keyword] && !helper.componentCallback) {
                 return;
             }
@@ -50,7 +51,7 @@ const HandlebarsMarkdown = ({ md, object = {}, disableLinks = false }) => {
                 return helper.callback(...args);
             });
         });
-    }, [handlebars, mdComponents]);
+    }, [handlebars, helpers, mdComponents]);
     useEffect(() => {
         THROTTLER.debounce(async () => {
             try {

package/components/elements/display/handlebars/helpers.d.ts

@@ -6,4 +6,4 @@ export interface HowlerHelper {
     callback?: Handlebars.HelperDelegate;
     componentCallback?: (...args: any[]) => ReactElement | Promise<ReactElement>;
 }
-export declare const helpers: () => HowlerHelper[];
+export declare const useHelpers: () => HowlerHelper[];

package/components/elements/display/handlebars/helpers.js

@@ -8,138 +8,143 @@ import { flatten } from 'flat';
 import Handlebars from 'handlebars';
 import { capitalize, get, groupBy, isObject } from 'lodash-es';
 import howlerPluginStore from '@cccsaurora/howler-ui/plugins/store';
-import {} from 'react';
+import { useMemo } from 'react';
+import { usePluginStore } from 'react-pluggable';
 import JSONViewer from '../json/JSONViewer';
-export const helpers = () => [
-    {
-        keyword: 'equals',
-        documentation: 'Checks the equality of the string representation of the two arguments.',
-        callback: (arg1, arg2) => arg1?.toString() === arg2.toString()
-    },
-    {
-        keyword: 'and',
-        documentation: 'Runs the comparison `arg1 && arg2`, and returns the result.',
-        callback: (arg1, arg2) => arg1 && arg2
-    },
-    {
-        keyword: 'or',
-        documentation: 'Runs the comparison `arg1 || arg2`, and returns the result.',
-        callback: (arg1, arg2) => arg1 || arg2
-    },
-    { keyword: 'not', documentation: 'Runs the comparison `!arg`, and returns the result.', callback: arg => !arg },
-    {
-        keyword: 'curly',
-        documentation: 'Wraps the given argument in curly braces.',
-        callback: arg1 => new Handlebars.SafeString(`{{${arg1}}}`)
-    },
-    {
-        keyword: 'join',
-        documentation: 'Joins two string arguments with a given string `sep`, or the empty string as a default.',
-        callback: (arg1, arg2, context) => [arg1?.toString() ?? '', arg2?.toString() ?? ''].join(context.hash?.sep ?? '')
-    },
-    {
-        keyword: 'upper',
-        documentation: 'Returns the uppercase representation of a string argment.',
-        callback: (val) => val.toLocaleUpperCase()
-    },
-    {
-        keyword: 'lower',
-        documentation: 'Returns the lowercase representation of a string argment.',
-        callback: (val) => val.toLocaleLowerCase()
-    },
-    {
-        keyword: 'fetch',
-        documentation: 'Fetches the url provided and returns the given (flattened) key from the returned JSON object. Note that the result must be JSON!',
-        callback: async (url, key) => {
-            try {
-                const response = await fetch(url);
-                const json = await response.json();
-                return flatten(json)[key];
+export const useHelpers = () => {
+    const pluginStore = usePluginStore();
+    const allHelpers = useMemo(() => [
+        {
+            keyword: 'equals',
+            documentation: 'Checks the equality of the string representation of the two arguments.',
+            callback: (arg1, arg2) => arg1?.toString() === arg2.toString()
+        },
+        {
+            keyword: 'and',
+            documentation: 'Runs the comparison `arg1 && arg2`, and returns the result.',
+            callback: (arg1, arg2) => arg1 && arg2
+        },
+        {
+            keyword: 'or',
+            documentation: 'Runs the comparison `arg1 || arg2`, and returns the result.',
+            callback: (arg1, arg2) => arg1 || arg2
+        },
+        { keyword: 'not', documentation: 'Runs the comparison `!arg`, and returns the result.', callback: arg => !arg },
+        {
+            keyword: 'curly',
+            documentation: 'Wraps the given argument in curly braces.',
+            callback: arg1 => new Handlebars.SafeString(`{{${arg1}}}`)
+        },
+        {
+            keyword: 'join',
+            documentation: 'Joins two string arguments with a given string `sep`, or the empty string as a default.',
+            callback: (arg1, arg2, context) => [arg1?.toString() ?? '', arg2?.toString() ?? ''].join(context.hash?.sep ?? '')
+        },
+        {
+            keyword: 'upper',
+            documentation: 'Returns the uppercase representation of a string argment.',
+            callback: (val) => val.toLocaleUpperCase()
+        },
+        {
+            keyword: 'lower',
+            documentation: 'Returns the lowercase representation of a string argment.',
+            callback: (val) => val.toLocaleLowerCase()
+        },
+        {
+            keyword: 'fetch',
+            documentation: 'Fetches the url provided and returns the given (flattened) key from the returned JSON object. Note that the result must be JSON!',
+            callback: async (url, key) => {
+                try {
+                    const response = await fetch(url);
+                    const json = await response.json();
+                    return flatten(json)[key];
+                }
+                catch (e) {
+                    return '';
+                }
             }
-            catch (e) {
-                return '';
+        },
+        {
+            keyword: 'howler',
+            documentation: 'Given a howler hit ID, this helper renders a hit card for that ID.',
+            componentCallback: id => {
+                if (!id) {
+                    return _jsx(AppListEmpty, {});
+                }
+                return _jsx(HitCard, { id: id, layout: HitLayout.NORMAL });
             }
-        }
-    },
-    {
-        keyword: 'howler',
-        documentation: 'Given a howler hit ID, this helper renders a hit card for that ID.',
-        componentCallback: id => {
-            if (!id) {
-                return _jsx(AppListEmpty, {});
+        },
+        {
+            keyword: 'entries',
+            documentation: 'Given a dict, return an array of {key, value} objects.',
+            callback: obj => {
+                if (!isObject(obj)) {
+                    return new Handlebars.SafeString('Invalid Object.');
+                }
+                return Object.entries(obj).map(([key, value]) => ({ key, value }));
             }
-            return _jsx(HitCard, { id: id, layout: HitLayout.NORMAL });
-        }
-    },
-    {
-        keyword: 'entries',
-        documentation: 'Given a dict, return an array of {key, value} objects.',
-        callback: obj => {
-            if (!isObject(obj)) {
-                return new Handlebars.SafeString('Invalid Object.');
+        },
+        {
+            keyword: 'render_json',
+            documentation: 'Given a howler hit ID, this helper renders a hit card for that ID.',
+            componentCallback: data => {
+                if (!data) {
+                    return _jsx(AppListEmpty, {});
+                }
+                return _jsx(JSONViewer, { data: data });
             }
-            return Object.entries(obj).map(([key, value]) => ({ key, value }));
-        }
-    },
-    {
-        keyword: 'render_json',
-        documentation: 'Given a howler hit ID, this helper renders a hit card for that ID.',
-        componentCallback: data => {
-            if (!data) {
-                return _jsx(AppListEmpty, {});
+        },
+        {
+            keyword: 'to_json',
+            documentation: 'Convert any object into a JSON string.',
+            callback: obj => {
+                return new Handlebars.SafeString(JSON.stringify(obj));
             }
-            return _jsx(JSONViewer, { data: data });
-        }
-    },
-    {
-        keyword: 'to_json',
-        documentation: 'Convert any object into a JSON string.',
-        callback: obj => {
-            return new Handlebars.SafeString(JSON.stringify(obj));
-        }
-    },
-    {
-        keyword: 'parse_json',
-        documentation: 'Convert JSON string into and object.',
-        callback: str => {
-            return JSON.parse(str);
-        }
-    },
-    {
-        keyword: 'get',
-        documentation: 'Returns the given (flattened) key from the provided object.',
-        callback: async (data, key) => {
-            try {
-                return get(data, key);
+        },
+        {
+            keyword: 'parse_json',
+            documentation: 'Convert JSON string into and object.',
+            callback: str => {
+                return JSON.parse(str);
             }
-            catch (e) {
-                return '';
+        },
+        {
+            keyword: 'get',
+            documentation: 'Returns the given (flattened) key from the provided object.',
+            callback: async (data, key) => {
+                try {
+                    return get(data, key);
+                }
+                catch (e) {
+                    return '';
+                }
             }
-        }
-    },
-    {
-        keyword: 'includes',
-        documentation: 'Checks if field is in string',
-        callback: (arg1, arg2) => {
-            return !!arg2 && !!arg1?.includes(arg2);
-        }
-    },
-    {
-        keyword: 'table',
-        documentation: 'Render a table in markdown given an array of cells',
-        componentCallback: (cells) => {
-            const columns = Object.keys(groupBy(cells, 'column'));
-            const rows = groupBy(cells, 'row');
-            return (_jsx(Paper, { sx: { width: '95%', overflowX: 'auto', m: 1 }, children: _jsxs(Table, { children: [_jsx(TableHead, { children: _jsx(TableRow, { children: columns.map(col => (_jsx(TableCell, { sx: { maxWidth: '150px' }, children: col
-                                        .split(/[_-]/)
-                                        .map(word => capitalize(word))
-                                        .join(' ') }, col))) }) }), _jsx(TableBody, { sx: { '& td': { wordBreak: 'break-word' } }, children: Object.entries(rows).map(([rowId, _cells]) => {
-                                return (_jsx(TableRow, { children: columns.map(col => {
-                                        const cell = _cells.find(row => row.column === col);
-                                        return _jsx(TableCell, { children: cell?.value ?? 'N/A' }, col + cell?.value);
-                                    }) }, rowId));
-                            }) })] }) }));
-        }
-    },
-    ...howlerPluginStore.plugins.flatMap(plugin => howlerPluginStore.pluginStore.executeFunction(`${plugin}.helpers`))
-];
+        },
+        {
+            keyword: 'includes',
+            documentation: 'Checks if field is in string',
+            callback: (arg1, arg2) => {
+                return !!arg2 && !!arg1?.includes(arg2);
+            }
+        },
+        {
+            keyword: 'table',
+            documentation: 'Render a table in markdown given an array of cells',
+            componentCallback: (cells) => {
+                const columns = Object.keys(groupBy(cells, 'column'));
+                const rows = groupBy(cells, 'row');
+                return (_jsx(Paper, { sx: { width: '95%', overflowX: 'auto', m: 1 }, children: _jsxs(Table, { children: [_jsx(TableHead, { children: _jsx(TableRow, { children: columns.map(col => (_jsx(TableCell, { sx: { maxWidth: '150px' }, children: col
+                                            .split(/[_-]/)
+                                            .map(word => capitalize(word))
+                                            .join(' ') }, col))) }) }), _jsx(TableBody, { sx: { '& td': { wordBreak: 'break-word' } }, children: Object.entries(rows).map(([rowId, _cells]) => {
+                                    return (_jsx(TableRow, { children: columns.map(col => {
+                                            const cell = _cells.find(row => row.column === col);
+                                            return _jsx(TableCell, { children: cell?.value ?? 'N/A' }, col + cell?.value);
+                                        }) }, rowId));
+                                }) })] }) }));
+            }
+        },
+        ...howlerPluginStore.plugins.flatMap(plugin => pluginStore.executeFunction(`${plugin}.helpers`))
+    ], [pluginStore]);
+    return allHelpers;
+};

package/components/hooks/useMySitemap.js

@@ -1,7 +1,5 @@
 import { jsx as _jsx } from "react/jsx-runtime";
-import { Article, Book, Code, CreateNewFolder, Dashboard, Description, Edit, EditNote, FormatListBulleted, Help, Info, Key, PersonSearch, QueryStats, SavedSearch, Search, SettingsSuggest, Shield, Storage, Terminal, Topic, Work } from '@mui/icons-material';
-import PersonIcon from '@mui/icons-material/Person';
-import SettingsIcon from '@mui/icons-material/Settings';
+import { Article, Book, Code, CreateNewFolder, Dashboard, Description, Edit, EditNote, FormatListBulleted, Help, Info, Key, Person, PersonSearch, QueryStats, SavedSearch, Search, Settings, SettingsSuggest, Shield, Storage, Terminal, Topic, Work } from '@mui/icons-material';
 import { useMemo } from 'react';
 import { useTranslation } from 'react-i18next';
 // SiteMapContextProps configuration properties.
@@ -31,7 +29,7 @@ const useMySitemap = () => {
                 title: t('route.admin.user.details'),
                 isLeaf: true,
                 breadcrumbs: ['/admin/users'],
-                icon: _jsx(PersonIcon, {})
+                icon: _jsx(Person, {})
             },
             { path: '/help', title: t('route.help'), isRoot: true, icon: _jsx(Help, {}) },
             { path: '/help/api', title: t('route.help.api'), isLeaf: true, icon: _jsx(Storage, {}), breadcrumbs: ['/help'] },
@@ -209,7 +207,7 @@ const useMySitemap = () => {
                 icon: _jsx(Info, {})
             },
             { path: '/home', title: t('route.home'), isRoot: true, icon: _jsx(Dashboard, {}) },
-            { path: '/settings', title: t('page.settings.sitemap'), isRoot: true, icon: _jsx(SettingsIcon, {}) },
+            { path: '/settings', title: t('page.settings.sitemap'), isRoot: true, icon: _jsx(Settings, {}) },
             { path: '/advanced', title: t('route.advanced'), isRoot: true, icon: _jsx(Code, {}) }
         ]
     }), [t]);

package/components/routes/help/OverviewDocumentation.js

@@ -2,12 +2,12 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import PageCenter from '@cccsaurora/howler-ui/commons/components/pages/PageCenter';
 import HandlebarsMarkdown from '@cccsaurora/howler-ui/components/elements/display/HandlebarsMarkdown';
 import { useScrollRestoration } from '@cccsaurora/howler-ui/components/hooks/useScrollRestoration';
-import { useMemo } from 'react';
+import {} from 'react';
 import ErrorBoundary from '../ErrorBoundary';
-import { startingTemplate } from '../overviews/startingTemplate';
+import { useStartingTemplate } from '../overviews/startingTemplate';
 const OverviewDocumentation = () => {
     useScrollRestoration();
-    const template = useMemo(() => startingTemplate(), []);
+    const template = useStartingTemplate();
     return (_jsx(PageCenter, { margin: 4, width: "100%", textAlign: "left", children: _jsx(ErrorBoundary, { children: _jsx(HandlebarsMarkdown, { md: template }) }) }));
 };
 export default OverviewDocumentation;

package/components/routes/overviews/OverviewViewer.js

@@ -14,7 +14,7 @@ import { useSearchParams } from 'react-router-dom';
 import hitsData from '@cccsaurora/howler-ui/utils/hit.json';
 import { sanitizeLuceneQuery } from '@cccsaurora/howler-ui/utils/stringUtils';
 import OverviewEditor from './OverviewEditor';
-import { startingTemplate } from './startingTemplate';
+import { useStartingTemplate } from './startingTemplate';
 const OverviewViewer = () => {
     const theme = useTheme();
     const { t } = useTranslation();
@@ -34,6 +34,7 @@ const OverviewViewer = () => {
     const [x, setX] = useState(0);
     const analyticContext = useContext(AnalyticContext);
     const wrapper = useRef();
+    const startingTemplate = useStartingTemplate();
     useEffect(() => {
         (async () => {
             setLoading(true);
@@ -212,6 +213,6 @@ const OverviewViewer = () => {
                                     mt: -1,
                                     '& > *': { width: '100%' },
                                     '& > div > :first-child': { mt: 0 }
-                                }, children: _jsx(HitOverview, { content: content || startingTemplate(), hit: exampleHit }) })] }))] })] }));
+                                }, children: _jsx(HitOverview, { content: content || startingTemplate, hit: exampleHit }) })] }))] })] }));
 };
 export default OverviewViewer;

package/components/routes/overviews/startingTemplate.d.ts

@@ -1 +1 @@
-export declare const startingTemplate: () => string;
+export declare const useStartingTemplate: () => string;

package/components/routes/overviews/startingTemplate.js

@@ -1,6 +1,8 @@
-import { helpers } from '@cccsaurora/howler-ui/components/elements/display/handlebars/helpers';
-export const startingTemplate = () => {
-    const helperText = helpers()
+import { useHelpers } from '@cccsaurora/howler-ui/components/elements/display/handlebars/helpers';
+import { useMemo } from 'react';
+export const useStartingTemplate = () => {
+    const helpers = useHelpers();
+    const helperText = useMemo(() => helpers
         .map(helper => `
 ### \`${helper.keyword}\`
 
@@ -8,8 +10,8 @@ ${helper.documentation}
 
 ---
 `.trim())
-        .join('\n');
-    return `
+        .join('\n'), [helpers]);
+    return useMemo(() => `
 # Creating an Overview
 
 Overviews can be used to modify the way data is presented on alerts that match the overview's settings. Overviews are, by design, easy to create and quite flexible.
@@ -177,5 +179,5 @@ You can also make basic fetch requests for, and parse, JSON data from external s
 ## Full Helper List
 
 ${helperText}
-`;
+`, [helperText]);
 };

package/package.json

@@ -96,7 +96,7 @@
     "internal-slot": "1.0.7"
   },
   "type": "module",
-  "version": "2.12.0-dev.45",
+  "version": "2.12.0-dev.48",
   "exports": {
     "./i18n": "./i18n.js",
     "./index.css": "./index.css",

package/plugins/store.d.ts

@@ -6,7 +6,7 @@ export declare class HitEvent extends Event {
     constructor(type: string, hit: Hit);
 }
 declare class HowlerPluginStore {
-    pluginStore: import("react-pluggable").PluginStore;
+    private _pluginStore;
     plugins: string[];
     private _leadFormats;
     private _pivotFormats;
@@ -18,6 +18,7 @@ declare class HowlerPluginStore {
     get leadFormats(): string[];
     get pivotFormats(): string[];
     get operations(): string[];
+    get pluginStore(): import("react-pluggable").PluginStore;
 }
 declare const howlerPluginStore: HowlerPluginStore;
 export default howlerPluginStore;

package/plugins/store.js

@@ -7,7 +7,7 @@ export class HitEvent extends Event {
     }
 }
 class HowlerPluginStore {
-    pluginStore = createPluginStore();
+    _pluginStore = createPluginStore();
     plugins = [];
     _leadFormats = [];
     _pivotFormats = [];
@@ -47,6 +47,9 @@ class HowlerPluginStore {
     get operations() {
         return this._operations;
     }
+    get pluginStore() {
+        return this._pluginStore;
+    }
 }
 const howlerPluginStore = new HowlerPluginStore();
 export default howlerPluginStore;