@squide/firefly 16.0.3 → 16.1.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @squide/firefly
 
+## 16.1.0
+
+### Minor Changes
+
+- [#352](https://github.com/workleap/wl-squide/pull/352) [`7bd7af5`](https://github.com/workleap/wl-squide/commit/7bd7af5a757912309704b9e93bf8ecf1388e6787) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Added support for LaunchDarkly feature flags.
+
+### Patch Changes
+
+- Updated dependencies [[`7bd7af5`](https://github.com/workleap/wl-squide/commit/7bd7af5a757912309704b9e93bf8ecf1388e6787), [`7bd7af5`](https://github.com/workleap/wl-squide/commit/7bd7af5a757912309704b9e93bf8ecf1388e6787)]:
+  - @squide/react-router@8.1.7
+  - @squide/env-vars@1.4.10
+  - @squide/core@6.1.7
+  - @squide/msw@4.0.8
+  - @squide/launch-darkly@1.0.0
+
 ## 16.0.3
 
 ### Patch Changes

package/dist/AppRouter.js

@@ -68,7 +68,7 @@ function AppRouter(props) {
         isEnabled: strictMode
     });
     useEffect(()=>{
-        logger.withText("[squide] AppRouter state updated:").withObject(state).debug();
+        logger.withText("[squide] AppRouter state has been updated to:").withObject(state).debug();
     }, [
         state,
         logger

package/dist/AppRouter.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppRouter.js","sources":["../src/AppRouter.tsx"],"sourcesContent":["import { useLogger } from \"@squide/core\";\nimport { useRoutes, type Route } from \"@squide/react-router\";\nimport { useEffect, useMemo, type ReactElement } from \"react\";\nimport type { RouterProviderProps } from \"react-router/dom\";\nimport { AppRouterDispatcherContext, AppRouterStateContext } from \"./AppRouterContext.ts\";\nimport { useAppRouterReducer, type AppRouterState } from \"./AppRouterReducer.ts\";\nimport { RootRoute } from \"./RootRoute.tsx\";\nimport { useStrictRegistrationMode } from \"./useStrictRegistrationMode.ts\";\n\nexport interface AppRouterRenderFunctionArgs {\n    routes: Route[];\n}\n\nexport interface RenderRouterProviderFunctionArgs {\n    rootRoute: ReactElement;\n    registeredRoutes: Route[];\n    routerProviderProps: Omit<RouterProviderProps, \"router\">;\n}\n\nexport type RenderRouterProviderFunction = (args: RenderRouterProviderFunctionArgs) => ReactElement;\n\nexport function useCanRenderRouter({ areModulesRegistered, areModulesReady: areModulesReadyValue }: AppRouterState) {\n    return (\n        // Wait until the modules has been registered, but do not wait for the deferred registrations to be registered has they will probably\n        // depends on the protected data.\n        (areModulesRegistered || areModulesReadyValue)\n    );\n}\n\nfunction useRenderRouterProvider(state: AppRouterState, renderRouterProvider: RenderRouterProviderFunction, strictMode: boolean) {\n    const routes = useRoutes();\n\n    // The value is computed outside of the router provider memo to prevent\n    // rendering a new router provider everytime the app router state change.\n    const canRenderRouter = useCanRenderRouter(state);\n\n    return useMemo(() => {\n        if (canRenderRouter) {\n            return renderRouterProvider({\n                rootRoute: <RootRoute strictMode={strictMode} />,\n                registeredRoutes: routes,\n                routerProviderProps: {}\n            });\n        }\n\n        return null;\n    }, [canRenderRouter, routes, renderRouterProvider, strictMode]);\n}\n\nexport interface AppRouterProps {\n    waitForPublicData?: boolean;\n    waitForProtectedData?: boolean;\n    strictMode?: boolean;\n    children: RenderRouterProviderFunction;\n}\n\nexport function AppRouter(props: AppRouterProps) {\n    const {\n        waitForPublicData = false,\n        waitForProtectedData = false,\n        strictMode = true,\n        children: renderRouterProvider\n    } = props;\n    const [state, dispatch] = useAppRouterReducer(waitForPublicData, waitForProtectedData);\n\n    const logger = useLogger();\n\n    useStrictRegistrationMode({\n        isEnabled: strictMode\n    });\n\n    useEffect(() => {\n        logger\n            .withText(\"[squide] AppRouter state updated:\")\n            .withObject(state)\n            .debug();\n    }, [state, logger]);\n\n    const routerProvider = useRenderRouterProvider(state, renderRouterProvider, strictMode);\n\n    return (\n        <AppRouterDispatcherContext.Provider value={dispatch}>\n            <AppRouterStateContext.Provider value={state}>\n                {routerProvider}\n            </AppRouterStateContext.Provider>\n        </AppRouterDispatcherContext.Provider>\n    );\n}\n"],"names":["useLogger","useRoutes","useEffect","useMemo","AppRouterDispatcherContext","AppRouterStateContext","useAppRouterReducer","RootRoute","useStrictRegistrationMode","useCanRenderRouter","areModulesRegistered","areModulesReadyValue","useRenderRouterProvider","state","renderRouterProvider","strictMode","routes","canRenderRouter","AppRouter","props","waitForPublicData","waitForProtectedData","dispatch","logger","routerProvider"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAyC;AACoB;AACC;AAE4B;AACT;AACrC;AAC+B;AAcpE,SAASS,mBAAmB,EAAEC,oBAAoB,EAAE,iBAAiBC,oBAAoB,EAAkB;IAC9G,OACI,qIAAqI;IACrI,iCAAiC;IAChCD,wBAAwBC;AAEjC;AAEA,SAASC,wBAAwBC,KAAqB,EAAEC,oBAAkD,EAAEC,UAAmB;IAC3H,MAAMC,SAASf,SAASA;IAExB,uEAAuE;IACvE,yEAAyE;IACzE,MAAMgB,kBAAkBR,mBAAmBI;IAE3C,OAAOV,OAAOA,CAAC;QACX,IAAIc,iBAAiB;YACjB,OAAOH,qBAAqB;gBACxB,yBAAW,IAACP,SAASA;oBAAC,YAAYQ;;gBAClC,kBAAkBC;gBAClB,qBAAqB,CAAC;YAC1B;QACJ;QAEA,OAAO;IACX,GAAG;QAACC;QAAiBD;QAAQF;QAAsBC;KAAW;AAClE;AASO,SAASG,UAAUC,KAAqB;IAC3C,MAAM,EACFC,oBAAoB,KAAK,EACzBC,uBAAuB,KAAK,EAC5BN,aAAa,IAAI,EACjB,UAAUD,oBAAoB,EACjC,GAAGK;IACJ,MAAM,CAACN,OAAOS,SAAS,GAAGhB,mBAAmBA,CAACc,mBAAmBC;IAEjE,MAAME,SAASvB,SAASA;IAExBQ,yBAAyBA,CAAC;QACtB,WAAWO;IACf;IAEAb,SAASA,CAAC;QACNqB,OACK,QAAQ,CAAC,qCACT,UAAU,CAACV,OACX,KAAK;IACd,GAAG;QAACA;QAAOU;KAAO;IAElB,MAAMC,iBAAiBZ,wBAAwBC,OAAOC,sBAAsBC;IAE5E,qBACI,IAACX,mCAAmC;QAAC,OAAOkB;kBACxC,kBAACjB,8BAA8B;YAAC,OAAOQ;sBAClCW;;;AAIjB"}
+{"version":3,"file":"AppRouter.js","sources":["../src/AppRouter.tsx"],"sourcesContent":["import { useLogger } from \"@squide/core\";\nimport { useRoutes, type Route } from \"@squide/react-router\";\nimport { useEffect, useMemo, type ReactElement } from \"react\";\nimport type { RouterProviderProps } from \"react-router/dom\";\nimport { AppRouterDispatcherContext, AppRouterStateContext } from \"./AppRouterContext.ts\";\nimport { useAppRouterReducer, type AppRouterState } from \"./AppRouterReducer.ts\";\nimport { RootRoute } from \"./RootRoute.tsx\";\nimport { useStrictRegistrationMode } from \"./useStrictRegistrationMode.ts\";\n\nexport interface AppRouterRenderFunctionArgs {\n    routes: Route[];\n}\n\nexport interface RenderRouterProviderFunctionArgs {\n    rootRoute: ReactElement;\n    registeredRoutes: Route[];\n    routerProviderProps: Omit<RouterProviderProps, \"router\">;\n}\n\nexport type RenderRouterProviderFunction = (args: RenderRouterProviderFunctionArgs) => ReactElement;\n\nexport function useCanRenderRouter({ areModulesRegistered, areModulesReady: areModulesReadyValue }: AppRouterState) {\n    return (\n        // Wait until the modules has been registered, but do not wait for the deferred registrations to be registered has they will probably\n        // depends on the protected data.\n        (areModulesRegistered || areModulesReadyValue)\n    );\n}\n\nfunction useRenderRouterProvider(state: AppRouterState, renderRouterProvider: RenderRouterProviderFunction, strictMode: boolean) {\n    const routes = useRoutes();\n\n    // The value is computed outside of the router provider memo to prevent\n    // rendering a new router provider everytime the app router state change.\n    const canRenderRouter = useCanRenderRouter(state);\n\n    return useMemo(() => {\n        if (canRenderRouter) {\n            return renderRouterProvider({\n                rootRoute: <RootRoute strictMode={strictMode} />,\n                registeredRoutes: routes,\n                routerProviderProps: {}\n            });\n        }\n\n        return null;\n    }, [canRenderRouter, routes, renderRouterProvider, strictMode]);\n}\n\nexport interface AppRouterProps {\n    waitForPublicData?: boolean;\n    waitForProtectedData?: boolean;\n    strictMode?: boolean;\n    children: RenderRouterProviderFunction;\n}\n\nexport function AppRouter(props: AppRouterProps) {\n    const {\n        waitForPublicData = false,\n        waitForProtectedData = false,\n        strictMode = true,\n        children: renderRouterProvider\n    } = props;\n    const [state, dispatch] = useAppRouterReducer(waitForPublicData, waitForProtectedData);\n\n    const logger = useLogger();\n\n    useStrictRegistrationMode({\n        isEnabled: strictMode\n    });\n\n    useEffect(() => {\n        logger\n            .withText(\"[squide] AppRouter state has been updated to:\")\n            .withObject(state)\n            .debug();\n    }, [state, logger]);\n\n    const routerProvider = useRenderRouterProvider(state, renderRouterProvider, strictMode);\n\n    return (\n        <AppRouterDispatcherContext.Provider value={dispatch}>\n            <AppRouterStateContext.Provider value={state}>\n                {routerProvider}\n            </AppRouterStateContext.Provider>\n        </AppRouterDispatcherContext.Provider>\n    );\n}\n"],"names":["useLogger","useRoutes","useEffect","useMemo","AppRouterDispatcherContext","AppRouterStateContext","useAppRouterReducer","RootRoute","useStrictRegistrationMode","useCanRenderRouter","areModulesRegistered","areModulesReadyValue","useRenderRouterProvider","state","renderRouterProvider","strictMode","routes","canRenderRouter","AppRouter","props","waitForPublicData","waitForProtectedData","dispatch","logger","routerProvider"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAAyC;AACoB;AACC;AAE4B;AACT;AACrC;AAC+B;AAcpE,SAASS,mBAAmB,EAAEC,oBAAoB,EAAE,iBAAiBC,oBAAoB,EAAkB;IAC9G,OACI,qIAAqI;IACrI,iCAAiC;IAChCD,wBAAwBC;AAEjC;AAEA,SAASC,wBAAwBC,KAAqB,EAAEC,oBAAkD,EAAEC,UAAmB;IAC3H,MAAMC,SAASf,SAASA;IAExB,uEAAuE;IACvE,yEAAyE;IACzE,MAAMgB,kBAAkBR,mBAAmBI;IAE3C,OAAOV,OAAOA,CAAC;QACX,IAAIc,iBAAiB;YACjB,OAAOH,qBAAqB;gBACxB,yBAAW,IAACP,SAASA;oBAAC,YAAYQ;;gBAClC,kBAAkBC;gBAClB,qBAAqB,CAAC;YAC1B;QACJ;QAEA,OAAO;IACX,GAAG;QAACC;QAAiBD;QAAQF;QAAsBC;KAAW;AAClE;AASO,SAASG,UAAUC,KAAqB;IAC3C,MAAM,EACFC,oBAAoB,KAAK,EACzBC,uBAAuB,KAAK,EAC5BN,aAAa,IAAI,EACjB,UAAUD,oBAAoB,EACjC,GAAGK;IACJ,MAAM,CAACN,OAAOS,SAAS,GAAGhB,mBAAmBA,CAACc,mBAAmBC;IAEjE,MAAME,SAASvB,SAASA;IAExBQ,yBAAyBA,CAAC;QACtB,WAAWO;IACf;IAEAb,SAASA,CAAC;QACNqB,OACK,QAAQ,CAAC,iDACT,UAAU,CAACV,OACX,KAAK;IACd,GAAG;QAACA;QAAOU;KAAO;IAElB,MAAMC,iBAAiBZ,wBAAwBC,OAAOC,sBAAsBC;IAE5E,qBACI,IAACX,mCAAmC;QAAC,OAAOkB;kBACxC,kBAACjB,8BAA8B;YAAC,OAAOQ;sBAClCW;;;AAIjB"}

package/dist/AppRouterContext.js

@@ -1,7 +1,7 @@
-import { isNil } from "@squide/core";
+import { isNil } from "@squide/core/internal";
 import { createContext, useContext } from "react";
 
-;// CONCATENATED MODULE: external "@squide/core"
+;// CONCATENATED MODULE: external "@squide/core/internal"
 
 ;// CONCATENATED MODULE: external "react"
 

package/dist/AppRouterContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppRouterContext.js","sources":["../src/AppRouterContext.ts"],"sourcesContent":["import { isNil } from \"@squide/core\";\nimport { createContext, useContext } from \"react\";\nimport type { AppRouterDispatch, AppRouterState } from \"./AppRouterReducer.ts\";\n\nexport const AppRouterStateContext = createContext<AppRouterState | undefined>(undefined);\n\nexport function useAppRouterState() {\n    const state = useContext(AppRouterStateContext);\n\n    if (isNil(state)) {\n        throw new Error(\"[squide] The useAppRouterState hook must be called by a children of the AppRouter component.\");\n    }\n\n    return state;\n}\n\nexport const AppRouterDispatcherContext = createContext<AppRouterDispatch | undefined>(undefined);\n\nexport function useAppRouterDispatcher() {\n    const dispatch = useContext(AppRouterDispatcherContext);\n\n    if (isNil(dispatch)) {\n        throw new Error(\"[squide] The useAppRouterDispatcher hook must be called by a children of the AppRouter component.\");\n    }\n\n    return dispatch;\n}\n"],"names":["isNil","createContext","useContext","AppRouterStateContext","undefined","useAppRouterState","state","Error","AppRouterDispatcherContext","useAppRouterDispatcher","dispatch"],"mappings":";;;;;;;;AAAqC;AACa;AAG3C,MAAMG,wBAAwBF,aAAaA,CAA6BG,WAAW;AAEnF,SAASC;IACZ,MAAMC,QAAQJ,UAAUA,CAACC;IAEzB,IAAIH,KAAKA,CAACM,QAAQ;QACd,MAAM,IAAIC,MAAM;IACpB;IAEA,OAAOD;AACX;AAEO,MAAME,6BAA6BP,aAAaA,CAAgCG,WAAW;AAE3F,SAASK;IACZ,MAAMC,WAAWR,UAAUA,CAACM;IAE5B,IAAIR,KAAKA,CAACU,WAAW;QACjB,MAAM,IAAIH,MAAM;IACpB;IAEA,OAAOG;AACX"}
+{"version":3,"file":"AppRouterContext.js","sources":["../src/AppRouterContext.ts"],"sourcesContent":["import { isNil } from \"@squide/core/internal\";\nimport { createContext, useContext } from \"react\";\nimport type { AppRouterDispatch, AppRouterState } from \"./AppRouterReducer.ts\";\n\nexport const AppRouterStateContext = createContext<AppRouterState | undefined>(undefined);\n\nexport function useAppRouterState() {\n    const state = useContext(AppRouterStateContext);\n\n    if (isNil(state)) {\n        throw new Error(\"[squide] The useAppRouterState hook must be called by a children of the AppRouter component.\");\n    }\n\n    return state;\n}\n\nexport const AppRouterDispatcherContext = createContext<AppRouterDispatch | undefined>(undefined);\n\nexport function useAppRouterDispatcher() {\n    const dispatch = useContext(AppRouterDispatcherContext);\n\n    if (isNil(dispatch)) {\n        throw new Error(\"[squide] The useAppRouterDispatcher hook must be called by a children of the AppRouter component.\");\n    }\n\n    return dispatch;\n}\n"],"names":["isNil","createContext","useContext","AppRouterStateContext","undefined","useAppRouterState","state","Error","AppRouterDispatcherContext","useAppRouterDispatcher","dispatch"],"mappings":";;;;;;;;AAA8C;AACI;AAG3C,MAAMG,wBAAwBF,aAAaA,CAA6BG,WAAW;AAEnF,SAASC;IACZ,MAAMC,QAAQJ,UAAUA,CAACC;IAEzB,IAAIH,KAAKA,CAACM,QAAQ;QACd,MAAM,IAAIC,MAAM;IACpB;IAEA,OAAOD;AACX;AAEO,MAAME,6BAA6BP,aAAaA,CAAgCG,WAAW;AAE3F,SAASK;IACZ,MAAMC,WAAWR,UAAUA,CAACM;IAE5B,IAAIR,KAAKA,CAACU,WAAW;QACjB,MAAM,IAAIH,MAAM;IACpB;IAEA,OAAOG;AACX"}

package/dist/AppRouterReducer.d.ts

@@ -14,11 +14,12 @@ export interface AppRouterState extends AppRouterWaitState {
     isProtectedDataReady: boolean;
     publicDataUpdatedAt?: number;
     protectedDataUpdatedAt?: number;
+    featureFlagsUpdatedAt?: number;
     deferredRegistrationsUpdatedAt?: number;
     activeRouteVisibility: ActiveRouteVisiblity;
     isUnauthorized: boolean;
 }
-export type AppRouterActionType = "modules-registered" | "modules-ready" | "msw-ready" | "public-data-ready" | "protected-data-ready" | "public-data-updated" | "protected-data-updated" | "deferred-registrations-updated" | "active-route-is-public" | "active-route-is-protected" | "is-unauthorized";
+export type AppRouterActionType = "modules-registered" | "modules-ready" | "msw-ready" | "public-data-ready" | "protected-data-ready" | "public-data-updated" | "protected-data-updated" | "feature-flags-updated" | "deferred-registrations-updated" | "active-route-is-public" | "active-route-is-protected" | "is-unauthorized";
 export declare const ModulesRegisteredEvent = "squide-modules-registered";
 export declare const ModulesReadyEvent = "squide-modules-ready";
 export declare const MswReadyEvent = "squide-msw-ready";
@@ -37,6 +38,7 @@ export interface AppRouterAction {
 export type AppRouterDispatch = Dispatch<AppRouterAction>;
 export declare function useModuleRegistrationStatusDispatcher(runtime: FireflyRuntime, areModulesRegisteredValue: boolean, areModulesReadyValue: boolean, dispatch: AppRouterDispatch): void;
 export declare function useMswStatusDispatcher(runtime: FireflyRuntime, isMswReadyValue: boolean, dispatch: AppRouterDispatch): void;
+export declare function useFeatureFlagsUpdatedDispatcher(runtime: FireflyRuntime, dispatch: AppRouterDispatch): 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

@@ -96,6 +96,14 @@ function reducer(state, action) {
                 };
                 break;
             }
+        case "feature-flags-updated":
+            {
+                newState = {
+                    ...newState,
+                    featureFlagsUpdatedAt: Date.now()
+                };
+                break;
+            }
         case "deferred-registrations-updated":
             {
                 newState = {
@@ -199,10 +207,10 @@ function useMswStatusDispatcher(runtime, isMswReadyValue, dispatch) {
     useEffect(()=>{
         if (runtime.isMswEnabled) {
             if (!isMswReadyValue) {
-                runtime.getMswState().addMswReadyListener(dispatchMswReady);
+                runtime.mswState.addMswReadyListener(dispatchMswReady);
             }
             return ()=>{
-                runtime.getMswState().removeMswReadyListener(dispatchMswReady);
+                runtime.mswState.removeMswReadyListener(dispatchMswReady);
             };
         }
     }, [
@@ -211,6 +219,28 @@ function useMswStatusDispatcher(runtime, isMswReadyValue, dispatch) {
         dispatchMswReady
     ]);
 }
+function useFeatureFlagsUpdatedDispatcher(runtime, dispatch) {
+    const logger = useLogger();
+    const dispatchFeatureFlagsUpdated = useCallback((changes)=>{
+        dispatch({
+            type: "feature-flags-updated"
+        });
+        logger.withText("[squide] Feature flags has been updated to:").withObject(changes).debug();
+    }, [
+        dispatch,
+        logger
+    ]);
+    useEffect(()=>{
+        if (runtime.isLaunchDarklyEnabled) {
+            runtime.featureFlagSetSnapshot.addSnapshotChangedListener(dispatchFeatureFlagsUpdated);
+            return ()=>{
+                runtime.featureFlagSetSnapshot.removeSnapshotChangedListener(dispatchFeatureFlagsUpdated);
+            };
+        }
+    }, [
+        runtime
+    ]);
+}
 function useBootstrappingCompletedDispatcher(waitState, state) {
     const eventBus = useEventBus();
     const areModulesRegisteredValue = state.areModulesRegistered;
@@ -271,7 +301,7 @@ function useAppRouterReducer(waitForPublicData, waitForProtectedData) {
     const isMswEnabled = runtime.isMswEnabled;
     const areModulesInitiallyRegistered = runtime.moduleManager.getAreModulesRegistered();
     const areModulesInitiallyReady = runtime.moduleManager.getAreModulesReady();
-    const isMswInitiallyReady = runtime.isMswEnabled ? runtime.getMswState().isReady : false;
+    const isMswInitiallyReady = runtime.isMswEnabled ? runtime.mswState.isReady : false;
     const waitState = useMemo(()=>({
             waitForMsw: isMswEnabled,
             waitForPublicData,
@@ -358,6 +388,7 @@ function useAppRouterReducer(waitForPublicData, waitForProtectedData) {
     const dispatch = useEnhancedReducerDispatch(waitState, dispatchProxy);
     useModuleRegistrationStatusDispatcher(runtime, areModulesRegisteredValue, areModulesReadyValue, dispatch);
     useMswStatusDispatcher(runtime, isMswReadyValue, dispatch);
+    useFeatureFlagsUpdatedDispatcher(runtime, dispatch);
     useBootstrappingCompletedDispatcher(waitState, state);
     return [
         state,
@@ -365,6 +396,6 @@ function useAppRouterReducer(waitForPublicData, waitForProtectedData) {
     ];
 }
 
-export { ActiveRouteIsProtectedEvent, ActiveRouteIsPublicEvent, ApplicationBoostrappedEvent, DeferredRegistrationsUpdatedEvent, ModulesReadyEvent, ModulesRegisteredEvent, MswReadyEvent, ProtectedDataReadyEvent, ProtectedDataUpdatedEvent, PublicDataReadyEvent, PublicDataUpdatedEvent, __clearAppReducerDispatchProxy, __setAppReducerDispatchProxyFactory, useAppRouterReducer, useModuleRegistrationStatusDispatcher, useMswStatusDispatcher };
+export { ActiveRouteIsProtectedEvent, ActiveRouteIsPublicEvent, ApplicationBoostrappedEvent, DeferredRegistrationsUpdatedEvent, ModulesReadyEvent, ModulesRegisteredEvent, MswReadyEvent, ProtectedDataReadyEvent, ProtectedDataUpdatedEvent, PublicDataReadyEvent, PublicDataUpdatedEvent, __clearAppReducerDispatchProxy, __setAppReducerDispatchProxyFactory, useAppRouterReducer, useFeatureFlagsUpdatedDispatcher, useModuleRegistrationStatusDispatcher, useMswStatusDispatcher };
 
 //# sourceMappingURL=AppRouterReducer.js.map

package/dist/AppRouterReducer.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppRouterReducer.js","sources":["../src/AppRouterReducer.ts"],"sourcesContent":["import { useEventBus, useLogger, useRuntime } from \"@squide/core\";\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 useModuleRegistrationStatusDispatcher(runtime: FireflyRuntime, areModulesRegisteredValue: boolean, areModulesReadyValue: boolean, dispatch: AppRouterDispatch) {\n    const logger = useLogger();\n\n    const dispatchModulesRegistered = useCallback(() => {\n        dispatch({ type: \"modules-registered\" });\n\n        logger\n            .withText(\"[squide] Modules are registered.\", {\n                style: {\n                    color: \"green\"\n                }\n            })\n            .information();\n    }, [dispatch, logger]);\n\n    const dispatchModulesReady = useCallback(() => {\n        dispatch({ type: \"modules-ready\" });\n\n        logger\n            .withText(\"[squide] Modules are ready.\", {\n                style: {\n                    color: \"green\"\n                }\n            })\n            .information();\n    }, [dispatch, logger]);\n\n    return useEffect(() => {\n        if (!areModulesRegisteredValue) {\n            runtime.moduleManager.registerModulesRegisteredListener(dispatchModulesRegistered);\n        }\n\n        if (!areModulesReadyValue) {\n            runtime.moduleManager.registerModulesReadyListener(dispatchModulesReady);\n        }\n\n        return () => {\n            runtime.moduleManager.removeModulesRegisteredListener(dispatchModulesRegistered);\n            runtime.moduleManager.removeModulesReadyListener(dispatchModulesReady);\n        };\n    }, [areModulesRegisteredValue, areModulesReadyValue, dispatchModulesRegistered, dispatchModulesReady]);\n}\n\nexport function useMswStatusDispatcher(runtime: FireflyRuntime, isMswReadyValue: boolean, dispatch: AppRouterDispatch) {\n    const logger = useLogger();\n\n    const dispatchMswReady = useCallback(() => {\n        dispatch({ type: \"msw-ready\" });\n\n        logger\n            .withText(\"[squide] MSW is ready.\", {\n                style: {\n                    color: \"green\"\n                }\n            })\n            .information();\n    }, [dispatch, logger]);\n\n    useEffect(() => {\n        if (runtime.isMswEnabled) {\n            if (!isMswReadyValue) {\n                runtime.getMswState().addMswReadyListener(dispatchMswReady);\n            }\n\n            return () => {\n                runtime.getMswState().removeMswReadyListener(dispatchMswReady);\n            };\n        }\n    }, [runtime, 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    const areModulesInitiallyRegistered = runtime.moduleManager.getAreModulesRegistered();\n    const areModulesInitiallyReady = runtime.moduleManager.getAreModulesReady();\n    const isMswInitiallyReady = runtime.isMswEnabled ? runtime.getMswState().isReady : false;\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(runtime, areModulesRegisteredValue, areModulesReadyValue, dispatch);\n    useMswStatusDispatcher(runtime, isMswReadyValue, dispatch);\n    useBootstrappingCompletedDispatcher(waitState, state);\n\n    return [state, dispatch];\n}\n"],"names":["useEventBus","useLogger","useRuntime","useCallback","useEffect","useMemo","useReducer","useAppRouterStore","useExecuteOnce","isBootstrapping","ModulesRegisteredEvent","ModulesReadyEvent","MswReadyEvent","ActiveRouteIsPublicEvent","ActiveRouteIsProtectedEvent","PublicDataReadyEvent","ProtectedDataReadyEvent","PublicDataUpdatedEvent","ProtectedDataUpdatedEvent","DeferredRegistrationsUpdatedEvent","ApplicationBoostrappedEvent","reducer","state","action","newState","Date","Error","useModuleRegistrationStatusDispatcher","runtime","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","isMswEnabled","areModulesInitiallyRegistered","areModulesInitiallyReady","isMswInitiallyReady","initialState","dispatchProxy"],"mappings":";;;;;;;;;;;;;;;;;AAAkE;AACiB;AAExB;AACN;AACK;AAoC1D,wFAAwF;AACxF,8DAA8D;AACvD,MAAMU,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,sCAAsCC,OAAuB,EAAEC,yBAAkC,EAAEC,oBAA6B,EAAEC,QAA2B;IACzK,MAAMC,SAAS/B,SAASA;IAExB,MAAMgC,4BAA4B9B,WAAWA,CAAC;QAC1C4B,SAAS;YAAE,MAAM;QAAqB;QAEtCC,OACK,QAAQ,CAAC,oCAAoC;YAC1C,OAAO;gBACH,OAAO;YACX;QACJ,GACC,WAAW;IACpB,GAAG;QAACD;QAAUC;KAAO;IAErB,MAAME,uBAAuB/B,WAAWA,CAAC;QACrC4B,SAAS;YAAE,MAAM;QAAgB;QAEjCC,OACK,QAAQ,CAAC,+BAA+B;YACrC,OAAO;gBACH,OAAO;YACX;QACJ,GACC,WAAW;IACpB,GAAG;QAACD;QAAUC;KAAO;IAErB,OAAO5B,SAASA,CAAC;QACb,IAAI,CAACyB,2BAA2B;YAC5BD,QAAQ,aAAa,CAAC,iCAAiC,CAACK;QAC5D;QAEA,IAAI,CAACH,sBAAsB;YACvBF,QAAQ,aAAa,CAAC,4BAA4B,CAACM;QACvD;QAEA,OAAO;YACHN,QAAQ,aAAa,CAAC,+BAA+B,CAACK;YACtDL,QAAQ,aAAa,CAAC,0BAA0B,CAACM;QACrD;IACJ,GAAG;QAACL;QAA2BC;QAAsBG;QAA2BC;KAAqB;AACzG;AAEO,SAASC,uBAAuBP,OAAuB,EAAEQ,eAAwB,EAAEL,QAA2B;IACjH,MAAMC,SAAS/B,SAASA;IAExB,MAAMoC,mBAAmBlC,WAAWA,CAAC;QACjC4B,SAAS;YAAE,MAAM;QAAY;QAE7BC,OACK,QAAQ,CAAC,0BAA0B;YAChC,OAAO;gBACH,OAAO;YACX;QACJ,GACC,WAAW;IACpB,GAAG;QAACD;QAAUC;KAAO;IAErB5B,SAASA,CAAC;QACN,IAAIwB,QAAQ,YAAY,EAAE;YACtB,IAAI,CAACQ,iBAAiB;gBAClBR,QAAQ,WAAW,GAAG,mBAAmB,CAACS;YAC9C;YAEA,OAAO;gBACHT,QAAQ,WAAW,GAAG,sBAAsB,CAACS;YACjD;QACJ;IACJ,GAAG;QAACT;QAASQ;QAAiBC;KAAiB;AACnD;AAEA,SAASC,oCAAoCC,SAA6B,EAAEjB,KAAqB;IAC7F,MAAMkB,WAAWxC,WAAWA;IAE5B,MAAM6B,4BAA4BP,MAAM,oBAAoB;IAC5D,MAAMmB,iBAAiBhC,eAAeA,CAACa;IAEvCd,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAI0B,6BAA6B,CAACY,gBAAgB;YAC9CD,SAAS,QAAQ,CAACpB,6BAA6BmB;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,OAAO3C,OAAOA,CAAC;QACX,OAAOqC,uBAAuBA,qBAAqBM,iBAAiBA;IACxE,GAAG;QAACA;KAAc;AACtB;AAEA,SAASC,2BAA2BV,SAA6B,EAAEW,eAAkC;IACjG,MAAMlB,SAAS/B,SAASA;IACxB,MAAMkD,iBAAiB5C,iBAAiBA;IACxC,MAAMiC,WAAWxC,WAAWA;IAE5B,OAAOG,WAAWA,CAAC,CAACoB;QAChBS,OACK,QAAQ,CAAC,+EACT,UAAU,CAACT,QACX,KAAK;QAEV4B,eAAe,QAAQ,CAAC;YAAE,GAAG5B,MAAM;YAAE,SAASgB;QAAU;QACxDC,SAAS,QAAQ,CAAC,CAAC,OAAO,EAAEjB,OAAO,IAAI,EAAE,EAAEgB;QAE3CW,gBAAgB3B;IACpB,GAAG;QAACgB;QAAWW;QAAiBlB;QAAQmB;QAAgBX;KAAS;AACrE;AAEO,SAASY,oBAAoBC,iBAA0B,EAAEC,oBAA6B;IACzF,MAAM1B,UAAU1B,UAAUA;IAC1B,MAAMsC,WAAWxC,WAAWA;IAC5B,MAAMmD,iBAAiB5C,iBAAiBA;IAExC,MAAMgD,eAAe3B,QAAQ,YAAY;IACzC,MAAM4B,gCAAgC5B,QAAQ,aAAa,CAAC,uBAAuB;IACnF,MAAM6B,2BAA2B7B,QAAQ,aAAa,CAAC,kBAAkB;IACzE,MAAM8B,sBAAsB9B,QAAQ,YAAY,GAAGA,QAAQ,WAAW,GAAG,OAAO,GAAG;IAEnF,MAAMW,YAAYlC,OAAOA,CAAC,IAAO;YAC7B,YAAYkD;YACZF;YACAC;QACJ,IAAI;QAACC;QAAcF;QAAmBC;KAAqB;IAE3D,MAAMK,eAAetD,OAAOA,CAAC,IAAO;YAChC,YAAYkC,UAAU,UAAU;YAChC,mBAAmBA,UAAU,iBAAiB;YAC9C,sBAAsBA,UAAU,oBAAoB;YACpD,4HAA4H;YAC5H,sBAAsBiB;YACtB,iBAAiBC;YACjB,YAAYC;YACZ,mBAAmB;YACnB,sBAAsB;YACtB,uBAAuB;YACvB,gBAAgB;QACpB,IAA6B;QAACnB;QAAWiB;QAA+BC;QAA0BC;KAAoB;IAEtH,2IAA2I;IAC3I,6HAA6H;IAC7HlD,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAIqD,+BAA+B;YAC/BL,eAAe,QAAQ,CAAC;gBAAE,MAAM;gBAAsB,SAASZ;YAAU;YACzEC,SAAS,QAAQ,CAAC9B,wBAAwB6B;QAC9C;QAEA,OAAO;IACX,GAAG;QAACiB;QAA+BL;QAAgBX;QAAUD;KAAU,GAAG;IAE1E,2IAA2I;IAC3I,6HAA6H;IAC7H/B,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAIsD,0BAA0B;YAC1BN,eAAe,QAAQ,CAAC;gBAAE,MAAM;gBAAiB,SAASZ;YAAU;YACpEC,SAAS,QAAQ,CAAC7B,mBAAmB4B;QACzC;QAEA,OAAO;IACX,GAAG;QAACkB;QAA0BN;QAAgBX;QAAUD;KAAU,GAAG;IAErE,2IAA2I;IAC3I,6HAA6H;IAC7H/B,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAIuD,qBAAqB;YACrBP,eAAe,QAAQ,CAAC;gBAAE,MAAM;gBAAa,SAASZ;YAAU;YAChEC,SAAS,QAAQ,CAAC5B,eAAe2B;QACrC;QAEA,OAAO;IACX,GAAG;QAACmB;QAAqBP;QAAgBX;QAAUD;KAAU,GAAG;IAEhE,MAAM,CAACjB,OAAO0B,cAAc,GAAG1C,UAAUA,CAACe,SAASsC;IAEnD,MAAM,EACF,sBAAsB9B,yBAAyB,EAC/C,iBAAiBC,oBAAoB,EACrC,YAAYM,eAAe,EAC9B,GAAGd;IAEJ,iHAAiH;IACjH,sCAAsC;IACtC,MAAMsC,gBAAgBb,wBAAwBC;IAC9C,MAAMjB,WAAWkB,2BAA2BV,WAAWqB;IAEvDjC,sCAAsCC,SAASC,2BAA2BC,sBAAsBC;IAChGI,uBAAuBP,SAASQ,iBAAiBL;IACjDO,oCAAoCC,WAAWjB;IAE/C,OAAO;QAACA;QAAOS;KAAS;AAC5B"}
+{"version":3,"file":"AppRouterReducer.js","sources":["../src/AppRouterReducer.ts"],"sourcesContent":["import { useEventBus, useLogger, useRuntime } from \"@squide/core\";\nimport type { FeatureFlagSetSnapshotChangedListener } from \"@squide/launch-darkly\";\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    featureFlagsUpdatedAt?: 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    | \"feature-flags-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 \"feature-flags-updated\": {\n            newState = {\n                ...newState,\n                featureFlagsUpdatedAt: 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 useModuleRegistrationStatusDispatcher(runtime: FireflyRuntime, areModulesRegisteredValue: boolean, areModulesReadyValue: boolean, dispatch: AppRouterDispatch) {\n    const logger = useLogger();\n\n    const dispatchModulesRegistered = useCallback(() => {\n        dispatch({ type: \"modules-registered\" });\n\n        logger\n            .withText(\"[squide] Modules are registered.\", {\n                style: {\n                    color: \"green\"\n                }\n            })\n            .information();\n    }, [dispatch, logger]);\n\n    const dispatchModulesReady = useCallback(() => {\n        dispatch({ type: \"modules-ready\" });\n\n        logger\n            .withText(\"[squide] Modules are ready.\", {\n                style: {\n                    color: \"green\"\n                }\n            })\n            .information();\n    }, [dispatch, logger]);\n\n    return useEffect(() => {\n        if (!areModulesRegisteredValue) {\n            runtime.moduleManager.registerModulesRegisteredListener(dispatchModulesRegistered);\n        }\n\n        if (!areModulesReadyValue) {\n            runtime.moduleManager.registerModulesReadyListener(dispatchModulesReady);\n        }\n\n        return () => {\n            runtime.moduleManager.removeModulesRegisteredListener(dispatchModulesRegistered);\n            runtime.moduleManager.removeModulesReadyListener(dispatchModulesReady);\n        };\n    }, [areModulesRegisteredValue, areModulesReadyValue, dispatchModulesRegistered, dispatchModulesReady]);\n}\n\nexport function useMswStatusDispatcher(runtime: FireflyRuntime, isMswReadyValue: boolean, dispatch: AppRouterDispatch) {\n    const logger = useLogger();\n\n    const dispatchMswReady = useCallback(() => {\n        dispatch({ type: \"msw-ready\" });\n\n        logger\n            .withText(\"[squide] MSW is ready.\", {\n                style: {\n                    color: \"green\"\n                }\n            })\n            .information();\n    }, [dispatch, logger]);\n\n    useEffect(() => {\n        if (runtime.isMswEnabled) {\n            if (!isMswReadyValue) {\n                runtime.mswState.addMswReadyListener(dispatchMswReady);\n            }\n\n            return () => {\n                runtime.mswState.removeMswReadyListener(dispatchMswReady);\n            };\n        }\n    }, [runtime, isMswReadyValue, dispatchMswReady]);\n}\n\nexport function useFeatureFlagsUpdatedDispatcher(runtime: FireflyRuntime, dispatch: AppRouterDispatch) {\n    const logger = useLogger();\n\n    const dispatchFeatureFlagsUpdated = useCallback((changes => {\n        dispatch({ type: \"feature-flags-updated\" });\n\n        logger\n            .withText(\"[squide] Feature flags has been updated to:\")\n            .withObject(changes)\n            .debug();\n    }) satisfies FeatureFlagSetSnapshotChangedListener, [dispatch, logger]);\n\n    useEffect(() => {\n        if (runtime.isLaunchDarklyEnabled) {\n            runtime.featureFlagSetSnapshot.addSnapshotChangedListener(dispatchFeatureFlagsUpdated);\n\n            return () => {\n                runtime.featureFlagSetSnapshot.removeSnapshotChangedListener(dispatchFeatureFlagsUpdated);\n            };\n        }\n    }, [runtime]);\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    const areModulesInitiallyRegistered = runtime.moduleManager.getAreModulesRegistered();\n    const areModulesInitiallyReady = runtime.moduleManager.getAreModulesReady();\n    const isMswInitiallyReady = runtime.isMswEnabled ? runtime.mswState.isReady : false;\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(runtime, areModulesRegisteredValue, areModulesReadyValue, dispatch);\n    useMswStatusDispatcher(runtime, isMswReadyValue, dispatch);\n    useFeatureFlagsUpdatedDispatcher(runtime, dispatch);\n    useBootstrappingCompletedDispatcher(waitState, state);\n\n    return [state, dispatch];\n}\n"],"names":["useEventBus","useLogger","useRuntime","useCallback","useEffect","useMemo","useReducer","useAppRouterStore","useExecuteOnce","isBootstrapping","ModulesRegisteredEvent","ModulesReadyEvent","MswReadyEvent","ActiveRouteIsPublicEvent","ActiveRouteIsProtectedEvent","PublicDataReadyEvent","ProtectedDataReadyEvent","PublicDataUpdatedEvent","ProtectedDataUpdatedEvent","DeferredRegistrationsUpdatedEvent","ApplicationBoostrappedEvent","reducer","state","action","newState","Date","Error","useModuleRegistrationStatusDispatcher","runtime","areModulesRegisteredValue","areModulesReadyValue","dispatch","logger","dispatchModulesRegistered","dispatchModulesReady","useMswStatusDispatcher","isMswReadyValue","dispatchMswReady","useFeatureFlagsUpdatedDispatcher","dispatchFeatureFlagsUpdated","changes","useBootstrappingCompletedDispatcher","waitState","eventBus","isBoostrapping","dispatchProxyFactory","__setAppReducerDispatchProxyFactory","factory","__clearAppReducerDispatchProxy","undefined","useReducerDispatchProxy","reactDispatch","useEnhancedReducerDispatch","reducerDispatch","appRouterStore","useAppRouterReducer","waitForPublicData","waitForProtectedData","isMswEnabled","areModulesInitiallyRegistered","areModulesInitiallyReady","isMswInitiallyReady","initialState","dispatchProxy"],"mappings":";;;;;;;;;;;;;;;;;AAAkE;AAEiB;AAExB;AACN;AACK;AAsC1D,wFAAwF;AACxF,8DAA8D;AACvD,MAAMU,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;YAAyB;gBAC1BD,WAAW;oBACP,GAAGA,QAAQ;oBACX,uBAAuBC,KAAK,GAAG;gBACnC;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,sCAAsCC,OAAuB,EAAEC,yBAAkC,EAAEC,oBAA6B,EAAEC,QAA2B;IACzK,MAAMC,SAAS/B,SAASA;IAExB,MAAMgC,4BAA4B9B,WAAWA,CAAC;QAC1C4B,SAAS;YAAE,MAAM;QAAqB;QAEtCC,OACK,QAAQ,CAAC,oCAAoC;YAC1C,OAAO;gBACH,OAAO;YACX;QACJ,GACC,WAAW;IACpB,GAAG;QAACD;QAAUC;KAAO;IAErB,MAAME,uBAAuB/B,WAAWA,CAAC;QACrC4B,SAAS;YAAE,MAAM;QAAgB;QAEjCC,OACK,QAAQ,CAAC,+BAA+B;YACrC,OAAO;gBACH,OAAO;YACX;QACJ,GACC,WAAW;IACpB,GAAG;QAACD;QAAUC;KAAO;IAErB,OAAO5B,SAASA,CAAC;QACb,IAAI,CAACyB,2BAA2B;YAC5BD,QAAQ,aAAa,CAAC,iCAAiC,CAACK;QAC5D;QAEA,IAAI,CAACH,sBAAsB;YACvBF,QAAQ,aAAa,CAAC,4BAA4B,CAACM;QACvD;QAEA,OAAO;YACHN,QAAQ,aAAa,CAAC,+BAA+B,CAACK;YACtDL,QAAQ,aAAa,CAAC,0BAA0B,CAACM;QACrD;IACJ,GAAG;QAACL;QAA2BC;QAAsBG;QAA2BC;KAAqB;AACzG;AAEO,SAASC,uBAAuBP,OAAuB,EAAEQ,eAAwB,EAAEL,QAA2B;IACjH,MAAMC,SAAS/B,SAASA;IAExB,MAAMoC,mBAAmBlC,WAAWA,CAAC;QACjC4B,SAAS;YAAE,MAAM;QAAY;QAE7BC,OACK,QAAQ,CAAC,0BAA0B;YAChC,OAAO;gBACH,OAAO;YACX;QACJ,GACC,WAAW;IACpB,GAAG;QAACD;QAAUC;KAAO;IAErB5B,SAASA,CAAC;QACN,IAAIwB,QAAQ,YAAY,EAAE;YACtB,IAAI,CAACQ,iBAAiB;gBAClBR,QAAQ,QAAQ,CAAC,mBAAmB,CAACS;YACzC;YAEA,OAAO;gBACHT,QAAQ,QAAQ,CAAC,sBAAsB,CAACS;YAC5C;QACJ;IACJ,GAAG;QAACT;QAASQ;QAAiBC;KAAiB;AACnD;AAEO,SAASC,iCAAiCV,OAAuB,EAAEG,QAA2B;IACjG,MAAMC,SAAS/B,SAASA;IAExB,MAAMsC,8BAA8BpC,WAAWA,CAAEqC,CAAAA;QAC7CT,SAAS;YAAE,MAAM;QAAwB;QAEzCC,OACK,QAAQ,CAAC,+CACT,UAAU,CAACQ,SACX,KAAK;IACd,GAAoD;QAACT;QAAUC;KAAO;IAEtE5B,SAASA,CAAC;QACN,IAAIwB,QAAQ,qBAAqB,EAAE;YAC/BA,QAAQ,sBAAsB,CAAC,0BAA0B,CAACW;YAE1D,OAAO;gBACHX,QAAQ,sBAAsB,CAAC,6BAA6B,CAACW;YACjE;QACJ;IACJ,GAAG;QAACX;KAAQ;AAChB;AAEA,SAASa,oCAAoCC,SAA6B,EAAEpB,KAAqB;IAC7F,MAAMqB,WAAW3C,WAAWA;IAE5B,MAAM6B,4BAA4BP,MAAM,oBAAoB;IAC5D,MAAMsB,iBAAiBnC,eAAeA,CAACa;IAEvCd,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAI0B,6BAA6B,CAACe,gBAAgB;YAC9CD,SAAS,QAAQ,CAACvB,6BAA6BsB;YAE/C,OAAO;QACX;QAEA,OAAO;IACX,GAAG;QAACb;QAA2Be;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,MAAMrB,SAAS/B,SAASA;IACxB,MAAMqD,iBAAiB/C,iBAAiBA;IACxC,MAAMoC,WAAW3C,WAAWA;IAE5B,OAAOG,WAAWA,CAAC,CAACoB;QAChBS,OACK,QAAQ,CAAC,+EACT,UAAU,CAACT,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;QAAiBrB;QAAQsB;QAAgBX;KAAS;AACrE;AAEO,SAASY,oBAAoBC,iBAA0B,EAAEC,oBAA6B;IACzF,MAAM7B,UAAU1B,UAAUA;IAC1B,MAAMyC,WAAW3C,WAAWA;IAC5B,MAAMsD,iBAAiB/C,iBAAiBA;IAExC,MAAMmD,eAAe9B,QAAQ,YAAY;IACzC,MAAM+B,gCAAgC/B,QAAQ,aAAa,CAAC,uBAAuB;IACnF,MAAMgC,2BAA2BhC,QAAQ,aAAa,CAAC,kBAAkB;IACzE,MAAMiC,sBAAsBjC,QAAQ,YAAY,GAAGA,QAAQ,QAAQ,CAAC,OAAO,GAAG;IAE9E,MAAMc,YAAYrC,OAAOA,CAAC,IAAO;YAC7B,YAAYqD;YACZF;YACAC;QACJ,IAAI;QAACC;QAAcF;QAAmBC;KAAqB;IAE3D,MAAMK,eAAezD,OAAOA,CAAC,IAAO;YAChC,YAAYqC,UAAU,UAAU;YAChC,mBAAmBA,UAAU,iBAAiB;YAC9C,sBAAsBA,UAAU,oBAAoB;YACpD,4HAA4H;YAC5H,sBAAsBiB;YACtB,iBAAiBC;YACjB,YAAYC;YACZ,mBAAmB;YACnB,sBAAsB;YACtB,uBAAuB;YACvB,gBAAgB;QACpB,IAA6B;QAACnB;QAAWiB;QAA+BC;QAA0BC;KAAoB;IAEtH,2IAA2I;IAC3I,6HAA6H;IAC7HrD,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAIwD,+BAA+B;YAC/BL,eAAe,QAAQ,CAAC;gBAAE,MAAM;gBAAsB,SAASZ;YAAU;YACzEC,SAAS,QAAQ,CAACjC,wBAAwBgC;QAC9C;QAEA,OAAO;IACX,GAAG;QAACiB;QAA+BL;QAAgBX;QAAUD;KAAU,GAAG;IAE1E,2IAA2I;IAC3I,6HAA6H;IAC7HlC,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAIyD,0BAA0B;YAC1BN,eAAe,QAAQ,CAAC;gBAAE,MAAM;gBAAiB,SAASZ;YAAU;YACpEC,SAAS,QAAQ,CAAChC,mBAAmB+B;QACzC;QAEA,OAAO;IACX,GAAG;QAACkB;QAA0BN;QAAgBX;QAAUD;KAAU,GAAG;IAErE,2IAA2I;IAC3I,6HAA6H;IAC7HlC,cAAcA,CAACL,WAAWA,CAAC;QACvB,IAAI0D,qBAAqB;YACrBP,eAAe,QAAQ,CAAC;gBAAE,MAAM;gBAAa,SAASZ;YAAU;YAChEC,SAAS,QAAQ,CAAC/B,eAAe8B;QACrC;QAEA,OAAO;IACX,GAAG;QAACmB;QAAqBP;QAAgBX;QAAUD;KAAU,GAAG;IAEhE,MAAM,CAACpB,OAAO6B,cAAc,GAAG7C,UAAUA,CAACe,SAASyC;IAEnD,MAAM,EACF,sBAAsBjC,yBAAyB,EAC/C,iBAAiBC,oBAAoB,EACrC,YAAYM,eAAe,EAC9B,GAAGd;IAEJ,iHAAiH;IACjH,sCAAsC;IACtC,MAAMyC,gBAAgBb,wBAAwBC;IAC9C,MAAMpB,WAAWqB,2BAA2BV,WAAWqB;IAEvDpC,sCAAsCC,SAASC,2BAA2BC,sBAAsBC;IAChGI,uBAAuBP,SAASQ,iBAAiBL;IACjDO,iCAAiCV,SAASG;IAC1CU,oCAAoCC,WAAWpB;IAE/C,OAAO;QAACA;QAAOS;KAAS;AAC5B"}

package/dist/AppRouterStore.js

@@ -97,6 +97,14 @@ class AppRouterStore {
                     };
                     break;
                 }
+            case "feature-flags-updated":
+                {
+                    newState = {
+                        ...newState,
+                        featureFlagsUpdatedAt: Date.now()
+                    };
+                    break;
+                }
             case "deferred-registrations-updated":
                 {
                     newState = {

package/dist/AppRouterStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"AppRouterStore.js","sources":["../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"}
+{"version":3,"file":"AppRouterStore.js","sources":["../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 \"feature-flags-updated\": {\n                newState = {\n                    ...newState,\n                    featureFlagsUpdatedAt: 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;gBAAyB;oBAC1BH,WAAW;wBACP,GAAGA,QAAQ;wBACX,uBAAuBG,KAAK,GAAG;oBACnC;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,9 +1,11 @@
 import type { RegisterRouteOptions, RuntimeMethodOptions, RuntimeOptions } from "@squide/core";
-import { EnvironmentVariableKey, EnvironmentVariables, EnvironmentVariableValue } from "@squide/env-vars";
+import { EnvironmentVariableKey, EnvironmentVariables } from "@squide/env-vars";
+import { FeatureFlagKey, FeatureFlags, FeatureFlagSetSnapshot } from "@squide/launch-darkly";
 import { 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 { LDClient } from "launchdarkly-js-client-sdk";
 import type { RequestHandler } from "msw";
 import { type AppRouterStore } from "./AppRouterStore.ts";
 export interface FireflyRuntimeOptions<TRuntime extends FireflyRuntime = FireflyRuntime> extends RuntimeOptions<TRuntime> {
@@ -12,43 +14,57 @@ export interface FireflyRuntimeOptions<TRuntime extends FireflyRuntime = Firefly
 export interface RegisterRequestHandlersOptions extends RuntimeMethodOptions {
 }
 export interface IFireflyRuntime extends IReactRouterRuntime {
-    getMswState(): MswState;
+    get isMswEnabled(): boolean;
+    get mswState(): MswState;
     registerRequestHandlers: (handlers: RequestHandler[]) => void;
     get requestHandlers(): RequestHandler[];
-    get isMswEnabled(): boolean;
-    registerEnvironmentVariable(key: EnvironmentVariableKey, value: EnvironmentVariableValue): void;
+    registerEnvironmentVariable<T extends EnvironmentVariableKey>(key: T, value: EnvironmentVariables[T]): void;
     registerEnvironmentVariables(variables: Partial<EnvironmentVariables>): void;
-    getEnvironmentVariable(key: EnvironmentVariableKey): EnvironmentVariableValue;
-    getEnvironmentVariables(): EnvironmentVariables;
+    getEnvironmentVariable<T extends EnvironmentVariableKey>(key: T): EnvironmentVariables[T];
+    get environmentVariables(): EnvironmentVariables;
     get appRouterStore(): AppRouterStore;
     get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient | undefined;
+    get isLaunchDarklyEnabled(): boolean;
+    get launchDarklyClient(): LDClient;
+    get featureFlags(): FeatureFlags;
+    getFeatureFlag(key: string, defaultValue?: unknown): unknown;
+    get featureFlagSetSnapshot(): FeatureFlagSetSnapshot;
 }
 export declare class FireflyRuntime<TRuntime extends FireflyRuntime = any> extends ReactRouterRuntime<TRuntime> implements IFireflyRuntime {
-    protected _appRouterStore: AppRouterStore;
-    protected _honeycombInstrumentationClient: HoneycombInstrumentationPartialClient | undefined;
+    #private;
     constructor(options?: FireflyRuntimeOptions);
     registerRoute(route: Route, options?: RegisterRouteOptions): void;
-    getMswState(): MswState;
+    get isMswEnabled(): boolean;
+    get mswState(): MswState;
     registerRequestHandlers(handlers: RequestHandler[], options?: RegisterRequestHandlersOptions): void;
     get requestHandlers(): RequestHandler[];
-    get isMswEnabled(): boolean;
     getEnvironmentVariable(key: EnvironmentVariableKey): never;
-    getEnvironmentVariables(): EnvironmentVariables;
-    registerEnvironmentVariable(key: EnvironmentVariableKey, value: EnvironmentVariableValue): void;
+    get environmentVariables(): EnvironmentVariables;
+    registerEnvironmentVariable<T extends EnvironmentVariableKey>(key: T, value: EnvironmentVariables[T]): void;
     registerEnvironmentVariables(variables: Partial<EnvironmentVariables>): void;
     get appRouterStore(): AppRouterStore;
     get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient | undefined;
+    get isLaunchDarklyEnabled(): boolean;
+    get launchDarklyClient(): LDClient;
+    get featureFlags(): FeatureFlags;
+    getFeatureFlag<T extends FeatureFlagKey>(key: T, defaultValue?: FeatureFlags[T]): FeatureFlags[T];
+    get featureFlagSetSnapshot(): FeatureFlagSetSnapshot;
     startScope(logger: Logger): TRuntime;
 }
 export declare class FireflyRuntimeScope<TRuntime extends FireflyRuntime = FireflyRuntime> extends ReactRouterRuntimeScope<TRuntime> implements IFireflyRuntime {
-    getMswState(): MswState;
+    get isMswEnabled(): boolean;
+    get mswState(): MswState;
     registerRequestHandlers(handlers: RequestHandler[], options?: RegisterRequestHandlersOptions): void;
     get requestHandlers(): RequestHandler[];
-    get isMswEnabled(): boolean;
-    getEnvironmentVariables(): EnvironmentVariables;
     getEnvironmentVariable(key: EnvironmentVariableKey): never;
-    registerEnvironmentVariable(key: EnvironmentVariableKey, value: EnvironmentVariableValue): void;
+    get environmentVariables(): EnvironmentVariables;
+    registerEnvironmentVariable<T extends EnvironmentVariableKey>(key: T, value: EnvironmentVariables[T]): void;
     registerEnvironmentVariables(variables: Partial<EnvironmentVariables>): void;
     get appRouterStore(): AppRouterStore;
     get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient;
+    get isLaunchDarklyEnabled(): boolean;
+    get launchDarklyClient(): LDClient;
+    get featureFlags(): FeatureFlags;
+    getFeatureFlag<T extends FeatureFlagKey>(key: T, defaultValue?: FeatureFlags[T]): FeatureFlags[T];
+    get featureFlagSetSnapshot(): FeatureFlagSetSnapshot;
 }

package/dist/FireflyRuntime.js

@@ -1,10 +1,13 @@
 import { getEnvironmentVariablesPlugin } from "@squide/env-vars";
+import { LaunchDarklyPluginName, getLaunchDarklyPlugin } from "@squide/launch-darkly";
 import { MswPluginName, getMswPlugin } from "@squide/msw";
 import { ReactRouterRuntime, ReactRouterRuntimeScope } from "@squide/react-router";
 import { createAppRouterStore } from "./AppRouterStore.js";
 
 ;// CONCATENATED MODULE: external "@squide/env-vars"
 
+;// CONCATENATED MODULE: external "@squide/launch-darkly"
+
 ;// CONCATENATED MODULE: external "@squide/msw"
 
 ;// CONCATENATED MODULE: external "@squide/react-router"
@@ -16,15 +19,20 @@ import { createAppRouterStore } from "./AppRouterStore.js";
 
 
 
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 class FireflyRuntime extends ReactRouterRuntime {
-    _appRouterStore;
-    _honeycombInstrumentationClient;
+    #appRouterStore;
+    #honeycombInstrumentationClient;
+    #isMswEnabled;
+    #isLaunchDarklyEnabled;
     constructor(options = {}){
         const { honeycombInstrumentationClient } = options;
         super(options);
-        this._appRouterStore = createAppRouterStore(this._logger);
-        this._honeycombInstrumentationClient = honeycombInstrumentationClient;
+        this.#appRouterStore = createAppRouterStore(this._logger);
+        this.#honeycombInstrumentationClient = honeycombInstrumentationClient;
+        this.#isMswEnabled = this._plugins.some((x)=>x.name === MswPluginName);
+        this.#isLaunchDarklyEnabled = this._plugins.some((x)=>x.name === LaunchDarklyPluginName);
     }
     registerRoute(route, options = {}) {
         if (this.moduleManager.getAreModulesRegistered()) {
@@ -32,7 +40,10 @@ class FireflyRuntime extends ReactRouterRuntime {
         }
         super.registerRoute(route, options);
     }
-    getMswState() {
+    get isMswEnabled() {
+        return this.#isMswEnabled;
+    }
+    get mswState() {
         const plugin = getMswPlugin(this);
         return plugin.mswState;
     }
@@ -51,14 +62,11 @@ class FireflyRuntime extends ReactRouterRuntime {
         const plugin = getMswPlugin(this);
         return plugin.requestHandlers;
     }
-    get isMswEnabled() {
-        return this._plugins.some((x)=>x.name === MswPluginName);
-    }
     getEnvironmentVariable(key) {
         const plugin = getEnvironmentVariablesPlugin(this);
         return plugin.getVariable(key);
     }
-    getEnvironmentVariables() {
+    get environmentVariables() {
         const plugin = getEnvironmentVariablesPlugin(this);
         return plugin.getVariables();
     }
@@ -71,18 +79,36 @@ class FireflyRuntime extends ReactRouterRuntime {
         return plugin.registerVariables(variables);
     }
     get appRouterStore() {
-        return this._appRouterStore;
+        return this.#appRouterStore;
     }
     get honeycombInstrumentationClient() {
-        return this._honeycombInstrumentationClient;
+        return this.#honeycombInstrumentationClient;
+    }
+    get isLaunchDarklyEnabled() {
+        return this.#isLaunchDarklyEnabled;
+    }
+    get launchDarklyClient() {
+        return getLaunchDarklyPlugin(this).client;
+    }
+    get featureFlags() {
+        return this.featureFlagSetSnapshot.value;
+    }
+    getFeatureFlag(key, defaultValue) {
+        return getLaunchDarklyPlugin(this).getFeatureFlag(key, defaultValue);
+    }
+    get featureFlagSetSnapshot() {
+        return getLaunchDarklyPlugin(this).featureFlagSetSnapshot;
     }
     startScope(logger) {
         return new FireflyRuntimeScope(this, logger);
     }
 }
 class FireflyRuntimeScope extends ReactRouterRuntimeScope {
-    getMswState() {
-        return this._runtime.getMswState();
+    get isMswEnabled() {
+        return this._runtime.isMswEnabled;
+    }
+    get mswState() {
+        return this._runtime.mswState;
     }
     registerRequestHandlers(handlers, options = {}) {
         this._runtime.registerRequestHandlers(handlers, {
@@ -94,15 +120,12 @@ class FireflyRuntimeScope extends ReactRouterRuntimeScope {
     get requestHandlers() {
         return this._runtime.requestHandlers;
     }
-    get isMswEnabled() {
-        return this._runtime.isMswEnabled;
-    }
-    getEnvironmentVariables() {
-        return this._runtime.getEnvironmentVariables();
-    }
     getEnvironmentVariable(key) {
         return this._runtime.getEnvironmentVariable(key);
     }
+    get environmentVariables() {
+        return this._runtime.environmentVariables;
+    }
     registerEnvironmentVariable(key, value) {
         this._runtime.registerEnvironmentVariable(key, value);
     }
@@ -115,6 +138,25 @@ class FireflyRuntimeScope extends ReactRouterRuntimeScope {
     get honeycombInstrumentationClient() {
         throw new Error("[squide] Cannot retrieve the Honeycomb instrumentation client from a runtime scope instance.");
     }
+    get isLaunchDarklyEnabled() {
+        return this._runtime.isLaunchDarklyEnabled;
+    }
+    get launchDarklyClient() {
+        return this._runtime.launchDarklyClient;
+    }
+    get featureFlags() {
+        return this._runtime.featureFlags;
+    }
+    getFeatureFlag(key, defaultValue) {
+        // The error is because the FeatureFlags interface is empty as it is expected to be augmented by the
+        // consumer application.
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        return this._runtime.getFeatureFlag(key, defaultValue);
+    }
+    get featureFlagSetSnapshot() {
+        return this._runtime.featureFlagSetSnapshot;
+    }
 }
 
 export { FireflyRuntime, FireflyRuntimeScope };