@squide/firefly 15.0.5 → 16.0.0

package/dist/useUpdateDeferredRegistrations.js

@@ -1,9 +1,6 @@
-import { updateDeferredRegistrations } from "@squide/module-federation";
 import { useCallback } from "react";
 import { useAppRouterDispatcher } from "./AppRouterContext.js";
 
-;// CONCATENATED MODULE: external "@squide/module-federation"
-
 ;// CONCATENATED MODULE: external "react"
 
 ;// CONCATENATED MODULE: external "./AppRouterContext.js"
@@ -11,20 +8,23 @@ import { useAppRouterDispatcher } from "./AppRouterContext.js";
 ;// CONCATENATED MODULE: ./src/useUpdateDeferredRegistrations.ts
 
 
-
+const DeferredRegistrationsUpdateStartedEvent = "squide-deferred-registrations-update-started";
+const DeferredRegistrationsUpdateCompletedEvent = "squide-deferred-registrations-update-completed-started";
 function useUpdateDeferredRegistrations() {
     const dispatch = useAppRouterDispatcher();
     return useCallback(async (data, runtime)=>{
-        const errors = await updateDeferredRegistrations(data, runtime);
+        runtime.eventBus.dispatch(DeferredRegistrationsUpdateStartedEvent);
+        const errors = await runtime.moduleManager.updateDeferredRegistrations(data);
         dispatch({
             type: "deferred-registrations-updated"
         });
+        runtime.eventBus.dispatch(DeferredRegistrationsUpdateCompletedEvent);
         return errors;
     }, [
         dispatch
     ]);
 }
 
-export { useUpdateDeferredRegistrations };
+export { DeferredRegistrationsUpdateCompletedEvent, DeferredRegistrationsUpdateStartedEvent, useUpdateDeferredRegistrations };
 
 //# sourceMappingURL=useUpdateDeferredRegistrations.js.map

package/dist/useUpdateDeferredRegistrations.js.map

@@ -1 +1 @@
-{"version":3,"file":"useUpdateDeferredRegistrations.js","sources":["webpack://@squide/firefly/./src/useUpdateDeferredRegistrations.ts"],"sourcesContent":["import type { Runtime } from \"@squide/core\";\nimport { updateDeferredRegistrations } from \"@squide/module-federation\";\nimport { useCallback } from \"react\";\nimport { useAppRouterDispatcher } from \"./AppRouterContext.ts\";\n\nexport function useUpdateDeferredRegistrations() {\n    const dispatch = useAppRouterDispatcher();\n\n    return useCallback(async <TData = unknown, TRuntime extends Runtime = Runtime>(data: TData, runtime: TRuntime) => {\n        const errors = await updateDeferredRegistrations(data, runtime);\n\n        dispatch({ type: \"deferred-registrations-updated\" });\n\n        return errors;\n    }, [dispatch]);\n}\n"],"names":["updateDeferredRegistrations","useCallback","useAppRouterDispatcher","useUpdateDeferredRegistrations","dispatch","data","runtime","errors"],"mappings":";;;;;;;;;;;AACwE;AACpC;AAC2B;AAExD,SAASG;IACZ,MAAMC,WAAWF,sBAAsBA;IAEvC,OAAOD,WAAWA,CAAC,OAA4DI,MAAaC;QACxF,MAAMC,SAAS,MAAMP,2BAA2BA,CAACK,MAAMC;QAEvDF,SAAS;YAAE,MAAM;QAAiC;QAElD,OAAOG;IACX,GAAG;QAACH;KAAS;AACjB"}
+{"version":3,"file":"useUpdateDeferredRegistrations.js","sources":["../src/useUpdateDeferredRegistrations.ts"],"sourcesContent":["import type { Runtime } from \"@squide/core\";\nimport { useCallback } from \"react\";\nimport { useAppRouterDispatcher } from \"./AppRouterContext.ts\";\n\nexport const DeferredRegistrationsUpdateStartedEvent = \"squide-deferred-registrations-update-started\";\nexport const DeferredRegistrationsUpdateCompletedEvent = \"squide-deferred-registrations-update-completed-started\";\n\nexport function useUpdateDeferredRegistrations() {\n    const dispatch = useAppRouterDispatcher();\n\n    return useCallback(async <TData = unknown, TRuntime extends Runtime = Runtime>(data: TData, runtime: TRuntime) => {\n        runtime.eventBus.dispatch(DeferredRegistrationsUpdateStartedEvent);\n\n        const errors = await runtime.moduleManager.updateDeferredRegistrations(data);\n\n        dispatch({ type: \"deferred-registrations-updated\" });\n\n        runtime.eventBus.dispatch(DeferredRegistrationsUpdateCompletedEvent);\n\n        return errors;\n    }, [dispatch]);\n}\n"],"names":["useCallback","useAppRouterDispatcher","DeferredRegistrationsUpdateStartedEvent","DeferredRegistrationsUpdateCompletedEvent","useUpdateDeferredRegistrations","dispatch","data","runtime","errors"],"mappings":";;;;;;;;AACoC;AAC2B;AAExD,MAAME,0CAA0C,+CAA+C;AAC/F,MAAMC,4CAA4C,yDAAyD;AAE3G,SAASC;IACZ,MAAMC,WAAWJ,sBAAsBA;IAEvC,OAAOD,WAAWA,CAAC,OAA4DM,MAAaC;QACxFA,QAAQ,QAAQ,CAAC,QAAQ,CAACL;QAE1B,MAAMM,SAAS,MAAMD,QAAQ,aAAa,CAAC,2BAA2B,CAACD;QAEvED,SAAS;YAAE,MAAM;QAAiC;QAElDE,QAAQ,QAAQ,CAAC,QAAQ,CAACJ;QAE1B,OAAOK;IACX,GAAG;QAACH;KAAS;AACjB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@squide/firefly",
   "author": "Workleap",
-  "version": "15.0.5",
+  "version": "16.0.0",
   "description": "Helpers to facilitate the creation of an application with the Squide firefly technology stack.",
   "license": "Apache-2.0",
   "repository": {
@@ -19,6 +19,11 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "default": "./dist/index.js"
+    },
+    "./internal": {
+      "types": "./dist/internal.d.ts",
+      "import": "./dist/internal.js",
+      "default": "./dist/internal.js"
     }
   },
   "files": [
@@ -28,43 +33,42 @@
   ],
   "peerDependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@tanstack/react-query": "^5.90.5",
-    "msw": "^2.11.6",
+    "@tanstack/react-query": "^5.90.10",
+    "msw": "^2.12.2",
     "react": "^18.0.0 || ^19.0.0",
     "react-dom": "^18.0.0 || ^19.0.0",
-    "react-router": "^7.9.4"
+    "react-router": "^7.9.6"
   },
   "dependencies": {
-    "@workleap-telemetry/core": "^1.0.3",
-    "@workleap/logging": "^1.3.1",
+    "@workleap-telemetry/core": "^1.0.4",
+    "@workleap/logging": "^1.3.2",
     "uuid": "^13.0.0",
-    "@squide/core": "6.1.3",
-    "@squide/module-federation": "7.0.4",
-    "@squide/msw": "4.0.4",
-    "@squide/react-router": "8.1.3"
+    "@squide/core": "6.1.4",
+    "@squide/msw": "4.0.5",
+    "@squide/react-router": "8.1.4"
   },
   "devDependencies": {
-    "@eslint/js": "9.38.0",
-    "@rsbuild/core": "1.5.17",
-    "@rslib/core": "0.16.1",
+    "@eslint/js": "9.39.1",
+    "@rsbuild/core": "1.6.7",
+    "@rslib/core": "0.18.0",
     "@testing-library/react": "16.3.0",
-    "@types/react": "19.2.2",
-    "@types/react-dom": "19.2.2",
-    "@typescript-eslint/parser": "8.46.2",
-    "@vitejs/plugin-react": "5.0.4",
-    "@workleap/eslint-configs": "0.0.5",
+    "@types/react": "19.2.6",
+    "@types/react-dom": "19.2.3",
+    "@typescript-eslint/parser": "8.47.0",
+    "@vitejs/plugin-react": "5.1.1",
+    "@workleap/eslint-configs": "1.1.5",
     "@workleap/rslib-configs": "1.1.3",
     "@workleap/typescript-configs": "3.0.7",
-    "eslint": "9.38.0",
-    "happy-dom": "20.0.8",
+    "eslint": "9.39.1",
+    "happy-dom": "20.0.10",
     "typescript": "5.9.3",
-    "typescript-eslint": "8.46.2",
-    "vitest": "4.0.2"
+    "typescript-eslint": "8.47.0",
+    "vitest": "4.0.10"
   },
   "sideEffects": false,
   "scripts": {
     "build": "rslib build --config ./rslib.build.ts",
-    "eslint": "eslint . --max-warnings=-0 --cache --cache-location node_modules/.cache/eslint",
+    "eslint": "eslint . --max-warnings=0 --cache --cache-location node_modules/.cache/eslint",
     "typecheck": "tsc",
     "test": "vitest --config vitest.config.ts --no-watch"
   }

package/src/AppRouterReducer.ts

@@ -1,6 +1,4 @@
-import { addLocalModuleRegistrationStatusChangedListener, getLocalModuleRegistrationStatus, removeLocalModuleRegistrationStatusChangedListener, useEventBus, useLogger, useRuntime } from "@squide/core";
-import { addRemoteModuleRegistrationStatusChangedListener, areModulesReady, areModulesRegistered, getRemoteModuleRegistrationStatus, removeRemoteModuleRegistrationStatusChangedListener } from "@squide/module-federation";
-import { addMswStateChangedListener, isMswReady, removeMswStateChangedListener } from "@squide/msw";
+import { useEventBus, useLogger, useRuntime } from "@squide/core";
 import { useCallback, useEffect, useMemo, useReducer, type Dispatch } from "react";
 import type { FireflyRuntime } from "./FireflyRuntime.tsx";
 import { useAppRouterStore } from "./useAppRouterStore.ts";
@@ -166,110 +164,75 @@ function reducer(state: AppRouterState, action: AppRouterAction) {
     return newState;
 }
 
-export function getAreModulesRegistered() {
-    const localModuleStatus = getLocalModuleRegistrationStatus();
-    const remoteModuleStatus = getRemoteModuleRegistrationStatus();
-
-    return areModulesRegistered(localModuleStatus, remoteModuleStatus);
-}
-
-export function getAreModulesReady() {
-    const localModuleStatus = getLocalModuleRegistrationStatus();
-    const remoteModuleStatus = getRemoteModuleRegistrationStatus();
-
-    return areModulesReady(localModuleStatus, remoteModuleStatus);
-}
-
-export function useModuleRegistrationStatusDispatcher(areModulesRegisteredValue: boolean, areModulesReadyValue: boolean, dispatch: AppRouterDispatch) {
+export function useModuleRegistrationStatusDispatcher(runtime: FireflyRuntime, areModulesRegisteredValue: boolean, areModulesReadyValue: boolean, dispatch: AppRouterDispatch) {
     const logger = useLogger();
 
-    const dispatchModulesRegistered = useExecuteOnce(useCallback(() => {
-        if (getAreModulesRegistered()) {
-            dispatch({ type: "modules-registered" });
-
-            logger
-                .withText("[squide] Modules are registered.", {
-                    style: {
-                        color: "green"
-                    }
-                })
-                .information();
-
-            return true;
-        }
-
-        return false;
-    }, [dispatch, logger]));
+    const dispatchModulesRegistered = useCallback(() => {
+        dispatch({ type: "modules-registered" });
 
-    const dispatchModulesReady = useExecuteOnce(useCallback(() => {
-        if (getAreModulesReady()) {
-            dispatch({ type: "modules-ready" });
-
-            logger
-                .withText("[squide] Modules are ready.", {
-                    style: {
-                        color: "green"
-                    }
-                })
-                .information();
+        logger
+            .withText("[squide] Modules are registered.", {
+                style: {
+                    color: "green"
+                }
+            })
+            .information();
+    }, [dispatch, logger]);
 
-            return true;
-        }
+    const dispatchModulesReady = useCallback(() => {
+        dispatch({ type: "modules-ready" });
 
-        return false;
-    }, [dispatch, logger]));
+        logger
+            .withText("[squide] Modules are ready.", {
+                style: {
+                    color: "green"
+                }
+            })
+            .information();
+    }, [dispatch, logger]);
 
     return useEffect(() => {
         if (!areModulesRegisteredValue) {
-            addLocalModuleRegistrationStatusChangedListener(dispatchModulesRegistered);
-            addRemoteModuleRegistrationStatusChangedListener(dispatchModulesRegistered);
+            runtime.moduleManager.registerModulesRegisteredListener(dispatchModulesRegistered);
         }
 
         if (!areModulesReadyValue) {
-            addLocalModuleRegistrationStatusChangedListener(dispatchModulesReady);
-            addRemoteModuleRegistrationStatusChangedListener(dispatchModulesReady);
+            runtime.moduleManager.registerModulesReadyListener(dispatchModulesReady);
         }
 
         return () => {
-            removeLocalModuleRegistrationStatusChangedListener(dispatchModulesRegistered);
-            removeRemoteModuleRegistrationStatusChangedListener(dispatchModulesRegistered);
-
-            removeLocalModuleRegistrationStatusChangedListener(dispatchModulesReady);
-            removeRemoteModuleRegistrationStatusChangedListener(dispatchModulesReady);
+            runtime.moduleManager.removeModulesRegisteredListener(dispatchModulesRegistered);
+            runtime.moduleManager.removeModulesReadyListener(dispatchModulesReady);
         };
     }, [areModulesRegisteredValue, areModulesReadyValue, dispatchModulesRegistered, dispatchModulesReady]);
 }
 
-export function useMswStatusDispatcher(isMswReadyValue: boolean, dispatch: AppRouterDispatch) {
+export function useMswStatusDispatcher(runtime: FireflyRuntime, isMswReadyValue: boolean, dispatch: AppRouterDispatch) {
     const logger = useLogger();
 
-    const dispatchMswReady = useExecuteOnce(useCallback(() => {
-        if (isMswReady()) {
-            dispatch({ type: "msw-ready" });
-
-            logger
-                .withText("[squide] MSW is ready.", {
-                    style: {
-                        color: "green"
-                    }
-                })
-                .information();
+    const dispatchMswReady = useCallback(() => {
+        dispatch({ type: "msw-ready" });
 
-            return true;
-        }
-
-        return false;
-    }, [dispatch, logger]));
+        logger
+            .withText("[squide] MSW is ready.", {
+                style: {
+                    color: "green"
+                }
+            })
+            .information();
+    }, [dispatch, logger]);
 
     useEffect(() => {
-        if (!isMswReadyValue) {
-            addMswStateChangedListener(dispatchMswReady);
-        }
+        if (runtime.isMswEnabled) {
+            if (!isMswReadyValue) {
+                runtime.getMswState().addMswReadyListener(dispatchMswReady);
+            }
 
-        return () => {
-            removeMswStateChangedListener(dispatchMswReady);
-        };
-    }, [isMswReadyValue, dispatchMswReady]);
+            return () => {
+                runtime.getMswState().removeMswReadyListener(dispatchMswReady);
+            };
+        }
+    }, [runtime, isMswReadyValue, dispatchMswReady]);
 }
 
 function useBootstrappingCompletedDispatcher(waitState: AppRouterWaitState, state: AppRouterState) {
@@ -331,10 +294,9 @@ export function useAppRouterReducer(waitForPublicData: boolean, waitForProtected
     const appRouterStore = useAppRouterStore();
 
     const isMswEnabled = runtime.isMswEnabled;
-
-    const areModulesInitiallyRegistered = getAreModulesRegistered();
-    const areModulesInitiallyReady = getAreModulesReady();
-    const isMswInitiallyReady = isMswReady();
+    const areModulesInitiallyRegistered = runtime.moduleManager.getAreModulesRegistered();
+    const areModulesInitiallyReady = runtime.moduleManager.getAreModulesReady();
+    const isMswInitiallyReady = runtime.isMswEnabled ? runtime.getMswState().isReady : false;
 
     const waitState = useMemo(() => ({
         waitForMsw: isMswEnabled,
@@ -402,8 +364,8 @@ export function useAppRouterReducer(waitForPublicData: boolean, waitForProtected
     const dispatchProxy = useReducerDispatchProxy(reactDispatch);
     const dispatch = useEnhancedReducerDispatch(waitState, dispatchProxy);
 
-    useModuleRegistrationStatusDispatcher(areModulesRegisteredValue, areModulesReadyValue, dispatch);
-    useMswStatusDispatcher(isMswReadyValue, dispatch);
+    useModuleRegistrationStatusDispatcher(runtime, areModulesRegisteredValue, areModulesReadyValue, dispatch);
+    useMswStatusDispatcher(runtime, isMswReadyValue, dispatch);
     useBootstrappingCompletedDispatcher(waitState, state);
 
     return [state, dispatch];

package/src/FireflyPlugin.ts

@@ -0,0 +1,11 @@
+import { Plugin } from "@squide/core";
+import { FireflyRuntime } from "./FireflyRuntime.tsx";
+import { GetSpanFunction, HoneycombTrackingUnmanagedErrorHandler } from "./honeycomb/registerHoneycombInstrumentation.ts";
+
+export interface FireflyPlugin extends Plugin<FireflyRuntime> {
+    registerHoneycombTrackingListeners?: (
+        getBootstrappingSpan: GetSpanFunction,
+        getDeferredRegistrationsUpdateSpan: GetSpanFunction,
+        onUnmanagedError: HoneycombTrackingUnmanagedErrorHandler
+    ) => HoneycombTrackingUnmanagedErrorHandler;
+}

package/src/FireflyRuntime.tsx

@@ -1,20 +1,19 @@
 import type { RegisterRouteOptions, RuntimeMethodOptions, RuntimeOptions } from "@squide/core";
-import { MswPlugin, MswPluginName } from "@squide/msw";
+import { MswPlugin, MswPluginName, MswState } from "@squide/msw";
 import { type IReactRouterRuntime, ReactRouterRuntime, ReactRouterRuntimeScope, type Route } from "@squide/react-router";
 import type { HoneycombInstrumentationPartialClient } from "@workleap-telemetry/core";
 import type { Logger } from "@workleap/logging";
 import type { RequestHandler } from "msw";
-import { getAreModulesRegistered } from "./AppRouterReducer.ts";
 import { type AppRouterStore, createAppRouterStore } from "./AppRouterStore.ts";
 
-export interface FireflyRuntimeOptions extends RuntimeOptions {
-    useMsw?: boolean;
+export interface FireflyRuntimeOptions<TRuntime extends FireflyRuntime = FireflyRuntime> extends RuntimeOptions<TRuntime> {
     honeycombInstrumentationClient?: HoneycombInstrumentationPartialClient;
 }
 
 export interface RegisterRequestHandlersOptions extends RuntimeMethodOptions {}
 
 export interface IFireflyRuntime extends IReactRouterRuntime {
+    getMswState(): MswState;
     registerRequestHandlers: (handlers: RequestHandler[]) => void;
     get requestHandlers(): RequestHandler[];
     get appRouterStore(): AppRouterStore;
@@ -22,35 +21,28 @@ export interface IFireflyRuntime extends IReactRouterRuntime {
     get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient | undefined;
 }
 
-export class FireflyRuntime extends ReactRouterRuntime implements IFireflyRuntime {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export class FireflyRuntime<TRuntime extends FireflyRuntime = any> extends ReactRouterRuntime<TRuntime> implements IFireflyRuntime {
     protected _appRouterStore: AppRouterStore;
-    protected _useMsw: boolean;
     protected _honeycombInstrumentationClient: HoneycombInstrumentationPartialClient | undefined;
 
-    constructor({ plugins, useMsw, honeycombInstrumentationClient, ...options }: FireflyRuntimeOptions = {}) {
-        if (useMsw) {
-            super({
-                plugins: [
-                    ...(plugins ?? []),
-                    runtime => new MswPlugin(runtime)
-                ],
-                ...options
-            });
-
-            this._useMsw = true;
-        } else {
-            super({
-                plugins,
-                ...options
-            });
-
-            this._useMsw = false;
-        }
+    constructor({ honeycombInstrumentationClient, ...options }: FireflyRuntimeOptions = {}) {
+        super(options);
 
         this._appRouterStore = createAppRouterStore(this._logger);
         this._honeycombInstrumentationClient = honeycombInstrumentationClient;
     }
 
+    getMswState() {
+        const mswPlugin = this.getPlugin(MswPluginName) as MswPlugin;
+
+        if (!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?");
+        }
+
+        return mswPlugin.mswState;
+    }
+
     registerRequestHandlers(handlers: RequestHandler[], options: RegisterRequestHandlersOptions = {}) {
         const logger = this._getLogger(options);
         const mswPlugin = this.getPlugin(MswPluginName) as MswPlugin;
@@ -59,7 +51,7 @@ export class FireflyRuntime extends ReactRouterRuntime implements IFireflyRuntim
             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?");
         }
 
-        if (getAreModulesRegistered()) {
+        if (this.moduleManager.getAreModulesRegistered()) {
             throw new Error("[squide] Cannot register an MSW request handlers once the modules are registered. Are you trying to register an MSW request handler in a deferred registration function? Only navigation items can be registered in a deferred registration function.");
         }
 
@@ -80,7 +72,7 @@ export class FireflyRuntime extends ReactRouterRuntime implements IFireflyRuntim
     }
 
     registerRoute(route: Route, options: RegisterRouteOptions = {}) {
-        if (getAreModulesRegistered()) {
+        if (this.moduleManager.getAreModulesRegistered()) {
             throw new Error("[squide] Cannot register a route once the modules are registered. Are you trying to register a route in a deferred registration function? Only navigation items can be registered in a deferred registration function.");
         }
 
@@ -92,19 +84,23 @@ export class FireflyRuntime extends ReactRouterRuntime implements IFireflyRuntim
     }
 
     get isMswEnabled() {
-        return this._useMsw;
+        return this._plugins.some(x => x.name === MswPluginName);
     }
 
     get honeycombInstrumentationClient() {
         return this._honeycombInstrumentationClient;
     }
 
-    startScope(logger: Logger): FireflyRuntime {
-        return (new FireflyRuntimeScope(this, logger) as unknown) as FireflyRuntime;
+    startScope(logger: Logger): TRuntime {
+        return (new FireflyRuntimeScope(this, logger) as unknown) as TRuntime;
     }
 }
 
 export class FireflyRuntimeScope<TRuntime extends FireflyRuntime = FireflyRuntime> extends ReactRouterRuntimeScope<TRuntime> implements IFireflyRuntime {
+    getMswState() {
+        return this._runtime.getMswState();
+    }
+
     registerRequestHandlers(handlers: RequestHandler[], options: RegisterRequestHandlersOptions = {}) {
         this._runtime.registerRequestHandlers(handlers, {
             ...options,
@@ -112,19 +108,20 @@ export class FireflyRuntimeScope<TRuntime extends FireflyRuntime = FireflyRuntim
         });
     }
 
+    // Must define a return type otherwise we get an "error TS2742: The inferred type of 'requestHandlers' cannot be named" error.
     get requestHandlers(): RequestHandler[] {
         return this._runtime.requestHandlers;
     }
 
-    get appRouterStore() {
-        return this._runtime.appRouterStore;
+    get appRouterStore(): AppRouterStore {
+        throw new Error("[squide] Cannot retrieve the app router store from a runtime scope instance.");
     }
 
     get isMswEnabled() {
         return this._runtime.isMswEnabled;
     }
 
-    get honeycombInstrumentationClient() {
-        return this._runtime.honeycombInstrumentationClient;
+    get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient {
+        throw new Error("[squide] Cannot retrieve the Honeycomb instrumentation client from a runtime scope instance.");
     }
 }