@cccsaurora/howler-ui 2.16.0-dev.383 → 2.16.0-dev.390

package/components/routes/help/AuthDocumentation.js

@@ -4,12 +4,19 @@ import Markdown from '@cccsaurora/howler-ui/components/elements/display/Markdown
 import { useScrollRestoration } from '@cccsaurora/howler-ui/components/hooks/useScrollRestoration';
 import { useMemo } from 'react';
 import { useTranslation } from 'react-i18next';
+import howlerPluginStore from '@cccsaurora/howler-ui/plugins/store';
+import { usePluginStore } from 'react-pluggable';
+import { modifyDocumentation } from '@cccsaurora/howler-ui/utils/utils';
 import AUTH_EN from './markdown/en/authentication.md';
 import AUTH_FR from './markdown/fr/authentication.md';
 const AuthDocumentation = () => {
     const { i18n } = useTranslation();
+    const pluginStore = usePluginStore();
     useScrollRestoration();
-    const md = useMemo(() => (i18n.language === 'en' ? AUTH_EN : AUTH_FR).replace(/\$CURRENT_URL/g, window.location.origin), [i18n.language]);
+    const md = useMemo(() => {
+        let original = (i18n.language === 'en' ? AUTH_EN : AUTH_FR).replace(/\$CURRENT_URL/g, window.location.origin);
+        return modifyDocumentation(original, howlerPluginStore, pluginStore);
+    }, [i18n.language, pluginStore]);
     return (_jsx(PageCenter, { margin: 4, width: "100%", textAlign: "left", children: _jsx(Markdown, { md: md }) }));
 };
 export default AuthDocumentation;

package/components/routes/help/ClientDocumentation.js

@@ -4,12 +4,19 @@ import Markdown from '@cccsaurora/howler-ui/components/elements/display/Markdown
 import { useMemo } from 'react';
 import { useTranslation } from 'react-i18next';
 import { useScrollRestoration } from '@cccsaurora/howler-ui/components/hooks/useScrollRestoration';
+import howlerPluginStore from '@cccsaurora/howler-ui/plugins/store';
+import { usePluginStore } from 'react-pluggable';
+import { modifyDocumentation } from '@cccsaurora/howler-ui/utils/utils';
 import CLIENT_EN from './markdown/en/client.md';
 import CLIENT_FR from './markdown/fr/client.md';
 const ClientDocumentation = () => {
     const { i18n } = useTranslation();
+    const pluginStore = usePluginStore();
     useScrollRestoration();
-    const md = useMemo(() => (i18n.language === 'en' ? CLIENT_EN : CLIENT_FR).replace(/\$CURRENT_URL/g, window.location.origin), [i18n.language]);
+    const md = useMemo(() => {
+        let original = (i18n.language === 'en' ? CLIENT_EN : CLIENT_FR).replace(/\$CURRENT_URL/g, window.location.origin);
+        return modifyDocumentation(original, howlerPluginStore, pluginStore);
+    }, [i18n.language, pluginStore]);
     return (_jsx(PageCenter, { margin: 4, width: "100%", textAlign: "left", children: _jsx(Markdown, { md: md }) }));
 };
 export default ClientDocumentation;

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

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

package/components/routes/help/NotebookDocumentation.js

@@ -2,17 +2,25 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import PageCenter from '@cccsaurora/howler-ui/commons/components/pages/PageCenter';
 import Markdown from '@cccsaurora/howler-ui/components/elements/display/Markdown';
 import { useScrollRestoration } from '@cccsaurora/howler-ui/components/hooks/useScrollRestoration';
+import howlerPluginStore from '@cccsaurora/howler-ui/plugins/store';
+import { useMemo } from 'react';
 import { useTranslation } from 'react-i18next';
+import { usePluginStore } from 'react-pluggable';
+import { modifyDocumentation } from '@cccsaurora/howler-ui/utils/utils';
 import NOTEBOOK_EN from './markdown/en/notebook.md';
 import NOTEBOOK_FR from './markdown/fr/notebook.md';
 const NotebookDocumentation = () => {
     const { i18n } = useTranslation();
+    const pluginStore = usePluginStore();
     useScrollRestoration();
-    const markdown = (i18n.language === 'en' ? NOTEBOOK_EN : NOTEBOOK_FR)
-        .replaceAll('$NBGALLERY_URL', window.location.host.startsWith('localhost')
-        ? 'https://nbgallery.dev.analysis.cyber.gc.ca'
-        : window.location.origin.replace(/howler(-stg)/, 'nbgallery'))
-        .replaceAll('$CURRENT_URL', window.location.origin);
-    return (_jsx(PageCenter, { margin: 4, width: "100%", textAlign: "left", children: _jsx(Markdown, { md: markdown }) }));
+    const md = useMemo(() => {
+        let markdown = (i18n.language === 'en' ? NOTEBOOK_EN : NOTEBOOK_FR)
+            .replaceAll('$NBGALLERY_URL', window.location.host.startsWith('localhost')
+            ? 'https://nbgallery.dev.analysis.cyber.gc.ca'
+            : window.location.origin.replace(/howler(-stg)/, 'nbgallery'))
+            .replaceAll('$CURRENT_URL', window.location.origin);
+        return modifyDocumentation(markdown, howlerPluginStore, pluginStore);
+    }, [i18n.language, pluginStore]);
+    return (_jsx(PageCenter, { margin: 4, width: "100%", textAlign: "left", children: _jsx(Markdown, { md: md }) }));
 };
 export default NotebookDocumentation;

package/components/routes/help/RetentionDocumentation.js

@@ -9,14 +9,21 @@ import api from '@cccsaurora/howler-ui/api';
 import { ApiConfigContext } from '@cccsaurora/howler-ui/components/app/providers/ApiConfigProvider';
 import HitCard from '@cccsaurora/howler-ui/components/elements/hit/HitCard';
 import { HitLayout } from '@cccsaurora/howler-ui/components/elements/hit/HitLayout';
+import howlerPluginStore from '@cccsaurora/howler-ui/plugins/store';
+import { usePluginStore } from 'react-pluggable';
+import { modifyDocumentation } from '@cccsaurora/howler-ui/utils/utils';
 import AUTH_EN from './markdown/en/retention.md';
 import AUTH_FR from './markdown/fr/retention.md';
 const RetentionDocumentation = () => {
     const { i18n } = useTranslation();
     const { config } = useContext(ApiConfigContext);
+    const pluginStore = usePluginStore();
     useScrollRestoration();
     const [hitId, setHitId] = useState();
-    const md = useMemo(() => (i18n.language === 'en' ? AUTH_EN : AUTH_FR).replace(/\$CURRENT_URL/g, window.location.origin), [i18n.language]);
+    const md = useMemo(() => {
+        let original = (i18n.language === 'en' ? AUTH_EN : AUTH_FR).replace(/\$CURRENT_URL/g, window.location.origin);
+        return modifyDocumentation(original, howlerPluginStore, pluginStore);
+    }, [i18n.language, pluginStore]);
     useEffect(() => {
         api.search.hit
             .post({

package/components/routes/help/TemplateDocumentation.js

@@ -6,8 +6,11 @@ import { HitLayout } from '@cccsaurora/howler-ui/components/elements/hit/HitLayo
 import DefaultOutline from '@cccsaurora/howler-ui/components/elements/hit/outlines/DefaultOutline';
 import { useScrollRestoration } from '@cccsaurora/howler-ui/components/hooks/useScrollRestoration';
 import dayjs from 'dayjs';
+import howlerPluginStore from '@cccsaurora/howler-ui/plugins/store';
 import { useMemo } from 'react';
 import { useTranslation } from 'react-i18next';
+import { usePluginStore } from 'react-pluggable';
+import { modifyDocumentation } from '@cccsaurora/howler-ui/utils/utils';
 import TEMPLATES_EN from './markdown/en/templates.md';
 import TEMPLATES_FR from './markdown/fr/templates.md';
 const ALERTS = [
@@ -32,6 +35,7 @@ const ALERTS = [
 ];
 const TemplateDocumentation = () => {
     const { i18n } = useTranslation();
+    const pluginStore = usePluginStore();
     useScrollRestoration();
     const [md1, md2] = useMemo(() => {
         let markdown = i18n.language === 'en' ? TEMPLATES_EN : TEMPLATES_FR;
@@ -39,8 +43,8 @@ const TemplateDocumentation = () => {
         ALERTS.forEach((alert, index) => {
             markdown = markdown.replace(`$ALERT_${index + 1}`, JSON.stringify(alert, null, 2));
         });
-        return markdown.split('\n===SPLIT===\n');
-    }, [i18n.language]);
+        return modifyDocumentation(markdown.split('\n===SPLIT===\n'), howlerPluginStore, pluginStore);
+    }, [i18n.language, pluginStore]);
     return (_jsxs(PageCenter, { margin: 4, width: "100%", textAlign: "left", children: [_jsx(Markdown, { md: md1 }), _jsx(Stack, { spacing: 1, children: ALERTS.map(alert => (_jsx(Card, { variant: "outlined", children: _jsx(CardContent, { children: _jsx(DefaultOutline, { hit: alert, fields: Object.keys(alert).flatMap(key => Object.keys(alert[key]).map(key2 => [key, key2].join('.'))), layout: HitLayout.NORMAL, readonly: true }) }) }, alert.howler.id))) }), _jsx(Markdown, { md: md2 })] }));
 };
 export default TemplateDocumentation;

package/components/routes/help/ViewDocumentation.js

@@ -3,14 +3,21 @@ import { Search } from '@mui/icons-material';
 import PageCenter from '@cccsaurora/howler-ui/commons/components/pages/PageCenter';
 import Markdown from '@cccsaurora/howler-ui/components/elements/display/Markdown';
 import { useScrollRestoration } from '@cccsaurora/howler-ui/components/hooks/useScrollRestoration';
+import howlerPluginStore from '@cccsaurora/howler-ui/plugins/store';
 import { useMemo } from 'react';
 import { useTranslation } from 'react-i18next';
+import { modifyDocumentation } from '@cccsaurora/howler-ui/utils/utils';
+import { usePluginStore } from 'react-pluggable';
 import VIEWS_EN from './markdown/en/views.md';
 import VIEWS_FR from './markdown/fr/views.md';
 const ViewDocumentation = () => {
     const { i18n } = useTranslation();
+    const pluginStore = usePluginStore();
     useScrollRestoration();
-    const md = useMemo(() => (i18n.language === 'en' ? VIEWS_EN : VIEWS_FR).replace(/\$CURRENT_URL/g, window.location.origin), [i18n.language]);
+    const md = useMemo(() => {
+        let original = (i18n.language === 'en' ? VIEWS_EN : VIEWS_FR).replace(/\$CURRENT_URL/g, window.location.origin);
+        return modifyDocumentation(original, howlerPluginStore, pluginStore);
+    }, [i18n.language, pluginStore]);
     return (_jsx(PageCenter, { margin: 4, width: "100%", textAlign: "left", children: _jsx(Markdown, { md: md, components: {
                 search: _jsx(Search, { fontSize: "inherit" })
             } }) }));

package/package.json

@@ -37,7 +37,7 @@
     "handlebars-async-helpers": "^1.0.6",
     "i18next": "^23.16.8",
     "i18next-browser-languagedetector": "^7.2.2",
-    "lodash-es": "^4.17.21",
+    "lodash-es": "^4.17.23",
     "md5": "^2.3.0",
     "mermaid": "^11.10.0",
     "monaco-editor": "^0.49.0",
@@ -51,7 +51,7 @@
     "react-markdown": "^10.1.0",
     "react-pluggable": "^0.4.3",
     "react-resize-detector": "^9.1.1",
-    "react-router": "^6.30.3",
+    "react-router": "^7.12.0",
     "react-router-dom": "^6.30.1",
     "react-syntax-highlighter": "^15.6.1",
     "rehype-raw": "^7.0.0",
@@ -96,7 +96,7 @@
     "internal-slot": "1.0.7"
   },
   "type": "module",
-  "version": "2.16.0-dev.383",
+  "version": "2.16.0-dev.390",
   "exports": {
     "./i18n": "./i18n.js",
     "./index.css": "./index.css",

package/plugins/HowlerPlugin.d.ts

@@ -111,5 +111,6 @@ declare abstract class HowlerPlugin implements IPlugin {
     help(): React.ReactNode;
     settings(_section: 'admin' | 'local' | 'profile' | 'security'): React.ReactNode;
     integrations(): [string, () => React.ReactNode][];
+    documentation(md: string): string;
 }
 export default HowlerPlugin;

package/plugins/HowlerPlugin.js

@@ -269,5 +269,8 @@ class HowlerPlugin {
     integrations() {
         return [];
     }
+    documentation(md) {
+        return md;
+    }
 }
 export default HowlerPlugin;

package/utils/utils.d.ts

@@ -30,4 +30,5 @@ export declare const flattenDeep: (data: {
 }) => {
     [index: string]: any;
 };
+export declare const modifyDocumentation: (original: string, howlerPluginStore: any, pluginStore: any) => string;
 export {};

package/utils/utils.js

@@ -178,3 +178,9 @@ export const flattenDeep = (data) => {
     });
     return final;
 };
+export const modifyDocumentation = (original, howlerPluginStore, pluginStore) => {
+    for (const plugin of howlerPluginStore.plugins) {
+        original = pluginStore.executeFunction(`${plugin}.documentation`, original);
+    }
+    return original;
+};