@squide/firefly-rsbuild-storybook 0.0.0

package/README.md

@@ -0,0 +1,13 @@
+# @squide/firefly-rsbuild-storybook
+
+## Usage
+
+View the [user's documentation](https://workleap.github.io/wl-squide/).
+
+## 🤝 Contributing
+
+View the [contributor's documentation](../../CONTRIBUTING.md).
+
+## License
+
+Copyright © 2024, Workleap. This code is licensed under the Apache License, Version 2.0. You may obtain a copy of this license at https://github.com/workleap/workleap-license/blob/master/LICENSE.

package/package.json

@@ -0,0 +1,73 @@
+{
+    "name": "@squide/firefly-rsbuild-storybook",
+    "author": "Workleap",
+    "version": "0.0.0",
+    "description": "Squide firefly helpers for Storybook and Rsbuild.",
+    "license": "Apache-2.0",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/workleap/wl-squide.git",
+        "directory": "packages/firefly-rsbuild-storybook"
+    },
+    "type": "module",
+    "publishConfig": {
+        "access": "public",
+        "provenance": true,
+        "exports": {
+            ".": {
+                "types": "./dist/index.d.ts",
+                "import": "./dist/index.js",
+                "default": "./dist/index.js"
+            }
+        }
+    },
+    "exports": "./src/index.ts",
+    "files": [
+        "src",
+        "dist",
+        "CHANGELOG.md"
+    ],
+    "scripts": {
+        "build": "rslib build --config ./rslib.build.ts",
+        "eslint": "eslint . --max-warnings=0 --cache --cache-location node_modules/.cache/eslint",
+        "typecheck": "tsc"
+    },
+    "peerDependencies": {
+        "@opentelemetry/api": "^1.9.0",
+        "@rsbuild/core": "^1.6.9",
+        "@tanstack/react-query": "^5.90.11",
+        "msw": "^2.12.3",
+        "react": "^18.0.0 || ^19.0.0",
+        "react-dom": "^18.0.0 || ^19.0.0",
+        "react-router": "^7.9.6",
+        "storybook": "^10.1.0",
+        "storybook-react-rsbuild": "^3.0.0"
+    },
+    "peerDependenciesMeta": {
+        "@opentelemetry/api": {
+            "optional": true
+        }
+    },
+    "dependencies": {
+        "@squide/env-vars": "workspace:*",
+        "@squide/firefly": "workspace:*",
+        "@squide/msw": "workspace:*",
+        "@workleap-telemetry/core": "^1.0.4",
+        "@workleap/logging": "^1.3.2"
+    },
+    "devDependencies": {
+        "@eslint/js": "9.39.1",
+        "@rsbuild/core": "1.6.9",
+        "@rslib/core": "0.18.2",
+        "@types/react": "19.2.7",
+        "@types/react-dom": "19.2.3",
+        "@typescript-eslint/parser": "8.48.0",
+        "@workleap/eslint-configs": "1.1.5",
+        "@workleap/rslib-configs": "1.1.3",
+        "@workleap/typescript-configs": "3.0.7",
+        "eslint": "9.39.1",
+        "typescript": "5.9.3",
+        "typescript-eslint": "8.48.0"
+    },
+    "sideEffects": false
+}

package/src/StorybookRuntime.ts

@@ -0,0 +1,31 @@
+import { FireflyRuntime, FireflyRuntimeOptions, FireflyRuntimeScope } from "@squide/firefly";
+import { HoneycombInstrumentationPartialClient } from "@workleap-telemetry/core";
+import { Logger } from "@workleap/logging";
+
+export class StorybookRuntime extends FireflyRuntime {
+    constructor(options: FireflyRuntimeOptions = {}) {
+        const {
+            honeycombInstrumentationClient
+        } = options;
+
+        if (honeycombInstrumentationClient) {
+            throw new Error("[squide] A StorybookRuntime instance should not receive an Honeycomb client.");
+        }
+
+        super(options);
+    }
+
+    registerRoute() {
+        // Ignore routes registration because it doesn't matter for a Storybook host application.
+    }
+
+    get honeycombInstrumentationClient(): HoneycombInstrumentationPartialClient {
+        throw new Error("[squide] Cannot retrieve the Honeycomb instrumentation client from a StorybookRuntime instance.");
+    }
+
+    startScope(logger: Logger) {
+        return (new StorybookRuntimeScope(this, logger) as unknown) as StorybookRuntime;
+    }
+}
+
+export class StorybookRuntimeScope extends FireflyRuntimeScope { }

package/src/index.ts

@@ -0,0 +1,4 @@
+export { initializeFireflyForStorybook, type InitializeFireflyForStorybookOptions } from "./initializeFireflyForStorybook.ts";
+export { StorybookRuntime, StorybookRuntimeScope } from "./StorybookRuntime.ts";
+export { FireflyDecorator, withFireflyDecorator, type FireflyDecoratorProps } from "./withFireflyDecorator.tsx";
+

package/src/initializeFireflyForStorybook.ts

@@ -0,0 +1,32 @@
+import { EnvironmentVariables, EnvironmentVariablesPlugin } from "@squide/env-vars";
+import { FireflyRuntime, ModuleRegisterFunction, toLocalModuleDefinitions } from "@squide/firefly";
+import { MswPlugin } from "@squide/msw";
+import { StorybookRuntime } from "./StorybookRuntime.ts";
+
+export interface InitializeFireflyForStorybookOptions {
+    localModules?: ModuleRegisterFunction<FireflyRuntime>[];
+    environmentVariables?: EnvironmentVariables;
+}
+
+export async function initializeFireflyForStorybook(options: InitializeFireflyForStorybookOptions = {}) {
+    const {
+        localModules = [],
+        environmentVariables = {}
+    } = options;
+
+    const runtime = new StorybookRuntime({
+        mode: "development",
+        plugins: [
+            x => new MswPlugin(x),
+            x => new EnvironmentVariablesPlugin(x, {
+                variables: environmentVariables
+            })
+        ]
+    });
+
+    await runtime.moduleManager.registerModules([
+        ...toLocalModuleDefinitions(localModules)
+    ]);
+
+    return runtime;
+}

package/src/withFireflyDecorator.tsx

@@ -0,0 +1,53 @@
+import { AppRouter, FireflyProvider, FireflyRuntime } from "@squide/firefly";
+import type { PropsWithChildren } from "react";
+import { createMemoryRouter } from "react-router";
+import { RouterProvider } from "react-router/dom";
+import { Decorator } from "storybook-react-rsbuild";
+
+export function withFireflyDecorator(runtime: FireflyRuntime): Decorator {
+    return story => {
+        return (
+            <FireflyDecorator runtime={runtime}>
+                {story()}
+            </FireflyDecorator>
+        );
+    };
+}
+
+export interface FireflyDecoratorProps extends PropsWithChildren {
+    runtime: FireflyRuntime;
+}
+
+export function FireflyDecorator(props: FireflyDecoratorProps) {
+    const {
+        runtime,
+        children: story
+    } = props;
+
+    return (
+        <FireflyProvider runtime={runtime}>
+            <AppRouter strictMode={false}>
+                {({ rootRoute, routerProviderProps }) => {
+                    return (
+                        <RouterProvider
+                            router={createMemoryRouter([
+                                {
+                                    element: rootRoute,
+                                    children: [
+                                        {
+                                            path: "/story",
+                                            element: story
+                                        }
+                                    ]
+                                }
+                            ], {
+                                initialEntries: ["/story"]
+                            })}
+                            {...routerProviderProps}
+                        />
+                    );
+                }}
+            </AppRouter>
+        </FireflyProvider>
+    );
+}