@das-fed/mframe 0.0.10

package/index.d.ts

@@ -0,0 +1,525 @@
+import { Emitter } from 'mitt';
+
+export declare const bus: <T extends keyof BusChannel>(name: T) => BusChannel[T];
+
+declare type BusChannel = ContainerChannelType & MainAppChannelType & MicroAppChannelType;
+
+declare const channelItem: {
+    data: {
+        set: (payload: Partial<{
+            /** 整个容器是否显示，默认为true，包括内容区域 */
+            visible: boolean | undefined;
+            /** 外框是否显示，默认为true，外框包括顶部导航栏，左侧菜单栏，tab标签栏 */
+            frameVisible: boolean | undefined;
+            /** 外框的顶部导航栏是否显示，默认为true，单独设置此项优先级高于frameVisible */
+            navVisible: boolean | undefined;
+            /** 外框的左侧菜单栏是否显示，默认为true，单独设置此项优先级高于frameVisible */
+            menuVisible: boolean | undefined;
+            /** 外框的tab标签栏是否显示，默认为true，单独设置此项优先级高于frameVisible */
+            tabVisible: boolean | undefined;
+            /** 内容区是否显示，默认为true，单独设置此项优先级高于visible */
+            mountVisible: boolean | undefined;
+            /** 子应用列表 */
+            microApps: MicroAppItem[];
+            /** 当前激活的子应用名称 */
+            activeMicroAppName: string;
+            /** 当前激活的子应用信息 */
+            activeMicroAppItem: null | MicroAppItem;
+            /** 顶部导航菜单项列表 */
+            navItems: NavItem[];
+            /** 当前激活的顶部导航菜单项 */
+            activeNavItem: null | NavItem;
+            /** 左侧菜单项列表 */
+            menuItems: MenuItem[];
+            /** 当前激活左侧菜单项 */
+            activeMenuItem: null | MenuItem;
+            /** 全量导航菜单项 */
+            fullNavItems: NavItem[];
+            /** 标签内容项列表 */
+            tabItems: TabItem[];
+            /** 当前激活的标签内容项 */
+            activeTabItem: null | TabItem;
+            /** nav的BoundingClientRect信息 */
+            navRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** menu的BoundingClientRect信息 */
+            menuRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** tab的BoundingClientRect信息 */
+            tabRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** mount的BoundingClientRect信息 */
+            mountRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** 子应用的置顶状态。子应用处于置顶时，主应用将无法触发外框的事件。 */
+            microAppStickStatus: boolean;
+            /** 容器创建时的初始化配置 */
+            initOptions: ContainerInitOptions;
+        }>, opt?: {
+            notMerge?: boolean;
+        } | undefined) => void;
+        get: (keys?: ("visible" | "frameVisible" | "navVisible" | "menuVisible" | "tabVisible" | "mountVisible" | "microApps" | "activeMicroAppName" | "activeMicroAppItem" | "navItems" | "activeNavItem" | "menuItems" | "activeMenuItem" | "fullNavItems" | "tabItems" | "activeTabItem" | "navRect" | "menuRect" | "tabRect" | "mountRect" | "microAppStickStatus" | "initOptions")[] | undefined) => {
+            /** 整个容器是否显示，默认为true，包括内容区域 */
+            visible: boolean | undefined;
+            /** 外框是否显示，默认为true，外框包括顶部导航栏，左侧菜单栏，tab标签栏 */
+            frameVisible: boolean | undefined;
+            /** 外框的顶部导航栏是否显示，默认为true，单独设置此项优先级高于frameVisible */
+            navVisible: boolean | undefined;
+            /** 外框的左侧菜单栏是否显示，默认为true，单独设置此项优先级高于frameVisible */
+            menuVisible: boolean | undefined;
+            /** 外框的tab标签栏是否显示，默认为true，单独设置此项优先级高于frameVisible */
+            tabVisible: boolean | undefined;
+            /** 内容区是否显示，默认为true，单独设置此项优先级高于visible */
+            mountVisible: boolean | undefined;
+            /** 子应用列表 */
+            microApps: MicroAppItem[];
+            /** 当前激活的子应用名称 */
+            activeMicroAppName: string;
+            /** 当前激活的子应用信息 */
+            activeMicroAppItem: null | MicroAppItem;
+            /** 顶部导航菜单项列表 */
+            navItems: NavItem[];
+            /** 当前激活的顶部导航菜单项 */
+            activeNavItem: null | NavItem;
+            /** 左侧菜单项列表 */
+            menuItems: MenuItem[];
+            /** 当前激活左侧菜单项 */
+            activeMenuItem: null | MenuItem;
+            /** 全量导航菜单项 */
+            fullNavItems: NavItem[];
+            /** 标签内容项列表 */
+            tabItems: TabItem[];
+            /** 当前激活的标签内容项 */
+            activeTabItem: null | TabItem;
+            /** nav的BoundingClientRect信息 */
+            navRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** menu的BoundingClientRect信息 */
+            menuRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** tab的BoundingClientRect信息 */
+            tabRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** mount的BoundingClientRect信息 */
+            mountRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** 子应用的置顶状态。子应用处于置顶时，主应用将无法触发外框的事件。 */
+            microAppStickStatus: boolean;
+            /** 容器创建时的初始化配置 */
+            initOptions: ContainerInitOptions;
+        };
+        watch: (cb: (newData: {
+            /** 整个容器是否显示，默认为true，包括内容区域 */
+            visible: boolean | undefined;
+            /** 外框是否显示，默认为true，外框包括顶部导航栏，左侧菜单栏，tab标签栏 */
+            frameVisible: boolean | undefined;
+            /** 外框的顶部导航栏是否显示，默认为true，单独设置此项优先级高于frameVisible */
+            navVisible: boolean | undefined;
+            /** 外框的左侧菜单栏是否显示，默认为true，单独设置此项优先级高于frameVisible */
+            menuVisible: boolean | undefined;
+            /** 外框的tab标签栏是否显示，默认为true，单独设置此项优先级高于frameVisible */
+            tabVisible: boolean | undefined;
+            /** 内容区是否显示，默认为true，单独设置此项优先级高于visible */
+            mountVisible: boolean | undefined;
+            /** 子应用列表 */
+            microApps: MicroAppItem[];
+            /** 当前激活的子应用名称 */
+            activeMicroAppName: string;
+            /** 当前激活的子应用信息 */
+            activeMicroAppItem: null | MicroAppItem;
+            /** 顶部导航菜单项列表 */
+            navItems: NavItem[];
+            /** 当前激活的顶部导航菜单项 */
+            activeNavItem: null | NavItem;
+            /** 左侧菜单项列表 */
+            menuItems: MenuItem[];
+            /** 当前激活左侧菜单项 */
+            activeMenuItem: null | MenuItem;
+            /** 全量导航菜单项 */
+            fullNavItems: NavItem[];
+            /** 标签内容项列表 */
+            tabItems: TabItem[];
+            /** 当前激活的标签内容项 */
+            activeTabItem: null | TabItem;
+            /** nav的BoundingClientRect信息 */
+            navRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** menu的BoundingClientRect信息 */
+            menuRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** tab的BoundingClientRect信息 */
+            tabRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** mount的BoundingClientRect信息 */
+            mountRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** 子应用的置顶状态。子应用处于置顶时，主应用将无法触发外框的事件。 */
+            microAppStickStatus: boolean;
+            /** 容器创建时的初始化配置 */
+            initOptions: ContainerInitOptions;
+        }, oldData: {
+            /** 整个容器是否显示，默认为true，包括内容区域 */
+            visible: boolean | undefined;
+            /** 外框是否显示，默认为true，外框包括顶部导航栏，左侧菜单栏，tab标签栏 */
+            frameVisible: boolean | undefined;
+            /** 外框的顶部导航栏是否显示，默认为true，单独设置此项优先级高于frameVisible */
+            navVisible: boolean | undefined;
+            /** 外框的左侧菜单栏是否显示，默认为true，单独设置此项优先级高于frameVisible */
+            menuVisible: boolean | undefined;
+            /** 外框的tab标签栏是否显示，默认为true，单独设置此项优先级高于frameVisible */
+            tabVisible: boolean | undefined;
+            /** 内容区是否显示，默认为true，单独设置此项优先级高于visible */
+            mountVisible: boolean | undefined;
+            /** 子应用列表 */
+            microApps: MicroAppItem[];
+            /** 当前激活的子应用名称 */
+            activeMicroAppName: string;
+            /** 当前激活的子应用信息 */
+            activeMicroAppItem: null | MicroAppItem;
+            /** 顶部导航菜单项列表 */
+            navItems: NavItem[];
+            /** 当前激活的顶部导航菜单项 */
+            activeNavItem: null | NavItem;
+            /** 左侧菜单项列表 */
+            menuItems: MenuItem[];
+            /** 当前激活左侧菜单项 */
+            activeMenuItem: null | MenuItem;
+            /** 全量导航菜单项 */
+            fullNavItems: NavItem[];
+            /** 标签内容项列表 */
+            tabItems: TabItem[];
+            /** 当前激活的标签内容项 */
+            activeTabItem: null | TabItem;
+            /** nav的BoundingClientRect信息 */
+            navRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** menu的BoundingClientRect信息 */
+            menuRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** tab的BoundingClientRect信息 */
+            tabRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** mount的BoundingClientRect信息 */
+            mountRect: {
+                x: number;
+                y: number;
+                height: number;
+                width: number;
+            };
+            /** 子应用的置顶状态。子应用处于置顶时，主应用将无法触发外框的事件。 */
+            microAppStickStatus: boolean;
+            /** 容器创建时的初始化配置 */
+            initOptions: ContainerInitOptions;
+        }) => any, watchKeys?: ("visible" | "frameVisible" | "navVisible" | "menuVisible" | "tabVisible" | "mountVisible" | "microApps" | "activeMicroAppName" | "activeMicroAppItem" | "navItems" | "activeNavItem" | "menuItems" | "activeMenuItem" | "fullNavItems" | "tabItems" | "activeTabItem" | "navRect" | "menuRect" | "tabRect" | "mountRect" | "microAppStickStatus" | "initOptions")[] | undefined) => () => void;
+    };
+    event: Emitter<Event_2>;
+    expose: {
+        /** 获取布局相关的数据key */
+        getLayoutDataKeys: () => any[];
+    };
+};
+
+declare const channelItem_2: {
+    data: {
+        set: (payload: Partial<{}>, opt?: {
+            notMerge?: boolean;
+        } | undefined) => void;
+        get: (keys?: never[] | undefined) => {};
+        watch: (cb: (newData: {}, oldData: {}) => any, watchKeys?: never[] | undefined) => () => void;
+    };
+    cors: {
+        send: (microAppName: string, key: ChildernListener, data?: any) => Promise<any>;
+        on: (name: ParentListener, opt1: any, opt2?: any) => any;
+        once: (name: ParentListener, opt1: any, opt2?: any) => any;
+    };
+    expose: {
+        connectMicroApp: (opt: microAppsDataItem) => Promise<void>;
+    };
+    event: Emitter<Event_3>;
+};
+
+declare const channelItem_3: {
+    data: {
+        set: (payload: Partial<{
+            appInfo: MicroAppItem;
+        }>, opt?: {
+            notMerge?: boolean;
+        } | undefined) => void;
+        get: (keys?: "appInfo"[] | undefined) => {
+            appInfo: MicroAppItem;
+        };
+        watch: (cb: (newData: {
+            appInfo: MicroAppItem;
+        }, oldData: {
+            appInfo: MicroAppItem;
+        }) => any, watchKeys?: "appInfo"[] | undefined) => () => void;
+    };
+    cors: {
+        send: (key: ParentListener_2, data?: any) => Promise<any>;
+        on: (name: ChildernListener_2, opt1?: any, opt2?: any) => any;
+        once: (name: ChildernListener_2, opt1?: any, opt2?: any) => any;
+    };
+};
+
+declare type ChildernListener = 'layoutDataChange' | 'syncRouter';
+
+declare type ChildernListener_2 = 'layoutDataChange' | 'syncRouter';
+
+declare type ContainerChannelType = {
+    container: typeof channelItem;
+};
+
+/** 容器的初始化配置 */
+declare type ContainerInitOptions = {
+    /** 容器类型。默认为microApp */
+    type?: 'mainApp' | 'microApp'
+
+    /** 应用挂载点。支持 #id，或者传入dom，默认值为#app。支持document.body或者其他dom */
+    appendTo?: String | HTMLElement
+
+    /** 路由配置 */
+    router?: RouterConfig
+
+    /** 子应用的列表。 */
+    microApps?: MicroAppItem[]
+
+    /** 作为子应用时，是否自动清除html、body、挂载点的背景颜色。默认清除，防止子应用的背景颜色覆盖主应用，但是会自动继到可用的布局容器中 */
+    autoClearBackground?: Boolean
+}
+
+/** 容器初始化方法的结果 */
+declare type ContainerResult = {
+    /** 顶部导航的挂载节点 */
+    navDom: HTMLDivElement
+
+    /** 左侧菜单的挂载节点 */
+    menuDom: HTMLDivElement
+
+    /** tab标签栏的挂载节点 */
+    tabDom: HTMLDivElement
+
+    /** 内容区的挂载节点 */
+    mountDom: HTMLDivElement
+}
+
+export declare const createContainer: (opt?: ContainerInitOptions) => Promise<ContainerResult>;
+
+export declare const createMainApp: (opt?: MainAppContainerInitOptions) => Promise<ContainerResult>;
+
+export declare const createMicroApp: (opt?: MicroAppContainerInitOptions) => Promise<MicroAppContainerResult>;
+
+declare type Event_2 = {
+    /** 容器组件onMounted生命周期 */
+    onMounted: any;
+    /** 容器组件内布局容器onMounted生命周期 */
+    onLayoutMounted: any;
+    /** 顶部导航菜单项的点击事件 */
+    navItemClick: any;
+    /** 左侧菜单项的点击事件 */
+    menuItemClick: any;
+    /** 左侧菜单项的点击事件 */
+    tabItemClick: any;
+    /** 左侧菜单项的点击事件 */
+    tabItemClose: any;
+    /** 展开收起图标的点击事件 */
+    collapseClick: any;
+};
+
+declare type Event_3 = {
+    /** 子应用上报路由信息事件 */
+    reportRouter: any;
+};
+
+declare enum LifeCycleKey {
+    'registered' = 0,
+    'loading' = 1,
+    'mounted' = 2,
+    'unmounted' = 3,
+    'activated' = 4,
+    'deactivated' = 5,
+    'destroy' = 6,
+    'error' = 7
+}
+
+declare type LifeCycleKeyType = keyof typeof LifeCycleKey;
+
+declare type MainAppChannelType = {
+    mainApp: typeof channelItem_2;
+};
+
+/** 主应用的初始化配置 */
+declare type MainAppContainerInitOptions = Omit<ContainerInitOptions, 'type' | 'autoClearBackground'>
+
+declare type MenuItem = {
+    label: string
+    value: string
+    [key: string]: any
+}
+
+declare type MicroAppChannelType = {
+    microApp: typeof channelItem_3;
+};
+
+/** 子应用的初始化配置 */
+declare type MicroAppContainerInitOptions = Omit<ContainerInitOptions, 'type' | 'microApps' | 'router'>
+
+/** 子应用容器初始化方法的结果 */
+declare type MicroAppContainerResult = Pick<ContainerResult, 'mountDom'>
+
+/** 子应用信息 */
+declare type MicroAppItem = {
+    /** 子应用名称，唯一标识。 */
+    name: string
+
+    /** 子应用来源（协议、主机、端口） */
+    origin: string
+
+    /** 子应用路由激活的规则，唯一规则（注意不要和其他应用存在包含关系）。支持如 glob 语法，使用 picomatch 来匹配 */
+    activeRule: string
+
+    /** 作为子应用时，是否自动清除html、body、挂载点的背景颜色。默认清除，防止子应用的背景颜色覆盖主应用，但是会自动继到可用的布局容器中 */
+    autoClearBackground?: Boolean
+
+    /** 路由配置 */
+    router?: RouterConfig
+
+    [key: string]: any
+}
+
+declare type microAppsDataItem = {
+    name: string;
+    contentWindow: Window;
+    [key: string]: any;
+};
+
+declare type NavItem = {
+    label: string
+    value: string
+    [key: string]: any
+}
+
+declare type ParentListener = 'getMicroFrameRect' | 'reportRouter' | 'microAppStickStatus';
+
+declare type ParentListener_2 = 'getMicroFrameRect' | 'reportRouter' | 'microAppStickStatus';
+
+export declare const pollVariable: <T>(getDataFn: () => any, opt?: {
+    interval: number;
+    times: number;
+}) => Promise<T>;
+
+export declare const reportRouter: (data?: any) => Promise<void>;
+
+declare type RouterConfig = {
+    /** 是否自动同步路由。默认自动同步 */
+    sync?: Boolean
+
+    /** 应用的路由模式。默认history，可以选值hash */
+    mode?: 'history' | 'hash'
+}
+
+declare type RouterEventListenerTypes = 'replaceState' | 'pushState';
+
+export declare const syncRouter: (cb: (params: {
+    appInfo: any;
+    parentRouter: any;
+    replacePath: string;
+}) => any) => void;
+
+declare type TabItem = {
+    label: string
+    value: string
+    [key: string]: any
+}
+
+export declare const useIframeManager: () => {
+    setIframeMountDom: (ele: Element | null) => void;
+    registerIframe: (id: string, config: MicroAppContainerInitOptions) => void;
+    getIframeInfo: (id: string) => any;
+    checkIframeStatus: (id: string, status: LifeCycleKeyType | LifeCycleKeyType[]) => boolean;
+    iframeEvent: Emitter<    {
+    registered: any;
+    loading: any;
+    mounted: any;
+    unmounted: any;
+    activated: any;
+    deactivated: any;
+    destroy: any;
+    error: any;
+    }>;
+    loadIframe: (id: string, opt?: any) => Promise<void>;
+    hideIframe: (iframeId?: string) => void;
+    destroyIframe: (id: string) => void;
+};
+
+export declare const useRouter: () => {
+    replaceState: (path: string) => void;
+    addRule: (key: string, globString: string) => void;
+    match: (path: string) => any;
+};
+
+export declare const useRouterEventListener: () => {
+    addRouterEventListener: (type: RouterEventListenerTypes | RouterEventListenerTypes[], cb: (e: any) => any) => void;
+    removeRouterEventListener: (type?: RouterEventListenerTypes | RouterEventListenerTypes[]) => void;
+};
+
+export { }