@storybook/server 6.5.6 → 7.0.0-alpha.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.
- package/README.md +1 -317
- package/dist/cjs/{client/index.js → index.js} +4 -3
- package/dist/cjs/{client/preview → preview}/config.js +0 -0
- package/dist/cjs/{client/preview → preview}/globals.js +0 -0
- package/dist/cjs/{client/preview → preview}/index.js +2 -2
- package/dist/cjs/preview/render.js +210 -0
- package/dist/cjs/{client/preview → preview}/types.js +0 -0
- package/dist/esm/index.js +3 -0
- package/dist/{modern/client → esm}/preview/config.js +0 -0
- package/dist/{modern/client → esm}/preview/globals.js +0 -0
- package/dist/{modern/client → esm}/preview/index.js +1 -1
- package/dist/{modern/client → esm}/preview/render.js +0 -0
- package/dist/esm/{client/preview → preview}/types.js +0 -0
- package/dist/{ts3.9/client → types}/index.d.ts +0 -0
- package/dist/{ts3.9/client → types}/preview/config.d.ts +0 -0
- package/dist/{ts3.9/client → types}/preview/globals.d.ts +0 -0
- package/dist/{ts3.9/client → types}/preview/index.d.ts +1 -2
- package/dist/{ts3.9/client → types}/preview/render.d.ts +0 -0
- package/dist/{ts3.9/client → types}/preview/types.d.ts +1 -1
- package/package.json +13 -40
- package/preview.js +1 -0
- package/bin/build.js +0 -4
- package/bin/index.js +0 -3
- package/dist/cjs/client/preview/render.js +0 -192
- package/dist/cjs/lib/compiler/index.js +0 -21
- package/dist/cjs/lib/compiler/stringifier.js +0 -175
- package/dist/cjs/lib/compiler/types.js +0 -1
- package/dist/cjs/server/build.js +0 -9
- package/dist/cjs/server/framework-preset-server.js +0 -33
- package/dist/cjs/server/index.js +0 -9
- package/dist/cjs/server/loader.js +0 -14
- package/dist/cjs/server/options.js +0 -17
- package/dist/esm/client/index.js +0 -5
- package/dist/esm/client/preview/config.js +0 -4
- package/dist/esm/client/preview/globals.js +0 -3
- package/dist/esm/client/preview/index.js +0 -30
- package/dist/esm/client/preview/render.js +0 -161
- package/dist/esm/lib/compiler/index.js +0 -13
- package/dist/esm/lib/compiler/stringifier.js +0 -137
- package/dist/esm/lib/compiler/types.js +0 -0
- package/dist/esm/server/build.js +0 -3
- package/dist/esm/server/framework-preset-server.js +0 -18
- package/dist/esm/server/index.js +0 -3
- package/dist/esm/server/loader.js +0 -4
- package/dist/esm/server/options.js +0 -8
- package/dist/modern/client/index.js +0 -5
- package/dist/modern/client/preview/types.js +0 -1
- package/dist/modern/lib/compiler/index.js +0 -12
- package/dist/modern/lib/compiler/stringifier.js +0 -83
- package/dist/modern/lib/compiler/types.js +0 -0
- package/dist/modern/server/build.js +0 -3
- package/dist/modern/server/framework-preset-server.js +0 -18
- package/dist/modern/server/index.js +0 -3
- package/dist/modern/server/loader.js +0 -4
- package/dist/modern/server/options.js +0 -8
- package/dist/ts3.4/client/index.d.ts +0 -1
- package/dist/ts3.4/client/preview/config.d.ts +0 -4
- package/dist/ts3.4/client/preview/globals.d.ts +0 -1
- package/dist/ts3.4/client/preview/index.d.ts +0 -21
- package/dist/ts3.4/client/preview/render.d.ts +0 -5
- package/dist/ts3.4/client/preview/types.d.ts +0 -20
- package/dist/ts3.4/lib/compiler/index.d.ts +0 -2
- package/dist/ts3.4/lib/compiler/stringifier.d.ts +0 -7
- package/dist/ts3.4/lib/compiler/types.d.ts +0 -24
- package/dist/ts3.4/server/build.d.ts +0 -1
- package/dist/ts3.4/server/framework-preset-server.d.ts +0 -4
- package/dist/ts3.4/server/index.d.ts +0 -1
- package/dist/ts3.4/server/loader.d.ts +0 -2
- package/dist/ts3.4/server/options.d.ts +0 -3
- package/dist/ts3.9/lib/compiler/index.d.ts +0 -2
- package/dist/ts3.9/lib/compiler/stringifier.d.ts +0 -7
- package/dist/ts3.9/lib/compiler/types.d.ts +0 -24
- package/dist/ts3.9/server/build.d.ts +0 -1
- package/dist/ts3.9/server/framework-preset-server.d.ts +0 -4
- package/dist/ts3.9/server/index.d.ts +0 -1
- package/dist/ts3.9/server/loader.d.ts +0 -2
- package/dist/ts3.9/server/options.d.ts +0 -3
- package/preset.js +0 -1
- package/standalone.js +0 -8
package/README.md
CHANGED
|
@@ -1,317 +1 @@
|
|
|
1
|
-
# Storybook
|
|
2
|
-
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
Storybook for Server is a UI development environment for your plain HTML snippets rendered by your server backend.
|
|
6
|
-
With it, you can visualize different states of your UI components and develop them interactively.
|
|
7
|
-
|
|
8
|
-

|
|
9
|
-
|
|
10
|
-
Storybook runs outside of your app.
|
|
11
|
-
So you can develop UI components in isolation without worrying about app specific dependencies and requirements.
|
|
12
|
-
|
|
13
|
-
## Getting Started
|
|
14
|
-
|
|
15
|
-
```sh
|
|
16
|
-
cd my-app
|
|
17
|
-
npx sb init -t server
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
To configure the server that Storybook will connect to, export a global parameter `parameters.server.url` in `.storybook/preview.js`:
|
|
21
|
-
|
|
22
|
-
```js
|
|
23
|
-
export const parameters = {
|
|
24
|
-
server: {
|
|
25
|
-
url: `http://localhost:${port}/storybook_preview`,
|
|
26
|
-
},
|
|
27
|
-
};
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
The URL you connect to should have the ability to render a story, see [server rendering](#server-rendering) below.
|
|
31
|
-
|
|
32
|
-
For more information visit: [storybook.js.org](https://storybook.js.org)
|
|
33
|
-
|
|
34
|
-
## Writing Stories
|
|
35
|
-
|
|
36
|
-
To write a story, use whatever API is natural for your server-side rendering framework to generate set of JSON or YAML files of stories analogous to CSF files (see the [`server-kitchen-sink`](../../examples/server-kitchen-sink/stories) example for ideas).
|
|
37
|
-
|
|
38
|
-
```json
|
|
39
|
-
{
|
|
40
|
-
"title": "Component",
|
|
41
|
-
"parameters": {
|
|
42
|
-
"options": { "component": "my_widget" }
|
|
43
|
-
},
|
|
44
|
-
"stories": [
|
|
45
|
-
{
|
|
46
|
-
"name": "Default",
|
|
47
|
-
"parameters": {
|
|
48
|
-
"server": { "id": "path/of/your/story" }
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
]
|
|
52
|
-
}
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
In your `.storybook/main.js` you simply provide a glob specifying the location of those JSON files, e.g.
|
|
56
|
-
|
|
57
|
-
```js
|
|
58
|
-
module.exports = {
|
|
59
|
-
stories: ['../stories/**/*.stories.json'],
|
|
60
|
-
};
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
Notice that the JSON does not specify a rendering function -- `@storybook/server` will instead call your `parameters.server.url` with the story's server id appended.
|
|
64
|
-
|
|
65
|
-
For example the JSON story above is requivalent to the CSF3 definition:
|
|
66
|
-
|
|
67
|
-
```javascript
|
|
68
|
-
export default {
|
|
69
|
-
title: 'Component',
|
|
70
|
-
parameters: {
|
|
71
|
-
options: {
|
|
72
|
-
component: 'my_widget',
|
|
73
|
-
},
|
|
74
|
-
},
|
|
75
|
-
};
|
|
76
|
-
|
|
77
|
-
export const Default = {
|
|
78
|
-
name: 'Default',
|
|
79
|
-
parameters: {
|
|
80
|
-
server: {
|
|
81
|
-
id: 'path/of/your/story"',
|
|
82
|
-
},
|
|
83
|
-
},
|
|
84
|
-
};
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
With the story HTML will be fetched from the server by making a GET request to http://localhost/storybook_preview/path/of/your/story`
|
|
88
|
-
|
|
89
|
-
### Ruby/Rails support
|
|
90
|
-
|
|
91
|
-
In particular the [View Component::Storybook](https://github.com/jonspalmer/view_component_storybook) gem provides a Ruby API for easily creating the above with a Ruby/Rails DSL (as well as providing a server rendering endpoint).
|
|
92
|
-
|
|
93
|
-
## Server rendering
|
|
94
|
-
|
|
95
|
-
The server rendering side of things is relatively straightfoward. When you browse to a story in the sidebar, Storybook will make a `fetch` request to `${parameters.server.url}/{parameters.server.id}` and display the HTML that is returned.
|
|
96
|
-
|
|
97
|
-
You need to ensure the route in your server app renders the appropriate HTML when called in that fashion.
|
|
98
|
-
|
|
99
|
-
### Passing parameters to the server
|
|
100
|
-
|
|
101
|
-
Many components are likely to be dynamic - responding to parameters that change their content or appearance. `@storybook\server` has two mechanisms for passing those parameters to the server - `params` and `args`. Parameters defined in this way are appended to the fetch url as query string parameters. The server endpoint is responsible for interpreting those parameters and vary the returned html appropriately
|
|
102
|
-
|
|
103
|
-
#### Constant parameters with `params`
|
|
104
|
-
|
|
105
|
-
Static parameters can be defined using the `params` story parameter. For example suppose you have a Button component that has a label and color options:
|
|
106
|
-
|
|
107
|
-
```json
|
|
108
|
-
{
|
|
109
|
-
"title": "Buttons",
|
|
110
|
-
"stories": [
|
|
111
|
-
{
|
|
112
|
-
"name": "Red",
|
|
113
|
-
"parameters": {
|
|
114
|
-
"server": {
|
|
115
|
-
"id": "button",
|
|
116
|
-
"params": { "color": "red", "label": "Stop" }
|
|
117
|
-
}
|
|
118
|
-
}
|
|
119
|
-
},
|
|
120
|
-
{
|
|
121
|
-
"name": "Green",
|
|
122
|
-
"parameters": {
|
|
123
|
-
"server": {
|
|
124
|
-
"id": "button",
|
|
125
|
-
"params": { "color": "green", "label": "OK" }
|
|
126
|
-
}
|
|
127
|
-
}
|
|
128
|
-
}
|
|
129
|
-
]
|
|
130
|
-
}
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
The Red and Green story HTML will be fetched from the urls `server.url/controls/button?color=red&label=Stop` and `server.url/controls/button?color=green&label=OK`
|
|
134
|
-
|
|
135
|
-
Like all story parameters server params can be defined in the default export and overridden in stories.
|
|
136
|
-
|
|
137
|
-
```json
|
|
138
|
-
{
|
|
139
|
-
"title": "Buttons",
|
|
140
|
-
"parameters": {
|
|
141
|
-
"server": {
|
|
142
|
-
"params": { "color": "red" }
|
|
143
|
-
}
|
|
144
|
-
},
|
|
145
|
-
"stories": [
|
|
146
|
-
{
|
|
147
|
-
"name": "Default",
|
|
148
|
-
"parameters": {
|
|
149
|
-
"server": {
|
|
150
|
-
"id": "button",
|
|
151
|
-
"params": { "label": "Stop" }
|
|
152
|
-
}
|
|
153
|
-
}
|
|
154
|
-
},
|
|
155
|
-
{
|
|
156
|
-
"name": "Green",
|
|
157
|
-
"parameters": {
|
|
158
|
-
"server": {
|
|
159
|
-
"id": "button",
|
|
160
|
-
"params": { "color": "green", "label": "OK" }
|
|
161
|
-
}
|
|
162
|
-
}
|
|
163
|
-
}
|
|
164
|
-
]
|
|
165
|
-
}
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
#### Dynamic parameters with `args` and Controls
|
|
169
|
-
|
|
170
|
-
Dynamic parameters can be defined using args and the Controls addon
|
|
171
|
-
|
|
172
|
-
```json
|
|
173
|
-
{
|
|
174
|
-
"title": "Buttons",
|
|
175
|
-
"stories": [
|
|
176
|
-
{
|
|
177
|
-
"name": "Red",
|
|
178
|
-
"parameters": {
|
|
179
|
-
"server": {
|
|
180
|
-
"id": "button"
|
|
181
|
-
}
|
|
182
|
-
},
|
|
183
|
-
"args": { "color": "red", "label": "Stop" }
|
|
184
|
-
},
|
|
185
|
-
{
|
|
186
|
-
"name": "Green",
|
|
187
|
-
"parameters": {
|
|
188
|
-
"server": {
|
|
189
|
-
"id": "button"
|
|
190
|
-
}
|
|
191
|
-
},
|
|
192
|
-
"args": { "color": "green", "label": "Go" }
|
|
193
|
-
}
|
|
194
|
-
]
|
|
195
|
-
}
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
Story args are passed to the server as url query parameters just like `params` except now they can be varied on the Controls addon panel.
|
|
199
|
-
|
|
200
|
-
Just like CSF stories we can define `argTypes` to specify the controls used in the controls panel. `argTypes` can be defined at the default or story level.
|
|
201
|
-
|
|
202
|
-
```json
|
|
203
|
-
{
|
|
204
|
-
"title": "Buttons",
|
|
205
|
-
"argTypes": {
|
|
206
|
-
"color": { "control": { "type": "color" } }
|
|
207
|
-
},
|
|
208
|
-
"stories": [
|
|
209
|
-
{
|
|
210
|
-
"name": "Red",
|
|
211
|
-
"parameters": {
|
|
212
|
-
"server": {
|
|
213
|
-
"id": "button"
|
|
214
|
-
}
|
|
215
|
-
},
|
|
216
|
-
"args": { "color": "red", "label": "Stop" }
|
|
217
|
-
},
|
|
218
|
-
{
|
|
219
|
-
"name": "Green",
|
|
220
|
-
"parameters": {
|
|
221
|
-
"server": {
|
|
222
|
-
"id": "button"
|
|
223
|
-
}
|
|
224
|
-
},
|
|
225
|
-
"args": { "color": "green", "label": "Go" }
|
|
226
|
-
}
|
|
227
|
-
]
|
|
228
|
-
}
|
|
229
|
-
```
|
|
230
|
-
|
|
231
|
-
## Addon compatibility
|
|
232
|
-
|
|
233
|
-
Storybook also comes with a lot of [addons](https://storybook.js.org/addons) and a great API to customize as you wish. As some addons assume the story is rendered in JS, they may not work with `@storybook/server` (yet!).
|
|
234
|
-
|
|
235
|
-
Many addons that act on the manager side (such as `backgrounds` and `viewport`) will work out of the box with `@storybook/server` -- you can configure them with parameters written on the server as usual.
|
|
236
|
-
|
|
237
|
-
### Controls
|
|
238
|
-
|
|
239
|
-
To configure controls, simple add `args` and `argTypes` keys to the story JSON much like you would CSF:
|
|
240
|
-
|
|
241
|
-
```json
|
|
242
|
-
{
|
|
243
|
-
"title": "Controls",
|
|
244
|
-
"stories": [
|
|
245
|
-
{
|
|
246
|
-
"name": "Button",
|
|
247
|
-
"parameters": {
|
|
248
|
-
"server": { "id": "controls/button" }
|
|
249
|
-
},
|
|
250
|
-
"args": { "button_text": "Push Me", "color": "red" },
|
|
251
|
-
"argTypes": { "button_text": { "control": { "type": "color" } } }
|
|
252
|
-
}
|
|
253
|
-
]
|
|
254
|
-
}
|
|
255
|
-
```
|
|
256
|
-
|
|
257
|
-
The controls values will be added to your story URL as query parameters.
|
|
258
|
-
|
|
259
|
-
### Actions
|
|
260
|
-
|
|
261
|
-
To use actions, use the `parameters.actions.handles` parameter:
|
|
262
|
-
|
|
263
|
-
```json
|
|
264
|
-
{
|
|
265
|
-
"title": "Actions",
|
|
266
|
-
"stories": [
|
|
267
|
-
{
|
|
268
|
-
"name": "Button",
|
|
269
|
-
"parameters": {
|
|
270
|
-
"server": { "id": "actions/button" },
|
|
271
|
-
"actions": {
|
|
272
|
-
"handles": ["mouseover", "click .btn"]
|
|
273
|
-
}
|
|
274
|
-
}
|
|
275
|
-
}
|
|
276
|
-
]
|
|
277
|
-
}
|
|
278
|
-
```
|
|
279
|
-
|
|
280
|
-
## Advanced Configuration
|
|
281
|
-
|
|
282
|
-
### fetchStoryHtml
|
|
283
|
-
|
|
284
|
-
For control over how `@storybook/server` fetches Html from the server you can provide a `fetchStoryHtml` function as a parameter. You would typically set this in `.storybook/preview.js` but it's just a regular Storybook parameter so could be overridden at the stories or story level.
|
|
285
|
-
|
|
286
|
-
```javascript
|
|
287
|
-
// .storybook/preview.js
|
|
288
|
-
|
|
289
|
-
const fetchStoryHtml = async (url, path, params, context) => {
|
|
290
|
-
// Custom fetch implementation
|
|
291
|
-
// ....
|
|
292
|
-
return html;
|
|
293
|
-
};
|
|
294
|
-
|
|
295
|
-
export const parameters = {
|
|
296
|
-
server: {
|
|
297
|
-
url: `http://localhost:${port}/storybook_preview`,
|
|
298
|
-
fetchStoryHtml,
|
|
299
|
-
},
|
|
300
|
-
};
|
|
301
|
-
```
|
|
302
|
-
|
|
303
|
-
`fetchStoryHtml` should be an async function with the following signature
|
|
304
|
-
|
|
305
|
-
```javascript
|
|
306
|
-
type FetchStoryHtmlType = (
|
|
307
|
-
url: string,
|
|
308
|
-
id: string,
|
|
309
|
-
params: any,
|
|
310
|
-
context: StoryContext
|
|
311
|
-
) => Promise<string | Node>;
|
|
312
|
-
```
|
|
313
|
-
|
|
314
|
-
- url: Server url configured by the `parameters.server.url`
|
|
315
|
-
- id: Id of the story being rendered given by `parameters.server.id`
|
|
316
|
-
- params: Merged story params `parameters.server.params`and story args
|
|
317
|
-
- context: The context of the story
|
|
1
|
+
# Storybook Server renderer
|
|
@@ -54,6 +54,7 @@ Object.defineProperty(exports, "storiesOf", {
|
|
|
54
54
|
|
|
55
55
|
var _preview = require("./preview");
|
|
56
56
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
57
|
+
var _module, _module$hot;
|
|
58
|
+
|
|
59
|
+
// optimization: stop HMR propagation in webpack
|
|
60
|
+
(_module = module) === null || _module === void 0 ? void 0 : (_module$hot = _module.hot) === null || _module$hot === void 0 ? void 0 : _module$hot.decline();
|
|
File without changes
|
|
File without changes
|
|
@@ -7,14 +7,14 @@ exports.storiesOf = exports.setAddon = exports.raw = exports.getStorybook = expo
|
|
|
7
7
|
|
|
8
8
|
require("core-js/modules/es.array.concat.js");
|
|
9
9
|
|
|
10
|
-
var
|
|
10
|
+
var _coreClient = require("@storybook/core-client");
|
|
11
11
|
|
|
12
12
|
require("./globals");
|
|
13
13
|
|
|
14
14
|
var _render = require("./render");
|
|
15
15
|
|
|
16
16
|
var framework = 'server';
|
|
17
|
-
var api = (0,
|
|
17
|
+
var api = (0, _coreClient.start)(_render.renderToDOM, {
|
|
18
18
|
render: _render.render
|
|
19
19
|
});
|
|
20
20
|
|
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
|
|
4
|
+
|
|
5
|
+
require("core-js/modules/es.symbol.js");
|
|
6
|
+
|
|
7
|
+
require("core-js/modules/es.symbol.description.js");
|
|
8
|
+
|
|
9
|
+
require("core-js/modules/es.symbol.iterator.js");
|
|
10
|
+
|
|
11
|
+
require("core-js/modules/es.symbol.async-iterator.js");
|
|
12
|
+
|
|
13
|
+
require("core-js/modules/es.symbol.to-string-tag.js");
|
|
14
|
+
|
|
15
|
+
require("core-js/modules/es.json.to-string-tag.js");
|
|
16
|
+
|
|
17
|
+
require("core-js/modules/es.math.to-string-tag.js");
|
|
18
|
+
|
|
19
|
+
require("core-js/modules/es.object.get-prototype-of.js");
|
|
20
|
+
|
|
21
|
+
require("core-js/modules/es.array.slice.js");
|
|
22
|
+
|
|
23
|
+
require("core-js/modules/es.object.freeze.js");
|
|
24
|
+
|
|
25
|
+
Object.defineProperty(exports, "__esModule", {
|
|
26
|
+
value: true
|
|
27
|
+
});
|
|
28
|
+
exports.render = void 0;
|
|
29
|
+
exports.renderToDOM = renderToDOM;
|
|
30
|
+
|
|
31
|
+
require("core-js/modules/es.object.to-string.js");
|
|
32
|
+
|
|
33
|
+
require("core-js/modules/es.promise.js");
|
|
34
|
+
|
|
35
|
+
require("core-js/modules/es.array.iterator.js");
|
|
36
|
+
|
|
37
|
+
require("core-js/modules/es.string.iterator.js");
|
|
38
|
+
|
|
39
|
+
require("core-js/modules/web.dom-collections.iterator.js");
|
|
40
|
+
|
|
41
|
+
require("core-js/modules/web.url.js");
|
|
42
|
+
|
|
43
|
+
require("core-js/modules/web.url-search-params.js");
|
|
44
|
+
|
|
45
|
+
require("core-js/modules/es.array.concat.js");
|
|
46
|
+
|
|
47
|
+
require("core-js/modules/es.regexp.exec.js");
|
|
48
|
+
|
|
49
|
+
require("core-js/modules/es.string.search.js");
|
|
50
|
+
|
|
51
|
+
require("core-js/modules/es.regexp.to-string.js");
|
|
52
|
+
|
|
53
|
+
require("core-js/modules/es.object.assign.js");
|
|
54
|
+
|
|
55
|
+
require("core-js/modules/web.dom-collections.for-each.js");
|
|
56
|
+
|
|
57
|
+
require("core-js/modules/es.object.keys.js");
|
|
58
|
+
|
|
59
|
+
require("core-js/modules/es.function.name.js");
|
|
60
|
+
|
|
61
|
+
var _global = _interopRequireDefault(require("global"));
|
|
62
|
+
|
|
63
|
+
var _tsDedent = _interopRequireDefault(require("ts-dedent"));
|
|
64
|
+
|
|
65
|
+
var _previewWeb = require("@storybook/preview-web");
|
|
66
|
+
|
|
67
|
+
var _templateObject;
|
|
68
|
+
|
|
69
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
70
|
+
|
|
71
|
+
function _taggedTemplateLiteral(strings, raw) { if (!raw) { raw = strings.slice(0); } return Object.freeze(Object.defineProperties(strings, { raw: { value: Object.freeze(raw) } })); }
|
|
72
|
+
|
|
73
|
+
function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return generator._invoke = function (innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; }(innerFn, self, context), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; this._invoke = function (method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); }; } function maybeInvokeDelegate(delegate, context) { var method = delegate.iterator[context.method]; if (undefined === method) { if (context.delegate = null, "throw" === context.method) { if (delegate.iterator.return && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method)) return ContinueSentinel; context.method = "throw", context.arg = new TypeError("The iterator does not provide a 'throw' method"); } return ContinueSentinel; } var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) { if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; } return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, define(Gp, "constructor", GeneratorFunctionPrototype), define(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (object) { var keys = []; for (var key in object) { keys.push(key); } return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) { "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); } }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, catch: function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
|
|
74
|
+
|
|
75
|
+
function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
|
|
76
|
+
|
|
77
|
+
function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
|
|
78
|
+
|
|
79
|
+
var fetch = _global.default.fetch,
|
|
80
|
+
Node = _global.default.Node;
|
|
81
|
+
|
|
82
|
+
var defaultFetchStoryHtml = /*#__PURE__*/function () {
|
|
83
|
+
var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(url, path, params, storyContext) {
|
|
84
|
+
var fetchUrl, response;
|
|
85
|
+
return _regeneratorRuntime().wrap(function _callee$(_context) {
|
|
86
|
+
while (1) {
|
|
87
|
+
switch (_context.prev = _context.next) {
|
|
88
|
+
case 0:
|
|
89
|
+
fetchUrl = new URL("".concat(url, "/").concat(path));
|
|
90
|
+
fetchUrl.search = new URLSearchParams(Object.assign({}, storyContext.globals, params)).toString();
|
|
91
|
+
_context.next = 4;
|
|
92
|
+
return fetch(fetchUrl);
|
|
93
|
+
|
|
94
|
+
case 4:
|
|
95
|
+
response = _context.sent;
|
|
96
|
+
return _context.abrupt("return", response.text());
|
|
97
|
+
|
|
98
|
+
case 6:
|
|
99
|
+
case "end":
|
|
100
|
+
return _context.stop();
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
}, _callee);
|
|
104
|
+
}));
|
|
105
|
+
|
|
106
|
+
return function defaultFetchStoryHtml(_x, _x2, _x3, _x4) {
|
|
107
|
+
return _ref.apply(this, arguments);
|
|
108
|
+
};
|
|
109
|
+
}();
|
|
110
|
+
|
|
111
|
+
var buildStoryArgs = function buildStoryArgs(args, argTypes) {
|
|
112
|
+
var storyArgs = Object.assign({}, args);
|
|
113
|
+
Object.keys(argTypes).forEach(function (key) {
|
|
114
|
+
var argType = argTypes[key];
|
|
115
|
+
var control = argType.control;
|
|
116
|
+
var controlType = control && control.type.toLowerCase();
|
|
117
|
+
var argValue = storyArgs[key];
|
|
118
|
+
|
|
119
|
+
switch (controlType) {
|
|
120
|
+
case 'date':
|
|
121
|
+
// For cross framework & language support we pick a consistent representation of Dates as strings
|
|
122
|
+
storyArgs[key] = new Date(argValue).toISOString();
|
|
123
|
+
break;
|
|
124
|
+
|
|
125
|
+
case 'object':
|
|
126
|
+
// send objects as JSON strings
|
|
127
|
+
storyArgs[key] = JSON.stringify(argValue);
|
|
128
|
+
break;
|
|
129
|
+
|
|
130
|
+
default:
|
|
131
|
+
}
|
|
132
|
+
});
|
|
133
|
+
return storyArgs;
|
|
134
|
+
};
|
|
135
|
+
|
|
136
|
+
var render = function render(args) {};
|
|
137
|
+
|
|
138
|
+
exports.render = render;
|
|
139
|
+
|
|
140
|
+
function renderToDOM(_x5, _x6) {
|
|
141
|
+
return _renderToDOM.apply(this, arguments);
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
function _renderToDOM() {
|
|
145
|
+
_renderToDOM = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(_ref2, domElement) {
|
|
146
|
+
var id, title, name, showMain, showError, forceRemount, storyFn, storyContext, _ref2$storyContext, parameters, args, argTypes, storyArgs, _parameters$server, url, storyId, _parameters$server$fe, fetchStoryHtml, params, fetchId, storyParams, element;
|
|
147
|
+
|
|
148
|
+
return _regeneratorRuntime().wrap(function _callee2$(_context2) {
|
|
149
|
+
while (1) {
|
|
150
|
+
switch (_context2.prev = _context2.next) {
|
|
151
|
+
case 0:
|
|
152
|
+
id = _ref2.id, title = _ref2.title, name = _ref2.name, showMain = _ref2.showMain, showError = _ref2.showError, forceRemount = _ref2.forceRemount, storyFn = _ref2.storyFn, storyContext = _ref2.storyContext, _ref2$storyContext = _ref2.storyContext, parameters = _ref2$storyContext.parameters, args = _ref2$storyContext.args, argTypes = _ref2$storyContext.argTypes;
|
|
153
|
+
// Some addons wrap the storyFn so we need to call it even though Server doesn't need the answer
|
|
154
|
+
storyFn();
|
|
155
|
+
storyArgs = buildStoryArgs(args, argTypes);
|
|
156
|
+
_parameters$server = parameters.server, url = _parameters$server.url, storyId = _parameters$server.id, _parameters$server$fe = _parameters$server.fetchStoryHtml, fetchStoryHtml = _parameters$server$fe === void 0 ? defaultFetchStoryHtml : _parameters$server$fe, params = _parameters$server.params;
|
|
157
|
+
fetchId = storyId || id;
|
|
158
|
+
storyParams = Object.assign({}, params, storyArgs);
|
|
159
|
+
_context2.next = 8;
|
|
160
|
+
return fetchStoryHtml(url, fetchId, storyParams, storyContext);
|
|
161
|
+
|
|
162
|
+
case 8:
|
|
163
|
+
element = _context2.sent;
|
|
164
|
+
showMain();
|
|
165
|
+
|
|
166
|
+
if (!(typeof element === 'string')) {
|
|
167
|
+
_context2.next = 15;
|
|
168
|
+
break;
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
domElement.innerHTML = element;
|
|
172
|
+
(0, _previewWeb.simulatePageLoad)(domElement);
|
|
173
|
+
_context2.next = 24;
|
|
174
|
+
break;
|
|
175
|
+
|
|
176
|
+
case 15:
|
|
177
|
+
if (!(element instanceof Node)) {
|
|
178
|
+
_context2.next = 23;
|
|
179
|
+
break;
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
if (!(domElement.firstChild === element && forceRemount === false)) {
|
|
183
|
+
_context2.next = 18;
|
|
184
|
+
break;
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
return _context2.abrupt("return");
|
|
188
|
+
|
|
189
|
+
case 18:
|
|
190
|
+
domElement.innerHTML = '';
|
|
191
|
+
domElement.appendChild(element);
|
|
192
|
+
(0, _previewWeb.simulateDOMContentLoaded)();
|
|
193
|
+
_context2.next = 24;
|
|
194
|
+
break;
|
|
195
|
+
|
|
196
|
+
case 23:
|
|
197
|
+
showError({
|
|
198
|
+
title: "Expecting an HTML snippet or DOM node from the story: \"".concat(name, "\" of \"").concat(title, "\"."),
|
|
199
|
+
description: (0, _tsDedent.default)(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n Did you forget to return the HTML snippet from the story?\n Use \"() => <your snippet or node>\" or when defining the story.\n "])))
|
|
200
|
+
});
|
|
201
|
+
|
|
202
|
+
case 24:
|
|
203
|
+
case "end":
|
|
204
|
+
return _context2.stop();
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
}, _callee2);
|
|
208
|
+
}));
|
|
209
|
+
return _renderToDOM.apply(this, arguments);
|
|
210
|
+
}
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
/// <reference types="webpack-env" />
|
|
2
|
-
/// <reference types="node" />
|
|
3
2
|
import type { ClientStoryApi, Loadable } from '@storybook/addons';
|
|
4
3
|
import './globals';
|
|
5
4
|
import type { IStorybookSection, ServerFramework } from './types';
|
|
@@ -16,6 +15,6 @@ export declare const configure: ClientApi['configure'];
|
|
|
16
15
|
export declare const addDecorator: (() => never) | ((decorator: import("@storybook/csf").DecoratorFunction<ServerFramework, import("@storybook/addons").Args>) => void), addParameters: (({ globals, globalTypes, ...parameters }: import("@storybook/csf").Parameters & {
|
|
17
16
|
globals?: import("@storybook/csf").Globals;
|
|
18
17
|
globalTypes?: import("@storybook/csf").GlobalTypes;
|
|
19
|
-
}) => void) | (() => never), clearDecorators: (() => void) | (() => never), setAddon: ((addon: any) => void) | (() => never), getStorybook: (() => never) | (() => import("
|
|
18
|
+
}) => void) | (() => never), clearDecorators: (() => void) | (() => never), setAddon: ((addon: any) => void) | (() => never), getStorybook: (() => never) | (() => import("lib/client-api/dist/types/ClientApi").GetStorybookKind<ServerFramework>[]), raw: (() => never) | (() => import("lib/store/dist/types").BoundStory<ServerFramework>[]);
|
|
20
19
|
export declare const forceReRender: (() => never) | (() => void);
|
|
21
20
|
export {};
|
|
File without changes
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { StoryContext } from '@storybook/csf';
|
|
2
|
-
export type { RenderContext } from '@storybook/core';
|
|
2
|
+
export type { RenderContext } from '@storybook/core-client';
|
|
3
3
|
export declare type StoryFnServerReturnType = any;
|
|
4
4
|
export declare type ServerFramework = {
|
|
5
5
|
component: string;
|