@storybook/types 7.0.0-beta.47 → 7.0.0-beta.49

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 +54 -58
  2. package/package.json +3 -5
package/dist/index.d.ts CHANGED
@@ -974,42 +974,42 @@ interface SBBaseType {
974
974
  required?: boolean;
975
975
  raw?: string;
976
976
  }
977
- declare type SBScalarType = SBBaseType & {
977
+ type SBScalarType = SBBaseType & {
978
978
  name: 'boolean' | 'string' | 'number' | 'function' | 'symbol';
979
979
  };
980
- declare type SBArrayType = SBBaseType & {
980
+ type SBArrayType = SBBaseType & {
981
981
  name: 'array';
982
982
  value: SBType;
983
983
  };
984
- declare type SBObjectType = SBBaseType & {
984
+ type SBObjectType = SBBaseType & {
985
985
  name: 'object';
986
986
  value: Record<string, SBType>;
987
987
  };
988
- declare type SBEnumType = SBBaseType & {
988
+ type SBEnumType = SBBaseType & {
989
989
  name: 'enum';
990
990
  value: (string | number)[];
991
991
  };
992
- declare type SBIntersectionType = SBBaseType & {
992
+ type SBIntersectionType = SBBaseType & {
993
993
  name: 'intersection';
994
994
  value: SBType[];
995
995
  };
996
- declare type SBUnionType = SBBaseType & {
996
+ type SBUnionType = SBBaseType & {
997
997
  name: 'union';
998
998
  value: SBType[];
999
999
  };
1000
- declare type SBOtherType = SBBaseType & {
1000
+ type SBOtherType = SBBaseType & {
1001
1001
  name: 'other';
1002
1002
  value: string;
1003
1003
  };
1004
- declare type SBType = SBScalarType | SBEnumType | SBArrayType | SBObjectType | SBIntersectionType | SBUnionType | SBOtherType;
1004
+ type SBType = SBScalarType | SBEnumType | SBArrayType | SBObjectType | SBIntersectionType | SBUnionType | SBOtherType;
1005
1005
 
1006
- declare type StoryId = string;
1007
- declare type ComponentId = string;
1008
- declare type ComponentTitle = string;
1009
- declare type StoryName = string;
1006
+ type StoryId = string;
1007
+ type ComponentId = string;
1008
+ type ComponentTitle = string;
1009
+ type StoryName = string;
1010
1010
  /** @deprecated */
1011
- declare type StoryKind = ComponentTitle;
1012
- declare type Tag = string;
1011
+ type StoryKind = ComponentTitle;
1012
+ type Tag = string;
1013
1013
  interface StoryIdentifier {
1014
1014
  componentId: ComponentId;
1015
1015
  title: ComponentTitle;
@@ -1024,7 +1024,7 @@ interface StoryIdentifier {
1024
1024
  interface Parameters {
1025
1025
  [name: string]: any;
1026
1026
  }
1027
- declare type ConditionalTest = {
1027
+ type ConditionalTest = {
1028
1028
  truthy?: boolean;
1029
1029
  } | {
1030
1030
  exists: boolean;
@@ -1033,12 +1033,12 @@ declare type ConditionalTest = {
1033
1033
  } | {
1034
1034
  neq: any;
1035
1035
  };
1036
- declare type ConditionalValue = {
1036
+ type ConditionalValue = {
1037
1037
  arg: string;
1038
1038
  } | {
1039
1039
  global: string;
1040
1040
  };
1041
- declare type Conditional = ConditionalValue & ConditionalTest;
1041
+ type Conditional = ConditionalValue & ConditionalTest;
1042
1042
  interface InputType {
1043
1043
  name?: string;
1044
1044
  description?: string;
@@ -1057,22 +1057,22 @@ interface Args {
1057
1057
  interface StrictArgs {
1058
1058
  [name: string]: unknown;
1059
1059
  }
1060
- declare type ArgTypes<TArgs = Args> = {
1060
+ type ArgTypes<TArgs = Args> = {
1061
1061
  [name in keyof TArgs]: InputType;
1062
1062
  };
1063
- declare type StrictArgTypes<TArgs = Args> = {
1063
+ type StrictArgTypes<TArgs = Args> = {
1064
1064
  [name in keyof TArgs]: StrictInputType;
1065
1065
  };
1066
- declare type Globals = {
1066
+ type Globals = {
1067
1067
  [name: string]: any;
1068
1068
  };
1069
- declare type GlobalTypes = {
1069
+ type GlobalTypes = {
1070
1070
  [name: string]: InputType;
1071
1071
  };
1072
- declare type StrictGlobalTypes = {
1072
+ type StrictGlobalTypes = {
1073
1073
  [name: string]: StrictInputType;
1074
1074
  };
1075
- declare type Renderer = {
1075
+ type Renderer = {
1076
1076
  /** What is the type of the `component` annotation in this renderer? */
1077
1077
  component: unknown;
1078
1078
  /** What does the story function return in this renderer? */
@@ -1081,7 +1081,7 @@ declare type Renderer = {
1081
1081
  canvasElement: unknown;
1082
1082
  T?: unknown;
1083
1083
  };
1084
- declare type StoryContextForEnhancers<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryIdentifier & {
1084
+ type StoryContextForEnhancers<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryIdentifier & {
1085
1085
  component?: (TRenderer & {
1086
1086
  T: any;
1087
1087
  })['component'];
@@ -1092,43 +1092,43 @@ declare type StoryContextForEnhancers<TRenderer extends Renderer = Renderer, TAr
1092
1092
  initialArgs: TArgs;
1093
1093
  argTypes: StrictArgTypes<TArgs>;
1094
1094
  };
1095
- declare type ArgsEnhancer<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContextForEnhancers<TRenderer, TArgs>) => TArgs;
1096
- declare type ArgTypesEnhancer<TRenderer extends Renderer = Renderer, TArgs = Args> = ((context: StoryContextForEnhancers<TRenderer, TArgs>) => StrictArgTypes<TArgs>) & {
1095
+ type ArgsEnhancer<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContextForEnhancers<TRenderer, TArgs>) => TArgs;
1096
+ type ArgTypesEnhancer<TRenderer extends Renderer = Renderer, TArgs = Args> = ((context: StoryContextForEnhancers<TRenderer, TArgs>) => StrictArgTypes<TArgs>) & {
1097
1097
  secondPass?: boolean;
1098
1098
  };
1099
- declare type StoryContextUpdate<TArgs = Args> = {
1099
+ type StoryContextUpdate<TArgs = Args> = {
1100
1100
  args?: TArgs;
1101
1101
  globals?: Globals;
1102
1102
  [key: string]: any;
1103
1103
  };
1104
- declare type ViewMode$1 = 'story' | 'docs';
1105
- declare type StoryContextForLoaders<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContextForEnhancers<TRenderer, TArgs> & Required<StoryContextUpdate<TArgs>> & {
1104
+ type ViewMode$1 = 'story' | 'docs';
1105
+ type StoryContextForLoaders<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContextForEnhancers<TRenderer, TArgs> & Required<StoryContextUpdate<TArgs>> & {
1106
1106
  hooks: unknown;
1107
1107
  viewMode: ViewMode$1;
1108
1108
  originalStoryFn: StoryFn<TRenderer>;
1109
1109
  };
1110
- declare type LoaderFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContextForLoaders<TRenderer, TArgs>) => Promise<Record<string, any>>;
1111
- declare type StoryContext<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContextForLoaders<TRenderer, TArgs> & {
1110
+ type LoaderFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContextForLoaders<TRenderer, TArgs>) => Promise<Record<string, any>>;
1111
+ type StoryContext<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContextForLoaders<TRenderer, TArgs> & {
1112
1112
  loaded: Record<string, any>;
1113
1113
  abortSignal: AbortSignal;
1114
1114
  canvasElement: TRenderer['canvasElement'];
1115
1115
  };
1116
- declare type StepLabel = string;
1117
- declare type StepFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (label: StepLabel, play: PlayFunction<TRenderer, TArgs>) => Promise<void> | void;
1118
- declare type PlayFunctionContext<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContext<TRenderer, TArgs> & {
1116
+ type StepLabel = string;
1117
+ type StepFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (label: StepLabel, play: PlayFunction<TRenderer, TArgs>) => Promise<void> | void;
1118
+ type PlayFunctionContext<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContext<TRenderer, TArgs> & {
1119
1119
  step: StepFunction<TRenderer, TArgs>;
1120
1120
  };
1121
- declare type PlayFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: PlayFunctionContext<TRenderer, TArgs>) => Promise<void> | void;
1122
- declare type PartialStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (update?: StoryContextUpdate<Partial<TArgs>>) => TRenderer['storyResult'];
1123
- declare type LegacyStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContext<TRenderer, TArgs>) => TRenderer['storyResult'];
1124
- declare type ArgsStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (args: TArgs, context: StoryContext<TRenderer, TArgs>) => (TRenderer & {
1121
+ type PlayFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: PlayFunctionContext<TRenderer, TArgs>) => Promise<void> | void;
1122
+ type PartialStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (update?: StoryContextUpdate<Partial<TArgs>>) => TRenderer['storyResult'];
1123
+ type LegacyStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContext<TRenderer, TArgs>) => TRenderer['storyResult'];
1124
+ type ArgsStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (args: TArgs, context: StoryContext<TRenderer, TArgs>) => (TRenderer & {
1125
1125
  T: TArgs;
1126
1126
  })['storyResult'];
1127
- declare type StoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = LegacyStoryFn<TRenderer, TArgs> | ArgsStoryFn<TRenderer, TArgs>;
1128
- declare type DecoratorFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (fn: PartialStoryFn<TRenderer, TArgs>, c: StoryContext<TRenderer, TArgs>) => TRenderer['storyResult'];
1129
- declare type DecoratorApplicator<TRenderer extends Renderer = Renderer, TArgs = Args> = (storyFn: LegacyStoryFn<TRenderer, TArgs>, decorators: DecoratorFunction<TRenderer, TArgs>[]) => LegacyStoryFn<TRenderer, TArgs>;
1130
- declare type StepRunner<TRenderer extends Renderer = Renderer, TArgs = Args> = (label: StepLabel, play: PlayFunction<TRenderer, TArgs>, context: PlayFunctionContext<TRenderer, TArgs>) => Promise<void>;
1131
- declare type BaseAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> = {
1127
+ type StoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = LegacyStoryFn<TRenderer, TArgs> | ArgsStoryFn<TRenderer, TArgs>;
1128
+ type DecoratorFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (fn: PartialStoryFn<TRenderer, TArgs>, c: StoryContext<TRenderer, TArgs>) => TRenderer['storyResult'];
1129
+ type DecoratorApplicator<TRenderer extends Renderer = Renderer, TArgs = Args> = (storyFn: LegacyStoryFn<TRenderer, TArgs>, decorators: DecoratorFunction<TRenderer, TArgs>[]) => LegacyStoryFn<TRenderer, TArgs>;
1130
+ type StepRunner<TRenderer extends Renderer = Renderer, TArgs = Args> = (label: StepLabel, play: PlayFunction<TRenderer, TArgs>, context: PlayFunctionContext<TRenderer, TArgs>) => Promise<void>;
1131
+ type BaseAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> = {
1132
1132
  /**
1133
1133
  * Wrapper components or Storybook decorators that wrap a story.
1134
1134
  *
@@ -1161,7 +1161,7 @@ declare type BaseAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args
1161
1161
  */
1162
1162
  render?: ArgsStoryFn<TRenderer, TArgs>;
1163
1163
  };
1164
- declare type ProjectAnnotations$1<TRenderer extends Renderer = Renderer, TArgs = Args> = BaseAnnotations<TRenderer, TArgs> & {
1164
+ type ProjectAnnotations$1<TRenderer extends Renderer = Renderer, TArgs = Args> = BaseAnnotations<TRenderer, TArgs> & {
1165
1165
  argsEnhancers?: ArgsEnhancer<TRenderer, Args>[];
1166
1166
  argTypesEnhancers?: ArgTypesEnhancer<TRenderer, Args>[];
1167
1167
  globals?: Globals;
@@ -1169,7 +1169,7 @@ declare type ProjectAnnotations$1<TRenderer extends Renderer = Renderer, TArgs =
1169
1169
  applyDecorators?: DecoratorApplicator<TRenderer, Args>;
1170
1170
  runStep?: StepRunner<TRenderer, TArgs>;
1171
1171
  };
1172
- declare type StoryDescriptor$1 = string[] | RegExp;
1172
+ type StoryDescriptor$1 = string[] | RegExp;
1173
1173
  interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> extends BaseAnnotations<TRenderer, TArgs> {
1174
1174
  /**
1175
1175
  * Title of the component which will be presented in the navigation. **Should be unique.**
@@ -1246,7 +1246,7 @@ interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Ar
1246
1246
  */
1247
1247
  tags?: Tag[];
1248
1248
  }
1249
- declare type StoryAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args, TRequiredArgs = Partial<TArgs>> = BaseAnnotations<TRenderer, TArgs> & {
1249
+ type StoryAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args, TRequiredArgs = Partial<TArgs>> = BaseAnnotations<TRenderer, TArgs> & {
1250
1250
  /**
1251
1251
  * Override the display name in the UI (CSF v3)
1252
1252
  */
@@ -1270,18 +1270,18 @@ declare type StoryAnnotations<TRenderer extends Renderer = Renderer, TArgs = Arg
1270
1270
  } : {
1271
1271
  args: TRequiredArgs;
1272
1272
  });
1273
- declare type LegacyAnnotatedStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryFn<TRenderer, TArgs> & StoryAnnotations<TRenderer, TArgs>;
1274
- declare type LegacyStoryAnnotationsOrFn<TRenderer extends Renderer = Renderer, TArgs = Args> = LegacyAnnotatedStoryFn<TRenderer, TArgs> | StoryAnnotations<TRenderer, TArgs>;
1275
- declare type AnnotatedStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = ArgsStoryFn<TRenderer, TArgs> & StoryAnnotations<TRenderer, TArgs>;
1276
- declare type StoryAnnotationsOrFn<TRenderer extends Renderer = Renderer, TArgs = Args> = AnnotatedStoryFn<TRenderer, TArgs> | StoryAnnotations<TRenderer, TArgs>;
1277
- declare type ArgsFromMeta<TRenderer extends Renderer, Meta> = Meta extends {
1273
+ type LegacyAnnotatedStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryFn<TRenderer, TArgs> & StoryAnnotations<TRenderer, TArgs>;
1274
+ type LegacyStoryAnnotationsOrFn<TRenderer extends Renderer = Renderer, TArgs = Args> = LegacyAnnotatedStoryFn<TRenderer, TArgs> | StoryAnnotations<TRenderer, TArgs>;
1275
+ type AnnotatedStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = ArgsStoryFn<TRenderer, TArgs> & StoryAnnotations<TRenderer, TArgs>;
1276
+ type StoryAnnotationsOrFn<TRenderer extends Renderer = Renderer, TArgs = Args> = AnnotatedStoryFn<TRenderer, TArgs> | StoryAnnotations<TRenderer, TArgs>;
1277
+ type ArgsFromMeta<TRenderer extends Renderer, Meta> = Meta extends {
1278
1278
  render?: ArgsStoryFn<TRenderer, infer RArgs>;
1279
1279
  loaders?: (infer Loaders)[];
1280
1280
  decorators?: (infer Decorators)[];
1281
1281
  } ? Simplify<RemoveIndexSignature<RArgs & DecoratorsArgs<TRenderer, Decorators> & LoaderArgs<TRenderer, Loaders>>> : unknown;
1282
- declare type DecoratorsArgs<TRenderer extends Renderer, Decorators> = UnionToIntersection<Decorators extends DecoratorFunction<TRenderer, infer TArgs> ? TArgs : unknown>;
1283
- declare type LoaderArgs<TRenderer extends Renderer, Loaders> = UnionToIntersection<Loaders extends LoaderFunction<TRenderer, infer TArgs> ? TArgs : unknown>;
1284
- declare type StoryDescriptor = string[] | RegExp;
1282
+ type DecoratorsArgs<TRenderer extends Renderer, Decorators> = UnionToIntersection<Decorators extends DecoratorFunction<TRenderer, infer TArgs> ? TArgs : unknown>;
1283
+ type LoaderArgs<TRenderer extends Renderer, Loaders> = UnionToIntersection<Loaders extends LoaderFunction<TRenderer, infer TArgs> ? TArgs : unknown>;
1284
+ type StoryDescriptor = string[] | RegExp;
1285
1285
  interface IncludeExcludeOptions {
1286
1286
  includeStories?: StoryDescriptor;
1287
1287
  excludeStories?: StoryDescriptor;
@@ -2080,10 +2080,6 @@ interface StorybookConfig {
2080
2080
  * Enable a set of planned breaking changes for SB7.0
2081
2081
  */
2082
2082
  breakingChangesV7?: boolean;
2083
- /**
2084
- * Enable the step debugger functionality in Addon-interactions.
2085
- */
2086
- interactionsDebugger?: boolean;
2087
2083
  /**
2088
2084
  * Filter args with a "target" on the type from the render function (EXPERIMENTAL)
2089
2085
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storybook/types",
3
- "version": "7.0.0-beta.47",
3
+ "version": "7.0.0-beta.49",
4
4
  "description": "Core Storybook Types",
5
5
  "keywords": [
6
6
  "storybook"
@@ -43,11 +43,9 @@
43
43
  "prep": "../../../scripts/prepare/bundle.ts"
44
44
  },
45
45
  "dependencies": {
46
- "@babel/core": "^7.12.10",
47
- "@storybook/channels": "7.0.0-beta.47",
46
+ "@storybook/channels": "7.0.0-beta.49",
48
47
  "@types/babel__core": "^7.0.0",
49
48
  "@types/express": "^4.7.0",
50
- "express": "^4.17.3",
51
49
  "file-system-cache": "^2.0.0"
52
50
  },
53
51
  "devDependencies": {
@@ -63,5 +61,5 @@
63
61
  "./src/index.ts"
64
62
  ]
65
63
  },
66
- "gitHead": "a591d8eb579e68b26c277ab8ebdcafc2611530a5"
64
+ "gitHead": "a2b4f0b42ee2b071390794bbdf99d0366fa32472"
67
65
  }