@luigi-project/core-modular 0.0.3-dev.202602230049 → 0.0.3-dev.202602250050

package/modules/routing-module.d.ts

@@ -1,5 +1,5 @@
-import { ExternalLink, Node, PageErrorHandler } from '../services/navigation.service';
 import { Luigi } from '../core-api/luigi';
+import { ExternalLink, Node, PageErrorHandler } from '../types/navigation';
 export declare const RoutingModule: {
     init: (luigi: Luigi) => void;
     handlePageErrorHandler: (pageErrorHandler: PageErrorHandler, node: Node, luigi: Luigi) => void;

package/modules/ui-module.d.ts

@@ -1,6 +1,7 @@
 import { Luigi } from '../core-api/luigi';
-import { NavigationService, ModalSettings } from '../services/navigation.service';
+import { NavigationService } from '../services/navigation.service';
 import { RoutingService } from '../services/routing.service';
+import { ModalSettings } from '../types/navigation';
 export declare const UIModule: {
     navService: NavigationService;
     routingService: RoutingService;

package/package.json

@@ -18,5 +18,5 @@
     "micro-frontends",
     "microfrontends"
   ],
-  "version": "0.0.3-dev.202602230049"
+  "version": "0.0.3-dev.202602250050"
 }

package/services/modal.service.d.ts

@@ -1,5 +1,5 @@
 import { Luigi } from '../core-api/luigi';
-import { ModalSettings } from './navigation.service';
+import { ModalSettings } from '../types/navigation';
 export interface ModalPromiseObject {
     closePromise?: Promise<void>;
     resolveFn?: () => void;

package/services/navigation.service.d.ts

@@ -1,187 +1,6 @@
 import { Luigi } from '../core-api/luigi';
+import { AppSwitcher, LeftNavData, NavigationRequestParams, NavItem, Node, PathData, TabNavData, TopNavData } from '../types/navigation';
 import { NodeDataManagementService } from './node-data-management.service';
-export interface TopNavData {
-    appTitle: string;
-    logo: string;
-    topNodes: NavItem[];
-    productSwitcher?: ProductSwitcher;
-    profile?: ProfileSettings;
-    appSwitcher?: AppSwitcher;
-    navClick?: (item: NavItem) => void;
-}
-export interface AppSwitcher {
-    showMainAppEntry?: boolean;
-    items?: AppSwitcherItem[];
-    itemRenderer?: (item: AppSwitcherItem, slot: HTMLElement, appSwitcherApiObj?: any) => void;
-}
-export interface AppSwitcherItem {
-    title?: string;
-    subtitle?: string;
-    link?: string;
-    selectionConditions?: selectionConditions;
-}
-export interface selectionConditions {
-    route?: string;
-    contextCriteria?: ContextCriteria[];
-}
-export interface ContextCriteria {
-    key: string;
-    value: string;
-}
-export interface ProfileSettings {
-    authEnabled: boolean;
-    signedIn: boolean;
-    logout: ProfileLogout;
-    items?: ProfileItem[];
-    staticUserInfoFn?: () => Promise<UserInfo>;
-    onUserInfoUpdate: (fn: (uInfo: UserInfo) => void) => void;
-    itemClick: (item: ProfileItem) => void;
-}
-export interface ProfileLogout {
-    label?: string;
-    icon?: string;
-    testId?: string;
-    altText?: string;
-    doLogout: () => void;
-}
-export interface ProfileItem {
-    label?: string;
-    link?: string;
-    externalLink?: ExternalLink;
-    icon?: string;
-    testId?: string;
-    altText?: string;
-    openNodeInModal?: boolean | ModalSettings;
-}
-export interface UserInfo {
-    name?: string;
-    initials?: string;
-    email?: string;
-    picture?: string;
-    description?: string;
-}
-export interface LeftNavData {
-    selectedNode: any;
-    items: NavItem[];
-    basePath: string;
-    sideNavFooterText?: string;
-    navClick?: (item: NavItem) => void;
-}
-export interface PathData {
-    selectedNode?: Node;
-    selectedNodeChildren?: Node[];
-    nodesInPath?: Node[];
-    rootNodes: Node[];
-    pathParams: Record<string, any>;
-}
-export interface RootNode {
-    node: Node;
-}
-export interface Node {
-    altText?: string;
-    anonymousAccess?: any;
-    badgeCounter?: {
-        count?: () => number | Promise<number>;
-        label?: string;
-    };
-    category?: any;
-    children?: Node[];
-    clientPermissions?: {
-        changeCurrentLocale?: boolean;
-        urlParameters?: Record<string, any>;
-    };
-    context?: Record<string, any>;
-    drawer?: ModalSettings;
-    externalLink?: ExternalLink;
-    hideFromNav?: boolean;
-    hideSideNav?: boolean;
-    icon?: string;
-    isRootNode?: boolean;
-    keepSelectedForChildren?: boolean;
-    label?: string;
-    onNodeActivation?: (node: Node) => boolean | void;
-    openNodeInModal?: boolean;
-    pageErrorHandler?: PageErrorHandler;
-    parent?: Node;
-    pathSegment?: string;
-    runTimeErrorHandler?: RunTimeErrorHandler;
-    tabNav?: boolean;
-    tooltipText?: string;
-    viewUrl?: string;
-    visibleForFeatureToggles?: string[];
-}
-export interface PageErrorHandler {
-    timeout: number;
-    viewUrl?: string;
-    redirectPath?: string;
-    errorFn?: (node?: Node) => void;
-}
-export interface RunTimeErrorHandler {
-    errorFn?: (error: object, node?: Node) => void;
-}
-export interface Category {
-    altText?: string;
-    collapsible?: boolean;
-    icon?: string;
-    id: string;
-    isGroup?: boolean;
-    label?: string;
-    nodes?: NavItem[];
-    tooltip?: string;
-}
-export interface NavItem {
-    altText?: string;
-    category?: Category;
-    icon?: string;
-    node?: Node;
-    label?: string;
-    selected?: boolean;
-    tooltip?: string;
-}
-export interface TabNavData {
-    selectedNode?: any;
-    items?: NavItem[];
-    basePath?: string;
-    navClick?: (item: NavItem) => void;
-}
-export interface ModalSettings {
-    size?: 'fullscreen' | 'l' | 'm' | 's';
-    width?: string;
-    height?: string;
-    title?: string;
-    closebtn_data_testid?: string;
-    keepPrevious?: boolean;
-}
-export interface ProductSwitcher {
-    altText?: string;
-    columns?: number;
-    icon?: string;
-    items?: [ProductSwitcherItem];
-    label?: string;
-    testId?: string;
-}
-export interface ProductSwitcherItem {
-    altText?: string;
-    externalLink?: ExternalLink;
-    icon?: string;
-    label?: string;
-    link?: string;
-    selected?: boolean;
-    subTitle?: string;
-    testId?: string;
-}
-export interface ExternalLink {
-    url?: string;
-    sameWindow?: boolean;
-}
-export interface NavigationRequestParams {
-    modalSettings?: any;
-    newTab?: boolean;
-    path: string;
-    preserveView?: string;
-    preventContextUpdate?: boolean;
-    withoutSync?: boolean;
-}
 export declare class NavigationService {
     private luigi;
     nodeDataManagementService?: NodeDataManagementService;
@@ -251,6 +70,7 @@ export declare class NavigationService {
      * @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)
      * @param {boolean} params.preventContextUpdate - make no context update being triggered; default is false (optional)
+     * @param {boolean} params.preventHistoryEntry - make no history update being triggered; default is false (optional)
      * @param {any} callbackFn - callback to be triggered after opening view as modal (optional)
      */
     handleNavigationRequest(params: NavigationRequestParams, callbackFn?: any): Promise<void>;

package/services/node-data-management.service.d.ts

@@ -1,4 +1,4 @@
-import { Node, RootNode } from './navigation.service';
+import { Node, RootNode } from '../types/navigation';
 export declare class NodeDataManagementService {
     dataManagement: Map<any, any>;
     navPath: string;

package/services/routing.service.d.ts

@@ -1,5 +1,6 @@
 import { Luigi } from '../core-api/luigi';
-import { ModalSettings, Node, PathData, NavigationService } from './navigation.service';
+import { ModalSettings, Node, PathData } from '../types/navigation';
+import { NavigationService } from './navigation.service';
 export interface Route {
     raw: string;
     node?: Node;

package/types/connector.d.ts

@@ -1,5 +1,5 @@
-import { ModalSettings, LeftNavData, Node, TopNavData, TabNavData } from '../services/navigation.service';
 import { AlertHandler, AlertSettings, ConfirmationModalHandler, ConfirmationModalSettings, UserSettings } from '../modules/ux-module';
+import { ModalSettings, LeftNavData, Node, TopNavData, TabNavData } from './navigation';
 export interface LuigiConnector {
     renderMainLayout(): void;
     renderTopNav(data: TopNavData): void;

package/types/navigation.d.ts

@@ -0,0 +1,189 @@
+export interface TopNavData {
+    appTitle: string;
+    logo: string;
+    topNodes: NavItem[];
+    productSwitcher?: ProductSwitcher;
+    profile?: ProfileSettings;
+    appSwitcher?: AppSwitcher;
+    navClick?: (item: NavItem) => void;
+}
+export interface AppSwitcher {
+    showMainAppEntry?: boolean;
+    items?: AppSwitcherItem[];
+    itemRenderer?: (item: AppSwitcherItem, slot: HTMLElement, appSwitcherApiObj?: any) => void;
+}
+export interface AppSwitcherItem {
+    title?: string;
+    subtitle?: string;
+    link?: string;
+    selectionConditions?: selectionConditions;
+}
+export interface selectionConditions {
+    route?: string;
+    contextCriteria?: ContextCriteria[];
+}
+export interface ContextCriteria {
+    key: string;
+    value: string;
+}
+export interface ProfileSettings {
+    authEnabled: boolean;
+    signedIn: boolean;
+    logout: ProfileLogout;
+    items?: ProfileItem[];
+    staticUserInfoFn?: () => Promise<UserInfo>;
+    onUserInfoUpdate: (fn: (uInfo: UserInfo) => void) => void;
+    itemClick: (item: ProfileItem) => void;
+}
+export interface ProfileLogout {
+    label?: string;
+    icon?: string;
+    testId?: string;
+    altText?: string;
+    doLogout: () => void;
+}
+export interface ProfileItem {
+    label?: string;
+    link?: string;
+    externalLink?: ExternalLink;
+    icon?: string;
+    testId?: string;
+    altText?: string;
+    openNodeInModal?: boolean | ModalSettings;
+}
+export interface UserInfo {
+    name?: string;
+    initials?: string;
+    email?: string;
+    picture?: string;
+    description?: string;
+}
+export interface LeftNavData {
+    selectedNode: any;
+    items: NavItem[];
+    basePath: string;
+    sideNavFooterText?: string;
+    navClick?: (item: NavItem) => void;
+}
+export interface PathData {
+    selectedNode?: Node;
+    selectedNodeChildren?: Node[];
+    nodesInPath?: Node[];
+    rootNodes: Node[];
+    pathParams: Record<string, any>;
+}
+export interface RootNode {
+    node: Node;
+}
+export interface Node {
+    altText?: string;
+    anonymousAccess?: any;
+    badgeCounter?: {
+        count?: () => number | Promise<number>;
+        label?: string;
+    };
+    category?: any;
+    children?: Node[];
+    clientPermissions?: {
+        changeCurrentLocale?: boolean;
+        urlParameters?: Record<string, any>;
+    };
+    context?: Record<string, any>;
+    drawer?: ModalSettings;
+    externalLink?: ExternalLink;
+    hideFromNav?: boolean;
+    hideSideNav?: boolean;
+    icon?: string;
+    isRootNode?: boolean;
+    keepSelectedForChildren?: boolean;
+    label?: string;
+    onNodeActivation?: (node: Node) => boolean | void;
+    openNodeInModal?: boolean;
+    pageErrorHandler?: PageErrorHandler;
+    parent?: Node;
+    pathSegment?: string;
+    runTimeErrorHandler?: RunTimeErrorHandler;
+    tabNav?: boolean;
+    tooltipText?: string;
+    viewUrl?: string;
+    visibleForFeatureToggles?: string[];
+}
+export interface PageErrorHandler {
+    timeout: number;
+    viewUrl?: string;
+    redirectPath?: string;
+    errorFn?: (node?: Node) => void;
+}
+export interface RunTimeErrorHandler {
+    errorFn?: (error: object, node?: Node) => void;
+}
+export interface Category {
+    altText?: string;
+    collapsible?: boolean;
+    icon?: string;
+    id: string;
+    isGroup?: boolean;
+    label?: string;
+    nodes?: NavItem[];
+    tooltip?: string;
+}
+export interface NavItem {
+    altText?: string;
+    category?: Category;
+    icon?: string;
+    node?: Node;
+    label?: string;
+    selected?: boolean;
+    tooltip?: string;
+}
+export interface TabNavData {
+    selectedNode?: any;
+    items?: NavItem[];
+    basePath?: string;
+    navClick?: (item: NavItem) => void;
+}
+export interface ModalSettings {
+    size?: 'fullscreen' | 'l' | 'm' | 's';
+    width?: string;
+    height?: string;
+    title?: string;
+    closebtn_data_testid?: string;
+    keepPrevious?: boolean;
+}
+export interface ProductSwitcher {
+    altText?: string;
+    columns?: number;
+    icon?: string;
+    items?: [ProductSwitcherItem];
+    label?: string;
+    testId?: string;
+}
+export interface ProductSwitcherItem {
+    altText?: string;
+    externalLink?: ExternalLink;
+    icon?: string;
+    label?: string;
+    link?: string;
+    selected?: boolean;
+    subTitle?: string;
+    testId?: string;
+}
+export interface ExternalLink {
+    url?: string;
+    sameWindow?: boolean;
+}
+export interface NavigationRequestBase {
+    preventContextUpdate?: boolean;
+    preventHistoryEntry?: boolean;
+    withoutSync?: boolean;
+}
+export interface NavigationRequestParams extends NavigationRequestBase {
+    modalSettings?: any;
+    newTab?: boolean;
+    path: string;
+    preserveView?: string;
+}
+export interface NavigationRequestEvent {
+    detail: NavigationRequestBase;
+}
+export type HistoryMethod = 'pushState' | 'replaceState';

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 '../../services/navigation.service';
+import { AppSwitcher, Node, PathData } from '../../types/navigation';
 export declare const NavigationHelpers: {
     normalizePath: (raw: string) => string;
     segmentMatches: (linkSegment: string, pathSegment: string, pathParams: Record<string, any>) => boolean;

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 '../../services/navigation.service';
+import { Node, PathData } from '../../types/navigation';
 export declare const RoutingHelpers: {
     defaultContentViewParamPrefix: string;
     defaultQueryParamSeparator: string;