@storybook/csf 0.1.9 → 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",
+  "version": "0.1.10--canary.d841bb4.0",
   "description": "Component Story Format (CSF) utilities",
   "keywords": [
     "storybook",

package/CHANGELOG.md

@@ -1,193 +0,0 @@
-# v0.1.9 (Mon Jun 24 2024)
-
-#### 🐛 Bug Fix
-
-- Add `beforeAll` hook to CSF types [#96](https://github.com/ComponentDriven/csf/pull/96) ([@ghengeveld](https://github.com/ghengeveld))
-
-#### Authors: 2
-
-- Gert Hengeveld ([@ghengeveld](https://github.com/ghengeveld))
-- Michael Shilman ([@shilman](https://github.com/shilman))
-
----
-
-# v0.1.8 (Mon Jun 03 2024)
-
-#### 🐛 Bug Fix
-
-- Add project initialGlobals & component/story globals, deprecate project globals [#92](https://github.com/ComponentDriven/csf/pull/92) ([@shilman](https://github.com/shilman))
-
-#### Authors: 1
-
-- Michael Shilman ([@shilman](https://github.com/shilman))
-
----
-
-# v0.1.7 (Mon May 06 2024)
-
-#### 🐛 Bug Fix
-
-- Fix the package name in the readme [#81](https://github.com/ComponentDriven/csf/pull/81) ([@stof](https://github.com/stof))
-- Add utility for tag combination & negation [#80](https://github.com/ComponentDriven/csf/pull/80) ([@shilman](https://github.com/shilman))
-
-#### Authors: 2
-
-- Christophe Coevoet ([@stof](https://github.com/stof))
-- Michael Shilman ([@shilman](https://github.com/shilman))
-
----
-
-# v0.1.6 (Tue Apr 30 2024)
-
-#### 🐛 Bug Fix
-
-- Add the beforeEach hook [#82](https://github.com/ComponentDriven/csf/pull/82) ([@kasperpeulen](https://github.com/kasperpeulen))
-
-#### Authors: 1
-
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-
----
-
-# v0.1.5 (Thu Apr 25 2024)
-
-#### 🐛 Bug Fix
-
-- chore: resolve eslint issues [#87](https://github.com/ComponentDriven/csf/pull/87) ([@Cherry](https://github.com/Cherry))
-- fix: better handle readonly InputType options [#85](https://github.com/ComponentDriven/csf/pull/85) ([@Cherry](https://github.com/Cherry))
-
-#### Authors: 2
-
-- James Ross ([@Cherry](https://github.com/Cherry))
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-
----
-
-# v0.1.4 (Fri Apr 12 2024)
-
-#### 🐛 Bug Fix
-
-- Loosen control type and some fixes [#83](https://github.com/ComponentDriven/csf/pull/83) ([@kasperpeulen](https://github.com/kasperpeulen))
-
-#### Authors: 1
-
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-
----
-
-# v0.1.3 (Mon Mar 18 2024)
-
-#### 🐛 Bug Fix
-
-- Fix bad publish [#78](https://github.com/ComponentDriven/csf/pull/78) ([@shilman](https://github.com/shilman))
-- Improve InputType for controls [#75](https://github.com/ComponentDriven/csf/pull/75) ([@Shinigami92](https://github.com/Shinigami92) [@shilman](https://github.com/shilman))
-- Update README [#74](https://github.com/ComponentDriven/csf/pull/74) ([@nkabrown](https://github.com/nkabrown))
-
-#### Authors: 4
-
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-- Michael Shilman ([@shilman](https://github.com/shilman))
-- Nathan Brown ([@nkabrown](https://github.com/nkabrown))
-- Shinigami ([@Shinigami92](https://github.com/Shinigami92))
-
----
-
-# v0.1.2 (Wed Nov 22 2023)
-
-#### 🐛 Bug Fix
-
-- Allow loaders to be synchronous or void [#71](https://github.com/ComponentDriven/csf/pull/71) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Move `types` condition to the front [#69](https://github.com/ComponentDriven/csf/pull/69) ([@Andarist](https://github.com/Andarist))
-
-#### Authors: 2
-
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-- Mateusz Burzyński ([@Andarist](https://github.com/Andarist))
-
----
-
-# v0.1.1 (Fri Jun 02 2023)
-
-#### 🐛 Bug Fix
-
-- Move `types` condition to the front [#70](https://github.com/ComponentDriven/csf/pull/70) ([@Andarist](https://github.com/Andarist))
-
-#### Authors: 1
-
-- Mateusz Burzyński ([@Andarist](https://github.com/Andarist))
-
----
-
-# v0.1.0 (Mon Apr 03 2023)
-
-#### 🚀 Enhancement
-
-
-#### 🐛 Bug Fix
-
-- Turn Args interfaces into types when passed to decorators [#65](https://github.com/ComponentDriven/csf/pull/65) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Improve the startcase implementation to mimick lodash's version more closely [#64](https://github.com/ComponentDriven/csf/pull/64) ([@ndelangen](https://github.com/ndelangen))
-- replace lodash [#62](https://github.com/ComponentDriven/csf/pull/62) ([@ndelangen](https://github.com/ndelangen))
-- Fix bug with meta not working well as generic parameter for StoryObj [#60](https://github.com/ComponentDriven/csf/pull/60) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Make sure that index signatures (used in decorators) don't cause unexpected types [#58](https://github.com/ComponentDriven/csf/pull/58) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Add strict variants for Args and Paramters to CSF [#57](https://github.com/ComponentDriven/csf/pull/57) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Revert stricter parameters [#56](https://github.com/ComponentDriven/csf/pull/56) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Use builtin installation of actions/setup-node [#55](https://github.com/ComponentDriven/csf/pull/55) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Rename Framework to Renderer [#54](https://github.com/ComponentDriven/csf/pull/54) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Rework Framework type to contain `canvasElement` [#53](https://github.com/ComponentDriven/csf/pull/53) ([@tmeasday](https://github.com/tmeasday))
-- Add tags annotation at all levels [#52](https://github.com/ComponentDriven/csf/pull/52) ([@tmeasday](https://github.com/tmeasday))
-- First attempt at bringing new types over [#29](https://github.com/ComponentDriven/csf/pull/29) ([@tmeasday](https://github.com/tmeasday) [@shilman](https://github.com/shilman) [@ghengeveld](https://github.com/ghengeveld) [@wKich](https://github.com/wKich) [@kasperpeulen](https://github.com/kasperpeulen))
-- Revert "Play function can only be set at the story level" [#40](https://github.com/ComponentDriven/csf/pull/40) ([@wKich](https://github.com/wKich) [@shilman](https://github.com/shilman))
-- Add conditional arg types and metadata [#36](https://github.com/ComponentDriven/csf/pull/36) ([@shilman](https://github.com/shilman) [@tmeasday](https://github.com/tmeasday) [@kasperpeulen](https://github.com/kasperpeulen))
-- Re-apply `TArgs` to CSF `render` type [#43](https://github.com/ComponentDriven/csf/pull/43) ([@tmeasday](https://github.com/tmeasday) [@shilman](https://github.com/shilman) [@kasperpeulen](https://github.com/kasperpeulen))
-- Add step to play context and `runStep` to project annotations [#48](https://github.com/ComponentDriven/csf/pull/48) ([@tmeasday](https://github.com/tmeasday) [@shilman](https://github.com/shilman) [@kasperpeulen](https://github.com/kasperpeulen))
-- Sound arg types for CSF3 [#49](https://github.com/ComponentDriven/csf/pull/49) ([@kasperpeulen](https://github.com/kasperpeulen) [@shilman](https://github.com/shilman))
-- ArgsFromMeta utility and generic ArgsStoryFn RT [#51](https://github.com/ComponentDriven/csf/pull/51) ([@kasperpeulen](https://github.com/kasperpeulen))
-- Configure Auto [#50](https://github.com/ComponentDriven/csf/pull/50) ([@shilman](https://github.com/shilman))
-- Only make `TArgs` parameterize `args` and `argTypes` in our default annotations [#33](https://github.com/ComponentDriven/csf/pull/33) ([@tmeasday](https://github.com/tmeasday))
-- Adding Components.studio as a tool using CSF [#13](https://github.com/ComponentDriven/csf/pull/13) ([@georges-gomes](https://github.com/georges-gomes) [@ghengeveld](https://github.com/ghengeveld))
-- Makes name argument for 'toId' optional [#17](https://github.com/ComponentDriven/csf/pull/17) ([@unematiii](https://github.com/unematiii) [@ghengeveld](https://github.com/ghengeveld))
-- use permanent url for the header image [#12](https://github.com/ComponentDriven/csf/pull/12) ([@winkerVSbecks](https://github.com/winkerVSbecks))
-- fix link to image [#10](https://github.com/ComponentDriven/csf/pull/10) ([@winkerVSbecks](https://github.com/winkerVSbecks))
-- Publish under @componentdriven and update README [#8](https://github.com/ComponentDriven/csf/pull/8) ([@winkerVSbecks](https://github.com/winkerVSbecks))
-- Add meta types for CSF [#5](https://github.com/ComponentDriven/csf/pull/5) ([@wKich](https://github.com/wKich))
-- types of csf properties [#3](https://github.com/ComponentDriven/csf/pull/3) ([@atanasster](https://github.com/atanasster) [@ndelangen](https://github.com/ndelangen))
-- Extract @storybook/csf from monorepo [#1](https://github.com/ComponentDriven/csf/pull/1) ([@shilman](https://github.com/shilman))
-
-#### ⚠️ Pushed to `master`
-
-- First commit ([@shilman](https://github.com/shilman))
-
-#### 📝 Documentation
-
-- added storyNameFromExport(key) in README.md [#2](https://github.com/ComponentDriven/csf/pull/2) ([@georges-gomes](https://github.com/georges-gomes) [@shilman](https://github.com/shilman))
-
-#### 🔩 Dependency Updates
-
-- Bump handlebars from 4.5.3 to 4.7.7 [#20](https://github.com/ComponentDriven/csf/pull/20) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump y18n from 4.0.0 to 4.0.3 [#32](https://github.com/ComponentDriven/csf/pull/32) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump ini from 1.3.5 to 1.3.8 [#18](https://github.com/ComponentDriven/csf/pull/18) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump yargs-parser from 13.1.1 to 13.1.2 [#15](https://github.com/ComponentDriven/csf/pull/15) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump lodash from 4.17.15 to 4.17.21 [#21](https://github.com/ComponentDriven/csf/pull/21) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump hosted-git-info from 2.8.5 to 2.8.9 [#22](https://github.com/ComponentDriven/csf/pull/22) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump path-parse from 1.0.6 to 1.0.7 [#25](https://github.com/ComponentDriven/csf/pull/25) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump browserslist from 4.11.1 to 4.16.6 [#23](https://github.com/ComponentDriven/csf/pull/23) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump acorn from 5.7.3 to 5.7.4 [#27](https://github.com/ComponentDriven/csf/pull/27) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump ws from 5.2.2 to 5.2.3 [#28](https://github.com/ComponentDriven/csf/pull/28) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump tar from 4.4.13 to 4.4.19 [#30](https://github.com/ComponentDriven/csf/pull/30) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-- Bump tmpl from 1.0.4 to 1.0.5 [#31](https://github.com/ComponentDriven/csf/pull/31) ([@dependabot[bot]](https://github.com/dependabot[bot]))
-
-#### Authors: 12
-
-- [@dependabot[bot]](https://github.com/dependabot[bot])
-- Atanas Stoyanov ([@atanasster](https://github.com/atanasster))
-- Dmitriy Lazarev ([@wKich](https://github.com/wKich))
-- Dominic Nguyen ([@domyen](https://github.com/domyen))
-- Georges Gomes ([@georges-gomes](https://github.com/georges-gomes))
-- Gert Hengeveld ([@ghengeveld](https://github.com/ghengeveld))
-- Kasper Peulen ([@kasperpeulen](https://github.com/kasperpeulen))
-- Mati Kärner ([@unematiii](https://github.com/unematiii))
-- Michael Shilman ([@shilman](https://github.com/shilman))
-- Norbert de Langen ([@ndelangen](https://github.com/ndelangen))
-- Tom Coleman ([@tmeasday](https://github.com/tmeasday))
-- Varun Vachhar ([@winkerVSbecks](https://github.com/winkerVSbecks))