@squide/firefly 7.0.0 → 8.0.0

package/CHANGELOG.md

@@ -1,5 +1,126 @@
 # @squide/firefly
 
+## 8.0.0
+
+### Major Changes
+
+- [#168](https://github.com/gsoft-inc/wl-squide/pull/168) [`89ace29`](https://github.com/gsoft-inc/wl-squide/commit/89ace29b9aeadbbe83cfa71dd137b9f1a115c283) Thanks [@patricklafrance](https://github.com/patricklafrance)! - This release Migrates Squide from Webpack Module Federation to [Module Federation 2.0](https://module-federation.io/guide/start/quick-start.html).
+
+  This release deprecates the following packages:
+
+  - `@squide/webpack-module-federation`, use `@squide/module-federation` instead.
+  - `@squide/firefly-configs`, use `@squide/firefly-webpack-configs` instead.
+
+  And introduce a few changes to existing API:
+
+  - The `FireflyRuntime` nows accept a `useMsw` option and expose a new `isMswEnabled` getter:
+
+  ```ts
+  // bootstrap.tsx
+
+  import { FireflyRuntime } from "@squide/firefly";
+
+  const runtime = new FireflyRuntime({
+    useMsw: true,
+  });
+
+  // Use the runtime to determine if MSW handlers should be registered.
+  if (runtime.isMswEnabled) {
+    // ...
+  }
+  ```
+
+  - The `registerRemoteModules` function doesn't accept the remotes URL anymore. The remotes URL should be configured in the webpack configuration files.
+
+  Previously:
+
+  ```ts
+  // bootstrap.tsx
+
+  import {
+    registerRemoteModules,
+    type RemoteDefinition,
+  } from "@squide/firefly";
+
+  const Remotes: RemoteDefinition = [
+    {
+      name: "remote1",
+      url: "http://localhost:8081",
+    },
+  ];
+
+  await registerRemoteModules(Remotes, runtime);
+  ```
+
+  ```js
+  // webpack.dev.js
+
+  import { defineDevHostConfig } from "@squide/firefly-webpack-configs";
+  import { swcConfig } from "./swc.dev.js";
+
+  export default defineDevHostConfig(swcConfig, "host", 8080, {
+    overlay: false,
+  });
+  ```
+
+  Now:
+
+  ```ts
+  // bootstrap.tsx
+
+  import {
+    registerRemoteModules,
+    type RemoteDefinition,
+  } from "@squide/firefly";
+
+  const Remotes: RemoteDefinition = [
+    {
+      name: "remote1",
+    },
+  ];
+
+  await registerRemoteModules(Remotes, runtime);
+  ```
+
+  ```js
+  // webpack.dev.js
+
+  import { defineDevHostConfig } from "@squide/firefly-webpack-configs";
+  import { swcConfig } from "./swc.dev.js";
+
+  /**
+   * @typedef {import("@squide/firefly-webpack-configs").RemoteDefinition}[]
+   */
+  export const Remotes = [
+    {
+      name: "remote1",
+      url: "http://localhost:8081",
+    },
+  ];
+
+  export default defineDevHostConfig(swcConfig, "host", 8080, Remotes, {
+    overlay: false,
+  });
+  ```
+
+  To migrate:
+
+  1. Replace the `@squide/webpack-module-federation` dependency by `@squide/module-federation`.
+
+  2. Replace the `@squide/firefly-configs` dependency by `@squide/firefly-webpack-configs`.
+
+  3. Move the remotes URL from the `bootstrap.tsx` file to the `webpack.*.js` files.
+
+  4. Integrate the new `useMsw` and `isMswEnabled` props.
+
+### Patch Changes
+
+- Updated dependencies [[`89ace29`](https://github.com/gsoft-inc/wl-squide/commit/89ace29b9aeadbbe83cfa71dd137b9f1a115c283)]:
+  - @squide/module-federation@5.0.0
+  - @squide/react-router@5.0.0
+  - @squide/core@4.0.0
+  - @squide/msw@2.0.14
+
 ## 7.0.0
 
 ### Major Changes

package/dist/AppRouter.js

@@ -1 +1 @@
-export { AppRouter, BootstrappingRoute } from './chunk-YPB7BNRJ.js';
+export { AppRouter, BootstrappingRoute } from './chunk-URNAUMUG.js';

package/dist/{chunk-YPB7BNRJ.js → chunk-URNAUMUG.js}

@@ -1,7 +1,7 @@
 import { useLogOnceLogger, isNil } from '@squide/core';
+import { useAreModulesRegistered, useAreModulesReady } from '@squide/module-federation';
 import { useIsMswStarted } from '@squide/msw';
 import { useRouteMatch, useIsRouteProtected, useRoutes, findRouteByPath } from '@squide/react-router';
-import { useAreModulesRegistered, useAreModulesReady } from '@squide/webpack-module-federation';
 import { useEffect, useCallback, cloneElement, useMemo } from 'react';
 import { ErrorBoundary, useErrorBoundary } from 'react-error-boundary';
 import { useLocation, Outlet } from 'react-router-dom';

package/dist/chunk-YXMNS6U3.js

@@ -0,0 +1,45 @@
+import { MswPlugin } from '@squide/msw';
+import { ReactRouterRuntime } from '@squide/react-router';
+
+// src/fireflyRuntime.tsx
+var FireflyRuntime = class extends ReactRouterRuntime {
+  #mswPlugin;
+  #useMsw;
+  constructor({ plugins, useMsw, ...options } = {}) {
+    if (useMsw) {
+      const mswPlugin = new MswPlugin();
+      super({
+        plugins: [
+          ...plugins ?? [],
+          mswPlugin
+        ],
+        ...options
+      });
+      this.#mswPlugin = mswPlugin;
+      this.#useMsw = true;
+    } else {
+      super({
+        plugins,
+        ...options
+      });
+      this.#useMsw = false;
+    }
+  }
+  registerRequestHandlers(handlers) {
+    if (!this.#mswPlugin) {
+      throw new Error(`[squide] Cannot register the provided MSW request handlers because the runtime hasn't been initialized with MSW. Did you instanciate the FireflyRuntime with the "useMsw" option?`);
+    }
+    this.#mswPlugin.registerRequestHandlers(handlers);
+  }
+  get requestHandlers() {
+    if (!this.#mswPlugin) {
+      throw new Error(`[squide] Cannot retrieve MSW request handlers because the runtime hasn't been initialized with MSW. Did you instanciate the FireflyRuntime with the "useMsw" option?`);
+    }
+    return this.#mswPlugin.requestHandlers;
+  }
+  get isMswEnabled() {
+    return this.#useMsw;
+  }
+};
+
+export { FireflyRuntime };

package/dist/fireflyRuntime.d.ts

@@ -2,12 +2,15 @@ import { RuntimeOptions } from '@squide/core';
 import { ReactRouterRuntime } from '@squide/react-router';
 import { RequestHandler } from 'msw';
 
-type FireflyRuntimeOptions = RuntimeOptions;
+interface FireflyRuntimeOptions extends RuntimeOptions {
+    useMsw?: boolean;
+}
 declare class FireflyRuntime extends ReactRouterRuntime {
     #private;
-    constructor({ plugins, ...options }?: FireflyRuntimeOptions);
+    constructor({ plugins, useMsw, ...options }?: FireflyRuntimeOptions);
     registerRequestHandlers(handlers: RequestHandler[]): void;
     get requestHandlers(): RequestHandler[];
+    get isMswEnabled(): boolean;
 }
 
 export { FireflyRuntime, type FireflyRuntimeOptions };

package/dist/fireflyRuntime.js

@@ -1 +1 @@
-export { FireflyRuntime } from './chunk-JRNDLQBI.js';
+export { FireflyRuntime } from './chunk-YXMNS6U3.js';

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export * from '@squide/core';
+export * from '@squide/module-federation';
 export * from '@squide/msw';
 export * from '@squide/react-router';
-export * from '@squide/webpack-module-federation';
 export { AppRouter, AppRouterProps, BootstrappingRoute, OnCompleteRegistrationsFunction, OnLoadProtectedDataFunction, OnLoadPublicDataFunction, RenderRouterProviderFunction } from './AppRouter.js';
 export { FireflyRuntime, FireflyRuntimeOptions } from './fireflyRuntime.js';
 import 'react';

package/dist/index.js

@@ -1,6 +1,6 @@
-export { AppRouter, BootstrappingRoute } from './chunk-YPB7BNRJ.js';
-export { FireflyRuntime } from './chunk-JRNDLQBI.js';
+export { AppRouter, BootstrappingRoute } from './chunk-URNAUMUG.js';
+export { FireflyRuntime } from './chunk-YXMNS6U3.js';
 export * from '@squide/core';
+export * from '@squide/module-federation';
 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": "7.0.0",
+  "version": "8.0.0",
   "description": "Helpers to facilitate the creation of a shell package with Squide firefly technology stack.",
   "license": "Apache-2.0",
   "repository": {
@@ -16,8 +16,8 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": "./dist/index.js",
       "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
       "default": "./dist/index.js"
     }
   },
@@ -34,33 +34,34 @@
     "react-router-dom": "*"
   },
   "devDependencies": {
-    "@swc/core": "1.4.7",
+    "@swc/core": "1.4.17",
     "@swc/jest": "0.2.36",
     "@testing-library/jest-dom": "6.4.2",
-    "@testing-library/react": "14.2.1",
+    "@testing-library/react": "15.0.5",
     "@types/jest": "29.5.12",
-    "@types/react": "18.2.65",
-    "@types/react-dom": "18.2.22",
-    "@workleap/eslint-plugin": "3.1.0",
+    "@types/react": "18.3.1",
+    "@types/react-dom": "18.3.0",
+    "@workleap/eslint-plugin": "3.2.2",
     "@workleap/swc-configs": "2.2.3",
-    "@workleap/tsup-configs": "3.0.4",
+    "@workleap/tsup-configs": "3.0.6",
     "@workleap/typescript-configs": "3.0.2",
+    "eslint": "8.57.0",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",
-    "msw": "2.2.3",
-    "react": "18.2.0",
-    "react-dom": "18.2.0",
+    "msw": "2.2.14",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
     "react-error-boundary": "4.0.13",
-    "react-router-dom": "6.22.3",
+    "react-router-dom": "6.23.0",
     "ts-jest": "29.1.2",
     "tsup": "8.0.2",
-    "typescript": "5.4.2"
+    "typescript": "5.4.5"
   },
   "dependencies": {
-    "@squide/core": "3.4.0",
-    "@squide/msw": "2.0.13",
-    "@squide/react-router": "4.1.3",
-    "@squide/webpack-module-federation": "4.0.0"
+    "@squide/core": "4.0.0",
+    "@squide/module-federation": "5.0.0",
+    "@squide/msw": "2.0.14",
+    "@squide/react-router": "5.0.0"
   },
   "sideEffects": false,
   "engines": {

package/dist/chunk-JRNDLQBI.js

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