@storybook/types 7.6.0-alpha.6 → 7.6.0-beta.0

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.
Files changed (2) hide show
  1. package/dist/index.d.ts +41 -22
  2. package/package.json +5 -5
package/dist/index.d.ts CHANGED
@@ -1064,15 +1064,15 @@ type ArgTypes<TArgs = Args> = {
1064
1064
  type StrictArgTypes<TArgs = Args> = {
1065
1065
  [name in keyof TArgs]: StrictInputType;
1066
1066
  };
1067
- type Globals = {
1067
+ interface Globals {
1068
1068
  [name: string]: any;
1069
- };
1070
- type GlobalTypes = {
1069
+ }
1070
+ interface GlobalTypes {
1071
1071
  [name: string]: InputType;
1072
- };
1073
- type StrictGlobalTypes = {
1072
+ }
1073
+ interface StrictGlobalTypes {
1074
1074
  [name: string]: StrictInputType;
1075
- };
1075
+ }
1076
1076
  type Renderer = {
1077
1077
  /** What is the type of the `component` annotation in this renderer? */
1078
1078
  component: unknown;
@@ -1082,7 +1082,7 @@ type Renderer = {
1082
1082
  canvasElement: unknown;
1083
1083
  T?: unknown;
1084
1084
  };
1085
- type StoryContextForEnhancers<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryIdentifier & {
1085
+ interface StoryContextForEnhancers<TRenderer extends Renderer = Renderer, TArgs = Args> extends StoryIdentifier {
1086
1086
  component?: (TRenderer & {
1087
1087
  T: any;
1088
1088
  })['component'];
@@ -1092,28 +1092,28 @@ type StoryContextForEnhancers<TRenderer extends Renderer = Renderer, TArgs = Arg
1092
1092
  parameters: Parameters;
1093
1093
  initialArgs: TArgs;
1094
1094
  argTypes: StrictArgTypes<TArgs>;
1095
- };
1095
+ }
1096
1096
  type ArgsEnhancer<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContextForEnhancers<TRenderer, TArgs>) => TArgs;
1097
1097
  type ArgTypesEnhancer<TRenderer extends Renderer = Renderer, TArgs = Args> = ((context: StoryContextForEnhancers<TRenderer, TArgs>) => StrictArgTypes<TArgs>) & {
1098
1098
  secondPass?: boolean;
1099
1099
  };
1100
- type StoryContextUpdate<TArgs = Args> = {
1100
+ interface StoryContextUpdate<TArgs = Args> {
1101
1101
  args?: TArgs;
1102
1102
  globals?: Globals;
1103
1103
  [key: string]: any;
1104
- };
1104
+ }
1105
1105
  type ViewMode$1 = 'story' | 'docs';
1106
- type StoryContextForLoaders<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContextForEnhancers<TRenderer, TArgs> & Required<StoryContextUpdate<TArgs>> & {
1106
+ interface StoryContextForLoaders<TRenderer extends Renderer = Renderer, TArgs = Args> extends StoryContextForEnhancers<TRenderer, TArgs>, Required<StoryContextUpdate<TArgs>> {
1107
1107
  hooks: unknown;
1108
1108
  viewMode: ViewMode$1;
1109
1109
  originalStoryFn: StoryFn<TRenderer>;
1110
- };
1111
- type LoaderFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContextForLoaders<TRenderer, TArgs>) => Promise<Record<string, any>>;
1112
- type StoryContext<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContextForLoaders<TRenderer, TArgs> & {
1110
+ }
1111
+ type LoaderFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContextForLoaders<TRenderer, TArgs>) => Promise<Record<string, any> | void> | Record<string, any> | void;
1112
+ interface StoryContext<TRenderer extends Renderer = Renderer, TArgs = Args> extends StoryContextForLoaders<TRenderer, TArgs> {
1113
1113
  loaded: Record<string, any>;
1114
1114
  abortSignal: AbortSignal;
1115
1115
  canvasElement: TRenderer['canvasElement'];
1116
- };
1116
+ }
1117
1117
  type StepLabel = string;
1118
1118
  type StepFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (label: StepLabel, play: PlayFunction<TRenderer, TArgs>) => Promise<void> | void;
1119
1119
  type PlayFunctionContext<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContext<TRenderer, TArgs> & {
@@ -1136,7 +1136,7 @@ type BaseAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> = {
1136
1136
  * Decorators defined in Meta will be applied to every story variation.
1137
1137
  * @see [Decorators](https://storybook.js.org/docs/addons/introduction/#1-decorators)
1138
1138
  */
1139
- decorators?: DecoratorFunction<TRenderer, Simplify<TArgs>>[];
1139
+ decorators?: DecoratorFunction<TRenderer, Simplify<TArgs>>[] | DecoratorFunction<TRenderer, Simplify<TArgs>>;
1140
1140
  /**
1141
1141
  * Custom metadata for a story.
1142
1142
  * @see [Parameters](https://storybook.js.org/docs/basics/writing-stories/#parameters)
@@ -1156,7 +1156,7 @@ type BaseAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> = {
1156
1156
  * Asynchronous functions which provide data for a story.
1157
1157
  * @see [Loaders](https://storybook.js.org/docs/react/writing-stories/loaders)
1158
1158
  */
1159
- loaders?: LoaderFunction<TRenderer, TArgs>[];
1159
+ loaders?: LoaderFunction<TRenderer, TArgs>[] | LoaderFunction<TRenderer, TArgs>;
1160
1160
  /**
1161
1161
  * Define a custom render function for the story(ies). If not passed, a default render function by the renderer will be used.
1162
1162
  */
@@ -1277,8 +1277,8 @@ type AnnotatedStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = Arg
1277
1277
  type StoryAnnotationsOrFn<TRenderer extends Renderer = Renderer, TArgs = Args> = AnnotatedStoryFn<TRenderer, TArgs> | StoryAnnotations<TRenderer, TArgs>;
1278
1278
  type ArgsFromMeta<TRenderer extends Renderer, Meta> = Meta extends {
1279
1279
  render?: ArgsStoryFn<TRenderer, infer RArgs>;
1280
- loaders?: (infer Loaders)[];
1281
- decorators?: (infer Decorators)[];
1280
+ loaders?: (infer Loaders)[] | infer Loaders;
1281
+ decorators?: (infer Decorators)[] | infer Decorators;
1282
1282
  } ? Simplify<RemoveIndexSignature<RArgs & DecoratorsArgs<TRenderer, Decorators> & LoaderArgs<TRenderer, Loaders>>> : unknown;
1283
1283
  type DecoratorsArgs<TRenderer extends Renderer, Decorators> = UnionToIntersection<Decorators extends DecoratorFunction<TRenderer, infer TArgs> ? TArgs : unknown>;
1284
1284
  type LoaderArgs<TRenderer extends Renderer, Loaders> = UnionToIntersection<Loaders extends LoaderFunction<TRenderer, infer TArgs> ? TArgs : unknown>;
@@ -3704,8 +3704,15 @@ interface TypescriptOptions {
3704
3704
  * Disable parsing typescript files through babel.
3705
3705
  *
3706
3706
  * @default `false`
3707
+ * @deprecated use `skipCompiler` instead
3707
3708
  */
3708
3709
  skipBabel: boolean;
3710
+ /**
3711
+ * Disable parsing typescript files through compiler.
3712
+ *
3713
+ * @default `false`
3714
+ */
3715
+ skipCompiler: boolean;
3709
3716
  }
3710
3717
  type Preset = string | {
3711
3718
  name: string;
@@ -3825,6 +3832,12 @@ interface StorybookConfig {
3825
3832
  * Apply decorators from preview.js before decorators from addons or frameworks
3826
3833
  */
3827
3834
  legacyDecoratorFileOrder?: boolean;
3835
+ /**
3836
+ * Disallow implicit actions during rendering. This will be the default in Storybook 8.
3837
+ *
3838
+ * This will make sure that your story renders the same no matter if docgen is enabled or not.
3839
+ */
3840
+ disallowImplicitActionsInRenderV8?: boolean;
3828
3841
  };
3829
3842
  build?: TestBuildConfig;
3830
3843
  /**
@@ -4743,21 +4756,27 @@ type ProjectAnnotations<TRenderer extends Renderer> = ProjectAnnotations$1<TRend
4743
4756
  renderToCanvas?: RenderToCanvas<TRenderer>;
4744
4757
  renderToDOM?: RenderToCanvas<TRenderer>;
4745
4758
  };
4746
- type NormalizedProjectAnnotations<TRenderer extends Renderer = Renderer> = ProjectAnnotations<TRenderer> & {
4759
+ type NormalizedProjectAnnotations<TRenderer extends Renderer = Renderer> = Omit<ProjectAnnotations<TRenderer>, 'decorators' | 'loaders'> & {
4747
4760
  argTypes?: StrictArgTypes;
4748
4761
  globalTypes?: StrictGlobalTypes;
4762
+ decorators?: DecoratorFunction<TRenderer>[];
4763
+ loaders?: LoaderFunction<TRenderer>[];
4749
4764
  };
4750
- type NormalizedComponentAnnotations<TRenderer extends Renderer = Renderer> = ComponentAnnotations<TRenderer> & {
4765
+ type NormalizedComponentAnnotations<TRenderer extends Renderer = Renderer> = Omit<ComponentAnnotations<TRenderer>, 'decorators' | 'loaders'> & {
4751
4766
  id: ComponentId;
4752
4767
  title: ComponentTitle;
4753
4768
  argTypes?: StrictArgTypes;
4769
+ decorators?: DecoratorFunction<TRenderer>[];
4770
+ loaders?: LoaderFunction<TRenderer>[];
4754
4771
  };
4755
- type NormalizedStoryAnnotations<TRenderer extends Renderer = Renderer> = Omit<StoryAnnotations<TRenderer>, 'storyName' | 'story'> & {
4772
+ type NormalizedStoryAnnotations<TRenderer extends Renderer = Renderer> = Omit<StoryAnnotations<TRenderer>, 'storyName' | 'story' | 'decorators' | 'loaders'> & {
4756
4773
  moduleExport: ModuleExport;
4757
4774
  id: StoryId;
4758
4775
  argTypes?: StrictArgTypes;
4759
4776
  name: StoryName;
4760
4777
  userStoryFn?: StoryFn<TRenderer>;
4778
+ decorators?: DecoratorFunction<TRenderer>[];
4779
+ loaders?: LoaderFunction<TRenderer>[];
4761
4780
  };
4762
4781
  type CSFFile<TRenderer extends Renderer = Renderer> = {
4763
4782
  meta: NormalizedComponentAnnotations<TRenderer>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storybook/types",
3
- "version": "7.6.0-alpha.6",
3
+ "version": "7.6.0-beta.0",
4
4
  "description": "Core Storybook TS Types",
5
5
  "keywords": [
6
6
  "storybook"
@@ -40,17 +40,17 @@
40
40
  "!src/**/*"
41
41
  ],
42
42
  "scripts": {
43
- "check": "../../../scripts/prepare/check.ts",
44
- "prep": "../../../scripts/prepare/bundle.ts"
43
+ "check": "node --loader ../../../scripts/node_modules/esbuild-register/loader.js -r ../../../scripts/node_modules/esbuild-register/register.js ../../../scripts/prepare/check.ts",
44
+ "prep": "node --loader ../../../scripts/node_modules/esbuild-register/loader.js -r ../../../scripts/node_modules/esbuild-register/register.js ../../../scripts/prepare/bundle.ts"
45
45
  },
46
46
  "dependencies": {
47
- "@storybook/channels": "7.6.0-alpha.6",
47
+ "@storybook/channels": "7.6.0-beta.0",
48
48
  "@types/babel__core": "^7.0.0",
49
49
  "@types/express": "^4.7.0",
50
50
  "file-system-cache": "2.3.0"
51
51
  },
52
52
  "devDependencies": {
53
- "@storybook/csf": "^0.1.0",
53
+ "@storybook/csf": "^0.1.2",
54
54
  "@types/fs-extra": "^11.0.1",
55
55
  "@types/node": "^18.0.0",
56
56
  "typescript": "~4.9.3"