@luigi-project/core-modular 0.0.4 → 0.0.5

package/core-api/dom-elements.d.ts

@@ -0,0 +1,59 @@
+import { MicrofrontendInDom } from '../utilities/helpers/luigi-container-helpers';
+import { Luigi } from './luigi';
+export declare class Elements {
+    luigi: Luigi;
+    constructor(luigi: Luigi);
+    /**
+     * Returns the shellbar component.
+     * @returns {HTMLElement | null} the shellbar DOM element
+     * @memberof Elements
+     * @example
+     * Luigi.elements().getShellbar();
+     */
+    getShellbar(): HTMLElement | null;
+    /**
+     * Returns the shellbar actions.
+     * @returns {HTMLElement | null} the shellbar actions DOM element
+     * @memberof Elements
+     * @example
+     * Luigi.elements().getShellbarActions();
+     */
+    getShellbarActions(): HTMLElement | null;
+    /**
+     * Returns the main container of the Luigi application.
+     * @memberof Elements
+     * @returns {HTMLElement | null} the Luigi container DOM element
+     */
+    getLuigiContainer(): HTMLElement | null;
+    /**
+     * Returns the navigation footer container of the Luigi application.
+     * @memberof Elements
+     * @returns {HTMLElement | null} the navigation footer container DOM element
+     */
+    getNavFooterContainer(): HTMLElement | null;
+    /**
+     * Returns a list of all available micro frontends.
+     * @returns {Array<{id: string, active: boolean, container: HTMLElement, type: 'main'|'drawer'|'modal'}>} list of objects defining all micro frontends from the DOM
+     * @memberof Elements
+     * @example
+     * Luigi.elements().getMicrofrontends();
+     */
+    getMicrofrontends(): MicrofrontendInDom[];
+    /**
+     * Returns all micro frontend iframes including the iframe from the modal if it exists.
+     * @returns {Array<HTMLElement>} an array of all micro frontend iframes from the DOM
+     * @memberof Elements
+     * @example
+     * Luigi.elements().getMicrofrontendIframes();
+     */
+    getMicrofrontendIframes(): HTMLElement[] | null;
+    /**
+     * Returns the active micro frontend iframe.
+     * If there is a modal, which includes the micro frontend iframe, the function returns this iframe.
+     * @returns {HTMLElement} the active micro frontend iframe DOM element
+     * @memberof Elements
+     * @example
+     * Luigi.elements().getCurrentMicrofrontendIframe();
+     */
+    getCurrentMicrofrontendIframe(): HTMLElement | null;
+}

package/core-api/luigi.d.ts

@@ -1,5 +1,6 @@
 import { LuigiEngine } from '../luigi-engine';
 import { i18nService } from '../services/i18n.service';
+import { Elements } from './dom-elements';
 import { LuigiAuthClass } from './auth';
 import { FeatureToggles } from './feature-toggles';
 import { Navigation } from './navigation';
@@ -14,6 +15,7 @@ export declare class Luigi {
     _i18n: i18nService;
     _theming?: Theming;
     _routing?: Routing;
+    _elements?: Elements;
     __cssVars?: any;
     preventLoadingModalData?: boolean;
     initialized: boolean;
@@ -71,6 +73,7 @@ export declare class Luigi {
      */
     storeUserSettings(userSettingsObj: Record<string, any>, previousUserSettingsObj: Record<string, any>): Promise<any>;
     i18n: () => i18nService;
+    elements: () => Elements;
     navigation: () => Navigation;
     ux: () => UX;
     featureToggles: () => FeatureToggles;

package/core-api/navigation.d.ts

@@ -13,11 +13,25 @@ export declare class Navigation {
     constructor(luigi: Luigi);
     navigate: (path: string, preserveView?: string, modalSettings?: ModalSettings, splitViewSettings?: any, drawerSettings?: any) => Promise<void>;
     openAsModal: (path: string, modalSettings: ModalSettings, onCloseCallback?: () => void) => Promise<void>;
-    openAsDrawer: (path: string, modalSettings: ModalSettings, onCloseCallback?: () => void) => Promise<void>;
+    openAsDrawer: (path: string, drawerSettings: ModalSettings, onCloseCallback?: () => void) => Promise<void>;
     runTimeErrorHandler: (errorObj: object) => Promise<void>;
+    /**
+     * Checks if the path you can navigate to exists in the main application. For example, you can use this helper method conditionally to display a DOM element like a button.
+     * @param {string} path - path which existence you want to check
+     * @returns {Promise<boolean>} A promise which resolves to a boolean variable specifying whether the path exists or not
+     * @example
+     *  let pathExists;
+     *  Luigi
+     *  .navigation()
+     *  .pathExists('projects/pr2')
+     *  .then(
+     *    (pathExists) => {  }
+     *  );
+     */
+    pathExists: (path: string) => Promise<boolean>;
     /**
      * Sets the current navigation base to the parent node that is defined as virtualTree. This method works only when the currently active micro frontend is inside a virtualTree.
-     * @returns {navigation} navigation instance
+     * @returns {Navigation} navigation instance
      * @example
      * Luigi.navigation().fromVirtualTreeRoot().navigate('/users/groups/stakeholders')
      */
@@ -25,12 +39,12 @@ export declare class Navigation {
     /**
      * Allows navigation from the node which has the navigation context set.
      * @param navigationContext
-     * @returns {navigation} navigation instance
+     * @returns {Navigation} navigation instance
      */
     fromContext(navigationContext: string): Navigation;
     /**
      * Allows navigation from the closest node which has the navigation context set. If there are multiple nodes with the same navigation context, the closest one will be used as the navigation base.
-     * @returns {navigation} navigation instance
+     * @returns {Navigation} navigation instance
      */
     fromClosestContext(): Navigation;
     /**
@@ -38,4 +52,5 @@ export declare class Navigation {
      * @returns {navigation} navigation instance
      */
     fromParent(): Navigation;
+    withParams(nodeParams: Record<string, any>): Navigation;
 }

package/luigi-engine.d.ts

@@ -9,12 +9,14 @@ export declare class LuigiEngine {
         navService: NavigationService;
         routingService: RoutingService;
         luigi: import('./core-api/luigi').Luigi;
+        modalContainer: any;
+        drawerContainer: any;
         init: (luigi: import('./core-api/luigi').Luigi) => void;
         update: (scopes?: string[]) => Promise<void>;
-        updateMainContent: (currentNode: any, luigi: import('./core-api/luigi').Luigi, withoutSync?: boolean, preventContextUpdate?: boolean) => Promise<void>;
-        openModal: (luigi: import('./core-api/luigi').Luigi, node: any, modalSettings: import('./types/navigation').ModalSettings, onCloseCallback?: () => void) => Promise<void>;
+        updateMainContent: (currentNode: import('./types/navigation').Node, luigi: import('./core-api/luigi').Luigi, luigiParams?: import('./types/routing').LuigiParams, withoutSync?: boolean, preventContextUpdate?: boolean) => Promise<void>;
+        openModal: (luigi: import('./core-api/luigi').Luigi, node: import('./types/navigation').Node, modalSettings: import('./types/navigation').ModalSettings, onCloseCallback?: () => void) => Promise<void>;
         updateModalSettings: (modalSettings: import('./types/navigation').ModalSettings, addHistoryEntry: boolean, luigi: import('./core-api/luigi').Luigi) => void;
-        openDrawer: (luigi: import('./core-api/luigi').Luigi, node: any, modalSettings: import('./types/navigation').ModalSettings, onCloseCallback?: () => void) => Promise<void>;
+        openDrawer: (luigi: import('./core-api/luigi').Luigi, node: import('./types/navigation').Node, drawerSettings: import('./types/navigation').ModalSettings, onCloseCallback?: () => void) => Promise<void>;
     };
     _comm: {
         luigi: import('./core-api/luigi').Luigi;