@luigi-project/core-modular 0.0.10-dev.202606260113 → 0.0.10-dev.202606270109

package/modules/ux-module.d.ts

@@ -1,42 +1,14 @@
 import { LuigiCompoundContainer, LuigiContainer } from '@luigi-project/container';
 import { Luigi } from '../core-api/luigi';
-export interface AlertSettings {
-    closeAfter?: number;
-    id?: string;
-    links?: Record<string, Link>;
-    text?: string;
-    ttl?: number;
-    type?: string;
-}
-export interface AlertHandler {
-    openFromClient: boolean;
-    close(): void;
-    link(linkKey: string): boolean;
-}
+import { AlertSettings, ConfirmationModalSettings, Link } from '../types/ux';
+export type { AlertHandler, AlertSettings, ConfirmationModalHandler, ConfirmationModalSettings, Link } from '../types/ux';
 export interface ProcessedAlertSettings {
     settings: AlertSettings;
 }
-export interface Link {
-    elemId: string;
-    url?: string;
-    dismissKey?: string;
-}
 export interface ProcessedTextAndLinks {
     sanitizedText: string;
     links: Link[];
 }
-export interface ConfirmationModalSettings {
-    icon?: string;
-    type?: string;
-    header?: string;
-    body?: string;
-    buttonConfirm?: string;
-    buttonDismiss?: string;
-}
-export interface ConfirmationModalHandler {
-    confirm(): void;
-    dismiss(): void;
-}
 export interface UserSettings {
     [key: string]: number | string | boolean;
 }

package/package.json

@@ -18,5 +18,5 @@
     "micro-frontends",
     "microfrontends"
   ],
-  "version": "0.0.10-dev.202606260113"
+  "version": "0.0.10-dev.202606270109"
 }

package/services/global-search.service.d.ts

@@ -1,4 +1,4 @@
-import { GlobalSearchProvider, SearchResultItem } from '../core-api/global-search';
+import { GlobalSearchProvider, SearchResultItem } from '../types/global-search';
 import { Luigi } from '../core-api/luigi';
 export declare class GlobalSearchService {
     private luigi;
@@ -8,6 +8,7 @@ export declare class GlobalSearchService {
     searchResult: SearchResultItem[];
     constructor(luigi: Luigi);
     get searchProvider(): GlobalSearchProvider;
+    private getHandler;
     hasSearchProvider(): boolean;
     getFieldVisibility(): boolean;
     setFieldVisibility(value: boolean): void;

package/types/compound-config.d.ts

@@ -0,0 +1,204 @@
+/**
+ * Configuration for compound web components in Luigi.
+ * Compound allows you to layout multiple web components in one micro frontend.
+ */
+export interface CompoundConfig {
+    /**
+     * Renderer configuration for the compound layout
+     */
+    renderer?: {
+        /**
+         * The renderer to use - can be 'grid', a custom renderer object, or undefined for default
+         */
+        use?: 'grid' | string | {
+            /**
+             * Base renderer to extend (e.g., 'grid')
+             */
+            extends?: string;
+            /**
+             * Custom function to create the compound container
+             * @param config - The renderer configuration
+             * @param renderer - The parent/super renderer (if extending)
+             */
+            createCompoundContainer?: (config: RendererConfig, renderer?: any) => HTMLDivElement;
+            /**
+             * Custom function to create individual compound item containers
+             * @param layoutConfig - Layout configuration for the item
+             * @param config - The overall renderer configuration
+             * @param renderer - The parent/super renderer (if extending)
+             */
+            createCompoundItemContainer?: (layoutConfig?: LayoutConfig, config?: RendererConfig, renderer?: any) => HTMLDivElement;
+            /**
+             * Custom function to attach an item to the compound container
+             * @param compoundCnt - The compound container element
+             * @param compoundItemCnt - The item container to attach
+             * @param renderer - The parent/super renderer (if extending)
+             */
+            attachCompoundItem?: (compoundCnt: HTMLElement, compoundItemCnt: HTMLElement, renderer?: any) => void;
+        };
+        /**
+         * Configuration for the grid layout
+         */
+        config?: {
+            /**
+             * CSS grid-template-columns value (e.g., '1fr 2fr')
+             */
+            columns?: string;
+            /**
+             * CSS grid-template-rows value (e.g., '150px 150px')
+             */
+            rows?: string;
+            /**
+             * CSS grid-gap value (e.g., 'auto', '10px')
+             */
+            gap?: string;
+            /**
+             * Minimum height for the grid container
+             */
+            minHeight?: string;
+            /**
+             * Responsive layout configurations for different viewport sizes
+             */
+            layouts?: Array<{
+                /**
+                 * CSS grid-template-columns for this breakpoint
+                 */
+                columns?: string | number;
+                /**
+                 * CSS grid-template-rows for this breakpoint
+                 */
+                rows?: string | number;
+                /**
+                 * CSS grid-gap for this breakpoint
+                 */
+                gap?: string | number;
+                /**
+                 * Minimum viewport width for this layout (in pixels)
+                 */
+                minWidth?: number;
+                /**
+                 * Maximum viewport width for this layout (in pixels)
+                 */
+                maxWidth?: number;
+            }>;
+        };
+    };
+    /**
+     * Lazy loading configuration for compound children
+     */
+    lazyLoadingOptions?: {
+        /**
+         * Enable lazy loading using IntersectionObserver
+         * @default false
+         */
+        enabled?: boolean;
+        /**
+         * IntersectionObserver rootMargin option
+         * Controls when children are loaded relative to viewport visibility
+         * @default "0px"
+         */
+        intersectionRootMargin?: string;
+        /**
+         * Default temporary height for child containers before they load
+         * @default "500px"
+         */
+        temporaryContainerHeight?: string;
+        /**
+         * Disable automatic temporary container heights
+         * Useful for custom renderers that manage heights themselves
+         * @default false
+         */
+        noTemporaryContainerHeight?: boolean;
+    };
+    /**
+     * Array of child web component configurations
+     */
+    children?: Array<{
+        /**
+         * Unique identifier for this child web component
+         */
+        id: string;
+        /**
+         * URL pointing to the web component JavaScript file
+         * Supports {i18n.currentLocale} placeholder for localization
+         */
+        viewUrl: string;
+        /**
+         * Context object passed to the web component
+         */
+        context?: Record<string, any>;
+        /**
+         * Layout configuration for positioning this child
+         */
+        layoutConfig?: {
+            /**
+             * CSS grid-row value (e.g., '1 / 3', 'auto')
+             * @default "auto"
+             */
+            row?: string;
+            /**
+             * CSS grid-column value (e.g., '1 / -1', 'auto')
+             * @default "auto"
+             */
+            column?: string;
+            /**
+             * Slot name for nested web components
+             * Use this instead of row/column to plug into a parent's slot
+             */
+            slot?: string;
+            /**
+             * Override the default temporary container height for this specific child
+             * Only used when lazy loading is enabled
+             * * @default undefined
+             */
+            temporaryContainerHeight?: string;
+        };
+        /**
+         * Event listeners for cross-component communication via event bus
+         */
+        eventListeners?: Array<{
+            /**
+             * ID of the source web component (use '*' for any source)
+             */
+            source: string;
+            /**
+             * Name of the event to listen for
+             */
+            name: string;
+            /**
+             * Type of action to perform (e.g., 'update')
+             */
+            action: string;
+            /**
+             * Optional function to convert event data before passing to listener
+             * @param data - The event data
+             */
+            dataConverter?: (data: any) => any;
+        }>;
+    }>;
+}
+/**
+ * Supporting type for layout configuration
+ */
+export interface LayoutConfig {
+    column?: string;
+    row?: string;
+    slot?: string;
+    temporaryContainerHeight?: string;
+}
+/**
+ * Supporting type for renderer configuration
+ */
+export interface RendererConfig {
+    columns?: string;
+    rows?: string;
+    gap?: string;
+    minHeight?: string;
+    layouts?: Array<{
+        columns?: string;
+        rows?: string;
+        gap?: string | number;
+        minWidth?: number;
+        maxWidth?: number;
+    }>;
+}

package/types/connector.d.ts

@@ -1,13 +1,14 @@
-import { SearchResultItem } from '../core-api/global-search';
-import { AlertHandler, AlertSettings, ConfirmationModalHandler, ConfirmationModalSettings } from '../modules/ux-module';
+import { CoreAPISupportedElements } from './dom-elements';
+import { GlobalSearchHandler } from './global-search';
+import { AlertHandler, AlertSettings, ConfirmationModalHandler, ConfirmationModalSettings } from './ux';
 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, drawerSettings: DrawerSettings, onCloseCallback?: () => void, onCloseRequest?: () => void): any;
+    renderModal(content: HTMLElement, modalSettings: ModalSettings, onCloseCallback?: () => void, onCloseRequest?: () => void): void;
+    renderDrawer(content: HTMLElement, drawerSettings: DrawerSettings, onCloseCallback?: () => void, onCloseRequest?: () => void): void;
     renderTabNav(data: TabNavData): void;
     renderBreadcrumbs(data: BreadcrumbData): void;
     renderAlert(alertSettings: AlertSettings, alertHandler: AlertHandler): void;
@@ -18,26 +19,14 @@ export interface LuigiConnector {
     hideLoadingIndicator(container?: HTMLElement): void;
     addBackdrop(): void;
     removeBackdrop(): void;
-    openUserSettings(dialogSettings: UserSettingsDialogSettings, userSettingData: any[], previousUserSettings: any): void;
+    openUserSettings(dialogSettings: UserSettingsDialogSettings, userSettingData: Record<string, any>[], previousUserSettings: Record<string, any> | null): void;
     closeUserSettings(): void;
     setCurrentLocale(locale: string): void;
     getCurrentLocale(): string;
     updateModalSettings(modalSettings: ModalSettings): void;
     showFatalError(error: string): void;
-    getCoreAPISupportedElements(): {
-        getShellbarElement(): HTMLElement | null;
-        getShellbarActions(): HTMLElement | null;
-        getLuigiContainer(): HTMLElement | null;
-        getNavFooterContainer(): HTMLElement | null;
-    };
+    getCoreAPISupportedElements(): CoreAPISupportedElements;
     unload(): void;
-    openSearchField(): void;
-    closeSearchField(): void;
-    clearSearchField(): void;
-    showSearchResult(searchResultItems: SearchResultItem[], searchQuery: string, isCentered: boolean, onShowCallback: (rendererSlot?: any) => void): void;
-    closeSearchResult(): void;
-    setSearchString(searchString: string, onSetCallback: (inputElem?: HTMLInputElement) => void): void;
-    setSearchInputPlaceholder(placeholder: string): void;
-    toggleSearch(isSearchFieldVisible: boolean, onToggleCallback: (inputElem?: HTMLInputElement) => void): void;
+    getGlobalSearchHandler?(): GlobalSearchHandler;
 }
 export type { Node };

package/types/dom-elements.d.ts

@@ -0,0 +1,13 @@
+/**
+ * DOM elements the connector exposes to Luigi's core API.
+ *
+ * Returned from `LuigiConnector.getCoreAPISupportedElements()` and consumed by
+ * `Luigi.elements()` to give micro-frontend authors access to shell-owned
+ * regions of the page.
+ */
+export interface CoreAPISupportedElements {
+    getShellbarElement(): HTMLElement | null;
+    getShellbarActions(): HTMLElement | null;
+    getLuigiContainer(): HTMLElement | null;
+    getNavFooterContainer(): HTMLElement | null;
+}

package/types/global-search.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Top-level `globalSearch` section of the Luigi configuration.
+ *
+ * See https://docs.luigi-project.io/docs/navigation-parameters-reference?section=global-search.
+ */
+export interface GlobalSearch {
+    /**
+     * Disables Luigi's internal keyup/etc. handlers on the search input field.
+     * When `true`, a `searchProvider` must be defined to attach custom logic.
+     */
+    disableInputHandlers?: boolean;
+    /**
+     * Label for the cancel button shown next to the search field on small viewports
+     * in centered mode. Only used when `searchFieldCentered` is active. Defaults to
+     * `'Cancel'`.
+     */
+    globalSearchCenteredCancelButton?: string;
+    /**
+     * Render the search input in the center of the shellbar instead of inline.
+     */
+    searchFieldCentered?: boolean;
+    /**
+     * Provider object carrying the renderers and event callbacks Luigi invokes
+     * during search interaction.
+     */
+    searchProvider?: GlobalSearchProvider;
+}
+export interface GlobalSearchProvider {
+    customSearchResultItemRenderer?: (searchResultItem: any, slot: HTMLLIElement, searchApiObj: any) => object;
+    customSearchResultRenderer?: (searchResults: any[], slot: HTMLDivElement, searchApiObj: any) => object;
+    /**
+     * Placeholder text for the search input. May be a plain string, a function
+     * returning a string, or a locale-keyed map (`{ en: '...', de: '...' }`).
+     */
+    inputPlaceholder?: string | (() => string) | Record<string, string>;
+    onEnter?: () => void;
+    onEscape?: () => void;
+    onInput?: () => void;
+    onSearchBtnClick?: () => void;
+    onSearchResultItemSelected?: (searchResultItem: any) => void;
+    toggleSearch?: (element: HTMLInputElement, visible: boolean) => void;
+}
+export interface SearchResultItem {
+    description: string;
+    label: string;
+    pathObject: Record<string, any>;
+}
+/**
+ * Imperative global-search surface exposed by a Luigi connector.
+ *
+ * The connector returns this handler from `getGlobalSearchHandler()`; if the
+ * connector does not implement global search, it may omit `getGlobalSearchHandler`
+ * entirely.
+ */
+export interface GlobalSearchHandler {
+    openSearchField(): void;
+    closeSearchField(): void;
+    clearSearchField(): void;
+    showSearchResult(searchResultItems: SearchResultItem[], searchQuery: string, isCentered: boolean, onShowCallback: (rendererSlot?: any) => void): void;
+    closeSearchResult(): void;
+    setSearchString(searchString: string, onSetCallback: (inputElem?: HTMLInputElement) => void): void;
+    setSearchInputPlaceholder(placeholder: string): void;
+    toggleSearch(isSearchFieldVisible: boolean, onToggleCallback: (inputElem?: HTMLInputElement) => void): void;
+}

package/types/navigation.d.ts

@@ -1,9 +1,10 @@
-import { GlobalSearchProvider } from '../core-api/global-search';
+import { GlobalSearch } from './global-search';
+import { CompoundConfig } from './compound-config';
 export interface TopNavData {
     appSwitcher?: AppSwitcher;
     appTitle: string;
     contextSwitcher?: ContextSwitcher;
-    globalSearchConfig?: GlobalSearchProvider;
+    globalSearch?: GlobalSearch;
     logo: string;
     navClick?: (item: NavItem) => Promise<void>;
     productSwitcher?: ProductSwitcher;
@@ -219,9 +220,12 @@ export interface BreadcrumbData {
     renderer?: any;
     selectedNode?: Node;
 }
+export interface DrawerHeader {
+    title: string;
+}
 export interface DrawerSettings {
     backdrop?: boolean;
-    header?: any;
+    header?: DrawerHeader;
     overlap?: boolean;
     size?: 'l' | 'm' | 's' | 'xs';
 }
@@ -257,11 +261,11 @@ export interface ExternalLink {
     sameWindow?: boolean;
 }
 export interface NavigationOptions {
-    fromContext?: any;
+    fromContext?: string | null;
     fromClosestContext?: boolean;
     fromVirtualTreeRoot?: boolean;
     fromParent?: boolean;
-    relative?: any;
+    relative?: boolean;
     nodeParams?: Record<string, any>;
 }
 export interface NavigationRequestBase {
@@ -292,216 +296,13 @@ export interface NavigationRequestDetail {
     preventContextUpdate: boolean;
     preventHistoryEntry: boolean;
     fromVirtualTreeRoot: boolean;
-    fromContext: boolean;
+    fromContext: string | null;
     fromClosestContext: boolean;
     fromParent: boolean;
     relative: boolean;
     nodeParams: Record<string, string>;
 }
-/**
- * Configuration for compound web components in Luigi.
- * Compound allows you to layout multiple web components in one micro frontend.
- */
-export interface CompoundConfig {
-    /**
-     * Renderer configuration for the compound layout
-     */
-    renderer?: {
-        /**
-         * The renderer to use - can be 'grid', a custom renderer object, or undefined for default
-         */
-        use?: 'grid' | string | {
-            /**
-             * Base renderer to extend (e.g., 'grid')
-             */
-            extends?: string;
-            /**
-             * Custom function to create the compound container
-             * @param config - The renderer configuration
-             * @param renderer - The parent/super renderer (if extending)
-             */
-            createCompoundContainer?: (config: RendererConfig, renderer?: any) => HTMLDivElement;
-            /**
-             * Custom function to create individual compound item containers
-             * @param layoutConfig - Layout configuration for the item
-             * @param config - The overall renderer configuration
-             * @param renderer - The parent/super renderer (if extending)
-             */
-            createCompoundItemContainer?: (layoutConfig?: LayoutConfig, config?: RendererConfig, renderer?: any) => HTMLDivElement;
-            /**
-             * Custom function to attach an item to the compound container
-             * @param compoundCnt - The compound container element
-             * @param compoundItemCnt - The item container to attach
-             * @param renderer - The parent/super renderer (if extending)
-             */
-            attachCompoundItem?: (compoundCnt: HTMLElement, compoundItemCnt: HTMLElement, renderer?: any) => void;
-        };
-        /**
-         * Configuration for the grid layout
-         */
-        config?: {
-            /**
-             * CSS grid-template-columns value (e.g., '1fr 2fr')
-             */
-            columns?: string;
-            /**
-             * CSS grid-template-rows value (e.g., '150px 150px')
-             */
-            rows?: string;
-            /**
-             * CSS grid-gap value (e.g., 'auto', '10px')
-             */
-            gap?: string;
-            /**
-             * Minimum height for the grid container
-             */
-            minHeight?: string;
-            /**
-             * Responsive layout configurations for different viewport sizes
-             */
-            layouts?: Array<{
-                /**
-                 * CSS grid-template-columns for this breakpoint
-                 */
-                columns?: string | number;
-                /**
-                 * CSS grid-template-rows for this breakpoint
-                 */
-                rows?: string | number;
-                /**
-                 * CSS grid-gap for this breakpoint
-                 */
-                gap?: string | number;
-                /**
-                 * Minimum viewport width for this layout (in pixels)
-                 */
-                minWidth?: number;
-                /**
-                 * Maximum viewport width for this layout (in pixels)
-                 */
-                maxWidth?: number;
-            }>;
-        };
-    };
-    /**
-     * Lazy loading configuration for compound children
-     */
-    lazyLoadingOptions?: {
-        /**
-         * Enable lazy loading using IntersectionObserver
-         * @default false
-         */
-        enabled?: boolean;
-        /**
-         * IntersectionObserver rootMargin option
-         * Controls when children are loaded relative to viewport visibility
-         * @default "0px"
-         */
-        intersectionRootMargin?: string;
-        /**
-         * Default temporary height for child containers before they load
-         * @default "500px"
-         */
-        temporaryContainerHeight?: string;
-        /**
-         * Disable automatic temporary container heights
-         * Useful for custom renderers that manage heights themselves
-         * @default false
-         */
-        noTemporaryContainerHeight?: boolean;
-    };
-    /**
-     * Array of child web component configurations
-     */
-    children?: Array<{
-        /**
-         * Unique identifier for this child web component
-         */
-        id: string;
-        /**
-         * URL pointing to the web component JavaScript file
-         * Supports {i18n.currentLocale} placeholder for localization
-         */
-        viewUrl: string;
-        /**
-         * Context object passed to the web component
-         */
-        context?: Record<string, any>;
-        /**
-         * Layout configuration for positioning this child
-         */
-        layoutConfig?: {
-            /**
-             * CSS grid-row value (e.g., '1 / 3', 'auto')
-             * @default "auto"
-             */
-            row?: string;
-            /**
-             * CSS grid-column value (e.g., '1 / -1', 'auto')
-             * @default "auto"
-             */
-            column?: string;
-            /**
-             * Slot name for nested web components
-             * Use this instead of row/column to plug into a parent's slot
-             */
-            slot?: string;
-            /**
-             * Override the default temporary container height for this specific child
-             * Only used when lazy loading is enabled
-             * * @default undefined
-             */
-            temporaryContainerHeight?: string;
-        };
-        /**
-         * Event listeners for cross-component communication via event bus
-         */
-        eventListeners?: Array<{
-            /**
-             * ID of the source web component (use '*' for any source)
-             */
-            source: string;
-            /**
-             * Name of the event to listen for
-             */
-            name: string;
-            /**
-             * Type of action to perform (e.g., 'update')
-             */
-            action: string;
-            /**
-             * Optional function to convert event data before passing to listener
-             * @param data - The event data
-             */
-            dataConverter?: (data: any) => any;
-        }>;
-    }>;
-}
-/**
- * Supporting type for layout configuration
- */
-export interface LayoutConfig {
-    column?: string;
-    row?: string;
-    slot?: string;
-    temporaryContainerHeight?: string;
-}
-/**
- * Supporting type for renderer configuration
- */
-export interface RendererConfig {
-    columns?: string;
-    rows?: string;
-    gap?: string;
-    minHeight?: string;
-    layouts?: Array<{
-        columns?: string;
-        rows?: string;
-        gap?: string | number;
-        minWidth?: number;
-        maxWidth?: number;
-    }>;
-}
+export type { CompoundConfig, LayoutConfig, RendererConfig } from './compound-config';
 export interface TitleResolverCache {
     key: string;
     value: {