@squide/firefly 17.1.0 → 17.2.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @squide/firefly
 
+## 17.2.0
+
+### Minor Changes
+
+- [#631](https://github.com/workleap/wl-squide/pull/631) [`9bbcd7e`](https://github.com/workleap/wl-squide/commit/9bbcd7e1597d0c473a1477f608e3596390553bb4) Thanks [@patricklafrance](https://github.com/patricklafrance)! - `registerRequestHandlers` now accepts a `prepend` option (mirroring `registerRoute`'s `hoist` flag). Prepended handlers are placed before the appended ones, with registration order preserved within each group.
+
+  MSW evaluates handlers in registration order and a handler returning nothing falls through to the next matching handler, so `prepend` enables middleware-like fall-through handlers (artificial latency, request logging, chaos testing) that must run before the regular handlers — regardless of module registration timing:
+
+  ```ts
+  runtime.registerRequestHandlers([latencyRequestHandler], { prepend: true });
+  ```
+
+### Patch Changes
+
+- Updated dependencies [[`9bbcd7e`](https://github.com/workleap/wl-squide/commit/9bbcd7e1597d0c473a1477f608e3596390553bb4)]:
+  - @squide/msw@4.1.0
+
 ## 17.1.0
 
 ### Minor Changes

package/dist/FireflyRuntime.d.ts

@@ -12,11 +12,12 @@ export interface FireflyRuntimeOptions<TRuntime extends FireflyRuntime = Firefly
     honeycombInstrumentationClient?: HoneycombInstrumentationPartialClient;
 }
 export interface RegisterRequestHandlersOptions extends RuntimeMethodOptions {
+    prepend?: true;
 }
 export interface IFireflyRuntime extends IReactRouterRuntime {
     get isMswEnabled(): boolean;
     get mswState(): MswState;
-    registerRequestHandlers: (handlers: RequestHandler[]) => void;
+    registerRequestHandlers: (handlers: RequestHandler[], options?: RegisterRequestHandlersOptions) => void;
     get requestHandlers(): RequestHandler[];
     registerEnvironmentVariable<T extends EnvironmentVariableKey>(key: T, value: EnvironmentVariables[T]): void;
     registerEnvironmentVariables(variables: Partial<EnvironmentVariables>): void;

package/dist/FireflyRuntime.js

@@ -41,13 +41,15 @@ class FireflyRuntime extends ReactRouterRuntime {
         return getMswPlugin(this).mswState;
     }
     registerRequestHandlers(handlers, options = {}) {
+        const { prepend } = options;
         const logger = this._getLogger(options);
         const plugin = getMswPlugin(this);
         if (this.moduleManager.getAreModulesRegistered()) {
-            throw new Error("[squide] Cannot register an MSW request handlers once the modules are registered. Are you trying to register an MSW request handler in a deferred registration function? Only navigation items can be registered in a deferred registration function.");
+            throw new Error("[squide] Cannot register 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.");
         }
         plugin.registerRequestHandlers(handlers, {
-            logger
+            logger,
+            prepend
         });
     }
     // Must define a return type otherwise we get an "error TS2742: The inferred type of 'requestHandlers' cannot be named" error.

package/dist/FireflyRuntime.js.map

@@ -1 +1 @@
-{"version":3,"file":"FireflyRuntime.js","sources":["../src/FireflyRuntime.tsx"],"sourcesContent":["import type { RegisterRouteOptions, RuntimeMethodOptions, RuntimeOptions } from \"@squide/core\";\nimport { EnvironmentVariableKey, EnvironmentVariables, getEnvironmentVariablesPlugin } from \"@squide/env-vars\";\nimport { FeatureFlagKey, FeatureFlags, FeatureFlagSetSnapshot, getLaunchDarklyPlugin, LaunchDarklyPluginName } from \"@squide/launch-darkly\";\nimport { getMswPlugin, MswPluginName, MswState } from \"@squide/msw\";\nimport { type IReactRouterRuntime, ReactRouterRuntime, ReactRouterRuntimeScope, type Route } from \"@squide/react-router\";\nimport type { HoneycombInstrumentationPartialClient } from \"@workleap-telemetry/core\";\nimport type { Logger } from \"@workleap/logging\";\nimport { LDClient } from \"launchdarkly-js-client-sdk\";\nimport type { RequestHandler } from \"msw\";\nimport { type AppRouterStore, createAppRouterStore } from \"./AppRouterStore.ts\";\n\nexport interface FireflyRuntimeOptions<TRuntime extends FireflyRuntime = FireflyRuntime> extends RuntimeOptions<TRuntime> {\n    honeycombInstrumentationClient?: HoneycombInstrumentationPartialClient;\n}\n\nexport interface RegisterRequestHandlersOptions extends RuntimeMethodOptions {}\n\nexport interface IFireflyRuntime extends IReactRouterRuntime {\n    get isMswEnabled(): boolean;\n    get mswState(): MswState;\n    registerRequestHandlers: (handlers: RequestHandler[]) => void;\n    get requestHandlers(): RequestHandler[];\n    registerEnvironmentVariable<T extends EnvironmentVariableKey>(key: T, value: EnvironmentVariables[T]): void;\n    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>): void;\n    getEnvironmentVariable<T extends EnvironmentVariableKey>(key: T): EnvironmentVariables[T];\n    get environmentVariables(): EnvironmentVariables;\n    get appRouterStore(): AppRouterStore;\n    get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient | undefined;\n    get isLaunchDarklyEnabled(): boolean;\n    get launchDarklyClient(): LDClient;\n    get featureFlags(): FeatureFlags;\n    getFeatureFlag(key: string, defaultValue?: unknown): unknown;\n    get featureFlagSetSnapshot(): FeatureFlagSetSnapshot;\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport class FireflyRuntime<TRuntime extends FireflyRuntime = any> extends ReactRouterRuntime<TRuntime> implements IFireflyRuntime {\n    readonly #appRouterStore: AppRouterStore;\n    readonly #honeycombInstrumentationClient: HoneycombInstrumentationPartialClient | undefined;\n    readonly #isMswEnabled: boolean;\n    readonly #isLaunchDarklyEnabled: boolean;\n\n    constructor(options: FireflyRuntimeOptions = {}) {\n        const {\n            honeycombInstrumentationClient\n        } = options;\n\n        super(options);\n\n        this.#appRouterStore = createAppRouterStore(this._logger);\n        this.#honeycombInstrumentationClient = honeycombInstrumentationClient;\n        this.#isMswEnabled = this._plugins.some(x => x.name === MswPluginName);\n        this.#isLaunchDarklyEnabled = this._plugins.some(x => x.name === LaunchDarklyPluginName);\n    }\n\n    registerRoute(route: Route, options: RegisterRouteOptions = {}) {\n        if (this.moduleManager.getAreModulesRegistered()) {\n            throw new Error(\"[squide] Cannot register a route once the modules are registered. Are you trying to register a route in a deferred registration function? Only navigation items can be registered in a deferred registration function.\");\n        }\n\n        super.registerRoute(route, options);\n    }\n\n    get isMswEnabled() {\n        return this.#isMswEnabled;\n    }\n\n    get mswState() {\n        return getMswPlugin(this).mswState;\n    }\n\n    registerRequestHandlers(handlers: RequestHandler[], options: RegisterRequestHandlersOptions = {}) {\n        const logger = this._getLogger(options);\n        const plugin = getMswPlugin(this);\n\n        if (this.moduleManager.getAreModulesRegistered()) {\n            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.\");\n        }\n\n        plugin.registerRequestHandlers(handlers, {\n            logger\n        });\n    }\n\n    // Must define a return type otherwise we get an \"error TS2742: The inferred type of 'requestHandlers' cannot be named\" error.\n    get requestHandlers(): RequestHandler[] {\n        return getMswPlugin(this).requestHandlers;\n    }\n\n    getEnvironmentVariable(key: EnvironmentVariableKey) {\n        return getEnvironmentVariablesPlugin(this).getVariable(key);\n    }\n\n    get environmentVariables() {\n        return getEnvironmentVariablesPlugin(this).getVariables();\n    }\n\n    registerEnvironmentVariable<T extends EnvironmentVariableKey>(key: T, value: EnvironmentVariables[T]) {\n        return getEnvironmentVariablesPlugin(this).registerVariable(key, value);\n    }\n\n    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>) {\n        return getEnvironmentVariablesPlugin(this).registerVariables(variables);\n    }\n\n    get appRouterStore() {\n        return this.#appRouterStore;\n    }\n\n    get honeycombInstrumentationClient() {\n        return this.#honeycombInstrumentationClient;\n    }\n\n    get isLaunchDarklyEnabled() {\n        return this.#isLaunchDarklyEnabled;\n    }\n\n    get launchDarklyClient() {\n        return getLaunchDarklyPlugin(this).client;\n    }\n\n    get featureFlags() {\n        return this.featureFlagSetSnapshot.value;\n    }\n\n    getFeatureFlag<T extends FeatureFlagKey>(key: T, defaultValue?: FeatureFlags[T]) {\n        return getLaunchDarklyPlugin(this).getFeatureFlag(key, defaultValue);\n    }\n\n    get featureFlagSetSnapshot() {\n        return getLaunchDarklyPlugin(this).featureFlagSetSnapshot;\n    }\n\n    startScope(logger: Logger): TRuntime {\n        return (new FireflyRuntimeScope(this, logger) as unknown) as TRuntime;\n    }\n}\n\nexport class FireflyRuntimeScope<TRuntime extends FireflyRuntime = FireflyRuntime> extends ReactRouterRuntimeScope<TRuntime> implements IFireflyRuntime {\n    get isMswEnabled() {\n        return this._runtime.isMswEnabled;\n    }\n\n    get mswState() {\n        return this._runtime.mswState;\n    }\n\n    registerRequestHandlers(handlers: RequestHandler[], options: RegisterRequestHandlersOptions = {}) {\n        this._runtime.registerRequestHandlers(handlers, {\n            ...options,\n            logger: this._getLogger(options)\n        });\n    }\n\n    // Must define a return type otherwise we get an \"error TS2742: The inferred type of 'requestHandlers' cannot be named\" error.\n    get requestHandlers(): RequestHandler[] {\n        return this._runtime.requestHandlers;\n    }\n\n    getEnvironmentVariable(key: EnvironmentVariableKey) {\n        return this._runtime.getEnvironmentVariable(key);\n    }\n\n    get environmentVariables() {\n        return this._runtime.environmentVariables;\n    }\n\n    registerEnvironmentVariable<T extends EnvironmentVariableKey>(key: T, value: EnvironmentVariables[T]) {\n        this._runtime.registerEnvironmentVariable(key, value);\n    }\n\n    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>) {\n        this._runtime.registerEnvironmentVariables(variables);\n    }\n\n    get appRouterStore(): AppRouterStore {\n        throw new Error(\"[squide] Cannot retrieve the app router store from a runtime scope instance.\");\n    }\n\n    get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient {\n        throw new Error(\"[squide] Cannot retrieve the Honeycomb instrumentation client from a runtime scope instance.\");\n    }\n\n    get isLaunchDarklyEnabled() {\n        return this._runtime.isLaunchDarklyEnabled;\n    }\n\n    get launchDarklyClient() {\n        return this._runtime.launchDarklyClient;\n    }\n\n    get featureFlags() {\n        return this._runtime.featureFlags;\n    }\n\n    getFeatureFlag<T extends FeatureFlagKey>(key: T, defaultValue?: FeatureFlags[T]) {\n        // The error is because the FeatureFlags interface is empty as it is expected to be augmented by the\n        // consumer application.\n        // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n        // @ts-ignore\n        return this._runtime.getFeatureFlag(key, defaultValue);\n    }\n\n    get featureFlagSetSnapshot() {\n        return this._runtime.featureFlagSetSnapshot;\n    }\n}\n"],"names":["getEnvironmentVariablesPlugin","getLaunchDarklyPlugin","LaunchDarklyPluginName","getMswPlugin","MswPluginName","ReactRouterRuntime","ReactRouterRuntimeScope","createAppRouterStore","FireflyRuntime","options","honeycombInstrumentationClient","x","route","Error","handlers","logger","plugin","key","value","variables","defaultValue","FireflyRuntimeScope"],"mappings":";;;;;;;;;;;AAC+G;AAC6B;AACxE;AACqD;AAKzC;AA0BhF,8DAA8D;AACvD,MAAMQ,cAAcA,SAAgDH,kBAAkBA;IAChF,eAAe,CAAiB;IAChC,+BAA+B,CAAoD;IACnF,aAAa,CAAU;IACvB,sBAAsB,CAAU;IAEzC,YAAYI,UAAiC,CAAC,CAAC,CAAE;QAC7C,MAAM,EACFC,8BAA8B,EACjC,GAAGD;QAEJ,KAAK,CAACA;QAEN,IAAI,CAAC,eAAe,GAAGF,oBAAoBA,CAAC,IAAI,CAAC,OAAO;QACxD,IAAI,CAAC,+BAA+B,GAAGG;QACvC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAACC,CAAAA,IAAKA,EAAE,IAAI,KAAKP,aAAaA;QACrE,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAACO,CAAAA,IAAKA,EAAE,IAAI,KAAKT,sBAAsBA;IAC3F;IAEA,cAAcU,KAAY,EAAEH,UAAgC,CAAC,CAAC,EAAE;QAC5D,IAAI,IAAI,CAAC,aAAa,CAAC,uBAAuB,IAAI;YAC9C,MAAM,IAAII,MAAM;QACpB;QAEA,KAAK,CAAC,cAAcD,OAAOH;IAC/B;IAEA,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,aAAa;IAC7B;IAEA,IAAI,WAAW;QACX,OAAON,YAAYA,CAAC,IAAI,EAAE,QAAQ;IACtC;IAEA,wBAAwBW,QAA0B,EAAEL,UAA0C,CAAC,CAAC,EAAE;QAC9F,MAAMM,SAAS,IAAI,CAAC,UAAU,CAACN;QAC/B,MAAMO,SAASb,YAAYA,CAAC,IAAI;QAEhC,IAAI,IAAI,CAAC,aAAa,CAAC,uBAAuB,IAAI;YAC9C,MAAM,IAAIU,MAAM;QACpB;QAEAG,OAAO,uBAAuB,CAACF,UAAU;YACrCC;QACJ;IACJ;IAEA,8HAA8H;IAC9H,IAAI,kBAAoC;QACpC,OAAOZ,YAAYA,CAAC,IAAI,EAAE,eAAe;IAC7C;IAEA,uBAAuBc,GAA2B,EAAE;QAChD,OAAOjB,6BAA6BA,CAAC,IAAI,EAAE,WAAW,CAACiB;IAC3D;IAEA,IAAI,uBAAuB;QACvB,OAAOjB,6BAA6BA,CAAC,IAAI,EAAE,YAAY;IAC3D;IAEA,4BAA8DiB,GAAM,EAAEC,KAA8B,EAAE;QAClG,OAAOlB,6BAA6BA,CAAC,IAAI,EAAE,gBAAgB,CAACiB,KAAKC;IACrE;IAEA,6BAA6BC,SAAwC,EAAE;QACnE,OAAOnB,6BAA6BA,CAAC,IAAI,EAAE,iBAAiB,CAACmB;IACjE;IAEA,IAAI,iBAAiB;QACjB,OAAO,IAAI,CAAC,eAAe;IAC/B;IAEA,IAAI,iCAAiC;QACjC,OAAO,IAAI,CAAC,+BAA+B;IAC/C;IAEA,IAAI,wBAAwB;QACxB,OAAO,IAAI,CAAC,sBAAsB;IACtC;IAEA,IAAI,qBAAqB;QACrB,OAAOlB,qBAAqBA,CAAC,IAAI,EAAE,MAAM;IAC7C;IAEA,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,sBAAsB,CAAC,KAAK;IAC5C;IAEA,eAAyCgB,GAAM,EAAEG,YAA8B,EAAE;QAC7E,OAAOnB,qBAAqBA,CAAC,IAAI,EAAE,cAAc,CAACgB,KAAKG;IAC3D;IAEA,IAAI,yBAAyB;QACzB,OAAOnB,qBAAqBA,CAAC,IAAI,EAAE,sBAAsB;IAC7D;IAEA,WAAWc,MAAc,EAAY;QACjC,OAAQ,IAAIM,mBAAmBA,CAAC,IAAI,EAAEN;IAC1C;AACJ;AAEO,MAAMM,mBAAmBA,SAA2Df,uBAAuBA;IAC9G,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY;IACrC;IAEA,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ;IACjC;IAEA,wBAAwBQ,QAA0B,EAAEL,UAA0C,CAAC,CAAC,EAAE;QAC9F,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAACK,UAAU;YAC5C,GAAGL,OAAO;YACV,QAAQ,IAAI,CAAC,UAAU,CAACA;QAC5B;IACJ;IAEA,8HAA8H;IAC9H,IAAI,kBAAoC;QACpC,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe;IACxC;IAEA,uBAAuBQ,GAA2B,EAAE;QAChD,OAAO,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAACA;IAChD;IAEA,IAAI,uBAAuB;QACvB,OAAO,IAAI,CAAC,QAAQ,CAAC,oBAAoB;IAC7C;IAEA,4BAA8DA,GAAM,EAAEC,KAA8B,EAAE;QAClG,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAACD,KAAKC;IACnD;IAEA,6BAA6BC,SAAwC,EAAE;QACnE,IAAI,CAAC,QAAQ,CAAC,4BAA4B,CAACA;IAC/C;IAEA,IAAI,iBAAiC;QACjC,MAAM,IAAIN,MAAM;IACpB;IAEA,IAAI,iCAAwE;QACxE,MAAM,IAAIA,MAAM;IACpB;IAEA,IAAI,wBAAwB;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,qBAAqB;IAC9C;IAEA,IAAI,qBAAqB;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,kBAAkB;IAC3C;IAEA,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY;IACrC;IAEA,eAAyCI,GAAM,EAAEG,YAA8B,EAAE;QAC7E,oGAAoG;QACpG,wBAAwB;QACxB,6DAA6D;QAC7D,aAAa;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAACH,KAAKG;IAC7C;IAEA,IAAI,yBAAyB;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,sBAAsB;IAC/C;AACJ"}
+{"version":3,"file":"FireflyRuntime.js","sources":["../src/FireflyRuntime.tsx"],"sourcesContent":["import type { RegisterRouteOptions, RuntimeMethodOptions, RuntimeOptions } from \"@squide/core\";\nimport { EnvironmentVariableKey, EnvironmentVariables, getEnvironmentVariablesPlugin } from \"@squide/env-vars\";\nimport { FeatureFlagKey, FeatureFlags, FeatureFlagSetSnapshot, getLaunchDarklyPlugin, LaunchDarklyPluginName } from \"@squide/launch-darkly\";\nimport { getMswPlugin, MswPluginName, MswState } from \"@squide/msw\";\nimport { type IReactRouterRuntime, ReactRouterRuntime, ReactRouterRuntimeScope, type Route } from \"@squide/react-router\";\nimport type { HoneycombInstrumentationPartialClient } from \"@workleap-telemetry/core\";\nimport type { Logger } from \"@workleap/logging\";\nimport { LDClient } from \"launchdarkly-js-client-sdk\";\nimport type { RequestHandler } from \"msw\";\nimport { type AppRouterStore, createAppRouterStore } from \"./AppRouterStore.ts\";\n\nexport interface FireflyRuntimeOptions<TRuntime extends FireflyRuntime = FireflyRuntime> extends RuntimeOptions<TRuntime> {\n    honeycombInstrumentationClient?: HoneycombInstrumentationPartialClient;\n}\n\nexport interface RegisterRequestHandlersOptions extends RuntimeMethodOptions {\n    prepend?: true;\n}\n\nexport interface IFireflyRuntime extends IReactRouterRuntime {\n    get isMswEnabled(): boolean;\n    get mswState(): MswState;\n    registerRequestHandlers: (handlers: RequestHandler[], options?: RegisterRequestHandlersOptions) => void;\n    get requestHandlers(): RequestHandler[];\n    registerEnvironmentVariable<T extends EnvironmentVariableKey>(key: T, value: EnvironmentVariables[T]): void;\n    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>): void;\n    getEnvironmentVariable<T extends EnvironmentVariableKey>(key: T): EnvironmentVariables[T];\n    get environmentVariables(): EnvironmentVariables;\n    get appRouterStore(): AppRouterStore;\n    get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient | undefined;\n    get isLaunchDarklyEnabled(): boolean;\n    get launchDarklyClient(): LDClient;\n    get featureFlags(): FeatureFlags;\n    getFeatureFlag(key: string, defaultValue?: unknown): unknown;\n    get featureFlagSetSnapshot(): FeatureFlagSetSnapshot;\n}\n\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport class FireflyRuntime<TRuntime extends FireflyRuntime = any> extends ReactRouterRuntime<TRuntime> implements IFireflyRuntime {\n    readonly #appRouterStore: AppRouterStore;\n    readonly #honeycombInstrumentationClient: HoneycombInstrumentationPartialClient | undefined;\n    readonly #isMswEnabled: boolean;\n    readonly #isLaunchDarklyEnabled: boolean;\n\n    constructor(options: FireflyRuntimeOptions = {}) {\n        const {\n            honeycombInstrumentationClient\n        } = options;\n\n        super(options);\n\n        this.#appRouterStore = createAppRouterStore(this._logger);\n        this.#honeycombInstrumentationClient = honeycombInstrumentationClient;\n        this.#isMswEnabled = this._plugins.some(x => x.name === MswPluginName);\n        this.#isLaunchDarklyEnabled = this._plugins.some(x => x.name === LaunchDarklyPluginName);\n    }\n\n    registerRoute(route: Route, options: RegisterRouteOptions = {}) {\n        if (this.moduleManager.getAreModulesRegistered()) {\n            throw new Error(\"[squide] Cannot register a route once the modules are registered. Are you trying to register a route in a deferred registration function? Only navigation items can be registered in a deferred registration function.\");\n        }\n\n        super.registerRoute(route, options);\n    }\n\n    get isMswEnabled() {\n        return this.#isMswEnabled;\n    }\n\n    get mswState() {\n        return getMswPlugin(this).mswState;\n    }\n\n    registerRequestHandlers(handlers: RequestHandler[], options: RegisterRequestHandlersOptions = {}) {\n        const {\n            prepend\n        } = options;\n\n        const logger = this._getLogger(options);\n        const plugin = getMswPlugin(this);\n\n        if (this.moduleManager.getAreModulesRegistered()) {\n            throw new Error(\"[squide] Cannot register 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.\");\n        }\n\n        plugin.registerRequestHandlers(handlers, {\n            logger,\n            prepend\n        });\n    }\n\n    // Must define a return type otherwise we get an \"error TS2742: The inferred type of 'requestHandlers' cannot be named\" error.\n    get requestHandlers(): RequestHandler[] {\n        return getMswPlugin(this).requestHandlers;\n    }\n\n    getEnvironmentVariable(key: EnvironmentVariableKey) {\n        return getEnvironmentVariablesPlugin(this).getVariable(key);\n    }\n\n    get environmentVariables() {\n        return getEnvironmentVariablesPlugin(this).getVariables();\n    }\n\n    registerEnvironmentVariable<T extends EnvironmentVariableKey>(key: T, value: EnvironmentVariables[T]) {\n        return getEnvironmentVariablesPlugin(this).registerVariable(key, value);\n    }\n\n    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>) {\n        return getEnvironmentVariablesPlugin(this).registerVariables(variables);\n    }\n\n    get appRouterStore() {\n        return this.#appRouterStore;\n    }\n\n    get honeycombInstrumentationClient() {\n        return this.#honeycombInstrumentationClient;\n    }\n\n    get isLaunchDarklyEnabled() {\n        return this.#isLaunchDarklyEnabled;\n    }\n\n    get launchDarklyClient() {\n        return getLaunchDarklyPlugin(this).client;\n    }\n\n    get featureFlags() {\n        return this.featureFlagSetSnapshot.value;\n    }\n\n    getFeatureFlag<T extends FeatureFlagKey>(key: T, defaultValue?: FeatureFlags[T]) {\n        return getLaunchDarklyPlugin(this).getFeatureFlag(key, defaultValue);\n    }\n\n    get featureFlagSetSnapshot() {\n        return getLaunchDarklyPlugin(this).featureFlagSetSnapshot;\n    }\n\n    startScope(logger: Logger): TRuntime {\n        return (new FireflyRuntimeScope(this, logger) as unknown) as TRuntime;\n    }\n}\n\nexport class FireflyRuntimeScope<TRuntime extends FireflyRuntime = FireflyRuntime> extends ReactRouterRuntimeScope<TRuntime> implements IFireflyRuntime {\n    get isMswEnabled() {\n        return this._runtime.isMswEnabled;\n    }\n\n    get mswState() {\n        return this._runtime.mswState;\n    }\n\n    registerRequestHandlers(handlers: RequestHandler[], options: RegisterRequestHandlersOptions = {}) {\n        this._runtime.registerRequestHandlers(handlers, {\n            ...options,\n            logger: this._getLogger(options)\n        });\n    }\n\n    // Must define a return type otherwise we get an \"error TS2742: The inferred type of 'requestHandlers' cannot be named\" error.\n    get requestHandlers(): RequestHandler[] {\n        return this._runtime.requestHandlers;\n    }\n\n    getEnvironmentVariable(key: EnvironmentVariableKey) {\n        return this._runtime.getEnvironmentVariable(key);\n    }\n\n    get environmentVariables() {\n        return this._runtime.environmentVariables;\n    }\n\n    registerEnvironmentVariable<T extends EnvironmentVariableKey>(key: T, value: EnvironmentVariables[T]) {\n        this._runtime.registerEnvironmentVariable(key, value);\n    }\n\n    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>) {\n        this._runtime.registerEnvironmentVariables(variables);\n    }\n\n    get appRouterStore(): AppRouterStore {\n        throw new Error(\"[squide] Cannot retrieve the app router store from a runtime scope instance.\");\n    }\n\n    get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient {\n        throw new Error(\"[squide] Cannot retrieve the Honeycomb instrumentation client from a runtime scope instance.\");\n    }\n\n    get isLaunchDarklyEnabled() {\n        return this._runtime.isLaunchDarklyEnabled;\n    }\n\n    get launchDarklyClient() {\n        return this._runtime.launchDarklyClient;\n    }\n\n    get featureFlags() {\n        return this._runtime.featureFlags;\n    }\n\n    getFeatureFlag<T extends FeatureFlagKey>(key: T, defaultValue?: FeatureFlags[T]) {\n        // The error is because the FeatureFlags interface is empty as it is expected to be augmented by the\n        // consumer application.\n        // eslint-disable-next-line @typescript-eslint/ban-ts-comment\n        // @ts-ignore\n        return this._runtime.getFeatureFlag(key, defaultValue);\n    }\n\n    get featureFlagSetSnapshot() {\n        return this._runtime.featureFlagSetSnapshot;\n    }\n}\n"],"names":["getEnvironmentVariablesPlugin","getLaunchDarklyPlugin","LaunchDarklyPluginName","getMswPlugin","MswPluginName","ReactRouterRuntime","ReactRouterRuntimeScope","createAppRouterStore","FireflyRuntime","options","honeycombInstrumentationClient","x","route","Error","handlers","prepend","logger","plugin","key","value","variables","defaultValue","FireflyRuntimeScope"],"mappings":";;;;;;;;;;;AAC+G;AAC6B;AACxE;AACqD;AAKzC;AA4BhF,8DAA8D;AACvD,MAAMQ,cAAcA,SAAgDH,kBAAkBA;IAChF,eAAe,CAAiB;IAChC,+BAA+B,CAAoD;IACnF,aAAa,CAAU;IACvB,sBAAsB,CAAU;IAEzC,YAAYI,UAAiC,CAAC,CAAC,CAAE;QAC7C,MAAM,EACFC,8BAA8B,EACjC,GAAGD;QAEJ,KAAK,CAACA;QAEN,IAAI,CAAC,eAAe,GAAGF,oBAAoBA,CAAC,IAAI,CAAC,OAAO;QACxD,IAAI,CAAC,+BAA+B,GAAGG;QACvC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAACC,CAAAA,IAAKA,EAAE,IAAI,KAAKP,aAAaA;QACrE,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAACO,CAAAA,IAAKA,EAAE,IAAI,KAAKT,sBAAsBA;IAC3F;IAEA,cAAcU,KAAY,EAAEH,UAAgC,CAAC,CAAC,EAAE;QAC5D,IAAI,IAAI,CAAC,aAAa,CAAC,uBAAuB,IAAI;YAC9C,MAAM,IAAII,MAAM;QACpB;QAEA,KAAK,CAAC,cAAcD,OAAOH;IAC/B;IAEA,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,aAAa;IAC7B;IAEA,IAAI,WAAW;QACX,OAAON,YAAYA,CAAC,IAAI,EAAE,QAAQ;IACtC;IAEA,wBAAwBW,QAA0B,EAAEL,UAA0C,CAAC,CAAC,EAAE;QAC9F,MAAM,EACFM,OAAO,EACV,GAAGN;QAEJ,MAAMO,SAAS,IAAI,CAAC,UAAU,CAACP;QAC/B,MAAMQ,SAASd,YAAYA,CAAC,IAAI;QAEhC,IAAI,IAAI,CAAC,aAAa,CAAC,uBAAuB,IAAI;YAC9C,MAAM,IAAIU,MAAM;QACpB;QAEAI,OAAO,uBAAuB,CAACH,UAAU;YACrCE;YACAD;QACJ;IACJ;IAEA,8HAA8H;IAC9H,IAAI,kBAAoC;QACpC,OAAOZ,YAAYA,CAAC,IAAI,EAAE,eAAe;IAC7C;IAEA,uBAAuBe,GAA2B,EAAE;QAChD,OAAOlB,6BAA6BA,CAAC,IAAI,EAAE,WAAW,CAACkB;IAC3D;IAEA,IAAI,uBAAuB;QACvB,OAAOlB,6BAA6BA,CAAC,IAAI,EAAE,YAAY;IAC3D;IAEA,4BAA8DkB,GAAM,EAAEC,KAA8B,EAAE;QAClG,OAAOnB,6BAA6BA,CAAC,IAAI,EAAE,gBAAgB,CAACkB,KAAKC;IACrE;IAEA,6BAA6BC,SAAwC,EAAE;QACnE,OAAOpB,6BAA6BA,CAAC,IAAI,EAAE,iBAAiB,CAACoB;IACjE;IAEA,IAAI,iBAAiB;QACjB,OAAO,IAAI,CAAC,eAAe;IAC/B;IAEA,IAAI,iCAAiC;QACjC,OAAO,IAAI,CAAC,+BAA+B;IAC/C;IAEA,IAAI,wBAAwB;QACxB,OAAO,IAAI,CAAC,sBAAsB;IACtC;IAEA,IAAI,qBAAqB;QACrB,OAAOnB,qBAAqBA,CAAC,IAAI,EAAE,MAAM;IAC7C;IAEA,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,sBAAsB,CAAC,KAAK;IAC5C;IAEA,eAAyCiB,GAAM,EAAEG,YAA8B,EAAE;QAC7E,OAAOpB,qBAAqBA,CAAC,IAAI,EAAE,cAAc,CAACiB,KAAKG;IAC3D;IAEA,IAAI,yBAAyB;QACzB,OAAOpB,qBAAqBA,CAAC,IAAI,EAAE,sBAAsB;IAC7D;IAEA,WAAWe,MAAc,EAAY;QACjC,OAAQ,IAAIM,mBAAmBA,CAAC,IAAI,EAAEN;IAC1C;AACJ;AAEO,MAAMM,mBAAmBA,SAA2DhB,uBAAuBA;IAC9G,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY;IACrC;IAEA,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ;IACjC;IAEA,wBAAwBQ,QAA0B,EAAEL,UAA0C,CAAC,CAAC,EAAE;QAC9F,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAACK,UAAU;YAC5C,GAAGL,OAAO;YACV,QAAQ,IAAI,CAAC,UAAU,CAACA;QAC5B;IACJ;IAEA,8HAA8H;IAC9H,IAAI,kBAAoC;QACpC,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe;IACxC;IAEA,uBAAuBS,GAA2B,EAAE;QAChD,OAAO,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAACA;IAChD;IAEA,IAAI,uBAAuB;QACvB,OAAO,IAAI,CAAC,QAAQ,CAAC,oBAAoB;IAC7C;IAEA,4BAA8DA,GAAM,EAAEC,KAA8B,EAAE;QAClG,IAAI,CAAC,QAAQ,CAAC,2BAA2B,CAACD,KAAKC;IACnD;IAEA,6BAA6BC,SAAwC,EAAE;QACnE,IAAI,CAAC,QAAQ,CAAC,4BAA4B,CAACA;IAC/C;IAEA,IAAI,iBAAiC;QACjC,MAAM,IAAIP,MAAM;IACpB;IAEA,IAAI,iCAAwE;QACxE,MAAM,IAAIA,MAAM;IACpB;IAEA,IAAI,wBAAwB;QACxB,OAAO,IAAI,CAAC,QAAQ,CAAC,qBAAqB;IAC9C;IAEA,IAAI,qBAAqB;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,kBAAkB;IAC3C;IAEA,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY;IACrC;IAEA,eAAyCK,GAAM,EAAEG,YAA8B,EAAE;QAC7E,oGAAoG;QACpG,wBAAwB;QACxB,6DAA6D;QAC7D,aAAa;QACb,OAAO,IAAI,CAAC,QAAQ,CAAC,cAAc,CAACH,KAAKG;IAC7C;IAEA,IAAI,yBAAyB;QACzB,OAAO,IAAI,CAAC,QAAQ,CAAC,sBAAsB;IAC/C;AACJ"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@squide/firefly",
   "author": "Workleap",
-  "version": "17.1.0",
+  "version": "17.2.0",
   "description": "Squide bundle for the firefly technology stack.",
   "license": "Apache-2.0",
   "repository": {
@@ -51,9 +51,9 @@
     "uuid": "^14.0.0",
     "@squide/core": "^7.1.0",
     "@squide/env-vars": "^1.4.22",
-    "@squide/launch-darkly": "^1.0.15",
-    "@squide/msw": "^4.0.20",
-    "@squide/react-router": "^8.2.0"
+    "@squide/react-router": "^8.2.0",
+    "@squide/msw": "^4.1.0",
+    "@squide/launch-darkly": "^1.0.15"
   },
   "devDependencies": {
     "@eslint/js": "9.39.2",

package/src/FireflyRuntime.tsx

@@ -13,12 +13,14 @@ export interface FireflyRuntimeOptions<TRuntime extends FireflyRuntime = Firefly
     honeycombInstrumentationClient?: HoneycombInstrumentationPartialClient;
 }
 
-export interface RegisterRequestHandlersOptions extends RuntimeMethodOptions {}
+export interface RegisterRequestHandlersOptions extends RuntimeMethodOptions {
+    prepend?: true;
+}
 
 export interface IFireflyRuntime extends IReactRouterRuntime {
     get isMswEnabled(): boolean;
     get mswState(): MswState;
-    registerRequestHandlers: (handlers: RequestHandler[]) => void;
+    registerRequestHandlers: (handlers: RequestHandler[], options?: RegisterRequestHandlersOptions) => void;
     get requestHandlers(): RequestHandler[];
     registerEnvironmentVariable<T extends EnvironmentVariableKey>(key: T, value: EnvironmentVariables[T]): void;
     registerEnvironmentVariables(variables: Partial<EnvironmentVariables>): void;
@@ -70,15 +72,20 @@ export class FireflyRuntime<TRuntime extends FireflyRuntime = any> extends React
     }
 
     registerRequestHandlers(handlers: RequestHandler[], options: RegisterRequestHandlersOptions = {}) {
+        const {
+            prepend
+        } = options;
+
         const logger = this._getLogger(options);
         const plugin = getMswPlugin(this);
 
         if (this.moduleManager.getAreModulesRegistered()) {
-            throw new Error("[squide] Cannot register an MSW request handlers once the modules are registered. Are you trying to register an MSW request handler in a deferred registration function? Only navigation items can be registered in a deferred registration function.");
+            throw new Error("[squide] Cannot register 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.");
         }
 
         plugin.registerRequestHandlers(handlers, {
-            logger
+            logger,
+            prepend
         });
     }