@luigi-project/core-modular 0.0.1 → 0.0.2

package/modules/routing-module.d.ts

@@ -14,5 +14,5 @@ export declare const RoutingModule: {
      * @param keepBrowserHistory - If `true`, the browser history will be preserved when updating the URL.
      * @param luigi - The Luigi core instance used to interact with the routing API.
      */
-    addSearchParamsFromClient(searchParams: Record<string, any>, keepBrowserHistory: boolean, luigi: Luigi): void;
+    addSearchParamsFromClient(searchParams: Record<string, any>, keepBrowserHistory: boolean, luigi: Luigi): Promise<void>;
 };

package/modules/ui-module.d.ts

@@ -6,7 +6,7 @@ export declare const UIModule: {
     routingService: RoutingService;
     luigi: Luigi;
     init: (luigi: Luigi) => void;
-    update: (scopes?: string[]) => void;
+    update: (scopes?: string[]) => Promise<void>;
     updateMainContent: (currentNode: any, luigi: Luigi) => Promise<void>;
     openModal: (luigi: Luigi, node: any, modalSettings: ModalSettings, onCloseCallback?: () => void) => Promise<void>;
     updateModalSettings: (modalSettings: ModalSettings, addHistoryEntry: boolean, luigi: Luigi) => void;

package/package.json

@@ -18,5 +18,5 @@
     "micro-frontends",
     "microfrontends"
   ],
-  "version": "0.0.1"
+  "version": "0.0.2"
 }

package/services/navigation.service.d.ts

@@ -1,4 +1,5 @@
 import { Luigi } from '../core-api/luigi';
+import { NodeDataManagementService } from './node-data-management.service';
 export interface TopNavData {
     appTitle: string;
     logo: string;
@@ -50,7 +51,7 @@ export interface ProfileItem {
     icon?: string;
     testId?: string;
     altText?: string;
-    openNodeAsModal?: boolean | ModalSettings;
+    openNodeInModal?: boolean | ModalSettings;
 }
 export interface UserInfo {
     name?: string;
@@ -73,9 +74,16 @@ export interface PathData {
     rootNodes: Node[];
     pathParams: Record<string, any>;
 }
+export interface RootNode {
+    node: Node;
+}
 export interface Node {
-    visibleForFeatureToggles?: string[];
+    altText?: string;
     anonymousAccess?: any;
+    badgeCounter?: {
+        count?: () => number | Promise<number>;
+        label?: string;
+    };
     category?: any;
     children?: Node[];
     clientPermissions?: {
@@ -88,16 +96,19 @@ export interface Node {
     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;
-    tooltip?: string;
+    tooltipText?: string;
     viewUrl?: string;
-    isRootNode?: boolean;
+    visibleForFeatureToggles?: string[];
 }
 export interface PageErrorHandler {
     timeout: number;
@@ -105,8 +116,12 @@ export interface PageErrorHandler {
     redirectPath?: string;
     errorFn?: (node?: Node) => void;
 }
+export interface RunTimeErrorHandler {
+    errorFn?: (error: object, node?: Node) => void;
+}
 export interface Category {
-    collabsible?: boolean;
+    altText?: string;
+    collapsible?: boolean;
     icon?: string;
     id: string;
     isGroup?: boolean;
@@ -115,9 +130,13 @@ export interface Category {
     tooltip?: string;
 }
 export interface NavItem {
-    node?: Node;
+    altText?: string;
     category?: Category;
+    icon?: string;
+    node?: Node;
+    label?: string;
     selected?: boolean;
+    tooltip?: string;
 }
 export interface TabNavData {
     selectedNode?: any;
@@ -157,13 +176,15 @@ export interface ExternalLink {
 }
 export declare class NavigationService {
     private luigi;
+    nodeDataManagementService?: NodeDataManagementService;
     constructor(luigi: Luigi);
-    getPathData(path: string): PathData;
+    private getNodeDataManagementService;
+    getPathData(path: string): Promise<PathData>;
     findMatchingNode(urlPathElement: string, nodes: Node[]): Node | undefined;
     buildNavItems(nodes: Node[], selectedNode: Node | undefined, pathData: PathData): NavItem[];
-    shouldRedirect(path: string, pData?: PathData): string | undefined;
-    getCurrentNode(path: string): any;
-    getPathParams(path: string): Record<string, any>;
+    shouldRedirect(path: string, pData?: PathData): Promise<string | undefined>;
+    getCurrentNode(path: string): Promise<any>;
+    getPathParams(path: string): Promise<Record<string, any>>;
     /**
      * getTruncatedChildren
      *
@@ -174,12 +195,12 @@ export declare class NavigationService {
      */
     getTruncatedChildren(children: any): any[];
     applyNavGroups(items: NavItem[]): NavItem[];
-    getLeftNavData(path: string, pData?: PathData): LeftNavData;
+    getLeftNavData(path: string, pData?: PathData): Promise<LeftNavData>;
     navItemClick(item: Node, parentPath: string): void;
-    getTopNavData(path: string, pData?: PathData): TopNavData;
+    getTopNavData(path: string, pData?: PathData): Promise<TopNavData>;
     getParentNode(node: Node | undefined, pathData: PathData): Node | undefined;
     getAppSwitcherData(appSwitcherData: AppSwitcher, headerSettings: any): AppSwitcher | undefined;
-    getTabNavData(path: string, pData?: PathData): TabNavData;
+    getTabNavData(path: string, pData?: PathData): Promise<TabNavData>;
     /**
      * Handles changes between navigation nodes by invoking a configured hook function.
      *
@@ -207,7 +228,14 @@ export declare class NavigationService {
         nodeObject: Node;
         pathData: PathData;
     }>;
+    shouldPreventNavigation(node: Node): Promise<boolean>;
+    shouldPreventNavigationForPath(nodepath: string): Promise<boolean>;
+    openViewInNewTab(nodepath: string): Promise<void>;
     private resolveTooltipText;
     private prepareRootNodes;
     private getAccessibleNodes;
+    handleNavigationRequest(path: string, preserveView?: string, modalSettings?: any, newTab?: boolean, withoutSync?: boolean, callbackFn?: any): Promise<void>;
+    getChildren(node: Node | undefined, context?: Record<string, any>): Promise<Node[]>;
+    getExpandStructuralPathSegment(node: Node): Node;
+    bindChildToParent(child: Node, node: Node): Node;
 }

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

@@ -1,4 +1,4 @@
-import { Node } from './navigation.service';
+import { Node, RootNode } from './navigation.service';
 export declare class NodeDataManagementService {
     dataManagement: Map<any, any>;
     navPath: string;
@@ -28,9 +28,9 @@ export declare class NodeDataManagementService {
     setRootNode(node: Node): void;
     /**
      * Returns the root node
-     * @returns {Node} root node
+     * @returns {RootNode} root node
      */
-    getRootNode(): Node;
+    getRootNode(): RootNode;
     /**
      * Checks if root node exists
      * @returns {boolean} true or false

package/services/routing.service.d.ts

@@ -1,5 +1,5 @@
 import { Luigi } from '../core-api/luigi';
-import { ModalSettings, Node, NavigationService } from './navigation.service';
+import { ModalSettings, Node, PathData, NavigationService } from './navigation.service';
 export interface Route {
     raw: string;
     node?: Node;
@@ -12,6 +12,7 @@ export declare class RoutingService {
     previousNode: Node | undefined;
     currentRoute?: Route;
     modalSettings?: ModalSettings;
+    previousPathData?: PathData;
     constructor(luigi: Luigi);
     private getNavigationService;
     /**
@@ -34,10 +35,16 @@ export declare class RoutingService {
      *
      */
     enableRouting(): void;
+    /**
+     * Deal with route changing scenario.
+     * @param {Object} routeInfo - the information about path and query
+     * @param {boolean} withoutSync - disables the navigation handling for a single navigation request
+     * @returns {Promise<void>} A promise that resolves when route change is complete.
+     */
     handleRouteChange(routeInfo: {
         path: string;
         query: string;
-    }): Promise<void>;
+    }, withoutSync?: boolean): Promise<void>;
     getCurrentRoute(): Route | undefined;
     /**
      * If `showModalPathInUrl` is provided, bookmarkable modal path will be triggered.
@@ -100,4 +107,5 @@ export declare class RoutingService {
   
      */
     updateModalDataInUrl(modalPath: string, modalParams: ModalSettings, addHistoryEntry: boolean): void;
+    checkInvalidateCache(previousPathData: PathData | undefined, newPath: string): void;
 }

package/utilities/helpers/config-helpers.d.ts

@@ -11,7 +11,9 @@ declare class ConfigHelpersClass {
      * If the value is a Function it is called (with the given parameters) and the result of that call is the value.
      * If the value is not a Promise it is wrapped to a Promise so that the returned value is definitely a Promise.
      * @private
-     * @memberof Configuration
+     * @param {string} property the object traversal path
+     * @param {boolean} throwError to throw an error or not
+     * @param {*} parameters optional parameters that are used if the target is a function
      */
     executeConfigFnAsync(property: string, throwError?: boolean, ...parameters: any): Promise<any>;
 }

package/utilities/helpers/generic-helpers.d.ts

@@ -17,6 +17,12 @@ export declare const GenericHelpers: {
      * @returns {boolean}
      */
     isFunction: (functionToCheck: any) => boolean;
+    /**
+     * Checks if input is an async function.
+     * @param functionToCheck mixed
+     * @returns {boolean}
+     */
+    isAsyncFunction: (functionToCheck: any) => boolean;
     /**
      * Checks if input is a string.
      * @param stringToCheck mixed

package/utilities/helpers/routing-helpers.d.ts

@@ -251,4 +251,15 @@ export declare const RoutingHelpers: {
      *   constraining `paramMap` and `object` to more specific record types.
      */
     substituteDynamicParamsInObject(object: Record<string, string>, paramMap: Record<any, any>, paramPrefix?: string, contains?: boolean): {};
+    /**
+     * Returns true or false whether the passed node is a dynamic node or not
+     * @param {*} node
+     */
+    isDynamicNode(node: Node): boolean;
+    /**
+     * Returns the value from the passed node's pathSegment, e.g. :groupId -> yourGroupId
+     * @param {*} node
+     * @param {*} pathParams
+     */
+    getDynamicNodeValue(node: Node, pathParams: Record<string, string>): string | undefined;
 };

package/utilities/lifecycle-hooks.d.ts

@@ -0,0 +1,4 @@
+import { Luigi } from '../core-api/luigi';
+export declare const LifecycleHooks: {
+    luigiAfterInit: (luigi: Luigi) => Promise<void>;
+};