@squide/msw 2.0.13 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,73 @@
 # @squide/msw
 
+## 3.0.0
+
+### Major Changes
+
+- [#182](https://github.com/gsoft-inc/wl-squide/pull/182) [`58cf066`](https://github.com/gsoft-inc/wl-squide/commit/58cf066e87e23611510c254cca96016bd2bad08a) Thanks [@patricklafrance](https://github.com/patricklafrance)! - ## Firefly v9
+
+  This major version of @squide/firefly introduces TanStack Query as the official library for fetching the global data of a Squide's application and features a complete rewrite of the AppRouter component, which now uses a state machine to manage the application's bootstrapping flow.
+
+  Prior to v9, Squide applications couldn't use TanStack Query to fetch global data, making it challenging for Workleap's applications to keep their global data in sync with the server state. With v9, applications can now leverage custom wrappers of the useQueries hook to fetch and keep their global data up-to-date with the server state. Additionally, the new deferred registrations update feature allows applications to even keep their conditional navigation items in sync with the server state.
+
+  Finally, with v9, Squide's philosophy has evolved. We used to describe Squide as a shell for federated applications. Now, we refer to Squide as a shell for modular applications. After playing with Squide's local module feature for a while, we discovered that Squide offers significant value even for non-federated applications, which triggered this shift in philosophy.
+
+  > For a full breakdown of the changres and a migration procedure, read the following [documentation](https://gsoft-inc.github.io/wl-squide/guides/migrate-to-firefly-v9/).
+
+  ## Breaking changes
+
+  - The `useAreModulesRegistered` hook has been removed, use the `useIsBootstrapping` hook instead.
+  - The `useAreModulesReady` hook has been removed, use the `useIsBootstrapping` hook instead.
+  - The `useIsMswStarted` hook has been removed, use the `useIsBootstrapping` hook instead.
+  - The `completeModuleRegistrations` function as been removed use the `useDeferredRegistrations` hook instead.
+  - The `completeLocalModulesRegistrations` function has been removed use the `useDeferredRegistrations` hook instead.
+  - The `completeRemoteModuleRegistrations` function has been removed use the `useDeferredRegistrations` hook instead.
+  - The `useSession` hook has been removed, define your own React context instead.
+  - The `useIsAuthenticated` hook has been removed, define your own React context instead.
+  - The `sessionAccessor` option has been removed from the `FireflyRuntime` options, define your own React context instead.
+  - Removed supports for deferred routes.
+  - Plugin's constructor now requires a runtime instance argument.
+  - Plugins now registers with a factory function.
+  - Full rewrite of the `AppRouter` component.
+
+  ## Renamed
+
+  - The `setMswAsStarted` function has been renamed to `setMswIsReady`.
+
+  ## Others
+
+  - The `@squide/firefly` package now takes a peerDependency on `@tanstack/react-query`.
+  - The `@squide/firefly` package doesn't takes a peerDependency on `react-error-boundary` anymore.
+
+  ## New hooks and functions
+
+  - A new `useIsBoostrapping` hook is now available.
+  - A new `useDeferredRegistrations` hook is now available.
+  - A new `usePublicDataQueries` hook is now available.
+  - A new `useProtectedDataQueries` hook is now available.
+  - A new `isGlobalDataQueriesError` function is now available.
+
+  ## Improvements
+
+  - Deferred registration functions now always receive a `data` argument.
+  - Deferred registration functions now receives a new `operation` argument.
+  - Navigation items now include a `$canRender` option, enabling modules to control whether a navigation item should be rendered.
+  - New `$key` option for navigation items.
+
+  For more details about the changes and a migration procedure, read the following [documentation](https://gsoft-inc.github.io/wl-squide/guides/migrate-to-firefly-v9/).
+
+### Patch Changes
+
+- Updated dependencies [[`58cf066`](https://github.com/gsoft-inc/wl-squide/commit/58cf066e87e23611510c254cca96016bd2bad08a)]:
+  - @squide/core@5.0.0
+
+## 2.0.14
+
+### Patch Changes
+
+- Updated dependencies [[`89ace29`](https://github.com/gsoft-inc/wl-squide/commit/89ace29b9aeadbbe83cfa71dd137b9f1a115c283)]:
+  - @squide/core@4.0.0
+
 ## 2.0.13
 
 ### Patch Changes

package/dist/chunk-2FX5W4F5.js

@@ -0,0 +1,46 @@
+// src/mswState.ts
+var MswState = class {
+  #isReady = false;
+  #stateChangedListeners = /* @__PURE__ */ new Set();
+  addStateChangedListener(callback) {
+    this.#stateChangedListeners.add(callback);
+  }
+  removeStateChangedListener(callback) {
+    this.#stateChangedListeners.delete(callback);
+  }
+  setAsReady() {
+    if (!this.#isReady) {
+      this.#isReady = true;
+      this.#stateChangedListeners.forEach((x) => {
+        x();
+      });
+    }
+  }
+  get isReady() {
+    return this.#isReady;
+  }
+};
+var mswState;
+function getMswState() {
+  if (!mswState) {
+    mswState = new MswState();
+  }
+  return mswState;
+}
+function __setMswState(state) {
+  mswState = state;
+}
+function setMswAsReady() {
+  getMswState().setAsReady();
+}
+function isMswReady() {
+  return getMswState().isReady;
+}
+function addMswStateChangedListener(callback) {
+  getMswState().addStateChangedListener(callback);
+}
+function removeMswStateChangedListener(callback) {
+  getMswState().removeStateChangedListener(callback);
+}
+
+export { MswState, __setMswState, addMswStateChangedListener, isMswReady, removeMswStateChangedListener, setMswAsReady };

package/dist/{chunk-UJ4YM7IF.js → chunk-AMKPYN4M.js}

@@ -1,10 +1,10 @@
-import { isMswStarted } from './chunk-4FYK3XXP.js';
+import { isMswReady } from './chunk-2FX5W4F5.js';
 
 // src/requestHandlerRegistry.ts
 var RequestHandlerRegistry = class {
   #handlers = [];
   add(handlers) {
-    if (isMswStarted()) {
+    if (isMswReady()) {
       throw new Error("[squide] MSW request handlers cannot be registered once MSW is started. Did you defer the registration of a MSW request handler?");
     }
     this.#handlers.push(...handlers);

package/dist/{chunk-BH5GURQ4.js → chunk-W5GMS2JV.js}

@@ -1,18 +1,14 @@
-import { RequestHandlerRegistry } from './chunk-UJ4YM7IF.js';
+import { RequestHandlerRegistry } from './chunk-AMKPYN4M.js';
 import { Plugin, isNil } from '@squide/core';
 
 var MswPlugin = class _MswPlugin extends Plugin {
-  #runtime;
   #requestHandlerRegistry = new RequestHandlerRegistry();
-  constructor() {
-    super(_MswPlugin.name);
-  }
-  _setRuntime(runtime) {
-    this.#runtime = runtime;
+  constructor(runtime) {
+    super(_MswPlugin.name, runtime);
   }
   registerRequestHandlers(handlers) {
     this.#requestHandlerRegistry.add(handlers);
-    this.#runtime?.logger.debug("[squide] The following MSW request handlers has been registered: ", handlers);
+    this._runtime.logger.debug("[squide] The following MSW request handlers has been registered: ", handlers);
   }
   get requestHandlers() {
     return this.#requestHandlerRegistry.handlers;

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 export { MswPlugin, getMswPlugin } from './mswPlugin.js';
-export { MswState, MswStateChangedListener, __resetMswStatus, addMswStateChangedListener, isMswStarted, removeMswStateChangedListener, setMswAsStarted } from './mswState.js';
+export { MswState, MswStateChangedListener, __setMswState, addMswStateChangedListener, isMswReady, removeMswStateChangedListener, setMswAsReady } from './mswState.js';
 export { RequestHandlerRegistry } from './requestHandlerRegistry.js';
-export { useIsMswStarted } from './useIsMswStarted.js';
 import '@squide/core';
 import 'msw';

package/dist/index.js

@@ -1,4 +1,3 @@
-export { MswPlugin, getMswPlugin } from './chunk-BH5GURQ4.js';
-export { RequestHandlerRegistry } from './chunk-UJ4YM7IF.js';
-export { useIsMswStarted } from './chunk-67NM4MII.js';
-export { MswState, __resetMswStatus, addMswStateChangedListener, isMswStarted, removeMswStateChangedListener, setMswAsStarted } from './chunk-4FYK3XXP.js';
+export { MswPlugin, getMswPlugin } from './chunk-W5GMS2JV.js';
+export { RequestHandlerRegistry } from './chunk-AMKPYN4M.js';
+export { MswState, __setMswState, addMswStateChangedListener, isMswReady, removeMswStateChangedListener, setMswAsReady } from './chunk-2FX5W4F5.js';

package/dist/mswPlugin.d.ts

@@ -3,8 +3,7 @@ import { RequestHandler } from 'msw';
 
 declare class MswPlugin extends Plugin {
     #private;
-    constructor();
-    _setRuntime(runtime: Runtime): void;
+    constructor(runtime: Runtime);
     registerRequestHandlers(handlers: RequestHandler[]): void;
     get requestHandlers(): RequestHandler[];
 }

package/dist/mswPlugin.js

@@ -1,3 +1,3 @@
-export { MswPlugin, getMswPlugin } from './chunk-BH5GURQ4.js';
-import './chunk-UJ4YM7IF.js';
-import './chunk-4FYK3XXP.js';
+export { MswPlugin, getMswPlugin } from './chunk-W5GMS2JV.js';
+import './chunk-AMKPYN4M.js';
+import './chunk-2FX5W4F5.js';

package/dist/mswState.d.ts

@@ -3,14 +3,13 @@ declare class MswState {
     #private;
     addStateChangedListener(callback: MswStateChangedListener): void;
     removeStateChangedListener(callback: MswStateChangedListener): void;
-    setAsStarted(): void;
-    get isStarted(): boolean;
-    _reset(): void;
+    setAsReady(): void;
+    get isReady(): boolean;
 }
-declare function setMswAsStarted(): void;
-declare function isMswStarted(): boolean;
+declare function __setMswState(state: MswState): void;
+declare function setMswAsReady(): void;
+declare function isMswReady(): boolean;
 declare function addMswStateChangedListener(callback: MswStateChangedListener): void;
 declare function removeMswStateChangedListener(callback: MswStateChangedListener): void;
-declare function __resetMswStatus(): void;
 
-export { MswState, type MswStateChangedListener, __resetMswStatus, addMswStateChangedListener, isMswStarted, removeMswStateChangedListener, setMswAsStarted };
+export { MswState, type MswStateChangedListener, __setMswState, addMswStateChangedListener, isMswReady, removeMswStateChangedListener, setMswAsReady };

package/dist/mswState.js

@@ -1 +1 @@
-export { MswState, __resetMswStatus, addMswStateChangedListener, isMswStarted, removeMswStateChangedListener, setMswAsStarted } from './chunk-4FYK3XXP.js';
+export { MswState, __setMswState, addMswStateChangedListener, isMswReady, removeMswStateChangedListener, setMswAsReady } from './chunk-2FX5W4F5.js';

package/dist/requestHandlerRegistry.js

@@ -1,2 +1,2 @@
-export { RequestHandlerRegistry } from './chunk-UJ4YM7IF.js';
-import './chunk-4FYK3XXP.js';
+export { RequestHandlerRegistry } from './chunk-AMKPYN4M.js';
+import './chunk-2FX5W4F5.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@squide/msw",
   "author": "Workleap",
-  "version": "2.0.13",
+  "version": "3.0.0",
   "description": "Add support for MSW to @squide federated application shell.",
   "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"
     }
   },
@@ -37,23 +37,24 @@
     }
   },
   "devDependencies": {
-    "@types/react": "18.2.61",
-    "@types/react-dom": "18.2.19",
-    "@workleap/eslint-plugin": "3.0.2",
-    "@workleap/tsup-configs": "3.0.4",
+    "@types/react": "18.3.3",
+    "@types/react-dom": "18.3.0",
+    "@workleap/eslint-plugin": "3.2.2",
+    "@workleap/tsup-configs": "3.0.6",
     "@workleap/typescript-configs": "3.0.2",
-    "msw": "2.2.2",
-    "react": "18.2.0",
-    "react-dom": "18.2.0",
-    "tsup": "8.0.2",
-    "typescript": "5.3.3"
+    "eslint": "8.57.0",
+    "msw": "2.3.1",
+    "react": "18.3.1",
+    "react-dom": "18.3.1",
+    "tsup": "8.1.2",
+    "typescript": "5.5.3"
   },
   "dependencies": {
-    "@squide/core": "3.4.0"
+    "@squide/core": "5.0.0"
   },
   "sideEffects": false,
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=20.0.0"
   },
   "scripts": {
     "dev": "tsup --config ./tsup.dev.ts",

package/dist/chunk-4FYK3XXP.js

@@ -1,44 +0,0 @@
-// src/mswState.ts
-var MswState = class {
-  #isStarted = false;
-  #stateChangedListeners = /* @__PURE__ */ new Set();
-  addStateChangedListener(callback) {
-    this.#stateChangedListeners.add(callback);
-  }
-  removeStateChangedListener(callback) {
-    this.#stateChangedListeners.delete(callback);
-  }
-  setAsStarted() {
-    if (!this.#isStarted) {
-      this.#isStarted = true;
-      this.#stateChangedListeners.forEach((x) => {
-        x();
-      });
-    }
-  }
-  get isStarted() {
-    return this.#isStarted;
-  }
-  // Strictly for Jest tests, this is NOT ideal.
-  _reset() {
-    this.#isStarted = false;
-  }
-};
-var mswState = new MswState();
-function setMswAsStarted() {
-  mswState.setAsStarted();
-}
-function isMswStarted() {
-  return mswState.isStarted;
-}
-function addMswStateChangedListener(callback) {
-  mswState.addStateChangedListener(callback);
-}
-function removeMswStateChangedListener(callback) {
-  mswState.removeStateChangedListener(callback);
-}
-function __resetMswStatus() {
-  mswState._reset();
-}
-
-export { MswState, __resetMswStatus, addMswStateChangedListener, isMswStarted, removeMswStateChangedListener, setMswAsStarted };

package/dist/chunk-67NM4MII.js

@@ -1,20 +0,0 @@
-import { isMswStarted, addMswStateChangedListener, removeMswStateChangedListener } from './chunk-4FYK3XXP.js';
-import { useLogOnceLogger } from '@squide/core';
-import { useSyncExternalStore, useEffect } from 'react';
-
-function subscribe(callback) {
-  addMswStateChangedListener(callback);
-  return () => removeMswStateChangedListener(callback);
-}
-function useIsMswStarted(enabled) {
-  const isStarted = useSyncExternalStore(subscribe, isMswStarted);
-  const logger = useLogOnceLogger();
-  useEffect(() => {
-    if (isStarted) {
-      logger.debugOnce("msw-is-started", "[squide] %cMSW is ready%c.", "color: white; background-color: green;", "");
-    }
-  }, [isStarted, logger]);
-  return isStarted || !enabled;
-}
-
-export { useIsMswStarted };

package/dist/useIsMswStarted.d.ts

@@ -1,3 +0,0 @@
-declare function useIsMswStarted(enabled: boolean): boolean;
-
-export { useIsMswStarted };

package/dist/useIsMswStarted.js

@@ -1,2 +0,0 @@
-export { useIsMswStarted } from './chunk-67NM4MII.js';
-import './chunk-4FYK3XXP.js';