storybook 9.0.0-alpha.12 → 9.0.0-alpha.13
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/assets/docs/addon-backgrounds.gif +0 -0
- package/assets/docs/highlight.png +0 -0
- package/dist/backgrounds/index.cjs +148 -0
- package/dist/backgrounds/index.d.ts +91 -0
- package/dist/backgrounds/index.js +130 -0
- package/dist/backgrounds/preview.cjs +143 -0
- package/dist/backgrounds/preview.d.ts +54 -0
- package/dist/backgrounds/preview.js +127 -0
- package/dist/bin/index.cjs +63 -71
- package/dist/bin/index.js +53 -61
- package/dist/builder-manager/index.cjs +390 -380
- package/dist/builder-manager/index.js +489 -479
- package/dist/cli/bin/index.cjs +225 -225
- package/dist/cli/bin/index.js +234 -234
- package/dist/cli/index.cjs +0 -2
- package/dist/cli/index.js +0 -2
- package/dist/common/index.cjs +2399 -2378
- package/dist/common/index.d.ts +0 -8
- package/dist/common/index.js +2607 -2586
- package/dist/components/index.cjs +3394 -3372
- package/dist/components/index.js +3922 -3900
- package/dist/core-events/index.cjs +72 -84
- package/dist/core-events/index.d.ts +2 -77
- package/dist/core-events/index.js +61 -73
- package/dist/core-server/index.cjs +5258 -5168
- package/dist/core-server/index.js +6539 -6449
- package/dist/core-server/presets/common-manager.js +9815 -12
- package/dist/core-server/presets/common-preset.cjs +2809 -3005
- package/dist/core-server/presets/common-preset.js +2891 -3087
- package/dist/docs-tools/index.cjs +626 -600
- package/dist/docs-tools/index.js +613 -587
- package/dist/highlight/index.cjs +27 -0
- package/dist/highlight/index.d.ts +17 -0
- package/dist/highlight/index.js +7 -0
- package/dist/highlight/preview.cjs +81 -0
- package/dist/highlight/preview.d.ts +54 -0
- package/dist/highlight/preview.js +67 -0
- package/dist/instrumenter/index.cjs +70 -60
- package/dist/instrumenter/index.d.ts +8 -7
- package/dist/instrumenter/index.js +98 -88
- package/dist/manager/globals-module-info.cjs +12 -22
- package/dist/manager/globals-module-info.js +2 -12
- package/dist/manager/globals-runtime.js +24173 -23140
- package/dist/manager/runtime.js +3419 -3522
- package/dist/manager-api/index.cjs +1055 -1167
- package/dist/manager-api/index.d.ts +7 -21
- package/dist/manager-api/index.js +761 -877
- package/dist/measure/index.cjs +474 -0
- package/dist/measure/index.d.ts +66 -0
- package/dist/measure/index.js +462 -0
- package/dist/measure/preview.cjs +464 -0
- package/dist/measure/preview.d.ts +59 -0
- package/dist/measure/preview.js +448 -0
- package/dist/outline/index.cjs +528 -0
- package/dist/outline/index.d.ts +66 -0
- package/dist/outline/index.js +500 -0
- package/dist/outline/preview.cjs +518 -0
- package/dist/outline/preview.d.ts +59 -0
- package/dist/outline/preview.js +486 -0
- package/dist/preview/runtime.js +14441 -13330
- package/dist/preview-api/index.cjs +1067 -1071
- package/dist/preview-api/index.d.ts +61 -102
- package/dist/preview-api/index.js +1090 -1092
- package/dist/test/index.cjs +1547 -1546
- package/dist/test/index.js +2308 -2307
- package/dist/test/preview.cjs +1906 -1905
- package/dist/test/preview.d.ts +0 -6
- package/dist/test/preview.js +1439 -1438
- package/dist/test/spy.cjs +65 -64
- package/dist/test/spy.js +59 -58
- package/dist/types/index.cjs +10 -10
- package/dist/types/index.d.ts +206 -243
- package/package.json +121 -16
- package/dist/actions/manager.js +0 -1195
- package/dist/component-testing/manager.js +0 -3126
- package/dist/controls/manager.js +0 -5593
- package/dist/viewport/manager.js +0 -400
- /package/dist/{component-testing/manager.css → core-server/presets/common-manager.css} +0 -0
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Channel } from 'storybook/internal/channels';
|
|
2
2
|
import * as storybook_internal_types from 'storybook/internal/types';
|
|
3
|
-
import { ProjectAnnotations
|
|
4
|
-
import { CleanupCallback
|
|
3
|
+
import { ProjectAnnotations, Renderer, Args, StoryContext, DecoratorApplicator, StoryId, Addon_StoryWrapper, PreparedStory, Globals, GlobalTypes, StoryIndex, StoryName, ComponentTitle, IndexEntry, Path, StoryAnnotationsOrFn, NormalizedComponentAnnotations, NormalizedStoryAnnotations, ModuleExports, CSFFile, NormalizedProjectAnnotations, ModuleExport, PreparedMeta, StepRunner, ComposedStoryFn, Store_CSFExports, ComposeStoryFn, LegacyStoryAnnotationsOrFn, ComponentAnnotations, NamedOrDefaultProjectAnnotations, ModuleImportFn, StoryContextForEnhancers, Parameters, StrictArgTypes, ArgTypesEnhancer, LegacyStoryFn, DecoratorFunction, PartialStoryFn, StoryContextUpdate, NormalizedStoriesSpecifier, Addon_StorySortParameterV7, DocsContextProps, ResolvedModuleExportType, ResolvedModuleExportFromType, StoryRenderOptions, RenderContextCallbacks, RenderToCanvas, ViewMode } from 'storybook/internal/types';
|
|
4
|
+
import { CleanupCallback } from 'storybook/internal/csf';
|
|
5
5
|
import { RequestData, ArgTypesRequestPayload } from 'storybook/internal/core-events';
|
|
6
6
|
|
|
7
7
|
declare class AddonStore {
|
|
@@ -16,7 +16,7 @@ declare class AddonStore {
|
|
|
16
16
|
}
|
|
17
17
|
declare const addons: AddonStore;
|
|
18
18
|
|
|
19
|
-
declare function definePreview(config: ProjectAnnotations
|
|
19
|
+
declare function definePreview(config: ProjectAnnotations<Renderer>): ProjectAnnotations<Renderer>;
|
|
20
20
|
|
|
21
21
|
interface Hook {
|
|
22
22
|
name: string;
|
|
@@ -28,7 +28,7 @@ interface Effect {
|
|
|
28
28
|
destroy?: (() => void) | void;
|
|
29
29
|
}
|
|
30
30
|
type AbstractFunction = (...args: any[]) => any;
|
|
31
|
-
declare class HooksContext<TRenderer extends Renderer
|
|
31
|
+
declare class HooksContext<TRenderer extends Renderer, TArgs extends Args = Args> {
|
|
32
32
|
hookListsMap: WeakMap<AbstractFunction, Hook[]>;
|
|
33
33
|
mountedDecorators: Set<AbstractFunction>;
|
|
34
34
|
prevMountedDecorators: Set<AbstractFunction>;
|
|
@@ -49,7 +49,7 @@ declare class HooksContext<TRenderer extends Renderer$1, TArgs extends Args = Ar
|
|
|
49
49
|
addRenderListeners(): void;
|
|
50
50
|
removeRenderListeners(): void;
|
|
51
51
|
}
|
|
52
|
-
declare const applyHooks: <TRenderer extends Renderer
|
|
52
|
+
declare const applyHooks: <TRenderer extends Renderer>(applyDecorators: DecoratorApplicator<TRenderer>) => DecoratorApplicator<TRenderer>;
|
|
53
53
|
/**
|
|
54
54
|
* Returns a memoized value.
|
|
55
55
|
*
|
|
@@ -215,7 +215,7 @@ declare function useChannel(eventMap: EventMap, deps?: any[]): (eventName: strin
|
|
|
215
215
|
* @template TArgs The type of the story's args.
|
|
216
216
|
* @returns {StoryContext<TRenderer>} The current story context.
|
|
217
217
|
*/
|
|
218
|
-
declare function useStoryContext<TRenderer extends Renderer
|
|
218
|
+
declare function useStoryContext<TRenderer extends Renderer, TArgs extends Args = Args>(): StoryContext<TRenderer>;
|
|
219
219
|
/**
|
|
220
220
|
* Returns the value of a specific parameter for the current story, or a default value if the
|
|
221
221
|
* parameter is not set.
|
|
@@ -351,16 +351,16 @@ declare class StoryIndexStore {
|
|
|
351
351
|
importPathToEntry(importPath: Path): IndexEntry;
|
|
352
352
|
}
|
|
353
353
|
|
|
354
|
-
declare function normalizeStory<TRenderer extends Renderer
|
|
354
|
+
declare function normalizeStory<TRenderer extends Renderer>(key: StoryId, storyAnnotations: StoryAnnotationsOrFn<TRenderer>, meta: NormalizedComponentAnnotations<TRenderer>): NormalizedStoryAnnotations<TRenderer>;
|
|
355
355
|
|
|
356
|
-
declare function processCSFFile<TRenderer extends Renderer
|
|
356
|
+
declare function processCSFFile<TRenderer extends Renderer>(moduleExports: ModuleExports, importPath: Path, title: ComponentTitle): CSFFile<TRenderer>;
|
|
357
357
|
|
|
358
|
-
declare function prepareStory<TRenderer extends Renderer
|
|
359
|
-
declare function prepareMeta<TRenderer extends Renderer
|
|
358
|
+
declare function prepareStory<TRenderer extends Renderer>(storyAnnotations: NormalizedStoryAnnotations<TRenderer>, componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations<TRenderer>): PreparedStory<TRenderer>;
|
|
359
|
+
declare function prepareMeta<TRenderer extends Renderer>(componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations<TRenderer>, moduleExport: ModuleExport): PreparedMeta<TRenderer>;
|
|
360
360
|
|
|
361
|
-
declare function normalizeProjectAnnotations<TRenderer extends Renderer
|
|
361
|
+
declare function normalizeProjectAnnotations<TRenderer extends Renderer>({ argTypes, globalTypes, argTypesEnhancers, decorators, loaders, beforeEach, experimental_afterEach, initialGlobals, ...annotations }: ProjectAnnotations<TRenderer>): NormalizedProjectAnnotations<TRenderer>;
|
|
362
362
|
|
|
363
|
-
declare function composeConfigs<TRenderer extends Renderer
|
|
363
|
+
declare function composeConfigs<TRenderer extends Renderer>(input: ModuleExports[]): NormalizedProjectAnnotations<TRenderer>;
|
|
364
364
|
|
|
365
365
|
/**
|
|
366
366
|
* Compose step runners to create a single step runner that applies each step runner in order.
|
|
@@ -386,16 +386,16 @@ declare function composeConfigs<TRenderer extends Renderer$1>(moduleExportList:
|
|
|
386
386
|
* @param stepRunners An array of StepRunner
|
|
387
387
|
* @returns A StepRunner that is the composition of the arguments
|
|
388
388
|
*/
|
|
389
|
-
declare function composeStepRunners<TRenderer extends Renderer
|
|
389
|
+
declare function composeStepRunners<TRenderer extends Renderer>(stepRunners: StepRunner<TRenderer>[]): StepRunner<TRenderer>;
|
|
390
390
|
|
|
391
391
|
declare global {
|
|
392
|
-
var globalProjectAnnotations: NormalizedProjectAnnotations
|
|
393
|
-
var defaultProjectAnnotations: ProjectAnnotations
|
|
392
|
+
var globalProjectAnnotations: NormalizedProjectAnnotations<any>;
|
|
393
|
+
var defaultProjectAnnotations: ProjectAnnotations<any>;
|
|
394
394
|
}
|
|
395
|
-
declare function setDefaultProjectAnnotations<TRenderer extends Renderer
|
|
396
|
-
declare function setProjectAnnotations<TRenderer extends Renderer
|
|
397
|
-
declare function composeStory<TRenderer extends Renderer
|
|
398
|
-
declare function composeStories<TModule extends Store_CSFExports>(storiesImport: TModule, globalConfig: ProjectAnnotations
|
|
395
|
+
declare function setDefaultProjectAnnotations<TRenderer extends Renderer = Renderer>(_defaultProjectAnnotations: ProjectAnnotations<TRenderer>): void;
|
|
396
|
+
declare function setProjectAnnotations<TRenderer extends Renderer = Renderer>(projectAnnotations: NamedOrDefaultProjectAnnotations<TRenderer> | NamedOrDefaultProjectAnnotations<TRenderer>[]): NormalizedProjectAnnotations<TRenderer>;
|
|
397
|
+
declare function composeStory<TRenderer extends Renderer = Renderer, TArgs extends Args = Args>(storyAnnotations: LegacyStoryAnnotationsOrFn<TRenderer>, componentAnnotations: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations?: ProjectAnnotations<TRenderer>, defaultConfig?: ProjectAnnotations<TRenderer>, exportsName?: string): ComposedStoryFn<TRenderer, Partial<TArgs>>;
|
|
398
|
+
declare function composeStories<TModule extends Store_CSFExports>(storiesImport: TModule, globalConfig: ProjectAnnotations<Renderer>, composeStoryFn?: ComposeStoryFn): {};
|
|
399
399
|
type WrappedStoryRef = {
|
|
400
400
|
__pw_type: 'jsx' | 'importRef';
|
|
401
401
|
};
|
|
@@ -411,14 +411,14 @@ declare function createPlaywrightTest<TFixture extends {
|
|
|
411
411
|
extend: any;
|
|
412
412
|
}>(baseTest: TFixture): TFixture;
|
|
413
413
|
|
|
414
|
-
declare function getCsfFactoryAnnotations<TRenderer extends Renderer
|
|
415
|
-
story: storybook_internal_types.StoryAnnotations<Renderer
|
|
416
|
-
meta: ComponentAnnotations<Renderer
|
|
417
|
-
preview: storybook_internal_types.NormalizedProjectAnnotations<Renderer
|
|
414
|
+
declare function getCsfFactoryAnnotations<TRenderer extends Renderer = Renderer, TArgs extends Args = Args>(story: LegacyStoryAnnotationsOrFn<TRenderer>, meta?: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations?: ProjectAnnotations<TRenderer>): {
|
|
415
|
+
story: storybook_internal_types.StoryAnnotations<Renderer, Args>;
|
|
416
|
+
meta: ComponentAnnotations<Renderer, Args>;
|
|
417
|
+
preview: storybook_internal_types.NormalizedProjectAnnotations<Renderer>;
|
|
418
418
|
} | {
|
|
419
419
|
story: LegacyStoryAnnotationsOrFn<TRenderer>;
|
|
420
420
|
meta: ComponentAnnotations<TRenderer, TArgs> | undefined;
|
|
421
|
-
preview: ProjectAnnotations
|
|
421
|
+
preview: ProjectAnnotations<TRenderer> | undefined;
|
|
422
422
|
};
|
|
423
423
|
|
|
424
424
|
interface Report<T = unknown> {
|
|
@@ -432,10 +432,10 @@ declare class ReporterAPI {
|
|
|
432
432
|
addReport(report: Report): Promise<void>;
|
|
433
433
|
}
|
|
434
434
|
|
|
435
|
-
declare class StoryStore<TRenderer extends Renderer
|
|
435
|
+
declare class StoryStore<TRenderer extends Renderer> {
|
|
436
436
|
importFn: ModuleImportFn;
|
|
437
437
|
storyIndex: StoryIndexStore;
|
|
438
|
-
projectAnnotations: NormalizedProjectAnnotations
|
|
438
|
+
projectAnnotations: NormalizedProjectAnnotations<TRenderer>;
|
|
439
439
|
userGlobals: GlobalsStore;
|
|
440
440
|
args: ArgsStore;
|
|
441
441
|
hooks: Record<StoryId, HooksContext<TRenderer>>;
|
|
@@ -444,8 +444,8 @@ declare class StoryStore<TRenderer extends Renderer$1> {
|
|
|
444
444
|
processCSFFileWithCache: typeof processCSFFile;
|
|
445
445
|
prepareMetaWithCache: typeof prepareMeta;
|
|
446
446
|
prepareStoryWithCache: typeof prepareStory;
|
|
447
|
-
constructor(storyIndex: StoryIndex, importFn: ModuleImportFn, projectAnnotations: ProjectAnnotations
|
|
448
|
-
setProjectAnnotations(projectAnnotations: ProjectAnnotations
|
|
447
|
+
constructor(storyIndex: StoryIndex, importFn: ModuleImportFn, projectAnnotations: ProjectAnnotations<TRenderer>);
|
|
448
|
+
setProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): void;
|
|
449
449
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
450
450
|
importFn?: ModuleImportFn;
|
|
451
451
|
storyIndex?: StoryIndex;
|
|
@@ -489,12 +489,12 @@ declare class StoryStore<TRenderer extends Renderer$1> {
|
|
|
489
489
|
subcomponents?: Record<string, (TRenderer & {
|
|
490
490
|
T: any;
|
|
491
491
|
})["component"]> | undefined;
|
|
492
|
-
parameters: Parameters;
|
|
492
|
+
parameters: storybook_internal_types.Parameters;
|
|
493
493
|
initialArgs: storybook_internal_types.Args;
|
|
494
494
|
argTypes: storybook_internal_types.StrictArgTypes<storybook_internal_types.Args>;
|
|
495
495
|
componentId: storybook_internal_types.ComponentId;
|
|
496
|
-
title: ComponentTitle;
|
|
497
|
-
kind: ComponentTitle;
|
|
496
|
+
title: storybook_internal_types.ComponentTitle;
|
|
497
|
+
kind: storybook_internal_types.ComponentTitle;
|
|
498
498
|
id: StoryId;
|
|
499
499
|
name: storybook_internal_types.StoryName;
|
|
500
500
|
story: storybook_internal_types.StoryName;
|
|
@@ -513,7 +513,7 @@ declare class StoryStore<TRenderer extends Renderer$1> {
|
|
|
513
513
|
renderToCanvas?: storybook_internal_types.RenderToCanvas<TRenderer> | undefined;
|
|
514
514
|
usesMount: boolean;
|
|
515
515
|
storyGlobals: storybook_internal_types.Globals;
|
|
516
|
-
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer
|
|
516
|
+
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer, storybook_internal_types.Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
517
517
|
addCleanupCallbacks(story: PreparedStory<TRenderer>, callbacks: CleanupCallback[]): void;
|
|
518
518
|
cleanupStory(story: PreparedStory<TRenderer>): Promise<void>;
|
|
519
519
|
extract(options?: {
|
|
@@ -531,9 +531,9 @@ declare const combineParameters: (...parameterSets: (Parameters | undefined)[])
|
|
|
531
531
|
type PropDescriptor = string[] | RegExp;
|
|
532
532
|
declare const filterArgTypes: (argTypes: StrictArgTypes, include?: PropDescriptor, exclude?: PropDescriptor) => Partial<StrictArgTypes<storybook_internal_types.Args>>;
|
|
533
533
|
|
|
534
|
-
declare const inferControls: ArgTypesEnhancer<Renderer
|
|
534
|
+
declare const inferControls: ArgTypesEnhancer<Renderer>;
|
|
535
535
|
|
|
536
|
-
declare function decorateStory<TRenderer extends Renderer
|
|
536
|
+
declare function decorateStory<TRenderer extends Renderer>(storyFn: LegacyStoryFn<TRenderer>, decorator: DecoratorFunction<TRenderer>, bindWithContext: (storyFn: LegacyStoryFn<TRenderer>) => PartialStoryFn<TRenderer>): LegacyStoryFn<TRenderer>;
|
|
537
537
|
/**
|
|
538
538
|
* Currently StoryContextUpdates are allowed to have any key in the type. However, you cannot
|
|
539
539
|
* overwrite any of the build-it "static" keys.
|
|
@@ -542,7 +542,7 @@ declare function decorateStory<TRenderer extends Renderer$1>(storyFn: LegacyStor
|
|
|
542
542
|
* @returns StoryContextUpdate
|
|
543
543
|
*/
|
|
544
544
|
declare function sanitizeStoryContextUpdate({ componentId, title, kind, id, name, story, parameters, initialArgs, argTypes, ...update }?: StoryContextUpdate): StoryContextUpdate;
|
|
545
|
-
declare function defaultDecorateStory<TRenderer extends Renderer
|
|
545
|
+
declare function defaultDecorateStory<TRenderer extends Renderer>(storyFn: LegacyStoryFn<TRenderer>, decorators: DecoratorFunction<TRenderer>[]): LegacyStoryFn<TRenderer>;
|
|
546
546
|
|
|
547
547
|
declare const combineArgs: (value: any, update: any) => Args;
|
|
548
548
|
|
|
@@ -551,7 +551,7 @@ declare const userOrAutoTitle: (fileName: string, storiesEntries: NormalizedStor
|
|
|
551
551
|
|
|
552
552
|
declare const sortStoriesV7: (stories: IndexEntry[], storySortParameter: Addon_StorySortParameterV7, fileNameOrder: Path[]) => IndexEntry[];
|
|
553
553
|
|
|
554
|
-
declare class DocsContext<TRenderer extends Renderer
|
|
554
|
+
declare class DocsContext<TRenderer extends Renderer> implements DocsContextProps<TRenderer> {
|
|
555
555
|
channel: Channel;
|
|
556
556
|
protected store: StoryStore<TRenderer>;
|
|
557
557
|
renderStoryToElement: DocsContextProps<TRenderer>['renderStoryToElement'];
|
|
@@ -634,7 +634,7 @@ type RenderType = 'story' | 'docs';
|
|
|
634
634
|
* - Tracking the state of the rendering as it moves between preparing, rendering and tearing down.
|
|
635
635
|
* - Tracking what is rendered to know if a change requires re-rendering or teardown + recreation.
|
|
636
636
|
*/
|
|
637
|
-
interface Render<TRenderer extends Renderer
|
|
637
|
+
interface Render<TRenderer extends Renderer> {
|
|
638
638
|
type: RenderType;
|
|
639
639
|
id: StoryId;
|
|
640
640
|
isPreparing: () => boolean;
|
|
@@ -658,7 +658,7 @@ interface Render<TRenderer extends Renderer$1> {
|
|
|
658
658
|
*
|
|
659
659
|
* - Autodocs, where there is no story, and we fall back to the globally defined template.
|
|
660
660
|
*/
|
|
661
|
-
declare class CsfDocsRender<TRenderer extends Renderer
|
|
661
|
+
declare class CsfDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
662
662
|
protected channel: Channel;
|
|
663
663
|
protected store: StoryStore<TRenderer>;
|
|
664
664
|
entry: IndexEntry;
|
|
@@ -696,7 +696,7 @@ declare class CsfDocsRender<TRenderer extends Renderer$1> implements Render<TRen
|
|
|
696
696
|
*
|
|
697
697
|
* - *.mdx file that may or may not reference a specific CSF file with `<Meta of={} />`
|
|
698
698
|
*/
|
|
699
|
-
declare class MdxDocsRender<TRenderer extends Renderer
|
|
699
|
+
declare class MdxDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
700
700
|
protected channel: Channel;
|
|
701
701
|
protected store: StoryStore<TRenderer>;
|
|
702
702
|
entry: IndexEntry;
|
|
@@ -725,7 +725,7 @@ declare class MdxDocsRender<TRenderer extends Renderer$1> implements Render<TRen
|
|
|
725
725
|
}
|
|
726
726
|
|
|
727
727
|
type RenderPhase = 'preparing' | 'loading' | 'beforeEach' | 'rendering' | 'playing' | 'played' | 'afterEach' | 'completed' | 'finished' | 'aborted' | 'errored';
|
|
728
|
-
declare class StoryRender<TRenderer extends Renderer
|
|
728
|
+
declare class StoryRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
729
729
|
channel: Channel;
|
|
730
730
|
store: StoryStore<TRenderer>;
|
|
731
731
|
private renderToScreen;
|
|
@@ -743,7 +743,7 @@ declare class StoryRender<TRenderer extends Renderer$1> implements Render<TRende
|
|
|
743
743
|
disableKeyListeners: boolean;
|
|
744
744
|
private teardownRender;
|
|
745
745
|
torndown: boolean;
|
|
746
|
-
constructor(channel: Channel, store: StoryStore<TRenderer>, renderToScreen: RenderToCanvas
|
|
746
|
+
constructor(channel: Channel, store: StoryStore<TRenderer>, renderToScreen: RenderToCanvas<TRenderer>, callbacks: RenderContextCallbacks<TRenderer> & {
|
|
747
747
|
showStoryDuringRender?: () => void;
|
|
748
748
|
}, id: StoryId, viewMode: StoryContext<TRenderer>['viewMode'], renderOptions?: StoryRenderOptions, story?: PreparedStory<TRenderer>);
|
|
749
749
|
private runPhase;
|
|
@@ -770,13 +770,13 @@ declare class StoryRender<TRenderer extends Renderer$1> implements Render<TRende
|
|
|
770
770
|
teardown(): Promise<void>;
|
|
771
771
|
}
|
|
772
772
|
|
|
773
|
-
type MaybePromise
|
|
774
|
-
declare class Preview<TRenderer extends Renderer
|
|
773
|
+
type MaybePromise<T> = Promise<T> | T;
|
|
774
|
+
declare class Preview<TRenderer extends Renderer> {
|
|
775
775
|
importFn: ModuleImportFn;
|
|
776
|
-
getProjectAnnotations: () => MaybePromise
|
|
776
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
777
777
|
protected channel: Channel;
|
|
778
778
|
protected storyStoreValue?: StoryStore<TRenderer>;
|
|
779
|
-
renderToCanvas?: RenderToCanvas
|
|
779
|
+
renderToCanvas?: RenderToCanvas<TRenderer>;
|
|
780
780
|
storyRenders: StoryRender<TRenderer>[];
|
|
781
781
|
previewEntryError?: Error;
|
|
782
782
|
private projectAnnotationsBeforeInitialization?;
|
|
@@ -784,20 +784,20 @@ declare class Preview<TRenderer extends Renderer$1> {
|
|
|
784
784
|
protected storeInitializationPromise: Promise<void>;
|
|
785
785
|
protected resolveStoreInitializationPromise: () => void;
|
|
786
786
|
protected rejectStoreInitializationPromise: (err: Error) => void;
|
|
787
|
-
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise
|
|
787
|
+
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>, channel?: Channel, shouldInitialize?: boolean);
|
|
788
788
|
get storyStore(): StoryStore<TRenderer>;
|
|
789
789
|
protected initialize(): Promise<void>;
|
|
790
790
|
ready(): Promise<void>;
|
|
791
791
|
setupListeners(): void;
|
|
792
|
-
getProjectAnnotationsOrRenderError(): Promise<ProjectAnnotations
|
|
793
|
-
initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations
|
|
794
|
-
runBeforeAllHook(projectAnnotations: ProjectAnnotations
|
|
792
|
+
getProjectAnnotationsOrRenderError(): Promise<ProjectAnnotations<TRenderer>>;
|
|
793
|
+
initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): Promise<void>;
|
|
794
|
+
runBeforeAllHook(projectAnnotations: ProjectAnnotations<TRenderer>): Promise<void>;
|
|
795
795
|
getStoryIndexFromServer(): Promise<StoryIndex>;
|
|
796
796
|
protected initializeWithStoryIndex(storyIndex: StoryIndex): void;
|
|
797
797
|
setInitialGlobals(): Promise<void>;
|
|
798
798
|
emitGlobals(): void;
|
|
799
799
|
onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
|
|
800
|
-
getProjectAnnotations: () => MaybePromise
|
|
800
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
801
801
|
}): Promise<void>;
|
|
802
802
|
onStoryIndexChanged(): Promise<void>;
|
|
803
803
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
@@ -867,10 +867,10 @@ declare class Preview<TRenderer extends Renderer$1> {
|
|
|
867
867
|
runStep: storybook_internal_types.StepRunner<TRenderer>;
|
|
868
868
|
mount: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => () => Promise<storybook_internal_types.Canvas>;
|
|
869
869
|
testingLibraryRender?: (...args: never[]) => unknown;
|
|
870
|
-
renderToCanvas?: RenderToCanvas
|
|
870
|
+
renderToCanvas?: RenderToCanvas<TRenderer> | undefined;
|
|
871
871
|
usesMount: boolean;
|
|
872
872
|
storyGlobals: Globals;
|
|
873
|
-
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer
|
|
873
|
+
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer, Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
874
874
|
extract(options?: {
|
|
875
875
|
includeDocsOnly: boolean;
|
|
876
876
|
}): Promise<Record<string, storybook_internal_types.StoryContextForEnhancers<TRenderer, Args>>>;
|
|
@@ -914,21 +914,21 @@ interface View<TStorybookRoot> {
|
|
|
914
914
|
showStoryDuringRender(): void;
|
|
915
915
|
}
|
|
916
916
|
|
|
917
|
-
type PossibleRender<TRenderer extends Renderer
|
|
918
|
-
declare class PreviewWithSelection<TRenderer extends Renderer
|
|
917
|
+
type PossibleRender<TRenderer extends Renderer> = StoryRender<TRenderer> | CsfDocsRender<TRenderer> | MdxDocsRender<TRenderer>;
|
|
918
|
+
declare class PreviewWithSelection<TRenderer extends Renderer> extends Preview<TRenderer> {
|
|
919
919
|
importFn: ModuleImportFn;
|
|
920
|
-
getProjectAnnotations: () => MaybePromise
|
|
920
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
921
921
|
selectionStore: SelectionStore;
|
|
922
922
|
view: View<TRenderer['canvasElement']>;
|
|
923
923
|
currentSelection?: Selection;
|
|
924
924
|
currentRender?: PossibleRender<TRenderer>;
|
|
925
|
-
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise
|
|
925
|
+
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>, selectionStore: SelectionStore, view: View<TRenderer['canvasElement']>);
|
|
926
926
|
setupListeners(): void;
|
|
927
927
|
setInitialGlobals(): Promise<void>;
|
|
928
928
|
initializeWithStoryIndex(storyIndex: StoryIndex): Promise<void>;
|
|
929
929
|
selectSpecifiedStory(): Promise<void>;
|
|
930
930
|
onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
|
|
931
|
-
getProjectAnnotations: () => MaybePromise
|
|
931
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
932
932
|
}): Promise<void>;
|
|
933
933
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
934
934
|
importFn?: ModuleImportFn;
|
|
@@ -975,10 +975,10 @@ declare class PreviewWithSelection<TRenderer extends Renderer$1> extends Preview
|
|
|
975
975
|
}): void;
|
|
976
976
|
}
|
|
977
977
|
|
|
978
|
-
declare class PreviewWeb<TRenderer extends Renderer
|
|
978
|
+
declare class PreviewWeb<TRenderer extends Renderer> extends PreviewWithSelection<TRenderer> {
|
|
979
979
|
importFn: ModuleImportFn;
|
|
980
|
-
getProjectAnnotations: () => MaybePromise
|
|
981
|
-
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise
|
|
980
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
981
|
+
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>);
|
|
982
982
|
}
|
|
983
983
|
|
|
984
984
|
declare class UrlStore implements SelectionStore {
|
|
@@ -1034,47 +1034,6 @@ declare class WebView implements View<HTMLElement> {
|
|
|
1034
1034
|
declare function simulateDOMContentLoaded(): void;
|
|
1035
1035
|
declare function simulatePageLoad($container: any): void;
|
|
1036
1036
|
|
|
1037
|
-
declare global {
|
|
1038
|
-
interface SymbolConstructor {
|
|
1039
|
-
readonly observable: symbol;
|
|
1040
|
-
}
|
|
1041
|
-
}
|
|
1042
|
-
|
|
1043
|
-
interface Renderer extends Renderer$2 {
|
|
1044
|
-
}
|
|
1045
|
-
|
|
1046
|
-
type MaybePromise<T> = Promise<T> | T;
|
|
1047
|
-
type TeardownRenderToCanvas = () => MaybePromise<void>;
|
|
1048
|
-
type RenderToCanvas<TRenderer extends Renderer> = (context: RenderContext<TRenderer>, element: TRenderer['canvasElement']) => MaybePromise<void | TeardownRenderToCanvas>;
|
|
1049
|
-
interface ProjectAnnotations<TRenderer extends Renderer> extends ProjectAnnotations$2<TRenderer> {
|
|
1050
|
-
addons?: ProjectAnnotations<TRenderer>[];
|
|
1051
|
-
testingLibraryRender?: (...args: never[]) => {
|
|
1052
|
-
unmount: () => void;
|
|
1053
|
-
};
|
|
1054
|
-
renderToCanvas?: RenderToCanvas<TRenderer>;
|
|
1055
|
-
}
|
|
1056
|
-
type NormalizedProjectAnnotations<TRenderer extends Renderer = Renderer> = Omit<ProjectAnnotations<TRenderer>, 'decorators' | 'loaders' | 'runStep' | 'beforeAll'> & {
|
|
1057
|
-
argTypes?: StrictArgTypes$1;
|
|
1058
|
-
globalTypes?: StrictGlobalTypes;
|
|
1059
|
-
decorators?: DecoratorFunction$1<TRenderer>[];
|
|
1060
|
-
loaders?: LoaderFunction<TRenderer>[];
|
|
1061
|
-
runStep: StepRunner$1<TRenderer>;
|
|
1062
|
-
beforeAll: BeforeAll;
|
|
1063
|
-
};
|
|
1064
|
-
declare type RenderContext<TRenderer extends Renderer = Renderer> = StoryIdentifier & {
|
|
1065
|
-
showMain: () => void;
|
|
1066
|
-
showError: (error: {
|
|
1067
|
-
title: string;
|
|
1068
|
-
description: string;
|
|
1069
|
-
}) => void;
|
|
1070
|
-
showException: (err: Error) => void;
|
|
1071
|
-
forceRemount: boolean;
|
|
1072
|
-
storyContext: StoryContext$1<TRenderer>;
|
|
1073
|
-
storyFn: PartialStoryFn$1<TRenderer>;
|
|
1074
|
-
unboundStoryFn: LegacyStoryFn$1<TRenderer>;
|
|
1075
|
-
};
|
|
1076
|
-
|
|
1077
1037
|
declare function getCoreAnnotations(): any[];
|
|
1078
|
-
declare function getComposedCoreAnnotations<TRenderer extends Renderer$1>(): NormalizedProjectAnnotations<TRenderer>;
|
|
1079
1038
|
|
|
1080
|
-
export { DocsContext, HooksContext, Preview, PreviewWeb, PreviewWithSelection, type PropDescriptor, type Report, ReporterAPI, type SelectionStore, StoryStore, UrlStore, type View, WebView, addons, applyHooks, combineArgs, combineParameters, composeConfigs, composeStepRunners, composeStories, composeStory, createPlaywrightTest, decorateStory, defaultDecorateStory, definePreview, filterArgTypes,
|
|
1039
|
+
export { DocsContext, HooksContext, Preview, PreviewWeb, PreviewWithSelection, type PropDescriptor, type Report, ReporterAPI, type SelectionStore, StoryStore, UrlStore, type View, WebView, addons, applyHooks, combineArgs, combineParameters, composeConfigs, composeStepRunners, composeStories, composeStory, createPlaywrightTest, decorateStory, defaultDecorateStory, definePreview, filterArgTypes, getCoreAnnotations, getCsfFactoryAnnotations, inferControls, makeDecorator, mockChannel, normalizeProjectAnnotations, normalizeStory, prepareMeta, prepareStory, sanitizeStoryContextUpdate, setDefaultProjectAnnotations, setProjectAnnotations, simulateDOMContentLoaded, simulatePageLoad, sortStoriesV7, useArgs, useCallback, useChannel, useEffect, useGlobals, useMemo, useParameter, useReducer, useRef, useState, useStoryContext, userOrAutoTitle, userOrAutoTitleFromSpecifier };
|