@luigi-project/core-modular 0.0.3 → 0.0.4

package/modules/routing-module.d.ts

@@ -1,5 +1,5 @@
-import { ExternalLink, Node, PageErrorHandler } from '../services/navigation.service';
 import { Luigi } from '../core-api/luigi';
+import { ExternalLink, Node, PageErrorHandler } from '../types/navigation';
 export declare const RoutingModule: {
     init: (luigi: Luigi) => void;
     handlePageErrorHandler: (pageErrorHandler: PageErrorHandler, node: Node, luigi: Luigi) => void;

package/modules/ui-module.d.ts

@@ -1,13 +1,14 @@
 import { Luigi } from '../core-api/luigi';
-import { NavigationService, ModalSettings } from '../services/navigation.service';
+import { NavigationService } from '../services/navigation.service';
 import { RoutingService } from '../services/routing.service';
+import { ModalSettings } from '../types/navigation';
 export declare const UIModule: {
     navService: NavigationService;
     routingService: RoutingService;
     luigi: Luigi;
     init: (luigi: Luigi) => void;
     update: (scopes?: string[]) => Promise<void>;
-    updateMainContent: (currentNode: any, luigi: Luigi) => Promise<void>;
+    updateMainContent: (currentNode: any, luigi: Luigi, withoutSync?: boolean, preventContextUpdate?: boolean) => Promise<void>;
     openModal: (luigi: Luigi, node: any, modalSettings: ModalSettings, onCloseCallback?: () => void) => Promise<void>;
     updateModalSettings: (modalSettings: ModalSettings, addHistoryEntry: boolean, luigi: Luigi) => void;
     openDrawer: (luigi: Luigi, node: any, modalSettings: ModalSettings, onCloseCallback?: () => void) => Promise<void>;

package/package.json

@@ -18,5 +18,5 @@
     "micro-frontends",
     "microfrontends"
   ],
-  "version": "0.0.3"
+  "version": "0.0.4"
 }

package/services/modal.service.d.ts

@@ -1,5 +1,5 @@
 import { Luigi } from '../core-api/luigi';
-import { ModalSettings } from './navigation.service';
+import { ModalSettings } from '../types/navigation';
 export interface ModalPromiseObject {
     closePromise?: Promise<void>;
     resolveFn?: () => void;

package/services/navigation.service.d.ts

@@ -1,183 +1,13 @@
 import { Luigi } from '../core-api/luigi';
+import { AppSwitcher, LeftNavData, NavigationOptions, NavigationRequestParams, NavItem, Node, PathData, TabNavData, TopNavData } from '../types/navigation';
 import { NodeDataManagementService } from './node-data-management.service';
-export interface TopNavData {
-    appTitle: string;
-    logo: string;
-    topNodes: NavItem[];
-    productSwitcher?: ProductSwitcher;
-    profile?: ProfileSettings;
-    appSwitcher?: AppSwitcher;
-    navClick?: (item: NavItem) => void;
-}
-export interface AppSwitcher {
-    showMainAppEntry?: boolean;
-    items?: AppSwitcherItem[];
-    itemRenderer?: (item: AppSwitcherItem, slot: HTMLElement, appSwitcherApiObj?: any) => void;
-}
-export interface AppSwitcherItem {
-    title?: string;
-    subtitle?: string;
-    link?: string;
-    selectionConditions?: selectionConditions;
-}
-export interface selectionConditions {
-    route?: string;
-    contextCriteria?: ContextCriteria[];
-}
-export interface ContextCriteria {
-    key: string;
-    value: string;
-}
-export interface ProfileSettings {
-    authEnabled: boolean;
-    signedIn: boolean;
-    logout: ProfileLogout;
-    items?: ProfileItem[];
-    staticUserInfoFn?: () => Promise<UserInfo>;
-    onUserInfoUpdate: (fn: (uInfo: UserInfo) => void) => void;
-    itemClick: (item: ProfileItem) => void;
-}
-export interface ProfileLogout {
-    label?: string;
-    icon?: string;
-    testId?: string;
-    altText?: string;
-    doLogout: () => void;
-}
-export interface ProfileItem {
-    label?: string;
-    link?: string;
-    externalLink?: ExternalLink;
-    icon?: string;
-    testId?: string;
-    altText?: string;
-    openNodeInModal?: boolean | ModalSettings;
-}
-export interface UserInfo {
-    name?: string;
-    initials?: string;
-    email?: string;
-    picture?: string;
-    description?: string;
-}
-export interface LeftNavData {
-    selectedNode: any;
-    items: NavItem[];
-    basePath: string;
-    sideNavFooterText?: string;
-    navClick?: (item: NavItem) => void;
-}
-export interface PathData {
-    selectedNode?: Node;
-    selectedNodeChildren?: Node[];
-    nodesInPath?: Node[];
-    rootNodes: Node[];
-    pathParams: Record<string, any>;
-}
-export interface RootNode {
-    node: Node;
-}
-export interface Node {
-    altText?: string;
-    anonymousAccess?: any;
-    badgeCounter?: {
-        count?: () => number | Promise<number>;
-        label?: string;
-    };
-    category?: any;
-    children?: Node[];
-    clientPermissions?: {
-        changeCurrentLocale?: boolean;
-        urlParameters?: Record<string, any>;
-    };
-    context?: Record<string, any>;
-    drawer?: ModalSettings;
-    externalLink?: ExternalLink;
-    hideFromNav?: boolean;
-    hideSideNav?: boolean;
-    icon?: string;
-    isRootNode?: boolean;
-    keepSelectedForChildren?: boolean;
-    label?: string;
-    onNodeActivation?: (node: Node) => boolean | void;
-    openNodeInModal?: boolean;
-    pageErrorHandler?: PageErrorHandler;
-    parent?: Node;
-    pathSegment?: string;
-    runTimeErrorHandler?: RunTimeErrorHandler;
-    tabNav?: boolean;
-    tooltipText?: string;
-    viewUrl?: string;
-    visibleForFeatureToggles?: string[];
-}
-export interface PageErrorHandler {
-    timeout: number;
-    viewUrl?: string;
-    redirectPath?: string;
-    errorFn?: (node?: Node) => void;
-}
-export interface RunTimeErrorHandler {
-    errorFn?: (error: object, node?: Node) => void;
-}
-export interface Category {
-    altText?: string;
-    collapsible?: boolean;
-    icon?: string;
-    id: string;
-    isGroup?: boolean;
-    label?: string;
-    nodes?: NavItem[];
-    tooltip?: string;
-}
-export interface NavItem {
-    altText?: string;
-    category?: Category;
-    icon?: string;
-    node?: Node;
-    label?: string;
-    selected?: boolean;
-    tooltip?: string;
-}
-export interface TabNavData {
-    selectedNode?: any;
-    items?: NavItem[];
-    basePath?: string;
-    navClick?: (item: NavItem) => void;
-}
-export interface ModalSettings {
-    size?: 'fullscreen' | 'l' | 'm' | 's';
-    width?: string;
-    height?: string;
-    title?: string;
-    closebtn_data_testid?: string;
-    keepPrevious?: boolean;
-}
-export interface ProductSwitcher {
-    altText?: string;
-    columns?: number;
-    icon?: string;
-    items?: [ProductSwitcherItem];
-    label?: string;
-    testId?: string;
-}
-export interface ProductSwitcherItem {
-    altText?: string;
-    externalLink?: ExternalLink;
-    icon?: string;
-    label?: string;
-    link?: string;
-    selected?: boolean;
-    subTitle?: string;
-    testId?: string;
-}
-export interface ExternalLink {
-    url?: string;
-    sameWindow?: boolean;
-}
+import { ModalService } from './modal.service';
 export declare class NavigationService {
     private luigi;
+    modalService?: ModalService;
     nodeDataManagementService?: NodeDataManagementService;
     constructor(luigi: Luigi);
+    private getModalService;
     private getNodeDataManagementService;
     getPathData(path: string): Promise<PathData>;
     findMatchingNode(urlPathElement: string, nodes: Node[]): Node | undefined;
@@ -196,7 +26,7 @@ export declare class NavigationService {
     getTruncatedChildren(children: any): any[];
     applyNavGroups(items: NavItem[]): NavItem[];
     getLeftNavData(path: string, pData?: PathData): Promise<LeftNavData>;
-    navItemClick(item: Node, parentPath: string): void;
+    navItemClick(node: Node, pathData?: PathData): void;
     getTopNavData(path: string, pData?: PathData): Promise<TopNavData>;
     getParentNode(node: Node | undefined, pathData: PathData): Node | undefined;
     getAppSwitcherData(appSwitcherData: AppSwitcher, headerSettings: any): AppSwitcher | undefined;
@@ -234,8 +64,47 @@ export declare class NavigationService {
     private resolveTooltipText;
     private prepareRootNodes;
     private getAccessibleNodes;
-    handleNavigationRequest(path: string, preserveView?: string, modalSettings?: any, newTab?: boolean, withoutSync?: boolean, callbackFn?: any): Promise<void>;
+    /**
+     * Deal with route changing scenario.
+     * @param {NavigationRequestParams} params - the params to configure navigation request
+     * @param {string} params.path - the path of the view to open
+     * @param {string} params.preserveView - preserve a view by setting it to specific value (optional)
+     * @param {any} params.modalSettings - settings to configure the modal's title and size (optional)
+     * @param {boolean} params.newTab - open a view in new tab by setting it to `true` (optional)
+     * @param {boolean} params.withoutSync - disables the navigation handling for a single navigation request (optional)
+     * @param {boolean} params.preventContextUpdate - make no context update being triggered; default is false (optional)
+     * @param {boolean} params.preventHistoryEntry - make no history update being triggered; default is false (optional)
+     * @param {any} callbackFn - callback to be triggered after opening view as modal (optional)
+     */
+    handleNavigationRequest(params: NavigationRequestParams, callbackFn?: any): Promise<void>;
     getChildren(node: Node | undefined, context?: Record<string, any>): Promise<Node[]>;
     getExpandStructuralPathSegment(node: Node): Node;
     bindChildToParent(child: Node, node: Node): Node;
+    /**
+     * Builds a virtual tree structure for the given node based on the provided path parameters.
+     *
+     * @param node - The node for which the virtual tree is being built.
+     * @param nodesInPath - An array of nodes representing the path in the virtual tree.
+     * @param pathParams - An object containing path parameters for the virtual tree.
+     */
+    buildVirtualTree(node: Node, segment: any, pathParams: Record<string, any>): Node[] | undefined;
+    /**
+     * Requires str to include :virtualPath
+     * and pathParams consist of :virtualSegment_N
+     * for deep nested virtual tree building
+     *
+     * @param str - The base string for the virtual view URL.
+     * @param pathParams - An object containing path parameters for the virtual view URL.
+     * @param _virtualPathIndex - The index of the virtual path segment.
+     * @returns The constructed virtual view URL string.
+     */
+    buildVirtualViewUrl(str: string, pathParams: any, _virtualPathIndex: number): string;
+    /**
+     * Builds a path string by concatenating path segments from the virtual tree root or the incoming path.
+     *
+     * @param incomingPath - The incoming path segment to be appended.
+     * @param fromVirtualTreeRoot - A boolean indicating whether to build the path from the virtual tree root.
+     * @returns The constructed path string.
+     */
+    buildPath(incomingPath: string, options: NavigationOptions): Promise<string>;
 }

package/services/node-data-management.service.d.ts

@@ -1,4 +1,4 @@
-import { Node, RootNode } from './navigation.service';
+import { Node, RootNode } from '../types/navigation';
 export declare class NodeDataManagementService {
     dataManagement: Map<any, any>;
     navPath: string;

package/services/routing.service.d.ts

@@ -1,5 +1,6 @@
 import { Luigi } from '../core-api/luigi';
-import { ModalSettings, Node, PathData, NavigationService } from './navigation.service';
+import { ModalSettings, Node, PathData } from '../types/navigation';
+import { NavigationService } from './navigation.service';
 export interface Route {
     raw: string;
     node?: Node;
@@ -39,12 +40,13 @@ export declare class RoutingService {
      * Deal with route changing scenario.
      * @param {Object} routeInfo - the information about path and query
      * @param {boolean} withoutSync - disables the navigation handling for a single navigation request
+     * @param {boolean} preventContextUpdate - make no context update being triggered
      * @returns {Promise<void>} A promise that resolves when route change is complete.
      */
     handleRouteChange(routeInfo: {
         path: string;
         query: string;
-    }, withoutSync?: boolean): Promise<void>;
+    }, withoutSync?: boolean, preventContextUpdate?: boolean): Promise<void>;
     getCurrentRoute(): Route | undefined;
     /**
      * If `showModalPathInUrl` is provided, bookmarkable modal path will be triggered.

package/types/connector.d.ts

@@ -1,5 +1,5 @@
-import { ModalSettings, LeftNavData, Node, TopNavData, TabNavData } from '../services/navigation.service';
 import { AlertHandler, AlertSettings, ConfirmationModalHandler, ConfirmationModalSettings, UserSettings } from '../modules/ux-module';
+import { ModalSettings, LeftNavData, Node, TopNavData, TabNavData } from './navigation';
 export interface LuigiConnector {
     renderMainLayout(): void;
     renderTopNav(data: TopNavData): void;

package/types/navigation.d.ts

@@ -0,0 +1,201 @@
+export interface TopNavData {
+    appTitle: string;
+    logo: string;
+    topNodes: NavItem[];
+    productSwitcher?: ProductSwitcher;
+    profile?: ProfileSettings;
+    appSwitcher?: AppSwitcher;
+    navClick?: (item: NavItem) => void;
+}
+export interface AppSwitcher {
+    showMainAppEntry?: boolean;
+    items?: AppSwitcherItem[];
+    itemRenderer?: (item: AppSwitcherItem, slot: HTMLElement, appSwitcherApiObj?: any) => void;
+}
+export interface AppSwitcherItem {
+    title?: string;
+    subtitle?: string;
+    link?: string;
+    selectionConditions?: selectionConditions;
+}
+export interface selectionConditions {
+    route?: string;
+    contextCriteria?: ContextCriteria[];
+}
+export interface ContextCriteria {
+    key: string;
+    value: string;
+}
+export interface ProfileSettings {
+    authEnabled: boolean;
+    signedIn: boolean;
+    logout: ProfileLogout;
+    items?: ProfileItem[];
+    staticUserInfoFn?: () => Promise<UserInfo>;
+    onUserInfoUpdate: (fn: (uInfo: UserInfo) => void) => void;
+    itemClick: (item: ProfileItem) => void;
+}
+export interface ProfileLogout {
+    label?: string;
+    icon?: string;
+    testId?: string;
+    altText?: string;
+    doLogout: () => void;
+}
+export interface ProfileItem {
+    label?: string;
+    link?: string;
+    externalLink?: ExternalLink;
+    icon?: string;
+    testId?: string;
+    altText?: string;
+    openNodeInModal?: boolean | ModalSettings;
+}
+export interface UserInfo {
+    name?: string;
+    initials?: string;
+    email?: string;
+    picture?: string;
+    description?: string;
+}
+export interface LeftNavData {
+    selectedNode: any;
+    items: NavItem[];
+    basePath: string;
+    sideNavFooterText?: string;
+    navClick?: (item: NavItem) => void;
+}
+export interface PathData {
+    selectedNode?: Node;
+    selectedNodeChildren?: Node[];
+    nodesInPath?: Node[];
+    rootNodes: Node[];
+    pathParams: Record<string, any>;
+}
+export interface RootNode {
+    node: Node;
+}
+export interface Node {
+    altText?: string;
+    anonymousAccess?: any;
+    badgeCounter?: {
+        count?: () => number | Promise<number>;
+        label?: string;
+    };
+    category?: any;
+    children?: Node[];
+    clientPermissions?: {
+        changeCurrentLocale?: boolean;
+        urlParameters?: Record<string, any>;
+    };
+    context?: Record<string, any>;
+    drawer?: ModalSettings;
+    externalLink?: ExternalLink;
+    hideFromNav?: boolean;
+    hideSideNav?: boolean;
+    icon?: string;
+    isRootNode?: boolean;
+    keepSelectedForChildren?: boolean;
+    label?: string;
+    navigationContext?: string;
+    onNodeActivation?: (node: Node) => boolean | void;
+    openNodeInModal?: boolean;
+    pageErrorHandler?: PageErrorHandler;
+    parent?: Node;
+    pathSegment?: string;
+    runTimeErrorHandler?: RunTimeErrorHandler;
+    tabNav?: boolean;
+    tooltipText?: string;
+    viewUrl?: string;
+    visibleForFeatureToggles?: string[];
+    virtualTree?: boolean;
+    _virtualTree?: Node;
+    _virtualPathIndex?: number;
+    _virtualViewUrl?: string;
+}
+export interface PageErrorHandler {
+    timeout: number;
+    viewUrl?: string;
+    redirectPath?: string;
+    errorFn?: (node?: Node) => void;
+}
+export interface RunTimeErrorHandler {
+    errorFn?: (error: object, node?: Node) => void;
+}
+export interface Category {
+    altText?: string;
+    collapsible?: boolean;
+    icon?: string;
+    id: string;
+    isGroup?: boolean;
+    label?: string;
+    nodes?: NavItem[];
+    tooltip?: string;
+}
+export interface NavItem {
+    altText?: string;
+    category?: Category;
+    icon?: string;
+    node?: Node;
+    label?: string;
+    selected?: boolean;
+    tooltip?: string;
+}
+export interface TabNavData {
+    selectedNode?: any;
+    items?: NavItem[];
+    basePath?: string;
+    navClick?: (item: NavItem) => void;
+}
+export interface ModalSettings {
+    size?: 'fullscreen' | 'l' | 'm' | 's';
+    width?: string;
+    height?: string;
+    title?: string;
+    closebtn_data_testid?: string;
+    keepPrevious?: boolean;
+}
+export interface ProductSwitcher {
+    altText?: string;
+    columns?: number;
+    icon?: string;
+    items?: [ProductSwitcherItem];
+    label?: string;
+    testId?: string;
+}
+export interface ProductSwitcherItem {
+    altText?: string;
+    externalLink?: ExternalLink;
+    icon?: string;
+    label?: string;
+    link?: string;
+    selected?: boolean;
+    subTitle?: string;
+    testId?: string;
+}
+export interface ExternalLink {
+    url?: string;
+    sameWindow?: boolean;
+}
+export interface NavigationOptions {
+    fromContext?: any;
+    fromClosestContext?: boolean;
+    fromVirtualTreeRoot?: boolean;
+    fromParent?: boolean;
+}
+export interface NavigationRequestBase {
+    preventContextUpdate?: boolean;
+    preventHistoryEntry?: boolean;
+    withoutSync?: boolean;
+    options?: NavigationOptions;
+}
+export interface NavigationRequestParams extends NavigationRequestBase {
+    modalSettings?: any;
+    newTab?: boolean;
+    path: string;
+    preserveView?: string;
+}
+export interface NavigationRequestEvent {
+    detail: NavigationRequestBase;
+}
+export type HistoryMethod = 'pushState' | 'replaceState';

package/utilities/helpers/generic-helpers.d.ts

@@ -81,4 +81,42 @@ export declare const GenericHelpers: {
      */
     getConfigBooleanValue: (object: Record<string, any>, property: string) => boolean;
     getUrlParameter: (key: string) => string | null;
+    /**
+     * Returns a new Object with the same object,
+     * without the keys that were given.
+     * References still stay.
+     * Allows wildcard ending keys
+     *
+     * @param {Object} input - any given object
+     * @param {Array} keys - allows also wildcards at the end, like: _*
+     */
+    removeProperties(input: Record<string, any>, keys: any[]): Record<string, any>;
+    /**
+     *  Replaces variables in the input string with the values from the params object. Variables are defined with a prefix and wrapped in curly braces, e.g. {i18n.key} or {config.key}.
+     *  If the variable is not found in the params object, it will be removed from the string.
+     * @param inputString
+     * @param params
+     * @param prefix
+     * @param parenthesis
+     * @returns
+     */
+    replaceVars(inputString: string, params: Record<string, any>, prefix: string, parenthesis?: boolean): string;
+    /**
+     *  Escapes special characters in a string for use in a regular expression.
+     * @param string
+     * @returns
+     */
+    escapeRegExp(string: string): string;
+    /**
+     * Checks if a given input string begins with a hash or a slash
+     * @param {string} path
+     * @returns {boolean}
+     */
+    hasHashOrSlash: (path: string) => boolean;
+    /**
+     * Removes leading hash or slash of a string
+     * @param {string} path
+     * @returns {string}
+     */
+    getPathWithoutHashOrSlash: (path: string) => string;
 };

package/utilities/helpers/navigation-helpers.d.ts

@@ -1,6 +1,6 @@
 import { FeatureToggles } from '../../core-api/feature-toggles';
 import { Luigi } from '../../core-api/luigi';
-import { AppSwitcher, Node, PathData } from '../../services/navigation.service';
+import { AppSwitcher, Node, PathData } from '../../types/navigation';
 export declare const NavigationHelpers: {
     normalizePath: (raw: string) => string;
     segmentMatches: (linkSegment: string, pathSegment: string, pathParams: Record<string, any>) => boolean;
@@ -12,4 +12,10 @@ export declare const NavigationHelpers: {
     buildPath(pathToLeftNavParent: Node[], pathData?: PathData): string;
     mergeContext(...objs: Record<string, any>[]): Record<string, any>;
     prepareForTests(...parts: string[]): string;
+    /**
+     * Finds the virtual tree root node for a given node by traversing up the node hierarchy until it finds a node with the virtualTree property set to true. If no such node is found, it returns undefined.
+     * @param node  The node for which to find the virtual tree root node.
+     * @returns The virtual tree root node if found, otherwise undefined.
+     */
+    findVirtualTreeRootNode(node: Node): Node | undefined;
 };

package/utilities/helpers/routing-helpers.d.ts

@@ -1,6 +1,6 @@
 import { FeatureToggles } from '../../core-api/feature-toggles';
 import { Luigi } from '../../core-api/luigi';
-import { Node, PathData } from '../../services/navigation.service';
+import { Node, PathData } from '../../types/navigation';
 export declare const RoutingHelpers: {
     defaultContentViewParamPrefix: string;
     defaultQueryParamSeparator: string;
@@ -262,4 +262,40 @@ export declare const RoutingHelpers: {
      * @param {*} pathParams
      */
     getDynamicNodeValue(node: Node, pathParams: Record<string, string>): string | undefined;
+    /**
+     *  Recursively constructs the full path for a given node by concatenating its path segment with those of its ancestors.
+     *  If `params` are provided, they are appended as query parameters to the final path.
+     * @param node - The node for which to construct the path. It is expected to have a `pathSegment` property and optionally a `parent` property pointing to its parent node.
+     * @param params - Optional query parameters to append to the path. If provided, it should be a string in the format of URL query parameters (e.g., "key=value&anotherKey=anotherValue").
+     * @returns The constructed path as a string, including any query parameters if provided.
+     */
+    getNodePath(node: Node, params?: string): string;
+    /**
+     * Builds a route string by recursively traversing up the node hierarchy and concatenating path segments.
+     * @param node - The current node from which to start building the route.
+     * @param path - The accumulated path string (used internally for recursion).
+     * @param params - Optional query parameters to append to the final route.
+     * @returns a string representing the full route from the root to the given node, including query parameters if provided.
+     */
+    buildRoute(node: Node, path: string, params?: string): string;
+    substituteViewUrl(viewUrl: string, pathParams: Record<string, string>, luigi: Luigi): string;
+    /**
+     *  Generates a sub-path for a given node by replacing dynamic parameters in the node's path with actual values from pathParams.
+     * @param node - The node for which to generate the sub-path. It is expected to have a `pathSegment` property and optionally a `parent` property pointing to its parent node.
+     * @param nodePathParams - An object containing the values for dynamic parameters in the node's path. The keys should match the parameter names in the path segments.
+     * @returns A string representing the sub-path with dynamic parameters replaced by their corresponding values from pathParams.
+     */
+    getSubPath(node: any, nodePathParams: any): string;
+    /**
+     * Concatenates a base path and a relative path
+     *
+     * The function performs the following steps:
+     * 1. Removes any trailing '/' from the base path.
+     * 2. If the relative path does not start with '/', it adds a '/' between the base and relative paths.
+     * 3. Concatenates the base path and the relative path.
+     * @param basePath The base path to which the relative path will be appended. It may or may not end with a '/' character.
+     * @param relativePath The relative path to append to the base path. It may or may not start with a '/' character.
+     * @returns A string representing the concatenated path, with exactly one '/' character between the base and relative paths.
+     */
+    concatenatePath(basePath: any, relativePath?: any): string;
 };