@squide/firefly-rsbuild-storybook 1.0.2 → 1.0.4

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @squide/firefly-rsbuild-storybook
 
+## 1.0.4
+
+### Patch Changes
+
+- Updated dependencies [[`992dd28`](https://github.com/workleap/wl-squide/commit/992dd28ce8aa03559c556f24df4ebc9c3129c943)]:
+  - @squide/firefly@16.1.4
+  - @squide/env-vars@1.4.12
+  - @squide/launch-darkly@1.0.3
+  - @squide/msw@4.0.10
+
+## 1.0.3
+
+### Patch Changes
+
+- [#363](https://github.com/workleap/wl-squide/pull/363) [`b114284`](https://github.com/workleap/wl-squide/commit/b114284529ff87e719d594d9612a52b1935a0bb2) Thanks [@patricklafrance](https://github.com/patricklafrance)! - Added an initialization log and now accept optional loggers.
+
+- Updated dependencies [[`b114284`](https://github.com/workleap/wl-squide/commit/b114284529ff87e719d594d9612a52b1935a0bb2)]:
+  - @squide/firefly@16.1.3
+
 ## 1.0.2
 
 ### Patch Changes

package/dist/initializeFireflyForStorybook.d.ts

@@ -1,5 +1,6 @@
 import { EnvironmentVariables } from "@squide/env-vars";
 import { FireflyRuntime, ModuleRegisterFunction } from "@squide/firefly";
+import { RootLogger } from "@workleap/logging";
 import { LDClient, LDFlagValue } from "launchdarkly-js-client-sdk";
 import { StorybookRuntime } from "./StorybookRuntime.ts";
 export interface InitializeFireflyForStorybookOptions {
@@ -7,5 +8,6 @@ export interface InitializeFireflyForStorybookOptions {
     environmentVariables?: EnvironmentVariables;
     featureFlags?: Map<string, LDFlagValue> | Record<string, LDFlagValue>;
     launchDarklyClient?: LDClient;
+    loggers?: RootLogger[];
 }
 export declare function initializeFireflyForStorybook(options?: InitializeFireflyForStorybookOptions): Promise<StorybookRuntime>;

package/dist/initializeFireflyForStorybook.js

@@ -16,21 +16,49 @@ import { StorybookRuntime } from "./StorybookRuntime.js";
 
 
 
+function logInitializationState(runtime, options, plugins) {
+    const { localModules, environmentVariables, featureFlags, launchDarklyClient } = options;
+    const scope = runtime.logger.startScope("[squide] Initializing the application.");
+    try {
+        scope.information("[squide] Mode: development");
+        if (localModules) {
+            scope.withText("[squide] Local modules:").withObject(localModules).information();
+        }
+        scope.information("[squide] Use MSW: Yes");
+        if (environmentVariables && Object.keys(environmentVariables).length > 0) {
+            scope.withText("[squide] Environment variables:").withObject(environmentVariables).information();
+        }
+        if (featureFlags) {
+            scope.withText("[squide] Feature flags:").withObject(featureFlags).information();
+        }
+        if (launchDarklyClient) {
+            scope.withText("[squide] LaunchDarkly client:").withObject(launchDarklyClient).information();
+        }
+        if (plugins.length > 0) {
+            scope.withText("[squide] Plugins:").withObject(plugins).information();
+        }
+    } finally{
+        scope.end();
+    }
+}
 async function initializeFireflyForStorybook(options = {}) {
-    const { localModules, environmentVariables, featureFlags = {}, launchDarklyClient } = options;
+    const { localModules, environmentVariables, featureFlags = {}, launchDarklyClient, loggers } = options;
+    const plugins = [
+        (x)=>new MswPlugin(x),
+        (x)=>new EnvironmentVariablesPlugin(x, {
+                variables: environmentVariables
+            }),
+        (x)=>new LaunchDarklyPlugin(x, // 1- If no client is provided create it.
+            // 2- If feature flags are provided and it's an instance of Map, use the argument.
+            // 3- If feature flags are provided (or the default value) and it's an object literal, convert the object to a Map instance.
+            launchDarklyClient ?? new InMemoryLaunchDarklyClient(featureFlags instanceof Map ? featureFlags : new Map(Object.entries(featureFlags))))
+    ];
     const runtime = new StorybookRuntime({
         mode: "development",
-        plugins: [
-            (x)=>new MswPlugin(x),
-            (x)=>new EnvironmentVariablesPlugin(x, {
-                    variables: environmentVariables
-                }),
-            (x)=>new LaunchDarklyPlugin(x, // 1- If no client is provided create it.
-                // 2- If feature flags are provided and it's an instance of Map, use the argument.
-                // 3- If feature flags are provided (or the default value) and it's an object literal, convert the object to a Map instance.
-                launchDarklyClient ?? new InMemoryLaunchDarklyClient(featureFlags instanceof Map ? featureFlags : new Map(Object.entries(featureFlags))))
-        ]
+        plugins,
+        loggers
     });
+    logInitializationState(runtime, options, plugins);
     if (localModules && localModules.length > 0) {
         await runtime.moduleManager.registerModules([
             ...toLocalModuleDefinitions(localModules)

package/dist/initializeFireflyForStorybook.js.map

@@ -1 +1 @@
-{"version":3,"file":"initializeFireflyForStorybook.js","sources":["../src/initializeFireflyForStorybook.ts"],"sourcesContent":["import { EnvironmentVariables, EnvironmentVariablesPlugin } from \"@squide/env-vars\";\nimport { FireflyRuntime, InMemoryLaunchDarklyClient, LaunchDarklyPlugin, ModuleRegisterFunction, toLocalModuleDefinitions } from \"@squide/firefly\";\nimport { MswPlugin } from \"@squide/msw\";\nimport { LDClient, LDFlagValue } from \"launchdarkly-js-client-sdk\";\nimport { StorybookRuntime } from \"./StorybookRuntime.ts\";\n\nexport interface InitializeFireflyForStorybookOptions {\n    localModules?: ModuleRegisterFunction<FireflyRuntime>[];\n    environmentVariables?: EnvironmentVariables;\n    featureFlags?: Map<string, LDFlagValue> | Record<string, LDFlagValue>;\n    launchDarklyClient?: LDClient;\n}\n\nexport async function initializeFireflyForStorybook(options: InitializeFireflyForStorybookOptions = {}) {\n    const {\n        localModules,\n        environmentVariables,\n        featureFlags = {},\n        launchDarklyClient\n    } = options;\n\n    const runtime = new StorybookRuntime({\n        mode: \"development\",\n        plugins: [\n            x => new MswPlugin(x),\n            x => new EnvironmentVariablesPlugin(x, {\n                variables: environmentVariables\n            }),\n            x => new LaunchDarklyPlugin(\n                x,\n                // 1- If no client is provided create it.\n                // 2- If feature flags are provided and it's an instance of Map, use the argument.\n                // 3- If feature flags are provided (or the default value) and it's an object literal, convert the object to a Map instance.\n                launchDarklyClient ?? new InMemoryLaunchDarklyClient(featureFlags instanceof Map\n                    ? featureFlags\n                    : new Map<string, LDFlagValue>(Object.entries(featureFlags))\n                )\n            )\n        ]\n    });\n\n    if (localModules && localModules.length > 0) {\n        await runtime.moduleManager.registerModules([\n            ...toLocalModuleDefinitions(localModules)\n        ]);\n    }\n\n    return runtime;\n}\n"],"names":["EnvironmentVariablesPlugin","InMemoryLaunchDarklyClient","LaunchDarklyPlugin","toLocalModuleDefinitions","MswPlugin","StorybookRuntime","initializeFireflyForStorybook","options","localModules","environmentVariables","featureFlags","launchDarklyClient","runtime","x","Map","Object"],"mappings":";;;;;;;;;;;;;;AAAoF;AAC+D;AAC3G;AAEiB;AASlD,eAAeM,8BAA8BC,UAAgD,CAAC,CAAC;IAClG,MAAM,EACFC,YAAY,EACZC,oBAAoB,EACpBC,eAAe,CAAC,CAAC,EACjBC,kBAAkB,EACrB,GAAGJ;IAEJ,MAAMK,UAAU,IAAIP,gBAAgBA,CAAC;QACjC,MAAM;QACN,SAAS;YACLQ,CAAAA,IAAK,IAAIT,SAASA,CAACS;YACnBA,CAAAA,IAAK,IAAIb,0BAA0BA,CAACa,GAAG;oBACnC,WAAWJ;gBACf;YACAI,CAAAA,IAAK,IAAIX,kBAAkBA,CACvBW,GACA,yCAAyC;gBACzC,kFAAkF;gBAClF,4HAA4H;gBAC5HF,sBAAsB,IAAIV,0BAA0BA,CAACS,wBAAwBI,MACvEJ,eACA,IAAII,IAAyBC,OAAO,OAAO,CAACL;SAGzD;IACL;IAEA,IAAIF,gBAAgBA,aAAa,MAAM,GAAG,GAAG;QACzC,MAAMI,QAAQ,aAAa,CAAC,eAAe,CAAC;eACrCT,wBAAwBA,CAACK;SAC/B;IACL;IAEA,OAAOI;AACX"}
+{"version":3,"file":"initializeFireflyForStorybook.js","sources":["../src/initializeFireflyForStorybook.ts"],"sourcesContent":["import { EnvironmentVariables, EnvironmentVariablesPlugin } from \"@squide/env-vars\";\nimport { FireflyRuntime, InMemoryLaunchDarklyClient, LaunchDarklyPlugin, ModuleRegisterFunction, PluginFactory, toLocalModuleDefinitions } from \"@squide/firefly\";\nimport { MswPlugin } from \"@squide/msw\";\nimport { RootLogger } from \"@workleap/logging\";\nimport { LDClient, LDFlagValue } from \"launchdarkly-js-client-sdk\";\nimport { StorybookRuntime } from \"./StorybookRuntime.ts\";\n\nexport interface InitializeFireflyForStorybookOptions {\n    localModules?: ModuleRegisterFunction<FireflyRuntime>[];\n    environmentVariables?: EnvironmentVariables;\n    featureFlags?: Map<string, LDFlagValue> | Record<string, LDFlagValue>;\n    launchDarklyClient?: LDClient;\n    loggers?: RootLogger[];\n}\n\nfunction logInitializationState(\n    runtime: FireflyRuntime,\n    options: InitializeFireflyForStorybookOptions,\n    plugins: PluginFactory<FireflyRuntime>[]\n) {\n    const {\n        localModules,\n        environmentVariables,\n        featureFlags,\n        launchDarklyClient\n    } = options;\n    const scope = (runtime.logger as RootLogger).startScope(\"[squide] Initializing the application.\");\n\n    try {\n        scope.information(\"[squide] Mode: development\");\n\n        if (localModules) {\n            scope\n                .withText(\"[squide] Local modules:\")\n                .withObject(localModules)\n                .information();\n        }\n\n        scope.information(\"[squide] Use MSW: Yes\");\n\n        if (environmentVariables && Object.keys(environmentVariables).length > 0) {\n            scope\n                .withText(\"[squide] Environment variables:\")\n                .withObject(environmentVariables)\n                .information();\n        }\n\n        if (featureFlags) {\n            scope\n                .withText(\"[squide] Feature flags:\")\n                .withObject(featureFlags)\n                .information();\n        }\n\n        if (launchDarklyClient) {\n            scope\n                .withText(\"[squide] LaunchDarkly client:\")\n                .withObject(launchDarklyClient)\n                .information();\n        }\n\n        if (plugins.length > 0) {\n            scope\n                .withText(\"[squide] Plugins:\")\n                .withObject(plugins)\n                .information();\n        }\n    } finally {\n        scope.end();\n    }\n}\n\nexport async function initializeFireflyForStorybook(options: InitializeFireflyForStorybookOptions = {}) {\n    const {\n        localModules,\n        environmentVariables,\n        featureFlags = {},\n        launchDarklyClient,\n        loggers\n    } = options;\n\n    const plugins: PluginFactory<FireflyRuntime>[] = [\n        x => new MswPlugin(x),\n        x => new EnvironmentVariablesPlugin(x, {\n            variables: environmentVariables\n        }),\n        x => new LaunchDarklyPlugin(\n            x,\n            // 1- If no client is provided create it.\n            // 2- If feature flags are provided and it's an instance of Map, use the argument.\n            // 3- If feature flags are provided (or the default value) and it's an object literal, convert the object to a Map instance.\n            launchDarklyClient ?? new InMemoryLaunchDarklyClient(featureFlags instanceof Map\n                ? featureFlags\n                : new Map<string, LDFlagValue>(Object.entries(featureFlags))\n            )\n        )\n    ];\n\n    const runtime = new StorybookRuntime({\n        mode: \"development\",\n        plugins,\n        loggers\n    });\n\n    logInitializationState(runtime, options, plugins);\n\n    if (localModules && localModules.length > 0) {\n        await runtime.moduleManager.registerModules([\n            ...toLocalModuleDefinitions(localModules)\n        ]);\n    }\n\n    return runtime;\n}\n"],"names":["EnvironmentVariablesPlugin","InMemoryLaunchDarklyClient","LaunchDarklyPlugin","toLocalModuleDefinitions","MswPlugin","StorybookRuntime","logInitializationState","runtime","options","plugins","localModules","environmentVariables","featureFlags","launchDarklyClient","scope","Object","initializeFireflyForStorybook","loggers","x","Map"],"mappings":";;;;;;;;;;;;;;AAAoF;AAC8E;AAC1H;AAGiB;AAUzD,SAASM,uBACLC,OAAuB,EACvBC,OAA6C,EAC7CC,OAAwC;IAExC,MAAM,EACFC,YAAY,EACZC,oBAAoB,EACpBC,YAAY,EACZC,kBAAkB,EACrB,GAAGL;IACJ,MAAMM,QAASP,QAAQ,MAAM,CAAgB,UAAU,CAAC;IAExD,IAAI;QACAO,MAAM,WAAW,CAAC;QAElB,IAAIJ,cAAc;YACdI,MACK,QAAQ,CAAC,2BACT,UAAU,CAACJ,cACX,WAAW;QACpB;QAEAI,MAAM,WAAW,CAAC;QAElB,IAAIH,wBAAwBI,OAAO,IAAI,CAACJ,sBAAsB,MAAM,GAAG,GAAG;YACtEG,MACK,QAAQ,CAAC,mCACT,UAAU,CAACH,sBACX,WAAW;QACpB;QAEA,IAAIC,cAAc;YACdE,MACK,QAAQ,CAAC,2BACT,UAAU,CAACF,cACX,WAAW;QACpB;QAEA,IAAIC,oBAAoB;YACpBC,MACK,QAAQ,CAAC,iCACT,UAAU,CAACD,oBACX,WAAW;QACpB;QAEA,IAAIJ,QAAQ,MAAM,GAAG,GAAG;YACpBK,MACK,QAAQ,CAAC,qBACT,UAAU,CAACL,SACX,WAAW;QACpB;IACJ,SAAU;QACNK,MAAM,GAAG;IACb;AACJ;AAEO,eAAeE,8BAA8BR,UAAgD,CAAC,CAAC;IAClG,MAAM,EACFE,YAAY,EACZC,oBAAoB,EACpBC,eAAe,CAAC,CAAC,EACjBC,kBAAkB,EAClBI,OAAO,EACV,GAAGT;IAEJ,MAAMC,UAA2C;QAC7CS,CAAAA,IAAK,IAAId,SAASA,CAACc;QACnBA,CAAAA,IAAK,IAAIlB,0BAA0BA,CAACkB,GAAG;gBACnC,WAAWP;YACf;QACAO,CAAAA,IAAK,IAAIhB,kBAAkBA,CACvBgB,GACA,yCAAyC;YACzC,kFAAkF;YAClF,4HAA4H;YAC5HL,sBAAsB,IAAIZ,0BAA0BA,CAACW,wBAAwBO,MACvEP,eACA,IAAIO,IAAyBJ,OAAO,OAAO,CAACH;KAGzD;IAED,MAAML,UAAU,IAAIF,gBAAgBA,CAAC;QACjC,MAAM;QACNI;QACAQ;IACJ;IAEAX,uBAAuBC,SAASC,SAASC;IAEzC,IAAIC,gBAAgBA,aAAa,MAAM,GAAG,GAAG;QACzC,MAAMH,QAAQ,aAAa,CAAC,eAAe,CAAC;eACrCJ,wBAAwBA,CAACO;SAC/B;IACL;IAEA,OAAOH;AACX"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@squide/firefly-rsbuild-storybook",
   "author": "Workleap",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Squide firefly helpers for Storybook and Rsbuild.",
   "license": "Apache-2.0",
   "repository": {
@@ -46,10 +46,10 @@
   "dependencies": {
     "@workleap-telemetry/core": "^1.0.6",
     "@workleap/logging": "^1.3.3",
-    "@squide/env-vars": "1.4.11",
-    "@squide/firefly": "16.1.2",
-    "@squide/launch-darkly": "1.0.2",
-    "@squide/msw": "4.0.9"
+    "@squide/env-vars": "1.4.12",
+    "@squide/firefly": "16.1.4",
+    "@squide/launch-darkly": "1.0.3",
+    "@squide/msw": "4.0.10"
   },
   "devDependencies": {
     "@eslint/js": "9.39.1",

package/src/initializeFireflyForStorybook.ts

@@ -1,6 +1,7 @@
 import { EnvironmentVariables, EnvironmentVariablesPlugin } from "@squide/env-vars";
-import { FireflyRuntime, InMemoryLaunchDarklyClient, LaunchDarklyPlugin, ModuleRegisterFunction, toLocalModuleDefinitions } from "@squide/firefly";
+import { FireflyRuntime, InMemoryLaunchDarklyClient, LaunchDarklyPlugin, ModuleRegisterFunction, PluginFactory, toLocalModuleDefinitions } from "@squide/firefly";
 import { MswPlugin } from "@squide/msw";
+import { RootLogger } from "@workleap/logging";
 import { LDClient, LDFlagValue } from "launchdarkly-js-client-sdk";
 import { StorybookRuntime } from "./StorybookRuntime.ts";
 
@@ -9,6 +10,64 @@ export interface InitializeFireflyForStorybookOptions {
     environmentVariables?: EnvironmentVariables;
     featureFlags?: Map<string, LDFlagValue> | Record<string, LDFlagValue>;
     launchDarklyClient?: LDClient;
+    loggers?: RootLogger[];
+}
+
+function logInitializationState(
+    runtime: FireflyRuntime,
+    options: InitializeFireflyForStorybookOptions,
+    plugins: PluginFactory<FireflyRuntime>[]
+) {
+    const {
+        localModules,
+        environmentVariables,
+        featureFlags,
+        launchDarklyClient
+    } = options;
+    const scope = (runtime.logger as RootLogger).startScope("[squide] Initializing the application.");
+
+    try {
+        scope.information("[squide] Mode: development");
+
+        if (localModules) {
+            scope
+                .withText("[squide] Local modules:")
+                .withObject(localModules)
+                .information();
+        }
+
+        scope.information("[squide] Use MSW: Yes");
+
+        if (environmentVariables && Object.keys(environmentVariables).length > 0) {
+            scope
+                .withText("[squide] Environment variables:")
+                .withObject(environmentVariables)
+                .information();
+        }
+
+        if (featureFlags) {
+            scope
+                .withText("[squide] Feature flags:")
+                .withObject(featureFlags)
+                .information();
+        }
+
+        if (launchDarklyClient) {
+            scope
+                .withText("[squide] LaunchDarkly client:")
+                .withObject(launchDarklyClient)
+                .information();
+        }
+
+        if (plugins.length > 0) {
+            scope
+                .withText("[squide] Plugins:")
+                .withObject(plugins)
+                .information();
+        }
+    } finally {
+        scope.end();
+    }
 }
 
 export async function initializeFireflyForStorybook(options: InitializeFireflyForStorybookOptions = {}) {
@@ -16,29 +75,35 @@ export async function initializeFireflyForStorybook(options: InitializeFireflyFo
         localModules,
         environmentVariables,
         featureFlags = {},
-        launchDarklyClient
+        launchDarklyClient,
+        loggers
     } = options;
 
+    const plugins: PluginFactory<FireflyRuntime>[] = [
+        x => new MswPlugin(x),
+        x => new EnvironmentVariablesPlugin(x, {
+            variables: environmentVariables
+        }),
+        x => new LaunchDarklyPlugin(
+            x,
+            // 1- If no client is provided create it.
+            // 2- If feature flags are provided and it's an instance of Map, use the argument.
+            // 3- If feature flags are provided (or the default value) and it's an object literal, convert the object to a Map instance.
+            launchDarklyClient ?? new InMemoryLaunchDarklyClient(featureFlags instanceof Map
+                ? featureFlags
+                : new Map<string, LDFlagValue>(Object.entries(featureFlags))
+            )
+        )
+    ];
+
     const runtime = new StorybookRuntime({
         mode: "development",
-        plugins: [
-            x => new MswPlugin(x),
-            x => new EnvironmentVariablesPlugin(x, {
-                variables: environmentVariables
-            }),
-            x => new LaunchDarklyPlugin(
-                x,
-                // 1- If no client is provided create it.
-                // 2- If feature flags are provided and it's an instance of Map, use the argument.
-                // 3- If feature flags are provided (or the default value) and it's an object literal, convert the object to a Map instance.
-                launchDarklyClient ?? new InMemoryLaunchDarklyClient(featureFlags instanceof Map
-                    ? featureFlags
-                    : new Map<string, LDFlagValue>(Object.entries(featureFlags))
-                )
-            )
-        ]
+        plugins,
+        loggers
     });
 
+    logInitializationState(runtime, options, plugins);
+
     if (localModules && localModules.length > 0) {
         await runtime.moduleManager.registerModules([
             ...toLocalModuleDefinitions(localModules)