@storybook/server 7.6.0-beta.2 → 8.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/dist/entry-preview.d.ts +1 -1
- package/dist/entry-preview.mjs +8 -3
- package/dist/index.d.ts +40 -13
- package/dist/index.js +1 -4
- package/dist/index.mjs +1 -5
- package/dist/preset.d.ts +3 -3
- package/dist/preset.js +1 -1
- package/package.json +5 -6
- package/dist/chunk-DS2DPF2X.mjs +0 -10
- package/dist/public-types-af1e4671.d.ts +0 -43
package/dist/entry-preview.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { RenderContext } from '@storybook/types';
|
|
2
|
-
import {
|
|
2
|
+
import { StoryFn, ServerRenderer } from './index.js';
|
|
3
3
|
|
|
4
4
|
declare const render: StoryFn<ServerRenderer>;
|
|
5
5
|
declare function renderToCanvas({ id, title, name, showMain, showError, forceRemount, storyFn, storyContext, storyContext: { parameters, args, argTypes }, }: RenderContext<ServerRenderer>, canvasElement: ServerRenderer['canvasElement']): Promise<void>;
|
package/dist/entry-preview.mjs
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
|
-
|
|
1
|
+
import { global } from '@storybook/global';
|
|
2
|
+
import { dedent } from 'ts-dedent';
|
|
3
|
+
import { simulatePageLoad, simulateDOMContentLoaded } from '@storybook/preview-api';
|
|
2
4
|
|
|
3
|
-
var
|
|
5
|
+
var {fetch,Node}=global,defaultFetchStoryHtml=async(url,path,params,storyContext)=>{let fetchUrl=new URL(`${url}/${path}`);return fetchUrl.search=new URLSearchParams({...storyContext.globals,...params}).toString(),(await fetch(fetchUrl)).text()},buildStoryArgs=(args,argTypes)=>{let storyArgs={...args};return Object.keys(argTypes).forEach(key=>{let argType=argTypes[key],{control}=argType,controlType=control&&control.type.toLowerCase(),argValue=storyArgs[key];switch(controlType){case"date":storyArgs[key]=new Date(argValue).toISOString();break;case"object":storyArgs[key]=JSON.stringify(argValue);break;}}),storyArgs},render=args=>{};async function renderToCanvas({id,title,name,showMain,showError,forceRemount,storyFn,storyContext,storyContext:{parameters:parameters2,args,argTypes}},canvasElement){storyFn();let storyArgs=buildStoryArgs(args,argTypes),{server:{url,id:storyId,fetchStoryHtml=defaultFetchStoryHtml,params}}=parameters2,fetchId=storyId||id,storyParams={...params,...storyArgs},element=await fetchStoryHtml(url,fetchId,storyParams,storyContext);if(showMain(),typeof element=="string")canvasElement.innerHTML=element,simulatePageLoad(canvasElement);else if(element instanceof Node){if(canvasElement.firstChild===element&&forceRemount===!1)return;canvasElement.innerHTML="",canvasElement.appendChild(element),simulateDOMContentLoaded();}else showError({title:`Expecting an HTML snippet or DOM node from the story: "${name}" of "${title}".`,description:dedent`
|
|
6
|
+
Did you forget to return the HTML snippet from the story?
|
|
7
|
+
Use "() => <your snippet or node>" or when defining the story.
|
|
8
|
+
`});}var parameters={renderer:"server"};
|
|
4
9
|
|
|
5
|
-
export { parameters };
|
|
10
|
+
export { parameters, render, renderToCanvas };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,17 +1,44 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { Addon_ClientStoryApi, Addon_Loadable } from '@storybook/types';
|
|
1
|
+
import { WebRenderer, Args, ComponentAnnotations, AnnotatedStoryFn, StoryAnnotations, StrictArgs, DecoratorFunction, LoaderFunction, StoryContext as StoryContext$1, ProjectAnnotations } from '@storybook/types';
|
|
3
2
|
export { ArgTypes, Args, Parameters, StrictArgs } from '@storybook/types';
|
|
4
|
-
import { S as ServerRenderer } from './public-types-af1e4671.js';
|
|
5
|
-
export { D as Decorator, L as Loader, M as Meta, P as Preview, c as Story, d as StoryContext, a as StoryFn, b as StoryObj } from './public-types-af1e4671.js';
|
|
6
3
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
4
|
+
type StoryFnServerReturnType = any;
|
|
5
|
+
interface ServerRenderer extends WebRenderer {
|
|
6
|
+
component: string;
|
|
7
|
+
storyResult: StoryFnServerReturnType;
|
|
11
8
|
}
|
|
12
|
-
declare const storiesOf: ClientApi['storiesOf'];
|
|
13
|
-
declare const configure: ClientApi['configure'];
|
|
14
|
-
declare const raw: ((...args: any[]) => never) | (() => _storybook_types.BoundStory<ServerRenderer>[]);
|
|
15
|
-
declare const forceReRender: () => void;
|
|
16
9
|
|
|
17
|
-
|
|
10
|
+
/**
|
|
11
|
+
* Metadata to configure the stories for a component.
|
|
12
|
+
*
|
|
13
|
+
* @see [Default export](https://storybook.js.org/docs/formats/component-story-format/#default-export)
|
|
14
|
+
*/
|
|
15
|
+
type Meta<TArgs = Args> = ComponentAnnotations<ServerRenderer, TArgs>;
|
|
16
|
+
/**
|
|
17
|
+
* Story function that represents a CSFv2 component example.
|
|
18
|
+
*
|
|
19
|
+
* @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
|
|
20
|
+
*/
|
|
21
|
+
type StoryFn<TArgs = Args> = AnnotatedStoryFn<ServerRenderer, TArgs>;
|
|
22
|
+
/**
|
|
23
|
+
* Story function that represents a CSFv3 component example.
|
|
24
|
+
*
|
|
25
|
+
* @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
|
|
26
|
+
*/
|
|
27
|
+
type StoryObj<TArgs = Args> = StoryAnnotations<ServerRenderer, TArgs>;
|
|
28
|
+
/**
|
|
29
|
+
* @deprecated Use `StoryFn` instead.
|
|
30
|
+
* Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
|
|
31
|
+
* You can read more about the CSF3 format here: https://storybook.js.org/blog/component-story-format-3-0/
|
|
32
|
+
*
|
|
33
|
+
* Story function that represents a CSFv2 component example.
|
|
34
|
+
*
|
|
35
|
+
* @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
|
|
36
|
+
*/
|
|
37
|
+
type Story<TArgs = Args> = StoryFn<TArgs>;
|
|
38
|
+
|
|
39
|
+
type Decorator<TArgs = StrictArgs> = DecoratorFunction<ServerRenderer, TArgs>;
|
|
40
|
+
type Loader<TArgs = StrictArgs> = LoaderFunction<ServerRenderer, TArgs>;
|
|
41
|
+
type StoryContext<TArgs = StrictArgs> = StoryContext$1<ServerRenderer, TArgs>;
|
|
42
|
+
type Preview = ProjectAnnotations<ServerRenderer>;
|
|
43
|
+
|
|
44
|
+
export { Decorator, Loader, Meta, Preview, ServerRenderer, Story, StoryContext, StoryFn, StoryObj };
|
package/dist/index.js
CHANGED
|
@@ -1,4 +1 @@
|
|
|
1
|
-
var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __hasOwnProp=Object.prototype.hasOwnProperty;var
|
|
2
|
-
Did you forget to return the HTML snippet from the story?
|
|
3
|
-
Use "() => <your snippet or node>" or when defining the story.
|
|
4
|
-
`})}var RENDERER="server",api=(0,import_preview_api2.start)(renderToCanvas,{render}),storiesOf=(kind,m)=>api.clientApi.storiesOf(kind,m).addParameters({renderer:RENDERER}),configure=(...args)=>api.configure(RENDERER,...args),{raw}=api.clientApi,{forceReRender}=api;var _a;typeof module<"u"&&((_a=module==null?void 0:module.hot)==null||_a.decline());0&&(module.exports={configure,forceReRender,raw,storiesOf});
|
|
1
|
+
var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __hasOwnProp=Object.prototype.hasOwnProperty;var __copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var src_exports={};module.exports=__toCommonJS(src_exports);var import_global=require("@storybook/global"),{window:globalWindow}=import_global.global;globalWindow.STORYBOOK_ENV="SERVER";var _a;typeof module<"u"&&((_a=module==null?void 0:module.hot)==null||_a.decline());
|
package/dist/index.mjs
CHANGED
|
@@ -1,7 +1,3 @@
|
|
|
1
|
-
import { renderToCanvas, render } from './chunk-DS2DPF2X.mjs';
|
|
2
1
|
import { global } from '@storybook/global';
|
|
3
|
-
import { start } from '@storybook/preview-api';
|
|
4
2
|
|
|
5
|
-
var{window:globalWindow}=global;globalWindow.STORYBOOK_ENV="SERVER";
|
|
6
|
-
|
|
7
|
-
export { configure, forceReRender, raw, storiesOf };
|
|
3
|
+
var{window:globalWindow}=global;globalWindow.STORYBOOK_ENV="SERVER";typeof module<"u"&&module?.hot?.decline();
|
package/dist/preset.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { PresetProperty } from '@storybook/types';
|
|
2
2
|
|
|
3
|
-
declare const experimental_indexers:
|
|
4
|
-
declare const previewAnnotations:
|
|
3
|
+
declare const experimental_indexers: PresetProperty<'experimental_indexers'>;
|
|
4
|
+
declare const previewAnnotations: PresetProperty<'previewAnnotations'>;
|
|
5
5
|
|
|
6
6
|
export { experimental_indexers, previewAnnotations };
|
package/dist/preset.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var preset_exports={};__export(preset_exports,{experimental_indexers:()=>experimental_indexers,previewAnnotations:()=>previewAnnotations});module.exports=__toCommonJS(preset_exports);var import_fs_extra=__toESM(require("fs-extra")),import_yaml=__toESM(require("yaml")),import_path=require("path"),experimental_indexers=existingIndexers=>[{test:/(stories|story)\.(json|ya?ml)$/,createIndex:async fileName=>{let content=fileName.endsWith(".json")?await import_fs_extra.default.readJson(fileName,"utf-8"):import_yaml.default.parse((await import_fs_extra.default.readFile(fileName,"utf-8")).toString());return content.stories.map(story=>{let tags=Array.from(new Set([...content.tags??[],...story.tags??[]]));return{importPath:fileName,exportName:story.name,name:story.name,title:content.title,tags,type:"story"}})}},...existingIndexers||[]],previewAnnotations=async(input,options)=>{let{presetsList}=options;return presetsList?[].concat(input).concat([(0,import_path.join)(__dirname,"entry-preview.mjs")]):input};0&&(module.exports={experimental_indexers,previewAnnotations});
|
|
1
|
+
var __create=Object.create;var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;var __getProtoOf=Object.getPrototypeOf,__hasOwnProp=Object.prototype.hasOwnProperty;var __export=(target,all)=>{for(var name in all)__defProp(target,name,{get:all[name],enumerable:!0})},__copyProps=(to,from,except,desc)=>{if(from&&typeof from=="object"||typeof from=="function")for(let key of __getOwnPropNames(from))!__hasOwnProp.call(to,key)&&key!==except&&__defProp(to,key,{get:()=>from[key],enumerable:!(desc=__getOwnPropDesc(from,key))||desc.enumerable});return to};var __toESM=(mod,isNodeMode,target)=>(target=mod!=null?__create(__getProtoOf(mod)):{},__copyProps(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:!0}):target,mod)),__toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:!0}),mod);var preset_exports={};__export(preset_exports,{experimental_indexers:()=>experimental_indexers,previewAnnotations:()=>previewAnnotations});module.exports=__toCommonJS(preset_exports);var import_fs_extra=__toESM(require("fs-extra")),import_yaml=__toESM(require("yaml")),import_path=require("path"),experimental_indexers=existingIndexers=>[{test:/(stories|story)\.(json|ya?ml)$/,createIndex:async fileName=>{let content=fileName.endsWith(".json")?await import_fs_extra.default.readJson(fileName,"utf-8"):import_yaml.default.parse((await import_fs_extra.default.readFile(fileName,"utf-8")).toString());return content.stories.map(story=>{let tags=Array.from(new Set([...content.tags??[],...story.tags??[]]));return{importPath:fileName,exportName:story.name,name:story.name,title:content.title,tags,type:"story"}})}},...existingIndexers||[]],previewAnnotations=async(input=[],options)=>{let{presetsList}=options;return presetsList?[].concat(input).concat([(0,import_path.join)(__dirname,"entry-preview.mjs")]):input};0&&(module.exports={experimental_indexers,previewAnnotations});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storybook/server",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "8.0.0-alpha.0",
|
|
4
4
|
"description": "Storybook Server renderer",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"storybook"
|
|
@@ -46,19 +46,18 @@
|
|
|
46
46
|
"prep": "node --loader ../../../scripts/node_modules/esbuild-register/loader.js -r ../../../scripts/node_modules/esbuild-register/register.js ../../../scripts/prepare/bundle.ts"
|
|
47
47
|
},
|
|
48
48
|
"dependencies": {
|
|
49
|
-
"@storybook/core-client": "7.6.0-beta.2",
|
|
50
49
|
"@storybook/csf": "^0.1.2",
|
|
51
|
-
"@storybook/csf-tools": "
|
|
50
|
+
"@storybook/csf-tools": "8.0.0-alpha.0",
|
|
52
51
|
"@storybook/global": "^5.0.0",
|
|
53
|
-
"@storybook/preview-api": "
|
|
54
|
-
"@storybook/types": "
|
|
52
|
+
"@storybook/preview-api": "8.0.0-alpha.0",
|
|
53
|
+
"@storybook/types": "8.0.0-alpha.0",
|
|
55
54
|
"@types/fs-extra": "^11.0.1",
|
|
56
55
|
"fs-extra": "^11.1.0",
|
|
57
56
|
"ts-dedent": "^2.0.0",
|
|
58
57
|
"yaml": "^2.3.1"
|
|
59
58
|
},
|
|
60
59
|
"devDependencies": {
|
|
61
|
-
"typescript": "
|
|
60
|
+
"typescript": "^5.3.2"
|
|
62
61
|
},
|
|
63
62
|
"engines": {
|
|
64
63
|
"node": ">=16.0.0"
|
package/dist/chunk-DS2DPF2X.mjs
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { global } from '@storybook/global';
|
|
2
|
-
import { dedent } from 'ts-dedent';
|
|
3
|
-
import { simulatePageLoad, simulateDOMContentLoaded } from '@storybook/preview-api';
|
|
4
|
-
|
|
5
|
-
var {fetch,Node}=global,defaultFetchStoryHtml=async(url,path,params,storyContext)=>{let fetchUrl=new URL(`${url}/${path}`);return fetchUrl.search=new URLSearchParams({...storyContext.globals,...params}).toString(),(await fetch(fetchUrl)).text()},buildStoryArgs=(args,argTypes)=>{let storyArgs={...args};return Object.keys(argTypes).forEach(key=>{let argType=argTypes[key],{control}=argType,controlType=control&&control.type.toLowerCase(),argValue=storyArgs[key];switch(controlType){case"date":storyArgs[key]=new Date(argValue).toISOString();break;case"object":storyArgs[key]=JSON.stringify(argValue);break;}}),storyArgs},render=args=>{};async function renderToCanvas({id,title,name,showMain,showError,forceRemount,storyFn,storyContext,storyContext:{parameters,args,argTypes}},canvasElement){storyFn();let storyArgs=buildStoryArgs(args,argTypes),{server:{url,id:storyId,fetchStoryHtml=defaultFetchStoryHtml,params}}=parameters,fetchId=storyId||id,storyParams={...params,...storyArgs},element=await fetchStoryHtml(url,fetchId,storyParams,storyContext);if(showMain(),typeof element=="string")canvasElement.innerHTML=element,simulatePageLoad(canvasElement);else if(element instanceof Node){if(canvasElement.firstChild===element&&forceRemount===!1)return;canvasElement.innerHTML="",canvasElement.appendChild(element),simulateDOMContentLoaded();}else showError({title:`Expecting an HTML snippet or DOM node from the story: "${name}" of "${title}".`,description:dedent`
|
|
6
|
-
Did you forget to return the HTML snippet from the story?
|
|
7
|
-
Use "() => <your snippet or node>" or when defining the story.
|
|
8
|
-
`});}
|
|
9
|
-
|
|
10
|
-
export { render, renderToCanvas };
|
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
import { WebRenderer, Args, ComponentAnnotations, AnnotatedStoryFn, StoryAnnotations, StrictArgs, DecoratorFunction, LoaderFunction, StoryContext as StoryContext$1, ProjectAnnotations } from '@storybook/types';
|
|
2
|
-
|
|
3
|
-
type StoryFnServerReturnType = any;
|
|
4
|
-
interface ServerRenderer extends WebRenderer {
|
|
5
|
-
component: string;
|
|
6
|
-
storyResult: StoryFnServerReturnType;
|
|
7
|
-
}
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* Metadata to configure the stories for a component.
|
|
11
|
-
*
|
|
12
|
-
* @see [Default export](https://storybook.js.org/docs/formats/component-story-format/#default-export)
|
|
13
|
-
*/
|
|
14
|
-
type Meta<TArgs = Args> = ComponentAnnotations<ServerRenderer, TArgs>;
|
|
15
|
-
/**
|
|
16
|
-
* Story function that represents a CSFv2 component example.
|
|
17
|
-
*
|
|
18
|
-
* @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
|
|
19
|
-
*/
|
|
20
|
-
type StoryFn<TArgs = Args> = AnnotatedStoryFn<ServerRenderer, TArgs>;
|
|
21
|
-
/**
|
|
22
|
-
* Story function that represents a CSFv3 component example.
|
|
23
|
-
*
|
|
24
|
-
* @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
|
|
25
|
-
*/
|
|
26
|
-
type StoryObj<TArgs = Args> = StoryAnnotations<ServerRenderer, TArgs>;
|
|
27
|
-
/**
|
|
28
|
-
* @deprecated Use `StoryFn` instead.
|
|
29
|
-
* Use `StoryObj` if you want to migrate to CSF3, which uses objects instead of functions to represent stories.
|
|
30
|
-
* You can read more about the CSF3 format here: https://storybook.js.org/blog/component-story-format-3-0/
|
|
31
|
-
*
|
|
32
|
-
* Story function that represents a CSFv2 component example.
|
|
33
|
-
*
|
|
34
|
-
* @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
|
|
35
|
-
*/
|
|
36
|
-
type Story<TArgs = Args> = StoryFn<TArgs>;
|
|
37
|
-
|
|
38
|
-
type Decorator<TArgs = StrictArgs> = DecoratorFunction<ServerRenderer, TArgs>;
|
|
39
|
-
type Loader<TArgs = StrictArgs> = LoaderFunction<ServerRenderer, TArgs>;
|
|
40
|
-
type StoryContext<TArgs = StrictArgs> = StoryContext$1<ServerRenderer, TArgs>;
|
|
41
|
-
type Preview = ProjectAnnotations<ServerRenderer>;
|
|
42
|
-
|
|
43
|
-
export { Decorator as D, Loader as L, Meta as M, Preview as P, ServerRenderer as S, StoryFn as a, StoryObj as b, Story as c, StoryContext as d };
|