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

package/commons/components/utils/hooks/useEnv.js

@@ -1,11 +0,0 @@
-import { useMemo } from 'react';
-// @ts-ignore
-const APP_ENV = process.env;
-export default function useAppEnv(key) {
-    return useMemo(() => {
-        if (key) {
-            return APP_ENV[key];
-        }
-        return APP_ENV;
-    }, [key]);
-}

package/commons/components/utils/hooks/useFullscreenStatus.d.ts

@@ -1,2 +0,0 @@
-import { type MutableRefObject } from 'react';
-export default function useFullscreenStatus(elRef: MutableRefObject<any>): [boolean, () => void];

package/commons/components/utils/hooks/useFullscreenStatus.js

@@ -1,41 +0,0 @@
-import { useCallback, useLayoutEffect, useMemo, useState } from 'react';
-const getBrowserFullscreenElementProp = () => {
-    if (typeof document.fullscreenElement !== 'undefined') {
-        return 'fullscreenElement';
-    }
-    // eslint-disable-next-line @typescript-eslint/dot-notation
-    if (typeof document['mozFullScreenElement'] !== 'undefined') {
-        return 'mozFullScreenElement';
-    }
-    // eslint-disable-next-line @typescript-eslint/dot-notation
-    if (typeof document['msFullscreenElement'] !== 'undefined') {
-        return 'msFullscreenElement';
-    }
-    // eslint-disable-next-line @typescript-eslint/dot-notation
-    if (typeof document['webkitFullscreenElement'] !== 'undefined') {
-        return 'webkitFullscreenElement';
-    }
-    throw new Error('fullscreenElement is not supported by this browser');
-};
-export default function useFullscreenStatus(elRef) {
-    const [isFullscreen, setIsFullscreen] = useState(document[getBrowserFullscreenElementProp()] != null);
-    const setFullscreen = useCallback(() => {
-        if (elRef.current == null)
-            return;
-        elRef.current
-            .requestFullscreen()
-            .then(() => {
-            setIsFullscreen(document[getBrowserFullscreenElementProp()] != null);
-        })
-            .catch(() => {
-            setIsFullscreen(false);
-        });
-    }, [elRef]);
-    useLayoutEffect(() => {
-        document.onfullscreenchange = () => setIsFullscreen(document[getBrowserFullscreenElementProp()] != null);
-        return () => {
-            document.onfullscreenchange = undefined;
-        };
-    });
-    return useMemo(() => [isFullscreen, setFullscreen], [isFullscreen, setFullscreen]);
-}

package/commons/components/utils/hooks/useGravatar.d.ts

@@ -1,2 +0,0 @@
-declare const useGravatar: (email: string) => string;
-export default useGravatar;

package/commons/components/utils/hooks/useGravatar.js

@@ -1,9 +0,0 @@
-import { useMemo } from 'react';
-import md5 from 'md5';
-const useGravatar = (email) => useMemo(() => {
-    if (email !== null) {
-        return `https://s.gravatar.com/avatar/${md5(email)}?d=404`;
-    }
-    return null;
-}, [email]);
-export default useGravatar;

package/commons/components/utils/hooks/useLocalStorage.d.ts

@@ -1,12 +0,0 @@
-export default function useLocalStorage(prefix?: string): {
-    get: <T>(key: string) => T;
-    set: (key: string, value: any) => void;
-    remove: (key: string, withPrefix?: boolean) => void;
-    has: (key: string) => boolean;
-    keys: () => string[];
-    items: () => {
-        key: string;
-        value: unknown;
-    }[];
-    clear: () => void;
-};

package/commons/components/utils/hooks/useLocalStorage.js

@@ -1,52 +0,0 @@
-import { useCallback, useMemo } from 'react';
-export default function useLocalStorage(prefix) {
-    // Build the name of the key.
-    // If a 'prefix' was specified, the 'key' will be appended to the 'prefix' automatically.
-    const _buildKey = useCallback((name) => (prefix ? `${prefix}.${name}` : name), [prefix]);
-    // Get an item from local storage.
-    // If a 'prefix' was specified, the 'key' will be appended to the 'prefix' automatically.
-    const get = useCallback((key) => {
-        try {
-            return JSON.parse(localStorage.getItem(_buildKey(key)));
-        }
-        catch (e) {
-            return null;
-        }
-    }, [_buildKey]);
-    // Set an item to local storage.
-    // If a 'prefix' was specified, the 'key' will be appended to the 'prefix' automatically.
-    const set = useCallback((key, value) => localStorage.setItem(_buildKey(key), JSON.stringify(value)), [_buildKey]);
-    // Remove an item from local storage.
-    // If a 'prefix' was specified, the 'key' will be appended to the 'prefix' automatically.
-    const remove = useCallback((key, withPrefix = false) => localStorage.removeItem(withPrefix ? key : _buildKey(key)), [_buildKey]);
-    // Indicates if the local storage has an item with the specified key.
-    // If a 'prefix' was specified, the 'key' will be appended to the 'prefix' automatically.
-    const has = useCallback((key) => get(key) !== null, [get]);
-    // Get all the keys in the local storage.
-    const keys = useCallback(() => Object.keys(localStorage), []);
-    // Get the local storage items {key: string, value: any}.
-    // If a 'prefix' key was specified, it will return the items that have a key starting with the prefix.
-    // If no 'prefix' was specified, it will return all items.
-    const items = useCallback(() => keys().map(k => ({ key: k, value: get(k) })), [get, keys]);
-    // Clear all local storage.
-    // If a 'prefix' key was specified, it will only clear/remove the items that start with that key.
-    // If no 'prefix' key was specified, it will clear/remove all of them.
-    const clear = useCallback(() => keys().forEach(key => {
-        if (prefix && key.startsWith(prefix)) {
-            remove(key, true);
-        }
-        else if (!prefix) {
-            remove(key);
-        }
-    }), [prefix, remove, keys]);
-    // Return memoized object to prevent unecessary renders.
-    return useMemo(() => ({
-        get,
-        set,
-        remove,
-        has,
-        keys,
-        items,
-        clear
-    }), [get, set, remove, has, keys, items, clear]);
-}

package/commons/components/utils/hooks/useLocalStorageItem.d.ts

@@ -1,14 +0,0 @@
-/**
- * This hooks backs the typical 'useState' hook with local storage.
- *
- * This means that it will initialize with the value stored in local storage.
- *
- * State changes are also persisted to local storage.
- *
- * All this ensures the state is preserved across inializations.
- *
- * @param key - local storage key under which to store the state.
- * @param initialValue - local storage initialization value.
- * @returns a stateful value, a function to update it, and a function to remove it.
- */
-export default function useLocalStorageItem<T>(key: string, initialValue?: T): [T, (value: T) => void, () => void];

package/commons/components/utils/hooks/useLocalStorageItem.js

@@ -1,39 +0,0 @@
-import useLocalStorage from '@cccsaurora/howler-ui/commons/components/utils/hooks/useLocalStorage';
-import { useEffect, useMemo, useState } from 'react';
-/**
- * This hooks backs the typical 'useState' hook with local storage.
- *
- * This means that it will initialize with the value stored in local storage.
- *
- * State changes are also persisted to local storage.
- *
- * All this ensures the state is preserved across inializations.
- *
- * @param key - local storage key under which to store the state.
- * @param initialValue - local storage initialization value.
- * @returns a stateful value, a function to update it, and a function to remove it.
- */
-export default function useLocalStorageItem(key, initialValue) {
-    const { get, set, has, remove } = useLocalStorage();
-    const [value, setValue] = useState(get(key) ?? initialValue);
-    useEffect(() => {
-        if (initialValue !== null && initialValue !== undefined && !has(key)) {
-            set(key, initialValue);
-        }
-    }, [key, initialValue, has, set]);
-    return useMemo(() => [
-        value,
-        (newValue, save = true) => {
-            if (save) {
-                if (newValue !== undefined) {
-                    set(key, newValue);
-                }
-                else {
-                    remove(key);
-                }
-            }
-            setValue(newValue);
-        },
-        () => remove(key)
-    ], [key, value, set, remove]);
-}

package/commons/components/utils/hooks/useThemeBuilder.d.ts

@@ -1,7 +0,0 @@
-import { type Components, type PaletteOptions, type Theme } from '@mui/material';
-import type { AppThemeConfigs } from '@cccsaurora/howler-ui/commons/components/app/AppConfigs';
-export declare const createTuiTheme: (components: Components<Omit<Theme, '@cccsaurora/howler-ui/components'>>, palette: PaletteOptions) => Theme;
-export default function useThemeBuilder(theme?: AppThemeConfigs): {
-    darkTheme: Theme;
-    lightTheme: Theme;
-};

package/commons/components/utils/hooks/useThemeBuilder.js

@@ -1,48 +0,0 @@
-import { createTheme } from '@mui/material';
-import { AppDefaultsThemeConfigs } from '@cccsaurora/howler-ui/commons/components/app/AppDefaults';
-import { useMemo } from 'react';
-export const createTuiTheme = (components, palette) => createTheme({
-    components: {
-        ...components,
-        MuiCssBaseline: {
-            ...(components?.MuiCssBaseline || {}),
-            styleOverrides: {
-                ...(components.MuiCssBaseline?.styleOverrides || {}),
-                html: {
-                    width: '100%',
-                    height: '100%'
-                },
-                body: {
-                    width: '100%',
-                    height: '100%'
-                },
-                '#root': {
-                    position: 'absolute',
-                    top: 0,
-                    left: 0,
-                    right: 0,
-                    bottom: 0
-                }
-            }
-        },
-        MuiUseMediaQuery: {
-            ...(components.MuiUseMediaQuery || {}),
-            defaultProps: {
-                noSsr: true
-            }
-        }
-    },
-    palette
-});
-export default function useThemeBuilder(theme = AppDefaultsThemeConfigs) {
-    return useMemo(() => ({
-        darkTheme: createTuiTheme(theme.components || {}, {
-            mode: 'dark',
-            ...(theme?.palette?.dark || {})
-        }),
-        lightTheme: createTuiTheme(theme.components || {}, {
-            mode: 'light',
-            ...(theme?.palette?.light || {})
-        })
-    }), [theme]);
-}

package/commons/components/utils/keyboard.d.ts

@@ -1,30 +0,0 @@
-import { type KeyboardEvent } from 'react';
-export declare const ENTER = "Enter";
-export declare const ESCAPE = "Escape";
-export declare const ARROW_LEFT = "ArrowLeft";
-export declare const ARROW_UP = "ArrowUp";
-export declare const ARROW_RIGHT = "ArrowRight";
-export declare const ARROW_DOWN = "ArrowDown";
-export declare const BACKSPACE = "Backspace";
-export declare const SPACE = " ";
-export declare function is(key: string, check: string): boolean;
-export declare function isArrowUp(key: string): boolean;
-export declare function isArrowDown(key: string): boolean;
-export declare function isArrowLeft(key: string): boolean;
-export declare function isArrowRight(key: string): boolean;
-export declare function isEscape(key: string): boolean;
-export declare function isEnter(key: string): boolean;
-export declare function isBackspace(key: string): boolean;
-export declare function isSpace(key: string): boolean;
-export declare function parseEvent(event: KeyboardEvent<HTMLElement>): {
-    key: string;
-    isCtrl: boolean;
-    isEnter: boolean;
-    isSpace: boolean;
-    isBackspace: boolean;
-    isEscape: boolean;
-    isArrowLeft: boolean;
-    isArrowRight: boolean;
-    isArrowUp: boolean;
-    isArrowDown: boolean;
-};

package/commons/components/utils/keyboard.js

@@ -1,50 +0,0 @@
-import {} from 'react';
-export const ENTER = 'Enter';
-export const ESCAPE = 'Escape';
-export const ARROW_LEFT = 'ArrowLeft';
-export const ARROW_UP = 'ArrowUp';
-export const ARROW_RIGHT = 'ArrowRight';
-export const ARROW_DOWN = 'ArrowDown';
-export const BACKSPACE = 'Backspace';
-export const SPACE = ' ';
-export function is(key, check) {
-    return key === check;
-}
-export function isArrowUp(key) {
-    return is(key, ARROW_UP);
-}
-export function isArrowDown(key) {
-    return is(key, ARROW_DOWN);
-}
-export function isArrowLeft(key) {
-    return is(key, ARROW_LEFT);
-}
-export function isArrowRight(key) {
-    return is(key, ARROW_RIGHT);
-}
-export function isEscape(key) {
-    return is(key, ESCAPE);
-}
-export function isEnter(key) {
-    return is(key, ENTER);
-}
-export function isBackspace(key) {
-    return is(key, BACKSPACE);
-}
-export function isSpace(key) {
-    return is(key, SPACE);
-}
-export function parseEvent(event) {
-    return {
-        key: event.key,
-        isCtrl: event.ctrlKey,
-        isEnter: isEnter(event.key),
-        isSpace: isSpace(event.key),
-        isBackspace: isBackspace(event.key),
-        isEscape: isEscape(event.key),
-        isArrowLeft: isArrowLeft(event.key),
-        isArrowRight: isArrowRight(event.key),
-        isArrowUp: isArrowUp(event.key),
-        isArrowDown: isArrowDown(event.key)
-    };
-}

package/components/hooks/useMySitemap.d.ts

@@ -1,3 +0,0 @@
-import type { AppSiteMapConfigs } from '@cccsaurora/howler-ui/commons/components/app/AppConfigs';
-declare const useMySitemap: () => AppSiteMapConfigs;
-export default useMySitemap;

package/components/hooks/useMySitemap.js

@@ -1,219 +0,0 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-import { Article, Book, BookRounded, 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 howlerPluginStore from '@cccsaurora/howler-ui/plugins/store';
-import { useMemo } from 'react';
-import { useTranslation } from 'react-i18next';
-// SiteMapContextProps configuration properties.
-// exceptLast: boolean = false (default) -> render all breadcrumb except the current route.
-// allLinks: boolean = false (default) -> render all breadcrumbs as links.
-// lastOnly: boolean = false (default) -> only render the current route.
-// itemsBefore: number = 1 (default) -> the number of items to show before the ellipsis.
-// itemsAfter: number = 1 (default) -> the number of items to show after the ellipsis.
-// routes: SiteMapRoute[] = [] (default) -> the list of routes that will define the application sitemap.
-// For each individual SiteMapRoute:
-// path: string -> the react router path to this route.
-// title: string -> the title/lable to display in breadcrumbs for this route.
-// icon?: React.ReactNode -> the icon component to show beside the title/lable.
-// isRoot?: boolean = false -> when true, indicates that the breadcrumbs will reset to this one path each time it is encountered.
-// isLeaf?: boolean = false -> when true, indicates that this path does not aggregate in breadcrumbs, i.e. will be replaced by next path.
-// excluded?: boolean = false -> when true, indicates to breadcrumbs component to not render this route.
-// breadcrumbs?: string[] -> a static list of breadcrumb paths to be rendered for the given route.
-// textWidth?: number -> the max width of the text when rendering the breadcrumb.
-const useMySitemap = () => {
-    const { t } = useTranslation();
-    return useMemo(() => ({
-        routes: [
-            { path: '/', title: t('route.home'), isRoot: true, icon: _jsx(Dashboard, {}) },
-            { path: '/cases', title: t('route.cases'), isRoot: true, icon: _jsx(BookRounded, {}) },
-            { path: '/cases/:id/*', title: t('route.cases.view'), isLeaf: true, breadcrumbs: ['/cases'] },
-            { path: '/admin/users', title: t('route.admin.user.search'), isRoot: true, icon: _jsx(PersonSearch, {}) },
-            {
-                path: '/admin/users/:id',
-                title: t('route.admin.user.details'),
-                isLeaf: true,
-                breadcrumbs: ['/admin/users'],
-                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'] },
-            { path: '/help/search', title: t('route.help.search'), isLeaf: true, icon: _jsx(Search, {}), breadcrumbs: ['/help'] },
-            {
-                path: '/help/client',
-                title: t('route.help.client'),
-                isLeaf: true,
-                icon: _jsx(Terminal, {}),
-                breadcrumbs: ['/help']
-            },
-            { path: '/help/auth', title: t('route.help.auth'), isLeaf: true, icon: _jsx(Key, {}), breadcrumbs: ['/help'] },
-            {
-                path: '/help/actions',
-                title: t('route.help.actions'),
-                isLeaf: true,
-                icon: _jsx(SettingsSuggest, {}),
-                breadcrumbs: ['/help']
-            },
-            { path: '/help/hit', title: t('route.help.hit'), isLeaf: true, icon: _jsx(Shield, {}), breadcrumbs: ['/help'] },
-            {
-                path: '/help/templates',
-                title: t('route.help.templates'),
-                isLeaf: true,
-                icon: _jsx(FormatListBulleted, {}),
-                breadcrumbs: ['/help']
-            },
-            {
-                path: '/help/overviews',
-                title: t('route.help.overviews'),
-                isLeaf: true,
-                icon: _jsx(Article, {}),
-                breadcrumbs: ['/help']
-            },
-            {
-                path: '/help/views',
-                title: t('route.help.views'),
-                isLeaf: true,
-                icon: _jsx(SavedSearch, {}),
-                breadcrumbs: ['/help']
-            },
-            {
-                path: '/help/retention',
-                title: t('route.help.retention'),
-                isLeaf: true,
-                icon: _jsx(Book, {}),
-                breadcrumbs: ['/help']
-            },
-            {
-                path: '/help/notebook',
-                title: t('route.help.notebook'),
-                isLeaf: true,
-                icon: _jsx(Description, {}),
-                breadcrumbs: ['/help']
-            },
-            { path: '/hits', title: t('route.hits'), isRoot: true, icon: _jsx(Search, {}) },
-            { path: '/search', title: t('route.search'), isRoot: true, icon: _jsx(Search, {}) },
-            { path: '/views', title: t('route.views'), isRoot: true, icon: _jsx(SavedSearch, {}) },
-            { path: '/views/create', title: t('route.views.create'), isRoot: true, icon: _jsx(SavedSearch, {}) },
-            {
-                path: '/views/:id',
-                title: t('route.views.show'),
-                isRoot: true,
-                icon: _jsx(SavedSearch, {})
-            },
-            {
-                path: '/views/:id/edit',
-                title: t('route.views.edit'),
-                isLeaf: true,
-                breadcrumbs: ['/views'],
-                icon: _jsx(Edit, {})
-            },
-            {
-                path: '/bundles/:id',
-                title: t('route.hits.bundle'),
-                isLeaf: true,
-                icon: _jsx(Work, {})
-            },
-            {
-                path: '/hits/:id',
-                title: t('route.hits.view'),
-                isLeaf: true,
-                breadcrumbs: ['/hits'],
-                icon: _jsx(Info, {})
-            },
-            {
-                path: '/templates',
-                title: t('route.templates'),
-                isRoot: true,
-                icon: _jsx(FormatListBulleted, {})
-            },
-            {
-                path: '/overviews',
-                title: t('route.overviews'),
-                isRoot: true,
-                icon: _jsx(Article, {})
-            },
-            {
-                path: '/dossiers',
-                title: t('route.dossiers'),
-                isRoot: true,
-                icon: _jsx(Topic, {})
-            },
-            {
-                path: '/dossiers/create',
-                title: t('route.dossiers.create'),
-                isRoot: true,
-                breadcrumbs: ['/dossiers'],
-                icon: _jsx(CreateNewFolder, {})
-            },
-            {
-                path: '/dossiers/:id/edit',
-                title: t('route.dossiers.edit'),
-                isLeaf: true,
-                breadcrumbs: ['/dossiers'],
-                icon: _jsx(Edit, {})
-            },
-            {
-                path: '/templates/view',
-                title: t('route.templates.view'),
-                breadcrumbs: ['/templates'],
-                isLeaf: true,
-                icon: _jsx(FormatListBulleted, {})
-            },
-            {
-                path: '/overviews/view',
-                title: t('route.overviews.view'),
-                breadcrumbs: ['/overviews'],
-                isLeaf: true,
-                icon: _jsx(Article, {})
-            },
-            {
-                path: '/analytics',
-                title: t('route.analytics'),
-                isRoot: true,
-                icon: _jsx(QueryStats, {})
-            },
-            {
-                path: '/action',
-                title: t('route.actions'),
-                isRoot: true,
-                icon: _jsx(Terminal, {})
-            },
-            {
-                path: '/action/integrations',
-                title: t('route.integrations'),
-                isRoot: true,
-                breadcrumbs: ['/action']
-            },
-            {
-                path: '/action/execute',
-                title: t('route.actions.create'),
-                isRoot: true,
-                breadcrumbs: ['/action'],
-                icon: _jsx(EditNote, {})
-            },
-            {
-                path: '/action/:id',
-                title: t('route.actions.view'),
-                isRoot: true,
-                breadcrumbs: ['/action']
-            },
-            {
-                path: '/action/:id/edit',
-                title: t('route.actions.edit'),
-                isRoot: true,
-                breadcrumbs: ['/action'],
-                icon: _jsx(Edit, {})
-            },
-            {
-                path: '/analytics/:id',
-                title: t('route.analytics.view'),
-                isLeaf: true,
-                breadcrumbs: ['/analytics'],
-                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(Settings, {}) },
-            { path: '/advanced', title: t('route.advanced'), isRoot: true, icon: _jsx(Code, {}) },
-            ...howlerPluginStore.sitemaps
-        ]
-    }), [t]);
-};
-export default useMySitemap;