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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -15,5 +15,5 @@ export declare const UIModule: {
15
15
  openModal: (luigi: Luigi, node: Node, modalSettings: ModalSettings, onCloseCallback?: (goBackValue?: any) => void, luigiParams?: LuigiParams) => Promise<void>;
16
16
  updateModalSettings: (modalSettings: ModalSettings, addHistoryEntry: boolean, luigi: Luigi) => void;
17
17
  openDrawer: (luigi: Luigi, node: Node, drawerSettings: DrawerSettings, onCloseCallback?: () => void, luigiParams?: LuigiParams) => Promise<void>;
18
- openUserSettings: (userSettingsDialogSettings: UserSettingsDialogSettings, userSettingData: any, previousUserSettings: any, luigi: Luigi) => Promise<void>;
18
+ openUserSettings: (userSettingsDialogSettings: UserSettingsDialogSettings, userSettingData: any, previousUserSettings: any, initialUserSettings: any, luigi: Luigi) => Promise<void>;
19
19
  };
package/package.json CHANGED
@@ -18,5 +18,5 @@
18
18
  "micro-frontends",
19
19
  "microfrontends"
20
20
  ],
21
- "version": "0.0.19"
21
+ "version": "0.0.20-dev.202610200049"
22
22
  }
@@ -220,19 +220,21 @@ export interface LuigiConnector {
220
220
  *
221
221
  * Core invokes `dialogSettings.renderMicroFrontendContainer(viewUrl, groupKey)`
222
222
  * (which it installs before calling this method) to mount per-group MFEs
223
- * inside the dialog, and `dialogSettings.onCloseCallback(stored, previous)`
224
- * when the dialog closes — the connector is responsible for calling both
225
- * at the appropriate moments.
223
+ * inside the dialog, and `dialogSettings.onCloseCallback(stored)` when the
224
+ * dialog closes — the connector is responsible for calling both at the
225
+ * appropriate moments.
226
226
  *
227
- * @param dialogSettings dialog header, save/dismiss button labels, plus
228
- * the two core-installed hooks (`renderMicroFrontendContainer`,
227
+ * @param dialogSettings dialog header, save/dismiss button labels, plus the
228
+ * two core-installed hooks (`renderMicroFrontendContainer`,
229
229
  * `onCloseCallback`) the connector must invoke.
230
230
  * @param userSettingData static schema describing the available
231
231
  * user-settings groups (one entry per group).
232
- * @param previousUserSettings persisted user-settings state to prefill
233
- * the dialog with, or `null` on first open.
232
+ * @param initialUserSettings the complete settings object the connector
233
+ * should use as the dialog's initial state — defaults for every configured
234
+ * setting, overlaid with the persisted values. Core builds this, so the
235
+ * connector never has to prefill defaults itself.
234
236
  */
235
- openUserSettings(dialogSettings: UserSettingsDialogSettings, userSettingData: Record<string, any>[], previousUserSettings: Record<string, any> | null): void;
237
+ openUserSettings(dialogSettings: UserSettingsDialogSettings, userSettingData: Record<string, any>[], initialUserSettings: Record<string, any>): void;
236
238
  /**
237
239
  * Close a user-settings dialog opened via `openUserSettings`.
238
240
  * Called from `Luigi.ux().closeUserSettings()` and on
@@ -89,7 +89,7 @@ export interface UserSettingsDialogSettings {
89
89
  saveBtn?: string;
90
90
  dismissBtn?: string;
91
91
  renderMicroFrontendContainer?: (viewUrl: string, groupKey: string) => Promise<any>;
92
- onCloseCallback?: (storedUserSettings: any, previousUserSettings: any) => void;
92
+ onCloseCallback?: (storedUserSettings: any) => void;
93
93
  }
94
94
  export interface UserInfo {
95
95
  name?: string;
@@ -1,6 +1,6 @@
1
1
  import { FeatureToggles } from '../../core-api/feature-toggles';
2
2
  import { Luigi } from '../../core-api/luigi';
3
- import { Node, PathData } from '../../types/navigation';
3
+ import { Node, PathData, ModalSettings } from '../../types/navigation';
4
4
  export declare const RoutingHelpers: {
5
5
  defaultContentViewParamPrefix: string;
6
6
  defaultQueryParamSeparator: string;
@@ -243,6 +243,20 @@ export declare const RoutingHelpers: {
243
243
  */
244
244
  parseParams(paramsString: string): Record<string, string>;
245
245
  getModalParamsFromPath(luigi: Luigi): any;
246
+ /**
247
+ * Returns only the modal settings that may be persisted in the bookmarkable
248
+ * `modalParams` query string. Everything else is dropped so non-bookmarkable
249
+ * settings never leak into the URL:
250
+ * - `nodeParams` are already serialized onto the modal path
251
+ * - `closebtn_data_testid` is a rendering-only detail
252
+ *
253
+ * `keepPrevious` is only kept when truthy (its default/false state is noise).
254
+ * Properties are copied by explicit name (no computed property writes) to
255
+ * avoid remote property injection. Returns a shallow copy; the input is left untouched.
256
+ * @param {ModalSettings} modalParams modal settings about to be written to the URL
257
+ * @returns {Partial<ModalSettings>} a copy containing only the bookmarkable properties
258
+ */
259
+ getBookmarkableModalParams(modalParams: ModalSettings): Partial<ModalSettings>;
246
260
  /**
247
261
  * Get the query param separator which is used with hashRouting
248
262
  * Default:
@@ -1,5 +1,18 @@
1
1
  declare class UserSettingsHelperClass {
2
2
  processUserSettingGroups(userSettings: any, storedSettings: any): any[];
3
+ /**
4
+ * Builds the complete user-settings object that should be stored.
5
+ *
6
+ * Every setting defined in the configuration is prefilled with a default
7
+ * (empty string), then overlaid with the persisted values. This guarantees
8
+ * that the stored object always contains the full set of properties, not
9
+ * only the ones that were changed in the dialog (mirrors Luigi core).
10
+ *
11
+ * @param userSettingData schema as returned by `processUserSettingGroups`
12
+ * @param previousUserSettings persisted user-settings state, or `null`/`{}`
13
+ * @returns a settings object keyed by group, each group prefilled with defaults
14
+ */
15
+ prepareUserSettingsObj(userSettingData: any[], previousUserSettings: Record<string, any> | null): Record<string, any>;
3
16
  getUserSettingsIframesInDom(): HTMLElement[];
4
17
  hideUserSettingsIframe(): void;
5
18
  findActiveCustomUserSettingsIframe(eventSource: any): any;