@squide/firefly 1.0.0 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @squide/firefly
 
+## 2.0.0
+
+### Minor Changes
+
+- [#112](https://github.com/gsoft-inc/wl-squide/pull/112) [`a9dda1c`](https://github.com/gsoft-inc/wl-squide/commit/a9dda1c3b010f616556fc3313c1934e20a26bc11) Thanks [@patricklafrance](https://github.com/patricklafrance)! - - Added a new `FireflyRuntime` class. This class should be used by all consumer applications rather than the previous `Runtime` class from `@squide/react-router`.
+  - The `FireflyRuntime` class has a `registerRequestHandlers` function and a `requestHandlers` getter. Consumer applications should use these instead of the `MSwPlugin`.
+  - Added a new layer of define functions (`defineDevHostConfig`, `defineBuildHostConfig`, `defineDevRemoteModuleConfig`, `defineBuildRemoteModuleConfig`). These functions should be used by all consumer applications rather than the previous define functions from `@squide/wbepack-module-federation`.
+  - Forward every exports from `@squide/core`, `@squide/react-router`, `@squide/webpack-module-federation`, `@squide/webpack-configs` and `@squide/msw`. Consumer applications should now import everything from `@squide/firefly` except the fakes implementations that should still be imported from `@squide/fakes`.
+
+### Patch Changes
+
+- Updated dependencies [[`a9dda1c`](https://github.com/gsoft-inc/wl-squide/commit/a9dda1c3b010f616556fc3313c1934e20a26bc11), [`a9dda1c`](https://github.com/gsoft-inc/wl-squide/commit/a9dda1c3b010f616556fc3313c1934e20a26bc11), [`a9dda1c`](https://github.com/gsoft-inc/wl-squide/commit/a9dda1c3b010f616556fc3313c1934e20a26bc11), [`a9dda1c`](https://github.com/gsoft-inc/wl-squide/commit/a9dda1c3b010f616556fc3313c1934e20a26bc11)]:
+  - @squide/webpack-configs@1.0.0
+  - @squide/webpack-module-federation@3.0.0
+  - @squide/core@3.0.0
+  - @squide/react-router@3.0.0
+  - @squide/msw@2.0.4
+
+## 1.0.1
+
+### Patch Changes
+
+- Updated dependencies [[`58097a2`](https://github.com/gsoft-inc/wl-squide/commit/58097a2fbaa7e5942cbe6f9b765fe471d52758d8)]:
+  - @squide/msw@2.0.3
+
 ## 1.0.0
 
 ### Major Changes

package/dist/AppRouter.d.ts

@@ -2,14 +2,14 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactElement } from 'react';
 import { RouterProviderProps } from 'react-router-dom';
 
-type OnLoadPublicDataFunction = (signal: AbortSignal) => Promise<unknown>;
-type OnLoadProtectedDataFunction = (signal: AbortSignal) => Promise<unknown>;
-type OnCompleteRegistrationFunction = () => Promise<unknown>;
+type OnLoadPublicDataFunction = () => Promise<unknown>;
+type OnLoadProtectedDataFunction = () => Promise<unknown>;
+type OnCompleteRegistrationsFunction = () => Promise<unknown>;
 interface BootstrappingRouteProps {
     fallbackElement: ReactElement;
     onLoadPublicData?: OnLoadPublicDataFunction;
     onLoadProtectedData?: OnLoadProtectedDataFunction;
-    onCompleteRegistration?: OnCompleteRegistrationFunction;
+    onCompleteRegistrations?: OnCompleteRegistrationsFunction;
     waitForMsw: boolean;
     areModulesRegistered: boolean;
     areModulesReady: boolean;
@@ -20,10 +20,10 @@ interface AppRouterProps {
     errorElement: ReactElement;
     onLoadPublicData?: OnLoadPublicDataFunction;
     onLoadProtectedData?: OnLoadProtectedDataFunction;
-    onCompleteRegistration?: OnCompleteRegistrationFunction;
+    onCompleteRegistrations?: OnCompleteRegistrationsFunction;
     waitForMsw: boolean;
     routerProvidersProps?: RouterProviderProps;
 }
 declare function AppRouter(props: AppRouterProps): react_jsx_runtime.JSX.Element;
 
-export { AppRouter, AppRouterProps, BootstrappingRoute, OnCompleteRegistrationFunction, OnLoadProtectedDataFunction, OnLoadPublicDataFunction };
+export { AppRouter, AppRouterProps, BootstrappingRoute, OnCompleteRegistrationsFunction, OnLoadProtectedDataFunction, OnLoadPublicDataFunction };

package/dist/AppRouter.js

@@ -1 +1 @@
-export { AppRouter, BootstrappingRoute } from './chunk-4UQRHMJC.js';
+export { AppRouter, BootstrappingRoute } from './chunk-GSHD4LQA.js';

package/dist/chunk-6R4K3V6F.js

@@ -0,0 +1,26 @@
+import { MswPlugin } from '@squide/msw';
+import { ReactRouterRuntime } from '@squide/react-router';
+
+// src/fireflyRuntime.tsx
+var FireflyRuntime = class extends ReactRouterRuntime {
+  #mswPlugin;
+  constructor(options = {}) {
+    const mswPlugin = new MswPlugin();
+    super({
+      ...options,
+      plugins: [
+        ...options.plugins ?? [],
+        mswPlugin
+      ]
+    });
+    this.#mswPlugin = mswPlugin;
+  }
+  registerRequestHandlers(handlers) {
+    this.#mswPlugin.registerRequestHandlers(handlers);
+  }
+  get requestHandlers() {
+    return this.#mswPlugin.requestHandlers;
+  }
+};
+
+export { FireflyRuntime };

package/dist/{chunk-4UQRHMJC.js → chunk-GSHD4LQA.js}

@@ -1,5 +1,6 @@
+import { useLogger } from '@squide/core';
 import { useIsMswStarted } from '@squide/msw';
-import { useLogger, useIsRouteMatchProtected, useRoutes } from '@squide/react-router';
+import { useIsRouteMatchProtected, useRoutes } from '@squide/react-router';
 import { useAreModulesRegistered, useAreModulesReady } from '@squide/webpack-module-federation';
 import { useState, useEffect, useCallback, cloneElement, useMemo } from 'react';
 import { useErrorBoundary, ErrorBoundary } from 'react-error-boundary';
@@ -12,7 +13,7 @@ function BootstrappingRoute(props) {
     fallbackElement,
     onLoadPublicData,
     onLoadProtectedData,
-    onCompleteRegistration,
+    onCompleteRegistrations,
     waitForMsw,
     areModulesRegistered,
     areModulesReady
@@ -37,37 +38,29 @@ function BootstrappingRoute(props) {
       if ((areModulesRegistered || areModulesReady) && isMswStarted) {
         if (!isPublicDataLoaded) {
           logger.debug("[shell] Loading public data.");
-          const abordController = new AbortController();
-          onLoadPublicData(abordController.signal).then(() => {
+          onLoadPublicData().then(() => {
             setIsPublicDataLoaded(true);
             logger.debug("[shell] Public data has been loaded.");
           }).catch((error) => {
             showBoundary(error);
           });
-          return () => {
-            abordController.abort();
-          };
         }
       }
     }
   }, [logger, areModulesRegistered, areModulesReady, isMswStarted, isPublicDataLoaded, onLoadPublicData]);
-  const isActiveRouteProtected = useIsRouteMatchProtected(location);
+  const isActiveRouteProtected = useIsRouteMatchProtected(location, { throwWhenThereIsNoMatch: areModulesReady });
   useEffect(() => {
     if (onLoadProtectedData) {
       if ((areModulesRegistered || areModulesReady) && isMswStarted) {
         if (isActiveRouteProtected) {
           if (!isProtectedDataLoaded) {
             logger.debug(`[shell] Loading protected data as "${location.pathname}" is a protected route.`);
-            const abordController = new AbortController();
-            onLoadProtectedData(abordController.signal).then(() => {
+            onLoadProtectedData().then(() => {
               setIsProtectedDataLoaded(true);
               logger.debug("[shell] Protected data has been loaded.");
             }).catch((error) => {
               showBoundary(error);
             });
-            return () => {
-              abordController.abort();
-            };
           }
         } else {
           logger.debug(`[shell] Not loading protected data as "${location.pathname}" is a public route.`);
@@ -76,14 +69,14 @@ function BootstrappingRoute(props) {
     }
   }, [logger, location, areModulesRegistered, areModulesReady, isMswStarted, isActiveRouteProtected, isProtectedDataLoaded, onLoadProtectedData]);
   useEffect(() => {
-    if (onCompleteRegistration) {
+    if (onCompleteRegistrations) {
       if (areModulesRegistered && isMswStarted && isPublicDataLoaded) {
         if (!areModulesReady) {
-          onCompleteRegistration();
+          onCompleteRegistrations();
         }
       }
     }
-  }, [areModulesRegistered, areModulesReady, isMswStarted, isPublicDataLoaded, onCompleteRegistration]);
+  }, [areModulesRegistered, areModulesReady, isMswStarted, isPublicDataLoaded, onCompleteRegistrations]);
   if (!areModulesReady || !isMswStarted || !isPublicDataLoaded || isActiveRouteProtected && !isProtectedDataLoaded) {
     return fallbackElement;
   }
@@ -95,7 +88,7 @@ function AppRouter(props) {
     errorElement,
     onLoadPublicData,
     onLoadProtectedData,
-    onCompleteRegistration,
+    onCompleteRegistrations,
     waitForMsw,
     routerProvidersProps = {}
   } = props;
@@ -116,7 +109,7 @@ function AppRouter(props) {
             fallbackElement,
             onLoadPublicData,
             onLoadProtectedData,
-            onCompleteRegistration,
+            onCompleteRegistrations,
             waitForMsw,
             areModulesRegistered,
             areModulesReady
@@ -125,7 +118,7 @@ function AppRouter(props) {
         children: routes
       }
     ]);
-  }, [areModulesRegistered, areModulesReady, routes, onLoadPublicData, onLoadProtectedData, onCompleteRegistration, waitForMsw]);
+  }, [areModulesRegistered, areModulesReady, routes, onLoadPublicData, onLoadProtectedData, onCompleteRegistrations, waitForMsw]);
   return /* @__PURE__ */ jsx(RouterProvider, { ...routerProvidersProps, router });
 }
 

package/dist/defineConfig.d.ts

@@ -0,0 +1,11 @@
+import { DefineDevHostConfigOptions, DefineBuildHostConfigOptions, DefineDevRemoteModuleConfigOptions, DefineBuildRemoteModuleConfigOptions } from '@squide/webpack-configs';
+export { DefineBuildHostConfigOptions, DefineBuildRemoteModuleConfigOptions, DefineDevHostConfigOptions, DefineDevRemoteModuleConfigOptions, DefineHostModuleFederationPluginOptions, DefineRemoteModuleFederationPluginOptions, Features, ModuleFederationPluginOptions, Router, defineRemoteModuleFederationPluginOptions } from '@squide/webpack-configs';
+import { SwcConfig } from '@workleap/swc-configs';
+import webpack from 'webpack';
+
+declare function defineDevHostConfig(swcConfig: SwcConfig, applicationName: string, port: number, options?: Omit<DefineDevHostConfigOptions, "features">): webpack.Configuration;
+declare function defineBuildHostConfig(swcConfig: SwcConfig, applicationName: string, options?: Omit<DefineBuildHostConfigOptions, "features">): webpack.Configuration;
+declare function defineDevRemoteModuleConfig(swcConfig: SwcConfig, applicationName: string, port: number, options?: Omit<DefineDevRemoteModuleConfigOptions, "features">): webpack.Configuration;
+declare function defineBuildRemoteModuleConfig(swcConfig: SwcConfig, applicationName: string, options?: Omit<DefineBuildRemoteModuleConfigOptions, "features">): webpack.Configuration;
+
+export { defineBuildHostConfig, defineBuildRemoteModuleConfig, defineDevHostConfig, defineDevRemoteModuleConfig };

package/dist/defineConfig.js

@@ -0,0 +1,42 @@
+import { defineDevHostConfig as defineDevHostConfig$1, defineBuildHostConfig as defineBuildHostConfig$1, defineDevRemoteModuleConfig as defineDevRemoteModuleConfig$1, defineBuildRemoteModuleConfig as defineBuildRemoteModuleConfig$1 } from '@squide/webpack-configs';
+export { defineRemoteModuleFederationPluginOptions } from '@squide/webpack-configs';
+
+// src/defineConfig.ts
+function defineDevHostConfig(swcConfig, applicationName, port, options = {}) {
+  return defineDevHostConfig$1(swcConfig, applicationName, port, {
+    ...options,
+    features: {
+      router: "react-router",
+      msw: true
+    }
+  });
+}
+function defineBuildHostConfig(swcConfig, applicationName, options = {}) {
+  return defineBuildHostConfig$1(swcConfig, applicationName, {
+    ...options,
+    features: {
+      router: "react-router",
+      msw: true
+    }
+  });
+}
+function defineDevRemoteModuleConfig(swcConfig, applicationName, port, options = {}) {
+  return defineDevRemoteModuleConfig$1(swcConfig, applicationName, port, {
+    ...options,
+    features: {
+      router: "react-router",
+      msw: true
+    }
+  });
+}
+function defineBuildRemoteModuleConfig(swcConfig, applicationName, options = {}) {
+  return defineBuildRemoteModuleConfig$1(swcConfig, applicationName, {
+    ...options,
+    features: {
+      router: "react-router",
+      msw: true
+    }
+  });
+}
+
+export { defineBuildHostConfig, defineBuildRemoteModuleConfig, defineDevHostConfig, defineDevRemoteModuleConfig };

package/dist/fireflyRuntime.d.ts

@@ -0,0 +1,12 @@
+import { RuntimeOptions } from '@squide/core';
+import { ReactRouterRuntime } from '@squide/react-router';
+import { RequestHandler } from 'msw';
+
+declare class FireflyRuntime extends ReactRouterRuntime {
+    #private;
+    constructor(options?: RuntimeOptions);
+    registerRequestHandlers(handlers: RequestHandler[]): void;
+    get requestHandlers(): RequestHandler[];
+}
+
+export { FireflyRuntime };

package/dist/fireflyRuntime.js

@@ -0,0 +1 @@
+export { FireflyRuntime } from './chunk-6R4K3V6F.js';

package/dist/index.d.ts

@@ -1,4 +1,10 @@
-export { AppRouter, AppRouterProps, BootstrappingRoute, OnCompleteRegistrationFunction, OnLoadProtectedDataFunction, OnLoadPublicDataFunction } from './AppRouter.js';
+export * from '@squide/core';
+export * from '@squide/msw';
+export * from '@squide/react-router';
+export * from '@squide/webpack-module-federation';
+export { AppRouter, AppRouterProps, BootstrappingRoute, OnCompleteRegistrationsFunction, OnLoadProtectedDataFunction, OnLoadPublicDataFunction } from './AppRouter.js';
+export { FireflyRuntime } from './fireflyRuntime.js';
 import 'react/jsx-runtime';
 import 'react';
 import 'react-router-dom';
+import 'msw';

package/dist/index.js

@@ -1 +1,6 @@
-export { AppRouter, BootstrappingRoute } from './chunk-4UQRHMJC.js';
+export { AppRouter, BootstrappingRoute } from './chunk-GSHD4LQA.js';
+export { FireflyRuntime } from './chunk-6R4K3V6F.js';
+export * from '@squide/core';
+export * from '@squide/msw';
+export * from '@squide/react-router';
+export * from '@squide/webpack-module-federation';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@squide/firefly",
   "author": "Workleap",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Helpers to facilitate the creation of a shell package with Squide firefly technology stack.",
   "license": "Apache-2.0",
   "repository": {
@@ -19,6 +19,11 @@
       "import": "./dist/index.js",
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
+    },
+    "./defineConfig.js": {
+      "import": "./dist/defineConfig.js",
+      "types": "./dist/defineConfig.d.ts",
+      "default": "./dist/defineConfig.js"
     }
   },
   "files": [
@@ -27,44 +32,57 @@
     "README.md"
   ],
   "peerDependencies": {
+    "@squide/webpack-configs": "*",
     "msw": "*",
     "react": "*",
     "react-dom": "*",
     "react-error-boundary": "*",
-    "react-router-dom": "*"
+    "react-router-dom": "*",
+    "webpack": ">=5.0.0"
   },
   "peerDependenciesMeta": {
+    "@squide/webpack-configs": {
+      "optional": true
+    },
     "msw": {
       "optional": true
+    },
+    "webpack": {
+      "optional": true
     }
   },
   "devDependencies": {
-    "@swc/core": "1.3.95",
+    "@swc/core": "1.3.96",
     "@swc/helpers": "0.5.3",
     "@swc/jest": "0.2.29",
+    "@testing-library/jest-dom": "6.1.4",
     "@testing-library/react": "14.0.0",
-    "@types/jest": "29.5.6",
-    "@types/react": "18.2.33",
+    "@types/jest": "29.5.7",
+    "@types/react": "18.2.36",
     "@types/react-dom": "18.2.14",
     "@workleap/eslint-plugin": "3.0.0",
     "@workleap/swc-configs": "2.1.2",
     "@workleap/tsup-configs": "3.0.1",
     "@workleap/typescript-configs": "3.0.2",
+    "@workleap/webpack-configs": "1.2.1",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",
-    "msw": "1.3.2",
+    "msw": "2.0.3",
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "react-error-boundary": "4.0.11",
-    "react-router-dom": "6.17.0",
+    "react-router-dom": "6.18.0",
     "ts-jest": "29.1.1",
     "tsup": "7.2.0",
-    "typescript": "5.2.2"
+    "typescript": "5.2.2",
+    "webpack": "5.89.0",
+    "@squide/webpack-configs": "1.0.0"
   },
   "dependencies": {
-    "@squide/msw": "2.0.2",
-    "@squide/react-router": "2.0.2",
-    "@squide/webpack-module-federation": "2.2.0"
+    "@squide/core": "3.0.0",
+    "@squide/msw": "2.0.4",
+    "@squide/react-router": "3.0.0",
+    "@squide/webpack-module-federation": "3.0.0"
   },
   "sideEffects": false,
   "engines": {