storybook 9.0.0-alpha.13 → 9.0.0-alpha.15
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/actions/decorator.js +46 -47
- package/dist/actions/index.cjs +28 -29
- package/dist/actions/index.d.ts +0 -3
- package/dist/actions/index.js +27 -28
- package/dist/actions/preview.cjs +22 -23
- package/dist/actions/preview.js +18 -19
- package/dist/bin/index.cjs +67 -71
- package/dist/bin/index.js +56 -60
- package/dist/channels/index.cjs +1018 -948
- package/dist/channels/index.js +1194 -1161
- package/dist/cli/bin/index.cjs +1 -1
- package/dist/cli/bin/index.js +1 -1
- package/dist/cli/index.cjs +1860 -1871
- package/dist/cli/index.js +308 -319
- package/dist/common/index.cjs +43 -49
- package/dist/common/index.d.ts +0 -4
- package/dist/common/index.js +43 -49
- package/dist/components/index.cjs +6375 -12708
- package/dist/components/index.d.ts +1 -2
- package/dist/components/index.js +4647 -10782
- package/dist/core-server/index.cjs +13626 -13550
- package/dist/core-server/index.js +11863 -11787
- package/dist/core-server/presets/common-manager.js +3221 -3138
- package/dist/manager/globals-runtime.js +29817 -33554
- package/dist/manager-api/index.cjs +2518 -2330
- package/dist/manager-api/index.js +2432 -2234
- package/dist/preview/runtime.js +18415 -16011
- package/dist/preview-api/index.cjs +619 -603
- package/dist/preview-api/index.d.ts +386 -118
- package/dist/preview-api/index.js +542 -526
- package/dist/server-errors.cjs +132 -118
- package/dist/server-errors.d.ts +4 -2
- package/dist/server-errors.js +127 -113
- package/dist/test/preview.d.ts +6 -0
- package/dist/types/index.d.ts +1 -4
- package/package.json +2 -2
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Channel } from 'storybook/internal/channels';
|
|
2
2
|
import * as storybook_internal_types from 'storybook/internal/types';
|
|
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';
|
|
3
|
+
import { ProjectAnnotations, Renderer as Renderer$1, Args as Args$1, StoryContext as StoryContext$1, DecoratorApplicator, StoryId as StoryId$1, Addon_StoryWrapper, PreparedStory, Globals as Globals$1, GlobalTypes, StoryIndex, StoryName as StoryName$1, ComponentTitle as ComponentTitle$1, IndexEntry, Path, StoryAnnotationsOrFn, NormalizedComponentAnnotations, NormalizedStoryAnnotations, ModuleExports, CSFFile, NormalizedProjectAnnotations, ModuleExport, PreparedMeta, StepRunner, ComposedStoryFn, Store_CSFExports, ComposeStoryFn, LegacyStoryAnnotationsOrFn, ComponentAnnotations, NamedOrDefaultProjectAnnotations, ModuleImportFn, StoryContextForEnhancers as StoryContextForEnhancers$1, Parameters as Parameters$1, StrictArgTypes as StrictArgTypes$1, ArgTypesEnhancer, LegacyStoryFn as LegacyStoryFn$1, DecoratorFunction, PartialStoryFn, StoryContextUpdate as StoryContextUpdate$1, NormalizedStoriesSpecifier, Addon_StorySortParameterV7, DocsContextProps, ResolvedModuleExportType, ResolvedModuleExportFromType, StoryRenderOptions, RenderContextCallbacks, RenderToCanvas, ViewMode as ViewMode$1 } from 'storybook/internal/types';
|
|
4
4
|
import { CleanupCallback } from 'storybook/internal/csf';
|
|
5
5
|
import { RequestData, ArgTypesRequestPayload } from 'storybook/internal/core-events';
|
|
6
6
|
|
|
@@ -16,7 +16,7 @@ declare class AddonStore {
|
|
|
16
16
|
}
|
|
17
17
|
declare const addons: AddonStore;
|
|
18
18
|
|
|
19
|
-
declare function definePreview(config: ProjectAnnotations<Renderer>): ProjectAnnotations<Renderer>;
|
|
19
|
+
declare function definePreview(config: ProjectAnnotations<Renderer$1>): ProjectAnnotations<Renderer$1>;
|
|
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, TArgs extends Args = Args> {
|
|
31
|
+
declare class HooksContext<TRenderer extends Renderer$1, TArgs extends Args$1 = Args$1> {
|
|
32
32
|
hookListsMap: WeakMap<AbstractFunction, Hook[]>;
|
|
33
33
|
mountedDecorators: Set<AbstractFunction>;
|
|
34
34
|
prevMountedDecorators: Set<AbstractFunction>;
|
|
@@ -39,8 +39,8 @@ declare class HooksContext<TRenderer extends Renderer, TArgs extends Args = Args
|
|
|
39
39
|
prevEffects: Effect[];
|
|
40
40
|
currentDecoratorName: string | null;
|
|
41
41
|
hasUpdates: boolean;
|
|
42
|
-
currentContext: StoryContext<TRenderer, TArgs> | null;
|
|
43
|
-
renderListener: (storyId: StoryId) => void;
|
|
42
|
+
currentContext: StoryContext$1<TRenderer, TArgs> | null;
|
|
43
|
+
renderListener: (storyId: StoryId$1) => void;
|
|
44
44
|
constructor();
|
|
45
45
|
init(): void;
|
|
46
46
|
clean(): void;
|
|
@@ -49,7 +49,7 @@ declare class HooksContext<TRenderer extends Renderer, TArgs extends Args = Args
|
|
|
49
49
|
addRenderListeners(): void;
|
|
50
50
|
removeRenderListeners(): void;
|
|
51
51
|
}
|
|
52
|
-
declare const applyHooks: <TRenderer extends Renderer>(applyDecorators: DecoratorApplicator<TRenderer>) => DecoratorApplicator<TRenderer>;
|
|
52
|
+
declare const applyHooks: <TRenderer extends Renderer$1>(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, TArgs extends Args = Args>(): StoryContext<TRenderer>;
|
|
218
|
+
declare function useStoryContext<TRenderer extends Renderer$1, TArgs extends Args$1 = Args$1>(): StoryContext$1<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.
|
|
@@ -251,7 +251,7 @@ declare function useParameter<S>(parameterKey: string, defaultValue?: S): S | un
|
|
|
251
251
|
* @returns {[TArgs, (newArgs: Partial<TArgs>) => void, (argNames?: (keyof TArgs)[]) => void]} An
|
|
252
252
|
* array containing the current args, a function to update them, and a function to reset them.
|
|
253
253
|
*/
|
|
254
|
-
declare function useArgs<TArgs extends Args = Args>(): [
|
|
254
|
+
declare function useArgs<TArgs extends Args$1 = Args$1>(): [
|
|
255
255
|
TArgs,
|
|
256
256
|
(newArgs: Partial<TArgs>) => void,
|
|
257
257
|
(argNames?: (keyof TArgs)[]) => void
|
|
@@ -270,7 +270,7 @@ declare function useArgs<TArgs extends Args = Args>(): [
|
|
|
270
270
|
* @returns {[Args, (newGlobals: Args) => void]} An array containing the current global args, and a
|
|
271
271
|
* function to update them.
|
|
272
272
|
*/
|
|
273
|
-
declare function useGlobals(): [Args, (newGlobals: Args) => void];
|
|
273
|
+
declare function useGlobals(): [Args$1, (newGlobals: Args$1) => void];
|
|
274
274
|
|
|
275
275
|
type MakeDecoratorResult = (...args: any) => any;
|
|
276
276
|
interface MakeDecoratorOptions {
|
|
@@ -312,55 +312,55 @@ declare const makeDecorator: ({ name, parameterName, wrapper, skipIfNoParameters
|
|
|
312
312
|
declare function mockChannel(): Channel;
|
|
313
313
|
|
|
314
314
|
declare class ArgsStore {
|
|
315
|
-
initialArgsByStoryId: Record<StoryId, Args>;
|
|
316
|
-
argsByStoryId: Record<StoryId, Args>;
|
|
317
|
-
get(storyId: StoryId): Args;
|
|
315
|
+
initialArgsByStoryId: Record<StoryId$1, Args$1>;
|
|
316
|
+
argsByStoryId: Record<StoryId$1, Args$1>;
|
|
317
|
+
get(storyId: StoryId$1): Args$1;
|
|
318
318
|
setInitial(story: PreparedStory<any>): void;
|
|
319
|
-
updateFromDelta(story: PreparedStory<any>, delta: Args): void;
|
|
320
|
-
updateFromPersisted(story: PreparedStory<any>, persisted: Args): void;
|
|
321
|
-
update(storyId: StoryId, argsUpdate: Partial<Args>): void;
|
|
319
|
+
updateFromDelta(story: PreparedStory<any>, delta: Args$1): void;
|
|
320
|
+
updateFromPersisted(story: PreparedStory<any>, persisted: Args$1): void;
|
|
321
|
+
update(storyId: StoryId$1, argsUpdate: Partial<Args$1>): void;
|
|
322
322
|
}
|
|
323
323
|
|
|
324
324
|
declare class GlobalsStore {
|
|
325
325
|
allowedGlobalNames: Set<string>;
|
|
326
|
-
initialGlobals: Globals;
|
|
327
|
-
globals: Globals;
|
|
326
|
+
initialGlobals: Globals$1;
|
|
327
|
+
globals: Globals$1;
|
|
328
328
|
constructor({ globals, globalTypes, }: {
|
|
329
|
-
globals?: Globals;
|
|
329
|
+
globals?: Globals$1;
|
|
330
330
|
globalTypes?: GlobalTypes;
|
|
331
331
|
});
|
|
332
332
|
set({ globals, globalTypes }: {
|
|
333
|
-
globals?: Globals;
|
|
333
|
+
globals?: Globals$1;
|
|
334
334
|
globalTypes?: GlobalTypes;
|
|
335
335
|
}): void;
|
|
336
|
-
filterAllowedGlobals(globals: Globals): Globals;
|
|
337
|
-
updateFromPersisted(persisted: Globals): void;
|
|
338
|
-
get(): Globals;
|
|
339
|
-
update(newGlobals: Globals): void;
|
|
336
|
+
filterAllowedGlobals(globals: Globals$1): Globals$1;
|
|
337
|
+
updateFromPersisted(persisted: Globals$1): void;
|
|
338
|
+
get(): Globals$1;
|
|
339
|
+
update(newGlobals: Globals$1): void;
|
|
340
340
|
}
|
|
341
341
|
|
|
342
|
-
type StorySpecifier = StoryId | {
|
|
343
|
-
name: StoryName;
|
|
344
|
-
title: ComponentTitle;
|
|
342
|
+
type StorySpecifier = StoryId$1 | {
|
|
343
|
+
name: StoryName$1;
|
|
344
|
+
title: ComponentTitle$1;
|
|
345
345
|
} | '*';
|
|
346
346
|
declare class StoryIndexStore {
|
|
347
347
|
entries: StoryIndex['entries'];
|
|
348
348
|
constructor({ entries }?: StoryIndex);
|
|
349
349
|
entryFromSpecifier(specifier: StorySpecifier): IndexEntry | undefined;
|
|
350
|
-
storyIdToEntry(storyId: StoryId): IndexEntry;
|
|
350
|
+
storyIdToEntry(storyId: StoryId$1): IndexEntry;
|
|
351
351
|
importPathToEntry(importPath: Path): IndexEntry;
|
|
352
352
|
}
|
|
353
353
|
|
|
354
|
-
declare function normalizeStory<TRenderer extends Renderer>(key: StoryId, storyAnnotations: StoryAnnotationsOrFn<TRenderer>, meta: NormalizedComponentAnnotations<TRenderer>): NormalizedStoryAnnotations<TRenderer>;
|
|
354
|
+
declare function normalizeStory<TRenderer extends Renderer$1>(key: StoryId$1, storyAnnotations: StoryAnnotationsOrFn<TRenderer>, meta: NormalizedComponentAnnotations<TRenderer>): NormalizedStoryAnnotations<TRenderer>;
|
|
355
355
|
|
|
356
|
-
declare function processCSFFile<TRenderer extends Renderer>(moduleExports: ModuleExports, importPath: Path, title: ComponentTitle): CSFFile<TRenderer>;
|
|
356
|
+
declare function processCSFFile<TRenderer extends Renderer$1>(moduleExports: ModuleExports, importPath: Path, title: ComponentTitle$1): CSFFile<TRenderer>;
|
|
357
357
|
|
|
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>;
|
|
358
|
+
declare function prepareStory<TRenderer extends Renderer$1>(storyAnnotations: NormalizedStoryAnnotations<TRenderer>, componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations<TRenderer>): PreparedStory<TRenderer>;
|
|
359
|
+
declare function prepareMeta<TRenderer extends Renderer$1>(componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations<TRenderer>, moduleExport: ModuleExport): PreparedMeta<TRenderer>;
|
|
360
360
|
|
|
361
|
-
declare function normalizeProjectAnnotations<TRenderer extends Renderer>({ argTypes, globalTypes, argTypesEnhancers, decorators, loaders, beforeEach, experimental_afterEach, initialGlobals, ...annotations }: ProjectAnnotations<TRenderer>): NormalizedProjectAnnotations<TRenderer>;
|
|
361
|
+
declare function normalizeProjectAnnotations<TRenderer extends Renderer$1>({ argTypes, globalTypes, argTypesEnhancers, decorators, loaders, beforeEach, experimental_afterEach, initialGlobals, ...annotations }: ProjectAnnotations<TRenderer>): NormalizedProjectAnnotations<TRenderer>;
|
|
362
362
|
|
|
363
|
-
declare function composeConfigs<TRenderer extends Renderer>(input: ModuleExports[]): NormalizedProjectAnnotations<TRenderer>;
|
|
363
|
+
declare function composeConfigs<TRenderer extends Renderer$1>(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>(input: ModuleExports
|
|
|
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>(stepRunners: StepRunner<TRenderer>[]): StepRunner<TRenderer>;
|
|
389
|
+
declare function composeStepRunners<TRenderer extends Renderer$1>(stepRunners: StepRunner<TRenderer>[]): StepRunner<TRenderer>;
|
|
390
390
|
|
|
391
391
|
declare global {
|
|
392
392
|
var globalProjectAnnotations: NormalizedProjectAnnotations<any>;
|
|
393
393
|
var defaultProjectAnnotations: ProjectAnnotations<any>;
|
|
394
394
|
}
|
|
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): {};
|
|
395
|
+
declare function setDefaultProjectAnnotations<TRenderer extends Renderer$1 = Renderer$1>(_defaultProjectAnnotations: ProjectAnnotations<TRenderer>): void;
|
|
396
|
+
declare function setProjectAnnotations<TRenderer extends Renderer$1 = Renderer$1>(projectAnnotations: NamedOrDefaultProjectAnnotations<TRenderer> | NamedOrDefaultProjectAnnotations<TRenderer>[]): NormalizedProjectAnnotations<TRenderer>;
|
|
397
|
+
declare function composeStory<TRenderer extends Renderer$1 = Renderer$1, TArgs extends Args$1 = Args$1>(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$1>, composeStoryFn?: ComposeStoryFn): {};
|
|
399
399
|
type WrappedStoryRef = {
|
|
400
400
|
__pw_type: 'jsx' | 'importRef';
|
|
401
401
|
};
|
|
@@ -411,35 +411,35 @@ declare function createPlaywrightTest<TFixture extends {
|
|
|
411
411
|
extend: any;
|
|
412
412
|
}>(baseTest: TFixture): TFixture;
|
|
413
413
|
|
|
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>;
|
|
414
|
+
declare function getCsfFactoryAnnotations<TRenderer extends Renderer$1 = Renderer$1, TArgs extends Args$1 = Args$1>(story: LegacyStoryAnnotationsOrFn<TRenderer>, meta?: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations?: ProjectAnnotations<TRenderer>): {
|
|
415
|
+
story: storybook_internal_types.StoryAnnotations<Renderer$1, Args$1>;
|
|
416
|
+
meta: ComponentAnnotations<Renderer$1, Args$1>;
|
|
417
|
+
preview: storybook_internal_types.NormalizedProjectAnnotations<Renderer$1>;
|
|
418
418
|
} | {
|
|
419
419
|
story: LegacyStoryAnnotationsOrFn<TRenderer>;
|
|
420
420
|
meta: ComponentAnnotations<TRenderer, TArgs> | undefined;
|
|
421
421
|
preview: ProjectAnnotations<TRenderer> | undefined;
|
|
422
422
|
};
|
|
423
423
|
|
|
424
|
-
interface Report<T = unknown> {
|
|
424
|
+
interface Report$1<T = unknown> {
|
|
425
425
|
type: string;
|
|
426
426
|
version?: number;
|
|
427
427
|
result: T;
|
|
428
428
|
status: 'failed' | 'passed' | 'warning';
|
|
429
429
|
}
|
|
430
430
|
declare class ReporterAPI {
|
|
431
|
-
reports: Report[];
|
|
432
|
-
addReport(report: Report): Promise<void>;
|
|
431
|
+
reports: Report$1[];
|
|
432
|
+
addReport(report: Report$1): Promise<void>;
|
|
433
433
|
}
|
|
434
434
|
|
|
435
|
-
declare class StoryStore<TRenderer extends Renderer> {
|
|
435
|
+
declare class StoryStore<TRenderer extends Renderer$1> {
|
|
436
436
|
importFn: ModuleImportFn;
|
|
437
437
|
storyIndex: StoryIndexStore;
|
|
438
438
|
projectAnnotations: NormalizedProjectAnnotations<TRenderer>;
|
|
439
439
|
userGlobals: GlobalsStore;
|
|
440
440
|
args: ArgsStore;
|
|
441
|
-
hooks: Record<StoryId, HooksContext<TRenderer>>;
|
|
442
|
-
cleanupCallbacks: Record<StoryId, CleanupCallback[] | undefined>;
|
|
441
|
+
hooks: Record<StoryId$1, HooksContext<TRenderer>>;
|
|
442
|
+
cleanupCallbacks: Record<StoryId$1, CleanupCallback[] | undefined>;
|
|
443
443
|
cachedCSFFiles?: Record<Path, CSFFile<TRenderer>>;
|
|
444
444
|
processCSFFileWithCache: typeof processCSFFile;
|
|
445
445
|
prepareMetaWithCache: typeof prepareMeta;
|
|
@@ -450,24 +450,24 @@ declare class StoryStore<TRenderer extends Renderer> {
|
|
|
450
450
|
importFn?: ModuleImportFn;
|
|
451
451
|
storyIndex?: StoryIndex;
|
|
452
452
|
}): Promise<void>;
|
|
453
|
-
storyIdToEntry(storyId: StoryId): Promise<IndexEntry>;
|
|
454
|
-
loadCSFFileByStoryId(storyId: StoryId): Promise<CSFFile<TRenderer>>;
|
|
453
|
+
storyIdToEntry(storyId: StoryId$1): Promise<IndexEntry>;
|
|
454
|
+
loadCSFFileByStoryId(storyId: StoryId$1): Promise<CSFFile<TRenderer>>;
|
|
455
455
|
loadAllCSFFiles(): Promise<StoryStore<TRenderer>['cachedCSFFiles']>;
|
|
456
456
|
cacheAllCSFFiles(): Promise<void>;
|
|
457
457
|
preparedMetaFromCSFFile({ csfFile }: {
|
|
458
458
|
csfFile: CSFFile<TRenderer>;
|
|
459
459
|
}): PreparedMeta<TRenderer>;
|
|
460
460
|
loadStory({ storyId }: {
|
|
461
|
-
storyId: StoryId;
|
|
461
|
+
storyId: StoryId$1;
|
|
462
462
|
}): Promise<PreparedStory<TRenderer>>;
|
|
463
463
|
storyFromCSFFile({ storyId, csfFile, }: {
|
|
464
|
-
storyId: StoryId;
|
|
464
|
+
storyId: StoryId$1;
|
|
465
465
|
csfFile: CSFFile<TRenderer>;
|
|
466
466
|
}): PreparedStory<TRenderer>;
|
|
467
467
|
componentStoriesFromCSFFile({ csfFile, }: {
|
|
468
468
|
csfFile: CSFFile<TRenderer>;
|
|
469
469
|
}): PreparedStory<TRenderer>[];
|
|
470
|
-
loadEntry(id: StoryId): Promise<{
|
|
470
|
+
loadEntry(id: StoryId$1): Promise<{
|
|
471
471
|
entryExports: ModuleExports;
|
|
472
472
|
csfFiles: CSFFile<TRenderer>[];
|
|
473
473
|
}>;
|
|
@@ -495,7 +495,7 @@ declare class StoryStore<TRenderer extends Renderer> {
|
|
|
495
495
|
componentId: storybook_internal_types.ComponentId;
|
|
496
496
|
title: storybook_internal_types.ComponentTitle;
|
|
497
497
|
kind: storybook_internal_types.ComponentTitle;
|
|
498
|
-
id: StoryId;
|
|
498
|
+
id: StoryId$1;
|
|
499
499
|
name: storybook_internal_types.StoryName;
|
|
500
500
|
story: storybook_internal_types.StoryName;
|
|
501
501
|
tags: storybook_internal_types.Tag[];
|
|
@@ -513,12 +513,12 @@ declare class StoryStore<TRenderer extends Renderer> {
|
|
|
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, storybook_internal_types.Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
516
|
+
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer$1, 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
|
-
}): Record<StoryId, StoryContextForEnhancers<TRenderer>>;
|
|
521
|
+
}): Record<StoryId$1, StoryContextForEnhancers$1<TRenderer>>;
|
|
522
522
|
}
|
|
523
523
|
|
|
524
524
|
/**
|
|
@@ -526,14 +526,14 @@ declare class StoryStore<TRenderer extends Renderer> {
|
|
|
526
526
|
* overwrite the existing value UNLESS both values are plain objects. In this case flag the key as
|
|
527
527
|
* "special" and handle it with a heuristic.
|
|
528
528
|
*/
|
|
529
|
-
declare const combineParameters: (...parameterSets: (Parameters | undefined)[]) => Parameters;
|
|
529
|
+
declare const combineParameters: (...parameterSets: (Parameters$1 | undefined)[]) => Parameters$1;
|
|
530
530
|
|
|
531
531
|
type PropDescriptor = string[] | RegExp;
|
|
532
|
-
declare const filterArgTypes: (argTypes: StrictArgTypes, include?: PropDescriptor, exclude?: PropDescriptor) => Partial<StrictArgTypes<storybook_internal_types.Args>>;
|
|
532
|
+
declare const filterArgTypes: (argTypes: StrictArgTypes$1, include?: PropDescriptor, exclude?: PropDescriptor) => Partial<StrictArgTypes$1<storybook_internal_types.Args>>;
|
|
533
533
|
|
|
534
|
-
declare const inferControls: ArgTypesEnhancer<Renderer>;
|
|
534
|
+
declare const inferControls: ArgTypesEnhancer<Renderer$1>;
|
|
535
535
|
|
|
536
|
-
declare function decorateStory<TRenderer extends Renderer>(storyFn: LegacyStoryFn<TRenderer>, decorator: DecoratorFunction<TRenderer>, bindWithContext: (storyFn: LegacyStoryFn<TRenderer>) => PartialStoryFn<TRenderer>): LegacyStoryFn<TRenderer>;
|
|
536
|
+
declare function decorateStory<TRenderer extends Renderer$1>(storyFn: LegacyStoryFn$1<TRenderer>, decorator: DecoratorFunction<TRenderer>, bindWithContext: (storyFn: LegacyStoryFn$1<TRenderer>) => PartialStoryFn<TRenderer>): LegacyStoryFn$1<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.
|
|
@@ -541,17 +541,17 @@ declare function decorateStory<TRenderer extends Renderer>(storyFn: LegacyStoryF
|
|
|
541
541
|
* @param inputContextUpdate StoryContextUpdate
|
|
542
542
|
* @returns StoryContextUpdate
|
|
543
543
|
*/
|
|
544
|
-
declare function sanitizeStoryContextUpdate({ componentId, title, kind, id, name, story, parameters, initialArgs, argTypes, ...update }?: StoryContextUpdate): StoryContextUpdate;
|
|
545
|
-
declare function defaultDecorateStory<TRenderer extends Renderer>(storyFn: LegacyStoryFn<TRenderer>, decorators: DecoratorFunction<TRenderer>[]): LegacyStoryFn<TRenderer>;
|
|
544
|
+
declare function sanitizeStoryContextUpdate({ componentId, title, kind, id, name, story, parameters, initialArgs, argTypes, ...update }?: StoryContextUpdate$1): StoryContextUpdate$1;
|
|
545
|
+
declare function defaultDecorateStory<TRenderer extends Renderer$1>(storyFn: LegacyStoryFn$1<TRenderer>, decorators: DecoratorFunction<TRenderer>[]): LegacyStoryFn$1<TRenderer>;
|
|
546
546
|
|
|
547
|
-
declare const combineArgs: (value: any, update: any) => Args;
|
|
547
|
+
declare const combineArgs: (value: any, update: any) => Args$1;
|
|
548
548
|
|
|
549
549
|
declare const userOrAutoTitleFromSpecifier: (fileName: string | number, entry: NormalizedStoriesSpecifier, userTitle?: string) => string | undefined;
|
|
550
550
|
declare const userOrAutoTitle: (fileName: string, storiesEntries: NormalizedStoriesSpecifier[], userTitle?: string) => string | undefined;
|
|
551
551
|
|
|
552
552
|
declare const sortStoriesV7: (stories: IndexEntry[], storySortParameter: Addon_StorySortParameterV7, fileNameOrder: Path[]) => IndexEntry[];
|
|
553
553
|
|
|
554
|
-
declare class DocsContext<TRenderer extends Renderer> implements DocsContextProps<TRenderer> {
|
|
554
|
+
declare class DocsContext<TRenderer extends Renderer$1> implements DocsContextProps<TRenderer> {
|
|
555
555
|
channel: Channel;
|
|
556
556
|
protected store: StoryStore<TRenderer>;
|
|
557
557
|
renderStoryToElement: DocsContextProps<TRenderer>['renderStoryToElement'];
|
|
@@ -572,10 +572,10 @@ declare class DocsContext<TRenderer extends Renderer> implements DocsContextProp
|
|
|
572
572
|
private resolveAttachedModuleExportType;
|
|
573
573
|
private resolveModuleExport;
|
|
574
574
|
resolveOf<TType extends ResolvedModuleExportType>(moduleExportOrType: ModuleExport | TType, validTypes?: TType[]): ResolvedModuleExportFromType<TType, TRenderer>;
|
|
575
|
-
storyIdByName: (storyName: StoryName) => string;
|
|
575
|
+
storyIdByName: (storyName: StoryName$1) => string;
|
|
576
576
|
componentStories: () => PreparedStory<TRenderer>[];
|
|
577
577
|
componentStoriesFromCSFFile: (csfFile: CSFFile<TRenderer>) => PreparedStory<TRenderer>[];
|
|
578
|
-
storyById: (storyId?: StoryId) => PreparedStory<TRenderer>;
|
|
578
|
+
storyById: (storyId?: StoryId$1) => PreparedStory<TRenderer>;
|
|
579
579
|
getStoryContext: (story: PreparedStory<TRenderer>) => {
|
|
580
580
|
loaded: {};
|
|
581
581
|
viewMode: string;
|
|
@@ -600,9 +600,9 @@ declare class DocsContext<TRenderer extends Renderer> implements DocsContextProp
|
|
|
600
600
|
componentId: storybook_internal_types.ComponentId;
|
|
601
601
|
title: storybook_internal_types.ComponentTitle;
|
|
602
602
|
kind: storybook_internal_types.ComponentTitle;
|
|
603
|
-
id: StoryId;
|
|
604
|
-
name: StoryName;
|
|
605
|
-
story: StoryName;
|
|
603
|
+
id: StoryId$1;
|
|
604
|
+
name: StoryName$1;
|
|
605
|
+
story: StoryName$1;
|
|
606
606
|
tags: storybook_internal_types.Tag[];
|
|
607
607
|
moduleExport: ModuleExport;
|
|
608
608
|
originalStoryFn: storybook_internal_types.ArgsStoryFn<TRenderer>;
|
|
@@ -622,7 +622,7 @@ declare class DocsContext<TRenderer extends Renderer> implements DocsContextProp
|
|
|
622
622
|
argsByTarget: any;
|
|
623
623
|
unmappedArgs: any;
|
|
624
624
|
};
|
|
625
|
-
loadStory: (id: StoryId) => Promise<PreparedStory<TRenderer>>;
|
|
625
|
+
loadStory: (id: StoryId$1) => Promise<PreparedStory<TRenderer>>;
|
|
626
626
|
}
|
|
627
627
|
|
|
628
628
|
type RenderType = 'story' | 'docs';
|
|
@@ -634,9 +634,9 @@ 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$1> {
|
|
638
638
|
type: RenderType;
|
|
639
|
-
id: StoryId;
|
|
639
|
+
id: StoryId$1;
|
|
640
640
|
isPreparing: () => boolean;
|
|
641
641
|
isEqual: (other: Render<TRenderer>) => boolean;
|
|
642
642
|
disableKeyListeners: boolean;
|
|
@@ -658,14 +658,14 @@ interface Render<TRenderer extends Renderer> {
|
|
|
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> implements Render<TRenderer> {
|
|
661
|
+
declare class CsfDocsRender<TRenderer extends Renderer$1> implements Render<TRenderer> {
|
|
662
662
|
protected channel: Channel;
|
|
663
663
|
protected store: StoryStore<TRenderer>;
|
|
664
664
|
entry: IndexEntry;
|
|
665
665
|
private callbacks;
|
|
666
666
|
readonly type: RenderType;
|
|
667
667
|
readonly subtype = "csf";
|
|
668
|
-
readonly id: StoryId;
|
|
668
|
+
readonly id: StoryId$1;
|
|
669
669
|
story?: PreparedStory<TRenderer>;
|
|
670
670
|
rerender?: () => Promise<void>;
|
|
671
671
|
teardownRender?: (options: {
|
|
@@ -696,14 +696,14 @@ declare class CsfDocsRender<TRenderer extends Renderer> implements Render<TRende
|
|
|
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> implements Render<TRenderer> {
|
|
699
|
+
declare class MdxDocsRender<TRenderer extends Renderer$1> implements Render<TRenderer> {
|
|
700
700
|
protected channel: Channel;
|
|
701
701
|
protected store: StoryStore<TRenderer>;
|
|
702
702
|
entry: IndexEntry;
|
|
703
703
|
private callbacks;
|
|
704
704
|
readonly type: RenderType;
|
|
705
705
|
readonly subtype = "mdx";
|
|
706
|
-
readonly id: StoryId;
|
|
706
|
+
readonly id: StoryId$1;
|
|
707
707
|
private exports?;
|
|
708
708
|
rerender?: () => Promise<void>;
|
|
709
709
|
teardownRender?: (options: {
|
|
@@ -725,13 +725,13 @@ declare class MdxDocsRender<TRenderer extends Renderer> implements Render<TRende
|
|
|
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> implements Render<TRenderer> {
|
|
728
|
+
declare class StoryRender<TRenderer extends Renderer$1> implements Render<TRenderer> {
|
|
729
729
|
channel: Channel;
|
|
730
730
|
store: StoryStore<TRenderer>;
|
|
731
731
|
private renderToScreen;
|
|
732
732
|
private callbacks;
|
|
733
|
-
id: StoryId;
|
|
734
|
-
viewMode: StoryContext<TRenderer>['viewMode'];
|
|
733
|
+
id: StoryId$1;
|
|
734
|
+
viewMode: StoryContext$1<TRenderer>['viewMode'];
|
|
735
735
|
renderOptions: StoryRenderOptions;
|
|
736
736
|
type: RenderType;
|
|
737
737
|
story?: PreparedStory<TRenderer>;
|
|
@@ -745,7 +745,7 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
|
|
|
745
745
|
torndown: boolean;
|
|
746
746
|
constructor(channel: Channel, store: StoryStore<TRenderer>, renderToScreen: RenderToCanvas<TRenderer>, callbacks: RenderContextCallbacks<TRenderer> & {
|
|
747
747
|
showStoryDuringRender?: () => void;
|
|
748
|
-
}, id: StoryId, viewMode: StoryContext<TRenderer>['viewMode'], renderOptions?: StoryRenderOptions, story?: PreparedStory<TRenderer>);
|
|
748
|
+
}, id: StoryId$1, viewMode: StoryContext$1<TRenderer>['viewMode'], renderOptions?: StoryRenderOptions, story?: PreparedStory<TRenderer>);
|
|
749
749
|
private runPhase;
|
|
750
750
|
private checkIfAborted;
|
|
751
751
|
prepare(): Promise<void>;
|
|
@@ -771,7 +771,7 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
|
|
|
771
771
|
}
|
|
772
772
|
|
|
773
773
|
type MaybePromise<T> = Promise<T> | T;
|
|
774
|
-
declare class Preview<TRenderer extends Renderer> {
|
|
774
|
+
declare class Preview<TRenderer extends Renderer$1> {
|
|
775
775
|
importFn: ModuleImportFn;
|
|
776
776
|
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
777
777
|
protected channel: Channel;
|
|
@@ -805,12 +805,12 @@ declare class Preview<TRenderer extends Renderer> {
|
|
|
805
805
|
storyIndex?: StoryIndex;
|
|
806
806
|
}): Promise<void>;
|
|
807
807
|
onUpdateGlobals({ globals: updatedGlobals, currentStory, }: {
|
|
808
|
-
globals: Globals;
|
|
808
|
+
globals: Globals$1;
|
|
809
809
|
currentStory?: PreparedStory<TRenderer>;
|
|
810
810
|
}): Promise<void>;
|
|
811
811
|
onUpdateArgs({ storyId, updatedArgs }: {
|
|
812
|
-
storyId: StoryId;
|
|
813
|
-
updatedArgs: Args;
|
|
812
|
+
storyId: StoryId$1;
|
|
813
|
+
updatedArgs: Args$1;
|
|
814
814
|
}): Promise<void>;
|
|
815
815
|
onRequestArgTypesInfo({ id, payload }: RequestData<ArgTypesRequestPayload>): Promise<void>;
|
|
816
816
|
onResetArgs({ storyId, argNames }: {
|
|
@@ -819,22 +819,22 @@ declare class Preview<TRenderer extends Renderer> {
|
|
|
819
819
|
}): Promise<void>;
|
|
820
820
|
onForceReRender(): Promise<void>;
|
|
821
821
|
onForceRemount({ storyId }: {
|
|
822
|
-
storyId: StoryId;
|
|
822
|
+
storyId: StoryId$1;
|
|
823
823
|
}): Promise<void>;
|
|
824
824
|
renderStoryToElement(story: PreparedStory<TRenderer>, element: TRenderer['canvasElement'], callbacks: RenderContextCallbacks<TRenderer>, options: StoryRenderOptions): () => Promise<void>;
|
|
825
825
|
teardownRender(render: StoryRender<TRenderer> | CsfDocsRender<TRenderer> | MdxDocsRender<TRenderer>, { viewModeChanged }?: {
|
|
826
826
|
viewModeChanged?: boolean;
|
|
827
827
|
}): Promise<void>;
|
|
828
828
|
loadStory({ storyId }: {
|
|
829
|
-
storyId: StoryId;
|
|
829
|
+
storyId: StoryId$1;
|
|
830
830
|
}): Promise<PreparedStory<TRenderer>>;
|
|
831
831
|
getStoryContext(story: PreparedStory<TRenderer>, { forceInitialArgs }?: {
|
|
832
832
|
forceInitialArgs?: boolean | undefined;
|
|
833
833
|
}): {
|
|
834
|
-
args: Args;
|
|
835
|
-
initialGlobals: Globals;
|
|
834
|
+
args: Args$1;
|
|
835
|
+
initialGlobals: Globals$1;
|
|
836
836
|
globalTypes: (storybook_internal_types.GlobalTypes & storybook_internal_types.StrictGlobalTypes) | undefined;
|
|
837
|
-
userGlobals: Globals;
|
|
837
|
+
userGlobals: Globals$1;
|
|
838
838
|
reporting: ReporterAPI;
|
|
839
839
|
globals: {
|
|
840
840
|
[x: string]: any;
|
|
@@ -847,12 +847,12 @@ declare class Preview<TRenderer extends Renderer> {
|
|
|
847
847
|
T: any;
|
|
848
848
|
})["component"]> | undefined;
|
|
849
849
|
parameters: storybook_internal_types.Parameters;
|
|
850
|
-
initialArgs: Args;
|
|
851
|
-
argTypes: storybook_internal_types.StrictArgTypes<Args>;
|
|
850
|
+
initialArgs: Args$1;
|
|
851
|
+
argTypes: storybook_internal_types.StrictArgTypes<Args$1>;
|
|
852
852
|
componentId: storybook_internal_types.ComponentId;
|
|
853
853
|
title: storybook_internal_types.ComponentTitle;
|
|
854
854
|
kind: storybook_internal_types.ComponentTitle;
|
|
855
|
-
id: StoryId;
|
|
855
|
+
id: StoryId$1;
|
|
856
856
|
name: storybook_internal_types.StoryName;
|
|
857
857
|
story: storybook_internal_types.StoryName;
|
|
858
858
|
tags: storybook_internal_types.Tag[];
|
|
@@ -860,32 +860,32 @@ declare class Preview<TRenderer extends Renderer> {
|
|
|
860
860
|
originalStoryFn: storybook_internal_types.ArgsStoryFn<TRenderer>;
|
|
861
861
|
undecoratedStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
862
862
|
unboundStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
863
|
-
applyLoaders: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => Promise<Record<string, any>>;
|
|
864
|
-
applyBeforeEach: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => Promise<CleanupCallback[]>;
|
|
865
|
-
applyAfterEach: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => Promise<void>;
|
|
866
|
-
playFunction?: ((context: storybook_internal_types.StoryContext<TRenderer, Args>) => Promise<void> | void) | undefined;
|
|
863
|
+
applyLoaders: (context: storybook_internal_types.StoryContext<TRenderer, Args$1>) => Promise<Record<string, any>>;
|
|
864
|
+
applyBeforeEach: (context: storybook_internal_types.StoryContext<TRenderer, Args$1>) => Promise<CleanupCallback[]>;
|
|
865
|
+
applyAfterEach: (context: storybook_internal_types.StoryContext<TRenderer, Args$1>) => Promise<void>;
|
|
866
|
+
playFunction?: ((context: storybook_internal_types.StoryContext<TRenderer, Args$1>) => Promise<void> | void) | undefined;
|
|
867
867
|
runStep: storybook_internal_types.StepRunner<TRenderer>;
|
|
868
|
-
mount: (context: storybook_internal_types.StoryContext<TRenderer, Args>) => () => Promise<storybook_internal_types.Canvas>;
|
|
868
|
+
mount: (context: storybook_internal_types.StoryContext<TRenderer, Args$1>) => () => Promise<storybook_internal_types.Canvas>;
|
|
869
869
|
testingLibraryRender?: (...args: never[]) => unknown;
|
|
870
870
|
renderToCanvas?: RenderToCanvas<TRenderer> | undefined;
|
|
871
871
|
usesMount: boolean;
|
|
872
|
-
storyGlobals: Globals;
|
|
873
|
-
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer, Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
872
|
+
storyGlobals: Globals$1;
|
|
873
|
+
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer$1, Args$1>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
874
874
|
extract(options?: {
|
|
875
875
|
includeDocsOnly: boolean;
|
|
876
|
-
}): Promise<Record<string, storybook_internal_types.StoryContextForEnhancers<TRenderer, Args>>>;
|
|
876
|
+
}): Promise<Record<string, storybook_internal_types.StoryContextForEnhancers<TRenderer, Args$1>>>;
|
|
877
877
|
renderPreviewEntryError(reason: string, err: Error): void;
|
|
878
878
|
}
|
|
879
879
|
|
|
880
880
|
interface SelectionSpecifier {
|
|
881
881
|
storySpecifier: StorySpecifier;
|
|
882
|
-
viewMode: ViewMode;
|
|
883
|
-
args?: Args;
|
|
884
|
-
globals?: Args;
|
|
882
|
+
viewMode: ViewMode$1;
|
|
883
|
+
args?: Args$1;
|
|
884
|
+
globals?: Args$1;
|
|
885
885
|
}
|
|
886
886
|
interface Selection {
|
|
887
|
-
storyId: StoryId;
|
|
888
|
-
viewMode: ViewMode;
|
|
887
|
+
storyId: StoryId$1;
|
|
888
|
+
viewMode: ViewMode$1;
|
|
889
889
|
}
|
|
890
890
|
interface SelectionStore {
|
|
891
891
|
selectionSpecifier: SelectionSpecifier | null;
|
|
@@ -914,8 +914,8 @@ interface View<TStorybookRoot> {
|
|
|
914
914
|
showStoryDuringRender(): void;
|
|
915
915
|
}
|
|
916
916
|
|
|
917
|
-
type PossibleRender<TRenderer extends Renderer> = StoryRender<TRenderer> | CsfDocsRender<TRenderer> | MdxDocsRender<TRenderer>;
|
|
918
|
-
declare class PreviewWithSelection<TRenderer extends Renderer> extends Preview<TRenderer> {
|
|
917
|
+
type PossibleRender<TRenderer extends Renderer$1> = StoryRender<TRenderer> | CsfDocsRender<TRenderer> | MdxDocsRender<TRenderer>;
|
|
918
|
+
declare class PreviewWithSelection<TRenderer extends Renderer$1> extends Preview<TRenderer> {
|
|
919
919
|
importFn: ModuleImportFn;
|
|
920
920
|
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
921
921
|
selectionStore: SelectionStore;
|
|
@@ -936,27 +936,27 @@ declare class PreviewWithSelection<TRenderer extends Renderer> extends Preview<T
|
|
|
936
936
|
}): Promise<void>;
|
|
937
937
|
onKeydown(event: KeyboardEvent): void;
|
|
938
938
|
onSetCurrentStory(selection: {
|
|
939
|
-
storyId: StoryId;
|
|
940
|
-
viewMode?: ViewMode;
|
|
939
|
+
storyId: StoryId$1;
|
|
940
|
+
viewMode?: ViewMode$1;
|
|
941
941
|
}): Promise<void>;
|
|
942
942
|
onUpdateQueryParams(queryParams: any): void;
|
|
943
943
|
onUpdateGlobals({ globals }: {
|
|
944
|
-
globals: Globals;
|
|
944
|
+
globals: Globals$1;
|
|
945
945
|
}): Promise<void>;
|
|
946
946
|
onUpdateArgs({ storyId, updatedArgs }: {
|
|
947
|
-
storyId: StoryId;
|
|
948
|
-
updatedArgs: Args;
|
|
947
|
+
storyId: StoryId$1;
|
|
948
|
+
updatedArgs: Args$1;
|
|
949
949
|
}): Promise<void>;
|
|
950
950
|
onPreloadStories({ ids }: {
|
|
951
951
|
ids: string[];
|
|
952
952
|
}): Promise<void>;
|
|
953
953
|
protected renderSelection({ persistedArgs }?: {
|
|
954
|
-
persistedArgs?: Args;
|
|
954
|
+
persistedArgs?: Args$1;
|
|
955
955
|
}): Promise<void>;
|
|
956
956
|
teardownRender(render: PossibleRender<TRenderer>, { viewModeChanged }?: {
|
|
957
957
|
viewModeChanged?: boolean;
|
|
958
958
|
}): Promise<void>;
|
|
959
|
-
mainStoryCallbacks(storyId: StoryId): {
|
|
959
|
+
mainStoryCallbacks(storyId: StoryId$1): {
|
|
960
960
|
showStoryDuringRender: () => void;
|
|
961
961
|
showMain: () => void;
|
|
962
962
|
showError: (err: {
|
|
@@ -968,14 +968,14 @@ declare class PreviewWithSelection<TRenderer extends Renderer> extends Preview<T
|
|
|
968
968
|
renderPreviewEntryError(reason: string, err: Error): void;
|
|
969
969
|
renderMissingStory(): void;
|
|
970
970
|
renderStoryLoadingException(storySpecifier: StorySpecifier, err: Error): void;
|
|
971
|
-
renderException(storyId: StoryId, error: Error): void;
|
|
972
|
-
renderError(storyId: StoryId, { title, description }: {
|
|
971
|
+
renderException(storyId: StoryId$1, error: Error): void;
|
|
972
|
+
renderError(storyId: StoryId$1, { title, description }: {
|
|
973
973
|
title: string;
|
|
974
974
|
description: string;
|
|
975
975
|
}): void;
|
|
976
976
|
}
|
|
977
977
|
|
|
978
|
-
declare class PreviewWeb<TRenderer extends Renderer> extends PreviewWithSelection<TRenderer> {
|
|
978
|
+
declare class PreviewWeb<TRenderer extends Renderer$1> extends PreviewWithSelection<TRenderer> {
|
|
979
979
|
importFn: ModuleImportFn;
|
|
980
980
|
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
981
981
|
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>);
|
|
@@ -1034,6 +1034,274 @@ 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 SBBaseType {
|
|
1044
|
+
required?: boolean;
|
|
1045
|
+
raw?: string;
|
|
1046
|
+
}
|
|
1047
|
+
type SBScalarType = SBBaseType & {
|
|
1048
|
+
name: 'boolean' | 'string' | 'number' | 'function' | 'symbol';
|
|
1049
|
+
};
|
|
1050
|
+
type SBArrayType = SBBaseType & {
|
|
1051
|
+
name: 'array';
|
|
1052
|
+
value: SBType;
|
|
1053
|
+
};
|
|
1054
|
+
type SBObjectType = SBBaseType & {
|
|
1055
|
+
name: 'object';
|
|
1056
|
+
value: Record<string, SBType>;
|
|
1057
|
+
};
|
|
1058
|
+
type SBEnumType = SBBaseType & {
|
|
1059
|
+
name: 'enum';
|
|
1060
|
+
value: (string | number)[];
|
|
1061
|
+
};
|
|
1062
|
+
type SBIntersectionType = SBBaseType & {
|
|
1063
|
+
name: 'intersection';
|
|
1064
|
+
value: SBType[];
|
|
1065
|
+
};
|
|
1066
|
+
type SBUnionType = SBBaseType & {
|
|
1067
|
+
name: 'union';
|
|
1068
|
+
value: SBType[];
|
|
1069
|
+
};
|
|
1070
|
+
type SBOtherType = SBBaseType & {
|
|
1071
|
+
name: 'other';
|
|
1072
|
+
value: string;
|
|
1073
|
+
};
|
|
1074
|
+
type SBType = SBScalarType | SBEnumType | SBArrayType | SBObjectType | SBIntersectionType | SBUnionType | SBOtherType;
|
|
1075
|
+
|
|
1076
|
+
type StoryId = string;
|
|
1077
|
+
type ComponentId = string;
|
|
1078
|
+
type ComponentTitle = string;
|
|
1079
|
+
type StoryName = string;
|
|
1080
|
+
type Tag = string;
|
|
1081
|
+
interface StoryIdentifier {
|
|
1082
|
+
componentId: ComponentId;
|
|
1083
|
+
title: ComponentTitle;
|
|
1084
|
+
/** @deprecated */
|
|
1085
|
+
kind: ComponentTitle;
|
|
1086
|
+
id: StoryId;
|
|
1087
|
+
name: StoryName;
|
|
1088
|
+
/** @deprecated */
|
|
1089
|
+
story: StoryName;
|
|
1090
|
+
tags: Tag[];
|
|
1091
|
+
}
|
|
1092
|
+
interface Parameters {
|
|
1093
|
+
[name: string]: any;
|
|
1094
|
+
}
|
|
1095
|
+
type ControlType = 'object' | 'boolean' | 'check' | 'inline-check' | 'radio' | 'inline-radio' | 'select' | 'multi-select' | 'number' | 'range' | 'file' | 'color' | 'date' | 'text';
|
|
1096
|
+
type ConditionalTest = {
|
|
1097
|
+
truthy?: boolean;
|
|
1098
|
+
} | {
|
|
1099
|
+
exists: boolean;
|
|
1100
|
+
} | {
|
|
1101
|
+
eq: any;
|
|
1102
|
+
} | {
|
|
1103
|
+
neq: any;
|
|
1104
|
+
};
|
|
1105
|
+
type ConditionalValue = {
|
|
1106
|
+
arg: string;
|
|
1107
|
+
} | {
|
|
1108
|
+
global: string;
|
|
1109
|
+
};
|
|
1110
|
+
type Conditional = ConditionalValue & ConditionalTest;
|
|
1111
|
+
interface ControlBase {
|
|
1112
|
+
[key: string]: any;
|
|
1113
|
+
/**
|
|
1114
|
+
* @see https://storybook.js.org/docs/api/arg-types#controltype
|
|
1115
|
+
*/
|
|
1116
|
+
type?: ControlType;
|
|
1117
|
+
disable?: boolean;
|
|
1118
|
+
}
|
|
1119
|
+
interface Report {
|
|
1120
|
+
type: string;
|
|
1121
|
+
version?: number;
|
|
1122
|
+
result: unknown;
|
|
1123
|
+
status: 'failed' | 'passed' | 'warning';
|
|
1124
|
+
}
|
|
1125
|
+
interface ReportingAPI {
|
|
1126
|
+
reports: Report[];
|
|
1127
|
+
addReport: (report: Report) => void;
|
|
1128
|
+
}
|
|
1129
|
+
type Control = ControlType | false | (ControlBase & (ControlBase | {
|
|
1130
|
+
type: 'color';
|
|
1131
|
+
/**
|
|
1132
|
+
* @see https://storybook.js.org/docs/api/arg-types#controlpresetcolors
|
|
1133
|
+
*/
|
|
1134
|
+
presetColors?: string[];
|
|
1135
|
+
} | {
|
|
1136
|
+
type: 'file';
|
|
1137
|
+
/**
|
|
1138
|
+
* @see https://storybook.js.org/docs/api/arg-types#controlaccept
|
|
1139
|
+
*/
|
|
1140
|
+
accept?: string;
|
|
1141
|
+
} | {
|
|
1142
|
+
type: 'inline-check' | 'radio' | 'inline-radio' | 'select' | 'multi-select';
|
|
1143
|
+
/**
|
|
1144
|
+
* @see https://storybook.js.org/docs/api/arg-types#controllabels
|
|
1145
|
+
*/
|
|
1146
|
+
labels?: {
|
|
1147
|
+
[options: string]: string;
|
|
1148
|
+
};
|
|
1149
|
+
} | {
|
|
1150
|
+
type: 'number' | 'range';
|
|
1151
|
+
/**
|
|
1152
|
+
* @see https://storybook.js.org/docs/api/arg-types#controlmax
|
|
1153
|
+
*/
|
|
1154
|
+
max?: number;
|
|
1155
|
+
/**
|
|
1156
|
+
* @see https://storybook.js.org/docs/api/arg-types#controlmin
|
|
1157
|
+
*/
|
|
1158
|
+
min?: number;
|
|
1159
|
+
/**
|
|
1160
|
+
* @see https://storybook.js.org/docs/api/arg-types#controlstep
|
|
1161
|
+
*/
|
|
1162
|
+
step?: number;
|
|
1163
|
+
}));
|
|
1164
|
+
interface InputType {
|
|
1165
|
+
/**
|
|
1166
|
+
* @see https://storybook.js.org/docs/api/arg-types#control
|
|
1167
|
+
*/
|
|
1168
|
+
control?: Control;
|
|
1169
|
+
/**
|
|
1170
|
+
* @see https://storybook.js.org/docs/api/arg-types#description
|
|
1171
|
+
*/
|
|
1172
|
+
description?: string;
|
|
1173
|
+
/**
|
|
1174
|
+
* @see https://storybook.js.org/docs/api/arg-types#if
|
|
1175
|
+
*/
|
|
1176
|
+
if?: Conditional;
|
|
1177
|
+
/**
|
|
1178
|
+
* @see https://storybook.js.org/docs/api/arg-types#mapping
|
|
1179
|
+
*/
|
|
1180
|
+
mapping?: {
|
|
1181
|
+
[key: string]: any;
|
|
1182
|
+
};
|
|
1183
|
+
/**
|
|
1184
|
+
* @see https://storybook.js.org/docs/api/arg-types#name
|
|
1185
|
+
*/
|
|
1186
|
+
name?: string;
|
|
1187
|
+
/**
|
|
1188
|
+
* @see https://storybook.js.org/docs/api/arg-types#options
|
|
1189
|
+
*/
|
|
1190
|
+
options?: readonly any[];
|
|
1191
|
+
/**
|
|
1192
|
+
* @see https://storybook.js.org/docs/api/arg-types#table
|
|
1193
|
+
*/
|
|
1194
|
+
table?: {
|
|
1195
|
+
[key: string]: unknown;
|
|
1196
|
+
/**
|
|
1197
|
+
* @see https://storybook.js.org/docs/api/arg-types#tablecategory
|
|
1198
|
+
*/
|
|
1199
|
+
category?: string;
|
|
1200
|
+
/**
|
|
1201
|
+
* @see https://storybook.js.org/docs/api/arg-types#tabledefaultvalue
|
|
1202
|
+
*/
|
|
1203
|
+
defaultValue?: {
|
|
1204
|
+
summary?: string;
|
|
1205
|
+
detail?: string;
|
|
1206
|
+
};
|
|
1207
|
+
/**
|
|
1208
|
+
* @see https://storybook.js.org/docs/api/arg-types#tabledisable
|
|
1209
|
+
*/
|
|
1210
|
+
disable?: boolean;
|
|
1211
|
+
/**
|
|
1212
|
+
* @see https://storybook.js.org/docs/api/arg-types#tablesubcategory
|
|
1213
|
+
*/
|
|
1214
|
+
subcategory?: string;
|
|
1215
|
+
/**
|
|
1216
|
+
* @see https://storybook.js.org/docs/api/arg-types#tabletype
|
|
1217
|
+
*/
|
|
1218
|
+
type?: {
|
|
1219
|
+
summary?: string;
|
|
1220
|
+
detail?: string;
|
|
1221
|
+
};
|
|
1222
|
+
};
|
|
1223
|
+
/**
|
|
1224
|
+
* @see https://storybook.js.org/docs/api/arg-types#type
|
|
1225
|
+
*/
|
|
1226
|
+
type?: SBType | SBScalarType['name'];
|
|
1227
|
+
/**
|
|
1228
|
+
* @see https://storybook.js.org/docs/api/arg-types#defaultvalue
|
|
1229
|
+
*
|
|
1230
|
+
* @deprecated Use `table.defaultValue.summary` instead.
|
|
1231
|
+
*/
|
|
1232
|
+
defaultValue?: any;
|
|
1233
|
+
[key: string]: any;
|
|
1234
|
+
}
|
|
1235
|
+
interface StrictInputType extends InputType {
|
|
1236
|
+
name: string;
|
|
1237
|
+
type?: SBType;
|
|
1238
|
+
}
|
|
1239
|
+
interface Args {
|
|
1240
|
+
[name: string]: any;
|
|
1241
|
+
}
|
|
1242
|
+
type StrictArgTypes<TArgs = Args> = {
|
|
1243
|
+
[name in keyof TArgs]: StrictInputType;
|
|
1244
|
+
};
|
|
1245
|
+
interface Globals {
|
|
1246
|
+
[name: string]: any;
|
|
1247
|
+
}
|
|
1248
|
+
interface Renderer {
|
|
1249
|
+
/** What is the type of the `component` annotation in this renderer? */
|
|
1250
|
+
component: unknown;
|
|
1251
|
+
/** What does the story function return in this renderer? */
|
|
1252
|
+
storyResult: unknown;
|
|
1253
|
+
/** What type of element does this renderer render to? */
|
|
1254
|
+
canvasElement: unknown;
|
|
1255
|
+
mount(): Promise<Canvas>;
|
|
1256
|
+
T?: unknown;
|
|
1257
|
+
}
|
|
1258
|
+
interface StoryContextForEnhancers<TRenderer extends Renderer = Renderer, TArgs = Args> extends StoryIdentifier {
|
|
1259
|
+
component?: (TRenderer & {
|
|
1260
|
+
T: any;
|
|
1261
|
+
})['component'];
|
|
1262
|
+
subcomponents?: Record<string, (TRenderer & {
|
|
1263
|
+
T: any;
|
|
1264
|
+
})['component']>;
|
|
1265
|
+
parameters: Parameters;
|
|
1266
|
+
initialArgs: TArgs;
|
|
1267
|
+
argTypes: StrictArgTypes<TArgs>;
|
|
1268
|
+
}
|
|
1269
|
+
interface StoryContextUpdate<TArgs = Args> {
|
|
1270
|
+
args?: TArgs;
|
|
1271
|
+
globals?: Globals;
|
|
1272
|
+
[key: string]: any;
|
|
1273
|
+
}
|
|
1274
|
+
type ViewMode = 'story' | 'docs';
|
|
1275
|
+
interface Canvas {
|
|
1276
|
+
}
|
|
1277
|
+
interface StoryContext<TRenderer extends Renderer = Renderer, TArgs = Args> extends StoryContextForEnhancers<TRenderer, TArgs>, Required<StoryContextUpdate<TArgs>> {
|
|
1278
|
+
loaded: Record<string, any>;
|
|
1279
|
+
abortSignal: AbortSignal;
|
|
1280
|
+
canvasElement: TRenderer['canvasElement'];
|
|
1281
|
+
hooks: unknown;
|
|
1282
|
+
originalStoryFn: StoryFn<TRenderer>;
|
|
1283
|
+
viewMode: ViewMode;
|
|
1284
|
+
step: StepFunction<TRenderer, TArgs>;
|
|
1285
|
+
context: this;
|
|
1286
|
+
canvas: Canvas;
|
|
1287
|
+
mount: TRenderer['mount'];
|
|
1288
|
+
reporting: ReportingAPI;
|
|
1289
|
+
}
|
|
1290
|
+
/** @deprecated Use {@link StoryContext} instead. */
|
|
1291
|
+
interface PlayFunctionContext<TRenderer extends Renderer = Renderer, TArgs = Args> extends StoryContext<TRenderer, TArgs> {
|
|
1292
|
+
}
|
|
1293
|
+
type StepLabel = string;
|
|
1294
|
+
type StepFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (label: StepLabel, play: PlayFunction<TRenderer, TArgs>) => Promise<void> | void;
|
|
1295
|
+
type PlayFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: PlayFunctionContext<TRenderer, TArgs>) => Promise<void> | void;
|
|
1296
|
+
type LegacyStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContext<TRenderer, TArgs>) => TRenderer['storyResult'];
|
|
1297
|
+
type ArgsStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (args: TArgs, context: StoryContext<TRenderer, TArgs>) => (TRenderer & {
|
|
1298
|
+
T: TArgs;
|
|
1299
|
+
})['storyResult'];
|
|
1300
|
+
type StoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = LegacyStoryFn<TRenderer, TArgs> | ArgsStoryFn<TRenderer, TArgs>;
|
|
1301
|
+
|
|
1302
|
+
type ReducedStoryContext = Omit<StoryContext<any, Args>, 'abortSignal' | 'canvasElement' | 'step' | 'context'>;
|
|
1303
|
+
declare function emitTransformCode(source: string | undefined, context: ReducedStoryContext): Promise<void>;
|
|
1304
|
+
|
|
1037
1305
|
declare function getCoreAnnotations(): any[];
|
|
1038
1306
|
|
|
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 };
|
|
1307
|
+
export { DocsContext, HooksContext, Preview, PreviewWeb, PreviewWithSelection, type PropDescriptor, type Report$1 as Report, ReporterAPI, type SelectionStore, StoryStore, UrlStore, type View, WebView, addons, applyHooks, combineArgs, combineParameters, composeConfigs, composeStepRunners, composeStories, composeStory, createPlaywrightTest, decorateStory, defaultDecorateStory, definePreview, emitTransformCode, 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 };
|