@storybook/preview-api 7.0.0-alpha.54 → 7.0.0-alpha.56
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/{ClientApi-dce2f8f2.d.ts → ClientApi-e986b10e.d.ts} +13 -13
- package/dist/{DocsContext-f03e0d93.d.ts → DocsContext-45b5a5b3.d.ts} +47 -37
- package/dist/StoryStore-d61f3707.d.ts +109 -0
- package/dist/addons.d.ts +2 -2
- package/dist/{chunk-SVTQV5PN.mjs → chunk-2GCNHWUZ.mjs} +1 -1
- package/dist/{chunk-Q5H6OXOG.mjs → chunk-FU7XW5ZS.mjs} +2 -2
- package/dist/{chunk-OWLSKH4Q.mjs → chunk-RLLOFRQR.mjs} +1 -1
- package/dist/{chunk-CMHHF3W3.mjs → chunk-XEVG66G2.mjs} +1 -1
- package/dist/client-api.d.ts +7 -7
- package/dist/client-api.js +13 -13
- package/dist/client-api.mjs +1 -1
- package/dist/composeConfigs-7f62ebf7.d.ts +9 -0
- package/dist/core-client.d.ts +4 -4
- package/dist/core-client.js +20 -20
- package/dist/core-client.mjs +1 -1
- package/dist/{hooks-a99e1305.d.ts → hooks-0a0ec0e3.d.ts} +3 -3
- package/dist/{hooks-0d0b05c1.d.ts → hooks-dd6bc7a8.d.ts} +0 -0
- package/dist/index.d.ts +9 -9
- package/dist/index.js +21 -21
- package/dist/index.mjs +1 -1
- package/dist/preview-web.d.ts +4 -4
- package/dist/preview-web.js +15 -15
- package/dist/preview-web.mjs +1 -1
- package/dist/{queryparams-2acc7490.d.ts → queryparams-d12445b8.d.ts} +0 -0
- package/dist/{sortStories-dc945850.d.ts → sortStories-a93f5af2.d.ts} +11 -10
- package/dist/{start-3a1ec032.d.ts → start-6a0f43a9.d.ts} +1 -1
- package/dist/store.d.ts +5 -5
- package/dist/store.js +10 -10
- package/dist/store.mjs +1 -1
- package/dist/{storybook-channel-mock-e42c60b1.d.ts → storybook-channel-mock-a19cd233.d.ts} +0 -0
- package/package.json +8 -8
- package/dist/StoryStore-8f9ab1c2.d.ts +0 -103
- package/dist/composeConfigs-62cfdf58.d.ts +0 -9
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
import * as _storybook_types from '@storybook/types';
|
|
2
|
-
import { Renderer,
|
|
3
|
-
import { S as StoryStore } from './StoryStore-
|
|
2
|
+
import { Renderer, NormalizedProjectAnnotations, StoryId, IndexEntry, ComponentId, Path, ModuleExports, DecoratorFunction, Parameters, LoaderFunction, Args, ArgTypes, ArgsEnhancer, ArgTypesEnhancer, StepRunner, ModuleImportFn, Globals, GlobalTypes, Addon_StoryApi } from '@storybook/types';
|
|
3
|
+
import { S as StoryStore } from './StoryStore-d61f3707.js';
|
|
4
4
|
|
|
5
5
|
declare class StoryStoreFacade<TRenderer extends Renderer> {
|
|
6
|
-
projectAnnotations:
|
|
7
|
-
entries: Record<StoryId,
|
|
6
|
+
projectAnnotations: NormalizedProjectAnnotations<TRenderer>;
|
|
7
|
+
entries: Record<StoryId, IndexEntry & {
|
|
8
8
|
componentId?: ComponentId;
|
|
9
9
|
}>;
|
|
10
|
-
csfExports: Record<Path,
|
|
10
|
+
csfExports: Record<Path, ModuleExports>;
|
|
11
11
|
constructor();
|
|
12
|
-
importFn(path: Path): Promise<
|
|
12
|
+
importFn(path: Path): Promise<ModuleExports>;
|
|
13
13
|
getStoryIndex(store: StoryStore<TRenderer>): {
|
|
14
14
|
v: number;
|
|
15
|
-
entries: Record<string,
|
|
15
|
+
entries: Record<string, IndexEntry>;
|
|
16
16
|
};
|
|
17
17
|
clearFilenameExports(fileName: Path): void;
|
|
18
|
-
addStoriesFromExports(fileName: Path, fileExports:
|
|
18
|
+
addStoriesFromExports(fileName: Path, fileExports: ModuleExports): void;
|
|
19
19
|
}
|
|
20
20
|
|
|
21
21
|
declare let singleton: ClientApi<Renderer>;
|
|
@@ -33,16 +33,16 @@ declare class ClientApi<TRenderer extends Renderer> {
|
|
|
33
33
|
storyStore?: StoryStore<TRenderer>;
|
|
34
34
|
private addons;
|
|
35
35
|
onImportFnChanged?: ({ importFn }: {
|
|
36
|
-
importFn:
|
|
36
|
+
importFn: ModuleImportFn;
|
|
37
37
|
}) => void;
|
|
38
38
|
private lastFileName;
|
|
39
39
|
constructor({ storyStore }?: {
|
|
40
40
|
storyStore?: StoryStore<TRenderer>;
|
|
41
41
|
});
|
|
42
|
-
importFn(path: Path): Promise<
|
|
42
|
+
importFn(path: Path): Promise<ModuleExports>;
|
|
43
43
|
getStoryIndex(): {
|
|
44
44
|
v: number;
|
|
45
|
-
entries: Record<string, _storybook_types.
|
|
45
|
+
entries: Record<string, _storybook_types.IndexEntry>;
|
|
46
46
|
};
|
|
47
47
|
addDecorator: (decorator: DecoratorFunction<TRenderer>) => void;
|
|
48
48
|
addParameters: ({ globals, globalTypes, ...parameters }: Parameters & {
|
|
@@ -55,10 +55,10 @@ declare class ClientApi<TRenderer extends Renderer> {
|
|
|
55
55
|
addArgTypes: (argTypes: ArgTypes) => void;
|
|
56
56
|
addArgsEnhancer: (enhancer: ArgsEnhancer<TRenderer>) => void;
|
|
57
57
|
addArgTypesEnhancer: (enhancer: ArgTypesEnhancer<TRenderer>) => void;
|
|
58
|
-
_addedExports: Record<string,
|
|
58
|
+
_addedExports: Record<string, ModuleExports>;
|
|
59
59
|
_loadAddedExports(): void;
|
|
60
60
|
storiesOf: (kind: string, m?: NodeModule) => Addon_StoryApi<TRenderer['storyResult']>;
|
|
61
|
-
raw: () => _storybook_types.
|
|
61
|
+
raw: () => _storybook_types.BoundStory<TRenderer>[] | undefined;
|
|
62
62
|
get _storyStore(): StoryStore<TRenderer> | undefined;
|
|
63
63
|
}
|
|
64
64
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as _storybook_types from '@storybook/types';
|
|
2
|
-
import { Renderer, StoryId, StoryRenderOptions, ViewMode,
|
|
2
|
+
import { Renderer, StoryId, StoryRenderOptions, ViewMode, PreparedStory, RenderToCanvas, RenderContext, IndexEntry, DocsContextProps, StoryIndex, ModuleImportFn, ProjectAnnotations, Globals, Args, CSFFile, ModuleExports, ModuleExport, StoryName, StoryContextForLoaders } from '@storybook/types';
|
|
3
3
|
import { Channel } from '@storybook/channels';
|
|
4
|
-
import { S as StoryStore } from './StoryStore-
|
|
4
|
+
import { S as StoryStore, a as StorySpecifier } from './StoryStore-d61f3707.js';
|
|
5
5
|
|
|
6
6
|
type RenderType = 'story' | 'docs';
|
|
7
7
|
/**
|
|
@@ -25,7 +25,7 @@ interface Render<TRenderer extends Renderer> {
|
|
|
25
25
|
}
|
|
26
26
|
|
|
27
27
|
type RenderPhase = 'preparing' | 'loading' | 'rendering' | 'playing' | 'played' | 'completed' | 'aborted' | 'errored';
|
|
28
|
-
type RenderContextCallbacks<TRenderer extends Renderer> = Pick<
|
|
28
|
+
type RenderContextCallbacks<TRenderer extends Renderer> = Pick<RenderContext<TRenderer>, 'showMain' | 'showError' | 'showException'>;
|
|
29
29
|
declare class StoryRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
30
30
|
channel: Channel;
|
|
31
31
|
store: StoryStore<TRenderer>;
|
|
@@ -35,7 +35,7 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
|
|
|
35
35
|
viewMode: ViewMode;
|
|
36
36
|
renderOptions: StoryRenderOptions;
|
|
37
37
|
type: RenderType;
|
|
38
|
-
story?:
|
|
38
|
+
story?: PreparedStory<TRenderer>;
|
|
39
39
|
phase?: RenderPhase;
|
|
40
40
|
private abortController?;
|
|
41
41
|
private canvasElement?;
|
|
@@ -43,7 +43,7 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
|
|
|
43
43
|
disableKeyListeners: boolean;
|
|
44
44
|
private teardownRender;
|
|
45
45
|
torndown: boolean;
|
|
46
|
-
constructor(channel: Channel, store: StoryStore<TRenderer>, renderToScreen: RenderToCanvas<TRenderer>, callbacks: RenderContextCallbacks<TRenderer>, id: StoryId, viewMode: ViewMode, renderOptions?: StoryRenderOptions, story?:
|
|
46
|
+
constructor(channel: Channel, store: StoryStore<TRenderer>, renderToScreen: RenderToCanvas<TRenderer>, callbacks: RenderContextCallbacks<TRenderer>, id: StoryId, viewMode: ViewMode, renderOptions?: StoryRenderOptions, story?: PreparedStory<TRenderer>);
|
|
47
47
|
private runPhase;
|
|
48
48
|
prepare(): Promise<void>;
|
|
49
49
|
isEqual(other: Render<TRenderer>): boolean;
|
|
@@ -76,10 +76,10 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
|
|
|
76
76
|
declare class TemplateDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
77
77
|
protected channel: Channel;
|
|
78
78
|
protected store: StoryStore<TRenderer>;
|
|
79
|
-
entry:
|
|
79
|
+
entry: IndexEntry;
|
|
80
80
|
readonly type: RenderType;
|
|
81
81
|
readonly id: StoryId;
|
|
82
|
-
story?:
|
|
82
|
+
story?: PreparedStory<TRenderer>;
|
|
83
83
|
rerender?: () => Promise<void>;
|
|
84
84
|
teardownRender?: (options: {
|
|
85
85
|
viewModeChanged?: boolean;
|
|
@@ -88,7 +88,7 @@ declare class TemplateDocsRender<TRenderer extends Renderer> implements Render<T
|
|
|
88
88
|
readonly disableKeyListeners = false;
|
|
89
89
|
preparing: boolean;
|
|
90
90
|
private csfFiles?;
|
|
91
|
-
constructor(channel: Channel, store: StoryStore<TRenderer>, entry:
|
|
91
|
+
constructor(channel: Channel, store: StoryStore<TRenderer>, entry: IndexEntry);
|
|
92
92
|
isPreparing(): boolean;
|
|
93
93
|
prepare(): Promise<void>;
|
|
94
94
|
isEqual(other: Render<TRenderer>): boolean;
|
|
@@ -109,7 +109,7 @@ declare class TemplateDocsRender<TRenderer extends Renderer> implements Render<T
|
|
|
109
109
|
declare class StandaloneDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
110
110
|
protected channel: Channel;
|
|
111
111
|
protected store: StoryStore<TRenderer>;
|
|
112
|
-
entry:
|
|
112
|
+
entry: IndexEntry;
|
|
113
113
|
readonly type: RenderType;
|
|
114
114
|
readonly id: StoryId;
|
|
115
115
|
private exports?;
|
|
@@ -121,7 +121,7 @@ declare class StandaloneDocsRender<TRenderer extends Renderer> implements Render
|
|
|
121
121
|
readonly disableKeyListeners = false;
|
|
122
122
|
preparing: boolean;
|
|
123
123
|
private csfFiles?;
|
|
124
|
-
constructor(channel: Channel, store: StoryStore<TRenderer>, entry:
|
|
124
|
+
constructor(channel: Channel, store: StoryStore<TRenderer>, entry: IndexEntry);
|
|
125
125
|
isPreparing(): boolean;
|
|
126
126
|
prepare(): Promise<void>;
|
|
127
127
|
isEqual(other: Render<TRenderer>): boolean;
|
|
@@ -136,31 +136,31 @@ declare class Preview<TFramework extends Renderer> {
|
|
|
136
136
|
protected channel: Channel;
|
|
137
137
|
serverChannel?: Channel;
|
|
138
138
|
storyStore: StoryStore<TFramework>;
|
|
139
|
-
getStoryIndex?: () =>
|
|
140
|
-
importFn?:
|
|
139
|
+
getStoryIndex?: () => StoryIndex;
|
|
140
|
+
importFn?: ModuleImportFn;
|
|
141
141
|
renderToCanvas?: RenderToCanvas<TFramework>;
|
|
142
142
|
storyRenders: StoryRender<TFramework>[];
|
|
143
143
|
previewEntryError?: Error;
|
|
144
144
|
constructor(channel?: Channel);
|
|
145
145
|
initialize({ getStoryIndex, importFn, getProjectAnnotations, }: {
|
|
146
|
-
getStoryIndex?: () =>
|
|
147
|
-
importFn:
|
|
146
|
+
getStoryIndex?: () => StoryIndex;
|
|
147
|
+
importFn: ModuleImportFn;
|
|
148
148
|
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TFramework>>;
|
|
149
149
|
}): Promise<void>;
|
|
150
150
|
setupListeners(): void;
|
|
151
|
-
getProjectAnnotationsOrRenderError(getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TFramework>>):
|
|
151
|
+
getProjectAnnotationsOrRenderError(getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TFramework>>): Promise<ProjectAnnotations<TFramework>>;
|
|
152
152
|
initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations<TFramework>): Promise<void>;
|
|
153
153
|
setInitialGlobals(): Promise<void>;
|
|
154
154
|
emitGlobals(): void;
|
|
155
|
-
getStoryIndexFromServer(): Promise<
|
|
156
|
-
initializeWithStoryIndex(storyIndex:
|
|
155
|
+
getStoryIndexFromServer(): Promise<StoryIndex>;
|
|
156
|
+
initializeWithStoryIndex(storyIndex: StoryIndex): PromiseLike<void>;
|
|
157
157
|
onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
|
|
158
158
|
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TFramework>>;
|
|
159
159
|
}): Promise<void>;
|
|
160
160
|
onStoryIndexChanged(): Promise<void>;
|
|
161
161
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
162
|
-
importFn?:
|
|
163
|
-
storyIndex?:
|
|
162
|
+
importFn?: ModuleImportFn;
|
|
163
|
+
storyIndex?: StoryIndex;
|
|
164
164
|
}): Promise<void>;
|
|
165
165
|
onUpdateGlobals({ globals }: {
|
|
166
166
|
globals: Globals;
|
|
@@ -177,7 +177,7 @@ declare class Preview<TFramework extends Renderer> {
|
|
|
177
177
|
onForceRemount({ storyId }: {
|
|
178
178
|
storyId: StoryId;
|
|
179
179
|
}): Promise<void>;
|
|
180
|
-
renderStoryToElement(story:
|
|
180
|
+
renderStoryToElement(story: PreparedStory<TFramework>, element: TFramework['canvasElement'], options: StoryRenderOptions): () => Promise<void>;
|
|
181
181
|
teardownRender(render: StoryRender<TFramework> | TemplateDocsRender<TFramework> | StandaloneDocsRender<TFramework>, { viewModeChanged }?: {
|
|
182
182
|
viewModeChanged?: boolean;
|
|
183
183
|
}): Promise<void>;
|
|
@@ -195,15 +195,25 @@ declare class Preview<TFramework extends Renderer> {
|
|
|
195
195
|
renderPreviewEntryError(reason: string, err: Error): void;
|
|
196
196
|
}
|
|
197
197
|
|
|
198
|
+
interface SelectionSpecifier {
|
|
199
|
+
storySpecifier: StorySpecifier;
|
|
200
|
+
viewMode: ViewMode;
|
|
201
|
+
args?: Args;
|
|
202
|
+
globals?: Args;
|
|
203
|
+
}
|
|
204
|
+
interface Selection {
|
|
205
|
+
storyId: StoryId;
|
|
206
|
+
viewMode: ViewMode;
|
|
207
|
+
}
|
|
198
208
|
interface SelectionStore {
|
|
199
|
-
selectionSpecifier:
|
|
200
|
-
selection?:
|
|
201
|
-
setSelection(selection:
|
|
209
|
+
selectionSpecifier: SelectionSpecifier | null;
|
|
210
|
+
selection?: Selection;
|
|
211
|
+
setSelection(selection: Selection): void;
|
|
202
212
|
setQueryParams(queryParams: qs.ParsedQs): void;
|
|
203
213
|
}
|
|
204
214
|
|
|
205
215
|
interface View<TStorybookRoot> {
|
|
206
|
-
prepareForStory(story:
|
|
216
|
+
prepareForStory(story: PreparedStory<any>): TStorybookRoot;
|
|
207
217
|
prepareForDocs(): TStorybookRoot;
|
|
208
218
|
showErrorDisplay(err: {
|
|
209
219
|
message?: string;
|
|
@@ -224,20 +234,20 @@ type PossibleRender<TFramework extends Renderer> = StoryRender<TFramework> | Tem
|
|
|
224
234
|
declare class PreviewWithSelection<TFramework extends Renderer> extends Preview<TFramework> {
|
|
225
235
|
selectionStore: SelectionStore;
|
|
226
236
|
view: View<TFramework['canvasElement']>;
|
|
227
|
-
currentSelection?:
|
|
237
|
+
currentSelection?: Selection;
|
|
228
238
|
currentRender?: PossibleRender<TFramework>;
|
|
229
239
|
constructor(selectionStore: SelectionStore, view: View<TFramework['canvasElement']>);
|
|
230
240
|
setupListeners(): void;
|
|
231
241
|
initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations<TFramework>): Promise<void>;
|
|
232
242
|
setInitialGlobals(): Promise<void>;
|
|
233
|
-
initializeWithStoryIndex(storyIndex:
|
|
243
|
+
initializeWithStoryIndex(storyIndex: StoryIndex): PromiseLike<void>;
|
|
234
244
|
selectSpecifiedStory(): Promise<void>;
|
|
235
245
|
onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
|
|
236
246
|
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TFramework>>;
|
|
237
247
|
}): Promise<void>;
|
|
238
248
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
239
|
-
importFn?:
|
|
240
|
-
storyIndex?:
|
|
249
|
+
importFn?: ModuleImportFn;
|
|
250
|
+
storyIndex?: StoryIndex;
|
|
241
251
|
}): Promise<void>;
|
|
242
252
|
onKeydown(event: KeyboardEvent): void;
|
|
243
253
|
onSetCurrentStory(selection: {
|
|
@@ -282,7 +292,7 @@ declare class PreviewWithSelection<TFramework extends Renderer> extends Preview<
|
|
|
282
292
|
};
|
|
283
293
|
renderPreviewEntryError(reason: string, err: Error): void;
|
|
284
294
|
renderMissingStory(): void;
|
|
285
|
-
renderStoryLoadingException(storySpecifier:
|
|
295
|
+
renderStoryLoadingException(storySpecifier: StorySpecifier, err: Error): void;
|
|
286
296
|
renderException(storyId: StoryId, error: Error): void;
|
|
287
297
|
renderError(storyId: StoryId, { title, description }: {
|
|
288
298
|
title: string;
|
|
@@ -308,15 +318,15 @@ declare class DocsContext<TRenderer extends Renderer> implements DocsContextProp
|
|
|
308
318
|
private primaryStory?;
|
|
309
319
|
constructor(channel: Channel, store: StoryStore<TRenderer>, renderStoryToElement: DocsContextProps['renderStoryToElement'],
|
|
310
320
|
/** The CSF files known (via the index) to be refererenced by this docs file */
|
|
311
|
-
csfFiles:
|
|
312
|
-
referenceCSFFile(csfFile:
|
|
313
|
-
setMeta(metaExports:
|
|
314
|
-
storyIdByModuleExport(storyExport:
|
|
321
|
+
csfFiles: CSFFile<TRenderer>[], componentStoriesFromAllCsfFiles?: boolean);
|
|
322
|
+
referenceCSFFile(csfFile: CSFFile<TRenderer>, addToComponentStories: boolean): void;
|
|
323
|
+
setMeta(metaExports: ModuleExports): void;
|
|
324
|
+
storyIdByModuleExport(storyExport: ModuleExport, metaExports?: ModuleExports): string;
|
|
315
325
|
storyIdByName: (storyName: StoryName) => string;
|
|
316
|
-
componentStories: () =>
|
|
317
|
-
storyById: (storyId?: StoryId) =>
|
|
318
|
-
getStoryContext: (story:
|
|
319
|
-
loadStory: (id: StoryId) => Promise<
|
|
326
|
+
componentStories: () => PreparedStory<TRenderer>[];
|
|
327
|
+
storyById: (storyId?: StoryId) => PreparedStory<TRenderer>;
|
|
328
|
+
getStoryContext: (story: PreparedStory<TRenderer>) => StoryContextForLoaders<TRenderer, _storybook_types.Args>;
|
|
329
|
+
loadStory: (id: StoryId) => Promise<PreparedStory<TRenderer>>;
|
|
320
330
|
}
|
|
321
331
|
|
|
322
332
|
export { DocsContext as D, Preview as P, simulateDOMContentLoaded as a, PreviewWeb as b, PreviewWithSelection as c, simulatePageLoad as s };
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import * as _storybook_types from '@storybook/types';
|
|
2
|
+
import { StoryId, StoryName, ComponentTitle, StoryIndex, IndexEntry, Path, Args, PreparedStory, Globals, GlobalTypes, Renderer, ModuleExports, CSFFile, NormalizedStoryAnnotations, NormalizedComponentAnnotations, NormalizedProjectAnnotations, ModuleImportFn, ProjectAnnotations, StoryContextForLoaders, StoryContextForEnhancers, Parameters, StoryIndexV3, API_PreparedStoryIndex, BoundStory } from '@storybook/types';
|
|
3
|
+
import { SynchronousPromise } from 'synchronous-promise';
|
|
4
|
+
import { H as HooksContext } from './hooks-dd6bc7a8.js';
|
|
5
|
+
|
|
6
|
+
type StorySpecifier = StoryId | {
|
|
7
|
+
name: StoryName;
|
|
8
|
+
title: ComponentTitle;
|
|
9
|
+
} | '*';
|
|
10
|
+
declare class StoryIndexStore {
|
|
11
|
+
entries: StoryIndex['entries'];
|
|
12
|
+
constructor({ entries }?: StoryIndex);
|
|
13
|
+
entryFromSpecifier(specifier: StorySpecifier): IndexEntry | undefined;
|
|
14
|
+
storyIdToEntry(storyId: StoryId): IndexEntry;
|
|
15
|
+
importPathToEntry(importPath: Path): IndexEntry;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
declare class ArgsStore {
|
|
19
|
+
initialArgsByStoryId: Record<StoryId, Args>;
|
|
20
|
+
argsByStoryId: Record<StoryId, Args>;
|
|
21
|
+
get(storyId: StoryId): Args;
|
|
22
|
+
setInitial(story: PreparedStory<any>): void;
|
|
23
|
+
updateFromDelta(story: PreparedStory<any>, delta: Args): void;
|
|
24
|
+
updateFromPersisted(story: PreparedStory<any>, persisted: Args): void;
|
|
25
|
+
update(storyId: StoryId, argsUpdate: Partial<Args>): void;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
declare class GlobalsStore {
|
|
29
|
+
allowedGlobalNames: Set<string>;
|
|
30
|
+
initialGlobals: Globals;
|
|
31
|
+
globals: Globals;
|
|
32
|
+
constructor({ globals, globalTypes, }: {
|
|
33
|
+
globals?: Globals;
|
|
34
|
+
globalTypes?: GlobalTypes;
|
|
35
|
+
});
|
|
36
|
+
set({ globals, globalTypes }: {
|
|
37
|
+
globals?: Globals;
|
|
38
|
+
globalTypes?: GlobalTypes;
|
|
39
|
+
}): void;
|
|
40
|
+
filterAllowedGlobals(globals: Globals): Globals;
|
|
41
|
+
updateFromPersisted(persisted: Globals): void;
|
|
42
|
+
get(): Globals;
|
|
43
|
+
update(newGlobals: Globals): void;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
declare function processCSFFile<TRenderer extends Renderer>(moduleExports: ModuleExports, importPath: Path, title: ComponentTitle): CSFFile<TRenderer>;
|
|
47
|
+
|
|
48
|
+
declare function prepareStory<TRenderer extends Renderer>(storyAnnotations: NormalizedStoryAnnotations<TRenderer>, componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations<TRenderer>): PreparedStory<TRenderer>;
|
|
49
|
+
|
|
50
|
+
declare class StoryStore<TRenderer extends Renderer> {
|
|
51
|
+
storyIndex?: StoryIndexStore;
|
|
52
|
+
importFn?: ModuleImportFn;
|
|
53
|
+
projectAnnotations?: NormalizedProjectAnnotations<TRenderer>;
|
|
54
|
+
globals?: GlobalsStore;
|
|
55
|
+
args: ArgsStore;
|
|
56
|
+
hooks: Record<StoryId, HooksContext<TRenderer>>;
|
|
57
|
+
cachedCSFFiles?: Record<Path, CSFFile<TRenderer>>;
|
|
58
|
+
processCSFFileWithCache: typeof processCSFFile;
|
|
59
|
+
prepareStoryWithCache: typeof prepareStory;
|
|
60
|
+
initializationPromise: SynchronousPromise<void>;
|
|
61
|
+
resolveInitializationPromise: () => void;
|
|
62
|
+
constructor();
|
|
63
|
+
setProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): void;
|
|
64
|
+
initialize({ storyIndex, importFn, cache, }: {
|
|
65
|
+
storyIndex?: StoryIndex;
|
|
66
|
+
importFn: ModuleImportFn;
|
|
67
|
+
cache?: boolean;
|
|
68
|
+
}): Promise<void>;
|
|
69
|
+
onStoriesChanged({ importFn, storyIndex, }: {
|
|
70
|
+
importFn?: ModuleImportFn;
|
|
71
|
+
storyIndex?: StoryIndex;
|
|
72
|
+
}): Promise<void>;
|
|
73
|
+
storyIdToEntry(storyId: StoryId): Promise<IndexEntry>;
|
|
74
|
+
loadCSFFileByStoryId(storyId: StoryId): Promise<CSFFile<TRenderer>>;
|
|
75
|
+
loadAllCSFFiles(): Promise<StoryStore<TRenderer>['cachedCSFFiles']>;
|
|
76
|
+
cacheAllCSFFiles(): Promise<void>;
|
|
77
|
+
loadStory({ storyId }: {
|
|
78
|
+
storyId: StoryId;
|
|
79
|
+
}): Promise<PreparedStory<TRenderer>>;
|
|
80
|
+
storyFromCSFFile({ storyId, csfFile, }: {
|
|
81
|
+
storyId: StoryId;
|
|
82
|
+
csfFile: CSFFile<TRenderer>;
|
|
83
|
+
}): PreparedStory<TRenderer>;
|
|
84
|
+
componentStoriesFromCSFFile({ csfFile, }: {
|
|
85
|
+
csfFile: CSFFile<TRenderer>;
|
|
86
|
+
}): PreparedStory<TRenderer>[];
|
|
87
|
+
loadEntry(id: StoryId): Promise<{
|
|
88
|
+
entryExports: ModuleExports;
|
|
89
|
+
csfFiles: CSFFile<TRenderer>[];
|
|
90
|
+
}>;
|
|
91
|
+
getStoryContext(story: PreparedStory<TRenderer>): Omit<StoryContextForLoaders<TRenderer>, 'viewMode'>;
|
|
92
|
+
cleanupStory(story: PreparedStory<TRenderer>): void;
|
|
93
|
+
extract(options?: {
|
|
94
|
+
includeDocsOnly?: boolean;
|
|
95
|
+
}): Record<StoryId, StoryContextForEnhancers<TRenderer>>;
|
|
96
|
+
getSetStoriesPayload(): {
|
|
97
|
+
v: number;
|
|
98
|
+
globals: _storybook_types.Globals;
|
|
99
|
+
globalParameters: {};
|
|
100
|
+
kindParameters: Parameters;
|
|
101
|
+
stories: Record<string, StoryContextForEnhancers<TRenderer, _storybook_types.Args>>;
|
|
102
|
+
};
|
|
103
|
+
getStoriesJsonData: () => StoryIndexV3;
|
|
104
|
+
getSetIndexPayload(): API_PreparedStoryIndex;
|
|
105
|
+
raw(): BoundStory<TRenderer>[];
|
|
106
|
+
fromId(storyId: StoryId): BoundStory<TRenderer> | null;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
export { StoryStore as S, StorySpecifier as a, processCSFFile as b, prepareStory as p };
|
package/dist/addons.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { A as AddonStore, c as MakeDecoratorOptions, M as MakeDecoratorResult, a as addons, m as makeDecorator, b as mockChannel } from './storybook-channel-mock-
|
|
2
|
-
export { E as EventMap, H as HooksContext, L as Listener, k as applyHooks, u as useArgs, a as useCallback, b as useChannel, c as useEffect, d as useGlobals, e as useMemo, f as useParameter, g as useReducer, h as useRef, i as useState, j as useStoryContext } from './hooks-
|
|
1
|
+
export { A as AddonStore, c as MakeDecoratorOptions, M as MakeDecoratorResult, a as addons, m as makeDecorator, b as mockChannel } from './storybook-channel-mock-a19cd233.js';
|
|
2
|
+
export { E as EventMap, H as HooksContext, L as Listener, k as applyHooks, u as useArgs, a as useCallback, b as useChannel, c as useEffect, d as useGlobals, e as useMemo, f as useParameter, g as useReducer, h as useRef, i as useState, j as useStoryContext } from './hooks-dd6bc7a8.js';
|
|
3
3
|
import '@storybook/channels';
|
|
4
4
|
import '@storybook/types';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import{ClientApi}from"./chunk-
|
|
1
|
+
import{ClientApi}from"./chunk-RLLOFRQR.mjs";import{PreviewWeb}from"./chunk-FU7XW5ZS.mjs";import{addons}from"./chunk-QSH26RWA.mjs";import global from"global";import{createChannel}from"@storybook/channel-postmessage";import{FORCE_RE_RENDER}from"@storybook/core-events";import{logger}from"@storybook/client-logger";function executeLoadable(loadable){let reqs=null;Array.isArray(loadable)?reqs=loadable:loadable.keys&&(reqs=[loadable]);let exportsMap=new Map;if(reqs)reqs.forEach(req=>{req.keys().forEach(filename=>{try{let fileExports=req(filename);exportsMap.set(typeof req.resolve=="function"?req.resolve(filename):filename,fileExports)}catch(error){let errorString=error.message&&error.stack?`${error.message}
|
|
2
2
|
${error.stack}`:error.toString();logger.error(`Unexpected error while loading ${filename}: ${errorString}`)}})});else{let exported=loadable();Array.isArray(exported)&&exported.every(obj=>obj.default!=null)?exportsMap=new Map(exported.map((fileExports,index)=>[`exports-map-${index}`,fileExports])):exported&&logger.warn(`Loader function passed to 'configure' should return void or an array of module exports that all contain a 'default' export. Received: ${JSON.stringify(exported)}`)}return exportsMap}function executeLoadableForChanges(loadable,m){let lastExportsMap=m?.hot?.data?.lastExportsMap||new Map;m?.hot?.dispose&&(m.hot.accept(),m.hot.dispose(data=>{data.lastExportsMap=lastExportsMap}));let exportsMap=executeLoadable(loadable),added=new Map;Array.from(exportsMap.entries()).filter(([,fileExports])=>!!fileExports.default).filter(([fileName,fileExports])=>lastExportsMap.get(fileName)!==fileExports).forEach(([fileName,fileExports])=>added.set(fileName,fileExports));let removed=new Map;return Array.from(lastExportsMap.keys()).filter(fileName=>!exportsMap.has(fileName)).forEach(fileName=>{let value=lastExportsMap.get(fileName);value&&removed.set(fileName,value)}),lastExportsMap=exportsMap,{added,removed}}var{window:globalWindow,FEATURES}=global,removedApi=name=>()=>{throw new Error(`@storybook/client-api:${name} was removed in storyStoreV7.`)};function start(renderToCanvas,{decorateStory,render}={}){if(globalWindow&&(globalWindow.IS_STORYBOOK=!0),FEATURES?.storyStoreV7)return{forceReRender:removedApi("forceReRender"),configure:removedApi("configure"),clientApi:{storiesOf:removedApi("clientApi.storiesOf"),raw:removedApi("raw")}};let channel=createChannel({page:"preview"});addons.setChannel(channel);let clientApi=new ClientApi,preview=new PreviewWeb,initialized=!1,importFn=path=>clientApi.importFn(path);function onStoriesChanged(){let storyIndex=clientApi.getStoryIndex();preview.onStoriesChanged({storyIndex,importFn})}return clientApi.onImportFnChanged=onStoriesChanged,clientApi.storyStore=preview.storyStore,globalWindow&&(globalWindow.__STORYBOOK_CLIENT_API__=clientApi,globalWindow.__STORYBOOK_ADDONS_CHANNEL__=channel,globalWindow.__STORYBOOK_PREVIEW__=preview,globalWindow.__STORYBOOK_STORY_STORE__=preview.storyStore),{forceReRender:()=>channel.emit(FORCE_RE_RENDER),clientApi,configure(framework,loadable,m,disableBackwardCompatibility=!0){if(disableBackwardCompatibility)throw new Error("unexpected configure() call");clientApi.addParameters({framework});let getProjectAnnotations=()=>{let{added,removed}=executeLoadableForChanges(loadable,m);return clientApi._loadAddedExports(),Array.from(added.entries()).forEach(([fileName,fileExports])=>clientApi.facade.addStoriesFromExports(fileName,fileExports)),Array.from(removed.entries()).forEach(([fileName])=>clientApi.facade.clearFilenameExports(fileName)),{render,...clientApi.facade.projectAnnotations,renderToCanvas,applyDecorators:decorateStory}};initialized?(getProjectAnnotations(),onStoriesChanged()):(preview.initialize({getStoryIndex:()=>clientApi.getStoryIndex(),importFn,getProjectAnnotations}),initialized=!0)}}}export{start};
|