@luigi-project/core-modular 0.0.7 → 0.0.8-dev.20260630124

package/modules/ui-module.d.ts

@@ -1,7 +1,7 @@
 import { Luigi } from '../core-api/luigi';
 import { NavigationService } from '../services/navigation.service';
 import { RoutingService } from '../services/routing.service';
-import { DrawerSettings, ModalSettings, Node } from '../types/navigation';
+import { DrawerSettings, ModalSettings, Node, UserSettingsDialogSettings } from '../types/navigation';
 import { LuigiParams } from '../types/routing';
 export declare const UIModule: {
     navService: NavigationService;
@@ -15,4 +15,5 @@ export declare const UIModule: {
     openModal: (luigi: Luigi, node: Node, modalSettings: ModalSettings, onCloseCallback?: () => void) => Promise<void>;
     updateModalSettings: (modalSettings: ModalSettings, addHistoryEntry: boolean, luigi: Luigi) => void;
     openDrawer: (luigi: Luigi, node: Node, drawerSettings: DrawerSettings, onCloseCallback?: () => void) => Promise<void>;
+    openUserSettings: (userSettingsDialogSettings: UserSettingsDialogSettings, userSettingData: any, previousUserSettings: any, luigi: Luigi) => Promise<void>;
 };

package/package.json

@@ -18,5 +18,5 @@
     "micro-frontends",
     "microfrontends"
   ],
-  "version": "0.0.7"
+  "version": "0.0.8-dev.20260630124"
 }

package/services/auth-layer.service.d.ts

@@ -19,6 +19,7 @@ declare class AuthLayerSvcClass {
     getIdpProviderInstance(idpProviderName: string, idpProviderSettings: any): Promise<any>;
     unload(): void;
     resetExpirationChecks(): void;
+    broadcastAuthData(authData: any): void;
 }
 export declare const AuthLayerSvc: AuthLayerSvcClass;
 export {};

package/services/dirty-status.service.d.ts

@@ -1,4 +1,6 @@
+import { Luigi } from '../core-api/luigi';
 export declare class DirtyStatusService {
+    private luigi;
     unsavedChanges: {
         isDirty?: boolean;
         persistUrl?: string | null;
@@ -8,7 +10,7 @@ export declare class DirtyStatusService {
      * Initializes the `unsavedChanges` property with default values.
      * Sets `isDirty` to `false` and `persistUrl` to `null`, indicating that there are no unsaved changes initially.
      */
-    constructor();
+    constructor(luigi: Luigi);
     /**
      * Updates the dirty status of a given source and manages the set of unsaved changes.
      *
@@ -38,4 +40,6 @@ export declare class DirtyStatusService {
      * @returns {boolean} `true` if there are unsaved changes, otherwise `false`.
      */
     readDirtyStatus(): boolean;
+    getUnsavedChangesModalPromise(source?: any): Promise<void>;
+    shouldShowUnsavedChangesModal(source?: any): boolean;
 }

package/services/i18n.service.d.ts

@@ -1,4 +1,3 @@
-import { LuigiContainer, LuigiCompoundContainer } from '@luigi-project/container';
 import { Luigi } from '../core-api/luigi';
 /**
  * Localization-related functions
@@ -21,7 +20,7 @@ export declare class i18nService {
      * Sets current locale to the specified one.
      * @param {string} locale locale to be set as the current locale
      */
-    setCurrentLocale(locale: string, containerElement?: LuigiContainer | LuigiCompoundContainer): void;
+    setCurrentLocale(locale: string): void;
     /**
      * Registers a listener for locale changes.
      * @param {Function} listener function called on every locale change with the new locale as argument

package/services/modal.service.d.ts

@@ -49,4 +49,5 @@ export declare class ModalService {
      * Removes the last modal from the stack.
      */
     removeLastModalFromStack(): void;
+    closeModalsWithDirtyCheck(): Promise<boolean>;
 }

package/services/navigation.service.d.ts

@@ -1,7 +1,7 @@
 import { Luigi } from '../core-api/luigi';
 import { AppSwitcher, BreadcrumbData, LeftNavData, NavigationOptions, NavigationRequestParams, NavItem, Node, PathData, TabNavData, TopNavData } from '../types/navigation';
-import { NodeDataManagementService } from './node-data-management.service';
 import { ModalService } from './modal.service';
+import { NodeDataManagementService } from './node-data-management.service';
 export declare class NavigationService {
     private luigi;
     modalService?: ModalService;
@@ -26,12 +26,13 @@ export declare class NavigationService {
     getTruncatedChildren(children: Node[]): Node[];
     applyNavGroups(items: NavItem[]): NavItem[];
     getLeftNavData(path: string, pData?: PathData): Promise<LeftNavData>;
-    navItemClick(node: Node, pathData?: PathData): void;
+    navItemClick(node: Node, pathData?: PathData): Promise<void>;
     getTopNavData(path: string, pData?: PathData): Promise<TopNavData>;
     getParentNode(node: Node | undefined, pathData: PathData): Node | undefined;
     getAppSwitcherData(appSwitcherData: AppSwitcher, headerSettings: any): AppSwitcher | undefined;
     getTabNavData(path: string, pData?: PathData): Promise<TabNavData>;
-    getBreadcrumbData(path: string, pData?: PathData): Promise<BreadcrumbData>;
+    getBreadcrumbData(path: string, pData?: PathData, onResolve?: (data: BreadcrumbData) => void): Promise<BreadcrumbData>;
+    private resolveBreadcrumbTitles;
     /**
      * Handles changes between navigation nodes by invoking a configured hook function.
      *
@@ -108,4 +109,5 @@ export declare class NavigationService {
      * @returns The constructed path string.
      */
     buildPath(incomingPath: string, options: NavigationOptions): Promise<string>;
+    private buildContextSwitcher;
 }

package/services/preloading.service.d.ts

@@ -0,0 +1,58 @@
+import { Luigi } from '../core-api/luigi';
+import { ViewGroupSettings } from '../types/navigation';
+/**
+ * Service responsible for preloading view group containers in the background.
+ *
+ * Preloading creates hidden luigi-container elements for configured view groups
+ * so that navigating to those groups later is near-instant (the MFE is already initialized).
+ * The service adapts its batch size dynamically based on observed MFE load times.
+ */
+export declare class PreloadingService {
+    private luigi;
+    private preloadBatchSize;
+    shouldPreload: boolean;
+    constructor(luigi: Luigi);
+    /**
+     * Preloads view group containers based on the `navigation.viewGroupSettings` configuration.
+     * Skips view groups that already have a container in the DOM or are currently being preloaded.
+     *
+     * @param batchSize - Maximum number of view groups to preload in this cycle (default: 3).
+     * @param backgroundMfeOnly - If true, only preloads view groups with `loadOnStartup: true`.
+     *   Used during application init to load critical MFEs without competing with the main navigation.
+     */
+    preloadViewGroups(batchSize?: number, backgroundMfeOnly?: boolean): void;
+    /**
+     * Creates a hidden luigi-container for the given view group and appends it to the DOM.
+     * The container loads the `preloadUrl` MFE in the background with `display: none`.
+     *
+     * @param settings - The view group settings containing the preloadUrl.
+     * @param name - The view group name (used as identifier on the container).
+     * @param containerWrapper - The DOM element to append the hidden container to.
+     */
+    preloadContainerOnBackground(settings: ViewGroupSettings, name: string, containerWrapper: HTMLElement): void;
+    /**
+     * Schedules a preload cycle. Uses a flag-based mechanism to skip the very first invocation
+     * and only trigger preloading from the second call onwards.
+     *
+     * @param backgroundMfeOnly - If true, only `loadOnStartup` view groups are preloaded.
+     *   Passed through to `preloadViewGroups`.
+     */
+    preload(backgroundMfeOnly?: boolean): void;
+    /**
+     * Called when a preloaded container has finished initializing (INITIALIZED event).
+     * Measures load time and adapts the batch size for subsequent preload cycles:
+     * - < 500ms  → batchSize 3 (fast connection)
+     * - 500–1000ms → batchSize 2
+     * - > 1000ms → batchSize 1 (slow, be conservative)
+     *
+     * Also schedules clearing the `_luigiPreloading` flag after a short delay,
+     * freeing the container for the next preload cycle.
+     *
+     * @param container - The container element that finished loading.
+     */
+    viewGroupLoaded(container: any): void;
+    /**
+     * Returns all containers in the wrapper that are currently in a preloading state.
+     */
+    private getPreloadingContainers;
+}

package/services/routing.service.d.ts

@@ -2,9 +2,11 @@ import { Luigi } from '../core-api/luigi';
 import { Route } from '../types/routing';
 import { ModalSettings, Node, PathData } from '../types/navigation';
 import { NavigationService } from './navigation.service';
+import { DirtyStatusService } from './dirty-status.service';
 export declare class RoutingService {
     private luigi;
     navigationService?: NavigationService;
+    dirtyStatusService?: DirtyStatusService;
     previousNode: Node | undefined;
     currentRoute?: Route;
     modalSettings?: ModalSettings;
@@ -123,4 +125,14 @@ export declare class RoutingService {
      * @returns {Promise<void>} A promise that resolves when error handling is complete.
      */
     showPageNotFoundError(pathToRedirect: string, notFoundPath: string, isAnyPathMatched?: boolean): Promise<void>;
+    /**
+     * Handles viewUrl misconfiguration scenario. If a node has no viewUrl, no children,
+     * and is not a compound node, it redirects to the root default child node.
+     * @param node - active node data
+     * @param viewUrl - the url of the current mf view
+     * @param previousPathData - previous path data
+     * @param pathUrlRaw - path url without hash
+     * @returns true if misconfiguration was detected and handled
+     */
+    handleViewUrlMisconfigured(node: Node, viewUrl: string, previousPathData: PathData, pathUrlRaw: string): Promise<boolean>;
 }

package/types/connector.d.ts

@@ -1,12 +1,12 @@
-import { AlertHandler, AlertSettings, ConfirmationModalHandler, ConfirmationModalSettings, UserSettings } from '../modules/ux-module';
-import { ModalSettings, LeftNavData, Node, TopNavData, TabNavData, BreadcrumbData, DrawerSettings } from './navigation';
+import { AlertHandler, AlertSettings, ConfirmationModalHandler, ConfirmationModalSettings } from '../modules/ux-module';
+import { ModalSettings, LeftNavData, Node, TopNavData, TabNavData, BreadcrumbData, DrawerSettings, UserSettingsDialogSettings } from './navigation';
 export interface LuigiConnector {
     renderMainLayout(): void;
     renderTopNav(data: TopNavData): void;
     renderLeftNav(data: LeftNavData): void;
     getContainerWrapper(): HTMLElement;
     renderModal(content: HTMLElement, modalSettings: ModalSettings, onCloseCallback?: () => void, onCloseRequest?: () => void): any;
-    renderDrawer(content: HTMLElement, modalSettings: DrawerSettings, onCloseCallback?: () => void): any;
+    renderDrawer(content: HTMLElement, drawerSettings: DrawerSettings, onCloseCallback?: () => void, onCloseRequest?: () => void): any;
     renderTabNav(data: TabNavData): void;
     renderBreadcrumbs(data: BreadcrumbData): void;
     renderAlert(alertSettings: AlertSettings, alertHandler: AlertHandler): void;
@@ -17,7 +17,7 @@ export interface LuigiConnector {
     hideLoadingIndicator(container?: HTMLElement): void;
     addBackdrop(): void;
     removeBackdrop(): void;
-    openUserSettings(settings: UserSettings): void;
+    openUserSettings(dialogSettings: UserSettingsDialogSettings, userSettingData: any[], previousUserSettings: any): void;
     closeUserSettings(): void;
     setCurrentLocale(locale: string): void;
     getCurrentLocale(): string;
@@ -29,5 +29,6 @@ export interface LuigiConnector {
         getLuigiContainer(): HTMLElement | null;
         getNavFooterContainer(): HTMLElement | null;
     };
+    unload(): void;
 }
 export type { Node };

package/types/navigation.d.ts

@@ -1,11 +1,12 @@
 export interface TopNavData {
+    appSwitcher?: AppSwitcher;
     appTitle: string;
+    contextSwitcher?: ContextSwitcher;
     logo: string;
-    topNodes: NavItem[];
+    navClick?: (item: NavItem) => Promise<void>;
     productSwitcher?: ProductSwitcher;
     profile?: ProfileSettings;
-    appSwitcher?: AppSwitcher;
-    navClick?: (item: NavItem) => void;
+    topNodes: NavItem[];
 }
 export interface AppSwitcher {
     showMainAppEntry?: boolean;
@@ -18,6 +19,25 @@ export interface AppSwitcherItem {
     link?: string;
     selectionConditions?: selectionConditions;
 }
+export interface ContextSwitcher {
+    actions?: any[];
+    config?: any;
+    options?: ContextSwitcherItem[];
+    selectedLabel?: string;
+    selectedNodePath?: any;
+    selectedOption?: ContextSwitcherItem;
+    switcherChange?: (selectedValue: string, selectedType?: string | undefined) => void;
+}
+export interface ContextSwitcherItem {
+    clickHandler?: any;
+    customRendererCategory?: any;
+    id?: string;
+    label?: string;
+    link?: string;
+    linkFromPath?: null | string;
+    position?: 'bottom' | 'top';
+    testId?: string;
+}
 export interface selectionConditions {
     route?: string;
     contextCriteria?: ContextCriteria[];
@@ -33,8 +53,14 @@ export interface ProfileSettings {
     items?: ProfileItem[];
     staticUserInfoFn?: () => Promise<UserInfo>;
     onUserInfoUpdate: (fn: (uInfo: UserInfo) => void) => void;
+    settings: UserSettingsProfileMenuEntry;
     itemClick: (item: ProfileItem) => void;
 }
+export interface UserSettingsProfileMenuEntry {
+    label?: string;
+    link?: string;
+    openUserSettings?: () => void;
+}
 export interface ProfileLogout {
     label?: string;
     icon?: string;
@@ -51,6 +77,13 @@ export interface ProfileItem {
     altText?: string;
     openNodeInModal?: boolean | ModalSettings;
 }
+export interface UserSettingsDialogSettings {
+    dialogHeader?: string;
+    saveBtn?: string;
+    dismissBtn?: string;
+    renderMicroFrontendContainer?: (viewUrl: string, groupKey: string) => Promise<any>;
+    onCloseCallback?: (storedUserSettings: any, previousUserSettings: any) => void;
+}
 export interface UserInfo {
     name?: string;
     initials?: string;
@@ -63,7 +96,7 @@ export interface LeftNavData {
     items: NavItem[];
     basePath: string;
     sideNavFooterText?: string;
-    navClick?: (item: NavItem) => void;
+    navClick?: (item: NavItem) => Promise<void>;
 }
 export interface PathData {
     context?: Record<string, any>;
@@ -98,9 +131,11 @@ export interface Node {
     hideFromNav?: boolean;
     hideSideNav?: boolean;
     icon?: string;
+    intendToHaveEmptyViewUrl?: boolean;
     isRootNode?: boolean;
     keepSelectedForChildren?: boolean;
     label?: string;
+    link?: string;
     loadingIndicator?: {
         enabled: boolean;
     };
@@ -113,6 +148,7 @@ export interface Node {
     runTimeErrorHandler?: RunTimeErrorHandler;
     showBreadcrumbs?: boolean;
     tabNav?: boolean;
+    titleResolver?: TitleResolver;
     tooltipText?: string;
     userSettingsGroup?: string;
     viewUrl?: string;
@@ -127,6 +163,7 @@ export interface Node {
     _virtualTree?: Node;
     _virtualPathIndex?: number;
     _virtualViewUrl?: string;
+    _rawContext?: Record<string, any>;
 }
 export interface PageErrorHandler {
     timeout: number;
@@ -157,6 +194,8 @@ export interface BreadcrumbItem {
 export interface NavItem {
     altText?: string;
     category?: Category;
+    externalLink?: ExternalLink;
+    href?: string;
     icon?: string;
     node?: Node;
     label?: string;
@@ -167,7 +206,7 @@ export interface TabNavData {
     selectedNode?: any;
     items?: NavItem[];
     basePath?: string;
-    navClick?: (item: NavItem) => void;
+    navClick?: (item: NavItem) => Promise<void>;
 }
 export interface BreadcrumbData {
     basePath?: string;
@@ -197,6 +236,7 @@ export interface ProductSwitcher {
     items?: [ProductSwitcherItem];
     label?: string;
     testId?: string;
+    productSwitcherItemClick?: (item: ProductSwitcherItem) => void;
 }
 export interface ProductSwitcherItem {
     altText?: string;
@@ -228,6 +268,7 @@ export interface NavigationRequestBase {
 }
 export interface NavigationRequestParams extends NavigationRequestBase {
     drawerSettings?: any;
+    intent?: boolean;
     modalSettings?: any;
     newTab?: boolean;
     path: string;
@@ -440,4 +481,32 @@ export interface RendererConfig {
         maxWidth?: number;
     }>;
 }
+export interface TitleResolverCache {
+    key: string;
+    value: {
+        label: string;
+        icon?: string;
+    };
+}
+export interface TitleResolver {
+    request: {
+        method: string;
+        url: string;
+        headers?: Record<string, string>;
+        body?: any;
+    };
+    titlePropertyChain: string;
+    titleDecorator?: string;
+    iconPropertyChain?: string;
+    prerenderFallback?: boolean;
+    responsePath?: string;
+    fallbackTitle?: string;
+    fallbackIcon?: string;
+    /** @internal runtime cache – not user-configured */
+    _cache?: TitleResolverCache;
+}
+export interface ViewGroupSettings {
+    preloadUrl?: string;
+    loadOnStartup?: boolean;
+}
 export type HistoryMethod = 'pushState' | 'replaceState';

package/utilities/helpers/context-switcher-helpers.d.ts

@@ -0,0 +1,17 @@
+import { Luigi } from '../../core-api/luigi';
+export declare const ContextSwitcherHelpers: {
+    _fallbackLabels: Map<any, any>;
+    resetFallbackLabelCache(): void;
+    getPreparedParentNodePath(config: Record<string, any>): string;
+    generateSwitcherNav(config: Record<string, any>, rawOptions: any[]): any[];
+    getNodePathFromCurrentPath(option: Record<string, any>, selectedOption: Record<string, any>, luigi: Luigi): string;
+    getOptionById(options: any[], id: string): any;
+    getLabelFromOptions(options: any[], id: string): string;
+    isContextSwitcherDetailsView(currentPath: string, parentNodePath: string): boolean;
+    getFallbackLabel(fallbackLabelResolver: any, id: string, luigi: Luigi): Promise<string>;
+    getSelectedId(currentPath: string, options: any[], parentNodePath: string): string | undefined;
+    getSelectedOption(currentPath: string, options: any[], parentNodePath: string): any;
+    getSelectedLabel(currentPath: string, options: any[], parentNodePath: string, fallbackLabelResolver: any, luigi: Luigi): Promise<string | undefined>;
+    getSelectedNode(currentPath: string, options: any[], parentNodePath: string): string | undefined;
+    fetchOptions(luigi: Luigi, existingOptions?: never[]): Promise<any[]>;
+};

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

@@ -65,12 +65,24 @@ export declare const GenericHelpers: {
      * @returns {string} string without leading slash
      */
     trimLeadingSlash: (str: string) => string;
+    /**
+     * Adds a trailing slash to a string if it has none
+     * @param {string} str string to be checked
+     * @returns {string} string with a trailing slash
+     */
+    addTrailingSlash: (str: string) => string;
     /**
      * Prepend current url to redirect_uri, if it is a relative path
      * @param {string} str string from which any number of trailing slashes should be removed
      * @returns {string} string without any trailing slash
      */
     trimTrailingSlash: (str: string) => string;
+    /**
+     * Returns a path that starts and end with one (and only one) slash, regardless of the slashes being already present in the path given as input
+     * @param {string} str path to normalize
+     * @returns {string} path that starts and ends with a slash
+     */
+    normalizePath: (str: string) => string;
     /**
      * Checks if HTML element is visible
      * @param {Element} element to be checked in DOM
@@ -124,7 +136,7 @@ export declare const GenericHelpers: {
      * @param parenthesis
      * @returns
      */
-    replaceVars(inputString: string, params: Record<string, any>, prefix: string, parenthesis?: boolean): string;
+    replaceVars(inputString: string, params: Record<string, any>, prefix: string, parenthesis?: boolean, slashStop?: boolean): string;
     /**
      *  Escapes special characters in a string for use in a regular expression.
      * @param string

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

@@ -0,0 +1,3 @@
+export declare class I18nHelpers {
+    static hasLocaleChangePermission(containerElement: any): boolean;
+}

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 '../../types/navigation';
+import { AppSwitcher, ExternalLink, Node, PathData, TitleResolver } from '../../types/navigation';
 export declare const NavigationHelpers: {
     normalizePath: (raw: string) => string;
     segmentMatches: (linkSegment: string, pathSegment: string, pathParams: Record<string, any>) => boolean;
@@ -8,10 +8,9 @@ export declare const NavigationHelpers: {
     checkVisibleForFeatureToggles: (nodeToCheckPermission: any, featureToggles: FeatureToggles) => boolean;
     generateTooltipText: (node: Node, translation: string, luigi: Luigi) => string;
     isNodeAccessPermitted: (nodeToCheckPermissionFor: Node, parentNode: Node | undefined, currentContext: Record<string, any>, luigi: Luigi) => boolean;
-    applyContext: (context: Record<string, any>, addition: Record<string, any>, navigationContext: any) => Record<string, any>;
     updateHeaderTitle: (appSwitcherData: AppSwitcher, pathData: PathData) => string | undefined;
     buildPath(pathToLeftNavParent: Node[], pathData?: PathData): string;
-    mergeContext(...objs: Record<string, any>[]): Record<string, any>;
+    mergeContext(base: Record<string, any>, addition?: Record<string, any>, navigationContext?: string): 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.
@@ -27,4 +26,23 @@ export declare const NavigationHelpers: {
      * @returns The redirect path if valid, undefined otherwise
      */
     validatePathAndGetRedirect: (path: string, luigi: Luigi) => Promise<string | undefined>;
+    fetchNodeTitleData(node: Node, context: any): Promise<{
+        label: string;
+        icon?: string;
+    }>;
+    /**
+     * Returns a nested property value defined by a chain string
+     * @param {*} obj - the object
+     * @param {*} propChain - a string defining the property chain
+     * @param {*} fallback - fallback value if resolution fails
+     * @returns the value or fallback
+     */
+    getPropertyChainValue(obj: Record<string, unknown>, propChain?: string, fallback?: any): any;
+    substituteVars(resolver: TitleResolver, context: Record<string, unknown>): TitleResolver;
+    _fetch(url: string, options: RequestInit): Promise<Response>;
+    processTitleData(data: Record<string, unknown>, resolver: TitleResolver): {
+        label: string;
+        icon?: string;
+    };
+    openExternalLink(externalLink: ExternalLink, pathParams?: Record<string, any>): void;
 };