@storybook/csf 0.1.9-next.0 → 0.1.10--canary.d841bb4.0

package/dist/index.d.ts

@@ -215,7 +215,7 @@ interface GlobalTypes {
 interface StrictGlobalTypes {
     [name: string]: StrictInputType;
 }
-type Renderer = {
+interface Renderer {
     /** What is the type of the `component` annotation in this renderer? */
     component: unknown;
     /** What does the story function return in this renderer? */
@@ -223,7 +223,7 @@ type Renderer = {
     /** What type of element does this renderer render to? */
     canvasElement: unknown;
     T?: unknown;
-};
+}
 /** @deprecated - use `Renderer` */
 type AnyFramework = Renderer;
 interface StoryContextForEnhancers<TRenderer extends Renderer = Renderer, TArgs = Args> extends StoryIdentifier {
@@ -247,26 +247,26 @@ interface StoryContextUpdate<TArgs = Args> {
     [key: string]: any;
 }
 type ViewMode = 'story' | 'docs';
-interface StoryContextForLoaders<TRenderer extends Renderer = Renderer, TArgs = Args> extends StoryContextForEnhancers<TRenderer, TArgs>, Required<StoryContextUpdate<TArgs>> {
-    hooks: unknown;
-    viewMode: ViewMode;
-    originalStoryFn: StoryFn<TRenderer>;
-}
 type LoaderFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContextForLoaders<TRenderer, TArgs>) => Promise<Record<string, any> | void> | Record<string, any> | void;
 type Awaitable<T> = T | PromiseLike<T>;
 type CleanupCallback = () => Awaitable<unknown>;
-type BeforeAll = () => Awaitable<CleanupCallback | void>;
 type BeforeEach<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContext<TRenderer, TArgs>) => Awaitable<CleanupCallback | void>;
-interface StoryContext<TRenderer extends Renderer = Renderer, TArgs = Args> extends StoryContextForLoaders<TRenderer, TArgs> {
+interface StoryContext<TRenderer extends Renderer = Renderer, TArgs = Args> extends StoryContextForEnhancers<TRenderer, TArgs>, Required<StoryContextUpdate<TArgs>> {
     loaded: Record<string, any>;
     abortSignal: AbortSignal;
     canvasElement: TRenderer['canvasElement'];
+    hooks: unknown;
+    originalStoryFn: StoryFn<TRenderer>;
+    viewMode: ViewMode;
+    step: StepFunction<TRenderer, TArgs>;
+    context: this;
 }
+/** @deprecated Use {@link StoryContext} instead. */
+type StoryContextForLoaders<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContext<TRenderer, TArgs>;
+/** @deprecated Use {@link StoryContext} instead. */
+type PlayFunctionContext<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContext<TRenderer, TArgs>;
 type StepLabel = string;
 type StepFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (label: StepLabel, play: PlayFunction<TRenderer, TArgs>) => Promise<void> | void;
-type PlayFunctionContext<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContext<TRenderer, TArgs> & {
-    step: StepFunction<TRenderer, TArgs>;
-};
 type PlayFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: PlayFunctionContext<TRenderer, TArgs>) => Promise<void> | void;
 type PartialStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (update?: StoryContextUpdate<Partial<TArgs>>) => TRenderer['storyResult'];
 type LegacyStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContext<TRenderer, TArgs>) => TRenderer['storyResult'];
@@ -276,8 +276,8 @@ type ArgsStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (args: T
 type StoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = LegacyStoryFn<TRenderer, TArgs> | ArgsStoryFn<TRenderer, TArgs>;
 type DecoratorFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (fn: PartialStoryFn<TRenderer, TArgs>, c: StoryContext<TRenderer, TArgs>) => TRenderer['storyResult'];
 type DecoratorApplicator<TRenderer extends Renderer = Renderer, TArgs = Args> = (storyFn: LegacyStoryFn<TRenderer, TArgs>, decorators: DecoratorFunction<TRenderer, TArgs>[]) => LegacyStoryFn<TRenderer, TArgs>;
-type StepRunner<TRenderer extends Renderer = Renderer, TArgs = Args> = (label: StepLabel, play: PlayFunction<TRenderer, TArgs>, context: PlayFunctionContext<TRenderer, TArgs>) => Promise<void>;
-type BaseAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> = {
+type StepRunner<TRenderer extends Renderer = Renderer, TArgs = Args> = (label: StepLabel, play: PlayFunction<TRenderer, TArgs>, context: StoryContext<TRenderer, TArgs>) => Promise<void>;
+interface BaseAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> {
     /**
      * Wrapper components or Storybook decorators that wrap a story.
      *
@@ -322,22 +322,10 @@ type BaseAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> = {
      * Named tags for a story, used to filter stories in different contexts.
      */
     tags?: Tag[];
-};
-type ProjectAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> = BaseAnnotations<TRenderer, TArgs> & {
+}
+interface ProjectAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> extends BaseAnnotations<TRenderer, TArgs> {
     argsEnhancers?: ArgsEnhancer<TRenderer, Args>[];
     argTypesEnhancers?: ArgTypesEnhancer<TRenderer, Args>[];
-    /**
-     * Lifecycle hook which runs once, before any loaders, decorators or stories, and may rerun when configuration changes or when reinitializing (e.g. between test runs).
-     * The function may be synchronous or asynchronous, and may return a cleanup function which may also be synchronous or asynchronous.
-     * The cleanup function is not guaranteed to run (e.g. when the browser closes), but runs when configuration changes or when reinitializing.
-     * This hook may only be defined globally (i.e. not on component or story level).
-     * When multiple hooks are specified, they are to be executed sequentially (and awaited) in the following order:
-     * - Addon hooks (in order of addons array in e.g. .storybook/main.js)
-     * - Annotation hooks (in order of previewAnnotations array in e.g. .storybook/main.js)
-     * - Preview hook (via e.g. .storybook/preview.js)
-     * Cleanup functions are executed sequentially in reverse order of initialization.
-     */
-    beforeAll?: BeforeAll;
     /**
      * @deprecated Project `globals` renamed to `initiaGlobals`
      */
@@ -346,7 +334,7 @@ type ProjectAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> = B
     globalTypes?: GlobalTypes;
     applyDecorators?: DecoratorApplicator<TRenderer, Args>;
     runStep?: StepRunner<TRenderer, TArgs>;
-};
+}
 type StoryDescriptor$1 = string[] | RegExp;
 interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> extends BaseAnnotations<TRenderer, TArgs> {
     /**
@@ -505,4 +493,4 @@ declare const parseKind: (kind: string, { rootSeparator, groupSeparator }: Separ
  */
 declare const combineTags: (...tags: string[]) => string[];
 
-export { AnnotatedStoryFn, AnyFramework, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, BeforeAll, BeforeEach, CleanupCallback, ComponentAnnotations, ComponentId, ComponentTitle, Conditional, DecoratorApplicator, DecoratorFunction, GlobalTypes, Globals, IncludeExcludeOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn, LegacyStoryFn, LoaderFunction, Parameters, PartialStoryFn, PlayFunction, PlayFunctionContext, ProjectAnnotations, Renderer, SBArrayType, SBEnumType, SBIntersectionType, SBObjectType, SBOtherType, SBScalarType, SBType, SBUnionType, SeparatorOptions, StepFunction, StepLabel, StepRunner, StoryAnnotations, StoryAnnotationsOrFn, StoryContext, StoryContextForEnhancers, StoryContextForLoaders, StoryContextUpdate, StoryFn, StoryId, StoryIdentifier, StoryKind, StoryName, StrictArgTypes, StrictArgs, StrictGlobalTypes, StrictInputType, StrictParameters, Tag, ViewMode, combineTags, includeConditionalArg, isExportStory, parseKind, sanitize, storyNameFromExport, toId };
+export { AnnotatedStoryFn, AnyFramework, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, BeforeEach, CleanupCallback, ComponentAnnotations, ComponentId, ComponentTitle, Conditional, DecoratorApplicator, DecoratorFunction, GlobalTypes, Globals, IncludeExcludeOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn, LegacyStoryFn, LoaderFunction, Parameters, PartialStoryFn, PlayFunction, PlayFunctionContext, ProjectAnnotations, Renderer, SBArrayType, SBEnumType, SBIntersectionType, SBObjectType, SBOtherType, SBScalarType, SBType, SBUnionType, SeparatorOptions, StepFunction, StepLabel, StepRunner, StoryAnnotations, StoryAnnotationsOrFn, StoryContext, StoryContextForEnhancers, StoryContextForLoaders, StoryContextUpdate, StoryFn, StoryId, StoryIdentifier, StoryKind, StoryName, StrictArgTypes, StrictArgs, StrictGlobalTypes, StrictInputType, StrictParameters, Tag, ViewMode, combineTags, includeConditionalArg, isExportStory, parseKind, sanitize, storyNameFromExport, toId };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/csf",
-  "version": "0.1.9-next.0",
+  "version": "0.1.10--canary.d841bb4.0",
   "description": "Component Story Format (CSF) utilities",
   "keywords": [
     "storybook",