@luigi-project/container 0.0.1 → 0.0.4

package/webcomponents.service.d.ts

@@ -0,0 +1,68 @@
+import { ContainerService } from './container.service';
+/** Methods for dealing with web components based micro frontend handling */
+export declare class WebComponentService {
+    containerService: ContainerService;
+    constructor();
+    dynamicImport(viewUrl: any): Promise<any>;
+    processViewUrl(viewUrl: string, data?: any): string;
+    /** Creates a web component with tagname wc_id and adds it to wcItemContainer,
+     * if attached to wc_container
+     */
+    attachWC(wc_id: any, wcItemPlaceholder: any, wc_container: any, ctx: any, viewUrl: any, nodeId: any): void;
+    createClientAPI(eventBusElement: any, nodeId: any, wc_id: any): {
+        linkManager: () => void;
+        uxManager: () => {
+            showAlert: (alertSettings: any) => void;
+            showConfirmationModal: (settings: any) => Promise<unknown>;
+        };
+        getCurrentLocale: () => void;
+        publishEvent: (ev: any) => void;
+    };
+    initWC(wc: any, wc_id: any, eventBusElement: any, viewUrl: any, ctx: any, nodeId: any): void;
+    /** Generates a unique web component id (tagname) based on the viewUrl
+     * returns a string that can be used as part of a tagname, only alphanumeric
+     * characters and no whitespaces.
+     */
+    generateWCId(viewUrl: any): string;
+    /** Does a module import from viewUrl and defines a new web component
+     * with the default export of the module or the first export extending HTMLElement if no default is
+     * specified.
+     * @returns a promise that gets resolved after successfull import */
+    registerWCFromUrl(viewUrl: any, wc_id: any): Promise<unknown>;
+    /**
+     * Handles the import of self registered web component bundles, i.e. the web component
+     * is added to the customElements registry by the bundle code rather than by luigi.
+     *
+     * @param {*} node the corresponding navigation node
+     * @param {*} viewUrl the source of the wc bundle
+     * @param {*} onload callback function executed after script attached and loaded
+     */
+    includeSelfRegisteredWCFromUrl(node: any, viewUrl: any, onload: any): void;
+    /**
+     * Checks if a url is allowed to be included, based on 'navigation.validWebcomponentUrls' in luigi config.
+     * Returns true, if allowed.
+     *
+     * @param {*} url the url string to check
+     */
+    checkWCUrl(url: any): boolean;
+    /** Adds a web component defined by viewUrl to the wc_container and sets the node context.
+     * If the web component is not defined yet, it gets imported.
+     */
+    renderWebComponent(viewUrl: any, wc_container: any, context: any, node: any, nodeId: any): void;
+    /**
+     * Creates a compound container according to the given renderer.
+     * Returns a promise that gets resolved with the created container DOM element.
+     *
+     * @param {DefaultCompoundRenderer} renderer
+     */
+    createCompoundContainerAsync(renderer: any, ctx: any): Promise<HTMLElement>;
+    /**
+     * Responsible for rendering web component compounds based on a renderer or a nesting
+     * micro frontend.
+     *
+     * @param {*} navNode the navigation node defining the compound
+     * @param {*} wc_container the web component container dom element
+     * @param {*} context the luigi node context
+     */
+    renderWebComponentCompound(navNode: any, wc_container: any, context: any): Promise<unknown>;
+}