@storybook/html 6.5.9 → 7.0.0-alpha.2

package/README.md

@@ -1,25 +1 @@
-# Storybook for HTML
-
----
-
-Storybook for HTML is a UI development environment for your plain HTML snippets.
-With it, you can visualize different states of your UI components and develop them interactively.
-
-![Storybook Screenshot](https://github.com/storybookjs/storybook/blob/main/media/storybook-intro.gif)
-
-Storybook runs outside of your app.
-So you can develop UI components in isolation without worrying about app specific dependencies and requirements.
-
-## Getting Started
-
-```sh
-cd my-app
-npx sb init -t html
-```
-
-For more information visit: [storybook.js.org](https://storybook.js.org)
-
----
-
-Storybook also comes with a lot of [addons](https://storybook.js.org/addons) and a great API to customize as you wish.
-You can also build a [static version](https://storybook.js.org/docs/html/sharing/publish-storybook) of your Storybook and deploy it anywhere you want.
+# Storybook HTML Renderer

package/dist/cjs/config.js

@@ -0,0 +1,36 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  parameters: true,
+  decorators: true
+};
+Object.defineProperty(exports, "decorators", {
+  enumerable: true,
+  get: function () {
+    return _config.decorators;
+  }
+});
+exports.parameters = void 0;
+
+var _config = require("./docs/config");
+
+var _config2 = require("./preview/config");
+
+Object.keys(_config2).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _config2[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _config2[key];
+    }
+  });
+});
+const parameters = Object.assign({
+  framework: 'html'
+}, _config.parameters);
+exports.parameters = parameters;

package/dist/cjs/{client/docs → docs}/config.js

@@ -9,14 +9,11 @@ var _docsTools = require("@storybook/docs-tools");
 
 var _sourceDecorator = require("./sourceDecorator");
 
-var _prepareForInline = require("./prepareForInline");
-
-var decorators = [_sourceDecorator.sourceDecorator];
+const decorators = [_sourceDecorator.sourceDecorator];
 exports.decorators = decorators;
-var parameters = {
+const parameters = {
   docs: {
     inlineStories: true,
-    prepareForInline: _prepareForInline.prepareForInline,
     source: {
       type: _docsTools.SourceType.DYNAMIC,
       language: 'html'

package/dist/cjs/{client/docs → docs}/sourceDecorator.js

@@ -13,12 +13,14 @@ var _tsDedent = _interopRequireDefault(require("ts-dedent"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+/* eslint-disable no-underscore-dangle */
+
 /* global window */
 function skipSourceRender(context) {
   var _context$parameters$d;
 
-  var sourceParams = context === null || context === void 0 ? void 0 : (_context$parameters$d = context.parameters.docs) === null || _context$parameters$d === void 0 ? void 0 : _context$parameters$d.source;
-  var isArgsStory = context === null || context === void 0 ? void 0 : context.parameters.__isArgsStory; // always render if the user forces it
+  const sourceParams = context === null || context === void 0 ? void 0 : (_context$parameters$d = context.parameters.docs) === null || _context$parameters$d === void 0 ? void 0 : _context$parameters$d.source;
+  const isArgsStory = context === null || context === void 0 ? void 0 : context.parameters.__isArgsStory; // always render if the user forces it
 
   if ((sourceParams === null || sourceParams === void 0 ? void 0 : sourceParams.type) === _docsTools.SourceType.DYNAMIC) {
     return false;
@@ -36,31 +38,28 @@ function defaultTransformSource(source) {
 }
 
 function applyTransformSource(source, context) {
-  var _context$parameters$d2, _docs$transformSource;
-
-  var docs = (_context$parameters$d2 = context.parameters.docs) !== null && _context$parameters$d2 !== void 0 ? _context$parameters$d2 : {};
-  var transformSource = (_docs$transformSource = docs.transformSource) !== null && _docs$transformSource !== void 0 ? _docs$transformSource : defaultTransformSource;
+  const docs = context.parameters.docs ?? {};
+  const transformSource = docs.transformSource ?? defaultTransformSource;
   return transformSource(source, context);
 }
 
 function sourceDecorator(storyFn, context) {
-  var _context$parameters$d3, _context$parameters$d4;
+  var _context$parameters$d2, _context$parameters$d3;
 
-  var story = context !== null && context !== void 0 && (_context$parameters$d3 = context.parameters.docs) !== null && _context$parameters$d3 !== void 0 && (_context$parameters$d4 = _context$parameters$d3.source) !== null && _context$parameters$d4 !== void 0 && _context$parameters$d4.excludeDecorators ? context.originalStoryFn(context.args, context) : storyFn();
-  var source;
+  const story = context !== null && context !== void 0 && (_context$parameters$d2 = context.parameters.docs) !== null && _context$parameters$d2 !== void 0 && (_context$parameters$d3 = _context$parameters$d2.source) !== null && _context$parameters$d3 !== void 0 && _context$parameters$d3.excludeDecorators ? context.originalStoryFn(context.args, context) : storyFn();
+  let source;
 
   if (!skipSourceRender(context)) {
     if (typeof story === 'string') {
       source = story;
-    } // eslint-disable-next-line no-undef
-    else if (story instanceof Element) {
+    } else if (story instanceof Element) {
       source = story.outerHTML;
     }
 
     if (source) source = applyTransformSource(source, context);
   }
 
-  (0, _addons.useEffect)(function () {
+  (0, _addons.useEffect)(() => {
     if (source) _addons.addons.getChannel().emit(_docsTools.SNIPPET_RENDERED, context.id, source);
   });
   return story;

package/dist/cjs/{client/index.js → index.js}

@@ -1,11 +1,5 @@
 "use strict";
 
-require("core-js/modules/es.object.to-string.js");
-
-require("core-js/modules/web.dom-collections.for-each.js");
-
-require("core-js/modules/es.object.keys.js");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -21,49 +15,49 @@ var _exportNames = {
 };
 Object.defineProperty(exports, "addDecorator", {
   enumerable: true,
-  get: function get() {
+  get: function () {
     return _preview.addDecorator;
   }
 });
 Object.defineProperty(exports, "addParameters", {
   enumerable: true,
-  get: function get() {
+  get: function () {
     return _preview.addParameters;
   }
 });
 Object.defineProperty(exports, "configure", {
   enumerable: true,
-  get: function get() {
+  get: function () {
     return _preview.configure;
   }
 });
 Object.defineProperty(exports, "forceReRender", {
   enumerable: true,
-  get: function get() {
+  get: function () {
     return _preview.forceReRender;
   }
 });
 Object.defineProperty(exports, "getStorybook", {
   enumerable: true,
-  get: function get() {
+  get: function () {
     return _preview.getStorybook;
   }
 });
 Object.defineProperty(exports, "raw", {
   enumerable: true,
-  get: function get() {
+  get: function () {
     return _preview.raw;
   }
 });
 Object.defineProperty(exports, "setAddon", {
   enumerable: true,
-  get: function get() {
+  get: function () {
     return _preview.setAddon;
   }
 });
 Object.defineProperty(exports, "storiesOf", {
   enumerable: true,
-  get: function get() {
+  get: function () {
     return _preview.storiesOf;
   }
 });
@@ -78,12 +72,13 @@ Object.keys(_types).forEach(function (key) {
   if (key in exports && exports[key] === _types[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
-    get: function get() {
+    get: function () {
       return _types[key];
     }
   });
 });
 
-if (module && module.hot && module.hot.decline) {
-  module.hot.decline();
-}
+var _module, _module$hot;
+
+// optimization: stop HMR propagation in webpack
+(_module = module) === null || _module === void 0 ? void 0 : (_module$hot = _module.hot) === null || _module$hot === void 0 ? void 0 : _module$hot.decline();

package/dist/cjs/{client/preview → preview}/config.js

@@ -3,17 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.parameters = void 0;
 Object.defineProperty(exports, "renderToDOM", {
   enumerable: true,
-  get: function get() {
+  get: function () {
     return _render.renderToDOM;
   }
 });
 
-var _render = require("./render");
-
-var parameters = {
-  framework: 'html'
-};
-exports.parameters = parameters;
+var _render = require("./render");

package/dist/cjs/{client/preview → preview}/globals.js

@@ -4,5 +4,7 @@ var _global = _interopRequireDefault(require("global"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-var globalWindow = _global.default.window;
+const {
+  window: globalWindow
+} = _global.default;
 globalWindow.STORYBOOK_ENV = 'HTML';

package/dist/cjs/preview/index.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.storiesOf = exports.setAddon = exports.raw = exports.getStorybook = exports.forceReRender = exports.configure = exports.clearDecorators = exports.addParameters = exports.addDecorator = void 0;
+
+var _coreClient = require("@storybook/core-client");
+
+require("./globals");
+
+var _render = require("./render");
+
+/* eslint-disable prefer-destructuring */
+const framework = 'html';
+const api = (0, _coreClient.start)(_render.renderToDOM);
+
+const storiesOf = (kind, m) => {
+  return api.clientApi.storiesOf(kind, m).addParameters({
+    framework
+  });
+};
+
+exports.storiesOf = storiesOf;
+
+const configure = (...args) => api.configure(framework, ...args);
+
+exports.configure = configure;
+const addDecorator = api.clientApi.addDecorator;
+exports.addDecorator = addDecorator;
+const addParameters = api.clientApi.addParameters;
+exports.addParameters = addParameters;
+const clearDecorators = api.clientApi.clearDecorators;
+exports.clearDecorators = clearDecorators;
+const setAddon = api.clientApi.setAddon;
+exports.setAddon = setAddon;
+const forceReRender = api.forceReRender;
+exports.forceReRender = forceReRender;
+const getStorybook = api.clientApi.getStorybook;
+exports.getStorybook = getStorybook;
+const raw = api.clientApi.raw;
+exports.raw = raw;

package/dist/cjs/preview/render.js

@@ -0,0 +1,52 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.renderToDOM = renderToDOM;
+
+var _global = _interopRequireDefault(require("global"));
+
+var _tsDedent = _interopRequireDefault(require("ts-dedent"));
+
+var _previewWeb = require("@storybook/preview-web");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/* eslint-disable no-param-reassign */
+const {
+  Node
+} = _global.default;
+
+function renderToDOM({
+  storyFn,
+  kind,
+  name,
+  showMain,
+  showError,
+  forceRemount
+}, domElement) {
+  const element = storyFn();
+  showMain();
+
+  if (typeof element === 'string') {
+    domElement.innerHTML = element;
+    (0, _previewWeb.simulatePageLoad)(domElement);
+  } else if (element instanceof Node) {
+    if (domElement.firstChild === element && forceRemount === false) {
+      return;
+    }
+
+    domElement.innerHTML = '';
+    domElement.appendChild(element);
+    (0, _previewWeb.simulateDOMContentLoaded)();
+  } else {
+    showError({
+      title: `Expecting an HTML snippet or DOM node from the story: "${name}" of "${kind}".`,
+      description: (0, _tsDedent.default)`
+        Did you forget to return the HTML snippet from the story?
+        Use "() => <your snippet or node>" or when defining the story.
+      `
+    });
+  }
+}

package/dist/esm/config.js

@@ -0,0 +1,6 @@
+import { parameters as docsParams } from './docs/config';
+export const parameters = Object.assign({
+  framework: 'html'
+}, docsParams);
+export { decorators } from './docs/config';
+export * from './preview/config';

package/dist/{modern/client → esm}/docs/config.js

@@ -1,11 +1,9 @@
 import { SourceType } from '@storybook/docs-tools';
 import { sourceDecorator } from './sourceDecorator';
-import { prepareForInline } from './prepareForInline';
 export const decorators = [sourceDecorator];
 export const parameters = {
   docs: {
     inlineStories: true,
-    prepareForInline,
     source: {
       type: SourceType.DYNAMIC,
       language: 'html'

package/dist/esm/docs/sourceDecorator.js

@@ -0,0 +1,51 @@
+/* eslint-disable no-underscore-dangle */
+
+/* global window */
+import { SNIPPET_RENDERED, SourceType } from '@storybook/docs-tools';
+import { addons, useEffect } from '@storybook/addons';
+import dedent from 'ts-dedent';
+
+function skipSourceRender(context) {
+  const sourceParams = context?.parameters.docs?.source;
+  const isArgsStory = context?.parameters.__isArgsStory; // always render if the user forces it
+
+  if (sourceParams?.type === SourceType.DYNAMIC) {
+    return false;
+  } // never render if the user is forcing the block to render code, or
+  // if the user provides code, or if it's not an args story.
+
+
+  return !isArgsStory || sourceParams?.code || sourceParams?.type === SourceType.CODE;
+} // By default, just remove indentation
+
+
+function defaultTransformSource(source) {
+  // Have to wrap dedent so it doesn't serialize the context
+  return dedent(source);
+}
+
+function applyTransformSource(source, context) {
+  const docs = context.parameters.docs ?? {};
+  const transformSource = docs.transformSource ?? defaultTransformSource;
+  return transformSource(source, context);
+}
+
+export function sourceDecorator(storyFn, context) {
+  const story = context?.parameters.docs?.source?.excludeDecorators ? context.originalStoryFn(context.args, context) : storyFn();
+  let source;
+
+  if (!skipSourceRender(context)) {
+    if (typeof story === 'string') {
+      source = story;
+    } else if (story instanceof Element) {
+      source = story.outerHTML;
+    }
+
+    if (source) source = applyTransformSource(source, context);
+  }
+
+  useEffect(() => {
+    if (source) addons.getChannel().emit(SNIPPET_RENDERED, context.id, source);
+  });
+  return story;
+}

package/dist/{modern/client → esm}/index.js

@@ -1,6 +1,4 @@
 export { storiesOf, setAddon, addDecorator, addParameters, configure, getStorybook, forceReRender, raw } from './preview';
-export * from './preview/types-6-0';
+export * from './preview/types-6-0'; // optimization: stop HMR propagation in webpack
 
-if (module && module.hot && module.hot.decline) {
-  module.hot.decline();
-}
+module?.hot?.decline();

package/dist/esm/preview/config.js

@@ -0,0 +1 @@
+export { renderToDOM } from './render';

package/dist/{modern/client → esm}/preview/index.js

@@ -1,5 +1,5 @@
 /* eslint-disable prefer-destructuring */
-import { start } from '@storybook/core';
+import { start } from '@storybook/core-client';
 import './globals';
 import { renderToDOM } from './render';
 const framework = 'html';

package/dist/types/config.d.ts

@@ -0,0 +1,12 @@
+export declare const parameters: {
+    docs: {
+        inlineStories: boolean;
+        source: {
+            type: import("lib/docs-tools/dist/types").SourceType;
+            language: string;
+        };
+    };
+    framework: string;
+};
+export { decorators } from './docs/config';
+export * from './preview/config';

package/dist/{ts3.9/client → types}/docs/config.d.ts

@@ -1,11 +1,9 @@
 import { SourceType } from '@storybook/docs-tools';
 import { sourceDecorator } from './sourceDecorator';
-import { prepareForInline } from './prepareForInline';
 export declare const decorators: (typeof sourceDecorator)[];
 export declare const parameters: {
     docs: {
         inlineStories: boolean;
-        prepareForInline: typeof prepareForInline;
         source: {
             type: SourceType;
             language: string;

package/dist/{ts3.9/client → types}/docs/sourceDecorator.d.ts

@@ -1,3 +1,3 @@
 import type { PartialStoryFn, StoryContext } from '@storybook/csf';
 import type { HtmlFramework } from '..';
-export declare function sourceDecorator(storyFn: PartialStoryFn<HtmlFramework>, context: StoryContext<HtmlFramework>): string | Node;
+export declare function sourceDecorator(storyFn: PartialStoryFn<HtmlFramework>, context: StoryContext<HtmlFramework>): import("../preview/types").StoryFnHtmlReturnType;

package/dist/types/preview/config.d.ts

@@ -0,0 +1 @@
+export { renderToDOM } from './render';

package/dist/{ts3.9/client → types}/preview/types.d.ts

@@ -1,4 +1,4 @@
-export type { RenderContext } from '@storybook/core';
+export type { RenderContext } from '@storybook/core-client';
 export declare type StoryFnHtmlReturnType = string | Node;
 export interface IStorybookStory {
     name: string;

package/package.json

@@ -1,41 +1,28 @@
 {
   "name": "@storybook/html",
-  "version": "6.5.9",
-  "description": "Storybook for HTML: View HTML snippets in isolation with Hot Reloading.",
+  "version": "7.0.0-alpha.2",
+  "description": "Storybook HTML renderer",
   "keywords": [
     "storybook"
   ],
-  "homepage": "https://github.com/storybookjs/storybook/tree/main/app/html",
+  "homepage": "https://github.com/storybookjs/storybook/tree/main/renderers/html",
   "bugs": {
     "url": "https://github.com/storybookjs/storybook/issues"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/storybookjs/storybook.git",
-    "directory": "app/html"
+    "directory": "renderers/html"
   },
   "funding": {
     "type": "opencollective",
     "url": "https://opencollective.com/storybook"
   },
   "license": "MIT",
-  "main": "dist/cjs/client/index.js",
-  "module": "dist/esm/client/index.js",
-  "types": "dist/ts3.9/client/index.d.ts",
-  "typesVersions": {
-    "<3.8": {
-      "dist/ts3.9/*": [
-        "dist/ts3.4/*"
-      ]
-    }
-  },
-  "bin": {
-    "build-storybook": "./bin/build.js",
-    "start-storybook": "./bin/index.js",
-    "storybook-server": "./bin/index.js"
-  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
   "files": [
-    "bin/**/*",
     "dist/**/*",
     "README.md",
     "*.js",
@@ -45,27 +32,18 @@
     "prepare": "node ../../scripts/prepare.js"
   },
   "dependencies": {
-    "@storybook/addons": "6.5.9",
-    "@storybook/core": "6.5.9",
-    "@storybook/core-common": "6.5.9",
+    "@storybook/addons": "7.0.0-alpha.2",
+    "@storybook/core-client": "7.0.0-alpha.2",
     "@storybook/csf": "0.0.2--canary.4566f4d.1",
-    "@storybook/docs-tools": "6.5.9",
-    "@storybook/preview-web": "6.5.9",
-    "@storybook/store": "6.5.9",
-    "@types/node": "^14.14.20 || ^16.0.0",
-    "@types/webpack-env": "^1.16.0",
+    "@storybook/docs-tools": "7.0.0-alpha.2",
+    "@storybook/preview-web": "7.0.0-alpha.2",
+    "@storybook/store": "7.0.0-alpha.2",
     "core-js": "^3.8.2",
     "global": "^4.4.0",
-    "html-loader": "^1.3.2",
     "react": "16.14.0",
     "react-dom": "16.14.0",
-    "read-pkg-up": "^7.0.1",
     "regenerator-runtime": "^0.13.7",
-    "ts-dedent": "^2.0.0",
-    "webpack": ">=4.0.0 <6.0.0"
-  },
-  "devDependencies": {
-    "webpack": "4"
+    "ts-dedent": "^2.0.0"
   },
   "peerDependencies": {
     "@babel/core": "*"
@@ -76,6 +54,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e2673f765722cbb542ef1b5cf8d533c8e746a127",
-  "sbmodern": "dist/modern/client/index.js"
+  "gitHead": "44920e2b6bd51981bac5124743c29fb9f5517e44"
 }

package/preview.js

@@ -0,0 +1 @@
+export * from './dist/esm/config';

package/bin/build.js

@@ -1,4 +0,0 @@
-#!/usr/bin/env node
-
-process.env.NODE_ENV = process.env.NODE_ENV || 'production';
-require('../dist/cjs/server/build');

package/bin/index.js

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-require('../dist/cjs/server');

package/dist/cjs/client/docs/prepareForInline.js

@@ -1,29 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.prepareForInline = prepareForInline;
-
-var _react = _interopRequireDefault(require("react"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function prepareForInline(storyFn) {
-  var html = storyFn();
-
-  if (typeof html === 'string') {
-    // eslint-disable-next-line react/no-danger
-    return /*#__PURE__*/_react.default.createElement("div", {
-      dangerouslySetInnerHTML: {
-        __html: html
-      }
-    });
-  }
-
-  return /*#__PURE__*/_react.default.createElement("div", {
-    ref: function ref(node) {
-      return node ? node.appendChild(html) : null;
-    }
-  });
-}