@luigi-project/core-modular 0.0.19 → 0.0.20

package/modules/ui-module.d.ts

@@ -15,5 +15,5 @@ export declare const UIModule: {
     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>;
+    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"
 }

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;

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;