@module-federation/bridge-react 0.4.0 → 0.5.0

package/dist/index.es.js

@@ -1,6 +1,6 @@
 import * as React from "react";
-import React__default, { createContext, Component, createElement, isValidElement, useContext, useState, useEffect, useRef, forwardRef } from "react";
-import { p as pathJoin, L as LoggerInstance, f, a as atLeastReact18, R as RouterContext } from "./context-Bw2PEwa6.js";
+import React__default, { createContext, Component, createElement, isValidElement, forwardRef, useRef, useEffect, useContext, useState } from "react";
+import { L as LoggerInstance, p as pathJoin, f, a as atLeastReact18, R as RouterContext } from "./context-Bw2PEwa6.js";
 import * as ReactRouterDOM from "react-router-dom";
 import ReactDOM from "react-dom";
 const ErrorBoundaryContext = createContext(null);
@@ -98,55 +98,71 @@ function hasArrayChanged() {
   let b = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : [];
   return a.length !== b.length || a.some((item, index) => !Object.is(item, b[index]));
 }
-const RemoteApp = ({
-  name,
-  memoryRoute,
-  basename,
-  providerInfo,
-  ...resProps
-}) => {
-  const rootRef = useRef(null);
-  const renderDom = useRef(null);
-  const providerInfoRef = useRef(null);
-  useEffect(() => {
-    const renderTimeout = setTimeout(() => {
-      const providerReturn = providerInfo();
-      providerInfoRef.current = providerReturn;
-      const renderProps = {
-        name,
-        dom: rootRef.current,
-        basename,
-        memoryRoute,
-        ...resProps
-      };
-      renderDom.current = rootRef.current;
-      LoggerInstance.log(
-        `createRemoteComponent LazyComponent render >>>`,
-        renderProps
-      );
-      providerReturn.render(renderProps);
-    });
-    return () => {
-      clearTimeout(renderTimeout);
-      setTimeout(() => {
-        var _a, _b;
-        if ((_a = providerInfoRef.current) == null ? void 0 : _a.destroy) {
-          LoggerInstance.log(
-            `createRemoteComponent LazyComponent destroy >>>`,
-            { name, basename, dom: renderDom.current }
-          );
-          (_b = providerInfoRef.current) == null ? void 0 : _b.destroy({
-            dom: renderDom.current
-          });
-        }
+const RemoteAppWrapper = forwardRef(function(props, ref) {
+  const RemoteApp2 = () => {
+    LoggerInstance.log(`RemoteAppWrapper RemoteApp props >>>`, { props });
+    const {
+      moduleName,
+      memoryRoute,
+      basename,
+      providerInfo,
+      className,
+      style,
+      fallback,
+      ...resProps
+    } = props;
+    const rootRef = ref && "current" in ref ? ref : useRef(null);
+    const renderDom = useRef(null);
+    const providerInfoRef = useRef(null);
+    useEffect(() => {
+      const renderTimeout = setTimeout(() => {
+        const providerReturn = providerInfo();
+        providerInfoRef.current = providerReturn;
+        const renderProps = {
+          moduleName,
+          dom: rootRef.current,
+          basename,
+          memoryRoute,
+          fallback,
+          ...resProps
+        };
+        renderDom.current = rootRef.current;
+        LoggerInstance.log(
+          `createRemoteComponent LazyComponent render >>>`,
+          renderProps
+        );
+        providerReturn.render(renderProps);
       });
-    };
-  }, []);
-  return /* @__PURE__ */ React__default.createElement("div", { ref: rootRef });
-};
-RemoteApp["__APP_VERSION__"] = "0.4.0";
+      return () => {
+        clearTimeout(renderTimeout);
+        setTimeout(() => {
+          var _a, _b;
+          if ((_a = providerInfoRef.current) == null ? void 0 : _a.destroy) {
+            LoggerInstance.log(
+              `createRemoteComponent LazyComponent destroy >>>`,
+              { moduleName, basename, dom: renderDom.current }
+            );
+            (_b = providerInfoRef.current) == null ? void 0 : _b.destroy({
+              dom: renderDom.current
+            });
+          }
+        });
+      };
+    }, []);
+    return /* @__PURE__ */ React__default.createElement(
+      "div",
+      {
+        className: props == null ? void 0 : props.className,
+        style: props == null ? void 0 : props.style,
+        ref: rootRef
+      }
+    );
+  };
+  RemoteApp2["__APP_VERSION__"] = "0.5.0";
+  return /* @__PURE__ */ React__default.createElement(RemoteApp2, null);
+});
 function withRouterData(WrappedComponent) {
-  return (props) => {
+  const Component2 = forwardRef(function(props, ref) {
     var _a;
     let enableDispathPopstate = false;
     let routerContextVal;
@@ -204,10 +220,13 @@ function withRouterData(WrappedComponent) {
         setPathname(location.pathname);
       }, [location]);
     }
-    return /* @__PURE__ */ React__default.createElement(WrappedComponent, { ...props, basename });
-  };
+    return /* @__PURE__ */ React__default.createElement(WrappedComponent, { ...props, basename, ref });
+  });
+  return forwardRef(function(props, ref) {
+    return /* @__PURE__ */ React__default.createElement(Component2, { ...props, ref });
+  });
 }
-const RemoteApp$1 = withRouterData(RemoteApp);
+const RemoteApp = withRouterData(RemoteAppWrapper);
 function createLazyRemoteComponent(info) {
   const exportName = (info == null ? void 0 : info.export) || "default";
   return React__default.lazy(async () => {
@@ -224,13 +243,15 @@ function createLazyRemoteComponent(info) {
       );
       const exportFn = m2[exportName];
       if (exportName in m2 && typeof exportFn === "function") {
-        const RemoteAppComponent = forwardRef((props, _ref) => {
+        const RemoteAppComponent = forwardRef((props, ref) => {
           return /* @__PURE__ */ React__default.createElement(
-            RemoteApp$1,
+            RemoteApp,
             {
-              name: moduleName,
+              moduleName,
               providerInfo: exportFn,
               exportName: info.export || "default",
+              fallback: info.fallback,
+              ref,
               ...props
             }
           );
@@ -255,10 +276,13 @@ function createLazyRemoteComponent(info) {
   });
 }
 function createRemoteComponent(info) {
-  const LazyComponent = createLazyRemoteComponent(info);
-  return (props) => {
-    return /* @__PURE__ */ React__default.createElement(ErrorBoundary, { FallbackComponent: info.fallback }, /* @__PURE__ */ React__default.createElement(React__default.Suspense, { fallback: info.loading }, /* @__PURE__ */ React__default.createElement(LazyComponent, { ...props })));
-  };
+  return forwardRef((props, ref) => {
+    const LazyComponent = createLazyRemoteComponent(info);
+    return (
+      // set ErrorBoundary for LazyComponent rendering error, usually caused by inner bridge logic render process
+      /* @__PURE__ */ React__default.createElement(ErrorBoundary, { FallbackComponent: info.fallback }, /* @__PURE__ */ React__default.createElement(React__default.Suspense, { fallback: info.loading }, /* @__PURE__ */ React__default.createElement(LazyComponent, { ...props, ref })))
+    );
+  });
 }
 var client = {};
 var m = ReactDOM;
@@ -288,54 +312,65 @@ function createBridgeComponent(bridgeInfo) {
   return () => {
     const rootMap = /* @__PURE__ */ new Map();
     const RawComponent = (info) => {
-      const { appInfo, propsInfo } = info;
-      const { name, memoryRoute, basename = "/" } = appInfo;
-      return /* @__PURE__ */ React.createElement(RouterContext.Provider, { value: { name, basename, memoryRoute } }, /* @__PURE__ */ React.createElement(bridgeInfo.rootComponent, { ...propsInfo, basename }));
+      const { appInfo, propsInfo, ...restProps } = info;
+      const { moduleName, memoryRoute, basename = "/" } = appInfo;
+      return /* @__PURE__ */ React.createElement(RouterContext.Provider, { value: { moduleName, basename, memoryRoute } }, /* @__PURE__ */ React.createElement(
+        bridgeInfo.rootComponent,
+        {
+          ...propsInfo,
+          basename,
+          ...restProps
+        }
+      ));
     };
     return {
-      render(info) {
+      async render(info) {
         LoggerInstance.log(`createBridgeComponent render Info`, info);
-        const { name, basename, memoryRoute, ...propsInfo } = info;
+        const {
+          moduleName,
+          dom,
+          basename,
+          memoryRoute,
+          fallback,
+          ...propsInfo
+        } = info;
+        const rootComponentWithErrorBoundary = (
+          // set ErrorBoundary for RawComponent rendering error, usually caused by user app rendering error
+          /* @__PURE__ */ React.createElement(ErrorBoundary, { FallbackComponent: fallback }, /* @__PURE__ */ React.createElement(
+            RawComponent,
+            {
+              appInfo: {
+                moduleName,
+                basename,
+                memoryRoute
+              },
+              propsInfo
+            }
+          ))
+        );
         if (atLeastReact18(React)) {
-          const root = client.createRoot(info.dom);
-          rootMap.set(info.dom, root);
-          root.render(
-            /* @__PURE__ */ React.createElement(
-              RawComponent,
-              {
-                propsInfo,
-                appInfo: {
-                  name,
-                  basename,
-                  memoryRoute
-                }
-              }
-            )
-          );
+          if (bridgeInfo == null ? void 0 : bridgeInfo.render) {
+            Promise.resolve(
+              bridgeInfo == null ? void 0 : bridgeInfo.render(rootComponentWithErrorBoundary, dom)
+            ).then((root) => rootMap.set(info.dom, root));
+          } else {
+            const root = client.createRoot(info.dom);
+            root.render(rootComponentWithErrorBoundary);
+            rootMap.set(info.dom, root);
+          }
         } else {
-          ReactDOM.render(
-            /* @__PURE__ */ React.createElement(
-              RawComponent,
-              {
-                propsInfo,
-                appInfo: {
-                  name,
-                  basename,
-                  memoryRoute
-                }
-              }
-            ),
-            info.dom
-          );
+          const renderFn = (bridgeInfo == null ? void 0 : bridgeInfo.render) || ReactDOM.render;
+          renderFn == null ? void 0 : renderFn(rootComponentWithErrorBoundary, info.dom);
         }
       },
-      destroy(info) {
+      async destroy(info) {
         LoggerInstance.log(`createBridgeComponent destroy Info`, {
           dom: info.dom
         });
         if (atLeastReact18(React)) {
           const root = rootMap.get(info.dom);
           root == null ? void 0 : root.unmount();
+          rootMap.delete(info.dom);
         } else {
           ReactDOM.unmountComponentAtNode(info.dom);
         }

package/dist/router-v5.cjs.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("react");
+const ReactRouterDom = require("react-router-dom/index.js");
+require("./context--mtFt3tp.cjs");
+const router = require("./router.cjs.js");
+exports.BrowserRouter = router.BrowserRouter;
+exports.RouterProvider = router.RouterProvider;
+Object.keys(ReactRouterDom).forEach((k) => {
+  if (k !== "default" && !Object.prototype.hasOwnProperty.call(exports, k))
+    Object.defineProperty(exports, k, {
+      enumerable: true,
+      get: () => ReactRouterDom[k]
+    });
+});

package/dist/router-v5.d.ts

@@ -0,0 +1,11 @@
+import { default as default_2 } from 'react';
+import * as ReactRouterDom from 'react-router-dom/';
+
+export declare function BrowserRouter(props: Parameters<typeof ReactRouterDom.BrowserRouter>[0] | Parameters<typeof ReactRouterDom.MemoryRouter>[0]): default_2.JSX.Element;
+
+export declare function RouterProvider(props: Parameters<typeof ReactRouterDom.RouterProvider>[0]): default_2.JSX.Element;
+
+
+export * from "react-router-dom/";
+
+export { }

package/dist/router-v5.es.js

@@ -0,0 +1,8 @@
+import "react";
+export * from "react-router-dom/index.js";
+import "./context-Bw2PEwa6.js";
+import { BrowserRouter, RouterProvider } from "./router.es.js";
+export {
+  BrowserRouter,
+  RouterProvider
+};

package/dist/router-v6.cjs.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+require("react");
+const ReactRouterDom = require("react-router-dom/dist/index.js");
+require("./context--mtFt3tp.cjs");
+const router = require("./router.cjs.js");
+exports.BrowserRouter = router.BrowserRouter;
+exports.RouterProvider = router.RouterProvider;
+Object.keys(ReactRouterDom).forEach((k) => {
+  if (k !== "default" && !Object.prototype.hasOwnProperty.call(exports, k))
+    Object.defineProperty(exports, k, {
+      enumerable: true,
+      get: () => ReactRouterDom[k]
+    });
+});

package/dist/router-v6.d.ts

@@ -0,0 +1,11 @@
+import { default as default_2 } from 'react';
+import * as ReactRouterDom from 'react-router-dom/';
+
+export declare function BrowserRouter(props: Parameters<typeof ReactRouterDom.BrowserRouter>[0] | Parameters<typeof ReactRouterDom.MemoryRouter>[0]): default_2.JSX.Element;
+
+export declare function RouterProvider(props: Parameters<typeof ReactRouterDom.RouterProvider>[0]): default_2.JSX.Element;
+
+
+export * from "react-router-dom/";
+
+export { }

package/dist/router-v6.es.js

@@ -0,0 +1,8 @@
+import "react";
+export * from "react-router-dom/dist/index.js";
+import "./context-Bw2PEwa6.js";
+import { BrowserRouter, RouterProvider } from "./router.es.js";
+export {
+  BrowserRouter,
+  RouterProvider
+};

package/dist/router.cjs.js

@@ -20,16 +20,14 @@ function _interopNamespaceDefault(e) {
   return Object.freeze(n);
 }
 const ReactRouterDom__namespace = /* @__PURE__ */ _interopNamespaceDefault(ReactRouterDom);
-function WraperRouter(props) {
+function WrapperRouter(props) {
   const { basename, ...propsRes } = props;
   const routerContextProps = React.useContext(context.RouterContext) || {};
-  context.LoggerInstance.log(`WraperRouter info >>>`, {
+  context.LoggerInstance.log(`WrapperRouter info >>>`, {
     ...routerContextProps,
     routerContextProps,
-    WraperRouterProps: props
+    WrapperRouterProps: props
   });
-  if (!routerContextProps)
-    return /* @__PURE__ */ React.createElement(ReactRouterDom__namespace.BrowserRouter, { ...props });
   if (routerContextProps == null ? void 0 : routerContextProps.memoryRoute) {
     return /* @__PURE__ */ React.createElement(
       ReactRouterDom__namespace.MemoryRouter,
@@ -47,21 +45,19 @@ function WraperRouter(props) {
     }
   );
 }
-function WraperRouterProvider(props) {
+function WrapperRouterProvider(props) {
   const { router, ...propsRes } = props;
   const routerContextProps = React.useContext(context.RouterContext) || {};
   const routers = router.routes;
-  context.LoggerInstance.log(`WraperRouterProvider info >>>`, {
+  context.LoggerInstance.log(`WrapperRouterProvider info >>>`, {
     ...routerContextProps,
     routerContextProps,
-    WraperRouterProviderProps: props,
+    WrapperRouterProviderProps: props,
     router
   });
   const RouterProvider = ReactRouterDom__namespace["RouterProvider"];
   const createMemoryRouter = ReactRouterDom__namespace["createMemoryRouter"];
   const createBrowserRouter = ReactRouterDom__namespace["createBrowserRouter"];
-  if (!routerContextProps)
-    return /* @__PURE__ */ React.createElement(RouterProvider, { ...props });
   if (routerContextProps.memoryRoute) {
     const MemeoryRouterInstance = createMemoryRouter(routers, {
       initialEntries: [routerContextProps == null ? void 0 : routerContextProps.memoryRoute.entryPath]
@@ -76,8 +72,8 @@ function WraperRouterProvider(props) {
     return /* @__PURE__ */ React.createElement(RouterProvider, { ...propsRes, router: BrowserRouterInstance });
   }
 }
-exports.BrowserRouter = WraperRouter;
-exports.RouterProvider = WraperRouterProvider;
+exports.BrowserRouter = WrapperRouter;
+exports.RouterProvider = WrapperRouterProvider;
 Object.keys(ReactRouterDom).forEach((k) => {
   if (k !== "default" && !Object.prototype.hasOwnProperty.call(exports, k))
     Object.defineProperty(exports, k, {

package/dist/router.es.js

@@ -2,16 +2,14 @@ import React__default, { useContext } from "react";
 import * as ReactRouterDom from "react-router-dom/";
 export * from "react-router-dom/";
 import { R as RouterContext, L as LoggerInstance } from "./context-Bw2PEwa6.js";
-function WraperRouter(props) {
+function WrapperRouter(props) {
   const { basename, ...propsRes } = props;
   const routerContextProps = useContext(RouterContext) || {};
-  LoggerInstance.log(`WraperRouter info >>>`, {
+  LoggerInstance.log(`WrapperRouter info >>>`, {
     ...routerContextProps,
     routerContextProps,
-    WraperRouterProps: props
+    WrapperRouterProps: props
   });
-  if (!routerContextProps)
-    return /* @__PURE__ */ React__default.createElement(ReactRouterDom.BrowserRouter, { ...props });
   if (routerContextProps == null ? void 0 : routerContextProps.memoryRoute) {
     return /* @__PURE__ */ React__default.createElement(
       ReactRouterDom.MemoryRouter,
@@ -29,21 +27,19 @@ function WraperRouter(props) {
     }
   );
 }
-function WraperRouterProvider(props) {
+function WrapperRouterProvider(props) {
   const { router, ...propsRes } = props;
   const routerContextProps = useContext(RouterContext) || {};
   const routers = router.routes;
-  LoggerInstance.log(`WraperRouterProvider info >>>`, {
+  LoggerInstance.log(`WrapperRouterProvider info >>>`, {
     ...routerContextProps,
     routerContextProps,
-    WraperRouterProviderProps: props,
+    WrapperRouterProviderProps: props,
     router
   });
   const RouterProvider = ReactRouterDom["RouterProvider"];
   const createMemoryRouter = ReactRouterDom["createMemoryRouter"];
   const createBrowserRouter = ReactRouterDom["createBrowserRouter"];
-  if (!routerContextProps)
-    return /* @__PURE__ */ React__default.createElement(RouterProvider, { ...props });
   if (routerContextProps.memoryRoute) {
     const MemeoryRouterInstance = createMemoryRouter(routers, {
       initialEntries: [routerContextProps == null ? void 0 : routerContextProps.memoryRoute.entryPath]
@@ -59,6 +55,6 @@ function WraperRouterProvider(props) {
   }
 }
 export {
-  WraperRouter as BrowserRouter,
-  WraperRouterProvider as RouterProvider
+  WrapperRouter as BrowserRouter,
+  WrapperRouterProvider as RouterProvider
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@module-federation/bridge-react",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "publishConfig": {
     "access": "public"
   },
@@ -20,12 +20,22 @@
       "import": "./dist/router.es.js",
       "require": "./dist/router.cjs.js"
     },
+    "./router-v5": {
+      "types": "./dist/router.d.ts",
+      "import": "./dist/router.es.js",
+      "require": "./dist/router.cjs.js"
+    },
+    "./router-v6": {
+      "types": "./dist/router.d.ts",
+      "import": "./dist/router.es.js",
+      "require": "./dist/router.cjs.js"
+    },
     "./*": "./*"
   },
   "dependencies": {
     "@loadable/component": "^5.16.4",
     "react-error-boundary": "^4.0.13",
-    "@module-federation/bridge-shared": "0.4.0"
+    "@module-federation/bridge-shared": "0.5.0"
   },
   "peerDependencies": {
     "react": ">=16.9.0",

package/src/create.tsx

@@ -13,11 +13,7 @@ export interface RenderFnParams extends ProviderParams {
 
 interface RemoteModule {
   provider: () => {
-    render: (
-      info: ProviderParams & {
-        dom: any;
-      },
-    ) => void;
+    render: (info: RenderFnParams) => void;
     destroy: (info: { dom: any }) => void;
   };
 }
@@ -34,6 +30,7 @@ function createLazyRemoteComponent<T, E extends keyof T>(info: {
       lazyComponent: info.loader,
       exportName,
     });
+
     try {
       const m = (await info.loader()) as RemoteModule;
       // @ts-ignore
@@ -44,8 +41,7 @@ function createLazyRemoteComponent<T, E extends keyof T>(info: {
       );
 
       // @ts-ignore
-      const exportFn = m[exportName] as any;
-
+      const exportFn = m[exportName];
       if (exportName in m && typeof exportFn === 'function') {
         const RemoteAppComponent = forwardRef<
           HTMLDivElement,
@@ -53,12 +49,15 @@ function createLazyRemoteComponent<T, E extends keyof T>(info: {
             basename?: ProviderParams['basename'];
             memoryRoute?: ProviderParams['memoryRoute'];
           }
-        >((props, _ref) => {
+        >((props, ref) => {
           return (
             <RemoteApp
-              name={moduleName}
+              // change `name` key to `moduleName` to avoid same property `name` passed by user's props which may cause unexpected issues.
+              moduleName={moduleName}
               providerInfo={exportFn}
               exportName={info.export || 'default'}
+              fallback={info.fallback}
+              ref={ref}
               {...props}
             />
           );
@@ -93,26 +92,22 @@ export function createRemoteComponent<T, E extends keyof T>(info: {
   type ExportType = T[E] extends (...args: any) => any
     ? ReturnType<T[E]>
     : never;
+
   type RawComponentType = '__BRIDGE_FN__' extends keyof ExportType
     ? ExportType['__BRIDGE_FN__'] extends (...args: any) => any
       ? Parameters<ExportType['__BRIDGE_FN__']>[0]
       : {}
     : {};
 
-  const LazyComponent = createLazyRemoteComponent(info);
-
-  return (
-    props: {
-      basename?: ProviderParams['basename'];
-      memoryRoute?: ProviderParams['memoryRoute'];
-    } & RawComponentType,
-  ) => {
+  return forwardRef((props: ProviderParams & RawComponentType, ref) => {
+    const LazyComponent = createLazyRemoteComponent(info);
     return (
+      // set ErrorBoundary for LazyComponent rendering error, usually caused by inner bridge logic render process
       <ErrorBoundary FallbackComponent={info.fallback}>
         <React.Suspense fallback={info.loading}>
-          <LazyComponent {...props} />
+          <LazyComponent {...props} ref={ref} />
         </React.Suspense>
       </ErrorBoundary>
     );
-  };
+  });
 }