@dxos/storybook-utils 0.7.5-labs.071a3e2

package/LICENSE

@@ -0,0 +1,8 @@
+MIT License 
+Copyright (c) 2022 DXOS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,9 @@
+# @dxos/storybook-utils
+
+Utilities for DXOS UI Storybooks.
+
+## Contributions
+
+Your ideas, issues, and code are most welcome. Please take a look at our [community code of conduct](https://github.com/dxos/dxos/blob/main/CODE_OF_CONDUCT.md), the [issue guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-issues), and the [PR contribution guide](https://github.com/dxos/dxos/blob/main/CONTRIBUTING.md#submitting-prs).
+
+License: [MIT](./LICENSE) Copyright 2022 © DXOS

package/README.yml

@@ -0,0 +1 @@
+guideUrl: https://docs.dxos.org/guide/react/aurora/

package/dist/lib/browser/index.mjs

@@ -0,0 +1,82 @@
+// packages/common/storybook-utils/src/index.ts
+import { registerSignalsRuntime as registerSignalsRuntime2 } from "@dxos/echo-signals/react";
+
+// packages/common/storybook-utils/src/decorators/withLayout.tsx
+import defaultsDeep from "lodash.defaultsdeep";
+import React from "react";
+import { DensityProvider } from "@dxos/react-ui";
+import { Tooltip } from "@dxos/react-ui";
+import { mx } from "@dxos/react-ui-theme";
+var defaultOptions = {
+  density: "fine"
+};
+var providers = [
+  (children, options) => {
+    return options.tooltips ? /* @__PURE__ */ React.createElement(Tooltip.Provider, null, children) : children;
+  },
+  (children, options) => {
+    return options?.density ? /* @__PURE__ */ React.createElement(DensityProvider, {
+      density: options.density
+    }, children) : children;
+  }
+];
+var withLayout = ({ classNames, fullscreen, ..._options } = {}) => {
+  return (Story, _context) => {
+    const options = defaultsDeep({}, _options, defaultOptions);
+    const children = (
+      // NOTE: Do not change the flex direction to flex-col by default.
+      /* @__PURE__ */ React.createElement("div", {
+        role: "none",
+        className: mx(fullscreen && "fixed inset-0 flex overflow-hidden", classNames)
+      }, /* @__PURE__ */ React.createElement(Story, null))
+    );
+    return providers.reduceRight((acc, provider) => provider(acc, options), children);
+  };
+};
+
+// packages/common/storybook-utils/src/decorators/withSignals.tsx
+import React2 from "react";
+import { registerSignalsRuntime } from "@dxos/echo-signals/react";
+var withSignals = (Story) => {
+  registerSignalsRuntime();
+  return /* @__PURE__ */ React2.createElement(Story, null);
+};
+
+// packages/common/storybook-utils/src/decorators/withTheme.tsx
+import { addons } from "@storybook/preview-api";
+import React3, { memo, useEffect, useState } from "react";
+import { DARK_MODE_EVENT_NAME } from "storybook-dark-mode";
+import { ThemeProvider } from "@dxos/react-ui";
+import { defaultTx } from "@dxos/react-ui-theme";
+var channel = addons.getChannel();
+var withTheme = (Story, context) => {
+  const MemoizedStory = /* @__PURE__ */ memo(Story);
+  const [themeMode, setThemeMode] = useState("dark");
+  useEffect(() => {
+    const handleUpdate = (darkMode) => setThemeMode(darkMode ? "dark" : "light");
+    channel.on(DARK_MODE_EVENT_NAME, handleUpdate);
+    return () => channel.off(DARK_MODE_EVENT_NAME, handleUpdate);
+  }, [
+    channel
+  ]);
+  return /* @__PURE__ */ React3.createElement(ThemeProvider, {
+    tx: defaultTx,
+    themeMode,
+    resourceExtensions: context?.parameters?.translations,
+    noCache: true
+  }, /* @__PURE__ */ React3.createElement(MemoizedStory, null));
+};
+
+// packages/common/storybook-utils/src/util.tsx
+import React4 from "react";
+var render = (r) => (args) => /* @__PURE__ */ React4.createElement(React4.Fragment, null, r(args) ?? /* @__PURE__ */ React4.createElement("div", null));
+
+// packages/common/storybook-utils/src/index.ts
+registerSignalsRuntime2();
+export {
+  render,
+  withLayout,
+  withSignals,
+  withTheme
+};
+//# sourceMappingURL=index.mjs.map

package/dist/lib/browser/index.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/index.ts", "../../../src/decorators/withLayout.tsx", "../../../src/decorators/withSignals.tsx", "../../../src/decorators/withTheme.tsx", "../../../src/util.tsx"],
+  "sourcesContent": ["//\n// Copyright 2023 DXOS.org\n//\n\nimport { registerSignalsRuntime } from '@dxos/echo-signals/react';\n\nexport { type Meta } from '@storybook/react';\n\nexport * from './decorators';\nexport * from './util';\n\nregisterSignalsRuntime();\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Decorator } from '@storybook/react';\nimport defaultsDeep from 'lodash.defaultsdeep';\nimport React, { type JSX } from 'react';\n\nimport { type Density, DensityProvider, type ThemedClassName } from '@dxos/react-ui';\nimport { Tooltip } from '@dxos/react-ui';\nimport { mx } from '@dxos/react-ui-theme';\n\ntype ProviderOptions = {\n  fullscreen?: boolean;\n  density?: Density;\n  tooltips?: boolean;\n};\n\nconst defaultOptions: ProviderOptions = {\n  density: 'fine',\n};\n\ntype Provider = (children: JSX.Element, options: ProviderOptions) => JSX.Element;\n\nconst providers: Provider[] = [\n  (children, options) => {\n    return options.tooltips ? <Tooltip.Provider>{children}</Tooltip.Provider> : children;\n  },\n  (children, options) => {\n    return options?.density ? <DensityProvider density={options.density}>{children}</DensityProvider> : children;\n  },\n];\n\nexport type WithFullscreenProps = ThemedClassName<ProviderOptions>;\n\n/**\n * Decorator to layout the story container, adding optional providers.\n */\nexport const withLayout = ({ classNames, fullscreen, ..._options }: WithFullscreenProps = {}): Decorator => {\n  // TODO(burdon): Inspect \"fullscreen\" parameter in context.\n  return (Story, _context) => {\n    const options = defaultsDeep({}, _options, defaultOptions);\n    const children = (\n      // NOTE: Do not change the flex direction to flex-col by default.\n      <div role='none' className={mx(fullscreen && 'fixed inset-0 flex overflow-hidden', classNames)}>\n        <Story />\n      </div>\n    );\n\n    return providers.reduceRight((acc, provider) => provider(acc, options), children);\n  };\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { type Decorator } from '@storybook/react';\nimport React from 'react';\n\nimport { registerSignalsRuntime } from '@dxos/echo-signals/react';\n\n/**\n * Make objects created using @dxos/echo-schema `create` reactive.\n */\nexport const withSignals: Decorator = (Story) => {\n  registerSignalsRuntime();\n  return <Story />;\n};\n", "//\n// Copyright 2023 DXOS.org\n//\n\nimport { addons } from '@storybook/preview-api';\nimport { type Decorator } from '@storybook/react';\nimport React, { memo, useEffect, useState } from 'react';\nimport { DARK_MODE_EVENT_NAME } from 'storybook-dark-mode';\n\nimport { type ThemeMode, ThemeProvider } from '@dxos/react-ui';\nimport { defaultTx } from '@dxos/react-ui-theme';\n\nconst channel = addons.getChannel();\n\n/**\n * Changes theme based on storybook toolbar toggle.\n */\nexport const withTheme: Decorator = (Story, context) => {\n  // Prevent re-rendering of the story.\n  const MemoizedStory = memo(Story);\n  const [themeMode, setThemeMode] = useState<ThemeMode>('dark');\n\n  // https://www.npmjs.com/package/storybook-dark-mode\n  // NOTE: The `useDarkMode` hook causes the story to continually re-render.\n  // NOTE: Changing the theme will cause the story to remount.\n  useEffect(() => {\n    const handleUpdate = (darkMode: boolean) => setThemeMode(darkMode ? 'dark' : 'light');\n    channel.on(DARK_MODE_EVENT_NAME, handleUpdate);\n    return () => channel.off(DARK_MODE_EVENT_NAME, handleUpdate);\n  }, [channel]);\n\n  return (\n    <ThemeProvider tx={defaultTx} themeMode={themeMode} resourceExtensions={context?.parameters?.translations} noCache>\n      <MemoizedStory />\n    </ThemeProvider>\n  );\n};\n", "//\n// Copyright 2024 DXOS.org\n//\n\nimport React, { type FC } from 'react';\n\n/**\n * Story renderer wrapper.\n */\nexport const render =\n  <T,>(r: FC<T>) =>\n  (args: T) => <>{r(args) ?? <div />}</>;\n"],
+  "mappings": ";AAIA,SAASA,0BAAAA,+BAA8B;;;ACCvC,OAAOC,kBAAkB;AACzB,OAAOC,WAAyB;AAEhC,SAAuBC,uBAA6C;AACpE,SAASC,eAAe;AACxB,SAASC,UAAU;AAQnB,IAAMC,iBAAkC;EACtCC,SAAS;AACX;AAIA,IAAMC,YAAwB;EAC5B,CAACC,UAAUC,YAAAA;AACT,WAAOA,QAAQC,WAAW,sBAAA,cAACC,QAAQC,UAAQ,MAAEJ,QAAAA,IAA+BA;EAC9E;EACA,CAACA,UAAUC,YAAAA;AACT,WAAOA,SAASH,UAAU,sBAAA,cAACO,iBAAAA;MAAgBP,SAASG,QAAQH;OAAUE,QAAAA,IAA8BA;EACtG;;AAQK,IAAMM,aAAa,CAAC,EAAEC,YAAYC,YAAY,GAAGC,SAAAA,IAAkC,CAAC,MAAC;AAE1F,SAAO,CAACC,OAAOC,aAAAA;AACb,UAAMV,UAAUW,aAAa,CAAC,GAAGH,UAAUZ,cAAAA;AAC3C,UAAMG;;MAEJ,sBAAA,cAACa,OAAAA;QAAIC,MAAK;QAAOC,WAAWC,GAAGR,cAAc,sCAAsCD,UAAAA;SACjF,sBAAA,cAACG,OAAAA,IAAAA,CAAAA;;AAIL,WAAOX,UAAUkB,YAAY,CAACC,KAAKC,aAAaA,SAASD,KAAKjB,OAAAA,GAAUD,QAAAA;EAC1E;AACF;;;AC9CA,OAAOoB,YAAW;AAElB,SAASC,8BAA8B;AAKhC,IAAMC,cAAyB,CAACC,UAAAA;AACrCC,yBAAAA;AACA,SAAO,gBAAAC,OAAA,cAACF,OAAAA,IAAAA;AACV;;;ACXA,SAASG,cAAc;AAEvB,OAAOC,UAASC,MAAMC,WAAWC,gBAAgB;AACjD,SAASC,4BAA4B;AAErC,SAAyBC,qBAAqB;AAC9C,SAASC,iBAAiB;AAE1B,IAAMC,UAAUC,OAAOC,WAAU;AAK1B,IAAMC,YAAuB,CAACC,OAAOC,YAAAA;AAE1C,QAAMC,gBAAgBC,qBAAKH,KAAAA;AAC3B,QAAM,CAACI,WAAWC,YAAAA,IAAgBC,SAAoB,MAAA;AAKtDC,YAAU,MAAA;AACR,UAAMC,eAAe,CAACC,aAAsBJ,aAAaI,WAAW,SAAS,OAAA;AAC7Eb,YAAQc,GAAGC,sBAAsBH,YAAAA;AACjC,WAAO,MAAMZ,QAAQgB,IAAID,sBAAsBH,YAAAA;EACjD,GAAG;IAACZ;GAAQ;AAEZ,SACE,gBAAAiB,OAAA,cAACC,eAAAA;IAAcC,IAAIC;IAAWZ;IAAsBa,oBAAoBhB,SAASiB,YAAYC;IAAcC,SAAAA;KACzG,gBAAAP,OAAA,cAACX,eAAAA,IAAAA,CAAAA;AAGP;;;AChCA,OAAOmB,YAAwB;AAKxB,IAAMC,SACX,CAAKC,MACL,CAACC,SAAY,gBAAAC,OAAA,cAAAA,OAAA,UAAA,MAAGF,EAAEC,IAAAA,KAAS,gBAAAC,OAAA,cAACC,OAAAA,IAAAA,CAAAA;;;AJA9BC,wBAAAA;",
+  "names": ["registerSignalsRuntime", "defaultsDeep", "React", "DensityProvider", "Tooltip", "mx", "defaultOptions", "density", "providers", "children", "options", "tooltips", "Tooltip", "Provider", "DensityProvider", "withLayout", "classNames", "fullscreen", "_options", "Story", "_context", "defaultsDeep", "div", "role", "className", "mx", "reduceRight", "acc", "provider", "React", "registerSignalsRuntime", "withSignals", "Story", "registerSignalsRuntime", "React", "addons", "React", "memo", "useEffect", "useState", "DARK_MODE_EVENT_NAME", "ThemeProvider", "defaultTx", "channel", "addons", "getChannel", "withTheme", "Story", "context", "MemoizedStory", "memo", "themeMode", "setThemeMode", "useState", "useEffect", "handleUpdate", "darkMode", "on", "DARK_MODE_EVENT_NAME", "off", "React", "ThemeProvider", "tx", "defaultTx", "resourceExtensions", "parameters", "translations", "noCache", "React", "render", "r", "args", "React", "div", "registerSignalsRuntime"]
+}

package/dist/lib/browser/meta.json

@@ -0,0 +1 @@
+{"inputs":{"packages/common/storybook-utils/src/decorators/withLayout.tsx":{"bytes":5343,"imports":[{"path":"lodash.defaultsdeep","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true}],"format":"esm"},"packages/common/storybook-utils/src/decorators/withSignals.tsx":{"bytes":1440,"imports":[{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo-signals/react","kind":"import-statement","external":true}],"format":"esm"},"packages/common/storybook-utils/src/decorators/withTheme.tsx":{"bytes":4710,"imports":[{"path":"@storybook/preview-api","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"storybook-dark-mode","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true}],"format":"esm"},"packages/common/storybook-utils/src/decorators/index.ts":{"bytes":708,"imports":[{"path":"packages/common/storybook-utils/src/decorators/withLayout.tsx","kind":"import-statement","original":"./withLayout"},{"path":"packages/common/storybook-utils/src/decorators/withSignals.tsx","kind":"import-statement","original":"./withSignals"},{"path":"packages/common/storybook-utils/src/decorators/withTheme.tsx","kind":"import-statement","original":"./withTheme"}],"format":"esm"},"packages/common/storybook-utils/src/util.tsx":{"bytes":1048,"imports":[{"path":"react","kind":"import-statement","external":true}],"format":"esm"},"packages/common/storybook-utils/src/index.ts":{"bytes":962,"imports":[{"path":"@dxos/echo-signals/react","kind":"import-statement","external":true},{"path":"packages/common/storybook-utils/src/decorators/index.ts","kind":"import-statement","original":"./decorators"},{"path":"packages/common/storybook-utils/src/util.tsx","kind":"import-statement","original":"./util"}],"format":"esm"}},"outputs":{"packages/common/storybook-utils/dist/lib/browser/index.mjs.map":{"imports":[],"exports":[],"inputs":{},"bytes":6666},"packages/common/storybook-utils/dist/lib/browser/index.mjs":{"imports":[{"path":"@dxos/echo-signals/react","kind":"import-statement","external":true},{"path":"lodash.defaultsdeep","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"@dxos/echo-signals/react","kind":"import-statement","external":true},{"path":"@storybook/preview-api","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true},{"path":"storybook-dark-mode","kind":"import-statement","external":true},{"path":"@dxos/react-ui","kind":"import-statement","external":true},{"path":"@dxos/react-ui-theme","kind":"import-statement","external":true},{"path":"react","kind":"import-statement","external":true}],"exports":["render","withLayout","withSignals","withTheme"],"entryPoint":"packages/common/storybook-utils/src/index.ts","inputs":{"packages/common/storybook-utils/src/index.ts":{"bytesInOutput":121},"packages/common/storybook-utils/src/decorators/withLayout.tsx":{"bytesInOutput":1175},"packages/common/storybook-utils/src/decorators/index.ts":{"bytesInOutput":0},"packages/common/storybook-utils/src/decorators/withSignals.tsx":{"bytesInOutput":217},"packages/common/storybook-utils/src/decorators/withTheme.tsx":{"bytesInOutput":933},"packages/common/storybook-utils/src/util.tsx":{"bytesInOutput":181}},"bytes":3069}}}

package/dist/types/src/decorators/index.d.ts

@@ -0,0 +1,4 @@
+export * from './withLayout';
+export * from './withSignals';
+export * from './withTheme';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/decorators/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/decorators/index.ts"],"names":[],"mappings":"AAIA,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC"}

package/dist/types/src/decorators/withLayout.d.ts

@@ -0,0 +1,14 @@
+import { type Decorator } from '@storybook/react';
+import { type Density, type ThemedClassName } from '@dxos/react-ui';
+type ProviderOptions = {
+    fullscreen?: boolean;
+    density?: Density;
+    tooltips?: boolean;
+};
+export type WithFullscreenProps = ThemedClassName<ProviderOptions>;
+/**
+ * Decorator to layout the story container, adding optional providers.
+ */
+export declare const withLayout: ({ classNames, fullscreen, ..._options }?: WithFullscreenProps) => Decorator;
+export {};
+//# sourceMappingURL=withLayout.d.ts.map

package/dist/types/src/decorators/withLayout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withLayout.d.ts","sourceRoot":"","sources":["../../../../src/decorators/withLayout.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAIlD,OAAO,EAAE,KAAK,OAAO,EAAmB,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAIrF,KAAK,eAAe,GAAG;IACrB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAiBF,MAAM,MAAM,mBAAmB,GAAG,eAAe,CAAC,eAAe,CAAC,CAAC;AAEnE;;GAEG;AACH,eAAO,MAAM,UAAU,6CAA6C,mBAAmB,KAAQ,SAa9F,CAAC"}

package/dist/types/src/decorators/withSignals.d.ts

@@ -0,0 +1,6 @@
+import { type Decorator } from '@storybook/react';
+/**
+ * Make objects created using @dxos/echo-schema `create` reactive.
+ */
+export declare const withSignals: Decorator;
+//# sourceMappingURL=withSignals.d.ts.map

package/dist/types/src/decorators/withSignals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withSignals.d.ts","sourceRoot":"","sources":["../../../../src/decorators/withSignals.tsx"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAKlD;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,SAGzB,CAAC"}

package/dist/types/src/decorators/withTheme.d.ts

@@ -0,0 +1,6 @@
+import { type Decorator } from '@storybook/react';
+/**
+ * Changes theme based on storybook toolbar toggle.
+ */
+export declare const withTheme: Decorator;
+//# sourceMappingURL=withTheme.d.ts.map

package/dist/types/src/decorators/withTheme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withTheme.d.ts","sourceRoot":"","sources":["../../../../src/decorators/withTheme.tsx"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AASlD;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,SAmBvB,CAAC"}

package/dist/types/src/index.d.ts

@@ -0,0 +1,4 @@
+export { type Meta } from '@storybook/react';
+export * from './decorators';
+export * from './util';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,cAAc,cAAc,CAAC;AAC7B,cAAc,QAAQ,CAAC"}

package/dist/types/src/util.d.ts

@@ -0,0 +1,6 @@
+import React, { type FC } from 'react';
+/**
+ * Story renderer wrapper.
+ */
+export declare const render: <T>(r: FC<T>) => (args: T) => React.JSX.Element;
+//# sourceMappingURL=util.d.ts.map

package/dist/types/src/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../src/util.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,MAAM,OAAO,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,MAAM,GAChB,CAAC,KAAM,EAAE,CAAC,CAAC,CAAC,YACN,CAAC,sBAA8B,CAAC"}

package/dist/types/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"version":"5.7.3"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@dxos/storybook-utils",
+  "version": "0.7.5-labs.071a3e2",
+  "description": "Utilities for DXOS UI Storybooks.",
+  "homepage": "https://dxos.org",
+  "bugs": "https://github.com/dxos/dxos/issues",
+  "license": "MIT",
+  "author": "DXOS.org",
+  "sideEffects": true,
+  "exports": {
+    ".": {
+      "types": "./dist/types/src/index.d.ts",
+      "browser": "./dist/lib/browser/index.mjs"
+    }
+  },
+  "types": "dist/types/src/index.d.ts",
+  "typesVersions": {
+    "*": {}
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "dependencies": {
+    "@storybook/preview-api": "^8.3.6",
+    "lodash.defaultsdeep": "^4.6.1",
+    "storybook-dark-mode": "^4.0.2",
+    "@dxos/echo-signals": "0.7.5-labs.071a3e2",
+    "@dxos/log": "0.7.5-labs.071a3e2"
+  },
+  "devDependencies": {
+    "@types/lodash.defaultsdeep": "^4.6.6",
+    "@types/react": "~18.2.0",
+    "@types/react-dom": "~18.2.0",
+    "react": "~18.2.0",
+    "react-dom": "~18.2.0",
+    "storybook": "^8.3.6",
+    "@dxos/react-ui": "0.7.5-labs.071a3e2",
+    "@dxos/react-ui-theme": "0.7.5-labs.071a3e2"
+  },
+  "peerDependencies": {
+    "react": "~18.2.0",
+    "react-dom": "~18.2.0",
+    "@dxos/react-ui": "0.7.5-labs.071a3e2",
+    "@dxos/react-ui-theme": "0.7.5-labs.071a3e2"
+  }
+}

package/src/decorators/index.ts

@@ -0,0 +1,7 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+export * from './withLayout';
+export * from './withSignals';
+export * from './withTheme';

package/src/decorators/withLayout.tsx

@@ -0,0 +1,52 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Decorator } from '@storybook/react';
+import defaultsDeep from 'lodash.defaultsdeep';
+import React, { type JSX } from 'react';
+
+import { type Density, DensityProvider, type ThemedClassName } from '@dxos/react-ui';
+import { Tooltip } from '@dxos/react-ui';
+import { mx } from '@dxos/react-ui-theme';
+
+type ProviderOptions = {
+  fullscreen?: boolean;
+  density?: Density;
+  tooltips?: boolean;
+};
+
+const defaultOptions: ProviderOptions = {
+  density: 'fine',
+};
+
+type Provider = (children: JSX.Element, options: ProviderOptions) => JSX.Element;
+
+const providers: Provider[] = [
+  (children, options) => {
+    return options.tooltips ? <Tooltip.Provider>{children}</Tooltip.Provider> : children;
+  },
+  (children, options) => {
+    return options?.density ? <DensityProvider density={options.density}>{children}</DensityProvider> : children;
+  },
+];
+
+export type WithFullscreenProps = ThemedClassName<ProviderOptions>;
+
+/**
+ * Decorator to layout the story container, adding optional providers.
+ */
+export const withLayout = ({ classNames, fullscreen, ..._options }: WithFullscreenProps = {}): Decorator => {
+  // TODO(burdon): Inspect "fullscreen" parameter in context.
+  return (Story, _context) => {
+    const options = defaultsDeep({}, _options, defaultOptions);
+    const children = (
+      // NOTE: Do not change the flex direction to flex-col by default.
+      <div role='none' className={mx(fullscreen && 'fixed inset-0 flex overflow-hidden', classNames)}>
+        <Story />
+      </div>
+    );
+
+    return providers.reduceRight((acc, provider) => provider(acc, options), children);
+  };
+};

package/src/decorators/withSignals.tsx

@@ -0,0 +1,16 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { type Decorator } from '@storybook/react';
+import React from 'react';
+
+import { registerSignalsRuntime } from '@dxos/echo-signals/react';
+
+/**
+ * Make objects created using @dxos/echo-schema `create` reactive.
+ */
+export const withSignals: Decorator = (Story) => {
+  registerSignalsRuntime();
+  return <Story />;
+};

package/src/decorators/withTheme.tsx

@@ -0,0 +1,37 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { addons } from '@storybook/preview-api';
+import { type Decorator } from '@storybook/react';
+import React, { memo, useEffect, useState } from 'react';
+import { DARK_MODE_EVENT_NAME } from 'storybook-dark-mode';
+
+import { type ThemeMode, ThemeProvider } from '@dxos/react-ui';
+import { defaultTx } from '@dxos/react-ui-theme';
+
+const channel = addons.getChannel();
+
+/**
+ * Changes theme based on storybook toolbar toggle.
+ */
+export const withTheme: Decorator = (Story, context) => {
+  // Prevent re-rendering of the story.
+  const MemoizedStory = memo(Story);
+  const [themeMode, setThemeMode] = useState<ThemeMode>('dark');
+
+  // https://www.npmjs.com/package/storybook-dark-mode
+  // NOTE: The `useDarkMode` hook causes the story to continually re-render.
+  // NOTE: Changing the theme will cause the story to remount.
+  useEffect(() => {
+    const handleUpdate = (darkMode: boolean) => setThemeMode(darkMode ? 'dark' : 'light');
+    channel.on(DARK_MODE_EVENT_NAME, handleUpdate);
+    return () => channel.off(DARK_MODE_EVENT_NAME, handleUpdate);
+  }, [channel]);
+
+  return (
+    <ThemeProvider tx={defaultTx} themeMode={themeMode} resourceExtensions={context?.parameters?.translations} noCache>
+      <MemoizedStory />
+    </ThemeProvider>
+  );
+};

package/src/index.ts

@@ -0,0 +1,12 @@
+//
+// Copyright 2023 DXOS.org
+//
+
+import { registerSignalsRuntime } from '@dxos/echo-signals/react';
+
+export { type Meta } from '@storybook/react';
+
+export * from './decorators';
+export * from './util';
+
+registerSignalsRuntime();

package/src/util.tsx

@@ -0,0 +1,12 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import React, { type FC } from 'react';
+
+/**
+ * Story renderer wrapper.
+ */
+export const render =
+  <T,>(r: FC<T>) =>
+  (args: T) => <>{r(args) ?? <div />}</>;