@storybook/csf - npm Package Compare versions

Comparing version 0.1.9 to 0.1.10--canary.d841bb4.0

dist/index.d.ts

@@ -218,3 +218,3 @@ import { Simplify, RemoveIndexSignature, UnionToIntersection } from 'type-fest';
 }
-type Renderer = {
+interface Renderer {
     /** What is the type of the `component` annotation in this renderer? */
@@ -227,3 +227,3 @@ component: unknown;
     T?: unknown;
-};
+}
 /** @deprecated - use `Renderer` */
@@ -252,22 +252,22 @@ type AnyFramework = Renderer;
 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;
@@ -282,4 +282,4 @@ type PartialStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (update?: StoryContextUpdate<Partial<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> {
     /**
@@ -329,19 +329,7 @@ * Wrapper components or Storybook decorators that wrap a story.
     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`
@@ -354,3 +342,3 @@ */
     runStep?: StepRunner<TRenderer, TArgs>;
-};
+}
 type StoryDescriptor$1 = string[] | RegExp;
@@ -514,2 +502,2 @@ interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> extends BaseAnnotations<TRenderer, TArgs> {
 
-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.json

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

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

34610

decreased by-26.04%

Number of package files

6

decreased by-14.29%

Lines of code

531

decreased by-2.21%

No dependency changes