@squide/firefly 16.0.0 → 16.0.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @squide/firefly
 
+## 16.0.1
+
+### Patch Changes
+
+- [#342](https://github.com/workleap/wl-squide/pull/342) [`3be4070`](https://github.com/workleap/wl-squide/commit/3be4070d2d647804903b5cc01113e20d5d71cb11) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Minor fine tuning following v16 release.
+
+- Updated dependencies [[`3be4070`](https://github.com/workleap/wl-squide/commit/3be4070d2d647804903b5cc01113e20d5d71cb11)]:
+  - @squide/env-vars@1.4.8
+  - @squide/core@6.1.5
+  - @squide/msw@4.0.6
+  - @squide/react-router@8.1.5
+
 ## 16.0.0
 
 ### Major Changes

package/dist/FireflyRuntime.d.ts

@@ -1,4 +1,5 @@
 import type { RegisterRouteOptions, RuntimeMethodOptions, RuntimeOptions } from "@squide/core";
+import { EnvironmentVariableKey, EnvironmentVariables, EnvironmentVariableValue } from "@squide/env-vars";
 import { MswState } from "@squide/msw";
 import { type IReactRouterRuntime, ReactRouterRuntime, ReactRouterRuntimeScope, type Route } from "@squide/react-router";
 import type { HoneycombInstrumentationPartialClient } from "@workleap-telemetry/core";
@@ -14,20 +15,28 @@ export interface IFireflyRuntime extends IReactRouterRuntime {
     getMswState(): MswState;
     registerRequestHandlers: (handlers: RequestHandler[]) => void;
     get requestHandlers(): RequestHandler[];
-    get appRouterStore(): AppRouterStore;
     get isMswEnabled(): boolean;
+    registerEnvironmentVariable(key: EnvironmentVariableKey, value: EnvironmentVariableValue): void;
+    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>): void;
+    getEnvironmentVariable(key: EnvironmentVariableKey): EnvironmentVariableValue;
+    getEnvironmentVariables(): EnvironmentVariables;
+    get appRouterStore(): AppRouterStore;
     get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient | undefined;
 }
 export declare class FireflyRuntime<TRuntime extends FireflyRuntime = any> extends ReactRouterRuntime<TRuntime> implements IFireflyRuntime {
     protected _appRouterStore: AppRouterStore;
     protected _honeycombInstrumentationClient: HoneycombInstrumentationPartialClient | undefined;
-    constructor({ honeycombInstrumentationClient, ...options }?: FireflyRuntimeOptions);
+    constructor(options?: FireflyRuntimeOptions);
+    registerRoute(route: Route, options?: RegisterRouteOptions): void;
     getMswState(): MswState;
     registerRequestHandlers(handlers: RequestHandler[], options?: RegisterRequestHandlersOptions): void;
     get requestHandlers(): RequestHandler[];
-    registerRoute(route: Route, options?: RegisterRouteOptions): void;
-    get appRouterStore(): AppRouterStore;
     get isMswEnabled(): boolean;
+    getEnvironmentVariable(key: EnvironmentVariableKey): never;
+    getEnvironmentVariables(): EnvironmentVariables;
+    registerEnvironmentVariable(key: EnvironmentVariableKey, value: EnvironmentVariableValue): void;
+    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>): void;
+    get appRouterStore(): AppRouterStore;
     get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient | undefined;
     startScope(logger: Logger): TRuntime;
 }
@@ -35,7 +44,11 @@ export declare class FireflyRuntimeScope<TRuntime extends FireflyRuntime = Firef
     getMswState(): MswState;
     registerRequestHandlers(handlers: RequestHandler[], options?: RegisterRequestHandlersOptions): void;
     get requestHandlers(): RequestHandler[];
-    get appRouterStore(): AppRouterStore;
     get isMswEnabled(): boolean;
+    getEnvironmentVariables(): EnvironmentVariables;
+    getEnvironmentVariable(key: EnvironmentVariableKey): never;
+    registerEnvironmentVariable(key: EnvironmentVariableKey, value: EnvironmentVariableValue): void;
+    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>): void;
+    get appRouterStore(): AppRouterStore;
     get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient;
 }

package/dist/FireflyRuntime.js

@@ -1,7 +1,10 @@
-import { MswPluginName } from "@squide/msw";
+import { getEnvironmentVariablesPlugin } from "@squide/env-vars";
+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/msw"
 
 ;// CONCATENATED MODULE: external "@squide/react-router"
@@ -12,55 +15,64 @@ import { createAppRouterStore } from "./AppRouterStore.js";
 
 
 
+
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 class FireflyRuntime extends ReactRouterRuntime {
     _appRouterStore;
     _honeycombInstrumentationClient;
-    constructor({ honeycombInstrumentationClient, ...options } = {}){
+    constructor(options = {}){
+        const { honeycombInstrumentationClient } = options;
         super(options);
         this._appRouterStore = createAppRouterStore(this._logger);
         this._honeycombInstrumentationClient = honeycombInstrumentationClient;
     }
-    getMswState() {
-        const mswPlugin = this.getPlugin(MswPluginName);
-        if (!mswPlugin) {
-            throw new Error("[squide] Cannot register the provided MSW request handlers because the runtime hasn't been initialized with MSW. Did you instanciate the FireflyRuntime with the \"useMsw\" option?");
+    registerRoute(route, options = {}) {
+        if (this.moduleManager.getAreModulesRegistered()) {
+            throw new Error("[squide] Cannot register a route once the modules are registered. Are you trying to register a route in a deferred registration function? Only navigation items can be registered in a deferred registration function.");
         }
-        return mswPlugin.mswState;
+        super.registerRoute(route, options);
+    }
+    getMswState() {
+        const plugin = getMswPlugin(this);
+        return plugin.mswState;
     }
     registerRequestHandlers(handlers, options = {}) {
         const logger = this._getLogger(options);
-        const mswPlugin = this.getPlugin(MswPluginName);
-        if (!mswPlugin) {
-            throw new Error("[squide] Cannot register the provided MSW request handlers because the runtime hasn't been initialized with MSW. Did you instanciate the FireflyRuntime with the \"useMsw\" option?");
-        }
+        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.");
         }
-        mswPlugin.registerRequestHandlers(handlers, {
+        plugin.registerRequestHandlers(handlers, {
             logger
         });
     }
     // Must define a return type otherwise we get an "error TS2742: The inferred type of 'requestHandlers' cannot be named" error.
     get requestHandlers() {
-        const mswPlugin = this.getPlugin(MswPluginName);
-        if (!mswPlugin) {
-            throw new Error("[squide] Cannot retrieve MSW request handlers because the runtime hasn't been initialized with MSW. Did you instanciate the FireflyRuntime with the \"useMsw\" option?");
-        }
-        return mswPlugin.requestHandlers;
+        const plugin = getMswPlugin(this);
+        return plugin.requestHandlers;
     }
-    registerRoute(route, options = {}) {
-        if (this.moduleManager.getAreModulesRegistered()) {
-            throw new Error("[squide] Cannot register a route once the modules are registered. Are you trying to register a route in a deferred registration function? Only navigation items can be registered in a deferred registration function.");
-        }
-        super.registerRoute(route, options);
+    get isMswEnabled() {
+        return this._plugins.some((x)=>x.name === MswPluginName);
+    }
+    getEnvironmentVariable(key) {
+        const plugin = getEnvironmentVariablesPlugin(this);
+        return plugin.getVariable(key);
+    }
+    getEnvironmentVariables() {
+        const plugin = getEnvironmentVariablesPlugin(this);
+        return plugin.getVariables();
+    }
+    registerEnvironmentVariable(key, value) {
+        const plugin = getEnvironmentVariablesPlugin(this);
+        return plugin.registerVariable(key, value);
+    }
+    registerEnvironmentVariables(variables) {
+        const plugin = getEnvironmentVariablesPlugin(this);
+        return plugin.registerVariables(variables);
     }
     get appRouterStore() {
         return this._appRouterStore;
     }
-    get isMswEnabled() {
-        return this._plugins.some((x)=>x.name === MswPluginName);
-    }
     get honeycombInstrumentationClient() {
         return this._honeycombInstrumentationClient;
     }
@@ -82,12 +94,24 @@ class FireflyRuntimeScope extends ReactRouterRuntimeScope {
     get requestHandlers() {
         return this._runtime.requestHandlers;
     }
-    get appRouterStore() {
-        throw new Error("[squide] Cannot retrieve the app router store from a runtime scope instance.");
-    }
     get isMswEnabled() {
         return this._runtime.isMswEnabled;
     }
+    getEnvironmentVariables() {
+        return this._runtime.getEnvironmentVariables();
+    }
+    getEnvironmentVariable(key) {
+        return this._runtime.getEnvironmentVariable(key);
+    }
+    registerEnvironmentVariable(key, value) {
+        this._runtime.registerEnvironmentVariable(key, value);
+    }
+    registerEnvironmentVariables(variables) {
+        this._runtime.registerEnvironmentVariables(variables);
+    }
+    get appRouterStore() {
+        throw new Error("[squide] Cannot retrieve the app router store from a runtime scope instance.");
+    }
     get honeycombInstrumentationClient() {
         throw new Error("[squide] Cannot retrieve the Honeycomb instrumentation client from a runtime scope instance.");
     }

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 { MswPlugin, 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 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    getMswState(): MswState;\n    registerRequestHandlers: (handlers: RequestHandler[]) => void;\n    get requestHandlers(): RequestHandler[];\n    get appRouterStore(): AppRouterStore;\n    get isMswEnabled(): boolean;\n    get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient | undefined;\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    protected _appRouterStore: AppRouterStore;\n    protected _honeycombInstrumentationClient: HoneycombInstrumentationPartialClient | undefined;\n\n    constructor({ honeycombInstrumentationClient, ...options }: FireflyRuntimeOptions = {}) {\n        super(options);\n\n        this._appRouterStore = createAppRouterStore(this._logger);\n        this._honeycombInstrumentationClient = honeycombInstrumentationClient;\n    }\n\n    getMswState() {\n        const mswPlugin = this.getPlugin(MswPluginName) as MswPlugin;\n\n        if (!mswPlugin) {\n            throw new Error(\"[squide] Cannot register the provided MSW request handlers because the runtime hasn't been initialized with MSW. Did you instanciate the FireflyRuntime with the \\\"useMsw\\\" option?\");\n        }\n\n        return mswPlugin.mswState;\n    }\n\n    registerRequestHandlers(handlers: RequestHandler[], options: RegisterRequestHandlersOptions = {}) {\n        const logger = this._getLogger(options);\n        const mswPlugin = this.getPlugin(MswPluginName) as MswPlugin;\n\n        if (!mswPlugin) {\n            throw new Error(\"[squide] Cannot register the provided MSW request handlers because the runtime hasn't been initialized with MSW. Did you instanciate the FireflyRuntime with the \\\"useMsw\\\" option?\");\n        }\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        mswPlugin.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        const mswPlugin = this.getPlugin(MswPluginName) as MswPlugin;\n\n        if (!mswPlugin) {\n            throw new Error(\"[squide] Cannot retrieve MSW request handlers because the runtime hasn't been initialized with MSW. Did you instanciate the FireflyRuntime with the \\\"useMsw\\\" option?\");\n        }\n\n        return mswPlugin.requestHandlers;\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 appRouterStore() {\n        return this._appRouterStore;\n    }\n\n    get isMswEnabled() {\n        return this._plugins.some(x => x.name === MswPluginName);\n    }\n\n    get honeycombInstrumentationClient() {\n        return this._honeycombInstrumentationClient;\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    getMswState() {\n        return this._runtime.getMswState();\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    get appRouterStore(): AppRouterStore {\n        throw new Error(\"[squide] Cannot retrieve the app router store from a runtime scope instance.\");\n    }\n\n    get isMswEnabled() {\n        return this._runtime.isMswEnabled;\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"],"names":["MswPluginName","ReactRouterRuntime","ReactRouterRuntimeScope","createAppRouterStore","FireflyRuntime","honeycombInstrumentationClient","options","mswPlugin","Error","handlers","logger","route","x","FireflyRuntimeScope"],"mappings":";;;;;;;;;;;AACiE;AACwD;AAIzC;AAiBhF,8DAA8D;AACvD,MAAMI,uBAA8DH,kBAAkBA;IAC/E,gBAAgC;IAChC,gCAAmF;IAE7F,YAAY,EAAEI,8BAA8B,EAAE,GAAGC,SAAgC,GAAG,CAAC,CAAC,CAAE;QACpF,KAAK,CAACA;QAEN,IAAI,CAAC,eAAe,GAAGH,oBAAoBA,CAAC,IAAI,CAAC,OAAO;QACxD,IAAI,CAAC,+BAA+B,GAAGE;IAC3C;IAEA,cAAc;QACV,MAAME,YAAY,IAAI,CAAC,SAAS,CAACP,aAAaA;QAE9C,IAAI,CAACO,WAAW;YACZ,MAAM,IAAIC,MAAM;QACpB;QAEA,OAAOD,UAAU,QAAQ;IAC7B;IAEA,wBAAwBE,QAA0B,EAAEH,UAA0C,CAAC,CAAC,EAAE;QAC9F,MAAMI,SAAS,IAAI,CAAC,UAAU,CAACJ;QAC/B,MAAMC,YAAY,IAAI,CAAC,SAAS,CAACP,aAAaA;QAE9C,IAAI,CAACO,WAAW;YACZ,MAAM,IAAIC,MAAM;QACpB;QAEA,IAAI,IAAI,CAAC,aAAa,CAAC,uBAAuB,IAAI;YAC9C,MAAM,IAAIA,MAAM;QACpB;QAEAD,UAAU,uBAAuB,CAACE,UAAU;YACxCC;QACJ;IACJ;IAEA,8HAA8H;IAC9H,IAAI,kBAAoC;QACpC,MAAMH,YAAY,IAAI,CAAC,SAAS,CAACP,aAAaA;QAE9C,IAAI,CAACO,WAAW;YACZ,MAAM,IAAIC,MAAM;QACpB;QAEA,OAAOD,UAAU,eAAe;IACpC;IAEA,cAAcI,KAAY,EAAEL,UAAgC,CAAC,CAAC,EAAE;QAC5D,IAAI,IAAI,CAAC,aAAa,CAAC,uBAAuB,IAAI;YAC9C,MAAM,IAAIE,MAAM;QACpB;QAEA,KAAK,CAAC,cAAcG,OAAOL;IAC/B;IAEA,IAAI,iBAAiB;QACjB,OAAO,IAAI,CAAC,eAAe;IAC/B;IAEA,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAACM,CAAAA,IAAKA,EAAE,IAAI,KAAKZ,aAAaA;IAC3D;IAEA,IAAI,iCAAiC;QACjC,OAAO,IAAI,CAAC,+BAA+B;IAC/C;IAEA,WAAWU,MAAc,EAAY;QACjC,OAAQ,IAAIG,oBAAoB,IAAI,EAAEH;IAC1C;AACJ;AAEO,MAAMG,4BAA8EX,uBAAuBA;IAC9G,cAAc;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW;IACpC;IAEA,wBAAwBO,QAA0B,EAAEH,UAA0C,CAAC,CAAC,EAAE;QAC9F,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CAACG,UAAU;YAC5C,GAAGH,OAAO;YACV,QAAQ,IAAI,CAAC,UAAU,CAACA;QAC5B;IACJ;IAEA,8HAA8H;IAC9H,IAAI,kBAAoC;QACpC,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe;IACxC;IAEA,IAAI,iBAAiC;QACjC,MAAM,IAAIE,MAAM;IACpB;IAEA,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY;IACrC;IAEA,IAAI,iCAAwE;QACxE,MAAM,IAAIA,MAAM;IACpB;AACJ"}
+{"version":3,"file":"FireflyRuntime.js","sources":["../src/FireflyRuntime.tsx"],"sourcesContent":["import type { RegisterRouteOptions, RuntimeMethodOptions, RuntimeOptions } from \"@squide/core\";\nimport { EnvironmentVariableKey, EnvironmentVariables, EnvironmentVariableValue, getEnvironmentVariablesPlugin } from \"@squide/env-vars\";\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 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    getMswState(): MswState;\n    registerRequestHandlers: (handlers: RequestHandler[]) => void;\n    get requestHandlers(): RequestHandler[];\n    get isMswEnabled(): boolean;\n    registerEnvironmentVariable(key: EnvironmentVariableKey, value: EnvironmentVariableValue): void;\n    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>): void;\n    getEnvironmentVariable(key: EnvironmentVariableKey): EnvironmentVariableValue;\n    getEnvironmentVariables(): EnvironmentVariables;\n    get appRouterStore(): AppRouterStore;\n    get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient | undefined;\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    protected _appRouterStore: AppRouterStore;\n    protected _honeycombInstrumentationClient: HoneycombInstrumentationPartialClient | undefined;\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    }\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    getMswState() {\n        const plugin = getMswPlugin(this);\n\n        return plugin.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        const plugin = getMswPlugin(this);\n\n        return plugin.requestHandlers;\n    }\n\n    get isMswEnabled() {\n        return this._plugins.some(x => x.name === MswPluginName);\n    }\n\n    getEnvironmentVariable(key: EnvironmentVariableKey) {\n        const plugin = getEnvironmentVariablesPlugin(this);\n\n        return plugin.getVariable(key);\n    }\n\n    getEnvironmentVariables() {\n        const plugin = getEnvironmentVariablesPlugin(this);\n\n        return plugin.getVariables();\n    }\n\n    registerEnvironmentVariable(key: EnvironmentVariableKey, value: EnvironmentVariableValue) {\n        const plugin = getEnvironmentVariablesPlugin(this);\n\n        return plugin.registerVariable(key, value);\n    }\n\n    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>) {\n        const plugin = getEnvironmentVariablesPlugin(this);\n\n        return plugin.registerVariables(variables);\n    }\n\n    get appRouterStore() {\n        return this._appRouterStore;\n    }\n\n    get honeycombInstrumentationClient() {\n        return this._honeycombInstrumentationClient;\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    getMswState() {\n        return this._runtime.getMswState();\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    get isMswEnabled() {\n        return this._runtime.isMswEnabled;\n    }\n\n    getEnvironmentVariables() {\n        return this._runtime.getEnvironmentVariables();\n    }\n\n    getEnvironmentVariable(key: EnvironmentVariableKey) {\n        return this._runtime.getEnvironmentVariable(key);\n    }\n\n    registerEnvironmentVariable(key: EnvironmentVariableKey, value: EnvironmentVariableValue) {\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"],"names":["getEnvironmentVariablesPlugin","getMswPlugin","MswPluginName","ReactRouterRuntime","ReactRouterRuntimeScope","createAppRouterStore","FireflyRuntime","options","honeycombInstrumentationClient","route","Error","plugin","handlers","logger","x","key","value","variables","FireflyRuntimeScope"],"mappings":";;;;;;;;;;;;;;AACyI;AACrE;AACqD;AAIzC;AAqBhF,8DAA8D;AACvD,MAAMM,uBAA8DH,kBAAkBA;IAC/E,gBAAgC;IAChC,gCAAmF;IAE7F,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;IAC3C;IAEA,cAAcC,KAAY,EAAEF,UAAgC,CAAC,CAAC,EAAE;QAC5D,IAAI,IAAI,CAAC,aAAa,CAAC,uBAAuB,IAAI;YAC9C,MAAM,IAAIG,MAAM;QACpB;QAEA,KAAK,CAAC,cAAcD,OAAOF;IAC/B;IAEA,cAAc;QACV,MAAMI,SAASV,YAAYA,CAAC,IAAI;QAEhC,OAAOU,OAAO,QAAQ;IAC1B;IAEA,wBAAwBC,QAA0B,EAAEL,UAA0C,CAAC,CAAC,EAAE;QAC9F,MAAMM,SAAS,IAAI,CAAC,UAAU,CAACN;QAC/B,MAAMI,SAASV,YAAYA,CAAC,IAAI;QAEhC,IAAI,IAAI,CAAC,aAAa,CAAC,uBAAuB,IAAI;YAC9C,MAAM,IAAIS,MAAM;QACpB;QAEAC,OAAO,uBAAuB,CAACC,UAAU;YACrCC;QACJ;IACJ;IAEA,8HAA8H;IAC9H,IAAI,kBAAoC;QACpC,MAAMF,SAASV,YAAYA,CAAC,IAAI;QAEhC,OAAOU,OAAO,eAAe;IACjC;IAEA,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAACG,CAAAA,IAAKA,EAAE,IAAI,KAAKZ,aAAaA;IAC3D;IAEA,uBAAuBa,GAA2B,EAAE;QAChD,MAAMJ,SAASX,6BAA6BA,CAAC,IAAI;QAEjD,OAAOW,OAAO,WAAW,CAACI;IAC9B;IAEA,0BAA0B;QACtB,MAAMJ,SAASX,6BAA6BA,CAAC,IAAI;QAEjD,OAAOW,OAAO,YAAY;IAC9B;IAEA,4BAA4BI,GAA2B,EAAEC,KAA+B,EAAE;QACtF,MAAML,SAASX,6BAA6BA,CAAC,IAAI;QAEjD,OAAOW,OAAO,gBAAgB,CAACI,KAAKC;IACxC;IAEA,6BAA6BC,SAAwC,EAAE;QACnE,MAAMN,SAASX,6BAA6BA,CAAC,IAAI;QAEjD,OAAOW,OAAO,iBAAiB,CAACM;IACpC;IAEA,IAAI,iBAAiB;QACjB,OAAO,IAAI,CAAC,eAAe;IAC/B;IAEA,IAAI,iCAAiC;QACjC,OAAO,IAAI,CAAC,+BAA+B;IAC/C;IAEA,WAAWJ,MAAc,EAAY;QACjC,OAAQ,IAAIK,oBAAoB,IAAI,EAAEL;IAC1C;AACJ;AAEO,MAAMK,4BAA8Ed,uBAAuBA;IAC9G,cAAc;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW;IACpC;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,IAAI,eAAe;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,YAAY;IACrC;IAEA,0BAA0B;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC,uBAAuB;IAChD;IAEA,uBAAuBQ,GAA2B,EAAE;QAChD,OAAO,IAAI,CAAC,QAAQ,CAAC,sBAAsB,CAACA;IAChD;IAEA,4BAA4BA,GAA2B,EAAEC,KAA+B,EAAE;QACtF,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;AACJ"}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from "@squide/core";
-export * from "@squide/msw";
+export { EnvironmentVariablesPlugin, useEnvironmentVariable, useEnvironmentVariables, type EnvironmentVariableKey, type EnvironmentVariables, type EnvironmentVariablesPluginOptions, type EnvironmentVariableValue } from "@squide/env-vars";
+export { MswPlugin, MswState, type MswPluginOptions, type MswPluginRegisterRequestHandlersOptions, type MswReadyListener, type MswStateOptions } from "@squide/msw";
 export * from "@squide/react-router";
 export type { FireflyPlugin } from "./FireflyPlugin.ts";
 export * from "./FireflyProvider.tsx";

package/dist/index.js

@@ -1,6 +1,7 @@
+import { EnvironmentVariablesPlugin, useEnvironmentVariable, useEnvironmentVariables } from "@squide/env-vars";
+import { MswPlugin, MswState } from "@squide/msw";
 import { ActiveRouteIsProtectedEvent, ActiveRouteIsPublicEvent, ApplicationBoostrappedEvent, DeferredRegistrationsUpdatedEvent, ModulesReadyEvent, ModulesRegisteredEvent, MswReadyEvent, ProtectedDataReadyEvent, ProtectedDataUpdatedEvent, PublicDataReadyEvent, PublicDataUpdatedEvent } from "./AppRouterReducer.js";
 export * from "@squide/core";
-export * from "@squide/msw";
 export * from "@squide/react-router";
 export * from "./FireflyProvider.js";
 export * from "./FireflyRuntime.js";
@@ -24,6 +25,10 @@ export * from "./useStrictRegistrationMode.js";
 export * from "./useUpdateDeferredRegistrations.js";
 export * from "./initializeFirefly.js";
 
+;// CONCATENATED MODULE: external "@squide/env-vars"
+
+;// CONCATENATED MODULE: external "@squide/msw"
+
 ;// CONCATENATED MODULE: external "./AppRouterReducer.js"
 
 ;// CONCATENATED MODULE: ./src/index.ts
@@ -53,6 +58,7 @@ export * from "./initializeFirefly.js";
 
 
 
-export { ActiveRouteIsProtectedEvent, ActiveRouteIsPublicEvent, ApplicationBoostrappedEvent, DeferredRegistrationsUpdatedEvent, ModulesReadyEvent, ModulesRegisteredEvent, MswReadyEvent, ProtectedDataReadyEvent, ProtectedDataUpdatedEvent, PublicDataReadyEvent, PublicDataUpdatedEvent };
+
+export { ActiveRouteIsProtectedEvent, ActiveRouteIsPublicEvent, ApplicationBoostrappedEvent, DeferredRegistrationsUpdatedEvent, EnvironmentVariablesPlugin, ModulesReadyEvent, ModulesRegisteredEvent, MswPlugin, MswReadyEvent, MswState, ProtectedDataReadyEvent, ProtectedDataUpdatedEvent, PublicDataReadyEvent, PublicDataUpdatedEvent, useEnvironmentVariable, useEnvironmentVariables };
 
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["export * from \"@squide/core\";\nexport * from \"@squide/msw\";\nexport * from \"@squide/react-router\";\n\nexport type { FireflyPlugin } from \"./FireflyPlugin.ts\";\nexport * from \"./FireflyProvider.tsx\";\nexport * from \"./FireflyRuntime.tsx\";\n\nexport * from \"./AppRouter.tsx\";\nexport {\n    ActiveRouteIsProtectedEvent,\n    ActiveRouteIsPublicEvent,\n    ApplicationBoostrappedEvent,\n    DeferredRegistrationsUpdatedEvent,\n    ModulesReadyEvent,\n    ModulesRegisteredEvent,\n    MswReadyEvent,\n    ProtectedDataReadyEvent,\n    ProtectedDataUpdatedEvent,\n    PublicDataReadyEvent,\n    PublicDataUpdatedEvent\n} from \"./AppRouterReducer.ts\";\n\nexport * from \"./AppRouterStore.ts\";\nexport * from \"./GlobalDataQueriesError.ts\";\nexport * from \"./useCanFetchProtectedData.ts\";\nexport * from \"./useCanFetchPublicData.ts\";\nexport * from \"./useCanRegisterDeferredRegistrations.ts\";\nexport * from \"./useCanUpdateDeferredRegistrations.ts\";\nexport * from \"./useDeferredRegistrations.ts\";\nexport * from \"./useIsActiveRouteProtected.ts\";\nexport * from \"./useIsBootstrapping.ts\";\nexport * from \"./useNavigationItems.ts\";\nexport * from \"./useProtectedDataHandler.ts\";\nexport * from \"./useProtectedDataQueries.ts\";\nexport * from \"./usePublicDataHandler.ts\";\nexport * from \"./usePublicDataQueries.ts\";\nexport * from \"./useRegisterDeferredRegistrations.ts\";\nexport * from \"./useStrictRegistrationMode.ts\";\nexport * from \"./useUpdateDeferredRegistrations.ts\";\n\nexport * from \"./initializeFirefly.ts\";\n\n"],"names":["ActiveRouteIsProtectedEvent","ActiveRouteIsPublicEvent","ApplicationBoostrappedEvent","DeferredRegistrationsUpdatedEvent","ModulesReadyEvent","ModulesRegisteredEvent","MswReadyEvent","ProtectedDataReadyEvent","ProtectedDataUpdatedEvent","PublicDataReadyEvent","PublicDataUpdatedEvent"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAA6B;AACD;AACS;AAGC;AACD;AAEL;AAaD;AAEK;AACQ;AACE;AACH;AACc;AACF;AACT;AACC;AACP;AACA;AACK;AACA;AACH;AACA;AACY;AACP;AACK;AAEb"}
+{"version":3,"file":"index.js","sources":["../src/index.ts"],"sourcesContent":["export * from \"@squide/core\";\nexport {\n    EnvironmentVariablesPlugin,\n    useEnvironmentVariable,\n    useEnvironmentVariables,\n    type EnvironmentVariableKey,\n    type EnvironmentVariables,\n    type EnvironmentVariablesPluginOptions,\n    type EnvironmentVariableValue\n} from \"@squide/env-vars\";\nexport {\n    MswPlugin,\n    MswState,\n    type MswPluginOptions,\n    type MswPluginRegisterRequestHandlersOptions,\n    type MswReadyListener,\n    type MswStateOptions\n} from \"@squide/msw\";\nexport * from \"@squide/react-router\";\n\nexport type { FireflyPlugin } from \"./FireflyPlugin.ts\";\nexport * from \"./FireflyProvider.tsx\";\nexport * from \"./FireflyRuntime.tsx\";\n\nexport * from \"./AppRouter.tsx\";\nexport {\n    ActiveRouteIsProtectedEvent,\n    ActiveRouteIsPublicEvent,\n    ApplicationBoostrappedEvent,\n    DeferredRegistrationsUpdatedEvent,\n    ModulesReadyEvent,\n    ModulesRegisteredEvent,\n    MswReadyEvent,\n    ProtectedDataReadyEvent,\n    ProtectedDataUpdatedEvent,\n    PublicDataReadyEvent,\n    PublicDataUpdatedEvent\n} from \"./AppRouterReducer.ts\";\n\nexport * from \"./AppRouterStore.ts\";\nexport * from \"./GlobalDataQueriesError.ts\";\nexport * from \"./useCanFetchProtectedData.ts\";\nexport * from \"./useCanFetchPublicData.ts\";\nexport * from \"./useCanRegisterDeferredRegistrations.ts\";\nexport * from \"./useCanUpdateDeferredRegistrations.ts\";\nexport * from \"./useDeferredRegistrations.ts\";\nexport * from \"./useIsActiveRouteProtected.ts\";\nexport * from \"./useIsBootstrapping.ts\";\nexport * from \"./useNavigationItems.ts\";\nexport * from \"./useProtectedDataHandler.ts\";\nexport * from \"./useProtectedDataQueries.ts\";\nexport * from \"./usePublicDataHandler.ts\";\nexport * from \"./usePublicDataQueries.ts\";\nexport * from \"./useRegisterDeferredRegistrations.ts\";\nexport * from \"./useStrictRegistrationMode.ts\";\nexport * from \"./useUpdateDeferredRegistrations.ts\";\n\nexport * from \"./initializeFirefly.ts\";\n\n"],"names":["EnvironmentVariablesPlugin","useEnvironmentVariable","useEnvironmentVariables","MswPlugin","MswState","ActiveRouteIsProtectedEvent","ActiveRouteIsPublicEvent","ApplicationBoostrappedEvent","DeferredRegistrationsUpdatedEvent","ModulesReadyEvent","ModulesRegisteredEvent","MswReadyEvent","ProtectedDataReadyEvent","ProtectedDataUpdatedEvent","PublicDataReadyEvent","PublicDataUpdatedEvent"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAA6B;AASH;AAQL;AACgB;AAGC;AACD;AAEL;AAaD;AAEK;AACQ;AACE;AACH;AACc;AACF;AACT;AACC;AACP;AACA;AACK;AACA;AACH;AACA;AACY;AACP;AACK;AAEb"}

package/dist/initializeFirefly.d.ts

@@ -1,4 +1,5 @@
 import { ModuleDefinition, type ModuleRegisterFunction, type RegisterModulesOptions } from "@squide/core";
+import { EnvironmentVariables } from "@squide/env-vars";
 import type { HoneycombInstrumentationPartialClient } from "@workleap-telemetry/core";
 import { FireflyRuntime, type FireflyRuntimeOptions } from "./FireflyRuntime.tsx";
 export declare const ApplicationBootstrappingStartedEvent = "squide-app-bootstrapping-started";
@@ -8,6 +9,7 @@ export interface InitializeFireflyOptions<TRuntime extends FireflyRuntime, TCont
     localModules?: ModuleRegisterFunction<TRuntime, TContext, TData>[];
     moduleDefinitions?: ModuleDefinition<TRuntime, TContext, TData>[];
     useMsw?: boolean;
+    environmentVariables?: Partial<EnvironmentVariables>;
     honeycombInstrumentationClient?: HoneycombInstrumentationPartialClient;
     startMsw?: StartMswFunction<FireflyRuntime>;
     onError?: OnInitializationErrorFunction;

package/dist/initializeFirefly.js

@@ -1,10 +1,13 @@
 import { isFunction, toLocalModuleDefinitions } from "@squide/core";
+import { EnvironmentVariablesPlugin } from "@squide/env-vars";
 import { MswPlugin } from "@squide/msw";
 import { FireflyRuntime } from "./FireflyRuntime.js";
 import { initializeHoneycomb } from "./honeycomb/initializeHoneycomb.js";
 
 ;// CONCATENATED MODULE: external "@squide/core"
 
+;// CONCATENATED MODULE: external "@squide/env-vars"
+
 ;// CONCATENATED MODULE: external "@squide/msw"
 
 ;// CONCATENATED MODULE: external "./FireflyRuntime.js"
@@ -16,6 +19,7 @@ import { initializeHoneycomb } from "./honeycomb/initializeHoneycomb.js";
 
 
 
+
 const ApplicationBootstrappingStartedEvent = "squide-app-bootstrapping-started";
 function bootstrap(runtime, modulesDefinitions, options = {}) {
     const { startMsw, onError, context } = options;
@@ -48,7 +52,7 @@ function __resetHasExecutedGuard() {
     hasExecuted = false;
 }
 function initializeFirefly(options = {}) {
-    const { mode, localModules = [], moduleDefinitions = [], useMsw, plugins = [], honeycombInstrumentationClient, loggers, onError } = options;
+    const { mode, localModules = [], moduleDefinitions = [], useMsw, plugins = [], environmentVariables, honeycombInstrumentationClient, loggers, onError } = options;
     if (hasExecuted) {
         throw new Error("[squide] A squide application can only be initialized once. Did you call the \"initializeSquide\" function twice?");
     }
@@ -60,7 +64,12 @@ function initializeFirefly(options = {}) {
         mode,
         honeycombInstrumentationClient,
         loggers,
-        plugins
+        plugins: [
+            (x)=>new EnvironmentVariablesPlugin(x, {
+                    variables: environmentVariables
+                }),
+            ...plugins
+        ]
     });
     initializeHoneycomb(runtime).catch((error)=>{
         if (onError) {

package/dist/initializeFirefly.js.map

@@ -1 +1 @@
-{"version":3,"file":"initializeFirefly.js","sources":["../src/initializeFirefly.ts"],"sourcesContent":["import { isFunction, ModuleDefinition, toLocalModuleDefinitions, type ModuleRegisterFunction, type RegisterModulesOptions } from \"@squide/core\";\nimport { MswPlugin } from \"@squide/msw\";\nimport type { HoneycombInstrumentationPartialClient } from \"@workleap-telemetry/core\";\nimport { FireflyRuntime, type FireflyRuntimeOptions } from \"./FireflyRuntime.tsx\";\nimport { initializeHoneycomb } from \"./honeycomb/initializeHoneycomb.ts\";\n\nexport const ApplicationBootstrappingStartedEvent = \"squide-app-bootstrapping-started\";\n\nexport type OnInitializationErrorFunction = (error: unknown) => void;\n\nexport type StartMswFunction<TRuntime = FireflyRuntime> = (runtime: TRuntime) => Promise<void>;\n\nexport interface InitializeFireflyOptions<TRuntime extends FireflyRuntime, TContext = unknown, TData = unknown> extends RegisterModulesOptions<TContext>, FireflyRuntimeOptions {\n    localModules?: ModuleRegisterFunction<TRuntime, TContext, TData>[];\n    moduleDefinitions?: ModuleDefinition<TRuntime, TContext, TData>[];\n    useMsw?: boolean;\n    honeycombInstrumentationClient?: HoneycombInstrumentationPartialClient;\n    startMsw?: StartMswFunction<FireflyRuntime>;\n    onError?: OnInitializationErrorFunction;\n}\n\nexport function bootstrap<TRuntime extends FireflyRuntime = FireflyRuntime, TContext = unknown, TData = unknown>(\n    runtime: TRuntime,\n    modulesDefinitions: ModuleDefinition<TRuntime, TContext, TData>[],\n    options: Omit<InitializeFireflyOptions<TRuntime, TContext, TData>, \"localModules\" | \"moduleDefinitions\"> = {}\n) {\n    const {\n        startMsw,\n        onError,\n        context\n    } = options;\n\n    runtime.eventBus.dispatch(ApplicationBootstrappingStartedEvent);\n\n    runtime.moduleManager.registerModules(modulesDefinitions, { context })\n        .then(results => {\n            if (runtime.isMswEnabled) {\n                if (!isFunction(startMsw)) {\n                    throw new Error(\"[squide] When MSW is enabled, the \\\"startMsw\\\" function must be provided.\");\n                }\n\n                startMsw(runtime)\n                    .then(() => {\n                        if (runtime.isMswEnabled) {\n                            runtime.getMswState().setAsReady();\n                        }\n                    })\n                    .catch((error: unknown) => {\n                        runtime.logger\n                            .withText(\"[squide] An error occured while starting MSW.\")\n                            .withError(error as Error)\n                            .error();\n                    });\n            }\n\n            if (onError) {\n                results.forEach(error => {\n                    onError(error);\n                });\n            }\n        });\n}\n\nlet hasExecuted = false;\n\n// Should only be used by tests.\nexport function __resetHasExecutedGuard() {\n    hasExecuted = false;\n}\n\nexport function initializeFirefly<TContext = unknown, TData = unknown>(options: InitializeFireflyOptions<FireflyRuntime, TContext, TData> = {}) {\n    const {\n        mode,\n        localModules = [],\n        moduleDefinitions = [],\n        useMsw,\n        plugins = [],\n        honeycombInstrumentationClient,\n        loggers,\n        onError\n    } = options;\n\n    if (hasExecuted) {\n        throw new Error(\"[squide] A squide application can only be initialized once. Did you call the \\\"initializeSquide\\\" function twice?\");\n    }\n\n    hasExecuted = true;\n\n    if (useMsw) {\n        plugins.push(x => new MswPlugin(x));\n    }\n\n    const runtime = new FireflyRuntime({\n        mode,\n        honeycombInstrumentationClient,\n        loggers,\n        plugins\n    });\n\n    initializeHoneycomb(runtime)\n        .catch((error: unknown) => {\n            if (onError) {\n                onError(error);\n            }\n        })\n        .finally(() => {\n            bootstrap(\n                runtime,\n                [...moduleDefinitions, ...toLocalModuleDefinitions(localModules)],\n                options\n            );\n        });\n\n    return runtime;\n}\n"],"names":["isFunction","toLocalModuleDefinitions","MswPlugin","FireflyRuntime","initializeHoneycomb","ApplicationBootstrappingStartedEvent","bootstrap","runtime","modulesDefinitions","options","startMsw","onError","context","results","Error","error","hasExecuted","__resetHasExecutedGuard","initializeFirefly","mode","localModules","moduleDefinitions","useMsw","plugins","honeycombInstrumentationClient","loggers","x"],"mappings":";;;;;;;;;;;;;;AAAgJ;AACxG;AAE0C;AACT;AAElE,MAAMK,uCAAuC,mCAAmC;AAehF,SAASC,UACZC,OAAiB,EACjBC,kBAAiE,EACjEC,UAA2G,CAAC,CAAC;IAE7G,MAAM,EACFC,QAAQ,EACRC,OAAO,EACPC,OAAO,EACV,GAAGH;IAEJF,QAAQ,QAAQ,CAAC,QAAQ,CAACF;IAE1BE,QAAQ,aAAa,CAAC,eAAe,CAACC,oBAAoB;QAAEI;IAAQ,GAC/D,IAAI,CAACC,CAAAA;QACF,IAAIN,QAAQ,YAAY,EAAE;YACtB,IAAI,CAACP,UAAUA,CAACU,WAAW;gBACvB,MAAM,IAAII,MAAM;YACpB;YAEAJ,SAASH,SACJ,IAAI,CAAC;gBACF,IAAIA,QAAQ,YAAY,EAAE;oBACtBA,QAAQ,WAAW,GAAG,UAAU;gBACpC;YACJ,GACC,KAAK,CAAC,CAACQ;gBACJR,QAAQ,MAAM,CACT,QAAQ,CAAC,iDACT,SAAS,CAACQ,OACV,KAAK;YACd;QACR;QAEA,IAAIJ,SAAS;YACTE,QAAQ,OAAO,CAACE,CAAAA;gBACZJ,QAAQI;YACZ;QACJ;IACJ;AACR;AAEA,IAAIC,cAAc;AAElB,gCAAgC;AACzB,SAASC;IACZD,cAAc;AAClB;AAEO,SAASE,kBAAuDT,UAAqE,CAAC,CAAC;IAC1I,MAAM,EACFU,IAAI,EACJC,eAAe,EAAE,EACjBC,oBAAoB,EAAE,EACtBC,MAAM,EACNC,UAAU,EAAE,EACZC,8BAA8B,EAC9BC,OAAO,EACPd,OAAO,EACV,GAAGF;IAEJ,IAAIO,aAAa;QACb,MAAM,IAAIF,MAAM;IACpB;IAEAE,cAAc;IAEd,IAAIM,QAAQ;QACRC,QAAQ,IAAI,CAACG,CAAAA,IAAK,IAAIxB,SAASA,CAACwB;IACpC;IAEA,MAAMnB,UAAU,IAAIJ,cAAcA,CAAC;QAC/BgB;QACAK;QACAC;QACAF;IACJ;IAEAnB,mBAAmBA,CAACG,SACf,KAAK,CAAC,CAACQ;QACJ,IAAIJ,SAAS;YACTA,QAAQI;QACZ;IACJ,GACC,OAAO,CAAC;QACLT,UACIC,SACA;eAAIc;eAAsBpB,wBAAwBA,CAACmB;SAAc,EACjEX;IAER;IAEJ,OAAOF;AACX"}
+{"version":3,"file":"initializeFirefly.js","sources":["../src/initializeFirefly.ts"],"sourcesContent":["import { isFunction, ModuleDefinition, toLocalModuleDefinitions, type ModuleRegisterFunction, type RegisterModulesOptions } from \"@squide/core\";\nimport { EnvironmentVariables, EnvironmentVariablesPlugin } from \"@squide/env-vars\";\nimport { MswPlugin } from \"@squide/msw\";\nimport type { HoneycombInstrumentationPartialClient } from \"@workleap-telemetry/core\";\nimport { FireflyRuntime, type FireflyRuntimeOptions } from \"./FireflyRuntime.tsx\";\nimport { initializeHoneycomb } from \"./honeycomb/initializeHoneycomb.ts\";\n\nexport const ApplicationBootstrappingStartedEvent = \"squide-app-bootstrapping-started\";\n\nexport type OnInitializationErrorFunction = (error: unknown) => void;\n\nexport type StartMswFunction<TRuntime = FireflyRuntime> = (runtime: TRuntime) => Promise<void>;\n\nexport interface InitializeFireflyOptions<TRuntime extends FireflyRuntime, TContext = unknown, TData = unknown> extends RegisterModulesOptions<TContext>, FireflyRuntimeOptions {\n    localModules?: ModuleRegisterFunction<TRuntime, TContext, TData>[];\n    moduleDefinitions?: ModuleDefinition<TRuntime, TContext, TData>[];\n    useMsw?: boolean;\n    environmentVariables?: Partial<EnvironmentVariables>;\n    honeycombInstrumentationClient?: HoneycombInstrumentationPartialClient;\n    startMsw?: StartMswFunction<FireflyRuntime>;\n    onError?: OnInitializationErrorFunction;\n}\n\nexport function bootstrap<TRuntime extends FireflyRuntime = FireflyRuntime, TContext = unknown, TData = unknown>(\n    runtime: TRuntime,\n    modulesDefinitions: ModuleDefinition<TRuntime, TContext, TData>[],\n    options: Omit<InitializeFireflyOptions<TRuntime, TContext, TData>, \"localModules\" | \"moduleDefinitions\"> = {}\n) {\n    const {\n        startMsw,\n        onError,\n        context\n    } = options;\n\n    runtime.eventBus.dispatch(ApplicationBootstrappingStartedEvent);\n\n    runtime.moduleManager.registerModules(modulesDefinitions, { context })\n        .then(results => {\n            if (runtime.isMswEnabled) {\n                if (!isFunction(startMsw)) {\n                    throw new Error(\"[squide] When MSW is enabled, the \\\"startMsw\\\" function must be provided.\");\n                }\n\n                startMsw(runtime)\n                    .then(() => {\n                        if (runtime.isMswEnabled) {\n                            runtime.getMswState().setAsReady();\n                        }\n                    })\n                    .catch((error: unknown) => {\n                        runtime.logger\n                            .withText(\"[squide] An error occured while starting MSW.\")\n                            .withError(error as Error)\n                            .error();\n                    });\n            }\n\n            if (onError) {\n                results.forEach(error => {\n                    onError(error);\n                });\n            }\n        });\n}\n\nlet hasExecuted = false;\n\n// Should only be used by tests.\nexport function __resetHasExecutedGuard() {\n    hasExecuted = false;\n}\n\nexport function initializeFirefly<TContext = unknown, TData = unknown>(options: InitializeFireflyOptions<FireflyRuntime, TContext, TData> = {}) {\n    const {\n        mode,\n        localModules = [],\n        moduleDefinitions = [],\n        useMsw,\n        plugins = [],\n        environmentVariables,\n        honeycombInstrumentationClient,\n        loggers,\n        onError\n    } = options;\n\n    if (hasExecuted) {\n        throw new Error(\"[squide] A squide application can only be initialized once. Did you call the \\\"initializeSquide\\\" function twice?\");\n    }\n\n    hasExecuted = true;\n\n    if (useMsw) {\n        plugins.push(x => new MswPlugin(x));\n    }\n\n    const runtime = new FireflyRuntime({\n        mode,\n        honeycombInstrumentationClient,\n        loggers,\n        plugins: [\n            x => new EnvironmentVariablesPlugin(x, {\n                variables: environmentVariables\n            }),\n            ...plugins\n        ]\n    });\n\n    initializeHoneycomb(runtime)\n        .catch((error: unknown) => {\n            if (onError) {\n                onError(error);\n            }\n        })\n        .finally(() => {\n            bootstrap(\n                runtime,\n                [...moduleDefinitions, ...toLocalModuleDefinitions(localModules)],\n                options\n            );\n        });\n\n    return runtime;\n}\n"],"names":["isFunction","toLocalModuleDefinitions","EnvironmentVariablesPlugin","MswPlugin","FireflyRuntime","initializeHoneycomb","ApplicationBootstrappingStartedEvent","bootstrap","runtime","modulesDefinitions","options","startMsw","onError","context","results","Error","error","hasExecuted","__resetHasExecutedGuard","initializeFirefly","mode","localModules","moduleDefinitions","useMsw","plugins","environmentVariables","honeycombInstrumentationClient","loggers","x"],"mappings":";;;;;;;;;;;;;;;;;AAAgJ;AAC5D;AAC5C;AAE0C;AACT;AAElE,MAAMM,uCAAuC,mCAAmC;AAgBhF,SAASC,UACZC,OAAiB,EACjBC,kBAAiE,EACjEC,UAA2G,CAAC,CAAC;IAE7G,MAAM,EACFC,QAAQ,EACRC,OAAO,EACPC,OAAO,EACV,GAAGH;IAEJF,QAAQ,QAAQ,CAAC,QAAQ,CAACF;IAE1BE,QAAQ,aAAa,CAAC,eAAe,CAACC,oBAAoB;QAAEI;IAAQ,GAC/D,IAAI,CAACC,CAAAA;QACF,IAAIN,QAAQ,YAAY,EAAE;YACtB,IAAI,CAACR,UAAUA,CAACW,WAAW;gBACvB,MAAM,IAAII,MAAM;YACpB;YAEAJ,SAASH,SACJ,IAAI,CAAC;gBACF,IAAIA,QAAQ,YAAY,EAAE;oBACtBA,QAAQ,WAAW,GAAG,UAAU;gBACpC;YACJ,GACC,KAAK,CAAC,CAACQ;gBACJR,QAAQ,MAAM,CACT,QAAQ,CAAC,iDACT,SAAS,CAACQ,OACV,KAAK;YACd;QACR;QAEA,IAAIJ,SAAS;YACTE,QAAQ,OAAO,CAACE,CAAAA;gBACZJ,QAAQI;YACZ;QACJ;IACJ;AACR;AAEA,IAAIC,cAAc;AAElB,gCAAgC;AACzB,SAASC;IACZD,cAAc;AAClB;AAEO,SAASE,kBAAuDT,UAAqE,CAAC,CAAC;IAC1I,MAAM,EACFU,IAAI,EACJC,eAAe,EAAE,EACjBC,oBAAoB,EAAE,EACtBC,MAAM,EACNC,UAAU,EAAE,EACZC,oBAAoB,EACpBC,8BAA8B,EAC9BC,OAAO,EACPf,OAAO,EACV,GAAGF;IAEJ,IAAIO,aAAa;QACb,MAAM,IAAIF,MAAM;IACpB;IAEAE,cAAc;IAEd,IAAIM,QAAQ;QACRC,QAAQ,IAAI,CAACI,CAAAA,IAAK,IAAIzB,SAASA,CAACyB;IACpC;IAEA,MAAMpB,UAAU,IAAIJ,cAAcA,CAAC;QAC/BgB;QACAM;QACAC;QACA,SAAS;YACLC,CAAAA,IAAK,IAAI1B,0BAA0BA,CAAC0B,GAAG;oBACnC,WAAWH;gBACf;eACGD;SACN;IACL;IAEAnB,mBAAmBA,CAACG,SACf,KAAK,CAAC,CAACQ;QACJ,IAAIJ,SAAS;YACTA,QAAQI;QACZ;IACJ,GACC,OAAO,CAAC;QACLT,UACIC,SACA;eAAIc;eAAsBrB,wBAAwBA,CAACoB;SAAc,EACjEX;IAER;IAEJ,OAAOF;AACX"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@squide/firefly",
   "author": "Workleap",
-  "version": "16.0.0",
+  "version": "16.0.1",
   "description": "Helpers to facilitate the creation of an application with the Squide firefly technology stack.",
   "license": "Apache-2.0",
   "repository": {
@@ -39,13 +39,19 @@
     "react-dom": "^18.0.0 || ^19.0.0",
     "react-router": "^7.9.6"
   },
+  "peerDependenciesMeta": {
+    "@opentelemetry/api": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "@workleap-telemetry/core": "^1.0.4",
     "@workleap/logging": "^1.3.2",
     "uuid": "^13.0.0",
-    "@squide/core": "6.1.4",
-    "@squide/msw": "4.0.5",
-    "@squide/react-router": "8.1.4"
+    "@squide/env-vars": "1.4.8",
+    "@squide/msw": "4.0.6",
+    "@squide/react-router": "8.1.5",
+    "@squide/core": "6.1.5"
   },
   "devDependencies": {
     "@eslint/js": "9.39.1",

package/src/FireflyRuntime.tsx

@@ -1,5 +1,6 @@
 import type { RegisterRouteOptions, RuntimeMethodOptions, RuntimeOptions } from "@squide/core";
-import { MswPlugin, MswPluginName, MswState } from "@squide/msw";
+import { EnvironmentVariableKey, EnvironmentVariables, EnvironmentVariableValue, getEnvironmentVariablesPlugin } from "@squide/env-vars";
+import { getMswPlugin, MswPluginName, MswState } from "@squide/msw";
 import { type IReactRouterRuntime, ReactRouterRuntime, ReactRouterRuntimeScope, type Route } from "@squide/react-router";
 import type { HoneycombInstrumentationPartialClient } from "@workleap-telemetry/core";
 import type { Logger } from "@workleap/logging";
@@ -16,8 +17,12 @@ export interface IFireflyRuntime extends IReactRouterRuntime {
     getMswState(): MswState;
     registerRequestHandlers: (handlers: RequestHandler[]) => void;
     get requestHandlers(): RequestHandler[];
-    get appRouterStore(): AppRouterStore;
     get isMswEnabled(): boolean;
+    registerEnvironmentVariable(key: EnvironmentVariableKey, value: EnvironmentVariableValue): void;
+    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>): void;
+    getEnvironmentVariable(key: EnvironmentVariableKey): EnvironmentVariableValue;
+    getEnvironmentVariables(): EnvironmentVariables;
+    get appRouterStore(): AppRouterStore;
     get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient | undefined;
 }
 
@@ -26,65 +31,81 @@ export class FireflyRuntime<TRuntime extends FireflyRuntime = any> extends React
     protected _appRouterStore: AppRouterStore;
     protected _honeycombInstrumentationClient: HoneycombInstrumentationPartialClient | undefined;
 
-    constructor({ honeycombInstrumentationClient, ...options }: FireflyRuntimeOptions = {}) {
+    constructor(options: FireflyRuntimeOptions = {}) {
+        const {
+            honeycombInstrumentationClient
+        } = options;
+
         super(options);
 
         this._appRouterStore = createAppRouterStore(this._logger);
         this._honeycombInstrumentationClient = honeycombInstrumentationClient;
     }
 
-    getMswState() {
-        const mswPlugin = this.getPlugin(MswPluginName) as MswPlugin;
-
-        if (!mswPlugin) {
-            throw new Error("[squide] Cannot register the provided MSW request handlers because the runtime hasn't been initialized with MSW. Did you instanciate the FireflyRuntime with the \"useMsw\" option?");
+    registerRoute(route: Route, options: RegisterRouteOptions = {}) {
+        if (this.moduleManager.getAreModulesRegistered()) {
+            throw new Error("[squide] Cannot register a route once the modules are registered. Are you trying to register a route in a deferred registration function? Only navigation items can be registered in a deferred registration function.");
         }
 
-        return mswPlugin.mswState;
+        super.registerRoute(route, options);
+    }
+
+    getMswState() {
+        const plugin = getMswPlugin(this);
+
+        return plugin.mswState;
     }
 
     registerRequestHandlers(handlers: RequestHandler[], options: RegisterRequestHandlersOptions = {}) {
         const logger = this._getLogger(options);
-        const mswPlugin = this.getPlugin(MswPluginName) as MswPlugin;
-
-        if (!mswPlugin) {
-            throw new Error("[squide] Cannot register the provided MSW request handlers because the runtime hasn't been initialized with MSW. Did you instanciate the FireflyRuntime with the \"useMsw\" option?");
-        }
+        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.");
         }
 
-        mswPlugin.registerRequestHandlers(handlers, {
+        plugin.registerRequestHandlers(handlers, {
             logger
         });
     }
 
     // Must define a return type otherwise we get an "error TS2742: The inferred type of 'requestHandlers' cannot be named" error.
     get requestHandlers(): RequestHandler[] {
-        const mswPlugin = this.getPlugin(MswPluginName) as MswPlugin;
+        const plugin = getMswPlugin(this);
 
-        if (!mswPlugin) {
-            throw new Error("[squide] Cannot retrieve MSW request handlers because the runtime hasn't been initialized with MSW. Did you instanciate the FireflyRuntime with the \"useMsw\" option?");
-        }
+        return plugin.requestHandlers;
+    }
 
-        return mswPlugin.requestHandlers;
+    get isMswEnabled() {
+        return this._plugins.some(x => x.name === MswPluginName);
     }
 
-    registerRoute(route: Route, options: RegisterRouteOptions = {}) {
-        if (this.moduleManager.getAreModulesRegistered()) {
-            throw new Error("[squide] Cannot register a route once the modules are registered. Are you trying to register a route in a deferred registration function? Only navigation items can be registered in a deferred registration function.");
-        }
+    getEnvironmentVariable(key: EnvironmentVariableKey) {
+        const plugin = getEnvironmentVariablesPlugin(this);
 
-        super.registerRoute(route, options);
+        return plugin.getVariable(key);
     }
 
-    get appRouterStore() {
-        return this._appRouterStore;
+    getEnvironmentVariables() {
+        const plugin = getEnvironmentVariablesPlugin(this);
+
+        return plugin.getVariables();
     }
 
-    get isMswEnabled() {
-        return this._plugins.some(x => x.name === MswPluginName);
+    registerEnvironmentVariable(key: EnvironmentVariableKey, value: EnvironmentVariableValue) {
+        const plugin = getEnvironmentVariablesPlugin(this);
+
+        return plugin.registerVariable(key, value);
+    }
+
+    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>) {
+        const plugin = getEnvironmentVariablesPlugin(this);
+
+        return plugin.registerVariables(variables);
+    }
+
+    get appRouterStore() {
+        return this._appRouterStore;
     }
 
     get honeycombInstrumentationClient() {
@@ -113,14 +134,30 @@ export class FireflyRuntimeScope<TRuntime extends FireflyRuntime = FireflyRuntim
         return this._runtime.requestHandlers;
     }
 
-    get appRouterStore(): AppRouterStore {
-        throw new Error("[squide] Cannot retrieve the app router store from a runtime scope instance.");
-    }
-
     get isMswEnabled() {
         return this._runtime.isMswEnabled;
     }
 
+    getEnvironmentVariables() {
+        return this._runtime.getEnvironmentVariables();
+    }
+
+    getEnvironmentVariable(key: EnvironmentVariableKey) {
+        return this._runtime.getEnvironmentVariable(key);
+    }
+
+    registerEnvironmentVariable(key: EnvironmentVariableKey, value: EnvironmentVariableValue) {
+        this._runtime.registerEnvironmentVariable(key, value);
+    }
+
+    registerEnvironmentVariables(variables: Partial<EnvironmentVariables>) {
+        this._runtime.registerEnvironmentVariables(variables);
+    }
+
+    get appRouterStore(): AppRouterStore {
+        throw new Error("[squide] Cannot retrieve the app router store from a runtime scope instance.");
+    }
+
     get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient {
         throw new Error("[squide] Cannot retrieve the Honeycomb instrumentation client from a runtime scope instance.");
     }

package/src/index.ts

@@ -1,5 +1,21 @@
 export * from "@squide/core";
-export * from "@squide/msw";
+export {
+    EnvironmentVariablesPlugin,
+    useEnvironmentVariable,
+    useEnvironmentVariables,
+    type EnvironmentVariableKey,
+    type EnvironmentVariables,
+    type EnvironmentVariablesPluginOptions,
+    type EnvironmentVariableValue
+} from "@squide/env-vars";
+export {
+    MswPlugin,
+    MswState,
+    type MswPluginOptions,
+    type MswPluginRegisterRequestHandlersOptions,
+    type MswReadyListener,
+    type MswStateOptions
+} from "@squide/msw";
 export * from "@squide/react-router";
 
 export type { FireflyPlugin } from "./FireflyPlugin.ts";

package/src/initializeFirefly.ts

@@ -1,4 +1,5 @@
 import { isFunction, ModuleDefinition, toLocalModuleDefinitions, type ModuleRegisterFunction, type RegisterModulesOptions } from "@squide/core";
+import { EnvironmentVariables, EnvironmentVariablesPlugin } from "@squide/env-vars";
 import { MswPlugin } from "@squide/msw";
 import type { HoneycombInstrumentationPartialClient } from "@workleap-telemetry/core";
 import { FireflyRuntime, type FireflyRuntimeOptions } from "./FireflyRuntime.tsx";
@@ -14,6 +15,7 @@ export interface InitializeFireflyOptions<TRuntime extends FireflyRuntime, TCont
     localModules?: ModuleRegisterFunction<TRuntime, TContext, TData>[];
     moduleDefinitions?: ModuleDefinition<TRuntime, TContext, TData>[];
     useMsw?: boolean;
+    environmentVariables?: Partial<EnvironmentVariables>;
     honeycombInstrumentationClient?: HoneycombInstrumentationPartialClient;
     startMsw?: StartMswFunction<FireflyRuntime>;
     onError?: OnInitializationErrorFunction;
@@ -75,6 +77,7 @@ export function initializeFirefly<TContext = unknown, TData = unknown>(options:
         moduleDefinitions = [],
         useMsw,
         plugins = [],
+        environmentVariables,
         honeycombInstrumentationClient,
         loggers,
         onError
@@ -94,7 +97,12 @@ export function initializeFirefly<TContext = unknown, TData = unknown>(options:
         mode,
         honeycombInstrumentationClient,
         loggers,
-        plugins
+        plugins: [
+            x => new EnvironmentVariablesPlugin(x, {
+                variables: environmentVariables
+            }),
+            ...plugins
+        ]
     });
 
     initializeHoneycomb(runtime)