@luigi-project/core-modular 0.0.19 → 0.0.20-dev.202610210048

package/modules/ui-module.d.ts

@@ -11,9 +11,9 @@ export declare const UIModule: {
     drawerContainer: any;
     init: (luigi: Luigi) => void;
     update: (scopes?: string[]) => Promise<void>;
-    updateMainContent: (currentNode: Node, luigi: Luigi, luigiParams?: LuigiParams, withoutSync?: boolean, preventContextUpdate?: boolean) => Promise<void>;
+    updateMainContent: (currentNode: Node, luigi: Luigi, luigiParams?: LuigiParams, withoutSync?: boolean, preventContextUpdate?: boolean, preserveView?: boolean) => Promise<void>;
     openModal: (luigi: Luigi, node: Node, modalSettings: ModalSettings, onCloseCallback?: (goBackValue?: any) => void, luigiParams?: LuigiParams) => Promise<void>;
     updateModalSettings: (modalSettings: ModalSettings, addHistoryEntry: boolean, luigi: Luigi) => void;
-    openDrawer: (luigi: Luigi, node: Node, drawerSettings: DrawerSettings, onCloseCallback?: () => void, luigiParams?: LuigiParams) => Promise<void>;
-    openUserSettings: (userSettingsDialogSettings: UserSettingsDialogSettings, userSettingData: any, previousUserSettings: any, luigi: Luigi) => Promise<void>;
+    openDrawer: (luigi: Luigi, node: Node, drawerSettings: DrawerSettings, onCloseCallback?: (goBackValue?: any) => void, luigiParams?: LuigiParams) => Promise<void>;
+    openUserSettings: (userSettingsDialogSettings: UserSettingsDialogSettings, userSettingData: any, previousUserSettings: any, initialUserSettings: any, luigi: Luigi) => Promise<void>;
 };

package/package.json

@@ -18,5 +18,5 @@
     "micro-frontends",
     "microfrontends"
   ],
-  "version": "0.0.19"
+  "version": "0.0.20-dev.202610210048"
 }

package/services/navigation.service.d.ts

@@ -4,12 +4,24 @@ import { ModalService } from './modal.service';
 import { NodeDataManagementService } from './node-data-management.service';
 export declare class NavigationService {
     private luigi;
+    _preservedViews: any[];
     modalService?: ModalService;
     nodeDataManagementService?: NodeDataManagementService;
+    private goBackContext;
     private previousBreadcrumbs;
     constructor(luigi: Luigi);
     private getModalService;
     private getNodeDataManagementService;
+    private handleDialogContainer;
+    private prepareGoBackContextForNavigation;
+    clearGoBackContext(): void;
+    getGoBackContext(): Record<string, any> | null;
+    clearPreservedViews(): void;
+    removeLastPreservedView(): void;
+    getPreservedViewsLength(): number;
+    isValidBackRoute(route: string): boolean;
+    processGoBackContext(goBackContext: any): void;
+    handleGoBackRequest(goBackContext?: any): void;
     getPathData(path: string): Promise<PathData>;
     findMatchingNode(urlPathElement: string, nodes: Node[]): Node | undefined;
     buildNavItems(nodes: Node[], selectedNode: Node | undefined, pathData: PathData): Promise<{
@@ -73,7 +85,7 @@ export declare class NavigationService {
      * 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 {boolean} 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)

package/services/routing.service.d.ts

@@ -38,12 +38,13 @@ export declare class RoutingService {
      * @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
+     * @param {boolean} preserveView - preserve a view by setting it to true
      * @returns {Promise<void>} A promise that resolves when route change is complete.
      */
     handleRouteChange(routeInfo: {
         path: string;
         query: string;
-    }, withoutSync?: boolean, preventContextUpdate?: boolean): Promise<void>;
+    }, withoutSync?: boolean, preventContextUpdate?: boolean, preserveView?: boolean): Promise<void>;
     getCurrentRoute(): Route | undefined;
     /**
      * If `showModalPathInUrl` is provided, bookmarkable modal path will be triggered.

package/types/connector.d.ts

@@ -220,19 +220,21 @@ export interface LuigiConnector {
      *
      * Core invokes `dialogSettings.renderMicroFrontendContainer(viewUrl, groupKey)`
      * (which it installs before calling this method) to mount per-group MFEs
-     * inside the dialog, and `dialogSettings.onCloseCallback(stored, previous)`
-     * when the dialog closes — the connector is responsible for calling both
-     * at the appropriate moments.
+     * inside the dialog, and `dialogSettings.onCloseCallback(stored)` when the
+     * dialog closes — the connector is responsible for calling both at the
+     * appropriate moments.
      *
-     * @param dialogSettings dialog header, save/dismiss button labels, plus
-     *   the two core-installed hooks (`renderMicroFrontendContainer`,
+     * @param dialogSettings dialog header, save/dismiss button labels, plus the
+     *   two core-installed hooks (`renderMicroFrontendContainer`,
      *   `onCloseCallback`) the connector must invoke.
      * @param userSettingData static schema describing the available
      *   user-settings groups (one entry per group).
-     * @param previousUserSettings persisted user-settings state to prefill
-     *   the dialog with, or `null` on first open.
+     * @param initialUserSettings the complete settings object the connector
+     *   should use as the dialog's initial state — defaults for every configured
+     *   setting, overlaid with the persisted values. Core builds this, so the
+     *   connector never has to prefill defaults itself.
      */
-    openUserSettings(dialogSettings: UserSettingsDialogSettings, userSettingData: Record<string, any>[], previousUserSettings: Record<string, any> | null): void;
+    openUserSettings(dialogSettings: UserSettingsDialogSettings, userSettingData: Record<string, any>[], initialUserSettings: Record<string, any>): void;
     /**
      * Close a user-settings dialog opened via `openUserSettings`.
      * Called from `Luigi.ux().closeUserSettings()` and on

package/types/navigation.d.ts

@@ -89,7 +89,7 @@ export interface UserSettingsDialogSettings {
     saveBtn?: string;
     dismissBtn?: string;
     renderMicroFrontendContainer?: (viewUrl: string, groupKey: string) => Promise<any>;
-    onCloseCallback?: (storedUserSettings: any, previousUserSettings: any) => void;
+    onCloseCallback?: (storedUserSettings: any) => void;
 }
 export interface UserInfo {
     name?: string;
@@ -298,6 +298,7 @@ export interface NavigationOptions {
     nodeParams?: Record<string, any>;
 }
 export interface NavigationRequestBase {
+    preserveView?: boolean;
     preventContextUpdate?: boolean;
     preventHistoryEntry?: boolean;
     withoutSync?: boolean;
@@ -309,27 +310,26 @@ export interface NavigationRequestParams extends NavigationRequestBase {
     modalSettings?: any;
     newTab?: boolean;
     path: string;
-    preserveView?: string;
 }
 export interface NavigationRequestEvent {
     detail: NavigationRequestBase;
 }
 export interface NavigationRequestDetail {
     drawer: unknown;
-    link: string;
+    fromClosestContext: boolean;
+    fromContext: string | null;
+    fromParent: boolean;
+    fromVirtualTreeRoot: boolean;
     intent: boolean;
-    preserveView: string;
+    link: string;
     modal: unknown;
     newTab: boolean;
-    withoutSync: boolean;
+    nodeParams: Record<string, string>;
+    preserveView: boolean;
     preventContextUpdate: boolean;
     preventHistoryEntry: boolean;
-    fromVirtualTreeRoot: boolean;
-    fromContext: string | null;
-    fromClosestContext: boolean;
-    fromParent: boolean;
     relative: boolean;
-    nodeParams: Record<string, string>;
+    withoutSync: boolean;
 }
 export type { CompoundConfig, LayoutConfig, RendererConfig } from './compound-config';
 export interface TitleResolverCache {

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 '../../types/navigation';
+import { Node, PathData, ModalSettings } from '../../types/navigation';
 export declare const RoutingHelpers: {
     defaultContentViewParamPrefix: string;
     defaultQueryParamSeparator: string;
@@ -243,6 +243,20 @@ export declare const RoutingHelpers: {
      */
     parseParams(paramsString: string): Record<string, string>;
     getModalParamsFromPath(luigi: Luigi): any;
+    /**
+     * Returns only the modal settings that may be persisted in the bookmarkable
+     * `modalParams` query string. Everything else is dropped so non-bookmarkable
+     * settings never leak into the URL:
+     * - `nodeParams` are already serialized onto the modal path
+     * - `closebtn_data_testid` is a rendering-only detail
+     *
+     * `keepPrevious` is only kept when truthy (its default/false state is noise).
+     * Properties are copied by explicit name (no computed property writes) to
+     * avoid remote property injection. Returns a shallow copy; the input is left untouched.
+     * @param {ModalSettings} modalParams modal settings about to be written to the URL
+     * @returns {Partial<ModalSettings>} a copy containing only the bookmarkable properties
+     */
+    getBookmarkableModalParams(modalParams: ModalSettings): Partial<ModalSettings>;
     /**
      * Get the query param separator which is used with hashRouting
      * Default:

package/utilities/helpers/usersetting-dialog-helpers.d.ts

@@ -1,5 +1,18 @@
 declare class UserSettingsHelperClass {
     processUserSettingGroups(userSettings: any, storedSettings: any): any[];
+    /**
+     * Builds the complete user-settings object that should be stored.
+     *
+     * Every setting defined in the configuration is prefilled with a default
+     * (empty string), then overlaid with the persisted values. This guarantees
+     * that the stored object always contains the full set of properties, not
+     * only the ones that were changed in the dialog (mirrors Luigi core).
+     *
+     * @param userSettingData schema as returned by `processUserSettingGroups`
+     * @param previousUserSettings persisted user-settings state, or `null`/`{}`
+     * @returns a settings object keyed by group, each group prefilled with defaults
+     */
+    prepareUserSettingsObj(userSettingData: any[], previousUserSettings: Record<string, any> | null): Record<string, any>;
     getUserSettingsIframesInDom(): HTMLElement[];
     hideUserSettingsIframe(): void;
     findActiveCustomUserSettingsIframe(eventSource: any): any;