@j2inn/fin5-ui-utils 5.2.2-beta.9 → 6.0.0

package/dist/react/components/navigation/MenuPage.js

@@ -1,37 +1,37 @@
-"use strict";
-/*
- * Copyright (c) 2022, J2 Innovations. All Rights Reserved
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAllSubPages = exports.pageTreeToPageList = exports.findPageByName = void 0;
-/**
- * Retrieve a specific page or subPage from a root page list
- * @param name the name of the searched page
- * @param pages the list of root pages
- */
-function findPageByName(pages, name) {
-    return pageTreeToPageList(pages).find((page) => page.key === name && !page.disabled);
-}
-exports.findPageByName = findPageByName;
-/**
- * Expands the list of pages to include all the subpages
- */
-function pageTreeToPageList(pages) {
-    return pages.flatMap((page) => getAllSubPages(page));
-}
-exports.pageTreeToPageList = pageTreeToPageList;
-/**
- * Recursively get all the subPages of a root page
- * @param page root page
- * @returns the whole tree of subPages as a list
- */
-function getAllSubPages(page) {
-    if (page.children) {
-        return [page].concat(...page.children.map((subPage) => getAllSubPages(subPage)));
-    }
-    else {
-        return [page];
-    }
-}
-exports.getAllSubPages = getAllSubPages;
+"use strict";
+/*
+ * Copyright (c) 2022, J2 Innovations. All Rights Reserved
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllSubPages = exports.pageTreeToPageList = exports.findPageByName = void 0;
+/**
+ * Retrieve a specific page or subPage from a root page list
+ * @param name the name of the searched page
+ * @param pages the list of root pages
+ */
+function findPageByName(pages, name) {
+    return pageTreeToPageList(pages).find((page) => page.key === name && !page.disabled);
+}
+exports.findPageByName = findPageByName;
+/**
+ * Expands the list of pages to include all the subpages
+ */
+function pageTreeToPageList(pages) {
+    return pages.flatMap((page) => getAllSubPages(page));
+}
+exports.pageTreeToPageList = pageTreeToPageList;
+/**
+ * Recursively get all the subPages of a root page
+ * @param page root page
+ * @returns the whole tree of subPages as a list
+ */
+function getAllSubPages(page) {
+    if (page.children) {
+        return [page].concat(...page.children.map((subPage) => getAllSubPages(subPage)));
+    }
+    else {
+        return [page];
+    }
+}
+exports.getAllSubPages = getAllSubPages;
 //# sourceMappingURL=MenuPage.js.map

package/dist/react/components/navigation/MenuTrigger.d.ts

@@ -1,9 +1,9 @@
-import React from 'react';
-interface MenuTriggerProps {
-    hiddenSider: boolean;
-    headerHeight?: number;
-    className?: string;
-    onClick: () => void;
-}
-declare const MenuTrigger: React.FC<MenuTriggerProps>;
-export default MenuTrigger;
+import React from 'react';
+interface MenuTriggerProps {
+    hiddenSider: boolean;
+    headerHeight?: number;
+    className?: string;
+    onClick: () => void;
+}
+declare const MenuTrigger: React.FC<MenuTriggerProps>;
+export default MenuTrigger;

package/dist/react/components/navigation/MenuTrigger.js

@@ -1,34 +1,34 @@
-"use strict";
-/*
- * Copyright (c) 2024, J2 Innovations. All Rights Reserved
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const icons_1 = require("@ant-design/icons");
-const classnames_1 = __importDefault(require("classnames"));
-const react_1 = __importDefault(require("react"));
-const react_jss_1 = require("react-jss");
-const useStyles = (0, react_jss_1.createUseStyles)((theme) => ({
-    menuTrigger: ({ headerHeight }) => ({
-        width: headerHeight,
-        height: '100%',
-        textAlign: 'center',
-        fontSize: 18,
-        cursor: 'pointer',
-        transition: 'color 0.3s ease-in-out',
-        backgroundColor: 'transparent',
-        color: theme.linkColor,
-        padding: '0 0.5rem',
-        '&:hover': {
-            color: theme.linkActiveColor,
-        },
-    }),
-}));
-const MenuTrigger = ({ hiddenSider, headerHeight = 45, onClick, className, }) => {
-    const classes = useStyles({ headerHeight });
-    return hiddenSider ? (react_1.default.createElement(icons_1.MenuUnfoldOutlined, { className: (0, classnames_1.default)(classes.menuTrigger, className), onClick: onClick })) : (react_1.default.createElement(icons_1.MenuFoldOutlined, { className: (0, classnames_1.default)(classes.menuTrigger, className), onClick: onClick }));
-};
-exports.default = MenuTrigger;
+"use strict";
+/*
+ * Copyright (c) 2024, J2 Innovations. All Rights Reserved
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const icons_1 = require("@ant-design/icons");
+const classnames_1 = __importDefault(require("classnames"));
+const react_1 = __importDefault(require("react"));
+const react_jss_1 = require("react-jss");
+const useStyles = (0, react_jss_1.createUseStyles)((theme) => ({
+    menuTrigger: ({ headerHeight }) => ({
+        width: headerHeight,
+        height: '100%',
+        textAlign: 'center',
+        fontSize: 18,
+        cursor: 'pointer',
+        transition: 'color 0.3s ease-in-out',
+        backgroundColor: 'transparent',
+        color: theme.linkColor,
+        padding: '0 0.5rem',
+        '&:hover': {
+            color: theme.linkActiveColor,
+        },
+    }),
+}));
+const MenuTrigger = ({ hiddenSider, headerHeight = 45, onClick, className, }) => {
+    const classes = useStyles({ headerHeight });
+    return hiddenSider ? (react_1.default.createElement(icons_1.MenuUnfoldOutlined, { className: (0, classnames_1.default)(classes.menuTrigger, className), onClick: onClick })) : (react_1.default.createElement(icons_1.MenuFoldOutlined, { className: (0, classnames_1.default)(classes.menuTrigger, className), onClick: onClick }));
+};
+exports.default = MenuTrigger;
 //# sourceMappingURL=MenuTrigger.js.map

package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.d.ts

@@ -1,11 +1,11 @@
-import type { Location } from '@remix-run/router';
-import React from 'react';
-import { HeaderSiderLayoutProps } from './HeaderSiderLayout';
-import { ReactRouterMenuPage } from './ReactRouterLayout';
-export interface ReactRouterHeaderSiderLayoutProps extends HeaderSiderLayoutProps<ReactRouterMenuPage> {
-    isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean;
-}
-/**
- * Header/Sider layout that uses React Router.
- */
-export declare const ReactRouterHeaderSiderLayout: React.FC<ReactRouterHeaderSiderLayoutProps>;
+import type { Location } from '@remix-run/router';
+import React from 'react';
+import { HeaderSiderLayoutProps } from './HeaderSiderLayout';
+import { ReactRouterMenuPage } from './ReactRouterLayout';
+export interface ReactRouterHeaderSiderLayoutProps extends HeaderSiderLayoutProps<ReactRouterMenuPage> {
+    isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean;
+}
+/**
+ * Header/Sider layout that uses React Router.
+ */
+export declare const ReactRouterHeaderSiderLayout: React.FC<ReactRouterHeaderSiderLayoutProps>;

package/dist/react/components/navigation/ReactRouterHeaderSiderLayout.js

@@ -1,26 +1,26 @@
-"use strict";
-/*
- * Copyright (c) 2024, J2 Innovations. All Rights Reserved
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReactRouterHeaderSiderLayout = void 0;
-const react_1 = __importDefault(require("react"));
-const react_router_1 = require("react-router");
-const HeaderSiderLayout_1 = require("./HeaderSiderLayout");
-const ReactRouterLayout_1 = require("./ReactRouterLayout");
-/**
- * Header/Sider layout that uses React Router.
- */
-const ReactRouterHeaderSiderLayout = ({ isSelectedRoute, pages = [], onSelect, ...otherProps }) => {
-    const navigate = (0, react_router_1.useNavigate)();
-    const selectedRoutes = (0, ReactRouterLayout_1.useSelectedRoutes)(pages, isSelectedRoute);
-    const pageKeyRouteMap = (0, ReactRouterLayout_1.useGetPageKeyRouteMap)(pages);
-    const defaultOnSelect = (0, ReactRouterLayout_1.useDefaultOnSelect)(navigate, pageKeyRouteMap, pages);
-    return (react_1.default.createElement(HeaderSiderLayout_1.HeaderSiderLayout, { ...otherProps, pages: pages, onSelect: onSelect ?? defaultOnSelect, selectedPages: selectedRoutes },
-        react_1.default.createElement(react_router_1.Outlet, null)));
-};
-exports.ReactRouterHeaderSiderLayout = ReactRouterHeaderSiderLayout;
+"use strict";
+/*
+ * Copyright (c) 2024, J2 Innovations. All Rights Reserved
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReactRouterHeaderSiderLayout = void 0;
+const react_1 = __importDefault(require("react"));
+const react_router_1 = require("react-router");
+const HeaderSiderLayout_1 = require("./HeaderSiderLayout");
+const ReactRouterLayout_1 = require("./ReactRouterLayout");
+/**
+ * Header/Sider layout that uses React Router.
+ */
+const ReactRouterHeaderSiderLayout = ({ isSelectedRoute, pages = [], onSelect, ...otherProps }) => {
+    const navigate = (0, react_router_1.useNavigate)();
+    const selectedRoutes = (0, ReactRouterLayout_1.useSelectedRoutes)(pages, isSelectedRoute);
+    const pageKeyRouteMap = (0, ReactRouterLayout_1.useGetPageKeyRouteMap)(pages);
+    const defaultOnSelect = (0, ReactRouterLayout_1.useDefaultOnSelect)(navigate, pageKeyRouteMap, pages);
+    return (react_1.default.createElement(HeaderSiderLayout_1.HeaderSiderLayout, { ...otherProps, pages: pages, onSelect: onSelect ?? defaultOnSelect, selectedPages: selectedRoutes },
+        react_1.default.createElement(react_router_1.Outlet, null)));
+};
+exports.ReactRouterHeaderSiderLayout = ReactRouterHeaderSiderLayout;
 //# sourceMappingURL=ReactRouterHeaderSiderLayout.js.map

package/dist/react/components/navigation/ReactRouterLayout.d.ts

@@ -1,46 +1,46 @@
-import type { Location } from '@remix-run/router';
-import React from 'react';
-import { NavigateFunction } from 'react-router';
-import { BasicLayoutProps } from './BasicLayout';
-import { MenuPage } from './MenuPage';
-export declare type ReactRouterMenuPage = MenuPage & {
-    route: string;
-};
-export interface ReactRouterLayoutProps extends BasicLayoutProps<ReactRouterMenuPage> {
-    isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean;
-}
-/**
- * This hook can be used with react-router/BasicLayout,
- * to ensure FIN5 URL is aligned with the internal frame URL.
- * This does not skip the hash update and should be used only with
- * FIN >= 5.1.7.92, otherwise FIN will reload the entire page.
- */
-export declare const useLocationUpdate: () => void;
-/**
- * This hook can be used with react-router/BasicLayout,
- * to ensure FIN5 URL is aligned with the internal frame URL.
- * This skips the hash update and should be used only with
- * FIN < 5.1.7.92.
- * @deprecated use only with FIN < 5.1.7.92
- * @see {@link useLocationUpdate} for FIN >= 5.1.7.92
- */
-export declare const useLocationUpdateSkippingHash: () => void;
-export declare const useSelectedRoutes: (pages: ReactRouterMenuPage[], isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean) => string[];
-/**
- * If we are inside a frame (FIN5), the route is left as is.
- * If we are outside FIN5 frame, the route needs to be prefixed with a segment containing the project name.
- * @param route
- * @returns the correct route for the environment
- */
-export declare const getRoute: (route: string) => string;
-/**
- * Create a map that holds the page key and its related route.
- * @param pages
- * @returns the map page key - route
- */
-export declare const useGetPageKeyRouteMap: (pages: ReactRouterMenuPage[]) => Map<string, string>;
-export declare const useDefaultOnSelect: (navigate: NavigateFunction, pageKeyRouteMap: Map<string, string>, pages: ReactRouterMenuPage[]) => (key: string) => void;
-/**
- * Basic layout that uses React Router.
- */
-export declare const ReactRouterLayout: React.FC<ReactRouterLayoutProps>;
+import type { Location } from '@remix-run/router';
+import React from 'react';
+import { NavigateFunction } from 'react-router';
+import { BasicLayoutProps } from './BasicLayout';
+import { MenuPage } from './MenuPage';
+export declare type ReactRouterMenuPage = MenuPage & {
+    route: string;
+};
+export interface ReactRouterLayoutProps extends BasicLayoutProps<ReactRouterMenuPage> {
+    isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean;
+}
+/**
+ * This hook can be used with react-router/BasicLayout,
+ * to ensure FIN5 URL is aligned with the internal frame URL.
+ * This does not skip the hash update and should be used only with
+ * FIN >= 5.1.7.92, otherwise FIN will reload the entire page.
+ */
+export declare const useLocationUpdate: () => void;
+/**
+ * This hook can be used with react-router/BasicLayout,
+ * to ensure FIN5 URL is aligned with the internal frame URL.
+ * This skips the hash update and should be used only with
+ * FIN < 5.1.7.92.
+ * @deprecated use only with FIN < 5.1.7.92
+ * @see {@link useLocationUpdate} for FIN >= 5.1.7.92
+ */
+export declare const useLocationUpdateSkippingHash: () => void;
+export declare const useSelectedRoutes: (pages: ReactRouterMenuPage[], isSelectedRoute?: (page: ReactRouterMenuPage, location: Location) => boolean) => string[];
+/**
+ * If we are inside a frame (FIN5), the route is left as is.
+ * If we are outside FIN5 frame, the route needs to be prefixed with a segment containing the project name.
+ * @param route
+ * @returns the correct route for the environment
+ */
+export declare const getRoute: (route: string) => string;
+/**
+ * Create a map that holds the page key and its related route.
+ * @param pages
+ * @returns the map page key - route
+ */
+export declare const useGetPageKeyRouteMap: (pages: ReactRouterMenuPage[]) => Map<string, string>;
+export declare const useDefaultOnSelect: (navigate: NavigateFunction, pageKeyRouteMap: Map<string, string>, pages: ReactRouterMenuPage[]) => (key: string) => void;
+/**
+ * Basic layout that uses React Router.
+ */
+export declare const ReactRouterLayout: React.FC<ReactRouterLayoutProps>;

package/dist/react/components/navigation/ReactRouterLayout.js

@@ -1,133 +1,133 @@
-"use strict";
-/*
- * Copyright (c) 2023, J2 Innovations. All Rights Reserved
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReactRouterLayout = exports.useDefaultOnSelect = exports.useGetPageKeyRouteMap = exports.getRoute = exports.useSelectedRoutes = exports.useLocationUpdateSkippingHash = exports.useLocationUpdate = void 0;
-const react_1 = __importStar(require("react"));
-const react_router_1 = require("react-router");
-const useFin5AppURLHashParameter_1 = require("../../../fin5Top/useFin5AppURLHashParameter");
-const BasicLayout_1 = require("./BasicLayout");
-const MenuPage_1 = require("./MenuPage");
-/**
- * This hook can be used with react-router/BasicLayout,
- * to ensure FIN5 URL is aligned with the internal frame URL.
- * This does not skip the hash update and should be used only with
- * FIN >= 5.1.7.92, otherwise FIN will reload the entire page.
- */
-const useLocationUpdate = () => {
-    const location = (0, react_router_1.useLocation)();
-    (0, react_1.useEffect)(() => {
-        if (useFin5AppURLHashParameter_1.IN_IFRAME) {
-            setHash(location);
-        }
-    }, [location]);
-};
-exports.useLocationUpdate = useLocationUpdate;
-/**
- * This hook can be used with react-router/BasicLayout,
- * to ensure FIN5 URL is aligned with the internal frame URL.
- * This skips the hash update and should be used only with
- * FIN < 5.1.7.92.
- * @deprecated use only with FIN < 5.1.7.92
- * @see {@link useLocationUpdate} for FIN >= 5.1.7.92
- */
-const useLocationUpdateSkippingHash = () => {
-    const location = (0, react_router_1.useLocation)();
-    (0, react_1.useEffect)(() => {
-        if (useFin5AppURLHashParameter_1.IN_IFRAME) {
-            (0, useFin5AppURLHashParameter_1.fin5SkipHashUpdate)()?.then(() => {
-                setHash(location);
-            });
-        }
-    }, [location]);
-};
-exports.useLocationUpdateSkippingHash = useLocationUpdateSkippingHash;
-const setHash = (location) => {
-    const hash = location.pathname;
-    const queryParams = location.search;
-    const frameParameters = (0, useFin5AppURLHashParameter_1.getFin5HashFrameParameters)();
-    frameParameters.set('url', frameParameters.get('url')?.split('#')[0] + '#' + hash + queryParams);
-    (0, useFin5AppURLHashParameter_1.getTopLocation)().hash = `#${(0, useFin5AppURLHashParameter_1.getTopLocation)().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
-};
-const useSelectedRoutes = (pages, isSelectedRoute = (page, location) => location.pathname.includes(page.route)) => {
-    const location = (0, react_router_1.useLocation)();
-    const flatPages = (0, react_1.useMemo)(() => (0, MenuPage_1.pageTreeToPageList)(pages), [pages]);
-    return (0, react_1.useMemo)(() => {
-        return flatPages
-            .filter((page) => isSelectedRoute(page, location))
-            .map((page) => page.key);
-    }, [location, flatPages, isSelectedRoute]);
-};
-exports.useSelectedRoutes = useSelectedRoutes;
-/**
- * If we are inside a frame (FIN5), the route is left as is.
- * If we are outside FIN5 frame, the route needs to be prefixed with a segment containing the project name.
- * @param route
- * @returns the correct route for the environment
- */
-const getRoute = (route) => {
-    const prefixedRoute = route.startsWith('/') ? route : `/${route}`;
-    return !useFin5AppURLHashParameter_1.IN_IFRAME ? `/proj/:projectName${prefixedRoute}` : prefixedRoute;
-};
-exports.getRoute = getRoute;
-/**
- * Create a map that holds the page key and its related route.
- * @param pages
- * @returns the map page key - route
- */
-const useGetPageKeyRouteMap = (pages) => (0, react_1.useMemo)(() => {
-    const flatPages = (0, MenuPage_1.pageTreeToPageList)(pages);
-    const result = new Map();
-    flatPages.forEach((page) => {
-        result.set(page.key, page.route);
-    });
-    return result;
-}, [pages]);
-exports.useGetPageKeyRouteMap = useGetPageKeyRouteMap;
-const useDefaultOnSelect = (navigate, pageKeyRouteMap, pages) => (0, react_1.useCallback)((key) => {
-    const route = pageKeyRouteMap.get(key);
-    if (route) {
-        navigate(route);
-    }
-    else {
-        console.warn('Could not find route for page key', key, 'pages', pages);
-    }
-}, [navigate, pageKeyRouteMap]);
-exports.useDefaultOnSelect = useDefaultOnSelect;
-/**
- * Basic layout that uses React Router.
- */
-const ReactRouterLayout = ({ isSelectedRoute, pages = [], onSelect, ...otherProps }) => {
-    const navigate = (0, react_router_1.useNavigate)();
-    const selectedRoutes = (0, exports.useSelectedRoutes)(pages, isSelectedRoute);
-    const pageKeyRouteMap = (0, exports.useGetPageKeyRouteMap)(pages);
-    const defaultOnSelect = (0, exports.useDefaultOnSelect)(navigate, pageKeyRouteMap, pages);
-    return (react_1.default.createElement(BasicLayout_1.BasicLayout, { ...otherProps, pages: pages, onSelect: onSelect ?? defaultOnSelect, selectedPages: selectedRoutes },
-        react_1.default.createElement(react_router_1.Outlet, null)));
-};
-exports.ReactRouterLayout = ReactRouterLayout;
+"use strict";
+/*
+ * Copyright (c) 2023, J2 Innovations. All Rights Reserved
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReactRouterLayout = exports.useDefaultOnSelect = exports.useGetPageKeyRouteMap = exports.getRoute = exports.useSelectedRoutes = exports.useLocationUpdateSkippingHash = exports.useLocationUpdate = void 0;
+const react_1 = __importStar(require("react"));
+const react_router_1 = require("react-router");
+const useFin5AppURLHashParameter_1 = require("../../../fin5Top/useFin5AppURLHashParameter");
+const BasicLayout_1 = require("./BasicLayout");
+const MenuPage_1 = require("./MenuPage");
+/**
+ * This hook can be used with react-router/BasicLayout,
+ * to ensure FIN5 URL is aligned with the internal frame URL.
+ * This does not skip the hash update and should be used only with
+ * FIN >= 5.1.7.92, otherwise FIN will reload the entire page.
+ */
+const useLocationUpdate = () => {
+    const location = (0, react_router_1.useLocation)();
+    (0, react_1.useEffect)(() => {
+        if (useFin5AppURLHashParameter_1.IN_IFRAME) {
+            setHash(location);
+        }
+    }, [location]);
+};
+exports.useLocationUpdate = useLocationUpdate;
+/**
+ * This hook can be used with react-router/BasicLayout,
+ * to ensure FIN5 URL is aligned with the internal frame URL.
+ * This skips the hash update and should be used only with
+ * FIN < 5.1.7.92.
+ * @deprecated use only with FIN < 5.1.7.92
+ * @see {@link useLocationUpdate} for FIN >= 5.1.7.92
+ */
+const useLocationUpdateSkippingHash = () => {
+    const location = (0, react_router_1.useLocation)();
+    (0, react_1.useEffect)(() => {
+        if (useFin5AppURLHashParameter_1.IN_IFRAME) {
+            (0, useFin5AppURLHashParameter_1.fin5SkipHashUpdate)()?.then(() => {
+                setHash(location);
+            });
+        }
+    }, [location]);
+};
+exports.useLocationUpdateSkippingHash = useLocationUpdateSkippingHash;
+const setHash = (location) => {
+    const hash = location.pathname;
+    const queryParams = location.search;
+    const frameParameters = (0, useFin5AppURLHashParameter_1.getFin5HashFrameParameters)();
+    frameParameters.set('url', frameParameters.get('url')?.split('#')[0] + '#' + hash + queryParams);
+    (0, useFin5AppURLHashParameter_1.getTopLocation)().hash = `#${(0, useFin5AppURLHashParameter_1.getTopLocation)().hash.slice(1).split('?')[0]}?${frameParameters.toString()}`;
+};
+const useSelectedRoutes = (pages, isSelectedRoute = (page, location) => location.pathname.includes(page.route)) => {
+    const location = (0, react_router_1.useLocation)();
+    const flatPages = (0, react_1.useMemo)(() => (0, MenuPage_1.pageTreeToPageList)(pages), [pages]);
+    return (0, react_1.useMemo)(() => {
+        return flatPages
+            .filter((page) => isSelectedRoute(page, location))
+            .map((page) => page.key);
+    }, [location, flatPages, isSelectedRoute]);
+};
+exports.useSelectedRoutes = useSelectedRoutes;
+/**
+ * If we are inside a frame (FIN5), the route is left as is.
+ * If we are outside FIN5 frame, the route needs to be prefixed with a segment containing the project name.
+ * @param route
+ * @returns the correct route for the environment
+ */
+const getRoute = (route) => {
+    const prefixedRoute = route.startsWith('/') ? route : `/${route}`;
+    return !useFin5AppURLHashParameter_1.IN_IFRAME ? `/proj/:projectName${prefixedRoute}` : prefixedRoute;
+};
+exports.getRoute = getRoute;
+/**
+ * Create a map that holds the page key and its related route.
+ * @param pages
+ * @returns the map page key - route
+ */
+const useGetPageKeyRouteMap = (pages) => (0, react_1.useMemo)(() => {
+    const flatPages = (0, MenuPage_1.pageTreeToPageList)(pages);
+    const result = new Map();
+    flatPages.forEach((page) => {
+        result.set(page.key, page.route);
+    });
+    return result;
+}, [pages]);
+exports.useGetPageKeyRouteMap = useGetPageKeyRouteMap;
+const useDefaultOnSelect = (navigate, pageKeyRouteMap, pages) => (0, react_1.useCallback)((key) => {
+    const route = pageKeyRouteMap.get(key);
+    if (route) {
+        navigate(route);
+    }
+    else {
+        console.warn('Could not find route for page key', key, 'pages', pages);
+    }
+}, [navigate, pageKeyRouteMap]);
+exports.useDefaultOnSelect = useDefaultOnSelect;
+/**
+ * Basic layout that uses React Router.
+ */
+const ReactRouterLayout = ({ isSelectedRoute, pages = [], onSelect, ...otherProps }) => {
+    const navigate = (0, react_router_1.useNavigate)();
+    const selectedRoutes = (0, exports.useSelectedRoutes)(pages, isSelectedRoute);
+    const pageKeyRouteMap = (0, exports.useGetPageKeyRouteMap)(pages);
+    const defaultOnSelect = (0, exports.useDefaultOnSelect)(navigate, pageKeyRouteMap, pages);
+    return (react_1.default.createElement(BasicLayout_1.BasicLayout, { ...otherProps, pages: pages, onSelect: onSelect ?? defaultOnSelect, selectedPages: selectedRoutes },
+        react_1.default.createElement(react_router_1.Outlet, null)));
+};
+exports.ReactRouterLayout = ReactRouterLayout;
 //# sourceMappingURL=ReactRouterLayout.js.map

package/dist/react/components/navigation/customRouting/Router.d.ts

@@ -1,12 +1,12 @@
-import { PropsWithChildren, ReactElement } from 'react';
-import { MenuPage } from '../MenuPage';
-export interface RouterProps<T extends MenuPage> {
-    pages?: T[];
-    currentPage: string;
-    onPageChange?: (selectedPage?: T) => void;
-    fallbackComponent?: ReactElement;
-}
-/**
- * Renders the currently selected page from a tree of pages
- */
-export declare function Router<T extends MenuPage>({ pages, currentPage, onPageChange, fallbackComponent, }: PropsWithChildren<RouterProps<T>>): JSX.Element;
+import { PropsWithChildren, ReactElement } from 'react';
+import { MenuPage } from '../MenuPage';
+export interface RouterProps<T extends MenuPage> {
+    pages?: T[];
+    currentPage: string;
+    onPageChange?: (selectedPage?: T) => void;
+    fallbackComponent?: ReactElement;
+}
+/**
+ * Renders the currently selected page from a tree of pages
+ */
+export declare function Router<T extends MenuPage>({ pages, currentPage, onPageChange, fallbackComponent, }: PropsWithChildren<RouterProps<T>>): JSX.Element;