@squide/firefly 13.3.0 → 14.0.0

package/CHANGELOG.md

@@ -1,5 +1,69 @@
 # @squide/firefly
 
+## 14.0.0
+
+### Major Changes
+
+- [#311](https://github.com/workleap/wl-squide/pull/311) [`cc52e8b`](https://github.com/workleap/wl-squide/commit/cc52e8bfbe9d3d215f51d12755743f17c0c69772) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Deferred registration functions now receives a runtime instance as the first argument. This new scope runtime instance should used whenever runtime access is required within a deferred registration function scope.
+
+  Before:
+
+  The `runtime` argument of the registration function is used to register the navigation item.
+
+  ```ts !#1,2,4
+  export const register: ModuleRegisterFunction<
+    FireflyRuntime,
+    unknown,
+    DeferredRegistrationData
+  > = (runtime) => {
+    return ({ featureFlags }, operation) => {
+      if (featureFlags.featureA) {
+        runtime.registerNavigationItem({
+          $id: "feature-a",
+          $label: operation === "register" ? "Feature A" : "Feature A updated",
+          to: "/feature-a",
+        });
+      }
+    };
+  };
+  ```
+
+  After:
+
+  The `deferredRuntime` argument of the **deferred** registration function is used to register the navigation item.
+
+  ```ts !#2,4
+  export const register: ModuleRegisterFunction<
+    FireflyRuntime,
+    unknown,
+    DeferredRegistrationData
+  > = (runtime) => {
+    return (deferredRuntime, { featureFlags }, operation) => {
+      if (featureFlags.featureA) {
+        deferredRuntime.registerNavigationItem({
+          $id: "feature-a",
+          $label: operation === "register" ? "Feature A" : "Feature A updated",
+          to: "/feature-a",
+        });
+      }
+    };
+  };
+  ```
+
+### Patch Changes
+
+- Updated dependencies [[`cc52e8b`](https://github.com/workleap/wl-squide/commit/cc52e8bfbe9d3d215f51d12755743f17c0c69772)]:
+  - @squide/module-federation@7.0.0
+  - @squide/react-router@8.0.0
+  - @squide/core@6.0.0
+  - @squide/msw@4.0.0
+
+## 13.3.1
+
+### Patch Changes
+
+- [#307](https://github.com/workleap/wl-squide/pull/307) [`4bd0a34`](https://github.com/workleap/wl-squide/commit/4bd0a34b443caeb12f6c65faa5443c4a48784562) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Fix Honeycomb traces for certain usecases, including global data fetch failures.
+
 ## 13.3.0
 
 ### Minor Changes

package/dist/AppRouterReducer.d.ts

@@ -1,9 +1,11 @@
 import { type Dispatch } from "react";
 export type ActiveRouteVisiblity = "unknown" | "public" | "protected";
-export interface AppRouterState {
+export interface AppRouterWaitState {
     waitForMsw: boolean;
     waitForPublicData: boolean;
     waitForProtectedData: boolean;
+}
+export interface AppRouterState extends AppRouterWaitState {
     areModulesRegistered: boolean;
     areModulesReady: boolean;
     isMswReady: boolean;
@@ -29,13 +31,13 @@ export declare const DeferredRegistrationsUpdatedEvent = "squide-deferred-regist
 export declare const ApplicationBoostrappedEvent = "squide-app-boostrapped";
 export interface AppRouterAction {
     type: AppRouterActionType;
+    payload?: unknown;
 }
 export type AppRouterDispatch = Dispatch<AppRouterAction>;
 export declare function getAreModulesRegistered(): boolean;
 export declare function getAreModulesReady(): boolean;
 export declare function useModuleRegistrationStatusDispatcher(areModulesRegisteredValue: boolean, areModulesReadyValue: boolean, dispatch: AppRouterDispatch): void;
 export declare function useMswStatusDispatcher(isMswReadyValue: boolean, dispatch: AppRouterDispatch): void;
-export declare function useBootstrappingCompletedDispatcher(state: AppRouterState): void;
 export declare function __setAppReducerDispatchProxyFactory(factory: (reactDispatch: AppRouterDispatch) => AppRouterDispatch): void;
 export declare function __clearAppReducerDispatchProxy(): void;
 export declare function useAppRouterReducer(waitForPublicData: boolean, waitForProtectedData: boolean): [AppRouterState, AppRouterDispatch];

package/dist/AppRouterReducer.js

@@ -160,13 +160,10 @@ function useModuleRegistrationStatusDispatcher(areModulesRegisteredValue, areMod
             dispatch({
                 type: "modules-registered"
             });
-            logger.withText("[squide]").withText("Modules are registered", {
+            logger.withText("[squide] Modules are registered.", {
                 style: {
-                    color: "white",
-                    backgroundColor: "green"
+                    color: "green"
                 }
-            }).withText(".", {
-                leadingSpace: false
             }).information();
             return true;
         }
@@ -180,13 +177,10 @@ function useModuleRegistrationStatusDispatcher(areModulesRegisteredValue, areMod
             dispatch({
                 type: "modules-ready"
             });
-            logger.withText("[squide]").withText("Modules are ready", {
+            logger.withText("[squide] Modules are ready.", {
                 style: {
-                    color: "white",
-                    backgroundColor: "green"
+                    color: "green"
                 }
-            }).withText(".", {
-                leadingSpace: false
             }).information();
             return true;
         }
@@ -224,13 +218,10 @@ function useMswStatusDispatcher(isMswReadyValue, dispatch) {
             dispatch({
                 type: "msw-ready"
             });
-            logger.withText("[squide]").withText("MSW is ready", {
+            logger.withText("[squide] MSW is ready.", {
                 style: {
-                    color: "white",
-                    backgroundColor: "green"
+                    color: "green"
                 }
-            }).withText(".", {
-                leadingSpace: false
             }).information();
             return true;
         }
@@ -251,19 +242,20 @@ function useMswStatusDispatcher(isMswReadyValue, dispatch) {
         dispatchMswReady
     ]);
 }
-function useBootstrappingCompletedDispatcher(state) {
+function useBootstrappingCompletedDispatcher(waitState, state) {
     const eventBus = useEventBus();
     const areModulesRegisteredValue = state.areModulesRegistered;
     const isBoostrapping = isBootstrapping(state);
     useExecuteOnce(useCallback(()=>{
         if (areModulesRegisteredValue && !isBoostrapping) {
-            eventBus.dispatch(ApplicationBoostrappedEvent);
+            eventBus.dispatch(ApplicationBoostrappedEvent, waitState);
             return true;
         }
         return false;
     }, [
         areModulesRegisteredValue,
         isBoostrapping,
+        waitState,
         eventBus
     ]), true);
 }
@@ -283,16 +275,20 @@ function useReducerDispatchProxy(reactDispatch) {
         reactDispatch
     ]);
 }
-function useEnhancedReducerDispatch(reducerDispatch) {
+function useEnhancedReducerDispatch(waitState, reducerDispatch) {
     const logger = useLogger();
     const appRouterStore = useAppRouterStore();
     const eventBus = useEventBus();
     return useCallback((action)=>{
         logger.withText("[squide] The following action has been dispatched to the AppRouter reducer:").withObject(action).debug();
-        appRouterStore.dispatch(action);
-        eventBus.dispatch(`squide-${action.type}`);
+        appRouterStore.dispatch({
+            ...action,
+            payload: waitState
+        });
+        eventBus.dispatch(`squide-${action.type}`, waitState);
         reducerDispatch(action);
     }, [
+        waitState,
         reducerDispatch,
         logger,
         appRouterStore,
@@ -303,81 +299,103 @@ function useAppRouterReducer(waitForPublicData, waitForProtectedData) {
     const runtime = useRuntime();
     const eventBus = useEventBus();
     const appRouterStore = useAppRouterStore();
+    const isMswEnabled = runtime.isMswEnabled;
     const areModulesInitiallyRegistered = getAreModulesRegistered();
     const areModulesInitiallyReady = getAreModulesReady();
     const isMswInitiallyReady = isMswReady();
+    const waitState = useMemo(()=>({
+            waitForMsw: isMswEnabled,
+            waitForPublicData,
+            waitForProtectedData
+        }), [
+        isMswEnabled,
+        waitForPublicData,
+        waitForProtectedData
+    ]);
+    const initialState = useMemo(()=>({
+            waitForMsw: waitState.waitForMsw,
+            waitForPublicData: waitState.waitForPublicData,
+            waitForProtectedData: waitState.waitForProtectedData,
+            // When the modules registration functions are awaited, the event listeners are registered after the modules are registered.
+            areModulesRegistered: areModulesInitiallyRegistered,
+            areModulesReady: areModulesInitiallyReady,
+            isMswReady: isMswInitiallyReady,
+            isPublicDataReady: false,
+            isProtectedDataReady: false,
+            activeRouteVisibility: "unknown",
+            isUnauthorized: false
+        }), [
+        waitState,
+        areModulesInitiallyRegistered,
+        areModulesInitiallyReady,
+        isMswInitiallyReady
+    ]);
     // When modules are initially registered, the reducer action will never be dispatched, therefore the event would not be dispatched as well.
     // To ensure the bootstrapping events sequencing, the event is manually dispatched when the modules are initially registered.
     useExecuteOnce(useCallback(()=>{
         if (areModulesInitiallyRegistered) {
             appRouterStore.dispatch({
-                type: "modules-registered"
+                type: "modules-registered",
+                payload: waitState
             });
-            eventBus.dispatch(ModulesRegisteredEvent);
+            eventBus.dispatch(ModulesRegisteredEvent, waitState);
         }
         return true;
     }, [
         areModulesInitiallyRegistered,
         appRouterStore,
-        eventBus
+        eventBus,
+        waitState
     ]), true);
     // When modules are initially registered, the reducer action will never be dispatched, therefore the event would not be dispatched as well.
     // To ensure the bootstrapping events sequencing, the event is manually dispatched when the modules are initially registered.
     useExecuteOnce(useCallback(()=>{
         if (areModulesInitiallyReady) {
             appRouterStore.dispatch({
-                type: "modules-ready"
+                type: "modules-ready",
+                payload: waitState
             });
-            eventBus.dispatch(ModulesReadyEvent);
+            eventBus.dispatch(ModulesReadyEvent, waitState);
         }
         return true;
     }, [
         areModulesInitiallyReady,
         appRouterStore,
-        eventBus
+        eventBus,
+        waitState
     ]), true);
     // When modules are initially registered, the reducer action will never be dispatched, therefore the event would not be dispatched as well.
     // To ensure the bootstrapping events sequencing, the event is manually dispatched when the modules are initially registered.
     useExecuteOnce(useCallback(()=>{
         if (isMswInitiallyReady) {
             appRouterStore.dispatch({
-                type: "msw-ready"
+                type: "msw-ready",
+                payload: waitState
             });
-            eventBus.dispatch(MswReadyEvent);
+            eventBus.dispatch(MswReadyEvent, waitState);
         }
         return true;
     }, [
         isMswInitiallyReady,
         appRouterStore,
-        eventBus
+        eventBus,
+        waitState
     ]), true);
-    const [state, reactDispatch] = useReducer(reducer, {
-        waitForMsw: runtime.isMswEnabled,
-        waitForPublicData,
-        waitForProtectedData,
-        // When the modules registration functions are awaited, the event listeners are registered after the modules are registered.
-        areModulesRegistered: areModulesInitiallyRegistered,
-        areModulesReady: areModulesInitiallyReady,
-        isMswReady: isMswInitiallyReady,
-        isPublicDataReady: false,
-        isProtectedDataReady: false,
-        activeRouteVisibility: "unknown",
-        isUnauthorized: false
-    });
+    const [state, reactDispatch] = useReducer(reducer, initialState);
     const { areModulesRegistered: areModulesRegisteredValue, areModulesReady: areModulesReadyValue, isMswReady: isMswReadyValue } = state;
     // The dispatch proxy is strictly an utility allowing tests to mock the useReducer dispatch function. It's easier
     // than mocking the import from React.
     const dispatchProxy = useReducerDispatchProxy(reactDispatch);
-    const dispatch = useEnhancedReducerDispatch(dispatchProxy);
+    const dispatch = useEnhancedReducerDispatch(waitState, dispatchProxy);
     useModuleRegistrationStatusDispatcher(areModulesRegisteredValue, areModulesReadyValue, dispatch);
     useMswStatusDispatcher(isMswReadyValue, dispatch);
-    useBootstrappingCompletedDispatcher(state);
+    useBootstrappingCompletedDispatcher(waitState, state);
     return [
         state,
         dispatch
     ];
 }
 
-export { ActiveRouteIsProtectedEvent, ActiveRouteIsPublicEvent, ApplicationBoostrappedEvent, DeferredRegistrationsUpdatedEvent, ModulesReadyEvent, ModulesRegisteredEvent, MswReadyEvent, ProtectedDataReadyEvent, ProtectedDataUpdatedEvent, PublicDataReadyEvent, PublicDataUpdatedEvent, __clearAppReducerDispatchProxy, __setAppReducerDispatchProxyFactory, getAreModulesReady, getAreModulesRegistered, useAppRouterReducer, useBootstrappingCompletedDispatcher, useModuleRegistrationStatusDispatcher, useMswStatusDispatcher };
+export { ActiveRouteIsProtectedEvent, ActiveRouteIsPublicEvent, ApplicationBoostrappedEvent, DeferredRegistrationsUpdatedEvent, ModulesReadyEvent, ModulesRegisteredEvent, MswReadyEvent, ProtectedDataReadyEvent, ProtectedDataUpdatedEvent, PublicDataReadyEvent, PublicDataUpdatedEvent, __clearAppReducerDispatchProxy, __setAppReducerDispatchProxyFactory, getAreModulesReady, getAreModulesRegistered, useAppRouterReducer, useModuleRegistrationStatusDispatcher, useMswStatusDispatcher };
 
 //# sourceMappingURL=AppRouterReducer.js.map

package/dist/AppRouterReducer.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppRouterReducer.js","sources":["webpack://@squide/firefly/./src/AppRouterReducer.ts"],"sourcesContent":["import { addLocalModuleRegistrationStatusChangedListener, getLocalModuleRegistrationStatus, removeLocalModuleRegistrationStatusChangedListener, useEventBus, useLogger, useRuntime } from \"@squide/core\";\nimport { addRemoteModuleRegistrationStatusChangedListener, areModulesReady, areModulesRegistered, getRemoteModuleRegistrationStatus, removeRemoteModuleRegistrationStatusChangedListener } from \"@squide/module-federation\";\nimport { addMswStateChangedListener, isMswReady, removeMswStateChangedListener } from \"@squide/msw\";\nimport { useCallback, useEffect, useMemo, useReducer, type Dispatch } from \"react\";\nimport type { FireflyRuntime } from \"./FireflyRuntime.tsx\";\nimport { useAppRouterStore } from \"./useAppRouterStore.ts\";\nimport { useExecuteOnce } from \"./useExecuteOnce.ts\";\nimport { isBootstrapping } from \"./useIsBootstrapping.ts\";\n\nexport type ActiveRouteVisiblity = \"unknown\" | \"public\" | \"protected\";\n\nexport interface AppRouterState {\n    waitForMsw: boolean;\n    waitForPublicData: boolean;\n    waitForProtectedData: boolean;\n    areModulesRegistered: boolean;\n    areModulesReady: boolean;\n    isMswReady: boolean;\n    isPublicDataReady: boolean;\n    isProtectedDataReady: boolean;\n    publicDataUpdatedAt?: number;\n    protectedDataUpdatedAt?: number;\n    deferredRegistrationsUpdatedAt?: number;\n    activeRouteVisibility: ActiveRouteVisiblity;\n    isUnauthorized: boolean;\n}\n\nexport type AppRouterActionType =\n| \"modules-registered\"\n| \"modules-ready\"\n| \"msw-ready\"\n| \"public-data-ready\"\n| \"protected-data-ready\"\n| \"public-data-updated\"\n| \"protected-data-updated\"\n| \"deferred-registrations-updated\"\n| \"active-route-is-public\"\n| \"active-route-is-protected\"\n| \"is-unauthorized\";\n\n// The followings event const are a concatenation of \"squide-\" with AppRouterActionType.\n// They are dispatched by the useEnhancedReducerDispatch hook.\nexport const ModulesRegisteredEvent = \"squide-modules-registered\";\nexport const ModulesReadyEvent = \"squide-modules-ready\";\nexport const MswReadyEvent = \"squide-msw-ready\";\nexport const ActiveRouteIsPublicEvent = \"squide-active-route-is-public\";\nexport const ActiveRouteIsProtectedEvent = \"squide-active-route-is-protected\";\nexport const PublicDataReadyEvent = \"squide-public-data-ready\";\nexport const ProtectedDataReadyEvent = \"squide-protected-data-ready\";\nexport const PublicDataUpdatedEvent = \"squide-public-data-updated\";\nexport const ProtectedDataUpdatedEvent = \"squide-protected-data-updated\";\nexport const DeferredRegistrationsUpdatedEvent = \"squide-deferred-registrations-updated\";\nexport const ApplicationBoostrappedEvent = \"squide-app-boostrapped\";\n\nexport interface AppRouterAction {\n    type: AppRouterActionType;\n}\n\nexport type AppRouterDispatch = Dispatch<AppRouterAction>;\n\nfunction reducer(state: AppRouterState, action: AppRouterAction) {\n    let newState = state;\n\n    switch (action.type) {\n        case \"modules-registered\": {\n            newState = {\n                ...newState,\n                areModulesRegistered: true\n            };\n\n            break;\n        }\n        case \"modules-ready\": {\n            newState = {\n                ...newState,\n                areModulesReady: true,\n                // Will be set even if the app is not using deferred registrations.\n                deferredRegistrationsUpdatedAt: Date.now()\n            };\n\n            break;\n        }\n        case \"msw-ready\": {\n            newState = {\n                ...newState,\n                isMswReady: true\n            };\n\n            break;\n        }\n        case \"public-data-ready\": {\n            newState = {\n                ...newState,\n                isPublicDataReady: true,\n                publicDataUpdatedAt: Date.now()\n            };\n\n            break;\n        }\n        case \"protected-data-ready\": {\n            newState = {\n                ...newState,\n                isProtectedDataReady: true,\n                protectedDataUpdatedAt: Date.now()\n            };\n\n            break;\n        }\n        case \"public-data-updated\": {\n            newState = {\n                ...newState,\n                publicDataUpdatedAt: Date.now()\n            };\n\n            break;\n        }\n        case \"protected-data-updated\": {\n            newState = {\n                ...newState,\n                protectedDataUpdatedAt: Date.now()\n            };\n\n            break;\n        }\n        case \"deferred-registrations-updated\": {\n            newState = {\n                ...newState,\n                deferredRegistrationsUpdatedAt: Date.now()\n            };\n\n            break;\n        }\n        case \"active-route-is-public\": {\n            newState = {\n                ...newState,\n                activeRouteVisibility: \"public\"\n            };\n\n            break;\n        }\n        case \"active-route-is-protected\": {\n            newState = {\n                ...newState,\n                activeRouteVisibility: \"protected\"\n            };\n\n            break;\n        }\n        case \"is-unauthorized\": {\n            newState = {\n                ...newState,\n                isUnauthorized: true\n            };\n\n            break;\n        }\n        default: {\n            throw new Error(`[squide] The AppRouter component state reducer doesn't support action type \"${action.type}\".`);\n        }\n    }\n\n    return newState;\n}\n\nexport function getAreModulesRegistered() {\n    const localModuleStatus = getLocalModuleRegistrationStatus();\n    const remoteModuleStatus = getRemoteModuleRegistrationStatus();\n\n    return areModulesRegistered(localModuleStatus, remoteModuleStatus);\n}\n\nexport function getAreModulesReady() {\n    const localModuleStatus = getLocalModuleRegistrationStatus();\n    const remoteModuleStatus = getRemoteModuleRegistrationStatus();\n\n    return areModulesReady(localModuleStatus, remoteModuleStatus);\n}\n\nexport function useModuleRegistrationStatusDispatcher(areModulesRegisteredValue: boolean, areModulesReadyValue: boolean, dispatch: AppRouterDispatch) {\n    const logger = useLogger();\n\n    const dispatchModulesRegistered = useExecuteOnce(useCallback(() => {\n        if (getAreModulesRegistered()) {\n            dispatch({ type: \"modules-registered\" });\n\n            logger\n                .withText(\"[squide]\")\n                .withText(\"Modules are registered\", {\n                    style: {\n                        color: \"white\",\n                        backgroundColor: \"green\"\n                    }\n                })\n                .withText(\".\", {\n                    leadingSpace: false\n                })\n                .information();\n\n            return true;\n        }\n\n        return false;\n    }, [dispatch, logger]));\n\n    const dispatchModulesReady = useExecuteOnce(useCallback(() => {\n        if (getAreModulesReady()) {\n            dispatch({ type: \"modules-ready\" });\n\n            logger\n                .withText(\"[squide]\")\n                .withText(\"Modules are ready\", {\n                    style: {\n                        color: \"white\",\n                        backgroundColor: \"green\"\n                    }\n                })\n                .withText(\".\", {\n                    leadingSpace: false\n                })\n                .information();\n\n            return true;\n        }\n\n        return false;\n    }, [dispatch, logger]));\n\n    return useEffect(() => {\n        if (!areModulesRegisteredValue) {\n            addLocalModuleRegistrationStatusChangedListener(dispatchModulesRegistered);\n            addRemoteModuleRegistrationStatusChangedListener(dispatchModulesRegistered);\n        }\n\n        if (!areModulesReadyValue) {\n            addLocalModuleRegistrationStatusChangedListener(dispatchModulesReady);\n            addRemoteModuleRegistrationStatusChangedListener(dispatchModulesReady);\n        }\n\n        return () => {\n            removeLocalModuleRegistrationStatusChangedListener(dispatchModulesRegistered);\n            removeRemoteModuleRegistrationStatusChangedListener(dispatchModulesRegistered);\n\n            removeLocalModuleRegistrationStatusChangedListener(dispatchModulesReady);\n            removeRemoteModuleRegistrationStatusChangedListener(dispatchModulesReady);\n        };\n    }, [areModulesRegisteredValue, areModulesReadyValue, dispatchModulesRegistered, dispatchModulesReady]);\n}\n\nexport function useMswStatusDispatcher(isMswReadyValue: boolean, dispatch: AppRouterDispatch) {\n    const logger = useLogger();\n\n    const dispatchMswReady = useExecuteOnce(useCallback(() => {\n        if (isMswReady()) {\n            dispatch({ type: \"msw-ready\" });\n\n            logger\n                .withText(\"[squide]\")\n                .withText(\"MSW is ready\", {\n                    style: {\n                        color: \"white\",\n                        backgroundColor: \"green\"\n                    }\n                })\n                .withText(\".\", {\n                    leadingSpace: false\n                })\n                .information();\n\n            return true;\n        }\n\n        return false;\n    }, [dispatch, logger]));\n\n    useEffect(() => {\n        if (!isMswReadyValue) {\n            addMswStateChangedListener(dispatchMswReady);\n        }\n\n        return () => {\n            removeMswStateChangedListener(dispatchMswReady);\n        };\n    }, [isMswReadyValue, dispatchMswReady]);\n}\n\nexport function useBootstrappingCompletedDispatcher(state: AppRouterState) {\n    const eventBus = useEventBus();\n\n    const areModulesRegisteredValue = state.areModulesRegistered;\n    const isBoostrapping = isBootstrapping(state);\n\n    useExecuteOnce(useCallback(() => {\n        if (areModulesRegisteredValue && !isBoostrapping) {\n            eventBus.dispatch(ApplicationBoostrappedEvent);\n\n            return true;\n        }\n\n        return false;\n    }, [areModulesRegisteredValue, isBoostrapping, eventBus]), true);\n}\n\nlet dispatchProxyFactory: ((reactDispatch: AppRouterDispatch) => AppRouterDispatch) | undefined;\n\n// This function should only be used by tests.\nexport function __setAppReducerDispatchProxyFactory(factory: (reactDispatch: AppRouterDispatch) => AppRouterDispatch) {\n    dispatchProxyFactory = factory;\n}\n\n// This function should only be used by tests.\nexport function __clearAppReducerDispatchProxy() {\n    dispatchProxyFactory = undefined;\n}\n\nfunction useReducerDispatchProxy(reactDispatch: AppRouterDispatch) {\n    return useMemo(() => {\n        return dispatchProxyFactory ? dispatchProxyFactory(reactDispatch) : reactDispatch;\n    }, [reactDispatch]);\n}\n\nfunction useEnhancedReducerDispatch(reducerDispatch: AppRouterDispatch) {\n    const logger = useLogger();\n    const appRouterStore = useAppRouterStore();\n    const eventBus = useEventBus();\n\n    return useCallback((action: AppRouterAction) => {\n        logger\n            .withText(\"[squide] The following action has been dispatched to the AppRouter reducer:\")\n            .withObject(action)\n            .debug();\n\n        appRouterStore.dispatch(action);\n        eventBus.dispatch(`squide-${action.type}`);\n\n        reducerDispatch(action);\n    }, [reducerDispatch, logger, appRouterStore, eventBus]);\n}\n\nexport function useAppRouterReducer(waitForPublicData: boolean, waitForProtectedData: boolean): [AppRouterState, AppRouterDispatch] {\n    const runtime = useRuntime() as FireflyRuntime;\n    const eventBus = useEventBus();\n    const appRouterStore = useAppRouterStore();\n\n    const areModulesInitiallyRegistered = getAreModulesRegistered();\n    const areModulesInitiallyReady = getAreModulesReady();\n    const isMswInitiallyReady = isMswReady();\n\n    // When modules are initially registered, the reducer action will never be dispatched, therefore the event would not be dispatched as well.\n    // To ensure the bootstrapping events sequencing, the event is manually dispatched when the modules are initially registered.\n    useExecuteOnce(useCallback(() => {\n        if (areModulesInitiallyRegistered) {\n            appRouterStore.dispatch({ type: \"modules-registered\" });\n            eventBus.dispatch(ModulesRegisteredEvent);\n        }\n\n        return true;\n    }, [areModulesInitiallyRegistered, appRouterStore, eventBus]), true);\n\n    // When modules are initially registered, the reducer action will never be dispatched, therefore the event would not be dispatched as well.\n    // To ensure the bootstrapping events sequencing, the event is manually dispatched when the modules are initially registered.\n    useExecuteOnce(useCallback(() => {\n        if (areModulesInitiallyReady) {\n            appRouterStore.dispatch({ type: \"modules-ready\" });\n            eventBus.dispatch(ModulesReadyEvent);\n        }\n\n        return true;\n    }, [areModulesInitiallyReady, appRouterStore, eventBus]), true);\n\n    // When modules are initially registered, the reducer action will never be dispatched, therefore the event would not be dispatched as well.\n    // To ensure the bootstrapping events sequencing, the event is manually dispatched when the modules are initially registered.\n    useExecuteOnce(useCallback(() => {\n        if (isMswInitiallyReady) {\n            appRouterStore.dispatch({ type: \"msw-ready\" });\n            eventBus.dispatch(MswReadyEvent);\n        }\n\n        return true;\n    }, [isMswInitiallyReady, appRouterStore, eventBus]), true);\n\n    const [state, reactDispatch] = useReducer(reducer, {\n        waitForMsw: runtime.isMswEnabled,\n        waitForPublicData,\n        waitForProtectedData,\n        // When the modules registration functions are awaited, the event listeners are registered after the modules are registered.\n        areModulesRegistered: areModulesInitiallyRegistered,\n        areModulesReady: areModulesInitiallyReady,\n        isMswReady: isMswInitiallyReady,\n        isPublicDataReady: false,\n        isProtectedDataReady: false,\n        activeRouteVisibility: \"unknown\",\n        isUnauthorized: false\n    });\n\n    const {\n        areModulesRegistered: areModulesRegisteredValue,\n        areModulesReady: areModulesReadyValue,\n        isMswReady: isMswReadyValue\n    } = state;\n\n    // The dispatch proxy is strictly an utility allowing tests to mock the useReducer dispatch function. It's easier\n    // than mocking the import from React.\n    const dispatchProxy = useReducerDispatchProxy(reactDispatch);\n    const dispatch = useEnhancedReducerDispatch(dispatchProxy);\n\n    useModuleRegistrationStatusDispatcher(areModulesRegisteredValue, areModulesReadyValue, dispatch);\n    useMswStatusDispatcher(isMswReadyValue, dispatch);\n    useBootstrappingCompletedDispatcher(state);\n\n    return [state, dispatch];\n}\n"],"names":["addLocalModuleRegistrationStatusChangedListener","getLocalModuleRegistrationStatus","removeLocalModuleRegistrationStatusChangedListener","useEventBus","useLogger","useRuntime","addRemoteModuleRegistrationStatusChangedListener","areModulesReady","areModulesRegistered","getRemoteModuleRegistrationStatus","removeRemoteModuleRegistrationStatusChangedListener","addMswStateChangedListener","isMswReady","removeMswStateChangedListener","useCallback","useEffect","useMemo","useReducer","useAppRouterStore","useExecuteOnce","isBootstrapping","ModulesRegisteredEvent","ModulesReadyEvent","MswReadyEvent","ActiveRouteIsPublicEvent","ActiveRouteIsProtectedEvent","PublicDataReadyEvent","ProtectedDataReadyEvent","PublicDataUpdatedEvent","ProtectedDataUpdatedEvent","DeferredRegistrationsUpdatedEvent","ApplicationBoostrappedEvent","reducer","state","action","newState","Date","Error","getAreModulesRegistered","localModuleStatus","remoteModuleStatus","getAreModulesReady","useModuleRegistrationStatusDispatcher","areModulesRegisteredValue","areModulesReadyValue","dispatch","logger","dispatchModulesRegistered","dispatchModulesReady","useMswStatusDispatcher","isMswReadyValue","dispatchMswReady","useBootstrappingCompletedDispatcher","eventBus","isBoostrapping","dispatchProxyFactory","__setAppReducerDispatchProxyFactory","factory","__clearAppReducerDispatchProxy","undefined","useReducerDispatchProxy","reactDispatch","useEnhancedReducerDispatch","reducerDispatch","appRouterStore","useAppRouterReducer","waitForPublicData","waitForProtectedData","runtime","areModulesInitiallyRegistered","areModulesInitiallyReady","isMswInitiallyReady","dispatchProxy"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAyM;AACmB;AACxH;AACjB;AAExB;AACN;AACK;AAiC1D,wFAAwF;AACxF,8DAA8D;AACvD,MAAMqB,yBAAyB,4BAA4B;AAC3D,MAAMC,oBAAoB,uBAAuB;AACjD,MAAMC,gBAAgB,mBAAmB;AACzC,MAAMC,2BAA2B,gCAAgC;AACjE,MAAMC,8BAA8B,mCAAmC;AACvE,MAAMC,uBAAuB,2BAA2B;AACxD,MAAMC,0BAA0B,8BAA8B;AAC9D,MAAMC,yBAAyB,6BAA6B;AAC5D,MAAMC,4BAA4B,gCAAgC;AAClE,MAAMC,oCAAoC,wCAAwC;AAClF,MAAMC,8BAA8B,yBAAyB;AAQpE,SAASC,QAAQC,KAAqB,EAAEC,MAAuB;IAC3D,IAAIC,WAAWF;IAEf,OAAQC,OAAO,IAAI;QACf,KAAK;YAAsB;gBACvBC,WAAW;oBACP,GAAGA,QAAQ;oBACX,sBAAsB;gBAC1B;gBAEA;YACJ;QACA,KAAK;YAAiB;gBAClBA,WAAW;oBACP,GAAGA,QAAQ;oBACX,iBAAiB;oBACjB,mEAAmE;oBACnE,gCAAgCC,KAAK,GAAG;gBAC5C;gBAEA;YACJ;QACA,KAAK;YAAa;gBACdD,WAAW;oBACP,GAAGA,QAAQ;oBACX,YAAY;gBAChB;gBAEA;YACJ;QACA,KAAK;YAAqB;gBACtBA,WAAW;oBACP,GAAGA,QAAQ;oBACX,mBAAmB;oBACnB,qBAAqBC,KAAK,GAAG;gBACjC;gBAEA;YACJ;QACA,KAAK;YAAwB;gBACzBD,WAAW;oBACP,GAAGA,QAAQ;oBACX,sBAAsB;oBACtB,wBAAwBC,KAAK,GAAG;gBACpC;gBAEA;YACJ;QACA,KAAK;YAAuB;gBACxBD,WAAW;oBACP,GAAGA,QAAQ;oBACX,qBAAqBC,KAAK,GAAG;gBACjC;gBAEA;YACJ;QACA,KAAK;YAA0B;gBAC3BD,WAAW;oBACP,GAAGA,QAAQ;oBACX,wBAAwBC,KAAK,GAAG;gBACpC;gBAEA;YACJ;QACA,KAAK;YAAkC;gBACnCD,WAAW;oBACP,GAAGA,QAAQ;oBACX,gCAAgCC,KAAK,GAAG;gBAC5C;gBAEA;YACJ;QACA,KAAK;YAA0B;gBAC3BD,WAAW;oBACP,GAAGA,QAAQ;oBACX,uBAAuB;gBAC3B;gBAEA;YACJ;QACA,KAAK;YAA6B;gBAC9BA,WAAW;oBACP,GAAGA,QAAQ;oBACX,uBAAuB;gBAC3B;gBAEA;YACJ;QACA,KAAK;YAAmB;gBACpBA,WAAW;oBACP,GAAGA,QAAQ;oBACX,gBAAgB;gBACpB;gBAEA;YACJ;QACA;YAAS;gBACL,MAAM,IAAIE,MAAM,CAAC,4EAA4E,EAAEH,OAAO,IAAI,CAAC,EAAE,CAAC;YAClH;IACJ;IAEA,OAAOC;AACX;AAEO,SAASG;IACZ,MAAMC,oBAAoBtC,gCAAgCA;IAC1D,MAAMuC,qBAAqB/B,iCAAiCA;IAE5D,OAAOD,oBAAoBA,CAAC+B,mBAAmBC;AACnD;AAEO,SAASC;IACZ,MAAMF,oBAAoBtC,gCAAgCA;IAC1D,MAAMuC,qBAAqB/B,iCAAiCA;IAE5D,OAAOF,eAAeA,CAACgC,mBAAmBC;AAC9C;AAEO,SAASE,sCAAsCC,yBAAkC,EAAEC,oBAA6B,EAAEC,QAA2B;IAChJ,MAAMC,SAAS1C,SAASA;IAExB,MAAM2C,4BAA4B5B,cAAcA,CAACL,WAAWA,CAAC;QACzD,IAAIwB,2BAA2B;YAC3BO,SAAS;gBAAE,MAAM;YAAqB;YAEtCC,OACK,QAAQ,CAAC,YACT,QAAQ,CAAC,0BAA0B;gBAChC,OAAO;oBACH,OAAO;oBACP,iBAAiB;gBACrB;YACJ,GACC,QAAQ,CAAC,KAAK;gBACX,cAAc;YAClB,GACC,WAAW;YAEhB,OAAO;QACX;QAEA,OAAO;IACX,GAAG;QAACD;QAAUC;KAAO;IAErB,MAAME,uBAAuB7B,cAAcA,CAACL,WAAWA,CAAC;QACpD,IAAI2B,sBAAsB;YACtBI,SAAS;gBAAE,MAAM;YAAgB;YAEjCC,OACK,QAAQ,CAAC,YACT,QAAQ,CAAC,qBAAqB;gBAC3B,OAAO;oBACH,OAAO;oBACP,iBAAiB;gBACrB;YACJ,GACC,QAAQ,CAAC,KAAK;gBACX,cAAc;YAClB,GACC,WAAW;YAEhB,OAAO;QACX;QAEA,OAAO;IACX,GAAG;QAACD;QAAUC;KAAO;IAErB,OAAO/B,SAASA,CAAC;QACb,IAAI,CAAC4B,2BAA2B;YAC5B3C,+CAA+CA,CAAC+C;YAChDzC,gDAAgDA,CAACyC;QACrD;QAEA,IAAI,CAACH,sBAAsB;YACvB5C,+CAA+CA,CAACgD;YAChD1C,gDAAgDA,CAAC0C;QACrD;QAEA,OAAO;YACH9C,kDAAkDA,CAAC6C;YACnDrC,mDAAmDA,CAACqC;YAEpD7C,kDAAkDA,CAAC8C;YACnDtC,mDAAmDA,CAACsC;QACxD;IACJ,GAAG;QAACL;QAA2BC;QAAsBG;QAA2BC;KAAqB;AACzG;AAEO,SAASC,uBAAuBC,eAAwB,EAAEL,QAA2B;IACxF,MAAMC,SAAS1C,SAASA;IAExB,MAAM+C,mBAAmBhC,cAAcA,CAACL,WAAWA,CAAC;QAChD,IAAIF,UAAUA,IAAI;YACdiC,SAAS;gBAAE,MAAM;YAAY;YAE7BC,OACK,QAAQ,CAAC,YACT,QAAQ,CAAC,gBAAgB;gBACtB,OAAO;oBACH,OAAO;oBACP,iBAAiB;gBACrB;YACJ,GACC,QAAQ,CAAC,KAAK;gBACX,cAAc;YAClB,GACC,WAAW;YAEhB,OAAO;QACX;QAEA,OAAO;IACX,GAAG;QAACD;QAAUC;KAAO;IAErB/B,SAASA,CAAC;QACN,IAAI,CAACmC,iBAAiB;YAClBvC,0BAA0BA,CAACwC;QAC/B;QAEA,OAAO;YACHtC,6BAA6BA,CAACsC;QAClC;IACJ,GAAG;QAACD;QAAiBC;KAAiB;AAC1C;AAEO,SAASC,oCAAoCnB,KAAqB;IACrE,MAAMoB,WAAWlD,WAAWA;IAE5B,MAAMwC,4BAA4BV,MAAM,oBAAoB;IAC5D,MAAMqB,iBAAiBlC,eAAeA,CAACa;IAEvCd,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAI6B,6BAA6B,CAACW,gBAAgB;YAC9CD,SAAS,QAAQ,CAACtB;YAElB,OAAO;QACX;QAEA,OAAO;IACX,GAAG;QAACY;QAA2BW;QAAgBD;KAAS,GAAG;AAC/D;AAEA,IAAIE;AAEJ,8CAA8C;AACvC,SAASC,oCAAoCC,OAAgE;IAChHF,uBAAuBE;AAC3B;AAEA,8CAA8C;AACvC,SAASC;IACZH,uBAAuBI;AAC3B;AAEA,SAASC,wBAAwBC,aAAgC;IAC7D,OAAO7C,OAAOA,CAAC;QACX,OAAOuC,uBAAuBA,qBAAqBM,iBAAiBA;IACxE,GAAG;QAACA;KAAc;AACtB;AAEA,SAASC,2BAA2BC,eAAkC;IAClE,MAAMjB,SAAS1C,SAASA;IACxB,MAAM4D,iBAAiB9C,iBAAiBA;IACxC,MAAMmC,WAAWlD,WAAWA;IAE5B,OAAOW,WAAWA,CAAC,CAACoB;QAChBY,OACK,QAAQ,CAAC,+EACT,UAAU,CAACZ,QACX,KAAK;QAEV8B,eAAe,QAAQ,CAAC9B;QACxBmB,SAAS,QAAQ,CAAC,CAAC,OAAO,EAAEnB,OAAO,IAAI,EAAE;QAEzC6B,gBAAgB7B;IACpB,GAAG;QAAC6B;QAAiBjB;QAAQkB;QAAgBX;KAAS;AAC1D;AAEO,SAASY,oBAAoBC,iBAA0B,EAAEC,oBAA6B;IACzF,MAAMC,UAAU/D,UAAUA;IAC1B,MAAMgD,WAAWlD,WAAWA;IAC5B,MAAM6D,iBAAiB9C,iBAAiBA;IAExC,MAAMmD,gCAAgC/B;IACtC,MAAMgC,2BAA2B7B;IACjC,MAAM8B,sBAAsB3D,UAAUA;IAEtC,2IAA2I;IAC3I,6HAA6H;IAC7HO,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAIuD,+BAA+B;YAC/BL,eAAe,QAAQ,CAAC;gBAAE,MAAM;YAAqB;YACrDX,SAAS,QAAQ,CAAChC;QACtB;QAEA,OAAO;IACX,GAAG;QAACgD;QAA+BL;QAAgBX;KAAS,GAAG;IAE/D,2IAA2I;IAC3I,6HAA6H;IAC7HlC,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAIwD,0BAA0B;YAC1BN,eAAe,QAAQ,CAAC;gBAAE,MAAM;YAAgB;YAChDX,SAAS,QAAQ,CAAC/B;QACtB;QAEA,OAAO;IACX,GAAG;QAACgD;QAA0BN;QAAgBX;KAAS,GAAG;IAE1D,2IAA2I;IAC3I,6HAA6H;IAC7HlC,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAIyD,qBAAqB;YACrBP,eAAe,QAAQ,CAAC;gBAAE,MAAM;YAAY;YAC5CX,SAAS,QAAQ,CAAC9B;QACtB;QAEA,OAAO;IACX,GAAG;QAACgD;QAAqBP;QAAgBX;KAAS,GAAG;IAErD,MAAM,CAACpB,OAAO4B,cAAc,GAAG5C,UAAUA,CAACe,SAAS;QAC/C,YAAYoC,QAAQ,YAAY;QAChCF;QACAC;QACA,4HAA4H;QAC5H,sBAAsBE;QACtB,iBAAiBC;QACjB,YAAYC;QACZ,mBAAmB;QACnB,sBAAsB;QACtB,uBAAuB;QACvB,gBAAgB;IACpB;IAEA,MAAM,EACF,sBAAsB5B,yBAAyB,EAC/C,iBAAiBC,oBAAoB,EACrC,YAAYM,eAAe,EAC9B,GAAGjB;IAEJ,iHAAiH;IACjH,sCAAsC;IACtC,MAAMuC,gBAAgBZ,wBAAwBC;IAC9C,MAAMhB,WAAWiB,2BAA2BU;IAE5C9B,sCAAsCC,2BAA2BC,sBAAsBC;IACvFI,uBAAuBC,iBAAiBL;IACxCO,oCAAoCnB;IAEpC,OAAO;QAACA;QAAOY;KAAS;AAC5B"}
+{"version":3,"file":"AppRouterReducer.js","sources":["webpack://@squide/firefly/./src/AppRouterReducer.ts"],"sourcesContent":["import { addLocalModuleRegistrationStatusChangedListener, getLocalModuleRegistrationStatus, removeLocalModuleRegistrationStatusChangedListener, useEventBus, useLogger, useRuntime } from \"@squide/core\";\nimport { addRemoteModuleRegistrationStatusChangedListener, areModulesReady, areModulesRegistered, getRemoteModuleRegistrationStatus, removeRemoteModuleRegistrationStatusChangedListener } from \"@squide/module-federation\";\nimport { addMswStateChangedListener, isMswReady, removeMswStateChangedListener } from \"@squide/msw\";\nimport { useCallback, useEffect, useMemo, useReducer, type Dispatch } from \"react\";\nimport type { FireflyRuntime } from \"./FireflyRuntime.tsx\";\nimport { useAppRouterStore } from \"./useAppRouterStore.ts\";\nimport { useExecuteOnce } from \"./useExecuteOnce.ts\";\nimport { isBootstrapping } from \"./useIsBootstrapping.ts\";\n\nexport type ActiveRouteVisiblity = \"unknown\" | \"public\" | \"protected\";\n\nexport interface AppRouterWaitState {\n    waitForMsw: boolean;\n    waitForPublicData: boolean;\n    waitForProtectedData: boolean;\n}\n\nexport interface AppRouterState extends AppRouterWaitState {\n    areModulesRegistered: boolean;\n    areModulesReady: boolean;\n    isMswReady: boolean;\n    isPublicDataReady: boolean;\n    isProtectedDataReady: boolean;\n    publicDataUpdatedAt?: number;\n    protectedDataUpdatedAt?: number;\n    deferredRegistrationsUpdatedAt?: number;\n    activeRouteVisibility: ActiveRouteVisiblity;\n    isUnauthorized: boolean;\n}\n\nexport type AppRouterActionType =\n| \"modules-registered\"\n| \"modules-ready\"\n| \"msw-ready\"\n| \"public-data-ready\"\n| \"protected-data-ready\"\n| \"public-data-updated\"\n| \"protected-data-updated\"\n| \"deferred-registrations-updated\"\n| \"active-route-is-public\"\n| \"active-route-is-protected\"\n| \"is-unauthorized\";\n\n// The followings event const are a concatenation of \"squide-\" with AppRouterActionType.\n// They are dispatched by the useEnhancedReducerDispatch hook.\nexport const ModulesRegisteredEvent = \"squide-modules-registered\";\nexport const ModulesReadyEvent = \"squide-modules-ready\";\nexport const MswReadyEvent = \"squide-msw-ready\";\nexport const ActiveRouteIsPublicEvent = \"squide-active-route-is-public\";\nexport const ActiveRouteIsProtectedEvent = \"squide-active-route-is-protected\";\nexport const PublicDataReadyEvent = \"squide-public-data-ready\";\nexport const ProtectedDataReadyEvent = \"squide-protected-data-ready\";\nexport const PublicDataUpdatedEvent = \"squide-public-data-updated\";\nexport const ProtectedDataUpdatedEvent = \"squide-protected-data-updated\";\nexport const DeferredRegistrationsUpdatedEvent = \"squide-deferred-registrations-updated\";\nexport const ApplicationBoostrappedEvent = \"squide-app-boostrapped\";\n\nexport interface AppRouterAction {\n    type: AppRouterActionType;\n    payload?: unknown;\n}\n\nexport type AppRouterDispatch = Dispatch<AppRouterAction>;\n\nfunction reducer(state: AppRouterState, action: AppRouterAction) {\n    let newState = state;\n\n    switch (action.type) {\n        case \"modules-registered\": {\n            newState = {\n                ...newState,\n                areModulesRegistered: true\n            };\n\n            break;\n        }\n        case \"modules-ready\": {\n            newState = {\n                ...newState,\n                areModulesReady: true,\n                // Will be set even if the app is not using deferred registrations.\n                deferredRegistrationsUpdatedAt: Date.now()\n            };\n\n            break;\n        }\n        case \"msw-ready\": {\n            newState = {\n                ...newState,\n                isMswReady: true\n            };\n\n            break;\n        }\n        case \"public-data-ready\": {\n            newState = {\n                ...newState,\n                isPublicDataReady: true,\n                publicDataUpdatedAt: Date.now()\n            };\n\n            break;\n        }\n        case \"protected-data-ready\": {\n            newState = {\n                ...newState,\n                isProtectedDataReady: true,\n                protectedDataUpdatedAt: Date.now()\n            };\n\n            break;\n        }\n        case \"public-data-updated\": {\n            newState = {\n                ...newState,\n                publicDataUpdatedAt: Date.now()\n            };\n\n            break;\n        }\n        case \"protected-data-updated\": {\n            newState = {\n                ...newState,\n                protectedDataUpdatedAt: Date.now()\n            };\n\n            break;\n        }\n        case \"deferred-registrations-updated\": {\n            newState = {\n                ...newState,\n                deferredRegistrationsUpdatedAt: Date.now()\n            };\n\n            break;\n        }\n        case \"active-route-is-public\": {\n            newState = {\n                ...newState,\n                activeRouteVisibility: \"public\"\n            };\n\n            break;\n        }\n        case \"active-route-is-protected\": {\n            newState = {\n                ...newState,\n                activeRouteVisibility: \"protected\"\n            };\n\n            break;\n        }\n        case \"is-unauthorized\": {\n            newState = {\n                ...newState,\n                isUnauthorized: true\n            };\n\n            break;\n        }\n        default: {\n            throw new Error(`[squide] The AppRouter component state reducer doesn't support action type \"${action.type}\".`);\n        }\n    }\n\n    return newState;\n}\n\nexport function getAreModulesRegistered() {\n    const localModuleStatus = getLocalModuleRegistrationStatus();\n    const remoteModuleStatus = getRemoteModuleRegistrationStatus();\n\n    return areModulesRegistered(localModuleStatus, remoteModuleStatus);\n}\n\nexport function getAreModulesReady() {\n    const localModuleStatus = getLocalModuleRegistrationStatus();\n    const remoteModuleStatus = getRemoteModuleRegistrationStatus();\n\n    return areModulesReady(localModuleStatus, remoteModuleStatus);\n}\n\nexport function useModuleRegistrationStatusDispatcher(areModulesRegisteredValue: boolean, areModulesReadyValue: boolean, dispatch: AppRouterDispatch) {\n    const logger = useLogger();\n\n    const dispatchModulesRegistered = useExecuteOnce(useCallback(() => {\n        if (getAreModulesRegistered()) {\n            dispatch({ type: \"modules-registered\" });\n\n            logger\n                .withText(\"[squide] Modules are registered.\", {\n                    style: {\n                        color: \"green\"\n                    }\n                })\n                .information();\n\n            return true;\n        }\n\n        return false;\n    }, [dispatch, logger]));\n\n    const dispatchModulesReady = useExecuteOnce(useCallback(() => {\n        if (getAreModulesReady()) {\n            dispatch({ type: \"modules-ready\" });\n\n            logger\n                .withText(\"[squide] Modules are ready.\", {\n                    style: {\n                        color: \"green\"\n                    }\n                })\n                .information();\n\n            return true;\n        }\n\n        return false;\n    }, [dispatch, logger]));\n\n    return useEffect(() => {\n        if (!areModulesRegisteredValue) {\n            addLocalModuleRegistrationStatusChangedListener(dispatchModulesRegistered);\n            addRemoteModuleRegistrationStatusChangedListener(dispatchModulesRegistered);\n        }\n\n        if (!areModulesReadyValue) {\n            addLocalModuleRegistrationStatusChangedListener(dispatchModulesReady);\n            addRemoteModuleRegistrationStatusChangedListener(dispatchModulesReady);\n        }\n\n        return () => {\n            removeLocalModuleRegistrationStatusChangedListener(dispatchModulesRegistered);\n            removeRemoteModuleRegistrationStatusChangedListener(dispatchModulesRegistered);\n\n            removeLocalModuleRegistrationStatusChangedListener(dispatchModulesReady);\n            removeRemoteModuleRegistrationStatusChangedListener(dispatchModulesReady);\n        };\n    }, [areModulesRegisteredValue, areModulesReadyValue, dispatchModulesRegistered, dispatchModulesReady]);\n}\n\nexport function useMswStatusDispatcher(isMswReadyValue: boolean, dispatch: AppRouterDispatch) {\n    const logger = useLogger();\n\n    const dispatchMswReady = useExecuteOnce(useCallback(() => {\n        if (isMswReady()) {\n            dispatch({ type: \"msw-ready\" });\n\n            logger\n                .withText(\"[squide] MSW is ready.\", {\n                    style: {\n                        color: \"green\"\n                    }\n                })\n                .information();\n\n            return true;\n        }\n\n        return false;\n    }, [dispatch, logger]));\n\n    useEffect(() => {\n        if (!isMswReadyValue) {\n            addMswStateChangedListener(dispatchMswReady);\n        }\n\n        return () => {\n            removeMswStateChangedListener(dispatchMswReady);\n        };\n    }, [isMswReadyValue, dispatchMswReady]);\n}\n\nfunction useBootstrappingCompletedDispatcher(waitState: AppRouterWaitState, state: AppRouterState) {\n    const eventBus = useEventBus();\n\n    const areModulesRegisteredValue = state.areModulesRegistered;\n    const isBoostrapping = isBootstrapping(state);\n\n    useExecuteOnce(useCallback(() => {\n        if (areModulesRegisteredValue && !isBoostrapping) {\n            eventBus.dispatch(ApplicationBoostrappedEvent, waitState);\n\n            return true;\n        }\n\n        return false;\n    }, [areModulesRegisteredValue, isBoostrapping, waitState, eventBus]), true);\n}\n\nlet dispatchProxyFactory: ((reactDispatch: AppRouterDispatch) => AppRouterDispatch) | undefined;\n\n// This function should only be used by tests.\nexport function __setAppReducerDispatchProxyFactory(factory: (reactDispatch: AppRouterDispatch) => AppRouterDispatch) {\n    dispatchProxyFactory = factory;\n}\n\n// This function should only be used by tests.\nexport function __clearAppReducerDispatchProxy() {\n    dispatchProxyFactory = undefined;\n}\n\nfunction useReducerDispatchProxy(reactDispatch: AppRouterDispatch) {\n    return useMemo(() => {\n        return dispatchProxyFactory ? dispatchProxyFactory(reactDispatch) : reactDispatch;\n    }, [reactDispatch]);\n}\n\nfunction useEnhancedReducerDispatch(waitState: AppRouterWaitState, reducerDispatch: AppRouterDispatch) {\n    const logger = useLogger();\n    const appRouterStore = useAppRouterStore();\n    const eventBus = useEventBus();\n\n    return useCallback((action: AppRouterAction) => {\n        logger\n            .withText(\"[squide] The following action has been dispatched to the AppRouter reducer:\")\n            .withObject(action)\n            .debug();\n\n        appRouterStore.dispatch({ ...action, payload: waitState });\n        eventBus.dispatch(`squide-${action.type}`, waitState);\n\n        reducerDispatch(action);\n    }, [waitState, reducerDispatch, logger, appRouterStore, eventBus]);\n}\n\nexport function useAppRouterReducer(waitForPublicData: boolean, waitForProtectedData: boolean): [AppRouterState, AppRouterDispatch] {\n    const runtime = useRuntime() as FireflyRuntime;\n    const eventBus = useEventBus();\n    const appRouterStore = useAppRouterStore();\n\n    const isMswEnabled = runtime.isMswEnabled;\n\n    const areModulesInitiallyRegistered = getAreModulesRegistered();\n    const areModulesInitiallyReady = getAreModulesReady();\n    const isMswInitiallyReady = isMswReady();\n\n    const waitState = useMemo(() => ({\n        waitForMsw: isMswEnabled,\n        waitForPublicData,\n        waitForProtectedData\n    }), [isMswEnabled, waitForPublicData, waitForProtectedData]);\n\n    const initialState = useMemo(() => ({\n        waitForMsw: waitState.waitForMsw,\n        waitForPublicData: waitState.waitForPublicData,\n        waitForProtectedData: waitState.waitForProtectedData,\n        // When the modules registration functions are awaited, the event listeners are registered after the modules are registered.\n        areModulesRegistered: areModulesInitiallyRegistered,\n        areModulesReady: areModulesInitiallyReady,\n        isMswReady: isMswInitiallyReady,\n        isPublicDataReady: false,\n        isProtectedDataReady: false,\n        activeRouteVisibility: \"unknown\",\n        isUnauthorized: false\n    } satisfies AppRouterState), [waitState, areModulesInitiallyRegistered, areModulesInitiallyReady, isMswInitiallyReady]);\n\n    // When modules are initially registered, the reducer action will never be dispatched, therefore the event would not be dispatched as well.\n    // To ensure the bootstrapping events sequencing, the event is manually dispatched when the modules are initially registered.\n    useExecuteOnce(useCallback(() => {\n        if (areModulesInitiallyRegistered) {\n            appRouterStore.dispatch({ type: \"modules-registered\", payload: waitState });\n            eventBus.dispatch(ModulesRegisteredEvent, waitState);\n        }\n\n        return true;\n    }, [areModulesInitiallyRegistered, appRouterStore, eventBus, waitState]), true);\n\n    // When modules are initially registered, the reducer action will never be dispatched, therefore the event would not be dispatched as well.\n    // To ensure the bootstrapping events sequencing, the event is manually dispatched when the modules are initially registered.\n    useExecuteOnce(useCallback(() => {\n        if (areModulesInitiallyReady) {\n            appRouterStore.dispatch({ type: \"modules-ready\", payload: waitState });\n            eventBus.dispatch(ModulesReadyEvent, waitState);\n        }\n\n        return true;\n    }, [areModulesInitiallyReady, appRouterStore, eventBus, waitState]), true);\n\n    // When modules are initially registered, the reducer action will never be dispatched, therefore the event would not be dispatched as well.\n    // To ensure the bootstrapping events sequencing, the event is manually dispatched when the modules are initially registered.\n    useExecuteOnce(useCallback(() => {\n        if (isMswInitiallyReady) {\n            appRouterStore.dispatch({ type: \"msw-ready\", payload: waitState });\n            eventBus.dispatch(MswReadyEvent, waitState);\n        }\n\n        return true;\n    }, [isMswInitiallyReady, appRouterStore, eventBus, waitState]), true);\n\n    const [state, reactDispatch] = useReducer(reducer, initialState);\n\n    const {\n        areModulesRegistered: areModulesRegisteredValue,\n        areModulesReady: areModulesReadyValue,\n        isMswReady: isMswReadyValue\n    } = state;\n\n    // The dispatch proxy is strictly an utility allowing tests to mock the useReducer dispatch function. It's easier\n    // than mocking the import from React.\n    const dispatchProxy = useReducerDispatchProxy(reactDispatch);\n    const dispatch = useEnhancedReducerDispatch(waitState, dispatchProxy);\n\n    useModuleRegistrationStatusDispatcher(areModulesRegisteredValue, areModulesReadyValue, dispatch);\n    useMswStatusDispatcher(isMswReadyValue, dispatch);\n    useBootstrappingCompletedDispatcher(waitState, state);\n\n    return [state, dispatch];\n}\n"],"names":["addLocalModuleRegistrationStatusChangedListener","getLocalModuleRegistrationStatus","removeLocalModuleRegistrationStatusChangedListener","useEventBus","useLogger","useRuntime","addRemoteModuleRegistrationStatusChangedListener","areModulesReady","areModulesRegistered","getRemoteModuleRegistrationStatus","removeRemoteModuleRegistrationStatusChangedListener","addMswStateChangedListener","isMswReady","removeMswStateChangedListener","useCallback","useEffect","useMemo","useReducer","useAppRouterStore","useExecuteOnce","isBootstrapping","ModulesRegisteredEvent","ModulesReadyEvent","MswReadyEvent","ActiveRouteIsPublicEvent","ActiveRouteIsProtectedEvent","PublicDataReadyEvent","ProtectedDataReadyEvent","PublicDataUpdatedEvent","ProtectedDataUpdatedEvent","DeferredRegistrationsUpdatedEvent","ApplicationBoostrappedEvent","reducer","state","action","newState","Date","Error","getAreModulesRegistered","localModuleStatus","remoteModuleStatus","getAreModulesReady","useModuleRegistrationStatusDispatcher","areModulesRegisteredValue","areModulesReadyValue","dispatch","logger","dispatchModulesRegistered","dispatchModulesReady","useMswStatusDispatcher","isMswReadyValue","dispatchMswReady","useBootstrappingCompletedDispatcher","waitState","eventBus","isBoostrapping","dispatchProxyFactory","__setAppReducerDispatchProxyFactory","factory","__clearAppReducerDispatchProxy","undefined","useReducerDispatchProxy","reactDispatch","useEnhancedReducerDispatch","reducerDispatch","appRouterStore","useAppRouterReducer","waitForPublicData","waitForProtectedData","runtime","isMswEnabled","areModulesInitiallyRegistered","areModulesInitiallyReady","isMswInitiallyReady","initialState","dispatchProxy"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAyM;AACmB;AACxH;AACjB;AAExB;AACN;AACK;AAoC1D,wFAAwF;AACxF,8DAA8D;AACvD,MAAMqB,yBAAyB,4BAA4B;AAC3D,MAAMC,oBAAoB,uBAAuB;AACjD,MAAMC,gBAAgB,mBAAmB;AACzC,MAAMC,2BAA2B,gCAAgC;AACjE,MAAMC,8BAA8B,mCAAmC;AACvE,MAAMC,uBAAuB,2BAA2B;AACxD,MAAMC,0BAA0B,8BAA8B;AAC9D,MAAMC,yBAAyB,6BAA6B;AAC5D,MAAMC,4BAA4B,gCAAgC;AAClE,MAAMC,oCAAoC,wCAAwC;AAClF,MAAMC,8BAA8B,yBAAyB;AASpE,SAASC,QAAQC,KAAqB,EAAEC,MAAuB;IAC3D,IAAIC,WAAWF;IAEf,OAAQC,OAAO,IAAI;QACf,KAAK;YAAsB;gBACvBC,WAAW;oBACP,GAAGA,QAAQ;oBACX,sBAAsB;gBAC1B;gBAEA;YACJ;QACA,KAAK;YAAiB;gBAClBA,WAAW;oBACP,GAAGA,QAAQ;oBACX,iBAAiB;oBACjB,mEAAmE;oBACnE,gCAAgCC,KAAK,GAAG;gBAC5C;gBAEA;YACJ;QACA,KAAK;YAAa;gBACdD,WAAW;oBACP,GAAGA,QAAQ;oBACX,YAAY;gBAChB;gBAEA;YACJ;QACA,KAAK;YAAqB;gBACtBA,WAAW;oBACP,GAAGA,QAAQ;oBACX,mBAAmB;oBACnB,qBAAqBC,KAAK,GAAG;gBACjC;gBAEA;YACJ;QACA,KAAK;YAAwB;gBACzBD,WAAW;oBACP,GAAGA,QAAQ;oBACX,sBAAsB;oBACtB,wBAAwBC,KAAK,GAAG;gBACpC;gBAEA;YACJ;QACA,KAAK;YAAuB;gBACxBD,WAAW;oBACP,GAAGA,QAAQ;oBACX,qBAAqBC,KAAK,GAAG;gBACjC;gBAEA;YACJ;QACA,KAAK;YAA0B;gBAC3BD,WAAW;oBACP,GAAGA,QAAQ;oBACX,wBAAwBC,KAAK,GAAG;gBACpC;gBAEA;YACJ;QACA,KAAK;YAAkC;gBACnCD,WAAW;oBACP,GAAGA,QAAQ;oBACX,gCAAgCC,KAAK,GAAG;gBAC5C;gBAEA;YACJ;QACA,KAAK;YAA0B;gBAC3BD,WAAW;oBACP,GAAGA,QAAQ;oBACX,uBAAuB;gBAC3B;gBAEA;YACJ;QACA,KAAK;YAA6B;gBAC9BA,WAAW;oBACP,GAAGA,QAAQ;oBACX,uBAAuB;gBAC3B;gBAEA;YACJ;QACA,KAAK;YAAmB;gBACpBA,WAAW;oBACP,GAAGA,QAAQ;oBACX,gBAAgB;gBACpB;gBAEA;YACJ;QACA;YAAS;gBACL,MAAM,IAAIE,MAAM,CAAC,4EAA4E,EAAEH,OAAO,IAAI,CAAC,EAAE,CAAC;YAClH;IACJ;IAEA,OAAOC;AACX;AAEO,SAASG;IACZ,MAAMC,oBAAoBtC,gCAAgCA;IAC1D,MAAMuC,qBAAqB/B,iCAAiCA;IAE5D,OAAOD,oBAAoBA,CAAC+B,mBAAmBC;AACnD;AAEO,SAASC;IACZ,MAAMF,oBAAoBtC,gCAAgCA;IAC1D,MAAMuC,qBAAqB/B,iCAAiCA;IAE5D,OAAOF,eAAeA,CAACgC,mBAAmBC;AAC9C;AAEO,SAASE,sCAAsCC,yBAAkC,EAAEC,oBAA6B,EAAEC,QAA2B;IAChJ,MAAMC,SAAS1C,SAASA;IAExB,MAAM2C,4BAA4B5B,cAAcA,CAACL,WAAWA,CAAC;QACzD,IAAIwB,2BAA2B;YAC3BO,SAAS;gBAAE,MAAM;YAAqB;YAEtCC,OACK,QAAQ,CAAC,oCAAoC;gBAC1C,OAAO;oBACH,OAAO;gBACX;YACJ,GACC,WAAW;YAEhB,OAAO;QACX;QAEA,OAAO;IACX,GAAG;QAACD;QAAUC;KAAO;IAErB,MAAME,uBAAuB7B,cAAcA,CAACL,WAAWA,CAAC;QACpD,IAAI2B,sBAAsB;YACtBI,SAAS;gBAAE,MAAM;YAAgB;YAEjCC,OACK,QAAQ,CAAC,+BAA+B;gBACrC,OAAO;oBACH,OAAO;gBACX;YACJ,GACC,WAAW;YAEhB,OAAO;QACX;QAEA,OAAO;IACX,GAAG;QAACD;QAAUC;KAAO;IAErB,OAAO/B,SAASA,CAAC;QACb,IAAI,CAAC4B,2BAA2B;YAC5B3C,+CAA+CA,CAAC+C;YAChDzC,gDAAgDA,CAACyC;QACrD;QAEA,IAAI,CAACH,sBAAsB;YACvB5C,+CAA+CA,CAACgD;YAChD1C,gDAAgDA,CAAC0C;QACrD;QAEA,OAAO;YACH9C,kDAAkDA,CAAC6C;YACnDrC,mDAAmDA,CAACqC;YAEpD7C,kDAAkDA,CAAC8C;YACnDtC,mDAAmDA,CAACsC;QACxD;IACJ,GAAG;QAACL;QAA2BC;QAAsBG;QAA2BC;KAAqB;AACzG;AAEO,SAASC,uBAAuBC,eAAwB,EAAEL,QAA2B;IACxF,MAAMC,SAAS1C,SAASA;IAExB,MAAM+C,mBAAmBhC,cAAcA,CAACL,WAAWA,CAAC;QAChD,IAAIF,UAAUA,IAAI;YACdiC,SAAS;gBAAE,MAAM;YAAY;YAE7BC,OACK,QAAQ,CAAC,0BAA0B;gBAChC,OAAO;oBACH,OAAO;gBACX;YACJ,GACC,WAAW;YAEhB,OAAO;QACX;QAEA,OAAO;IACX,GAAG;QAACD;QAAUC;KAAO;IAErB/B,SAASA,CAAC;QACN,IAAI,CAACmC,iBAAiB;YAClBvC,0BAA0BA,CAACwC;QAC/B;QAEA,OAAO;YACHtC,6BAA6BA,CAACsC;QAClC;IACJ,GAAG;QAACD;QAAiBC;KAAiB;AAC1C;AAEA,SAASC,oCAAoCC,SAA6B,EAAEpB,KAAqB;IAC7F,MAAMqB,WAAWnD,WAAWA;IAE5B,MAAMwC,4BAA4BV,MAAM,oBAAoB;IAC5D,MAAMsB,iBAAiBnC,eAAeA,CAACa;IAEvCd,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAI6B,6BAA6B,CAACY,gBAAgB;YAC9CD,SAAS,QAAQ,CAACvB,6BAA6BsB;YAE/C,OAAO;QACX;QAEA,OAAO;IACX,GAAG;QAACV;QAA2BY;QAAgBF;QAAWC;KAAS,GAAG;AAC1E;AAEA,IAAIE;AAEJ,8CAA8C;AACvC,SAASC,oCAAoCC,OAAgE;IAChHF,uBAAuBE;AAC3B;AAEA,8CAA8C;AACvC,SAASC;IACZH,uBAAuBI;AAC3B;AAEA,SAASC,wBAAwBC,aAAgC;IAC7D,OAAO9C,OAAOA,CAAC;QACX,OAAOwC,uBAAuBA,qBAAqBM,iBAAiBA;IACxE,GAAG;QAACA;KAAc;AACtB;AAEA,SAASC,2BAA2BV,SAA6B,EAAEW,eAAkC;IACjG,MAAMlB,SAAS1C,SAASA;IACxB,MAAM6D,iBAAiB/C,iBAAiBA;IACxC,MAAMoC,WAAWnD,WAAWA;IAE5B,OAAOW,WAAWA,CAAC,CAACoB;QAChBY,OACK,QAAQ,CAAC,+EACT,UAAU,CAACZ,QACX,KAAK;QAEV+B,eAAe,QAAQ,CAAC;YAAE,GAAG/B,MAAM;YAAE,SAASmB;QAAU;QACxDC,SAAS,QAAQ,CAAC,CAAC,OAAO,EAAEpB,OAAO,IAAI,EAAE,EAAEmB;QAE3CW,gBAAgB9B;IACpB,GAAG;QAACmB;QAAWW;QAAiBlB;QAAQmB;QAAgBX;KAAS;AACrE;AAEO,SAASY,oBAAoBC,iBAA0B,EAAEC,oBAA6B;IACzF,MAAMC,UAAUhE,UAAUA;IAC1B,MAAMiD,WAAWnD,WAAWA;IAC5B,MAAM8D,iBAAiB/C,iBAAiBA;IAExC,MAAMoD,eAAeD,QAAQ,YAAY;IAEzC,MAAME,gCAAgCjC;IACtC,MAAMkC,2BAA2B/B;IACjC,MAAMgC,sBAAsB7D,UAAUA;IAEtC,MAAMyC,YAAYrC,OAAOA,CAAC,IAAO;YAC7B,YAAYsD;YACZH;YACAC;QACJ,IAAI;QAACE;QAAcH;QAAmBC;KAAqB;IAE3D,MAAMM,eAAe1D,OAAOA,CAAC,IAAO;YAChC,YAAYqC,UAAU,UAAU;YAChC,mBAAmBA,UAAU,iBAAiB;YAC9C,sBAAsBA,UAAU,oBAAoB;YACpD,4HAA4H;YAC5H,sBAAsBkB;YACtB,iBAAiBC;YACjB,YAAYC;YACZ,mBAAmB;YACnB,sBAAsB;YACtB,uBAAuB;YACvB,gBAAgB;QACpB,IAA6B;QAACpB;QAAWkB;QAA+BC;QAA0BC;KAAoB;IAEtH,2IAA2I;IAC3I,6HAA6H;IAC7HtD,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAIyD,+BAA+B;YAC/BN,eAAe,QAAQ,CAAC;gBAAE,MAAM;gBAAsB,SAASZ;YAAU;YACzEC,SAAS,QAAQ,CAACjC,wBAAwBgC;QAC9C;QAEA,OAAO;IACX,GAAG;QAACkB;QAA+BN;QAAgBX;QAAUD;KAAU,GAAG;IAE1E,2IAA2I;IAC3I,6HAA6H;IAC7HlC,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAI0D,0BAA0B;YAC1BP,eAAe,QAAQ,CAAC;gBAAE,MAAM;gBAAiB,SAASZ;YAAU;YACpEC,SAAS,QAAQ,CAAChC,mBAAmB+B;QACzC;QAEA,OAAO;IACX,GAAG;QAACmB;QAA0BP;QAAgBX;QAAUD;KAAU,GAAG;IAErE,2IAA2I;IAC3I,6HAA6H;IAC7HlC,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAI2D,qBAAqB;YACrBR,eAAe,QAAQ,CAAC;gBAAE,MAAM;gBAAa,SAASZ;YAAU;YAChEC,SAAS,QAAQ,CAAC/B,eAAe8B;QACrC;QAEA,OAAO;IACX,GAAG;QAACoB;QAAqBR;QAAgBX;QAAUD;KAAU,GAAG;IAEhE,MAAM,CAACpB,OAAO6B,cAAc,GAAG7C,UAAUA,CAACe,SAAS0C;IAEnD,MAAM,EACF,sBAAsB/B,yBAAyB,EAC/C,iBAAiBC,oBAAoB,EACrC,YAAYM,eAAe,EAC9B,GAAGjB;IAEJ,iHAAiH;IACjH,sCAAsC;IACtC,MAAM0C,gBAAgBd,wBAAwBC;IAC9C,MAAMjB,WAAWkB,2BAA2BV,WAAWsB;IAEvDjC,sCAAsCC,2BAA2BC,sBAAsBC;IACvFI,uBAAuBC,iBAAiBL;IACxCO,oCAAoCC,WAAWpB;IAE/C,OAAO;QAACA;QAAOY;KAAS;AAC5B"}

package/dist/AppRouterStore.d.ts

@@ -1,13 +1,13 @@
-import type { RootLogger } from "@workleap/logging";
+import type { Logger } from "@workleap/logging";
 import type { AppRouterAction, AppRouterState } from "./AppRouterReducer.ts";
 export type AppRouterStoreState = Omit<AppRouterState, "waitForMsw" | "waitForPublicData" | "waitForProtectedData">;
 export type AppRouterStoreListenerFunction = (store: AppRouterStore, unsuscribe: () => void) => void;
 export declare class AppRouterStore {
     #private;
-    constructor(initialialState: AppRouterStoreState, logger: RootLogger);
+    constructor(initialialState: AppRouterStoreState, logger: Logger);
     subscribe(listener: AppRouterStoreListenerFunction): () => void;
     unsuscribe(listener: AppRouterStoreListenerFunction): void;
     dispatch(action: AppRouterAction): void;
     get state(): AppRouterStoreState;
 }
-export declare function createAppRouterStore(logger: RootLogger): AppRouterStore;
+export declare function createAppRouterStore(logger: Logger): AppRouterStore;

package/dist/AppRouterStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppRouterStore.js","sources":["webpack://@squide/firefly/./src/AppRouterStore.ts"],"sourcesContent":["// This file is a low cost port of the AppRouterReducer to a non-React store. It allows, non-React parts of the library to get\n// access to the state and ease the integration with third-party libraries such as the Platform Widgets.\n// Eventually, AppRouterReducer should be deprecated in favor of this new AppRouterStore.\n\nimport type { RootLogger } from \"@workleap/logging\";\nimport type { AppRouterAction, AppRouterState } from \"./AppRouterReducer.ts\";\n\nexport type AppRouterStoreState = Omit<AppRouterState, \"waitForMsw\" | \"waitForPublicData\" | \"waitForProtectedData\">;\n\nexport type AppRouterStoreListenerFunction = (store: AppRouterStore, unsuscribe: () => void) => void;\n\nexport class AppRouterStore {\n    #state: AppRouterStoreState;\n\n    readonly #listeners = new Set<AppRouterStoreListenerFunction>();\n    readonly #logger: RootLogger;\n\n    constructor(initialialState: AppRouterStoreState, logger: RootLogger) {\n        this.#state = initialialState;\n        this.#logger = logger;\n    }\n\n    subscribe(listener: AppRouterStoreListenerFunction) {\n        this.#listeners.add(listener);\n\n        return () => {\n            this.unsuscribe(listener);\n        };\n    }\n\n    unsuscribe(listener: AppRouterStoreListenerFunction) {\n        this.#listeners.delete(listener);\n    }\n\n    dispatch(action: AppRouterAction) {\n        const newState = this.#reducer({ ...this.#state }, action);\n\n        this.#logger\n            .withText(\"[squide] The AppRouterStore state has been updated to:\")\n            .withObject(newState)\n            .debug();\n\n        this.#state = newState;\n\n        // Creating a copy of the listeners in case some are removed during the looping.\n        // To be honest, it might not be necessary, I simply don't know.\n        new Set(this.#listeners).forEach(x => {\n            x(this, () => {\n                this.unsuscribe(x);\n            });\n        });\n    }\n\n    #reducer(state: AppRouterStoreState, action: AppRouterAction) {\n        let newState = state;\n\n        switch (action.type) {\n            case \"modules-registered\": {\n                newState = {\n                    ...newState,\n                    areModulesRegistered: true\n                };\n\n                break;\n            }\n            case \"modules-ready\": {\n                newState = {\n                    ...newState,\n                    areModulesReady: true,\n                    // Will be set even if the app is not using deferred registrations.\n                    deferredRegistrationsUpdatedAt: Date.now()\n                };\n\n                break;\n            }\n            case \"msw-ready\": {\n                newState = {\n                    ...newState,\n                    isMswReady: true\n                };\n\n                break;\n            }\n            case \"public-data-ready\": {\n                newState = {\n                    ...newState,\n                    isPublicDataReady: true,\n                    publicDataUpdatedAt: Date.now()\n                };\n\n                break;\n            }\n            case \"protected-data-ready\": {\n                newState = {\n                    ...newState,\n                    isProtectedDataReady: true,\n                    protectedDataUpdatedAt: Date.now()\n                };\n\n                break;\n            }\n            case \"public-data-updated\": {\n                newState = {\n                    ...newState,\n                    publicDataUpdatedAt: Date.now()\n                };\n\n                break;\n            }\n            case \"protected-data-updated\": {\n                newState = {\n                    ...newState,\n                    protectedDataUpdatedAt: Date.now()\n                };\n\n                break;\n            }\n            case \"deferred-registrations-updated\": {\n                newState = {\n                    ...newState,\n                    deferredRegistrationsUpdatedAt: Date.now()\n                };\n\n                break;\n            }\n            case \"active-route-is-public\": {\n                newState = {\n                    ...newState,\n                    activeRouteVisibility: \"public\"\n                };\n\n                break;\n            }\n            case \"active-route-is-protected\": {\n                newState = {\n                    ...newState,\n                    activeRouteVisibility: \"protected\"\n                };\n\n                break;\n            }\n            case \"is-unauthorized\": {\n                newState = {\n                    ...newState,\n                    isUnauthorized: true\n                };\n\n                break;\n            }\n            default: {\n                throw new Error(`[squide] The AppRouterStore state reducer doesn't support action type \"${action.type}\".`);\n            }\n        }\n\n        return newState;\n    }\n\n    get state() {\n        return this.#state;\n    }\n}\n\nexport function createAppRouterStore(logger: RootLogger) {\n    const initialState: AppRouterStoreState = {\n        areModulesRegistered: false,\n        areModulesReady: false,\n        isMswReady: false,\n        isPublicDataReady: false,\n        isProtectedDataReady: false,\n        activeRouteVisibility: \"unknown\",\n        isUnauthorized: false\n    };\n\n    return new AppRouterStore(initialState, logger);\n}\n"],"names":["AppRouterStore","Set","initialialState","logger","listener","action","newState","x","state","Date","Error","createAppRouterStore","initialState"],"mappings":";;AAAA,8HAA8H;AAC9H,wGAAwG;AACxG,yFAAyF;AASlF,MAAMA;IACT,MAAM,CAAsB;IAEnB,UAAU,GAAG,IAAIC,MAAsC;IACvD,OAAO,CAAa;IAE7B,YAAYC,eAAoC,EAAEC,MAAkB,CAAE;QAClE,IAAI,CAAC,MAAM,GAAGD;QACd,IAAI,CAAC,OAAO,GAAGC;IACnB;IAEA,UAAUC,QAAwC,EAAE;QAChD,IAAI,CAAC,UAAU,CAAC,GAAG,CAACA;QAEpB,OAAO;YACH,IAAI,CAAC,UAAU,CAACA;QACpB;IACJ;IAEA,WAAWA,QAAwC,EAAE;QACjD,IAAI,CAAC,UAAU,CAAC,MAAM,CAACA;IAC3B;IAEA,SAASC,MAAuB,EAAE;QAC9B,MAAMC,WAAW,IAAI,CAAC,QAAQ,CAAC;YAAE,GAAG,IAAI,CAAC,MAAM;QAAC,GAAGD;QAEnD,IAAI,CAAC,OAAO,CACP,QAAQ,CAAC,0DACT,UAAU,CAACC,UACX,KAAK;QAEV,IAAI,CAAC,MAAM,GAAGA;QAEd,gFAAgF;QAChF,gEAAgE;QAChE,IAAIL,IAAI,IAAI,CAAC,UAAU,EAAE,OAAO,CAACM,CAAAA;YAC7BA,EAAE,IAAI,EAAE;gBACJ,IAAI,CAAC,UAAU,CAACA;YACpB;QACJ;IACJ;IAEA,QAAQ,CAACC,KAA0B,EAAEH,MAAuB;QACxD,IAAIC,WAAWE;QAEf,OAAQH,OAAO,IAAI;YACf,KAAK;gBAAsB;oBACvBC,WAAW;wBACP,GAAGA,QAAQ;wBACX,sBAAsB;oBAC1B;oBAEA;gBACJ;YACA,KAAK;gBAAiB;oBAClBA,WAAW;wBACP,GAAGA,QAAQ;wBACX,iBAAiB;wBACjB,mEAAmE;wBACnE,gCAAgCG,KAAK,GAAG;oBAC5C;oBAEA;gBACJ;YACA,KAAK;gBAAa;oBACdH,WAAW;wBACP,GAAGA,QAAQ;wBACX,YAAY;oBAChB;oBAEA;gBACJ;YACA,KAAK;gBAAqB;oBACtBA,WAAW;wBACP,GAAGA,QAAQ;wBACX,mBAAmB;wBACnB,qBAAqBG,KAAK,GAAG;oBACjC;oBAEA;gBACJ;YACA,KAAK;gBAAwB;oBACzBH,WAAW;wBACP,GAAGA,QAAQ;wBACX,sBAAsB;wBACtB,wBAAwBG,KAAK,GAAG;oBACpC;oBAEA;gBACJ;YACA,KAAK;gBAAuB;oBACxBH,WAAW;wBACP,GAAGA,QAAQ;wBACX,qBAAqBG,KAAK,GAAG;oBACjC;oBAEA;gBACJ;YACA,KAAK;gBAA0B;oBAC3BH,WAAW;wBACP,GAAGA,QAAQ;wBACX,wBAAwBG,KAAK,GAAG;oBACpC;oBAEA;gBACJ;YACA,KAAK;gBAAkC;oBACnCH,WAAW;wBACP,GAAGA,QAAQ;wBACX,gCAAgCG,KAAK,GAAG;oBAC5C;oBAEA;gBACJ;YACA,KAAK;gBAA0B;oBAC3BH,WAAW;wBACP,GAAGA,QAAQ;wBACX,uBAAuB;oBAC3B;oBAEA;gBACJ;YACA,KAAK;gBAA6B;oBAC9BA,WAAW;wBACP,GAAGA,QAAQ;wBACX,uBAAuB;oBAC3B;oBAEA;gBACJ;YACA,KAAK;gBAAmB;oBACpBA,WAAW;wBACP,GAAGA,QAAQ;wBACX,gBAAgB;oBACpB;oBAEA;gBACJ;YACA;gBAAS;oBACL,MAAM,IAAII,MAAM,CAAC,uEAAuE,EAAEL,OAAO,IAAI,CAAC,EAAE,CAAC;gBAC7G;QACJ;QAEA,OAAOC;IACX;IAEA,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,MAAM;IACtB;AACJ;AAEO,SAASK,qBAAqBR,MAAkB;IACnD,MAAMS,eAAoC;QACtC,sBAAsB;QACtB,iBAAiB;QACjB,YAAY;QACZ,mBAAmB;QACnB,sBAAsB;QACtB,uBAAuB;QACvB,gBAAgB;IACpB;IAEA,OAAO,IAAIZ,eAAeY,cAAcT;AAC5C"}
+{"version":3,"file":"AppRouterStore.js","sources":["webpack://@squide/firefly/./src/AppRouterStore.ts"],"sourcesContent":["// This file is a low cost port of the AppRouterReducer to a non-React store. It allows, non-React parts of the library to get\n// access to the state and ease the integration with third-party libraries such as the Platform Widgets.\n// Eventually, AppRouterReducer should be deprecated in favor of this new AppRouterStore.\n\nimport type { Logger } from \"@workleap/logging\";\nimport type { AppRouterAction, AppRouterState } from \"./AppRouterReducer.ts\";\n\nexport type AppRouterStoreState = Omit<AppRouterState, \"waitForMsw\" | \"waitForPublicData\" | \"waitForProtectedData\">;\n\nexport type AppRouterStoreListenerFunction = (store: AppRouterStore, unsuscribe: () => void) => void;\n\nexport class AppRouterStore {\n    #state: AppRouterStoreState;\n\n    readonly #listeners = new Set<AppRouterStoreListenerFunction>();\n    readonly #logger: Logger;\n\n    constructor(initialialState: AppRouterStoreState, logger: Logger) {\n        this.#state = initialialState;\n        this.#logger = logger;\n    }\n\n    subscribe(listener: AppRouterStoreListenerFunction) {\n        this.#listeners.add(listener);\n\n        return () => {\n            this.unsuscribe(listener);\n        };\n    }\n\n    unsuscribe(listener: AppRouterStoreListenerFunction) {\n        this.#listeners.delete(listener);\n    }\n\n    dispatch(action: AppRouterAction) {\n        const newState = this.#reducer({ ...this.#state }, action);\n\n        this.#logger\n            .withText(\"[squide] The AppRouterStore state has been updated to:\")\n            .withObject(newState)\n            .debug();\n\n        this.#state = newState;\n\n        // Creating a copy of the listeners in case some are removed during the looping.\n        // To be honest, it might not be necessary, I simply don't know.\n        new Set(this.#listeners).forEach(x => {\n            x(this, () => {\n                this.unsuscribe(x);\n            });\n        });\n    }\n\n    #reducer(state: AppRouterStoreState, action: AppRouterAction) {\n        let newState = state;\n\n        switch (action.type) {\n            case \"modules-registered\": {\n                newState = {\n                    ...newState,\n                    areModulesRegistered: true\n                };\n\n                break;\n            }\n            case \"modules-ready\": {\n                newState = {\n                    ...newState,\n                    areModulesReady: true,\n                    // Will be set even if the app is not using deferred registrations.\n                    deferredRegistrationsUpdatedAt: Date.now()\n                };\n\n                break;\n            }\n            case \"msw-ready\": {\n                newState = {\n                    ...newState,\n                    isMswReady: true\n                };\n\n                break;\n            }\n            case \"public-data-ready\": {\n                newState = {\n                    ...newState,\n                    isPublicDataReady: true,\n                    publicDataUpdatedAt: Date.now()\n                };\n\n                break;\n            }\n            case \"protected-data-ready\": {\n                newState = {\n                    ...newState,\n                    isProtectedDataReady: true,\n                    protectedDataUpdatedAt: Date.now()\n                };\n\n                break;\n            }\n            case \"public-data-updated\": {\n                newState = {\n                    ...newState,\n                    publicDataUpdatedAt: Date.now()\n                };\n\n                break;\n            }\n            case \"protected-data-updated\": {\n                newState = {\n                    ...newState,\n                    protectedDataUpdatedAt: Date.now()\n                };\n\n                break;\n            }\n            case \"deferred-registrations-updated\": {\n                newState = {\n                    ...newState,\n                    deferredRegistrationsUpdatedAt: Date.now()\n                };\n\n                break;\n            }\n            case \"active-route-is-public\": {\n                newState = {\n                    ...newState,\n                    activeRouteVisibility: \"public\"\n                };\n\n                break;\n            }\n            case \"active-route-is-protected\": {\n                newState = {\n                    ...newState,\n                    activeRouteVisibility: \"protected\"\n                };\n\n                break;\n            }\n            case \"is-unauthorized\": {\n                newState = {\n                    ...newState,\n                    isUnauthorized: true\n                };\n\n                break;\n            }\n            default: {\n                throw new Error(`[squide] The AppRouterStore state reducer doesn't support action type \"${action.type}\".`);\n            }\n        }\n\n        return newState;\n    }\n\n    get state() {\n        return this.#state;\n    }\n}\n\nexport function createAppRouterStore(logger: Logger) {\n    const initialState: AppRouterStoreState = {\n        areModulesRegistered: false,\n        areModulesReady: false,\n        isMswReady: false,\n        isPublicDataReady: false,\n        isProtectedDataReady: false,\n        activeRouteVisibility: \"unknown\",\n        isUnauthorized: false\n    };\n\n    return new AppRouterStore(initialState, logger);\n}\n"],"names":["AppRouterStore","Set","initialialState","logger","listener","action","newState","x","state","Date","Error","createAppRouterStore","initialState"],"mappings":";;AAAA,8HAA8H;AAC9H,wGAAwG;AACxG,yFAAyF;AASlF,MAAMA;IACT,MAAM,CAAsB;IAEnB,UAAU,GAAG,IAAIC,MAAsC;IACvD,OAAO,CAAS;IAEzB,YAAYC,eAAoC,EAAEC,MAAc,CAAE;QAC9D,IAAI,CAAC,MAAM,GAAGD;QACd,IAAI,CAAC,OAAO,GAAGC;IACnB;IAEA,UAAUC,QAAwC,EAAE;QAChD,IAAI,CAAC,UAAU,CAAC,GAAG,CAACA;QAEpB,OAAO;YACH,IAAI,CAAC,UAAU,CAACA;QACpB;IACJ;IAEA,WAAWA,QAAwC,EAAE;QACjD,IAAI,CAAC,UAAU,CAAC,MAAM,CAACA;IAC3B;IAEA,SAASC,MAAuB,EAAE;QAC9B,MAAMC,WAAW,IAAI,CAAC,QAAQ,CAAC;YAAE,GAAG,IAAI,CAAC,MAAM;QAAC,GAAGD;QAEnD,IAAI,CAAC,OAAO,CACP,QAAQ,CAAC,0DACT,UAAU,CAACC,UACX,KAAK;QAEV,IAAI,CAAC,MAAM,GAAGA;QAEd,gFAAgF;QAChF,gEAAgE;QAChE,IAAIL,IAAI,IAAI,CAAC,UAAU,EAAE,OAAO,CAACM,CAAAA;YAC7BA,EAAE,IAAI,EAAE;gBACJ,IAAI,CAAC,UAAU,CAACA;YACpB;QACJ;IACJ;IAEA,QAAQ,CAACC,KAA0B,EAAEH,MAAuB;QACxD,IAAIC,WAAWE;QAEf,OAAQH,OAAO,IAAI;YACf,KAAK;gBAAsB;oBACvBC,WAAW;wBACP,GAAGA,QAAQ;wBACX,sBAAsB;oBAC1B;oBAEA;gBACJ;YACA,KAAK;gBAAiB;oBAClBA,WAAW;wBACP,GAAGA,QAAQ;wBACX,iBAAiB;wBACjB,mEAAmE;wBACnE,gCAAgCG,KAAK,GAAG;oBAC5C;oBAEA;gBACJ;YACA,KAAK;gBAAa;oBACdH,WAAW;wBACP,GAAGA,QAAQ;wBACX,YAAY;oBAChB;oBAEA;gBACJ;YACA,KAAK;gBAAqB;oBACtBA,WAAW;wBACP,GAAGA,QAAQ;wBACX,mBAAmB;wBACnB,qBAAqBG,KAAK,GAAG;oBACjC;oBAEA;gBACJ;YACA,KAAK;gBAAwB;oBACzBH,WAAW;wBACP,GAAGA,QAAQ;wBACX,sBAAsB;wBACtB,wBAAwBG,KAAK,GAAG;oBACpC;oBAEA;gBACJ;YACA,KAAK;gBAAuB;oBACxBH,WAAW;wBACP,GAAGA,QAAQ;wBACX,qBAAqBG,KAAK,GAAG;oBACjC;oBAEA;gBACJ;YACA,KAAK;gBAA0B;oBAC3BH,WAAW;wBACP,GAAGA,QAAQ;wBACX,wBAAwBG,KAAK,GAAG;oBACpC;oBAEA;gBACJ;YACA,KAAK;gBAAkC;oBACnCH,WAAW;wBACP,GAAGA,QAAQ;wBACX,gCAAgCG,KAAK,GAAG;oBAC5C;oBAEA;gBACJ;YACA,KAAK;gBAA0B;oBAC3BH,WAAW;wBACP,GAAGA,QAAQ;wBACX,uBAAuB;oBAC3B;oBAEA;gBACJ;YACA,KAAK;gBAA6B;oBAC9BA,WAAW;wBACP,GAAGA,QAAQ;wBACX,uBAAuB;oBAC3B;oBAEA;gBACJ;YACA,KAAK;gBAAmB;oBACpBA,WAAW;wBACP,GAAGA,QAAQ;wBACX,gBAAgB;oBACpB;oBAEA;gBACJ;YACA;gBAAS;oBACL,MAAM,IAAII,MAAM,CAAC,uEAAuE,EAAEL,OAAO,IAAI,CAAC,EAAE,CAAC;gBAC7G;QACJ;QAEA,OAAOC;IACX;IAEA,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,MAAM;IACtB;AACJ;AAEO,SAASK,qBAAqBR,MAAc;IAC/C,MAAMS,eAAoC;QACtC,sBAAsB;QACtB,iBAAiB;QACjB,YAAY;QACZ,mBAAmB;QACnB,sBAAsB;QACtB,uBAAuB;QACvB,gBAAgB;IACpB;IAEA,OAAO,IAAIZ,eAAeY,cAAcT;AAC5C"}

package/dist/FireflyRuntime.d.ts

@@ -1,16 +1,33 @@
-import type { RegisterRouteOptions, RuntimeOptions } from "@squide/core";
-import { ReactRouterRuntime, type Route } from "@squide/react-router";
+import type { RegisterRouteOptions, RuntimeMethodOptions, RuntimeOptions } from "@squide/core";
+import { type IReactRouterRuntime, ReactRouterRuntime, ReactRouterRuntimeScope, type Route } from "@squide/react-router";
+import type { Logger } from "@workleap/logging";
 import type { RequestHandler } from "msw";
 import { type AppRouterStore } from "./AppRouterStore.ts";
 export interface FireflyRuntimeOptions extends RuntimeOptions {
     useMsw?: boolean;
 }
-export declare class FireflyRuntime extends ReactRouterRuntime {
-    #private;
+export interface RegisterRequestHandlersOptions extends RuntimeMethodOptions {
+}
+export interface IFireflyRuntime extends IReactRouterRuntime {
+    registerRequestHandlers: (handlers: RequestHandler[]) => void;
+    get requestHandlers(): RequestHandler[];
+    get appRouterStore(): AppRouterStore;
+    get isMswEnabled(): boolean;
+}
+export declare class FireflyRuntime extends ReactRouterRuntime implements IFireflyRuntime {
+    protected _appRouterStore: AppRouterStore;
+    protected _useMsw: boolean;
     constructor({ plugins, useMsw, ...options }?: FireflyRuntimeOptions);
-    registerRequestHandlers(handlers: RequestHandler[]): void;
+    registerRequestHandlers(handlers: RequestHandler[], options?: RegisterRequestHandlersOptions): void;
     get requestHandlers(): RequestHandler[];
     registerRoute(route: Route, options?: RegisterRouteOptions): void;
     get appRouterStore(): AppRouterStore;
     get isMswEnabled(): boolean;
+    startScope(logger: Logger): FireflyRuntime;
+}
+export declare class FireflyRuntimeScope<TRuntime extends FireflyRuntime = FireflyRuntime> extends ReactRouterRuntimeScope<TRuntime> implements IFireflyRuntime {
+    registerRequestHandlers(handlers: RequestHandler[], options?: RegisterRequestHandlersOptions): void;
+    get requestHandlers(): RequestHandler[];
+    get appRouterStore(): AppRouterStore;
+    get isMswEnabled(): boolean;
 }

package/dist/FireflyRuntime.js

@@ -1,5 +1,5 @@
 import { MswPlugin, MswPluginName } from "@squide/msw";
-import { ReactRouterRuntime } from "@squide/react-router";
+import { ReactRouterRuntime, ReactRouterRuntimeScope } from "@squide/react-router";
 import { getAreModulesRegistered } from "./AppRouterReducer.js";
 import { createAppRouterStore } from "./AppRouterStore.js";
 
@@ -17,8 +17,8 @@ import { createAppRouterStore } from "./AppRouterStore.js";
 
 
 class FireflyRuntime extends ReactRouterRuntime {
-    #appRouterStore;
-    #useMsw;
+    _appRouterStore;
+    _useMsw;
     constructor({ plugins, useMsw, ...options } = {}){
         if (useMsw) {
             super({
@@ -28,17 +28,18 @@ class FireflyRuntime extends ReactRouterRuntime {
                 ],
                 ...options
             });
-            this.#useMsw = true;
+            this._useMsw = true;
         } else {
             super({
                 plugins,
                 ...options
             });
-            this.#useMsw = false;
+            this._useMsw = false;
         }
-        this.#appRouterStore = createAppRouterStore(this._logger);
+        this._appRouterStore = createAppRouterStore(this._logger);
     }
-    registerRequestHandlers(handlers) {
+    registerRequestHandlers(handlers, options = {}) {
+        const logger = this._getLogger(options);
         const mswPlugin = this.getPlugin(MswPluginName);
         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?");
@@ -46,7 +47,9 @@ class FireflyRuntime extends ReactRouterRuntime {
         if (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.");
         }
-        mswPlugin.registerRequestHandlers(handlers);
+        mswPlugin.registerRequestHandlers(handlers, {
+            logger
+        });
     }
     // Must define a return type otherwise we get an "error TS2742: The inferred type of 'requestHandlers' cannot be named" error.
     get requestHandlers() {
@@ -63,13 +66,33 @@ class FireflyRuntime extends ReactRouterRuntime {
         super.registerRoute(route, options);
     }
     get appRouterStore() {
-        return this.#appRouterStore;
+        return this._appRouterStore;
     }
     get isMswEnabled() {
-        return this.#useMsw;
+        return this._useMsw;
+    }
+    startScope(logger) {
+        return new FireflyRuntimeScope(this, logger);
+    }
+}
+class FireflyRuntimeScope extends ReactRouterRuntimeScope {
+    registerRequestHandlers(handlers, options = {}) {
+        this._runtime.registerRequestHandlers(handlers, {
+            ...options,
+            logger: this._getLogger(options)
+        });
+    }
+    get requestHandlers() {
+        return this._runtime.requestHandlers;
+    }
+    get appRouterStore() {
+        return this._runtime.appRouterStore;
+    }
+    get isMswEnabled() {
+        return this._runtime.isMswEnabled;
     }
 }
 
-export { FireflyRuntime };
+export { FireflyRuntime, FireflyRuntimeScope };
 
 //# sourceMappingURL=FireflyRuntime.js.map