@module-federation/bridge-react 0.0.0-next-20240927195332 → 0.0.0-next-20240930091801

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -65,7 +65,7 @@ function WraperRouterProvider(props) {
65
65
  return /* @__PURE__ */ React.createElement(RouterProvider, { router: MemeoryRouterInstance });
66
66
  } else {
67
67
  const BrowserRouterInstance = createBrowserRouter(routers, {
68
- basename: routerContextProps.basename,
68
+ basename: routerContextProps.basename || (router == null ? void 0 : router.basename),
69
69
  future: router.future,
70
70
  window: router.window
71
71
  });
@@ -47,7 +47,7 @@ function WraperRouterProvider(props) {
47
47
  return /* @__PURE__ */ React__default.createElement(RouterProvider, { router: MemeoryRouterInstance });
48
48
  } else {
49
49
  const BrowserRouterInstance = createBrowserRouter(routers, {
50
- basename: routerContextProps.basename,
50
+ basename: routerContextProps.basename || (router == null ? void 0 : router.basename),
51
51
  future: router.future,
52
52
  window: router.window
53
53
  });
@@ -65,7 +65,7 @@ function WrapperRouterProvider(props) {
65
65
  return /* @__PURE__ */ React.createElement(RouterProvider, { router: MemeoryRouterInstance });
66
66
  } else {
67
67
  const BrowserRouterInstance = createBrowserRouter(routers, {
68
- basename: routerContextProps.basename,
68
+ basename: routerContextProps.basename || (router == null ? void 0 : router.basename),
69
69
  future: router.future,
70
70
  window: router.window
71
71
  });
package/dist/router.es.js CHANGED
@@ -47,7 +47,7 @@ function WrapperRouterProvider(props) {
47
47
  return /* @__PURE__ */ React__default.createElement(RouterProvider, { router: MemeoryRouterInstance });
48
48
  } else {
49
49
  const BrowserRouterInstance = createBrowserRouter(routers, {
50
- basename: routerContextProps.basename,
50
+ basename: routerContextProps.basename || (router == null ? void 0 : router.basename),
51
51
  future: router.future,
52
52
  window: router.window
53
53
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@module-federation/bridge-react",
3
- "version": "0.0.0-next-20240927195332",
3
+ "version": "0.0.0-next-20240930091801",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -35,12 +35,13 @@
35
35
  "dependencies": {
36
36
  "@loadable/component": "^5.16.4",
37
37
  "react-error-boundary": "^4.0.13",
38
- "@module-federation/bridge-shared": "0.0.0-next-20240927195332"
38
+ "@module-federation/bridge-shared": "0.0.0-next-20240930091801"
39
39
  },
40
40
  "peerDependencies": {
41
41
  "react": ">=16.9.0",
42
42
  "react-dom": ">=16.9.0",
43
- "react-router-dom": ">=4"
43
+ "react-router-dom": ">=4",
44
+ "@module-federation/runtime": "0.0.0-next-20240930091801"
44
45
  },
45
46
  "devDependencies": {
46
47
  "@testing-library/react": "15.0.7",
package/src/create.tsx CHANGED
@@ -1,11 +1,11 @@
1
1
  import React, { forwardRef } from 'react';
2
- import type { ProviderParams } from '@module-federation/bridge-shared';
3
- import { LoggerInstance } from './utils';
4
2
  import {
5
3
  ErrorBoundary,
6
4
  ErrorBoundaryPropsWithComponent,
7
5
  } from 'react-error-boundary';
6
+ import { LoggerInstance } from './utils';
8
7
  import RemoteApp from './remote';
8
+ import type { ProviderParams } from '@module-federation/bridge-shared';
9
9
 
10
10
  export interface RenderFnParams extends ProviderParams {
11
11
  dom?: any;
@@ -0,0 +1,29 @@
1
+ import { getInstance } from '@module-federation/runtime';
2
+ import helper from '@module-federation/runtime/helpers';
3
+
4
+ function registerBridgeLifeCycle() {
5
+ const { registerPlugins, pluginHelper } = helper.global;
6
+ const host = getInstance();
7
+ const pluginSystem = new pluginHelper.PluginSystem({
8
+ beforeBridgeRender: new pluginHelper.SyncHook<
9
+ [Record<string, any>],
10
+ void
11
+ >(),
12
+ beforeBridgeDestroy: new pluginHelper.SyncHook<
13
+ [Record<string, any>],
14
+ void
15
+ >(),
16
+ });
17
+
18
+ if (host) {
19
+ registerPlugins<typeof pluginSystem.lifecycle, typeof pluginSystem>(
20
+ host?.options?.plugins,
21
+ [pluginSystem],
22
+ );
23
+ return pluginSystem;
24
+ }
25
+
26
+ return null;
27
+ }
28
+
29
+ export { registerBridgeLifeCycle };
package/src/provider.tsx CHANGED
@@ -2,25 +2,35 @@ import { useLayoutEffect, useRef, useState } from 'react';
2
2
  import * as React from 'react';
3
3
  import ReactDOM from 'react-dom';
4
4
  import ReactDOMClient from 'react-dom/client';
5
- import { RouterContext } from './context';
6
5
  import type {
7
6
  ProviderParams,
8
7
  RenderFnParams,
9
8
  } from '@module-federation/bridge-shared';
10
- import { LoggerInstance, atLeastReact18 } from './utils';
11
9
  import { ErrorBoundary } from 'react-error-boundary';
10
+ import { RouterContext } from './context';
11
+ import { LoggerInstance, atLeastReact18 } from './utils';
12
12
 
13
+ type RenderParams = RenderFnParams & any;
14
+ type DestroyParams = {
15
+ dom: HTMLElement;
16
+ };
13
17
  type RootType = HTMLElement | ReactDOMClient.Root;
18
+
19
+ type BridgeHooks = {
20
+ beforeBridgeRender?: (params: RenderFnParams) => void;
21
+ beforeBridgeDestroy?: (params: DestroyParams) => void;
22
+ };
23
+
14
24
  type ProviderFnParams<T> = {
15
25
  rootComponent: React.ComponentType<T>;
16
26
  render?: (
17
27
  App: React.ReactElement,
18
28
  id?: HTMLElement | string,
19
29
  ) => RootType | Promise<RootType>;
30
+ hooks?: BridgeHooks;
20
31
  };
21
-
22
32
  export function createBridgeComponent<T>(bridgeInfo: ProviderFnParams<T>) {
23
- return () => {
33
+ return (params: { hooks?: BridgeHooks }) => {
24
34
  const rootMap = new Map<any, RootType>();
25
35
  const RawComponent = (info: { propsInfo: T; appInfo: ProviderParams }) => {
26
36
  const { appInfo, propsInfo, ...restProps } = info;
@@ -37,7 +47,7 @@ export function createBridgeComponent<T>(bridgeInfo: ProviderFnParams<T>) {
37
47
  };
38
48
 
39
49
  return {
40
- async render(info: RenderFnParams & any) {
50
+ async render(info: RenderParams) {
41
51
  LoggerInstance.log(`createBridgeComponent render Info`, info);
42
52
  const {
43
53
  moduleName,
@@ -61,6 +71,20 @@ export function createBridgeComponent<T>(bridgeInfo: ProviderFnParams<T>) {
61
71
  </ErrorBoundary>
62
72
  );
63
73
 
74
+ const beforeBridgeRender =
75
+ (bridgeInfo?.hooks && bridgeInfo?.hooks.beforeBridgeRender) ||
76
+ params?.hooks?.beforeBridgeRender;
77
+ beforeBridgeRender && beforeBridgeRender(info);
78
+ // call beforeBridgeRender hook
79
+ // if (
80
+ // bridgeInfo?.hooks &&
81
+ // bridgeInfo?.hooks.beforeBridgeRender &&
82
+ // typeof bridgeInfo?.hooks.beforeBridgeRender === 'function'
83
+ // ) {
84
+ // bridgeInfo.hooks.beforeBridgeRender(info);
85
+ // }
86
+
87
+ // call render function
64
88
  if (atLeastReact18(React)) {
65
89
  if (bridgeInfo?.render) {
66
90
  // in case bridgeInfo?.render is an async function, resolve this to promise
@@ -78,10 +102,26 @@ export function createBridgeComponent<T>(bridgeInfo: ProviderFnParams<T>) {
78
102
  renderFn?.(rootComponentWithErrorBoundary, info.dom);
79
103
  }
80
104
  },
81
- async destroy(info: { dom: HTMLElement }) {
105
+ async destroy(info: DestroyParams) {
82
106
  LoggerInstance.log(`createBridgeComponent destroy Info`, {
83
107
  dom: info.dom,
84
108
  });
109
+
110
+ // call beforeBridgeDestroy hook
111
+ if (
112
+ bridgeInfo?.hooks &&
113
+ bridgeInfo?.hooks.beforeBridgeDestroy &&
114
+ typeof bridgeInfo?.hooks.beforeBridgeDestroy === 'function'
115
+ ) {
116
+ bridgeInfo.hooks.beforeBridgeDestroy(info);
117
+ }
118
+
119
+ const beforeBridgeDestroy =
120
+ (bridgeInfo?.hooks && bridgeInfo?.hooks.beforeBridgeDestroy) ||
121
+ params?.hooks?.beforeBridgeDestroy;
122
+ beforeBridgeDestroy && beforeBridgeDestroy(info);
123
+
124
+ // call destroy function
85
125
  if (atLeastReact18(React)) {
86
126
  const root = rootMap.get(info.dom);
87
127
  (root as ReactDOMClient.Root)?.unmount();
@@ -7,9 +7,10 @@ import React, {
7
7
  } from 'react';
8
8
  import * as ReactRouterDOM from 'react-router-dom';
9
9
  import type { ProviderParams } from '@module-federation/bridge-shared';
10
- import { LoggerInstance, pathJoin } from '../utils';
11
10
  import { dispatchPopstateEnv } from '@module-federation/bridge-shared';
12
11
  import { ErrorBoundaryPropsWithComponent } from 'react-error-boundary';
12
+ import { registerBridgeLifeCycle } from '../lifecycle';
13
+ import { LoggerInstance, pathJoin } from '../utils';
13
14
 
14
15
  declare const __APP_VERSION__: string;
15
16
  export interface RenderFnParams extends ProviderParams {
@@ -39,6 +40,7 @@ const RemoteAppWrapper = forwardRef(function (
39
40
  props: RemoteAppParams & RenderFnParams,
40
41
  ref,
41
42
  ) {
43
+ const bridgeHook = registerBridgeLifeCycle();
42
44
  const RemoteApp = () => {
43
45
  LoggerInstance.log(`RemoteAppWrapper RemoteApp props >>>`, { props });
44
46
  const {
@@ -78,6 +80,13 @@ const RemoteAppWrapper = forwardRef(function (
78
80
  `createRemoteComponent LazyComponent render >>>`,
79
81
  renderProps,
80
82
  );
83
+
84
+ if (bridgeHook && bridgeHook?.lifecycle?.beforeBridgeRender) {
85
+ bridgeHook?.lifecycle?.beforeBridgeRender.emit({
86
+ ...renderProps,
87
+ });
88
+ }
89
+
81
90
  providerReturn.render(renderProps);
82
91
  });
83
92
 
@@ -89,6 +98,16 @@ const RemoteAppWrapper = forwardRef(function (
89
98
  `createRemoteComponent LazyComponent destroy >>>`,
90
99
  { moduleName, basename, dom: renderDom.current },
91
100
  );
101
+ if (bridgeHook && bridgeHook?.lifecycle?.beforeBridgeDestroy) {
102
+ bridgeHook?.lifecycle?.beforeBridgeDestroy.emit({
103
+ moduleName,
104
+ dom: renderDom.current,
105
+ basename,
106
+ memoryRoute,
107
+ fallback,
108
+ ...resProps,
109
+ });
110
+ }
92
111
  providerInfoRef.current?.destroy({
93
112
  dom: renderDom.current,
94
113
  });
package/src/router-v5.tsx CHANGED
@@ -2,7 +2,6 @@ import React, { useContext } from 'react';
2
2
  // The upper alias react-router-dom$ into this file avoids the loop
3
3
  // @ts-ignore
4
4
  import * as ReactRouterDom from 'react-router-dom/index.js';
5
-
6
5
  import { RouterContext } from './context';
7
6
  import { LoggerInstance } from './utils';
8
7
 
package/src/router-v6.tsx CHANGED
@@ -60,7 +60,7 @@ function WraperRouterProvider(
60
60
  return <RouterProvider router={MemeoryRouterInstance} />;
61
61
  } else {
62
62
  const BrowserRouterInstance = createBrowserRouter(routers, {
63
- basename: routerContextProps.basename,
63
+ basename: routerContextProps.basename || router?.basename,
64
64
  future: router.future,
65
65
  window: router.window,
66
66
  });
package/src/router.tsx CHANGED
@@ -59,7 +59,7 @@ function WrapperRouterProvider(
59
59
  return <RouterProvider router={MemeoryRouterInstance} />;
60
60
  } else {
61
61
  const BrowserRouterInstance = createBrowserRouter(routers, {
62
- basename: routerContextProps.basename,
62
+ basename: routerContextProps.basename || router?.basename,
63
63
  future: router.future,
64
64
  window: router.window,
65
65
  });