@dxos/storybook-addon-logger 0.10.0 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,13 +1,9 @@
1
- // src/constants.ts
1
+ //#region src/constants.ts
2
2
  var ADDON_ID = "storybook-addon-logger";
3
3
  var TOOL_ID = `${ADDON_ID}.download-logs`;
4
4
  var DOWNLOAD_EVENT = `${ADDON_ID}.download-logs`;
5
5
  var LOGS_DATA_EVENT = `${ADDON_ID}.logs-data`;
6
+ //#endregion
7
+ export { TOOL_ID as i, DOWNLOAD_EVENT as n, LOGS_DATA_EVENT as r, ADDON_ID as t };
6
8
 
7
- export {
8
- ADDON_ID,
9
- TOOL_ID,
10
- DOWNLOAD_EVENT,
11
- LOGS_DATA_EVENT
12
- };
13
- //# sourceMappingURL=chunk-QSJMUIYY.mjs.map
9
+ //# sourceMappingURL=chunk-constants.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"chunk-constants.mjs","names":[],"sources":["../../src/constants.ts"],"sourcesContent":["//\n// Copyright 2025 DXOS.org\n//\n\nexport const ADDON_ID = 'storybook-addon-logger';\nexport const TOOL_ID = `${ADDON_ID}.download-logs`;\nexport const DOWNLOAD_EVENT = `${ADDON_ID}.download-logs`;\nexport const LOGS_DATA_EVENT = `${ADDON_ID}.logs-data`;\n"],"mappings":";AAIA,IAAa,WAAW;AACxB,IAAa,UAAU,GAAG,SAAS;AACnC,IAAa,iBAAiB,GAAG,SAAS;AAC1C,IAAa,kBAAkB,GAAG,SAAS"}
@@ -0,0 +1,19 @@
1
+ //#region src/trigger-download.ts
2
+ /**
3
+ * Downloads NDJSON log data as a file. Shared by the manager toolbar button (`manager.tsx`) and
4
+ * the preview-side `downloadLogs` (`download.ts`), which run in different Storybook contexts but
5
+ * both end up with the same buffered NDJSON string to save.
6
+ */
7
+ var triggerLogsDownload = (ndjson) => {
8
+ const blob = new Blob([ndjson], { type: "application/x-ndjson" });
9
+ const url = URL.createObjectURL(blob);
10
+ const anchor = document.createElement("a");
11
+ anchor.href = url;
12
+ anchor.download = `storybook-logs-${(/* @__PURE__ */ new Date()).toISOString().slice(0, 19).replace(/:/g, "-")}.ndjson`;
13
+ anchor.click();
14
+ URL.revokeObjectURL(url);
15
+ };
16
+ //#endregion
17
+ export { triggerLogsDownload as t };
18
+
19
+ //# sourceMappingURL=chunk-trigger-download.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"chunk-trigger-download.mjs","names":[],"sources":["../../src/trigger-download.ts"],"sourcesContent":["//\n// Copyright 2026 DXOS.org\n//\n\n/**\n * Downloads NDJSON log data as a file. Shared by the manager toolbar button (`manager.tsx`) and\n * the preview-side `downloadLogs` (`download.ts`), which run in different Storybook contexts but\n * both end up with the same buffered NDJSON string to save.\n */\nexport const triggerLogsDownload = (ndjson: string): void => {\n const blob = new Blob([ndjson], { type: 'application/x-ndjson' });\n const url = URL.createObjectURL(blob);\n const anchor = document.createElement('a');\n anchor.href = url;\n anchor.download = `storybook-logs-${new Date().toISOString().slice(0, 19).replace(/:/g, '-')}.ndjson`;\n anchor.click();\n URL.revokeObjectURL(url);\n};\n"],"mappings":";;;;;;AASA,IAAa,uBAAuB,WAAyB;CAC3D,MAAM,OAAO,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE,MAAM,uBAAuB,CAAC;CAChE,MAAM,MAAM,IAAI,gBAAgB,IAAI;CACpC,MAAM,SAAS,SAAS,cAAc,GAAG;CACzC,OAAO,OAAO;CACd,OAAO,WAAW,mCAAkB,IAAI,KAAK,EAAA,CAAE,YAAY,CAAC,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,QAAQ,MAAM,GAAG,EAAE;CAC7F,OAAO,MAAM;CACb,IAAI,gBAAgB,GAAG;AACzB"}
@@ -0,0 +1,21 @@
1
+ import { n as DOWNLOAD_EVENT, r as LOGS_DATA_EVENT } from "./chunk-constants.mjs";
2
+ import { t as triggerLogsDownload } from "./chunk-trigger-download.mjs";
3
+ import { addons } from "storybook/preview-api";
4
+ //#region src/download.ts
5
+ /**
6
+ * Requests the current story's buffered logs from `preview.tsx`'s `LogBuffer` and downloads them
7
+ * as NDJSON. Usable from any component rendered inside the preview iframe — e.g. an error-boundary
8
+ * fallback, so a crashed story still offers a one-click way to grab logs without reaching for the
9
+ * manager toolbar's "Download logs" button.
10
+ */
11
+ var downloadLogs = () => {
12
+ const channel = addons.getChannel();
13
+ channel.once(LOGS_DATA_EVENT, ({ ndjson }) => {
14
+ triggerLogsDownload(ndjson);
15
+ });
16
+ channel.emit(DOWNLOAD_EVENT);
17
+ };
18
+ //#endregion
19
+ export { downloadLogs };
20
+
21
+ //# sourceMappingURL=download.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"download.mjs","names":[],"sources":["../../src/download.ts"],"sourcesContent":["//\n// Copyright 2026 DXOS.org\n//\n\nimport { addons } from 'storybook/preview-api';\n\nimport { DOWNLOAD_EVENT, LOGS_DATA_EVENT } from './constants';\nimport { triggerLogsDownload } from './trigger-download';\n\n/**\n * Requests the current story's buffered logs from `preview.tsx`'s `LogBuffer` and downloads them\n * as NDJSON. Usable from any component rendered inside the preview iframe — e.g. an error-boundary\n * fallback, so a crashed story still offers a one-click way to grab logs without reaching for the\n * manager toolbar's \"Download logs\" button.\n */\nexport const downloadLogs = (): void => {\n const channel = addons.getChannel();\n channel.once(LOGS_DATA_EVENT, ({ ndjson }: { ndjson: string }) => {\n triggerLogsDownload(ndjson);\n });\n channel.emit(DOWNLOAD_EVENT);\n};\n"],"mappings":";;;;;;;;;;AAeA,IAAa,qBAA2B;CACtC,MAAM,UAAU,OAAO,WAAW;CAClC,QAAQ,KAAK,kBAAkB,EAAE,aAAiC;EAChE,oBAAoB,MAAM;CAC5B,CAAC;CACD,QAAQ,KAAK,cAAc;AAC7B"}
File without changes
@@ -0,0 +1,32 @@
1
+ import { i as TOOL_ID, n as DOWNLOAD_EVENT, r as LOGS_DATA_EVENT, t as ADDON_ID } from "./chunk-constants.mjs";
2
+ import { t as triggerLogsDownload } from "./chunk-trigger-download.mjs";
3
+ import { DownloadIcon } from "@storybook/icons";
4
+ import React, { useCallback } from "react";
5
+ import { Button } from "storybook/internal/components";
6
+ import { addons, types } from "storybook/manager-api";
7
+ //#region src/manager.tsx
8
+ var DownloadLogsButton = () => {
9
+ const channel = addons.getChannel();
10
+ const handleClick = useCallback(() => {
11
+ channel.once(LOGS_DATA_EVENT, ({ ndjson }) => {
12
+ triggerLogsDownload(ndjson);
13
+ });
14
+ channel.emit(DOWNLOAD_EVENT);
15
+ }, [channel]);
16
+ return /* @__PURE__ */ React.createElement(Button, {
17
+ variant: "ghost",
18
+ padding: "small",
19
+ ariaLabel: "Download logs",
20
+ onClick: handleClick
21
+ }, /* @__PURE__ */ React.createElement(DownloadIcon, null));
22
+ };
23
+ addons.register(ADDON_ID, () => {
24
+ addons.add(TOOL_ID, {
25
+ type: types.TOOL,
26
+ title: "Download logs",
27
+ render: () => /* @__PURE__ */ React.createElement(DownloadLogsButton, null)
28
+ });
29
+ });
30
+ //#endregion
31
+
32
+ //# sourceMappingURL=manager.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"manager.mjs","names":[],"sources":["../../src/manager.tsx"],"sourcesContent":["//\n// Copyright 2025 DXOS.org\n//\n\nimport { DownloadIcon } from '@storybook/icons';\nimport React, { useCallback } from 'react';\nimport { Button } from 'storybook/internal/components';\nimport { addons, types } from 'storybook/manager-api';\n\nimport { ADDON_ID, DOWNLOAD_EVENT, LOGS_DATA_EVENT, TOOL_ID } from './constants';\nimport { triggerLogsDownload } from './trigger-download';\n\nconst DownloadLogsButton = () => {\n const channel = addons.getChannel();\n\n const handleClick = useCallback(() => {\n channel.once(LOGS_DATA_EVENT, ({ ndjson }: { ndjson: string }) => {\n triggerLogsDownload(ndjson);\n });\n channel.emit(DOWNLOAD_EVENT);\n }, [channel]);\n\n return (\n <Button variant='ghost' padding='small' ariaLabel='Download logs' onClick={handleClick}>\n <DownloadIcon />\n </Button>\n );\n};\n\naddons.register(ADDON_ID, () => {\n addons.add(TOOL_ID, {\n type: types.TOOL,\n title: 'Download logs',\n render: () => <DownloadLogsButton />,\n });\n});\n"],"mappings":";;;;;;;AAYA,IAAM,2BAA2B;CAC/B,MAAM,UAAU,OAAO,WAAW;CAElC,MAAM,cAAc,kBAAkB;EACpC,QAAQ,KAAK,kBAAkB,EAAE,aAAiC;GAChE,oBAAoB,MAAM;EAC5B,CAAC;EACD,QAAQ,KAAK,cAAc;CAC7B,GAAG,CAAC,OAAO,CAAC;CAEZ,OACE,sBAAA,cAAC,QAAD;EAAQ,SAAQ;EAAQ,SAAQ;EAAQ,WAAU;EAAgB,SAAS;CAEnE,GADN,sBAAA,cAAC,cAAA,IAAc,CACT;AAEZ;AAEA,OAAO,SAAS,gBAAgB;CAC9B,OAAO,IAAI,SAAS;EAClB,MAAM,MAAM;EACZ,OAAO;EACP,cAAc,sBAAA,cAAC,oBAAA,IAAoB;CACrC,CAAC;AACH,CAAC"}
@@ -0,0 +1,89 @@
1
+ import { n as DOWNLOAD_EVENT, r as LOGS_DATA_EVENT } from "./chunk-constants.mjs";
2
+ import React, { memo, useEffect } from "react";
3
+ import { STORY_CHANGED } from "storybook/internal/core-events";
4
+ import { addons } from "storybook/preview-api";
5
+ import { LogBuffer, LogLevel, log } from "@dxos/log";
6
+ //#region src/preview.tsx
7
+ var __dxlog_file = "/__w/dxos/dxos/packages/common/storybook-addon-logger/src/preview.tsx";
8
+ /** Default DX log level for Storybook preview (matches toolbar item values). */
9
+ var DEFAULT_LOG_LEVEL = String(LogLevel.INFO);
10
+ var logBuffer = new LogBuffer();
11
+ log.addProcessor(logBuffer.logProcessor, void 0, {
12
+ "~LogMeta": "~LogMeta",
13
+ F: __dxlog_file,
14
+ L: 18,
15
+ S: void 0
16
+ });
17
+ log.config({ filter: Number(DEFAULT_LOG_LEVEL) }, void 0, {
18
+ "~LogMeta": "~LogMeta",
19
+ F: __dxlog_file,
20
+ L: 19,
21
+ S: void 0
22
+ });
23
+ var channel = addons.getChannel();
24
+ channel.on(DOWNLOAD_EVENT, () => {
25
+ channel.emit(LOGS_DATA_EVENT, { ndjson: logBuffer.serialize() });
26
+ });
27
+ channel.on(STORY_CHANGED, () => {
28
+ logBuffer.clear();
29
+ });
30
+ var preview = {
31
+ /**
32
+ * Global decorators.
33
+ * https://storybook.js.org/docs/writing-stories/decorators
34
+ */
35
+ decorators: [(Story, { globals: { logLevel } }) => {
36
+ const MemoizedStory = memo(Story);
37
+ useEffect(() => {
38
+ const parsed = Number(logLevel);
39
+ const level = Number.isFinite(parsed) ? parsed : Number(DEFAULT_LOG_LEVEL);
40
+ log.config({ filter: level }, void 0, {
41
+ "~LogMeta": "~LogMeta",
42
+ F: __dxlog_file,
43
+ L: 42,
44
+ S: void 0
45
+ });
46
+ }, [logLevel]);
47
+ return /* @__PURE__ */ React.createElement(MemoizedStory, null);
48
+ }],
49
+ /**
50
+ * These definitions add controls to the toolbar.
51
+ * https://storybook.js.org/docs/essentials/toolbars-and-globals
52
+ */
53
+ globalTypes: { logLevel: {
54
+ name: "Log level",
55
+ description: "DX logging level.",
56
+ defaultValue: DEFAULT_LOG_LEVEL,
57
+ toolbar: {
58
+ title: "Log level",
59
+ icon: "eye",
60
+ dynamicTitle: true,
61
+ items: [
62
+ {
63
+ value: String(LogLevel.TRACE),
64
+ title: "TRACE"
65
+ },
66
+ {
67
+ value: String(LogLevel.DEBUG),
68
+ title: "DEBUG"
69
+ },
70
+ {
71
+ value: String(LogLevel.INFO),
72
+ title: "INFO"
73
+ },
74
+ {
75
+ value: String(LogLevel.WARN),
76
+ title: "WARN"
77
+ },
78
+ {
79
+ value: String(LogLevel.ERROR),
80
+ title: "ERROR"
81
+ }
82
+ ]
83
+ }
84
+ } }
85
+ };
86
+ //#endregion
87
+ export { preview as default };
88
+
89
+ //# sourceMappingURL=preview.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"preview.mjs","names":[],"sources":["../../src/preview.tsx"],"sourcesContent":["//\n// Copyright 2025 DXOS.org\n//\n\nimport { type Preview } from '@storybook/react';\nimport React, { memo, useEffect } from 'react';\nimport { STORY_CHANGED } from 'storybook/internal/core-events';\nimport { addons } from 'storybook/preview-api';\n\nimport { LogBuffer, LogLevel, log } from '@dxos/log';\n\nimport { DOWNLOAD_EVENT, LOGS_DATA_EVENT } from './constants';\n\n/** Default DX log level for Storybook preview (matches toolbar item values). */\nconst DEFAULT_LOG_LEVEL = String(LogLevel.INFO);\n\nconst logBuffer = new LogBuffer();\nlog.addProcessor(logBuffer.logProcessor);\nlog.config({ filter: Number(DEFAULT_LOG_LEVEL) });\n\nconst channel = addons.getChannel();\nchannel.on(DOWNLOAD_EVENT, () => {\n channel.emit(LOGS_DATA_EVENT, { ndjson: logBuffer.serialize() });\n});\nchannel.on(STORY_CHANGED, () => {\n logBuffer.clear();\n});\n\n// TODO(burdon): Create separate addon for global types.\nconst preview: Preview = {\n /**\n * Global decorators.\n * https://storybook.js.org/docs/writing-stories/decorators\n */\n decorators: [\n (Story, { globals: { logLevel } }) => {\n // Prevent re-rendering of the story.\n const MemoizedStory = memo(Story);\n useEffect(() => {\n const parsed = Number(logLevel);\n const level = Number.isFinite(parsed) ? parsed : Number(DEFAULT_LOG_LEVEL);\n log.config({ filter: level });\n }, [logLevel]);\n\n return <MemoizedStory />;\n },\n ],\n\n /**\n * These definitions add controls to the toolbar.\n * https://storybook.js.org/docs/essentials/toolbars-and-globals\n */\n globalTypes: {\n logLevel: {\n name: 'Log level',\n description: 'DX logging level.',\n defaultValue: DEFAULT_LOG_LEVEL,\n toolbar: {\n title: 'Log level',\n icon: 'eye',\n dynamicTitle: true,\n items: [\n {\n value: String(LogLevel.TRACE),\n title: 'TRACE',\n },\n {\n value: String(LogLevel.DEBUG),\n title: 'DEBUG',\n },\n {\n value: String(LogLevel.INFO),\n title: 'INFO',\n },\n {\n value: String(LogLevel.WARN),\n title: 'WARN',\n },\n {\n value: String(LogLevel.ERROR),\n title: 'ERROR',\n },\n ],\n },\n },\n },\n};\n\nexport default preview;\n"],"mappings":";;;;;;;;AAcA,IAAM,oBAAoB,OAAO,SAAS,IAAI;AAE9C,IAAM,YAAY,IAAI,UAAU;AAChC,IAAI,aAAa,UAAU,cAAW,KAAA,GAAA;CAAA,YAAA;CAAA,GAAA;CAAA,GAAA;CAAA,GAAA,KAAA;AAAA,CAAC;AACvC,IAAI,OAAO,EAAE,QAAQ,OAAO,iBAAiB,EAAE,GAAA,KAAA,GAAA;CAAA,YAAA;CAAA,GAAA;CAAA,GAAA;CAAA,GAAA,KAAA;AAAA,CAAC;AAEhD,IAAM,UAAU,OAAO,WAAW;AAClC,QAAQ,GAAG,sBAAsB;CAC/B,QAAQ,KAAK,iBAAiB,EAAE,QAAQ,UAAU,UAAU,EAAE,CAAC;AACjE,CAAC;AACD,QAAQ,GAAG,qBAAqB;CAC9B,UAAU,MAAM;AAClB,CAAC;AAGD,IAAM,UAAmB;;;;;CAKvB,YAAY,EACT,OAAO,EAAE,SAAS,EAAE,iBAAiB;EAEpC,MAAM,gBAAgB,KAAK,KAAK;EAChC,gBAAgB;GACd,MAAM,SAAS,OAAO,QAAQ;GAC9B,MAAM,QAAQ,OAAO,SAAS,MAAM,IAAI,SAAS,OAAO,iBAAiB;GACzE,IAAI,OAAO,EAAE,QAAQ,MAAM,GAAA,KAAA,GAAA;IAAA,YAAA;IAAA,GAAA;IAAA,GAAA;IAAA,GAAA,KAAA;GAAA,CAAC;EAC9B,GAAG,CAAC,QAAQ,CAAC;EAEb,OAAO,sBAAA,cAAC,eAAA,IAAe;CACzB,CACF;;;;;CAMA,aAAa,EACX,UAAU;EACR,MAAM;EACN,aAAa;EACb,cAAc;EACd,SAAS;GACP,OAAO;GACP,MAAM;GACN,cAAc;GACd,OAAO;IACL;KACE,OAAO,OAAO,SAAS,KAAK;KAC5B,OAAO;IACT;IACA;KACE,OAAO,OAAO,SAAS,KAAK;KAC5B,OAAO;IACT;IACA;KACE,OAAO,OAAO,SAAS,IAAI;KAC3B,OAAO;IACT;IACA;KACE,OAAO,OAAO,SAAS,IAAI;KAC3B,OAAO;IACT;IACA;KACE,OAAO,OAAO,SAAS,KAAK;KAC5B,OAAO;IACT;GACF;EACF;CACF,EACF;AACF"}
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Requests the current story's buffered logs from `preview.tsx`'s `LogBuffer` and downloads them
3
+ * as NDJSON. Usable from any component rendered inside the preview iframe — e.g. an error-boundary
4
+ * fallback, so a crashed story still offers a one-click way to grab logs without reaching for the
5
+ * manager toolbar's "Download logs" button.
6
+ */
7
+ export declare const downloadLogs: () => void;
8
+ //# sourceMappingURL=download.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"download.d.ts","sourceRoot":"","sources":["../../../src/download.ts"],"names":[],"mappings":"AASA;;;;;GAKG;AACH,eAAO,MAAM,YAAY,QAAO,IAM/B,CAAC"}
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Downloads NDJSON log data as a file. Shared by the manager toolbar button (`manager.tsx`) and
3
+ * the preview-side `downloadLogs` (`download.ts`), which run in different Storybook contexts but
4
+ * both end up with the same buffered NDJSON string to save.
5
+ */
6
+ export declare const triggerLogsDownload: (ndjson: string) => void;
7
+ //# sourceMappingURL=trigger-download.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"trigger-download.d.ts","sourceRoot":"","sources":["../../../src/trigger-download.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,WAAY,MAAM,KAAG,IAQpD,CAAC"}