storybook 9.0.0-alpha.11 → 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/bin/index.cjs +2 -2
- package/dist/actions/preview.d.ts +0 -1
- 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 +49 -61
- package/dist/bin/index.js +49 -61
- package/dist/builder-manager/index.cjs +390 -380
- package/dist/builder-manager/index.js +489 -479
- package/dist/channels/index.cjs +17 -17
- package/dist/channels/index.js +3 -3
- package/dist/cli/bin/index.cjs +225 -225
- package/dist/cli/bin/index.js +234 -234
- package/dist/cli/index.cjs +1904 -1909
- package/dist/cli/index.d.ts +3 -7
- package/dist/cli/index.js +734 -739
- package/dist/common/index.cjs +2401 -2388
- package/dist/common/index.d.ts +1 -13
- package/dist/common/index.js +2609 -2596
- package/dist/components/index.cjs +5701 -5946
- package/dist/components/index.d.ts +3 -254
- package/dist/components/index.js +7271 -13724
- package/dist/controls/preview.d.ts +0 -1
- package/dist/core-events/index.cjs +91 -106
- package/dist/core-events/index.d.ts +2 -80
- package/dist/core-events/index.js +79 -94
- package/dist/core-server/index.cjs +5221 -5122
- package/dist/core-server/index.d.ts +32 -23
- package/dist/core-server/index.js +6511 -6412
- package/dist/core-server/presets/common-manager.js +9815 -12
- package/dist/core-server/presets/common-preset.cjs +2817 -2989
- package/dist/core-server/presets/common-preset.js +2896 -3068
- package/dist/csf/index.d.ts +0 -2
- package/dist/csf-tools/index.cjs +0 -8
- package/dist/csf-tools/index.d.ts +0 -4
- package/dist/csf-tools/index.js +0 -8
- 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 +21 -33
- package/dist/manager/globals-module-info.js +6 -18
- package/dist/manager/globals-runtime.js +22671 -22006
- package/dist/manager/runtime.js +4996 -4581
- package/dist/manager-api/index.cjs +1289 -1384
- package/dist/manager-api/index.d.ts +109 -114
- package/dist/manager-api/index.js +920 -1021
- 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 +14340 -13357
- package/dist/preview-api/index.cjs +1201 -1321
- package/dist/preview-api/index.d.ts +66 -120
- package/dist/preview-api/index.js +1546 -1665
- package/dist/telemetry/index.d.ts +1 -1
- 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 +11 -12
- package/dist/types/index.d.ts +502 -298
- package/dist/types/index.js +1 -2
- package/dist/viewport/preview.d.ts +0 -1
- package/package.json +124 -19
- package/dist/actions/manager.js +0 -1196
- package/dist/component-testing/manager.js +0 -3099
- package/dist/controls/manager.js +0 -5545
- 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;
|
|
@@ -503,32 +503,22 @@ declare class StoryStore<TRenderer extends Renderer$1> {
|
|
|
503
503
|
originalStoryFn: storybook_internal_types.ArgsStoryFn<TRenderer>;
|
|
504
504
|
undecoratedStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
505
505
|
unboundStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
506
|
-
applyLoaders: (context: StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<Record<string, any>>;
|
|
507
|
-
applyBeforeEach: (context: StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<CleanupCallback[]>;
|
|
508
|
-
applyAfterEach: (context: StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void>;
|
|
509
|
-
playFunction?: ((context: StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void> | void) | undefined;
|
|
506
|
+
applyLoaders: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<Record<string, any>>;
|
|
507
|
+
applyBeforeEach: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<CleanupCallback[]>;
|
|
508
|
+
applyAfterEach: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void>;
|
|
509
|
+
playFunction?: ((context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void> | void) | undefined;
|
|
510
510
|
runStep: storybook_internal_types.StepRunner<TRenderer>;
|
|
511
|
-
mount: (context: StoryContext<TRenderer, storybook_internal_types.Args>) => () => Promise<Canvas>;
|
|
511
|
+
mount: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => () => Promise<storybook_internal_types.Canvas>;
|
|
512
512
|
testingLibraryRender?: (...args: never[]) => unknown;
|
|
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?: {
|
|
520
520
|
includeDocsOnly?: boolean;
|
|
521
521
|
}): Record<StoryId, StoryContextForEnhancers<TRenderer>>;
|
|
522
|
-
getSetStoriesPayload(): {
|
|
523
|
-
v: number;
|
|
524
|
-
globals: storybook_internal_types.Globals;
|
|
525
|
-
globalParameters: {};
|
|
526
|
-
kindParameters: Parameters;
|
|
527
|
-
stories: Record<string, StoryContextForEnhancers<TRenderer, storybook_internal_types.Args>>;
|
|
528
|
-
};
|
|
529
|
-
getStoriesJsonData: () => StoryIndexV3;
|
|
530
|
-
raw(): BoundStory<TRenderer>[];
|
|
531
|
-
fromId(storyId: StoryId): BoundStory<TRenderer> | null;
|
|
532
522
|
}
|
|
533
523
|
|
|
534
524
|
/**
|
|
@@ -541,9 +531,9 @@ declare const combineParameters: (...parameterSets: (Parameters | undefined)[])
|
|
|
541
531
|
type PropDescriptor = string[] | RegExp;
|
|
542
532
|
declare const filterArgTypes: (argTypes: StrictArgTypes, include?: PropDescriptor, exclude?: PropDescriptor) => Partial<StrictArgTypes<storybook_internal_types.Args>>;
|
|
543
533
|
|
|
544
|
-
declare const inferControls: ArgTypesEnhancer<Renderer
|
|
534
|
+
declare const inferControls: ArgTypesEnhancer<Renderer>;
|
|
545
535
|
|
|
546
|
-
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>;
|
|
547
537
|
/**
|
|
548
538
|
* Currently StoryContextUpdates are allowed to have any key in the type. However, you cannot
|
|
549
539
|
* overwrite any of the build-it "static" keys.
|
|
@@ -552,7 +542,7 @@ declare function decorateStory<TRenderer extends Renderer$1>(storyFn: LegacyStor
|
|
|
552
542
|
* @returns StoryContextUpdate
|
|
553
543
|
*/
|
|
554
544
|
declare function sanitizeStoryContextUpdate({ componentId, title, kind, id, name, story, parameters, initialArgs, argTypes, ...update }?: StoryContextUpdate): StoryContextUpdate;
|
|
555
|
-
declare function defaultDecorateStory<TRenderer extends Renderer
|
|
545
|
+
declare function defaultDecorateStory<TRenderer extends Renderer>(storyFn: LegacyStoryFn<TRenderer>, decorators: DecoratorFunction<TRenderer>[]): LegacyStoryFn<TRenderer>;
|
|
556
546
|
|
|
557
547
|
declare const combineArgs: (value: any, update: any) => Args;
|
|
558
548
|
|
|
@@ -561,7 +551,7 @@ declare const userOrAutoTitle: (fileName: string, storiesEntries: NormalizedStor
|
|
|
561
551
|
|
|
562
552
|
declare const sortStoriesV7: (stories: IndexEntry[], storySortParameter: Addon_StorySortParameterV7, fileNameOrder: Path[]) => IndexEntry[];
|
|
563
553
|
|
|
564
|
-
declare class DocsContext<TRenderer extends Renderer
|
|
554
|
+
declare class DocsContext<TRenderer extends Renderer> implements DocsContextProps<TRenderer> {
|
|
565
555
|
channel: Channel;
|
|
566
556
|
protected store: StoryStore<TRenderer>;
|
|
567
557
|
renderStoryToElement: DocsContextProps<TRenderer>['renderStoryToElement'];
|
|
@@ -644,7 +634,7 @@ type RenderType = 'story' | 'docs';
|
|
|
644
634
|
* - Tracking the state of the rendering as it moves between preparing, rendering and tearing down.
|
|
645
635
|
* - Tracking what is rendered to know if a change requires re-rendering or teardown + recreation.
|
|
646
636
|
*/
|
|
647
|
-
interface Render<TRenderer extends Renderer
|
|
637
|
+
interface Render<TRenderer extends Renderer> {
|
|
648
638
|
type: RenderType;
|
|
649
639
|
id: StoryId;
|
|
650
640
|
isPreparing: () => boolean;
|
|
@@ -668,7 +658,7 @@ interface Render<TRenderer extends Renderer$1> {
|
|
|
668
658
|
*
|
|
669
659
|
* - Autodocs, where there is no story, and we fall back to the globally defined template.
|
|
670
660
|
*/
|
|
671
|
-
declare class CsfDocsRender<TRenderer extends Renderer
|
|
661
|
+
declare class CsfDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
672
662
|
protected channel: Channel;
|
|
673
663
|
protected store: StoryStore<TRenderer>;
|
|
674
664
|
entry: IndexEntry;
|
|
@@ -706,7 +696,7 @@ declare class CsfDocsRender<TRenderer extends Renderer$1> implements Render<TRen
|
|
|
706
696
|
*
|
|
707
697
|
* - *.mdx file that may or may not reference a specific CSF file with `<Meta of={} />`
|
|
708
698
|
*/
|
|
709
|
-
declare class MdxDocsRender<TRenderer extends Renderer
|
|
699
|
+
declare class MdxDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
710
700
|
protected channel: Channel;
|
|
711
701
|
protected store: StoryStore<TRenderer>;
|
|
712
702
|
entry: IndexEntry;
|
|
@@ -735,7 +725,7 @@ declare class MdxDocsRender<TRenderer extends Renderer$1> implements Render<TRen
|
|
|
735
725
|
}
|
|
736
726
|
|
|
737
727
|
type RenderPhase = 'preparing' | 'loading' | 'beforeEach' | 'rendering' | 'playing' | 'played' | 'afterEach' | 'completed' | 'finished' | 'aborted' | 'errored';
|
|
738
|
-
declare class StoryRender<TRenderer extends Renderer
|
|
728
|
+
declare class StoryRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
739
729
|
channel: Channel;
|
|
740
730
|
store: StoryStore<TRenderer>;
|
|
741
731
|
private renderToScreen;
|
|
@@ -753,7 +743,7 @@ declare class StoryRender<TRenderer extends Renderer$1> implements Render<TRende
|
|
|
753
743
|
disableKeyListeners: boolean;
|
|
754
744
|
private teardownRender;
|
|
755
745
|
torndown: boolean;
|
|
756
|
-
constructor(channel: Channel, store: StoryStore<TRenderer>, renderToScreen: RenderToCanvas
|
|
746
|
+
constructor(channel: Channel, store: StoryStore<TRenderer>, renderToScreen: RenderToCanvas<TRenderer>, callbacks: RenderContextCallbacks<TRenderer> & {
|
|
757
747
|
showStoryDuringRender?: () => void;
|
|
758
748
|
}, id: StoryId, viewMode: StoryContext<TRenderer>['viewMode'], renderOptions?: StoryRenderOptions, story?: PreparedStory<TRenderer>);
|
|
759
749
|
private runPhase;
|
|
@@ -780,15 +770,13 @@ declare class StoryRender<TRenderer extends Renderer$1> implements Render<TRende
|
|
|
780
770
|
teardown(): Promise<void>;
|
|
781
771
|
}
|
|
782
772
|
|
|
783
|
-
type MaybePromise
|
|
784
|
-
declare class Preview<TRenderer extends Renderer
|
|
773
|
+
type MaybePromise<T> = Promise<T> | T;
|
|
774
|
+
declare class Preview<TRenderer extends Renderer> {
|
|
785
775
|
importFn: ModuleImportFn;
|
|
786
|
-
getProjectAnnotations: () => MaybePromise
|
|
776
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
787
777
|
protected channel: Channel;
|
|
788
|
-
/** @deprecated Will be removed in 8.0, please use channel instead */
|
|
789
|
-
serverChannel?: Channel;
|
|
790
778
|
protected storyStoreValue?: StoryStore<TRenderer>;
|
|
791
|
-
renderToCanvas?: RenderToCanvas
|
|
779
|
+
renderToCanvas?: RenderToCanvas<TRenderer>;
|
|
792
780
|
storyRenders: StoryRender<TRenderer>[];
|
|
793
781
|
previewEntryError?: Error;
|
|
794
782
|
private projectAnnotationsBeforeInitialization?;
|
|
@@ -796,20 +784,20 @@ declare class Preview<TRenderer extends Renderer$1> {
|
|
|
796
784
|
protected storeInitializationPromise: Promise<void>;
|
|
797
785
|
protected resolveStoreInitializationPromise: () => void;
|
|
798
786
|
protected rejectStoreInitializationPromise: (err: Error) => void;
|
|
799
|
-
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise
|
|
787
|
+
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>, channel?: Channel, shouldInitialize?: boolean);
|
|
800
788
|
get storyStore(): StoryStore<TRenderer>;
|
|
801
789
|
protected initialize(): Promise<void>;
|
|
802
790
|
ready(): Promise<void>;
|
|
803
791
|
setupListeners(): void;
|
|
804
|
-
getProjectAnnotationsOrRenderError(): Promise<ProjectAnnotations
|
|
805
|
-
initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations
|
|
806
|
-
runBeforeAllHook(projectAnnotations: ProjectAnnotations
|
|
792
|
+
getProjectAnnotationsOrRenderError(): Promise<ProjectAnnotations<TRenderer>>;
|
|
793
|
+
initializeWithProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): Promise<void>;
|
|
794
|
+
runBeforeAllHook(projectAnnotations: ProjectAnnotations<TRenderer>): Promise<void>;
|
|
807
795
|
getStoryIndexFromServer(): Promise<StoryIndex>;
|
|
808
796
|
protected initializeWithStoryIndex(storyIndex: StoryIndex): void;
|
|
809
797
|
setInitialGlobals(): Promise<void>;
|
|
810
798
|
emitGlobals(): void;
|
|
811
799
|
onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
|
|
812
|
-
getProjectAnnotations: () => MaybePromise
|
|
800
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
813
801
|
}): Promise<void>;
|
|
814
802
|
onStoryIndexChanged(): Promise<void>;
|
|
815
803
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
@@ -879,10 +867,10 @@ declare class Preview<TRenderer extends Renderer$1> {
|
|
|
879
867
|
runStep: storybook_internal_types.StepRunner<TRenderer>;
|
|
880
868
|
mount: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => () => Promise<storybook_internal_types.Canvas>;
|
|
881
869
|
testingLibraryRender?: (...args: never[]) => unknown;
|
|
882
|
-
renderToCanvas?: RenderToCanvas
|
|
870
|
+
renderToCanvas?: RenderToCanvas<TRenderer> | undefined;
|
|
883
871
|
usesMount: boolean;
|
|
884
872
|
storyGlobals: Globals;
|
|
885
|
-
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer
|
|
873
|
+
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer, Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
886
874
|
extract(options?: {
|
|
887
875
|
includeDocsOnly: boolean;
|
|
888
876
|
}): Promise<Record<string, storybook_internal_types.StoryContextForEnhancers<TRenderer, Args>>>;
|
|
@@ -926,21 +914,21 @@ interface View<TStorybookRoot> {
|
|
|
926
914
|
showStoryDuringRender(): void;
|
|
927
915
|
}
|
|
928
916
|
|
|
929
|
-
type PossibleRender<TRenderer extends Renderer
|
|
930
|
-
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> {
|
|
931
919
|
importFn: ModuleImportFn;
|
|
932
|
-
getProjectAnnotations: () => MaybePromise
|
|
920
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
933
921
|
selectionStore: SelectionStore;
|
|
934
922
|
view: View<TRenderer['canvasElement']>;
|
|
935
923
|
currentSelection?: Selection;
|
|
936
924
|
currentRender?: PossibleRender<TRenderer>;
|
|
937
|
-
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise
|
|
925
|
+
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>, selectionStore: SelectionStore, view: View<TRenderer['canvasElement']>);
|
|
938
926
|
setupListeners(): void;
|
|
939
927
|
setInitialGlobals(): Promise<void>;
|
|
940
928
|
initializeWithStoryIndex(storyIndex: StoryIndex): Promise<void>;
|
|
941
929
|
selectSpecifiedStory(): Promise<void>;
|
|
942
930
|
onGetProjectAnnotationsChanged({ getProjectAnnotations, }: {
|
|
943
|
-
getProjectAnnotations: () => MaybePromise
|
|
931
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
944
932
|
}): Promise<void>;
|
|
945
933
|
onStoriesChanged({ importFn, storyIndex, }: {
|
|
946
934
|
importFn?: ModuleImportFn;
|
|
@@ -987,10 +975,10 @@ declare class PreviewWithSelection<TRenderer extends Renderer$1> extends Preview
|
|
|
987
975
|
}): void;
|
|
988
976
|
}
|
|
989
977
|
|
|
990
|
-
declare class PreviewWeb<TRenderer extends Renderer
|
|
978
|
+
declare class PreviewWeb<TRenderer extends Renderer> extends PreviewWithSelection<TRenderer> {
|
|
991
979
|
importFn: ModuleImportFn;
|
|
992
|
-
getProjectAnnotations: () => MaybePromise
|
|
993
|
-
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise
|
|
980
|
+
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
981
|
+
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>);
|
|
994
982
|
}
|
|
995
983
|
|
|
996
984
|
declare class UrlStore implements SelectionStore {
|
|
@@ -1046,48 +1034,6 @@ declare class WebView implements View<HTMLElement> {
|
|
|
1046
1034
|
declare function simulateDOMContentLoaded(): void;
|
|
1047
1035
|
declare function simulatePageLoad($container: any): void;
|
|
1048
1036
|
|
|
1049
|
-
declare global {
|
|
1050
|
-
interface SymbolConstructor {
|
|
1051
|
-
readonly observable: symbol;
|
|
1052
|
-
}
|
|
1053
|
-
}
|
|
1054
|
-
|
|
1055
|
-
interface Renderer extends Renderer$2 {
|
|
1056
|
-
}
|
|
1057
|
-
|
|
1058
|
-
type MaybePromise<T> = Promise<T> | T;
|
|
1059
|
-
type TeardownRenderToCanvas = () => MaybePromise<void>;
|
|
1060
|
-
type RenderToCanvas<TRenderer extends Renderer> = (context: RenderContext<TRenderer>, element: TRenderer['canvasElement']) => MaybePromise<void | TeardownRenderToCanvas>;
|
|
1061
|
-
interface ProjectAnnotations<TRenderer extends Renderer> extends ProjectAnnotations$2<TRenderer> {
|
|
1062
|
-
addons?: ProjectAnnotations<TRenderer>[];
|
|
1063
|
-
testingLibraryRender?: (...args: never[]) => {
|
|
1064
|
-
unmount: () => void;
|
|
1065
|
-
};
|
|
1066
|
-
renderToCanvas?: RenderToCanvas<TRenderer>;
|
|
1067
|
-
renderToDOM?: RenderToCanvas<TRenderer>;
|
|
1068
|
-
}
|
|
1069
|
-
type NormalizedProjectAnnotations<TRenderer extends Renderer = Renderer> = Omit<ProjectAnnotations<TRenderer>, 'decorators' | 'loaders' | 'runStep' | 'beforeAll'> & {
|
|
1070
|
-
argTypes?: StrictArgTypes$1;
|
|
1071
|
-
globalTypes?: StrictGlobalTypes;
|
|
1072
|
-
decorators?: DecoratorFunction$1<TRenderer>[];
|
|
1073
|
-
loaders?: LoaderFunction<TRenderer>[];
|
|
1074
|
-
runStep: StepRunner$1<TRenderer>;
|
|
1075
|
-
beforeAll: BeforeAll;
|
|
1076
|
-
};
|
|
1077
|
-
declare type RenderContext<TRenderer extends Renderer = Renderer> = StoryIdentifier & {
|
|
1078
|
-
showMain: () => void;
|
|
1079
|
-
showError: (error: {
|
|
1080
|
-
title: string;
|
|
1081
|
-
description: string;
|
|
1082
|
-
}) => void;
|
|
1083
|
-
showException: (err: Error) => void;
|
|
1084
|
-
forceRemount: boolean;
|
|
1085
|
-
storyContext: StoryContext$1<TRenderer>;
|
|
1086
|
-
storyFn: PartialStoryFn$1<TRenderer>;
|
|
1087
|
-
unboundStoryFn: LegacyStoryFn$1<TRenderer>;
|
|
1088
|
-
};
|
|
1089
|
-
|
|
1090
1037
|
declare function getCoreAnnotations(): any[];
|
|
1091
|
-
declare function getComposedCoreAnnotations<TRenderer extends Renderer$1>(): NormalizedProjectAnnotations<TRenderer>;
|
|
1092
1038
|
|
|
1093
|
-
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 };
|