storybook 9.0.0-alpha.2 → 9.0.0-alpha.20
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/README.md +1 -1
- package/assets/docs/addon-backgrounds.gif +0 -0
- package/assets/docs/addon-controls-args-annotated.png +0 -0
- package/assets/docs/addon-controls-args-background-color.png +0 -0
- package/assets/docs/addon-controls-args-background-string.png +0 -0
- package/assets/docs/addon-controls-args-docs.png +0 -0
- package/assets/docs/addon-controls-args-logging.png +0 -0
- package/assets/docs/addon-controls-args-no-annotation.png +0 -0
- package/assets/docs/addon-controls-args-reflow-slider.png +0 -0
- package/assets/docs/addon-controls-args-reflow.png +0 -0
- package/assets/docs/addon-controls-args-template.png +0 -0
- package/assets/docs/addon-controls-expanded.png +0 -0
- package/assets/docs/addon-controls-hero.gif +0 -0
- package/assets/docs/addon-controls-install.png +0 -0
- package/assets/docs/hero.gif +0 -0
- package/assets/docs/highlight.png +0 -0
- package/assets/docs/viewport.png +0 -0
- package/bin/index.cjs +2 -2
- package/dist/actions/decorator.d.ts +6 -0
- package/dist/actions/decorator.js +138 -0
- package/dist/actions/index.cjs +126 -0
- package/dist/actions/index.d.ts +102 -0
- package/dist/actions/index.js +111 -0
- package/dist/actions/preview.cjs +164 -0
- package/dist/actions/preview.d.ts +54 -0
- package/dist/actions/preview.js +155 -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 +66 -89
- package/dist/bin/index.js +62 -85
- package/dist/builder-manager/index.cjs +523 -540
- package/dist/builder-manager/index.js +544 -561
- package/dist/channels/index.cjs +1026 -981
- package/dist/channels/index.js +1194 -1165
- package/dist/cli/bin/index.cjs +483 -483
- package/dist/cli/bin/index.js +495 -495
- package/dist/cli/index.cjs +2279 -2295
- package/dist/cli/index.d.ts +4 -8
- package/dist/cli/index.js +740 -756
- package/dist/client-logger/index.cjs +56 -88
- package/dist/client-logger/index.js +41 -47
- package/dist/common/index.cjs +2496 -2480
- package/dist/common/index.d.ts +5 -29
- package/dist/common/index.js +2679 -2663
- package/dist/component-testing/index.cjs +23 -0
- package/dist/component-testing/index.d.ts +3 -0
- package/dist/component-testing/index.js +5 -0
- package/dist/component-testing/preview.cjs +40 -0
- package/dist/component-testing/preview.d.ts +5 -0
- package/dist/component-testing/preview.js +25 -0
- package/dist/components/index.cjs +11709 -20418
- package/dist/components/index.d.ts +94 -346
- package/dist/components/index.js +5827 -19157
- package/dist/controls/decorator.d.ts +5 -0
- package/dist/controls/decorator.js +8 -0
- package/dist/controls/index.cjs +26 -0
- package/dist/controls/index.d.ts +39 -0
- package/dist/controls/index.js +6 -0
- package/dist/controls/preview.cjs +26 -0
- package/dist/controls/preview.d.ts +54 -0
- package/dist/controls/preview.js +9 -0
- package/dist/core-events/index.cjs +91 -106
- package/dist/core-events/index.d.ts +139 -104
- package/dist/core-events/index.js +79 -94
- package/dist/core-server/index.cjs +14413 -13924
- package/dist/core-server/index.d.ts +270 -3
- package/dist/core-server/index.js +14003 -13519
- package/dist/core-server/presets/common-manager.css +170 -0
- package/dist/core-server/presets/common-manager.js +12099 -17
- package/dist/core-server/presets/common-preset.cjs +2760 -2914
- package/dist/core-server/presets/common-preset.js +2852 -3007
- package/dist/csf/index.cjs +76 -120
- package/dist/csf/index.d.ts +2 -6
- package/dist/csf/index.js +69 -113
- package/dist/csf-tools/index.cjs +412 -403
- package/dist/csf-tools/index.d.ts +0 -4
- package/dist/csf-tools/index.js +410 -401
- package/dist/docs-tools/index.cjs +2569 -575
- package/dist/docs-tools/index.d.ts +2 -2
- package/dist/docs-tools/index.js +2557 -564
- 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 +2207 -2342
- package/dist/instrumenter/index.d.ts +8 -7
- package/dist/instrumenter/index.js +2438 -2620
- package/dist/manager/globals-module-info.cjs +290 -151
- package/dist/manager/globals-module-info.d.ts +1 -1
- package/dist/manager/globals-module-info.js +274 -135
- package/dist/manager/globals-runtime.js +60016 -28331
- package/dist/manager/globals.cjs +23 -19
- package/dist/manager/globals.d.ts +8 -5
- package/dist/manager/globals.js +10 -6
- package/dist/manager/runtime.js +4645 -3946
- package/dist/manager-api/index.cjs +4228 -3833
- package/dist/manager-api/index.d.ts +398 -102
- package/dist/manager-api/index.js +3676 -3291
- package/dist/manager-errors.d.ts +25 -1
- package/dist/manager-errors.js +42 -26
- 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/globals.cjs +21 -17
- package/dist/preview/globals.d.ts +4 -1
- package/dist/preview/globals.js +6 -2
- package/dist/preview/runtime.js +45697 -6618
- package/dist/preview-api/index.cjs +1363 -1898
- package/dist/preview-api/index.d.ts +449 -498
- package/dist/preview-api/index.js +1622 -2095
- package/dist/preview-errors.cjs +99 -82
- package/dist/preview-errors.d.ts +25 -1
- package/dist/preview-errors.js +110 -94
- package/dist/router/index.cjs +847 -871
- package/dist/router/index.js +193 -199
- package/dist/server-errors.cjs +156 -125
- package/dist/server-errors.d.ts +28 -2
- package/dist/server-errors.js +150 -119
- package/dist/telemetry/index.cjs +1050 -1977
- package/dist/telemetry/index.d.ts +26 -5
- package/dist/telemetry/index.js +1085 -2008
- package/dist/test/index.cjs +35686 -0
- package/dist/test/index.d.ts +186 -0
- package/dist/test/index.js +33752 -0
- package/dist/test/preview.cjs +15870 -0
- package/dist/test/preview.d.ts +54 -0
- package/dist/test/preview.js +14441 -0
- package/dist/test/spy.cjs +258 -0
- package/dist/test/spy.d.ts +66 -0
- package/dist/test/spy.js +240 -0
- package/dist/theming/create.cjs +79 -2269
- package/dist/theming/create.js +67 -841
- package/dist/theming/index.cjs +1065 -3232
- package/dist/theming/index.js +951 -1719
- package/dist/types/index.cjs +11 -12
- package/dist/types/index.d.ts +612 -157
- package/dist/types/index.js +1 -2
- package/dist/viewport/index.cjs +310 -0
- package/dist/viewport/index.d.ts +320 -0
- package/dist/viewport/index.js +290 -0
- package/dist/viewport/preview.cjs +35 -0
- package/dist/viewport/preview.d.ts +68 -0
- package/dist/viewport/preview.js +19 -0
- package/package.json +359 -12
|
@@ -1,8 +1,7 @@
|
|
|
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,
|
|
4
|
-
import
|
|
5
|
-
import { CleanupCallback, Canvas } from 'storybook/internal/csf';
|
|
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
|
+
import { CleanupCallback } from 'storybook/internal/csf';
|
|
6
5
|
import { RequestData, ArgTypesRequestPayload } from 'storybook/internal/core-events';
|
|
7
6
|
|
|
8
7
|
declare class AddonStore {
|
|
@@ -17,7 +16,7 @@ declare class AddonStore {
|
|
|
17
16
|
}
|
|
18
17
|
declare const addons: AddonStore;
|
|
19
18
|
|
|
20
|
-
declare function definePreview(config: ProjectAnnotations<Renderer>): ProjectAnnotations<Renderer>;
|
|
19
|
+
declare function definePreview(config: ProjectAnnotations<Renderer$1>): ProjectAnnotations<Renderer$1>;
|
|
21
20
|
|
|
22
21
|
interface Hook {
|
|
23
22
|
name: string;
|
|
@@ -29,7 +28,7 @@ interface Effect {
|
|
|
29
28
|
destroy?: (() => void) | void;
|
|
30
29
|
}
|
|
31
30
|
type AbstractFunction = (...args: any[]) => any;
|
|
32
|
-
declare class HooksContext<TRenderer extends Renderer, TArgs extends Args = Args> {
|
|
31
|
+
declare class HooksContext<TRenderer extends Renderer$1, TArgs extends Args$1 = Args$1> {
|
|
33
32
|
hookListsMap: WeakMap<AbstractFunction, Hook[]>;
|
|
34
33
|
mountedDecorators: Set<AbstractFunction>;
|
|
35
34
|
prevMountedDecorators: Set<AbstractFunction>;
|
|
@@ -40,8 +39,8 @@ declare class HooksContext<TRenderer extends Renderer, TArgs extends Args = Args
|
|
|
40
39
|
prevEffects: Effect[];
|
|
41
40
|
currentDecoratorName: string | null;
|
|
42
41
|
hasUpdates: boolean;
|
|
43
|
-
currentContext: StoryContext<TRenderer, TArgs> | null;
|
|
44
|
-
renderListener: (storyId: StoryId) => void;
|
|
42
|
+
currentContext: StoryContext$1<TRenderer, TArgs> | null;
|
|
43
|
+
renderListener: (storyId: StoryId$1) => void;
|
|
45
44
|
constructor();
|
|
46
45
|
init(): void;
|
|
47
46
|
clean(): void;
|
|
@@ -50,7 +49,7 @@ declare class HooksContext<TRenderer extends Renderer, TArgs extends Args = Args
|
|
|
50
49
|
addRenderListeners(): void;
|
|
51
50
|
removeRenderListeners(): void;
|
|
52
51
|
}
|
|
53
|
-
declare const applyHooks: <TRenderer extends Renderer>(applyDecorators: DecoratorApplicator<TRenderer>) => DecoratorApplicator<TRenderer>;
|
|
52
|
+
declare const applyHooks: <TRenderer extends Renderer$1>(applyDecorators: DecoratorApplicator<TRenderer>) => DecoratorApplicator<TRenderer>;
|
|
54
53
|
/**
|
|
55
54
|
* Returns a memoized value.
|
|
56
55
|
*
|
|
@@ -178,11 +177,11 @@ declare function useReducer<S, I, A>(reducer: (state: S, action: A) => S, initia
|
|
|
178
177
|
* @returns {void}
|
|
179
178
|
*/
|
|
180
179
|
declare function useEffect(create: () => (() => void) | void, deps?: any[]): void;
|
|
181
|
-
interface Listener
|
|
180
|
+
interface Listener {
|
|
182
181
|
(...args: any[]): void;
|
|
183
182
|
}
|
|
184
183
|
interface EventMap {
|
|
185
|
-
[eventId: string]: Listener
|
|
184
|
+
[eventId: string]: Listener;
|
|
186
185
|
}
|
|
187
186
|
/**
|
|
188
187
|
* Subscribes to events emitted by the Storybook channel and returns a function to emit events.
|
|
@@ -216,7 +215,7 @@ declare function useChannel(eventMap: EventMap, deps?: any[]): (eventName: strin
|
|
|
216
215
|
* @template TArgs The type of the story's args.
|
|
217
216
|
* @returns {StoryContext<TRenderer>} The current story context.
|
|
218
217
|
*/
|
|
219
|
-
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>;
|
|
220
219
|
/**
|
|
221
220
|
* Returns the value of a specific parameter for the current story, or a default value if the
|
|
222
221
|
* parameter is not set.
|
|
@@ -252,7 +251,7 @@ declare function useParameter<S>(parameterKey: string, defaultValue?: S): S | un
|
|
|
252
251
|
* @returns {[TArgs, (newArgs: Partial<TArgs>) => void, (argNames?: (keyof TArgs)[]) => void]} An
|
|
253
252
|
* array containing the current args, a function to update them, and a function to reset them.
|
|
254
253
|
*/
|
|
255
|
-
declare function useArgs<TArgs extends Args = Args>(): [
|
|
254
|
+
declare function useArgs<TArgs extends Args$1 = Args$1>(): [
|
|
256
255
|
TArgs,
|
|
257
256
|
(newArgs: Partial<TArgs>) => void,
|
|
258
257
|
(argNames?: (keyof TArgs)[]) => void
|
|
@@ -271,7 +270,7 @@ declare function useArgs<TArgs extends Args = Args>(): [
|
|
|
271
270
|
* @returns {[Args, (newGlobals: Args) => void]} An array containing the current global args, and a
|
|
272
271
|
* function to update them.
|
|
273
272
|
*/
|
|
274
|
-
declare function useGlobals(): [Args, (newGlobals: Args) => void];
|
|
273
|
+
declare function useGlobals(): [Args$1, (newGlobals: Args$1) => void];
|
|
275
274
|
|
|
276
275
|
type MakeDecoratorResult = (...args: any) => any;
|
|
277
276
|
interface MakeDecoratorOptions {
|
|
@@ -312,362 +311,56 @@ declare const makeDecorator: ({ name, parameterName, wrapper, skipIfNoParameters
|
|
|
312
311
|
|
|
313
312
|
declare function mockChannel(): Channel;
|
|
314
313
|
|
|
315
|
-
type EnvironmentType = (typeof UniversalStore.Environment)[keyof typeof UniversalStore.Environment];
|
|
316
|
-
type StatusType = (typeof UniversalStore.Status)[keyof typeof UniversalStore.Status];
|
|
317
|
-
type StateUpdater<TState> = (prevState: TState) => TState;
|
|
318
|
-
type Actor = {
|
|
319
|
-
id: string;
|
|
320
|
-
type: (typeof UniversalStore.ActorType)[keyof typeof UniversalStore.ActorType];
|
|
321
|
-
environment: EnvironmentType;
|
|
322
|
-
};
|
|
323
|
-
type EventInfo = {
|
|
324
|
-
actor: Actor;
|
|
325
|
-
forwardingActor?: Actor;
|
|
326
|
-
};
|
|
327
|
-
type Listener<TEvent> = (event: TEvent, eventInfo: EventInfo) => void;
|
|
328
|
-
type BaseEvent = {
|
|
329
|
-
type: string;
|
|
330
|
-
payload?: any;
|
|
331
|
-
};
|
|
332
|
-
interface SetStateEvent<TState> extends BaseEvent {
|
|
333
|
-
type: typeof UniversalStore.InternalEventType.SET_STATE;
|
|
334
|
-
payload: {
|
|
335
|
-
state: TState;
|
|
336
|
-
previousState: TState;
|
|
337
|
-
};
|
|
338
|
-
}
|
|
339
|
-
interface ExistingStateRequestEvent extends BaseEvent {
|
|
340
|
-
type: typeof UniversalStore.InternalEventType.EXISTING_STATE_REQUEST;
|
|
341
|
-
payload: never;
|
|
342
|
-
}
|
|
343
|
-
interface ExistingStateResponseEvent<TState> extends BaseEvent {
|
|
344
|
-
type: typeof UniversalStore.InternalEventType.EXISTING_STATE_RESPONSE;
|
|
345
|
-
payload: TState;
|
|
346
|
-
}
|
|
347
|
-
interface LeaderCreatedEvent extends BaseEvent {
|
|
348
|
-
type: typeof UniversalStore.InternalEventType.LEADER_CREATED;
|
|
349
|
-
payload: never;
|
|
350
|
-
}
|
|
351
|
-
interface FollowerCreatedEvent extends BaseEvent {
|
|
352
|
-
type: typeof UniversalStore.InternalEventType.FOLLOWER_CREATED;
|
|
353
|
-
payload: never;
|
|
354
|
-
}
|
|
355
|
-
type InternalEvent<TState> = SetStateEvent<TState> | ExistingStateRequestEvent | ExistingStateResponseEvent<TState> | FollowerCreatedEvent | LeaderCreatedEvent;
|
|
356
|
-
type Event<TState, TEvent extends BaseEvent> = TEvent | InternalEvent<TState>;
|
|
357
|
-
type ChannelLike = Pick<Channel, 'on' | 'off' | 'emit'>;
|
|
358
|
-
type StoreOptions<TState> = {
|
|
359
|
-
id: string;
|
|
360
|
-
leader?: boolean;
|
|
361
|
-
initialState?: TState;
|
|
362
|
-
debug?: boolean;
|
|
363
|
-
};
|
|
364
|
-
type EnvironmentOverrides = {
|
|
365
|
-
channel: ChannelLike;
|
|
366
|
-
environment: EnvironmentType;
|
|
367
|
-
};
|
|
368
|
-
|
|
369
|
-
/**
|
|
370
|
-
* A universal store implementation that synchronizes state across different environments using a
|
|
371
|
-
* channel-based communication.
|
|
372
|
-
*
|
|
373
|
-
* The store follows a leader-follower pattern where:
|
|
374
|
-
*
|
|
375
|
-
* - Leader: The main store instance that owns and manages the state
|
|
376
|
-
* - Follower: Store instances that mirror the leader's state
|
|
377
|
-
*
|
|
378
|
-
* Features:
|
|
379
|
-
*
|
|
380
|
-
* - State synchronization across environments
|
|
381
|
-
* - Event-based communication
|
|
382
|
-
* - Type-safe state and custom events
|
|
383
|
-
* - Subscription system for state changes and custom events
|
|
384
|
-
*
|
|
385
|
-
* @remarks
|
|
386
|
-
* - The store must be created using the static `create()` method, not the constructor
|
|
387
|
-
* - Follower stores will automatically sync with their leader's state. If they have initial state, it
|
|
388
|
-
* will be replaced immediately when it has synced with the leader.
|
|
389
|
-
*
|
|
390
|
-
* @example
|
|
391
|
-
*
|
|
392
|
-
* ```typescript
|
|
393
|
-
* interface MyState {
|
|
394
|
-
* count: number;
|
|
395
|
-
* }
|
|
396
|
-
* interface MyCustomEvent {
|
|
397
|
-
* type: 'INCREMENT';
|
|
398
|
-
* payload: number;
|
|
399
|
-
* }
|
|
400
|
-
*
|
|
401
|
-
* // Create a leader store
|
|
402
|
-
* const leaderStore = UniversalStore.create<MyState, MyCustomEvent>({
|
|
403
|
-
* id: 'my-store',
|
|
404
|
-
* leader: true,
|
|
405
|
-
* initialState: { count: 0 },
|
|
406
|
-
* });
|
|
407
|
-
*
|
|
408
|
-
* // Create a follower store
|
|
409
|
-
* const followerStore = UniversalStore.create<MyState, MyCustomEvent>({
|
|
410
|
-
* id: 'my-store',
|
|
411
|
-
* leader: false,
|
|
412
|
-
* });
|
|
413
|
-
* ```
|
|
414
|
-
*
|
|
415
|
-
* @template State - The type of state managed by the store
|
|
416
|
-
* @template CustomEvent - Custom events that can be sent through the store. Must have a `type`
|
|
417
|
-
* string and optional `payload`
|
|
418
|
-
* @throws {Error} If constructed directly instead of using `create()`
|
|
419
|
-
* @throws {Error} If created without setting a channel first
|
|
420
|
-
* @throws {Error} If a follower is created with initial state
|
|
421
|
-
* @throws {Error} If a follower cannot find its leader within 1 second
|
|
422
|
-
*/
|
|
423
|
-
declare class UniversalStore<State, CustomEvent extends {
|
|
424
|
-
type: string;
|
|
425
|
-
payload?: any;
|
|
426
|
-
} = {
|
|
427
|
-
type: string;
|
|
428
|
-
payload?: any;
|
|
429
|
-
}> {
|
|
430
|
-
/**
|
|
431
|
-
* Defines the possible actor types in the store system
|
|
432
|
-
*
|
|
433
|
-
* @readonly
|
|
434
|
-
*/
|
|
435
|
-
static readonly ActorType: {
|
|
436
|
-
readonly LEADER: "LEADER";
|
|
437
|
-
readonly FOLLOWER: "FOLLOWER";
|
|
438
|
-
};
|
|
439
|
-
/**
|
|
440
|
-
* Defines the possible environments the store can run in
|
|
441
|
-
*
|
|
442
|
-
* @readonly
|
|
443
|
-
*/
|
|
444
|
-
static readonly Environment: {
|
|
445
|
-
readonly SERVER: "SERVER";
|
|
446
|
-
readonly MANAGER: "MANAGER";
|
|
447
|
-
readonly PREVIEW: "PREVIEW";
|
|
448
|
-
readonly UNKNOWN: "UNKNOWN";
|
|
449
|
-
readonly MOCK: "MOCK";
|
|
450
|
-
};
|
|
451
|
-
/**
|
|
452
|
-
* Internal event types used for store synchronization
|
|
453
|
-
*
|
|
454
|
-
* @readonly
|
|
455
|
-
*/
|
|
456
|
-
static readonly InternalEventType: {
|
|
457
|
-
readonly EXISTING_STATE_REQUEST: "__EXISTING_STATE_REQUEST";
|
|
458
|
-
readonly EXISTING_STATE_RESPONSE: "__EXISTING_STATE_RESPONSE";
|
|
459
|
-
readonly SET_STATE: "__SET_STATE";
|
|
460
|
-
readonly LEADER_CREATED: "__LEADER_CREATED";
|
|
461
|
-
readonly FOLLOWER_CREATED: "__FOLLOWER_CREATED";
|
|
462
|
-
};
|
|
463
|
-
static readonly Status: {
|
|
464
|
-
readonly UNPREPARED: "UNPREPARED";
|
|
465
|
-
readonly SYNCING: "SYNCING";
|
|
466
|
-
readonly READY: "READY";
|
|
467
|
-
readonly ERROR: "ERROR";
|
|
468
|
-
};
|
|
469
|
-
protected static isInternalConstructing: boolean;
|
|
470
|
-
/**
|
|
471
|
-
* The preparation construct is used to keep track of all store's preparation state the promise is
|
|
472
|
-
* resolved when the store is prepared with the static __prepare() method which will also change
|
|
473
|
-
* the state from PENDING to RESOLVED
|
|
474
|
-
*/
|
|
475
|
-
private static preparation;
|
|
476
|
-
private static setupPreparationPromise;
|
|
477
|
-
/** Enable debug logs for this store */
|
|
478
|
-
debugging: boolean;
|
|
479
|
-
/** The actor object representing the store instance with a unique ID and a type */
|
|
480
|
-
get actor(): Actor;
|
|
481
|
-
/**
|
|
482
|
-
* The current state of the store, that signals both if the store is prepared by Storybook and
|
|
483
|
-
* also - in the case of a follower - if the state has been synced with the leader's state.
|
|
484
|
-
*/
|
|
485
|
-
get status(): StatusType;
|
|
486
|
-
/**
|
|
487
|
-
* A promise that resolves when the store is fully ready. A leader will be ready when the store
|
|
488
|
-
* has been prepared by Storybook, which is almost instantly.
|
|
489
|
-
*
|
|
490
|
-
* A follower will be ready when the state has been synced with the leader's state, within a few
|
|
491
|
-
* hundred milliseconds.
|
|
492
|
-
*/
|
|
493
|
-
untilReady(): Promise<[{
|
|
494
|
-
channel: ChannelLike;
|
|
495
|
-
environment: EnvironmentType;
|
|
496
|
-
}, void | undefined]>;
|
|
497
|
-
/**
|
|
498
|
-
* The syncing construct is used to keep track of if the instance's state has been synced with the
|
|
499
|
-
* other instances. A leader will immediately have the promise resolved. A follower will initially
|
|
500
|
-
* be in a PENDING state, and resolve the the leader has sent the existing state, or reject if no
|
|
501
|
-
* leader has responded before the timeout.
|
|
502
|
-
*/
|
|
503
|
-
private syncing?;
|
|
504
|
-
private channelEventName;
|
|
505
|
-
private state;
|
|
506
|
-
private channel?;
|
|
507
|
-
private environment?;
|
|
508
|
-
private listeners;
|
|
509
|
-
private id;
|
|
510
|
-
private actorId;
|
|
511
|
-
private actorType;
|
|
512
|
-
protected constructor(options: StoreOptions<State>, environmentOverrides?: EnvironmentOverrides);
|
|
513
|
-
/** Creates a new instance of UniversalStore */
|
|
514
|
-
static create<State = any, CustomEvent extends {
|
|
515
|
-
type: string;
|
|
516
|
-
payload?: any;
|
|
517
|
-
} = {
|
|
518
|
-
type: string;
|
|
519
|
-
payload?: any;
|
|
520
|
-
}>(options: StoreOptions<State>): UniversalStore<State, CustomEvent>;
|
|
521
|
-
/** Gets the current state */
|
|
522
|
-
getState: () => State;
|
|
523
|
-
/**
|
|
524
|
-
* Updates the store's state
|
|
525
|
-
*
|
|
526
|
-
* Either a new state or a state updater function can be passed to the method.
|
|
527
|
-
*/
|
|
528
|
-
setState(updater: State | StateUpdater<State>): void;
|
|
529
|
-
/**
|
|
530
|
-
* Subscribes to store events
|
|
531
|
-
*
|
|
532
|
-
* @returns A function to unsubscribe
|
|
533
|
-
*/
|
|
534
|
-
subscribe: {
|
|
535
|
-
(listener: Listener<Event<State, CustomEvent>>): () => void;
|
|
536
|
-
<EventType extends Event<State, CustomEvent>['type']>(eventType: EventType, listener: Listener<Extract<Event<State, CustomEvent>, {
|
|
537
|
-
type: EventType;
|
|
538
|
-
}>>): () => void;
|
|
539
|
-
};
|
|
540
|
-
/**
|
|
541
|
-
* Subscribes to state changes
|
|
542
|
-
*
|
|
543
|
-
* @returns Unsubscribe function
|
|
544
|
-
*/
|
|
545
|
-
onStateChange(listener: (state: State, previousState: State, eventInfo: EventInfo) => void): () => void;
|
|
546
|
-
/** Sends a custom event to the other stores */
|
|
547
|
-
send: (event: CustomEvent) => void;
|
|
548
|
-
private emitToChannel;
|
|
549
|
-
private prepareThis;
|
|
550
|
-
private emitToListeners;
|
|
551
|
-
private handleChannelEvents;
|
|
552
|
-
private debug;
|
|
553
|
-
}
|
|
554
|
-
|
|
555
|
-
/**
|
|
556
|
-
* A hook to use a UniversalStore in a rendered preview. This hook will react to changes in the
|
|
557
|
-
* store state and re-render when the store changes.
|
|
558
|
-
*
|
|
559
|
-
* @param universalStore The UniversalStore instance to use.
|
|
560
|
-
* @param selector An optional selector function to select a subset of the store state.
|
|
561
|
-
* @remark This hook is intended for use in the preview. For use in the manager UI, import from
|
|
562
|
-
* `storybook/internal/manager-api` instead.
|
|
563
|
-
*/
|
|
564
|
-
declare const useUniversalStore: {
|
|
565
|
-
<TUniversalStore extends UniversalStore<TState, any>, TState = TUniversalStore extends UniversalStore<infer S, any> ? S : never>(universalStore: TUniversalStore): [TState, TUniversalStore['setState']];
|
|
566
|
-
<TUniversalStore extends UniversalStore<any, any>, TSelectedState, TState = TUniversalStore extends UniversalStore<infer S, any> ? S : never>(universalStore: TUniversalStore, selector: (state: TState) => TSelectedState): [TSelectedState, TUniversalStore['setState']];
|
|
567
|
-
};
|
|
568
|
-
|
|
569
|
-
/**
|
|
570
|
-
* A mock universal store that can be used when testing code that relies on a universal store. It
|
|
571
|
-
* functions exactly like a normal universal store, with a few exceptions:
|
|
572
|
-
*
|
|
573
|
-
* - It is fully isolated, meaning that it doesn't interact with any channel, and it is always a
|
|
574
|
-
* leader.
|
|
575
|
-
*
|
|
576
|
-
* If the second testUtils argument is provided, all the public methods are spied on, so they can be
|
|
577
|
-
* asserted.
|
|
578
|
-
*
|
|
579
|
-
* When a mock store is re-used across tests (eg. in stories), you manually need to reset the state
|
|
580
|
-
* after each test.
|
|
581
|
-
*
|
|
582
|
-
* @example
|
|
583
|
-
*
|
|
584
|
-
* ```ts
|
|
585
|
-
* import * as testUtils from '@storybook/test'; // in stories
|
|
586
|
-
* import { vi as testUtils } from 'vitest'; // ... or in Vitest tests
|
|
587
|
-
*
|
|
588
|
-
* const initialState = { ... };
|
|
589
|
-
* const store = new MockUniversalStore({ initialState }, testUtils);
|
|
590
|
-
*
|
|
591
|
-
* export default {
|
|
592
|
-
* title: 'My story',
|
|
593
|
-
* beforeEach: () => {
|
|
594
|
-
* return () => {
|
|
595
|
-
* store.setState(initialState);
|
|
596
|
-
* };
|
|
597
|
-
* }
|
|
598
|
-
* }
|
|
599
|
-
* ```
|
|
600
|
-
*/
|
|
601
|
-
declare class MockUniversalStore<State, CustomEvent extends {
|
|
602
|
-
type: string;
|
|
603
|
-
payload?: any;
|
|
604
|
-
} = {
|
|
605
|
-
type: string;
|
|
606
|
-
payload?: any;
|
|
607
|
-
}> extends UniversalStore<State, CustomEvent> {
|
|
608
|
-
private testUtils;
|
|
609
|
-
constructor(options: StoreOptions<State>, testUtils?: any);
|
|
610
|
-
/** Create a mock universal store. This is just an alias for the constructor */
|
|
611
|
-
static create<State = any, CustomEvent extends {
|
|
612
|
-
type: string;
|
|
613
|
-
payload?: any;
|
|
614
|
-
} = {
|
|
615
|
-
type: string;
|
|
616
|
-
payload?: any;
|
|
617
|
-
}>(options: StoreOptions<State>, testUtils?: any): MockUniversalStore<State, CustomEvent>;
|
|
618
|
-
unsubscribeAll(): void;
|
|
619
|
-
}
|
|
620
|
-
|
|
621
314
|
declare class ArgsStore {
|
|
622
|
-
initialArgsByStoryId: Record<StoryId, Args>;
|
|
623
|
-
argsByStoryId: Record<StoryId, Args>;
|
|
624
|
-
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;
|
|
625
318
|
setInitial(story: PreparedStory<any>): void;
|
|
626
|
-
updateFromDelta(story: PreparedStory<any>, delta: Args): void;
|
|
627
|
-
updateFromPersisted(story: PreparedStory<any>, persisted: Args): void;
|
|
628
|
-
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;
|
|
629
322
|
}
|
|
630
323
|
|
|
631
324
|
declare class GlobalsStore {
|
|
632
325
|
allowedGlobalNames: Set<string>;
|
|
633
|
-
initialGlobals: Globals;
|
|
634
|
-
globals: Globals;
|
|
326
|
+
initialGlobals: Globals$1;
|
|
327
|
+
globals: Globals$1;
|
|
635
328
|
constructor({ globals, globalTypes, }: {
|
|
636
|
-
globals?: Globals;
|
|
329
|
+
globals?: Globals$1;
|
|
637
330
|
globalTypes?: GlobalTypes;
|
|
638
331
|
});
|
|
639
332
|
set({ globals, globalTypes }: {
|
|
640
|
-
globals?: Globals;
|
|
333
|
+
globals?: Globals$1;
|
|
641
334
|
globalTypes?: GlobalTypes;
|
|
642
335
|
}): void;
|
|
643
|
-
filterAllowedGlobals(globals: Globals): Globals;
|
|
644
|
-
updateFromPersisted(persisted: Globals): void;
|
|
645
|
-
get(): Globals;
|
|
646
|
-
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;
|
|
647
340
|
}
|
|
648
341
|
|
|
649
|
-
type StorySpecifier = StoryId | {
|
|
650
|
-
name: StoryName;
|
|
651
|
-
title: ComponentTitle;
|
|
342
|
+
type StorySpecifier = StoryId$1 | {
|
|
343
|
+
name: StoryName$1;
|
|
344
|
+
title: ComponentTitle$1;
|
|
652
345
|
} | '*';
|
|
653
346
|
declare class StoryIndexStore {
|
|
654
347
|
entries: StoryIndex['entries'];
|
|
655
348
|
constructor({ entries }?: StoryIndex);
|
|
656
349
|
entryFromSpecifier(specifier: StorySpecifier): IndexEntry | undefined;
|
|
657
|
-
storyIdToEntry(storyId: StoryId): IndexEntry;
|
|
350
|
+
storyIdToEntry(storyId: StoryId$1): IndexEntry;
|
|
658
351
|
importPathToEntry(importPath: Path): IndexEntry;
|
|
659
352
|
}
|
|
660
353
|
|
|
661
|
-
declare function normalizeStory<TRenderer extends Renderer>(key: StoryId, storyAnnotations:
|
|
354
|
+
declare function normalizeStory<TRenderer extends Renderer$1>(key: StoryId$1, storyAnnotations: StoryAnnotationsOrFn<TRenderer>, meta: NormalizedComponentAnnotations<TRenderer>): NormalizedStoryAnnotations<TRenderer>;
|
|
662
355
|
|
|
663
|
-
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>;
|
|
664
357
|
|
|
665
|
-
declare function prepareStory<TRenderer extends Renderer>(storyAnnotations: NormalizedStoryAnnotations<TRenderer>, componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations<TRenderer>): PreparedStory<TRenderer>;
|
|
666
|
-
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>;
|
|
667
360
|
|
|
668
|
-
declare function normalizeProjectAnnotations<TRenderer extends Renderer>({ argTypes, globalTypes, argTypesEnhancers, decorators, loaders, beforeEach, experimental_afterEach,
|
|
361
|
+
declare function normalizeProjectAnnotations<TRenderer extends Renderer$1>({ argTypes, globalTypes, argTypesEnhancers, decorators, loaders, beforeEach, experimental_afterEach, initialGlobals, ...annotations }: ProjectAnnotations<TRenderer>): NormalizedProjectAnnotations<TRenderer>;
|
|
669
362
|
|
|
670
|
-
declare function composeConfigs<TRenderer extends Renderer>(
|
|
363
|
+
declare function composeConfigs<TRenderer extends Renderer$1>(input: ModuleExports[]): NormalizedProjectAnnotations<TRenderer>;
|
|
671
364
|
|
|
672
365
|
/**
|
|
673
366
|
* Compose step runners to create a single step runner that applies each step runner in order.
|
|
@@ -680,8 +373,8 @@ declare function composeConfigs<TRenderer extends Renderer>(moduleExportList: Mo
|
|
|
680
373
|
* step('label', () => {});
|
|
681
374
|
* ```
|
|
682
375
|
*
|
|
683
|
-
* ...and runs it. The prototypical example is from
|
|
684
|
-
*
|
|
376
|
+
* ...and runs it. The prototypical example is from `core/interactions` where the step runner will
|
|
377
|
+
* decorate all instrumented code inside the step with information about the label.
|
|
685
378
|
*
|
|
686
379
|
* In theory it is possible to have more than one addon that wants to run steps; they can be
|
|
687
380
|
* composed together in a similar fashion to decorators. In some ways step runners are like
|
|
@@ -693,16 +386,16 @@ declare function composeConfigs<TRenderer extends Renderer>(moduleExportList: Mo
|
|
|
693
386
|
* @param stepRunners An array of StepRunner
|
|
694
387
|
* @returns A StepRunner that is the composition of the arguments
|
|
695
388
|
*/
|
|
696
|
-
declare function composeStepRunners<TRenderer extends Renderer>(stepRunners: StepRunner<TRenderer>[]): StepRunner<TRenderer>;
|
|
389
|
+
declare function composeStepRunners<TRenderer extends Renderer$1>(stepRunners: StepRunner<TRenderer>[]): StepRunner<TRenderer>;
|
|
697
390
|
|
|
698
391
|
declare global {
|
|
699
392
|
var globalProjectAnnotations: NormalizedProjectAnnotations<any>;
|
|
700
393
|
var defaultProjectAnnotations: ProjectAnnotations<any>;
|
|
701
394
|
}
|
|
702
|
-
declare function setDefaultProjectAnnotations<TRenderer extends Renderer = Renderer>(_defaultProjectAnnotations: ProjectAnnotations<TRenderer>): void;
|
|
703
|
-
declare function setProjectAnnotations<TRenderer extends Renderer = Renderer>(projectAnnotations: NamedOrDefaultProjectAnnotations<TRenderer> | NamedOrDefaultProjectAnnotations<TRenderer>[]): NormalizedProjectAnnotations<TRenderer>;
|
|
704
|
-
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>>;
|
|
705
|
-
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): {};
|
|
706
399
|
type WrappedStoryRef = {
|
|
707
400
|
__pw_type: 'jsx' | 'importRef';
|
|
708
401
|
};
|
|
@@ -718,35 +411,35 @@ declare function createPlaywrightTest<TFixture extends {
|
|
|
718
411
|
extend: any;
|
|
719
412
|
}>(baseTest: TFixture): TFixture;
|
|
720
413
|
|
|
721
|
-
declare function getCsfFactoryAnnotations<TRenderer extends Renderer = Renderer, TArgs extends Args = Args>(story: LegacyStoryAnnotationsOrFn<TRenderer>, meta?: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations?: ProjectAnnotations<TRenderer>): {
|
|
722
|
-
story:
|
|
723
|
-
meta: ComponentAnnotations<Renderer, Args>;
|
|
724
|
-
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>;
|
|
725
418
|
} | {
|
|
726
419
|
story: LegacyStoryAnnotationsOrFn<TRenderer>;
|
|
727
420
|
meta: ComponentAnnotations<TRenderer, TArgs> | undefined;
|
|
728
421
|
preview: ProjectAnnotations<TRenderer> | undefined;
|
|
729
422
|
};
|
|
730
423
|
|
|
731
|
-
interface Report<T = unknown> {
|
|
424
|
+
interface Report$1<T = unknown> {
|
|
732
425
|
type: string;
|
|
733
426
|
version?: number;
|
|
734
427
|
result: T;
|
|
735
428
|
status: 'failed' | 'passed' | 'warning';
|
|
736
429
|
}
|
|
737
430
|
declare class ReporterAPI {
|
|
738
|
-
reports: Report[];
|
|
739
|
-
addReport(report: Report): Promise<void>;
|
|
431
|
+
reports: Report$1[];
|
|
432
|
+
addReport(report: Report$1): Promise<void>;
|
|
740
433
|
}
|
|
741
434
|
|
|
742
|
-
declare class StoryStore<TRenderer extends Renderer> {
|
|
435
|
+
declare class StoryStore<TRenderer extends Renderer$1> {
|
|
743
436
|
importFn: ModuleImportFn;
|
|
744
437
|
storyIndex: StoryIndexStore;
|
|
745
438
|
projectAnnotations: NormalizedProjectAnnotations<TRenderer>;
|
|
746
439
|
userGlobals: GlobalsStore;
|
|
747
440
|
args: ArgsStore;
|
|
748
|
-
hooks: Record<StoryId, HooksContext<TRenderer>>;
|
|
749
|
-
cleanupCallbacks: Record<StoryId, CleanupCallback[] | undefined>;
|
|
441
|
+
hooks: Record<StoryId$1, HooksContext<TRenderer>>;
|
|
442
|
+
cleanupCallbacks: Record<StoryId$1, CleanupCallback[] | undefined>;
|
|
750
443
|
cachedCSFFiles?: Record<Path, CSFFile<TRenderer>>;
|
|
751
444
|
processCSFFileWithCache: typeof processCSFFile;
|
|
752
445
|
prepareMetaWithCache: typeof prepareMeta;
|
|
@@ -757,34 +450,34 @@ declare class StoryStore<TRenderer extends Renderer> {
|
|
|
757
450
|
importFn?: ModuleImportFn;
|
|
758
451
|
storyIndex?: StoryIndex;
|
|
759
452
|
}): Promise<void>;
|
|
760
|
-
storyIdToEntry(storyId: StoryId): Promise<IndexEntry>;
|
|
761
|
-
loadCSFFileByStoryId(storyId: StoryId): Promise<CSFFile<TRenderer>>;
|
|
453
|
+
storyIdToEntry(storyId: StoryId$1): Promise<IndexEntry>;
|
|
454
|
+
loadCSFFileByStoryId(storyId: StoryId$1): Promise<CSFFile<TRenderer>>;
|
|
762
455
|
loadAllCSFFiles(): Promise<StoryStore<TRenderer>['cachedCSFFiles']>;
|
|
763
456
|
cacheAllCSFFiles(): Promise<void>;
|
|
764
457
|
preparedMetaFromCSFFile({ csfFile }: {
|
|
765
458
|
csfFile: CSFFile<TRenderer>;
|
|
766
459
|
}): PreparedMeta<TRenderer>;
|
|
767
460
|
loadStory({ storyId }: {
|
|
768
|
-
storyId: StoryId;
|
|
461
|
+
storyId: StoryId$1;
|
|
769
462
|
}): Promise<PreparedStory<TRenderer>>;
|
|
770
463
|
storyFromCSFFile({ storyId, csfFile, }: {
|
|
771
|
-
storyId: StoryId;
|
|
464
|
+
storyId: StoryId$1;
|
|
772
465
|
csfFile: CSFFile<TRenderer>;
|
|
773
466
|
}): PreparedStory<TRenderer>;
|
|
774
467
|
componentStoriesFromCSFFile({ csfFile, }: {
|
|
775
468
|
csfFile: CSFFile<TRenderer>;
|
|
776
469
|
}): PreparedStory<TRenderer>[];
|
|
777
|
-
loadEntry(id: StoryId): Promise<{
|
|
470
|
+
loadEntry(id: StoryId$1): Promise<{
|
|
778
471
|
entryExports: ModuleExports;
|
|
779
472
|
csfFiles: CSFFile<TRenderer>[];
|
|
780
473
|
}>;
|
|
781
474
|
getStoryContext(story: PreparedStory<TRenderer>, { forceInitialArgs }?: {
|
|
782
475
|
forceInitialArgs?: boolean | undefined;
|
|
783
476
|
}): {
|
|
784
|
-
args:
|
|
785
|
-
initialGlobals:
|
|
786
|
-
globalTypes: (
|
|
787
|
-
userGlobals:
|
|
477
|
+
args: storybook_internal_types.Args;
|
|
478
|
+
initialGlobals: storybook_internal_types.Globals;
|
|
479
|
+
globalTypes: (storybook_internal_types.GlobalTypes & storybook_internal_types.StrictGlobalTypes) | undefined;
|
|
480
|
+
userGlobals: storybook_internal_types.Globals;
|
|
788
481
|
reporting: ReporterAPI;
|
|
789
482
|
globals: {
|
|
790
483
|
[x: string]: any;
|
|
@@ -796,46 +489,36 @@ declare class StoryStore<TRenderer extends Renderer> {
|
|
|
796
489
|
subcomponents?: Record<string, (TRenderer & {
|
|
797
490
|
T: any;
|
|
798
491
|
})["component"]> | undefined;
|
|
799
|
-
parameters: Parameters;
|
|
800
|
-
initialArgs:
|
|
801
|
-
argTypes:
|
|
802
|
-
componentId:
|
|
803
|
-
title: ComponentTitle;
|
|
804
|
-
kind: ComponentTitle;
|
|
805
|
-
id: StoryId;
|
|
806
|
-
name:
|
|
807
|
-
story:
|
|
808
|
-
tags:
|
|
492
|
+
parameters: storybook_internal_types.Parameters;
|
|
493
|
+
initialArgs: storybook_internal_types.Args;
|
|
494
|
+
argTypes: storybook_internal_types.StrictArgTypes<storybook_internal_types.Args>;
|
|
495
|
+
componentId: storybook_internal_types.ComponentId;
|
|
496
|
+
title: storybook_internal_types.ComponentTitle;
|
|
497
|
+
kind: storybook_internal_types.ComponentTitle;
|
|
498
|
+
id: StoryId$1;
|
|
499
|
+
name: storybook_internal_types.StoryName;
|
|
500
|
+
story: storybook_internal_types.StoryName;
|
|
501
|
+
tags: storybook_internal_types.Tag[];
|
|
809
502
|
moduleExport: storybook_internal_types.ModuleExport;
|
|
810
|
-
originalStoryFn:
|
|
811
|
-
undecoratedStoryFn:
|
|
812
|
-
unboundStoryFn:
|
|
813
|
-
applyLoaders: (context: StoryContext<TRenderer,
|
|
814
|
-
applyBeforeEach: (context: StoryContext<TRenderer,
|
|
815
|
-
applyAfterEach: (context: StoryContext<TRenderer,
|
|
816
|
-
playFunction?: ((context: StoryContext<TRenderer,
|
|
817
|
-
runStep:
|
|
818
|
-
mount: (context: StoryContext<TRenderer,
|
|
503
|
+
originalStoryFn: storybook_internal_types.ArgsStoryFn<TRenderer>;
|
|
504
|
+
undecoratedStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
505
|
+
unboundStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
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
|
+
runStep: storybook_internal_types.StepRunner<TRenderer>;
|
|
511
|
+
mount: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => () => Promise<storybook_internal_types.Canvas>;
|
|
819
512
|
testingLibraryRender?: (...args: never[]) => unknown;
|
|
820
513
|
renderToCanvas?: storybook_internal_types.RenderToCanvas<TRenderer> | undefined;
|
|
821
514
|
usesMount: boolean;
|
|
822
|
-
storyGlobals:
|
|
823
|
-
} & Pick<
|
|
515
|
+
storyGlobals: storybook_internal_types.Globals;
|
|
516
|
+
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer$1, storybook_internal_types.Args>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
824
517
|
addCleanupCallbacks(story: PreparedStory<TRenderer>, callbacks: CleanupCallback[]): void;
|
|
825
518
|
cleanupStory(story: PreparedStory<TRenderer>): Promise<void>;
|
|
826
519
|
extract(options?: {
|
|
827
520
|
includeDocsOnly?: boolean;
|
|
828
|
-
}): Record<StoryId, StoryContextForEnhancers<TRenderer>>;
|
|
829
|
-
getSetStoriesPayload(): {
|
|
830
|
-
v: number;
|
|
831
|
-
globals: storybook_internal_csf.Globals;
|
|
832
|
-
globalParameters: {};
|
|
833
|
-
kindParameters: Parameters;
|
|
834
|
-
stories: Record<string, StoryContextForEnhancers<TRenderer, storybook_internal_csf.Args>>;
|
|
835
|
-
};
|
|
836
|
-
getStoriesJsonData: () => StoryIndexV3;
|
|
837
|
-
raw(): BoundStory<TRenderer>[];
|
|
838
|
-
fromId(storyId: StoryId): BoundStory<TRenderer> | null;
|
|
521
|
+
}): Record<StoryId$1, StoryContextForEnhancers$1<TRenderer>>;
|
|
839
522
|
}
|
|
840
523
|
|
|
841
524
|
/**
|
|
@@ -843,14 +526,14 @@ declare class StoryStore<TRenderer extends Renderer> {
|
|
|
843
526
|
* overwrite the existing value UNLESS both values are plain objects. In this case flag the key as
|
|
844
527
|
* "special" and handle it with a heuristic.
|
|
845
528
|
*/
|
|
846
|
-
declare const combineParameters: (...parameterSets: (Parameters | undefined)[]) => Parameters;
|
|
529
|
+
declare const combineParameters: (...parameterSets: (Parameters$1 | undefined)[]) => Parameters$1;
|
|
847
530
|
|
|
848
531
|
type PropDescriptor = string[] | RegExp;
|
|
849
|
-
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>>;
|
|
850
533
|
|
|
851
|
-
declare const inferControls: ArgTypesEnhancer<Renderer>;
|
|
534
|
+
declare const inferControls: ArgTypesEnhancer<Renderer$1>;
|
|
852
535
|
|
|
853
|
-
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>;
|
|
854
537
|
/**
|
|
855
538
|
* Currently StoryContextUpdates are allowed to have any key in the type. However, you cannot
|
|
856
539
|
* overwrite any of the build-it "static" keys.
|
|
@@ -858,17 +541,17 @@ declare function decorateStory<TRenderer extends Renderer>(storyFn: LegacyStoryF
|
|
|
858
541
|
* @param inputContextUpdate StoryContextUpdate
|
|
859
542
|
* @returns StoryContextUpdate
|
|
860
543
|
*/
|
|
861
|
-
declare function sanitizeStoryContextUpdate({ componentId, title, kind, id, name, story, parameters, initialArgs, argTypes, ...update }?: StoryContextUpdate): StoryContextUpdate;
|
|
862
|
-
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>;
|
|
863
546
|
|
|
864
|
-
declare const combineArgs: (value: any, update: any) => Args;
|
|
547
|
+
declare const combineArgs: (value: any, update: any) => Args$1;
|
|
865
548
|
|
|
866
549
|
declare const userOrAutoTitleFromSpecifier: (fileName: string | number, entry: NormalizedStoriesSpecifier, userTitle?: string) => string | undefined;
|
|
867
550
|
declare const userOrAutoTitle: (fileName: string, storiesEntries: NormalizedStoriesSpecifier[], userTitle?: string) => string | undefined;
|
|
868
551
|
|
|
869
552
|
declare const sortStoriesV7: (stories: IndexEntry[], storySortParameter: Addon_StorySortParameterV7, fileNameOrder: Path[]) => IndexEntry[];
|
|
870
553
|
|
|
871
|
-
declare class DocsContext<TRenderer extends Renderer> implements DocsContextProps<TRenderer> {
|
|
554
|
+
declare class DocsContext<TRenderer extends Renderer$1> implements DocsContextProps<TRenderer> {
|
|
872
555
|
channel: Channel;
|
|
873
556
|
protected store: StoryStore<TRenderer>;
|
|
874
557
|
renderStoryToElement: DocsContextProps<TRenderer>['renderStoryToElement'];
|
|
@@ -889,17 +572,17 @@ declare class DocsContext<TRenderer extends Renderer> implements DocsContextProp
|
|
|
889
572
|
private resolveAttachedModuleExportType;
|
|
890
573
|
private resolveModuleExport;
|
|
891
574
|
resolveOf<TType extends ResolvedModuleExportType>(moduleExportOrType: ModuleExport | TType, validTypes?: TType[]): ResolvedModuleExportFromType<TType, TRenderer>;
|
|
892
|
-
storyIdByName: (storyName: StoryName) => string;
|
|
575
|
+
storyIdByName: (storyName: StoryName$1) => string;
|
|
893
576
|
componentStories: () => PreparedStory<TRenderer>[];
|
|
894
577
|
componentStoriesFromCSFFile: (csfFile: CSFFile<TRenderer>) => PreparedStory<TRenderer>[];
|
|
895
|
-
storyById: (storyId?: StoryId) => PreparedStory<TRenderer>;
|
|
578
|
+
storyById: (storyId?: StoryId$1) => PreparedStory<TRenderer>;
|
|
896
579
|
getStoryContext: (story: PreparedStory<TRenderer>) => {
|
|
897
580
|
loaded: {};
|
|
898
581
|
viewMode: string;
|
|
899
|
-
args:
|
|
900
|
-
initialGlobals:
|
|
901
|
-
globalTypes: (
|
|
902
|
-
userGlobals:
|
|
582
|
+
args: storybook_internal_types.Args;
|
|
583
|
+
initialGlobals: storybook_internal_types.Globals;
|
|
584
|
+
globalTypes: (storybook_internal_types.GlobalTypes & storybook_internal_types.StrictGlobalTypes) | undefined;
|
|
585
|
+
userGlobals: storybook_internal_types.Globals;
|
|
903
586
|
reporting: ReporterAPI;
|
|
904
587
|
globals: {
|
|
905
588
|
[x: string]: any;
|
|
@@ -911,35 +594,35 @@ declare class DocsContext<TRenderer extends Renderer> implements DocsContextProp
|
|
|
911
594
|
subcomponents?: Record<string, (TRenderer & {
|
|
912
595
|
T: any;
|
|
913
596
|
})["component"]> | undefined;
|
|
914
|
-
parameters:
|
|
915
|
-
initialArgs:
|
|
916
|
-
argTypes:
|
|
917
|
-
componentId:
|
|
918
|
-
title:
|
|
919
|
-
kind:
|
|
920
|
-
id: StoryId;
|
|
921
|
-
name: StoryName;
|
|
922
|
-
story: StoryName;
|
|
923
|
-
tags:
|
|
597
|
+
parameters: storybook_internal_types.Parameters;
|
|
598
|
+
initialArgs: storybook_internal_types.Args;
|
|
599
|
+
argTypes: storybook_internal_types.StrictArgTypes<storybook_internal_types.Args>;
|
|
600
|
+
componentId: storybook_internal_types.ComponentId;
|
|
601
|
+
title: storybook_internal_types.ComponentTitle;
|
|
602
|
+
kind: storybook_internal_types.ComponentTitle;
|
|
603
|
+
id: StoryId$1;
|
|
604
|
+
name: StoryName$1;
|
|
605
|
+
story: StoryName$1;
|
|
606
|
+
tags: storybook_internal_types.Tag[];
|
|
924
607
|
moduleExport: ModuleExport;
|
|
925
|
-
originalStoryFn:
|
|
926
|
-
undecoratedStoryFn:
|
|
927
|
-
unboundStoryFn:
|
|
928
|
-
applyLoaders: (context:
|
|
929
|
-
applyBeforeEach: (context:
|
|
930
|
-
applyAfterEach: (context:
|
|
931
|
-
playFunction?: ((context:
|
|
932
|
-
runStep:
|
|
933
|
-
mount: (context:
|
|
608
|
+
originalStoryFn: storybook_internal_types.ArgsStoryFn<TRenderer>;
|
|
609
|
+
undecoratedStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
610
|
+
unboundStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
611
|
+
applyLoaders: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<Record<string, any>>;
|
|
612
|
+
applyBeforeEach: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<storybook_internal_types.CleanupCallback[]>;
|
|
613
|
+
applyAfterEach: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void>;
|
|
614
|
+
playFunction?: ((context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => Promise<void> | void) | undefined;
|
|
615
|
+
runStep: storybook_internal_types.StepRunner<TRenderer>;
|
|
616
|
+
mount: (context: storybook_internal_types.StoryContext<TRenderer, storybook_internal_types.Args>) => () => Promise<storybook_internal_types.Canvas>;
|
|
934
617
|
testingLibraryRender?: (...args: never[]) => unknown;
|
|
935
618
|
renderToCanvas?: storybook_internal_types.RenderToCanvas<TRenderer> | undefined;
|
|
936
619
|
usesMount: boolean;
|
|
937
|
-
storyGlobals:
|
|
620
|
+
storyGlobals: storybook_internal_types.Globals;
|
|
938
621
|
allArgs: any;
|
|
939
622
|
argsByTarget: any;
|
|
940
623
|
unmappedArgs: any;
|
|
941
624
|
};
|
|
942
|
-
loadStory: (id: StoryId) => Promise<PreparedStory<TRenderer>>;
|
|
625
|
+
loadStory: (id: StoryId$1) => Promise<PreparedStory<TRenderer>>;
|
|
943
626
|
}
|
|
944
627
|
|
|
945
628
|
type RenderType = 'story' | 'docs';
|
|
@@ -951,9 +634,9 @@ type RenderType = 'story' | 'docs';
|
|
|
951
634
|
* - Tracking the state of the rendering as it moves between preparing, rendering and tearing down.
|
|
952
635
|
* - Tracking what is rendered to know if a change requires re-rendering or teardown + recreation.
|
|
953
636
|
*/
|
|
954
|
-
interface Render<TRenderer extends Renderer> {
|
|
637
|
+
interface Render<TRenderer extends Renderer$1> {
|
|
955
638
|
type: RenderType;
|
|
956
|
-
id: StoryId;
|
|
639
|
+
id: StoryId$1;
|
|
957
640
|
isPreparing: () => boolean;
|
|
958
641
|
isEqual: (other: Render<TRenderer>) => boolean;
|
|
959
642
|
disableKeyListeners: boolean;
|
|
@@ -975,14 +658,14 @@ interface Render<TRenderer extends Renderer> {
|
|
|
975
658
|
*
|
|
976
659
|
* - Autodocs, where there is no story, and we fall back to the globally defined template.
|
|
977
660
|
*/
|
|
978
|
-
declare class CsfDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
661
|
+
declare class CsfDocsRender<TRenderer extends Renderer$1> implements Render<TRenderer> {
|
|
979
662
|
protected channel: Channel;
|
|
980
663
|
protected store: StoryStore<TRenderer>;
|
|
981
664
|
entry: IndexEntry;
|
|
982
665
|
private callbacks;
|
|
983
666
|
readonly type: RenderType;
|
|
984
667
|
readonly subtype = "csf";
|
|
985
|
-
readonly id: StoryId;
|
|
668
|
+
readonly id: StoryId$1;
|
|
986
669
|
story?: PreparedStory<TRenderer>;
|
|
987
670
|
rerender?: () => Promise<void>;
|
|
988
671
|
teardownRender?: (options: {
|
|
@@ -1013,14 +696,14 @@ declare class CsfDocsRender<TRenderer extends Renderer> implements Render<TRende
|
|
|
1013
696
|
*
|
|
1014
697
|
* - *.mdx file that may or may not reference a specific CSF file with `<Meta of={} />`
|
|
1015
698
|
*/
|
|
1016
|
-
declare class MdxDocsRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
699
|
+
declare class MdxDocsRender<TRenderer extends Renderer$1> implements Render<TRenderer> {
|
|
1017
700
|
protected channel: Channel;
|
|
1018
701
|
protected store: StoryStore<TRenderer>;
|
|
1019
702
|
entry: IndexEntry;
|
|
1020
703
|
private callbacks;
|
|
1021
704
|
readonly type: RenderType;
|
|
1022
705
|
readonly subtype = "mdx";
|
|
1023
|
-
readonly id: StoryId;
|
|
706
|
+
readonly id: StoryId$1;
|
|
1024
707
|
private exports?;
|
|
1025
708
|
rerender?: () => Promise<void>;
|
|
1026
709
|
teardownRender?: (options: {
|
|
@@ -1042,13 +725,13 @@ declare class MdxDocsRender<TRenderer extends Renderer> implements Render<TRende
|
|
|
1042
725
|
}
|
|
1043
726
|
|
|
1044
727
|
type RenderPhase = 'preparing' | 'loading' | 'beforeEach' | 'rendering' | 'playing' | 'played' | 'afterEach' | 'completed' | 'finished' | 'aborted' | 'errored';
|
|
1045
|
-
declare class StoryRender<TRenderer extends Renderer> implements Render<TRenderer> {
|
|
728
|
+
declare class StoryRender<TRenderer extends Renderer$1> implements Render<TRenderer> {
|
|
1046
729
|
channel: Channel;
|
|
1047
730
|
store: StoryStore<TRenderer>;
|
|
1048
731
|
private renderToScreen;
|
|
1049
732
|
private callbacks;
|
|
1050
|
-
id: StoryId;
|
|
1051
|
-
viewMode: StoryContext<TRenderer>['viewMode'];
|
|
733
|
+
id: StoryId$1;
|
|
734
|
+
viewMode: StoryContext$1<TRenderer>['viewMode'];
|
|
1052
735
|
renderOptions: StoryRenderOptions;
|
|
1053
736
|
type: RenderType;
|
|
1054
737
|
story?: PreparedStory<TRenderer>;
|
|
@@ -1062,7 +745,7 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
|
|
|
1062
745
|
torndown: boolean;
|
|
1063
746
|
constructor(channel: Channel, store: StoryStore<TRenderer>, renderToScreen: RenderToCanvas<TRenderer>, callbacks: RenderContextCallbacks<TRenderer> & {
|
|
1064
747
|
showStoryDuringRender?: () => void;
|
|
1065
|
-
}, 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>);
|
|
1066
749
|
private runPhase;
|
|
1067
750
|
private checkIfAborted;
|
|
1068
751
|
prepare(): Promise<void>;
|
|
@@ -1088,12 +771,10 @@ declare class StoryRender<TRenderer extends Renderer> implements Render<TRendere
|
|
|
1088
771
|
}
|
|
1089
772
|
|
|
1090
773
|
type MaybePromise<T> = Promise<T> | T;
|
|
1091
|
-
declare class Preview<TRenderer extends Renderer> {
|
|
774
|
+
declare class Preview<TRenderer extends Renderer$1> {
|
|
1092
775
|
importFn: ModuleImportFn;
|
|
1093
776
|
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
1094
777
|
protected channel: Channel;
|
|
1095
|
-
/** @deprecated Will be removed in 8.0, please use channel instead */
|
|
1096
|
-
serverChannel?: Channel;
|
|
1097
778
|
protected storyStoreValue?: StoryStore<TRenderer>;
|
|
1098
779
|
renderToCanvas?: RenderToCanvas<TRenderer>;
|
|
1099
780
|
storyRenders: StoryRender<TRenderer>[];
|
|
@@ -1124,12 +805,12 @@ declare class Preview<TRenderer extends Renderer> {
|
|
|
1124
805
|
storyIndex?: StoryIndex;
|
|
1125
806
|
}): Promise<void>;
|
|
1126
807
|
onUpdateGlobals({ globals: updatedGlobals, currentStory, }: {
|
|
1127
|
-
globals: Globals;
|
|
808
|
+
globals: Globals$1;
|
|
1128
809
|
currentStory?: PreparedStory<TRenderer>;
|
|
1129
810
|
}): Promise<void>;
|
|
1130
811
|
onUpdateArgs({ storyId, updatedArgs }: {
|
|
1131
|
-
storyId: StoryId;
|
|
1132
|
-
updatedArgs: Args;
|
|
812
|
+
storyId: StoryId$1;
|
|
813
|
+
updatedArgs: Args$1;
|
|
1133
814
|
}): Promise<void>;
|
|
1134
815
|
onRequestArgTypesInfo({ id, payload }: RequestData<ArgTypesRequestPayload>): Promise<void>;
|
|
1135
816
|
onResetArgs({ storyId, argNames }: {
|
|
@@ -1138,22 +819,22 @@ declare class Preview<TRenderer extends Renderer> {
|
|
|
1138
819
|
}): Promise<void>;
|
|
1139
820
|
onForceReRender(): Promise<void>;
|
|
1140
821
|
onForceRemount({ storyId }: {
|
|
1141
|
-
storyId: StoryId;
|
|
822
|
+
storyId: StoryId$1;
|
|
1142
823
|
}): Promise<void>;
|
|
1143
824
|
renderStoryToElement(story: PreparedStory<TRenderer>, element: TRenderer['canvasElement'], callbacks: RenderContextCallbacks<TRenderer>, options: StoryRenderOptions): () => Promise<void>;
|
|
1144
825
|
teardownRender(render: StoryRender<TRenderer> | CsfDocsRender<TRenderer> | MdxDocsRender<TRenderer>, { viewModeChanged }?: {
|
|
1145
826
|
viewModeChanged?: boolean;
|
|
1146
827
|
}): Promise<void>;
|
|
1147
828
|
loadStory({ storyId }: {
|
|
1148
|
-
storyId: StoryId;
|
|
829
|
+
storyId: StoryId$1;
|
|
1149
830
|
}): Promise<PreparedStory<TRenderer>>;
|
|
1150
831
|
getStoryContext(story: PreparedStory<TRenderer>, { forceInitialArgs }?: {
|
|
1151
832
|
forceInitialArgs?: boolean | undefined;
|
|
1152
833
|
}): {
|
|
1153
|
-
args: Args;
|
|
1154
|
-
initialGlobals: Globals;
|
|
1155
|
-
globalTypes: (
|
|
1156
|
-
userGlobals: Globals;
|
|
834
|
+
args: Args$1;
|
|
835
|
+
initialGlobals: Globals$1;
|
|
836
|
+
globalTypes: (storybook_internal_types.GlobalTypes & storybook_internal_types.StrictGlobalTypes) | undefined;
|
|
837
|
+
userGlobals: Globals$1;
|
|
1157
838
|
reporting: ReporterAPI;
|
|
1158
839
|
globals: {
|
|
1159
840
|
[x: string]: any;
|
|
@@ -1165,46 +846,46 @@ declare class Preview<TRenderer extends Renderer> {
|
|
|
1165
846
|
subcomponents?: Record<string, (TRenderer & {
|
|
1166
847
|
T: any;
|
|
1167
848
|
})["component"]> | undefined;
|
|
1168
|
-
parameters:
|
|
1169
|
-
initialArgs: Args;
|
|
1170
|
-
argTypes:
|
|
1171
|
-
componentId:
|
|
1172
|
-
title:
|
|
1173
|
-
kind:
|
|
1174
|
-
id: StoryId;
|
|
1175
|
-
name:
|
|
1176
|
-
story:
|
|
1177
|
-
tags:
|
|
849
|
+
parameters: storybook_internal_types.Parameters;
|
|
850
|
+
initialArgs: Args$1;
|
|
851
|
+
argTypes: storybook_internal_types.StrictArgTypes<Args$1>;
|
|
852
|
+
componentId: storybook_internal_types.ComponentId;
|
|
853
|
+
title: storybook_internal_types.ComponentTitle;
|
|
854
|
+
kind: storybook_internal_types.ComponentTitle;
|
|
855
|
+
id: StoryId$1;
|
|
856
|
+
name: storybook_internal_types.StoryName;
|
|
857
|
+
story: storybook_internal_types.StoryName;
|
|
858
|
+
tags: storybook_internal_types.Tag[];
|
|
1178
859
|
moduleExport: storybook_internal_types.ModuleExport;
|
|
1179
|
-
originalStoryFn:
|
|
1180
|
-
undecoratedStoryFn:
|
|
1181
|
-
unboundStoryFn:
|
|
1182
|
-
applyLoaders: (context:
|
|
1183
|
-
applyBeforeEach: (context:
|
|
1184
|
-
applyAfterEach: (context:
|
|
1185
|
-
playFunction?: ((context:
|
|
1186
|
-
runStep:
|
|
1187
|
-
mount: (context:
|
|
860
|
+
originalStoryFn: storybook_internal_types.ArgsStoryFn<TRenderer>;
|
|
861
|
+
undecoratedStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
862
|
+
unboundStoryFn: storybook_internal_types.LegacyStoryFn<TRenderer>;
|
|
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
|
+
runStep: storybook_internal_types.StepRunner<TRenderer>;
|
|
868
|
+
mount: (context: storybook_internal_types.StoryContext<TRenderer, Args$1>) => () => Promise<storybook_internal_types.Canvas>;
|
|
1188
869
|
testingLibraryRender?: (...args: never[]) => unknown;
|
|
1189
870
|
renderToCanvas?: RenderToCanvas<TRenderer> | undefined;
|
|
1190
871
|
usesMount: boolean;
|
|
1191
|
-
storyGlobals: Globals;
|
|
1192
|
-
} & Pick<
|
|
872
|
+
storyGlobals: Globals$1;
|
|
873
|
+
} & Pick<storybook_internal_types.StoryContextForLoaders<Renderer$1, Args$1>, "allArgs" | "argsByTarget" | "unmappedArgs">;
|
|
1193
874
|
extract(options?: {
|
|
1194
875
|
includeDocsOnly: boolean;
|
|
1195
|
-
}): Promise<Record<string,
|
|
876
|
+
}): Promise<Record<string, storybook_internal_types.StoryContextForEnhancers<TRenderer, Args$1>>>;
|
|
1196
877
|
renderPreviewEntryError(reason: string, err: Error): void;
|
|
1197
878
|
}
|
|
1198
879
|
|
|
1199
880
|
interface SelectionSpecifier {
|
|
1200
881
|
storySpecifier: StorySpecifier;
|
|
1201
|
-
viewMode: ViewMode;
|
|
1202
|
-
args?: Args;
|
|
1203
|
-
globals?: Args;
|
|
882
|
+
viewMode: ViewMode$1;
|
|
883
|
+
args?: Args$1;
|
|
884
|
+
globals?: Args$1;
|
|
1204
885
|
}
|
|
1205
886
|
interface Selection {
|
|
1206
|
-
storyId: StoryId;
|
|
1207
|
-
viewMode: ViewMode;
|
|
887
|
+
storyId: StoryId$1;
|
|
888
|
+
viewMode: ViewMode$1;
|
|
1208
889
|
}
|
|
1209
890
|
interface SelectionStore {
|
|
1210
891
|
selectionSpecifier: SelectionSpecifier | null;
|
|
@@ -1233,8 +914,8 @@ interface View<TStorybookRoot> {
|
|
|
1233
914
|
showStoryDuringRender(): void;
|
|
1234
915
|
}
|
|
1235
916
|
|
|
1236
|
-
type PossibleRender<TRenderer extends Renderer> = StoryRender<TRenderer> | CsfDocsRender<TRenderer> | MdxDocsRender<TRenderer>;
|
|
1237
|
-
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> {
|
|
1238
919
|
importFn: ModuleImportFn;
|
|
1239
920
|
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
1240
921
|
selectionStore: SelectionStore;
|
|
@@ -1255,27 +936,27 @@ declare class PreviewWithSelection<TRenderer extends Renderer> extends Preview<T
|
|
|
1255
936
|
}): Promise<void>;
|
|
1256
937
|
onKeydown(event: KeyboardEvent): void;
|
|
1257
938
|
onSetCurrentStory(selection: {
|
|
1258
|
-
storyId: StoryId;
|
|
1259
|
-
viewMode?: ViewMode;
|
|
939
|
+
storyId: StoryId$1;
|
|
940
|
+
viewMode?: ViewMode$1;
|
|
1260
941
|
}): Promise<void>;
|
|
1261
942
|
onUpdateQueryParams(queryParams: any): void;
|
|
1262
943
|
onUpdateGlobals({ globals }: {
|
|
1263
|
-
globals: Globals;
|
|
944
|
+
globals: Globals$1;
|
|
1264
945
|
}): Promise<void>;
|
|
1265
946
|
onUpdateArgs({ storyId, updatedArgs }: {
|
|
1266
|
-
storyId: StoryId;
|
|
1267
|
-
updatedArgs: Args;
|
|
947
|
+
storyId: StoryId$1;
|
|
948
|
+
updatedArgs: Args$1;
|
|
1268
949
|
}): Promise<void>;
|
|
1269
950
|
onPreloadStories({ ids }: {
|
|
1270
951
|
ids: string[];
|
|
1271
952
|
}): Promise<void>;
|
|
1272
953
|
protected renderSelection({ persistedArgs }?: {
|
|
1273
|
-
persistedArgs?: Args;
|
|
954
|
+
persistedArgs?: Args$1;
|
|
1274
955
|
}): Promise<void>;
|
|
1275
956
|
teardownRender(render: PossibleRender<TRenderer>, { viewModeChanged }?: {
|
|
1276
957
|
viewModeChanged?: boolean;
|
|
1277
958
|
}): Promise<void>;
|
|
1278
|
-
mainStoryCallbacks(storyId: StoryId): {
|
|
959
|
+
mainStoryCallbacks(storyId: StoryId$1): {
|
|
1279
960
|
showStoryDuringRender: () => void;
|
|
1280
961
|
showMain: () => void;
|
|
1281
962
|
showError: (err: {
|
|
@@ -1287,14 +968,14 @@ declare class PreviewWithSelection<TRenderer extends Renderer> extends Preview<T
|
|
|
1287
968
|
renderPreviewEntryError(reason: string, err: Error): void;
|
|
1288
969
|
renderMissingStory(): void;
|
|
1289
970
|
renderStoryLoadingException(storySpecifier: StorySpecifier, err: Error): void;
|
|
1290
|
-
renderException(storyId: StoryId, error: Error): void;
|
|
1291
|
-
renderError(storyId: StoryId, { title, description }: {
|
|
971
|
+
renderException(storyId: StoryId$1, error: Error): void;
|
|
972
|
+
renderError(storyId: StoryId$1, { title, description }: {
|
|
1292
973
|
title: string;
|
|
1293
974
|
description: string;
|
|
1294
975
|
}): void;
|
|
1295
976
|
}
|
|
1296
977
|
|
|
1297
|
-
declare class PreviewWeb<TRenderer extends Renderer> extends PreviewWithSelection<TRenderer> {
|
|
978
|
+
declare class PreviewWeb<TRenderer extends Renderer$1> extends PreviewWithSelection<TRenderer> {
|
|
1298
979
|
importFn: ModuleImportFn;
|
|
1299
980
|
getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>;
|
|
1300
981
|
constructor(importFn: ModuleImportFn, getProjectAnnotations: () => MaybePromise<ProjectAnnotations<TRenderer>>);
|
|
@@ -1353,4 +1034,274 @@ declare class WebView implements View<HTMLElement> {
|
|
|
1353
1034
|
declare function simulateDOMContentLoaded(): void;
|
|
1354
1035
|
declare function simulatePageLoad($container: any): void;
|
|
1355
1036
|
|
|
1356
|
-
|
|
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
|
+
|
|
1305
|
+
declare function getCoreAnnotations(): any[];
|
|
1306
|
+
|
|
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 };
|