@luigi-project/core-modular 0.0.3-dev.202602251304 → 0.0.3-dev.202602270047

package/package.json

@@ -18,5 +18,5 @@
     "micro-frontends",
     "microfrontends"
   ],
-  "version": "0.0.3-dev.202602251304"
+  "version": "0.0.3-dev.202602270047"
 }

package/services/navigation.service.d.ts

@@ -26,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;
@@ -80,4 +80,31 @@ export declare class NavigationService {
     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, nodesInPath: any, pathParams: Record<string, any>): void;
+    /**
+     * 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, fromVirtualTreeRoot?: boolean): Promise<string>;
 }

package/types/navigation.d.ts

@@ -107,6 +107,10 @@ export interface Node {
     tooltipText?: string;
     viewUrl?: string;
     visibleForFeatureToggles?: string[];
+    virtualTree?: boolean;
+    _virtualTree?: Node;
+    _virtualPathIndex?: number;
+    _virtualViewUrl?: string;
 }
 export interface PageErrorHandler {
     timeout: number;
@@ -172,10 +176,17 @@ 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;

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

@@ -81,4 +81,30 @@ 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;
 };

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

@@ -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

@@ -262,4 +262,13 @@ export declare const RoutingHelpers: {
      * @param {*} pathParams
      */
     getDynamicNodeValue(node: Node, pathParams: Record<string, string>): string | undefined;
+    /**
+     * 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, pathData: PathData, luigi: Luigi): string;
 };