@storybook/types 7.0.0-alpha.49 → 7.0.0-alpha.51
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.
- package/dist/index.d.ts +319 -210
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +7 -7
package/dist/index.d.ts
CHANGED
|
@@ -107,6 +107,111 @@ type Simplify<
|
|
|
107
107
|
? Flatten<AnyType, Options>
|
|
108
108
|
: AnyType;
|
|
109
109
|
|
|
110
|
+
/**
|
|
111
|
+
Remove any index signatures from the given object type, so that only explicitly defined properties remain.
|
|
112
|
+
|
|
113
|
+
Use-cases:
|
|
114
|
+
- Remove overly permissive signatures from third-party types.
|
|
115
|
+
|
|
116
|
+
This type was taken from this [StackOverflow answer](https://stackoverflow.com/a/68261113/420747).
|
|
117
|
+
|
|
118
|
+
It relies on the fact that an empty object (`{}`) is assignable to an object with just an index signature, like `Record<string, unknown>`, but not to an object with explicitly defined keys, like `Record<'foo' | 'bar', unknown>`.
|
|
119
|
+
|
|
120
|
+
(The actual value type, `unknown`, is irrelevant and could be any type. Only the key type matters.)
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
const indexed: Record<string, unknown> = {}; // Allowed
|
|
124
|
+
|
|
125
|
+
const keyed: Record<'foo', unknown> = {}; // Error
|
|
126
|
+
// => TS2739: Type '{}' is missing the following properties from type 'Record<"foo" | "bar", unknown>': foo, bar
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Instead of causing a type error like the above, you can also use a [conditional type](https://www.typescriptlang.org/docs/handbook/2/conditional-types.html) to test whether a type is assignable to another:
|
|
130
|
+
|
|
131
|
+
```
|
|
132
|
+
type Indexed = {} extends Record<string, unknown>
|
|
133
|
+
? '✅ `{}` is assignable to `Record<string, unknown>`'
|
|
134
|
+
: '❌ `{}` is NOT assignable to `Record<string, unknown>`';
|
|
135
|
+
// => '✅ `{}` is assignable to `Record<string, unknown>`'
|
|
136
|
+
|
|
137
|
+
type Keyed = {} extends Record<'foo' | 'bar', unknown>
|
|
138
|
+
? "✅ `{}` is assignable to `Record<'foo' | 'bar', unknown>`"
|
|
139
|
+
: "❌ `{}` is NOT assignable to `Record<'foo' | 'bar', unknown>`";
|
|
140
|
+
// => "❌ `{}` is NOT assignable to `Record<'foo' | 'bar', unknown>`"
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
Using a [mapped type](https://www.typescriptlang.org/docs/handbook/2/mapped-types.html#further-exploration), you can then check for each `KeyType` of `ObjectType`...
|
|
144
|
+
|
|
145
|
+
```
|
|
146
|
+
import type {RemoveIndexSignature} from 'type-fest';
|
|
147
|
+
|
|
148
|
+
type RemoveIndexSignature<ObjectType> = {
|
|
149
|
+
[KeyType in keyof ObjectType // Map each key of `ObjectType`...
|
|
150
|
+
]: ObjectType[KeyType]; // ...to its original value, i.e. `RemoveIndexSignature<Foo> == Foo`.
|
|
151
|
+
};
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
...whether an empty object (`{}`) would be assignable to an object with that `KeyType` (`Record<KeyType, unknown>`)...
|
|
155
|
+
|
|
156
|
+
```
|
|
157
|
+
import type {RemoveIndexSignature} from 'type-fest';
|
|
158
|
+
|
|
159
|
+
type RemoveIndexSignature<ObjectType> = {
|
|
160
|
+
[KeyType in keyof ObjectType
|
|
161
|
+
// Is `{}` assignable to `Record<KeyType, unknown>`?
|
|
162
|
+
as {} extends Record<KeyType, unknown>
|
|
163
|
+
? ... // ✅ `{}` is assignable to `Record<KeyType, unknown>`
|
|
164
|
+
: ... // ❌ `{}` is NOT assignable to `Record<KeyType, unknown>`
|
|
165
|
+
]: ObjectType[KeyType];
|
|
166
|
+
};
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
If `{}` is assignable, it means that `KeyType` is an index signature and we want to remove it. If it is not assignable, `KeyType` is a "real" key and we want to keep it.
|
|
170
|
+
|
|
171
|
+
```
|
|
172
|
+
import type {RemoveIndexSignature} from 'type-fest';
|
|
173
|
+
|
|
174
|
+
type RemoveIndexSignature<ObjectType> = {
|
|
175
|
+
[KeyType in keyof ObjectType
|
|
176
|
+
as {} extends Record<KeyType, unknown>
|
|
177
|
+
? never // => Remove this `KeyType`.
|
|
178
|
+
: KeyType // => Keep this `KeyType` as it is.
|
|
179
|
+
]: ObjectType[KeyType];
|
|
180
|
+
};
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
@example
|
|
184
|
+
```
|
|
185
|
+
import type {RemoveIndexSignature} from 'type-fest';
|
|
186
|
+
|
|
187
|
+
interface Example {
|
|
188
|
+
// These index signatures will be removed.
|
|
189
|
+
[x: string]: any
|
|
190
|
+
[x: number]: any
|
|
191
|
+
[x: symbol]: any
|
|
192
|
+
[x: `head-${string}`]: string
|
|
193
|
+
[x: `${string}-tail`]: string
|
|
194
|
+
[x: `head-${string}-tail`]: string
|
|
195
|
+
[x: `${bigint}`]: string
|
|
196
|
+
[x: `embedded-${number}`]: string
|
|
197
|
+
|
|
198
|
+
// These explicitly defined keys will remain.
|
|
199
|
+
foo: 'bar';
|
|
200
|
+
qux?: 'baz';
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
type ExampleWithoutIndexSignatures = RemoveIndexSignature<Example>;
|
|
204
|
+
// => { foo: 'bar'; qux?: 'baz' | undefined; }
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
@category Object
|
|
208
|
+
*/
|
|
209
|
+
type RemoveIndexSignature<ObjectType> = {
|
|
210
|
+
[KeyType in keyof ObjectType as {} extends Record<KeyType, unknown>
|
|
211
|
+
? never
|
|
212
|
+
: KeyType]: ObjectType[KeyType];
|
|
213
|
+
};
|
|
214
|
+
|
|
110
215
|
/**
|
|
111
216
|
Allows creating a union type by combining primitive types and literal types without sacrificing auto-completion in IDEs for the literal type part of the union.
|
|
112
217
|
|
|
@@ -915,9 +1020,9 @@ interface StoryIdentifier {
|
|
|
915
1020
|
story: StoryName;
|
|
916
1021
|
tags: Tag[];
|
|
917
1022
|
}
|
|
918
|
-
|
|
1023
|
+
interface Parameters {
|
|
919
1024
|
[name: string]: any;
|
|
920
|
-
}
|
|
1025
|
+
}
|
|
921
1026
|
declare type ConditionalTest = {
|
|
922
1027
|
truthy?: boolean;
|
|
923
1028
|
} | {
|
|
@@ -945,9 +1050,12 @@ interface StrictInputType extends InputType {
|
|
|
945
1050
|
name: string;
|
|
946
1051
|
type?: SBType;
|
|
947
1052
|
}
|
|
948
|
-
|
|
1053
|
+
interface Args {
|
|
949
1054
|
[name: string]: any;
|
|
950
|
-
}
|
|
1055
|
+
}
|
|
1056
|
+
interface StrictArgs {
|
|
1057
|
+
[name: string]: unknown;
|
|
1058
|
+
}
|
|
951
1059
|
declare type ArgTypes<TArgs = Args> = {
|
|
952
1060
|
[name in keyof TArgs]: InputType;
|
|
953
1061
|
};
|
|
@@ -963,28 +1071,28 @@ declare type GlobalTypes = {
|
|
|
963
1071
|
declare type StrictGlobalTypes = {
|
|
964
1072
|
[name: string]: StrictInputType;
|
|
965
1073
|
};
|
|
966
|
-
declare type
|
|
967
|
-
/** What
|
|
1074
|
+
declare type Renderer = {
|
|
1075
|
+
/** What is the type of the `component` annotation in this renderer? */
|
|
968
1076
|
component: unknown;
|
|
969
|
-
/** What does the story function return in this
|
|
1077
|
+
/** What does the story function return in this renderer? */
|
|
970
1078
|
storyResult: unknown;
|
|
971
|
-
/** What type of element does this
|
|
1079
|
+
/** What type of element does this renderer render to? */
|
|
972
1080
|
canvasElement: unknown;
|
|
973
1081
|
T?: unknown;
|
|
974
1082
|
};
|
|
975
|
-
declare type StoryContextForEnhancers<
|
|
976
|
-
component?: (
|
|
1083
|
+
declare type StoryContextForEnhancers<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryIdentifier & {
|
|
1084
|
+
component?: (TRenderer & {
|
|
977
1085
|
T: any;
|
|
978
1086
|
})['component'];
|
|
979
|
-
subcomponents?: Record<string, (
|
|
1087
|
+
subcomponents?: Record<string, (TRenderer & {
|
|
980
1088
|
T: any;
|
|
981
1089
|
})['component']>;
|
|
982
|
-
parameters: Parameters
|
|
1090
|
+
parameters: Parameters;
|
|
983
1091
|
initialArgs: TArgs;
|
|
984
1092
|
argTypes: StrictArgTypes<TArgs>;
|
|
985
1093
|
};
|
|
986
|
-
declare type ArgsEnhancer<
|
|
987
|
-
declare type ArgTypesEnhancer<
|
|
1094
|
+
declare type ArgsEnhancer<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContextForEnhancers<TRenderer, TArgs>) => TArgs;
|
|
1095
|
+
declare type ArgTypesEnhancer<TRenderer extends Renderer = Renderer, TArgs = Args> = ((context: StoryContextForEnhancers<TRenderer, TArgs>) => StrictArgTypes<TArgs>) & {
|
|
988
1096
|
secondPass?: boolean;
|
|
989
1097
|
};
|
|
990
1098
|
declare type StoryContextUpdate<TArgs = Args> = {
|
|
@@ -993,45 +1101,45 @@ declare type StoryContextUpdate<TArgs = Args> = {
|
|
|
993
1101
|
[key: string]: any;
|
|
994
1102
|
};
|
|
995
1103
|
declare type ViewMode$1 = 'story' | 'docs';
|
|
996
|
-
declare type StoryContextForLoaders<
|
|
1104
|
+
declare type StoryContextForLoaders<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContextForEnhancers<TRenderer, TArgs> & Required<StoryContextUpdate<TArgs>> & {
|
|
997
1105
|
hooks: unknown;
|
|
998
1106
|
viewMode: ViewMode$1;
|
|
999
|
-
originalStoryFn: StoryFn<
|
|
1107
|
+
originalStoryFn: StoryFn<TRenderer>;
|
|
1000
1108
|
};
|
|
1001
|
-
declare type LoaderFunction<
|
|
1002
|
-
declare type StoryContext<
|
|
1109
|
+
declare type LoaderFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContextForLoaders<TRenderer, TArgs>) => Promise<Record<string, any>>;
|
|
1110
|
+
declare type StoryContext<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContextForLoaders<TRenderer, TArgs> & {
|
|
1003
1111
|
loaded: Record<string, any>;
|
|
1004
1112
|
abortSignal: AbortSignal;
|
|
1005
|
-
canvasElement:
|
|
1113
|
+
canvasElement: TRenderer['canvasElement'];
|
|
1006
1114
|
};
|
|
1007
1115
|
declare type StepLabel = string;
|
|
1008
|
-
declare type StepFunction<
|
|
1009
|
-
declare type PlayFunctionContext<
|
|
1010
|
-
step: StepFunction<
|
|
1011
|
-
};
|
|
1012
|
-
declare type PlayFunction<
|
|
1013
|
-
declare type PartialStoryFn<
|
|
1014
|
-
declare type LegacyStoryFn<
|
|
1015
|
-
declare type ArgsStoryFn<
|
|
1116
|
+
declare type StepFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (label: StepLabel, play: PlayFunction<TRenderer, TArgs>) => Promise<void> | void;
|
|
1117
|
+
declare type PlayFunctionContext<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContext<TRenderer, TArgs> & {
|
|
1118
|
+
step: StepFunction<TRenderer, TArgs>;
|
|
1119
|
+
};
|
|
1120
|
+
declare type PlayFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: PlayFunctionContext<TRenderer, TArgs>) => Promise<void> | void;
|
|
1121
|
+
declare type PartialStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (update?: StoryContextUpdate<Partial<TArgs>>) => TRenderer['storyResult'];
|
|
1122
|
+
declare type LegacyStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContext<TRenderer, TArgs>) => TRenderer['storyResult'];
|
|
1123
|
+
declare type ArgsStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (args: TArgs, context: StoryContext<TRenderer, TArgs>) => (TRenderer & {
|
|
1016
1124
|
T: TArgs;
|
|
1017
1125
|
})['storyResult'];
|
|
1018
|
-
declare type StoryFn<
|
|
1019
|
-
declare type DecoratorFunction<
|
|
1020
|
-
declare type DecoratorApplicator<
|
|
1021
|
-
declare type StepRunner<
|
|
1022
|
-
declare type BaseAnnotations<
|
|
1126
|
+
declare type StoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = LegacyStoryFn<TRenderer, TArgs> | ArgsStoryFn<TRenderer, TArgs>;
|
|
1127
|
+
declare type DecoratorFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (fn: PartialStoryFn<TRenderer, TArgs>, c: StoryContext<TRenderer, TArgs>) => TRenderer['storyResult'];
|
|
1128
|
+
declare type DecoratorApplicator<TRenderer extends Renderer = Renderer, TArgs = Args> = (storyFn: LegacyStoryFn<TRenderer, TArgs>, decorators: DecoratorFunction<TRenderer, TArgs>[]) => LegacyStoryFn<TRenderer, TArgs>;
|
|
1129
|
+
declare type StepRunner<TRenderer extends Renderer = Renderer, TArgs = Args> = (label: StepLabel, play: PlayFunction<TRenderer, TArgs>, context: PlayFunctionContext<TRenderer, TArgs>) => Promise<void>;
|
|
1130
|
+
declare type BaseAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> = {
|
|
1023
1131
|
/**
|
|
1024
1132
|
* Wrapper components or Storybook decorators that wrap a story.
|
|
1025
1133
|
*
|
|
1026
1134
|
* Decorators defined in Meta will be applied to every story variation.
|
|
1027
1135
|
* @see [Decorators](https://storybook.js.org/docs/addons/introduction/#1-decorators)
|
|
1028
1136
|
*/
|
|
1029
|
-
decorators?: DecoratorFunction<
|
|
1137
|
+
decorators?: DecoratorFunction<TRenderer, TArgs>[];
|
|
1030
1138
|
/**
|
|
1031
1139
|
* Custom metadata for a story.
|
|
1032
1140
|
* @see [Parameters](https://storybook.js.org/docs/basics/writing-stories/#parameters)
|
|
1033
1141
|
*/
|
|
1034
|
-
parameters?: Parameters
|
|
1142
|
+
parameters?: Parameters;
|
|
1035
1143
|
/**
|
|
1036
1144
|
* Dynamic data that are provided (and possibly updated by) Storybook and its addons.
|
|
1037
1145
|
* @see [Arg story inputs](https://storybook.js.org/docs/react/api/csf#args-story-inputs)
|
|
@@ -1046,22 +1154,22 @@ declare type BaseAnnotations<TFramework extends Framework = Framework, TArgs = A
|
|
|
1046
1154
|
* Asynchronous functions which provide data for a story.
|
|
1047
1155
|
* @see [Loaders](https://storybook.js.org/docs/react/writing-stories/loaders)
|
|
1048
1156
|
*/
|
|
1049
|
-
loaders?: LoaderFunction<
|
|
1157
|
+
loaders?: LoaderFunction<TRenderer, TArgs>[];
|
|
1050
1158
|
/**
|
|
1051
|
-
* Define a custom render function for the story(ies). If not passed, a default render function by the
|
|
1159
|
+
* Define a custom render function for the story(ies). If not passed, a default render function by the renderer will be used.
|
|
1052
1160
|
*/
|
|
1053
|
-
render?: ArgsStoryFn<
|
|
1161
|
+
render?: ArgsStoryFn<TRenderer, TArgs>;
|
|
1054
1162
|
};
|
|
1055
|
-
declare type ProjectAnnotations$1<
|
|
1056
|
-
argsEnhancers?: ArgsEnhancer<
|
|
1057
|
-
argTypesEnhancers?: ArgTypesEnhancer<
|
|
1163
|
+
declare type ProjectAnnotations$1<TRenderer extends Renderer = Renderer, TArgs = Args> = BaseAnnotations<TRenderer, TArgs> & {
|
|
1164
|
+
argsEnhancers?: ArgsEnhancer<TRenderer, Args>[];
|
|
1165
|
+
argTypesEnhancers?: ArgTypesEnhancer<TRenderer, Args>[];
|
|
1058
1166
|
globals?: Globals;
|
|
1059
1167
|
globalTypes?: GlobalTypes;
|
|
1060
|
-
applyDecorators?: DecoratorApplicator<
|
|
1061
|
-
runStep?: StepRunner<
|
|
1168
|
+
applyDecorators?: DecoratorApplicator<TRenderer, Args>;
|
|
1169
|
+
runStep?: StepRunner<TRenderer, TArgs>;
|
|
1062
1170
|
};
|
|
1063
1171
|
declare type StoryDescriptor$1 = string[] | RegExp;
|
|
1064
|
-
interface ComponentAnnotations<
|
|
1172
|
+
interface ComponentAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args> extends BaseAnnotations<TRenderer, TArgs> {
|
|
1065
1173
|
/**
|
|
1066
1174
|
* Title of the component which will be presented in the navigation. **Should be unique.**
|
|
1067
1175
|
*
|
|
@@ -1109,7 +1217,7 @@ interface ComponentAnnotations<TFramework extends Framework = Framework, TArgs =
|
|
|
1109
1217
|
*
|
|
1110
1218
|
* Used by addons for automatic prop table generation and display of other component metadata.
|
|
1111
1219
|
*/
|
|
1112
|
-
component?: (
|
|
1220
|
+
component?: (TRenderer & {
|
|
1113
1221
|
T: Args extends TArgs ? any : TArgs;
|
|
1114
1222
|
})['component'];
|
|
1115
1223
|
/**
|
|
@@ -1127,17 +1235,17 @@ interface ComponentAnnotations<TFramework extends Framework = Framework, TArgs =
|
|
|
1127
1235
|
*
|
|
1128
1236
|
* By defining them each component will have its tab in the args table.
|
|
1129
1237
|
*/
|
|
1130
|
-
subcomponents?: Record<string,
|
|
1238
|
+
subcomponents?: Record<string, TRenderer['component']>;
|
|
1131
1239
|
/**
|
|
1132
1240
|
* Function that is executed after the story is rendered.
|
|
1133
1241
|
*/
|
|
1134
|
-
play?: PlayFunction<
|
|
1242
|
+
play?: PlayFunction<TRenderer, TArgs>;
|
|
1135
1243
|
/**
|
|
1136
1244
|
* Named tags for a story, used to filter stories in different contexts.
|
|
1137
1245
|
*/
|
|
1138
1246
|
tags?: Tag[];
|
|
1139
1247
|
}
|
|
1140
|
-
declare type StoryAnnotations<
|
|
1248
|
+
declare type StoryAnnotations<TRenderer extends Renderer = Renderer, TArgs = Args, TRequiredArgs = Partial<TArgs>> = BaseAnnotations<TRenderer, TArgs> & {
|
|
1141
1249
|
/**
|
|
1142
1250
|
* Override the display name in the UI (CSF v3)
|
|
1143
1251
|
*/
|
|
@@ -1149,29 +1257,29 @@ declare type StoryAnnotations<TFramework extends Framework = Framework, TArgs =
|
|
|
1149
1257
|
/**
|
|
1150
1258
|
* Function that is executed after the story is rendered.
|
|
1151
1259
|
*/
|
|
1152
|
-
play?: PlayFunction<
|
|
1260
|
+
play?: PlayFunction<TRenderer, TArgs>;
|
|
1153
1261
|
/**
|
|
1154
1262
|
* Named tags for a story, used to filter stories in different contexts.
|
|
1155
1263
|
*/
|
|
1156
1264
|
tags?: Tag[];
|
|
1157
1265
|
/** @deprecated */
|
|
1158
|
-
story?: Omit<StoryAnnotations<
|
|
1266
|
+
story?: Omit<StoryAnnotations<TRenderer, TArgs>, 'story'>;
|
|
1159
1267
|
} & ({} extends TRequiredArgs ? {
|
|
1160
1268
|
args?: TRequiredArgs;
|
|
1161
1269
|
} : {
|
|
1162
1270
|
args: TRequiredArgs;
|
|
1163
1271
|
});
|
|
1164
|
-
declare type LegacyAnnotatedStoryFn<
|
|
1165
|
-
declare type LegacyStoryAnnotationsOrFn<
|
|
1166
|
-
declare type AnnotatedStoryFn<
|
|
1167
|
-
declare type StoryAnnotationsOrFn<
|
|
1168
|
-
declare type ArgsFromMeta<
|
|
1169
|
-
render?: ArgsStoryFn<
|
|
1272
|
+
declare type LegacyAnnotatedStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryFn<TRenderer, TArgs> & StoryAnnotations<TRenderer, TArgs>;
|
|
1273
|
+
declare type LegacyStoryAnnotationsOrFn<TRenderer extends Renderer = Renderer, TArgs = Args> = LegacyAnnotatedStoryFn<TRenderer, TArgs> | StoryAnnotations<TRenderer, TArgs>;
|
|
1274
|
+
declare type AnnotatedStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = ArgsStoryFn<TRenderer, TArgs> & StoryAnnotations<TRenderer, TArgs>;
|
|
1275
|
+
declare type StoryAnnotationsOrFn<TRenderer extends Renderer = Renderer, TArgs = Args> = AnnotatedStoryFn<TRenderer, TArgs> | StoryAnnotations<TRenderer, TArgs>;
|
|
1276
|
+
declare type ArgsFromMeta<TRenderer extends Renderer, Meta> = Meta extends {
|
|
1277
|
+
render?: ArgsStoryFn<TRenderer, infer RArgs>;
|
|
1170
1278
|
loaders?: (infer Loaders)[];
|
|
1171
1279
|
decorators?: (infer Decorators)[];
|
|
1172
|
-
} ? Simplify<RArgs & DecoratorsArgs<
|
|
1173
|
-
declare type DecoratorsArgs<
|
|
1174
|
-
declare type LoaderArgs<
|
|
1280
|
+
} ? Simplify<RemoveIndexSignature<RArgs & DecoratorsArgs<TRenderer, Decorators> & LoaderArgs<TRenderer, Loaders>>> : unknown;
|
|
1281
|
+
declare type DecoratorsArgs<TRenderer extends Renderer, Decorators> = UnionToIntersection<Decorators extends DecoratorFunction<TRenderer, infer TArgs> ? TArgs : unknown>;
|
|
1282
|
+
declare type LoaderArgs<TRenderer extends Renderer, Loaders> = UnionToIntersection<Loaders extends LoaderFunction<TRenderer, infer TArgs> ? TArgs : unknown>;
|
|
1175
1283
|
declare type StoryDescriptor = string[] | RegExp;
|
|
1176
1284
|
interface IncludeExcludeOptions {
|
|
1177
1285
|
includeStories?: StoryDescriptor;
|
|
@@ -1264,11 +1372,11 @@ interface Other extends StoryData {
|
|
|
1264
1372
|
path: string;
|
|
1265
1373
|
singleStory?: boolean;
|
|
1266
1374
|
}
|
|
1267
|
-
|
|
1375
|
+
type RouterData = {
|
|
1268
1376
|
location: Partial<Location>;
|
|
1269
1377
|
navigate: ReturnType<typeof useNavigate>;
|
|
1270
1378
|
} & Other;
|
|
1271
|
-
|
|
1379
|
+
type RenderData = Pick<RouterData, 'location'> & Other;
|
|
1272
1380
|
declare const useNavigate: () => (to: string | number, { plain, ...options }?: any) => void;
|
|
1273
1381
|
|
|
1274
1382
|
interface ThemeVars {
|
|
@@ -1302,17 +1410,17 @@ interface ThemeVars {
|
|
|
1302
1410
|
gridCellSize?: number;
|
|
1303
1411
|
}
|
|
1304
1412
|
|
|
1305
|
-
|
|
1413
|
+
type Addon_Types = Addon_TypesEnum | string;
|
|
1306
1414
|
interface Addon_ArgType<TArg = unknown> extends InputType {
|
|
1307
1415
|
defaultValue?: TArg;
|
|
1308
1416
|
}
|
|
1309
|
-
|
|
1417
|
+
type Addons_ArgTypes<TArgs = Args> = {
|
|
1310
1418
|
[key in keyof Partial<TArgs>]: Addon_ArgType<TArgs[key]>;
|
|
1311
1419
|
} & {
|
|
1312
1420
|
[key in string]: Addon_ArgType<unknown>;
|
|
1313
1421
|
};
|
|
1314
|
-
|
|
1315
|
-
|
|
1422
|
+
type Addon_Comparator<T> = ((a: T, b: T) => boolean) | ((a: T, b: T) => number);
|
|
1423
|
+
type Addon_StorySortMethod = 'configure' | 'alphabetical';
|
|
1316
1424
|
interface Addon_StorySortObjectParameter {
|
|
1317
1425
|
method?: Addon_StorySortMethod;
|
|
1318
1426
|
order?: any[];
|
|
@@ -1326,28 +1434,28 @@ interface Addon_BaseIndexEntry {
|
|
|
1326
1434
|
tags?: Tag[];
|
|
1327
1435
|
importPath: Path;
|
|
1328
1436
|
}
|
|
1329
|
-
|
|
1437
|
+
type Addon_StoryIndexEntry = Addon_BaseIndexEntry & {
|
|
1330
1438
|
type: 'story';
|
|
1331
1439
|
};
|
|
1332
|
-
|
|
1440
|
+
type Addon_DocsIndexEntry = Addon_BaseIndexEntry & {
|
|
1333
1441
|
storiesImports: Path[];
|
|
1334
1442
|
type: 'docs';
|
|
1335
1443
|
standalone: boolean;
|
|
1336
1444
|
};
|
|
1337
1445
|
/** A StandaloneDocsIndexExtry represents a file who's default export is directly renderable */
|
|
1338
|
-
|
|
1446
|
+
type Addon_StandaloneDocsIndexEntry = Addon_DocsIndexEntry & {
|
|
1339
1447
|
standalone: true;
|
|
1340
1448
|
};
|
|
1341
1449
|
/** A TemplateDocsIndexEntry represents a stories file that gets rendered in "docs" mode */
|
|
1342
|
-
|
|
1450
|
+
type Addon_TemplateDocsIndexEntry = Addon_DocsIndexEntry & {
|
|
1343
1451
|
standalone: false;
|
|
1344
1452
|
};
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
|
|
1350
|
-
|
|
1453
|
+
type Addon_IndexEntry = Addon_StoryIndexEntry | Addon_DocsIndexEntry;
|
|
1454
|
+
type Addon_IndexEntryLegacy = [StoryId, any, Parameters, Parameters];
|
|
1455
|
+
type Addon_StorySortComparator = Addon_Comparator<Addon_IndexEntryLegacy>;
|
|
1456
|
+
type Addon_StorySortParameter = Addon_StorySortComparator | Addon_StorySortObjectParameter;
|
|
1457
|
+
type Addon_StorySortComparatorV7 = Addon_Comparator<Addon_IndexEntry>;
|
|
1458
|
+
type Addon_StorySortParameterV7 = Addon_StorySortComparatorV7 | Addon_StorySortObjectParameter;
|
|
1351
1459
|
interface Addon_OptionsParameter extends Object {
|
|
1352
1460
|
storySort?: Addon_StorySortParameter;
|
|
1353
1461
|
theme?: {
|
|
@@ -1356,27 +1464,27 @@ interface Addon_OptionsParameter extends Object {
|
|
|
1356
1464
|
};
|
|
1357
1465
|
[key: string]: any;
|
|
1358
1466
|
}
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1467
|
+
type Addon_StoryContext<TRenderer extends Renderer = Renderer> = StoryContext<TRenderer>;
|
|
1468
|
+
type Addon_StoryContextUpdate = Partial<Addon_StoryContext>;
|
|
1469
|
+
type Addon_ReturnTypeFramework<ReturnType> = {
|
|
1362
1470
|
component: any;
|
|
1363
1471
|
storyResult: ReturnType;
|
|
1364
1472
|
canvasElement: any;
|
|
1365
1473
|
};
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1474
|
+
type Addon_PartialStoryFn<ReturnType = unknown> = PartialStoryFn<Addon_ReturnTypeFramework<ReturnType>>;
|
|
1475
|
+
type Addon_LegacyStoryFn<ReturnType = unknown> = LegacyStoryFn<Addon_ReturnTypeFramework<ReturnType>>;
|
|
1476
|
+
type Addon_ArgsStoryFn<ReturnType = unknown> = ArgsStoryFn<Addon_ReturnTypeFramework<ReturnType>>;
|
|
1477
|
+
type Addon_StoryFn<ReturnType = unknown> = StoryFn<Addon_ReturnTypeFramework<ReturnType>>;
|
|
1478
|
+
type Addon_DecoratorFunction<StoryFnReturnType = unknown> = DecoratorFunction<Addon_ReturnTypeFramework<StoryFnReturnType>>;
|
|
1479
|
+
type Addon_LoaderFunction = LoaderFunction<Addon_ReturnTypeFramework<unknown>>;
|
|
1372
1480
|
interface Addon_WrapperSettings {
|
|
1373
1481
|
options: object;
|
|
1374
1482
|
parameters: {
|
|
1375
1483
|
[key: string]: any;
|
|
1376
1484
|
};
|
|
1377
1485
|
}
|
|
1378
|
-
|
|
1379
|
-
|
|
1486
|
+
type Addon_StoryWrapper = (storyFn: Addon_LegacyStoryFn, context: Addon_StoryContext, settings: Addon_WrapperSettings) => any;
|
|
1487
|
+
type Addon_MakeDecoratorResult = (...args: any) => any;
|
|
1380
1488
|
interface Addon_AddStoryArgs<StoryFnReturnType = unknown> {
|
|
1381
1489
|
id: StoryId;
|
|
1382
1490
|
kind: StoryKind;
|
|
@@ -1390,7 +1498,7 @@ interface Addon_ClientApiAddon<StoryFnReturnType = unknown> extends Addon_Type {
|
|
|
1390
1498
|
interface Addon_ClientApiAddons<StoryFnReturnType> {
|
|
1391
1499
|
[key: string]: Addon_ClientApiAddon<StoryFnReturnType>;
|
|
1392
1500
|
}
|
|
1393
|
-
|
|
1501
|
+
type Addon_ClientApiReturnFn<StoryFnReturnType = unknown> = (...args: any[]) => Addon_StoryApi<StoryFnReturnType>;
|
|
1394
1502
|
interface Addon_StoryApi<StoryFnReturnType = unknown> {
|
|
1395
1503
|
kind: StoryKind;
|
|
1396
1504
|
add: (storyName: StoryName, storyFn: Addon_StoryFn<StoryFnReturnType>, parameters?: Parameters) => Addon_StoryApi<StoryFnReturnType>;
|
|
@@ -1402,10 +1510,10 @@ interface Addon_StoryApi<StoryFnReturnType = unknown> {
|
|
|
1402
1510
|
interface Addon_ClientStoryApi<StoryFnReturnType = unknown> {
|
|
1403
1511
|
storiesOf(kind: StoryKind, module: any): Addon_StoryApi<StoryFnReturnType>;
|
|
1404
1512
|
}
|
|
1405
|
-
|
|
1406
|
-
|
|
1407
|
-
|
|
1408
|
-
|
|
1513
|
+
type Addon_LoadFn = () => any;
|
|
1514
|
+
type Addon_RequireContext = any;
|
|
1515
|
+
type Addon_Loadable = Addon_RequireContext | [Addon_RequireContext] | Addon_LoadFn;
|
|
1516
|
+
type Addon_BaseDecorators<StoryFnReturnType> = Array<(story: () => StoryFnReturnType, context: Addon_StoryContext) => StoryFnReturnType>;
|
|
1409
1517
|
interface Addon_BaseAnnotations<TArgs, StoryFnReturnType> {
|
|
1410
1518
|
/**
|
|
1411
1519
|
* Dynamic data that are provided (and possibly updated by) Storybook and its addons.
|
|
@@ -1506,16 +1614,16 @@ interface Addon_BaseMeta<ComponentType> {
|
|
|
1506
1614
|
*/
|
|
1507
1615
|
subcomponents?: Record<string, ComponentType>;
|
|
1508
1616
|
}
|
|
1509
|
-
|
|
1617
|
+
type Addon_BaseStoryObject<TArgs, StoryFnReturnType> = {
|
|
1510
1618
|
/**
|
|
1511
1619
|
* Override the display name in the UI
|
|
1512
1620
|
*/
|
|
1513
1621
|
storyName?: string;
|
|
1514
1622
|
};
|
|
1515
|
-
|
|
1623
|
+
type Addon_BaseStoryFn<TArgs, StoryFnReturnType> = {
|
|
1516
1624
|
(args: TArgs, context: Addon_StoryContext): StoryFnReturnType;
|
|
1517
1625
|
} & Addon_BaseStoryObject<TArgs, StoryFnReturnType>;
|
|
1518
|
-
|
|
1626
|
+
type BaseStory<TArgs, StoryFnReturnType> = Addon_BaseStoryFn<TArgs, StoryFnReturnType> | Addon_BaseStoryObject<TArgs, StoryFnReturnType>;
|
|
1519
1627
|
interface Addon_RenderOptions {
|
|
1520
1628
|
active?: boolean;
|
|
1521
1629
|
key?: string;
|
|
@@ -1531,7 +1639,7 @@ interface Addon_Type {
|
|
|
1531
1639
|
disabled?: boolean;
|
|
1532
1640
|
hidden?: boolean;
|
|
1533
1641
|
}
|
|
1534
|
-
|
|
1642
|
+
type Addon_Loader<API> = (api: API) => void;
|
|
1535
1643
|
interface Addon_Loaders<API> {
|
|
1536
1644
|
[key: string]: Addon_Loader<API>;
|
|
1537
1645
|
}
|
|
@@ -1574,17 +1682,18 @@ interface CSF_Story {
|
|
|
1574
1682
|
parameters: Parameters;
|
|
1575
1683
|
tags?: Tag[];
|
|
1576
1684
|
}
|
|
1577
|
-
|
|
1578
|
-
|
|
1579
|
-
interface
|
|
1580
|
-
fileName?: string;
|
|
1685
|
+
type ViewMode = ViewMode$1 | 'story' | 'info' | 'settings' | string | undefined;
|
|
1686
|
+
type Layout = 'centered' | 'fullscreen' | 'padded' | 'none';
|
|
1687
|
+
interface StorybookParameters {
|
|
1581
1688
|
options?: Addon_OptionsParameter;
|
|
1582
1689
|
/** The layout property defines basic styles added to the preview body where the story is rendered. If you pass 'none', no styles are applied. */
|
|
1583
1690
|
layout?: Layout;
|
|
1584
|
-
docsOnly?: boolean;
|
|
1585
|
-
[key: string]: any;
|
|
1586
1691
|
}
|
|
1587
|
-
|
|
1692
|
+
interface StorybookInternalParameters extends StorybookParameters {
|
|
1693
|
+
fileName?: string;
|
|
1694
|
+
docsOnly?: true;
|
|
1695
|
+
}
|
|
1696
|
+
type Path = string;
|
|
1588
1697
|
|
|
1589
1698
|
type ValueOrPromiseOfValue<T> = T | PromiseLike<T>
|
|
1590
1699
|
type RejectedOutcome = {
|
|
@@ -1734,54 +1843,54 @@ interface UnresolvedSynchronousPromise<T> extends SynchronousPromise<T> {
|
|
|
1734
1843
|
|
|
1735
1844
|
declare var SynchronousPromise: SynchronousPromiseConstructor;
|
|
1736
1845
|
|
|
1737
|
-
interface
|
|
1846
|
+
interface WebRenderer extends Renderer {
|
|
1738
1847
|
canvasElement: HTMLElement;
|
|
1739
1848
|
}
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
|
|
1743
|
-
|
|
1744
|
-
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
|
|
1748
|
-
renderToCanvas?: RenderToCanvas<
|
|
1749
|
-
renderToDOM?: RenderToCanvas<
|
|
1750
|
-
};
|
|
1751
|
-
|
|
1849
|
+
type Store_ModuleExport = any;
|
|
1850
|
+
type Store_ModuleExports = Record<string, Store_ModuleExport>;
|
|
1851
|
+
type Store_PromiseLike<T> = Promise<T> | SynchronousPromise<T>;
|
|
1852
|
+
type Store_ModuleImportFn = (path: Path) => Store_PromiseLike<Store_ModuleExports>;
|
|
1853
|
+
type Store_MaybePromise<T> = Promise<T> | T;
|
|
1854
|
+
type TeardownRenderToCanvas = () => Store_MaybePromise<void>;
|
|
1855
|
+
type RenderToCanvas<TRenderer extends Renderer> = (context: Store_RenderContext<TRenderer>, element: TRenderer['canvasElement']) => Store_MaybePromise<void | TeardownRenderToCanvas>;
|
|
1856
|
+
type ProjectAnnotations<TRenderer extends Renderer> = ProjectAnnotations$1<TRenderer> & {
|
|
1857
|
+
renderToCanvas?: RenderToCanvas<TRenderer>;
|
|
1858
|
+
renderToDOM?: RenderToCanvas<TRenderer>;
|
|
1859
|
+
};
|
|
1860
|
+
type Store_NormalizedProjectAnnotations<TRenderer extends Renderer = Renderer> = ProjectAnnotations<TRenderer> & {
|
|
1752
1861
|
argTypes?: StrictArgTypes;
|
|
1753
1862
|
globalTypes?: StrictGlobalTypes;
|
|
1754
1863
|
};
|
|
1755
|
-
|
|
1864
|
+
type Store_NormalizedComponentAnnotations<TRenderer extends Renderer = Renderer> = ComponentAnnotations<TRenderer> & {
|
|
1756
1865
|
id: ComponentId;
|
|
1757
1866
|
title: ComponentTitle;
|
|
1758
1867
|
argTypes?: StrictArgTypes;
|
|
1759
1868
|
};
|
|
1760
|
-
|
|
1869
|
+
type Store_NormalizedStoryAnnotations<TRenderer extends Renderer = Renderer> = Omit<StoryAnnotations<TRenderer>, 'storyName' | 'story'> & {
|
|
1761
1870
|
moduleExport: Store_ModuleExport;
|
|
1762
1871
|
id: StoryId;
|
|
1763
1872
|
argTypes?: StrictArgTypes;
|
|
1764
1873
|
name: StoryName;
|
|
1765
|
-
userStoryFn?: StoryFn<
|
|
1874
|
+
userStoryFn?: StoryFn<TRenderer>;
|
|
1766
1875
|
};
|
|
1767
|
-
|
|
1768
|
-
meta: Store_NormalizedComponentAnnotations<
|
|
1769
|
-
stories: Record<StoryId, Store_NormalizedStoryAnnotations<
|
|
1876
|
+
type Store_CSFFile<TRenderer extends Renderer = Renderer> = {
|
|
1877
|
+
meta: Store_NormalizedComponentAnnotations<TRenderer>;
|
|
1878
|
+
stories: Record<StoryId, Store_NormalizedStoryAnnotations<TRenderer>>;
|
|
1770
1879
|
};
|
|
1771
|
-
|
|
1880
|
+
type Store_Story<TRenderer extends Renderer = Renderer> = StoryContextForEnhancers<TRenderer> & {
|
|
1772
1881
|
moduleExport: Store_ModuleExport;
|
|
1773
|
-
originalStoryFn: StoryFn<
|
|
1774
|
-
undecoratedStoryFn: LegacyStoryFn<
|
|
1775
|
-
unboundStoryFn: LegacyStoryFn<
|
|
1776
|
-
applyLoaders: (context: StoryContextForLoaders<
|
|
1777
|
-
loaded: StoryContext<
|
|
1882
|
+
originalStoryFn: StoryFn<TRenderer>;
|
|
1883
|
+
undecoratedStoryFn: LegacyStoryFn<TRenderer>;
|
|
1884
|
+
unboundStoryFn: LegacyStoryFn<TRenderer>;
|
|
1885
|
+
applyLoaders: (context: StoryContextForLoaders<TRenderer>) => Promise<StoryContextForLoaders<TRenderer> & {
|
|
1886
|
+
loaded: StoryContext<TRenderer>['loaded'];
|
|
1778
1887
|
}>;
|
|
1779
|
-
playFunction?: (context: StoryContext<
|
|
1888
|
+
playFunction?: (context: StoryContext<TRenderer>) => Promise<void> | void;
|
|
1780
1889
|
};
|
|
1781
|
-
|
|
1782
|
-
storyFn: PartialStoryFn<
|
|
1890
|
+
type Store_BoundStory<TRenderer extends Renderer = Renderer> = Store_Story<TRenderer> & {
|
|
1891
|
+
storyFn: PartialStoryFn<TRenderer>;
|
|
1783
1892
|
};
|
|
1784
|
-
declare type Store_RenderContext<
|
|
1893
|
+
declare type Store_RenderContext<TRenderer extends Renderer = Renderer> = StoryIdentifier & {
|
|
1785
1894
|
showMain: () => void;
|
|
1786
1895
|
showError: (error: {
|
|
1787
1896
|
title: string;
|
|
@@ -1789,9 +1898,9 @@ declare type Store_RenderContext<TFramework extends Framework = Framework> = Sto
|
|
|
1789
1898
|
}) => void;
|
|
1790
1899
|
showException: (err: Error) => void;
|
|
1791
1900
|
forceRemount: boolean;
|
|
1792
|
-
storyContext: StoryContext<
|
|
1793
|
-
storyFn: PartialStoryFn<
|
|
1794
|
-
unboundStoryFn: LegacyStoryFn<
|
|
1901
|
+
storyContext: StoryContext<TRenderer>;
|
|
1902
|
+
storyFn: PartialStoryFn<TRenderer>;
|
|
1903
|
+
unboundStoryFn: LegacyStoryFn<TRenderer>;
|
|
1795
1904
|
};
|
|
1796
1905
|
interface Store_V2CompatIndexEntry extends Omit<Addon_StoryIndexEntry, 'type'> {
|
|
1797
1906
|
kind: Addon_StoryIndexEntry['title'];
|
|
@@ -1806,7 +1915,7 @@ interface Store_StoryIndex {
|
|
|
1806
1915
|
v: number;
|
|
1807
1916
|
entries: Record<StoryId, Addon_IndexEntry>;
|
|
1808
1917
|
}
|
|
1809
|
-
|
|
1918
|
+
type Store_StorySpecifier = StoryId | {
|
|
1810
1919
|
name: StoryName;
|
|
1811
1920
|
title: ComponentTitle;
|
|
1812
1921
|
} | '*';
|
|
@@ -1820,7 +1929,7 @@ interface Store_Selection {
|
|
|
1820
1929
|
storyId: StoryId;
|
|
1821
1930
|
viewMode: ViewMode;
|
|
1822
1931
|
}
|
|
1823
|
-
|
|
1932
|
+
type Store_DecoratorApplicator<TRenderer extends Renderer = Renderer> = (storyFn: LegacyStoryFn<TRenderer>, decorators: DecoratorFunction<TRenderer>[]) => LegacyStoryFn<TRenderer>;
|
|
1824
1933
|
interface Store_StoriesSpecifier {
|
|
1825
1934
|
directory: string;
|
|
1826
1935
|
titlePrefix?: string;
|
|
@@ -1829,7 +1938,7 @@ interface Store_NormalizedStoriesSpecifier {
|
|
|
1829
1938
|
glob?: string;
|
|
1830
1939
|
specifier?: Store_StoriesSpecifier;
|
|
1831
1940
|
}
|
|
1832
|
-
|
|
1941
|
+
type Store_ExtractOptions = {
|
|
1833
1942
|
includeDocsOnly?: boolean;
|
|
1834
1943
|
};
|
|
1835
1944
|
interface Store_NormalizedStoriesSpecifierEntry {
|
|
@@ -1838,37 +1947,37 @@ interface Store_NormalizedStoriesSpecifierEntry {
|
|
|
1838
1947
|
files?: string;
|
|
1839
1948
|
importPathMatcher: RegExp;
|
|
1840
1949
|
}
|
|
1841
|
-
|
|
1842
|
-
value?: StoryContext<
|
|
1950
|
+
type Store_ContextStore<TRenderer extends Renderer> = {
|
|
1951
|
+
value?: StoryContext<TRenderer>;
|
|
1843
1952
|
};
|
|
1844
|
-
|
|
1845
|
-
|
|
1846
|
-
default: ComponentAnnotations<
|
|
1953
|
+
type Store_PropDescriptor = string[] | RegExp;
|
|
1954
|
+
type Store_CSFExports<TRenderer extends Renderer = Renderer> = {
|
|
1955
|
+
default: ComponentAnnotations<TRenderer, Args>;
|
|
1847
1956
|
__esModule?: boolean;
|
|
1848
1957
|
__namedExportsOrder?: string[];
|
|
1849
1958
|
};
|
|
1850
|
-
|
|
1851
|
-
|
|
1852
|
-
|
|
1959
|
+
type Store_ComposedStoryPlayContext = Partial<StoryContext> & Pick<StoryContext, 'canvasElement'>;
|
|
1960
|
+
type Store_ComposedStoryPlayFn = (context: Store_ComposedStoryPlayContext) => Promise<void> | void;
|
|
1961
|
+
type Store_StoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = AnnotatedStoryFn<TRenderer, TArgs> & {
|
|
1853
1962
|
play: Store_ComposedStoryPlayFn;
|
|
1854
1963
|
};
|
|
1855
|
-
|
|
1964
|
+
type Store_ComposedStory<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryFn<TRenderer, TArgs> | StoryAnnotations<TRenderer, TArgs>;
|
|
1856
1965
|
/**
|
|
1857
1966
|
* T represents the whole ES module of a stories file. K of T means named exports (basically the Story type)
|
|
1858
1967
|
* 1. pick the keys K of T that have properties that are Story<AnyProps>
|
|
1859
1968
|
* 2. infer the actual prop type for each Story
|
|
1860
1969
|
* 3. reconstruct Story with Partial. Story<Props> -> Story<Partial<Props>>
|
|
1861
1970
|
*/
|
|
1862
|
-
|
|
1863
|
-
[K in keyof TModule]: TModule[K] extends Store_ComposedStory<infer _, infer TProps> ? AnnotatedStoryFn<
|
|
1971
|
+
type Store_StoriesWithPartialProps<TRenderer extends Renderer, TModule> = {
|
|
1972
|
+
[K in keyof TModule]: TModule[K] extends Store_ComposedStory<infer _, infer TProps> ? AnnotatedStoryFn<TRenderer, Partial<TProps>> : unknown;
|
|
1864
1973
|
};
|
|
1865
|
-
|
|
1974
|
+
type Store_ControlsMatchers = {
|
|
1866
1975
|
date: RegExp;
|
|
1867
1976
|
color: RegExp;
|
|
1868
1977
|
};
|
|
1869
|
-
interface Store_ComposeStory<
|
|
1870
|
-
(storyAnnotations: AnnotatedStoryFn<
|
|
1871
|
-
(extraArgs: Partial<TArgs>):
|
|
1978
|
+
interface Store_ComposeStory<TRenderer extends Renderer = Renderer, TArgs extends Args = Args> {
|
|
1979
|
+
(storyAnnotations: AnnotatedStoryFn<TRenderer, TArgs> | StoryAnnotations<TRenderer, TArgs>, componentAnnotations: ComponentAnnotations<TRenderer, TArgs>, projectAnnotations: ProjectAnnotations<TRenderer>, exportsName?: string): {
|
|
1980
|
+
(extraArgs: Partial<TArgs>): TRenderer['storyResult'];
|
|
1872
1981
|
storyName: string;
|
|
1873
1982
|
args: Args;
|
|
1874
1983
|
play: Store_ComposedStoryPlayFn;
|
|
@@ -1885,9 +1994,9 @@ interface ClientAPI_StoryMetadata {
|
|
|
1885
1994
|
decorators?: DecoratorFunction[];
|
|
1886
1995
|
loaders?: LoaderFunction[];
|
|
1887
1996
|
}
|
|
1888
|
-
|
|
1889
|
-
|
|
1890
|
-
|
|
1997
|
+
type ClientAPI_ArgTypesEnhancer = (context: StoryContext) => ArgTypes;
|
|
1998
|
+
type ClientAPI_ArgsEnhancer = (context: StoryContext) => Args;
|
|
1999
|
+
type StorySpecifier = StoryId | {
|
|
1891
2000
|
name: StoryName;
|
|
1892
2001
|
kind: StoryKind;
|
|
1893
2002
|
} | '*';
|
|
@@ -1902,28 +2011,28 @@ interface ClientAPI_StoreSelection {
|
|
|
1902
2011
|
storyId: StoryId;
|
|
1903
2012
|
viewMode: ViewMode;
|
|
1904
2013
|
}
|
|
1905
|
-
|
|
2014
|
+
type ClientAPI_AddStoryArgs = StoryIdentifier & {
|
|
1906
2015
|
storyFn: StoryFn<any>;
|
|
1907
2016
|
parameters?: Parameters;
|
|
1908
2017
|
decorators?: DecoratorFunction[];
|
|
1909
2018
|
loaders?: LoaderFunction[];
|
|
1910
2019
|
};
|
|
1911
|
-
|
|
2020
|
+
type ClientAPI_ClientApiReturnFn<StoryFnReturnType> = (...args: any[]) => Addon_StoryApi<StoryFnReturnType>;
|
|
1912
2021
|
interface ClientAPI_ClientApiAddon<StoryFnReturnType = unknown> extends Addon_Type {
|
|
1913
2022
|
apply: (a: Addon_StoryApi<StoryFnReturnType>, b: any[]) => any;
|
|
1914
2023
|
}
|
|
1915
2024
|
interface ClientAPI_ClientApiAddons<StoryFnReturnType> {
|
|
1916
2025
|
[key: string]: ClientAPI_ClientApiAddon<StoryFnReturnType>;
|
|
1917
2026
|
}
|
|
1918
|
-
|
|
1919
|
-
interface ClientAPI_GetStorybookStory<
|
|
2027
|
+
type ClientAPI_RenderContextWithoutStoryContext = Omit<Store_RenderContext, 'storyContext'>;
|
|
2028
|
+
interface ClientAPI_GetStorybookStory<TRenderer extends Renderer> {
|
|
1920
2029
|
name: string;
|
|
1921
|
-
render: LegacyStoryFn<
|
|
2030
|
+
render: LegacyStoryFn<TRenderer>;
|
|
1922
2031
|
}
|
|
1923
|
-
interface ClientAPI_GetStorybookKind<
|
|
2032
|
+
interface ClientAPI_GetStorybookKind<TRenderer extends Renderer> {
|
|
1924
2033
|
kind: string;
|
|
1925
2034
|
fileName: string;
|
|
1926
|
-
stories: ClientAPI_GetStorybookStory<
|
|
2035
|
+
stories: ClientAPI_GetStorybookStory<TRenderer>[];
|
|
1927
2036
|
}
|
|
1928
2037
|
|
|
1929
2038
|
interface CoreClient_PreviewError {
|
|
@@ -1935,10 +2044,10 @@ interface CoreClient_RequireContext {
|
|
|
1935
2044
|
(id: string): any;
|
|
1936
2045
|
resolve(id: string): string;
|
|
1937
2046
|
}
|
|
1938
|
-
|
|
1939
|
-
|
|
2047
|
+
type CoreClient_LoaderFunction = () => void | any[];
|
|
2048
|
+
type Loadable = CoreClient_RequireContext | CoreClient_RequireContext[] | CoreClient_LoaderFunction;
|
|
1940
2049
|
|
|
1941
|
-
|
|
2050
|
+
type CoreClient_RenderStoryFunction = (context: Store_RenderContext) => void;
|
|
1942
2051
|
|
|
1943
2052
|
interface Options$1 {
|
|
1944
2053
|
allowRegExp: boolean;
|
|
@@ -1955,8 +2064,8 @@ interface Options$1 {
|
|
|
1955
2064
|
/**
|
|
1956
2065
|
* ⚠️ This file contains internal WIP types they MUST NOT be exported outside this package for now!
|
|
1957
2066
|
*/
|
|
1958
|
-
|
|
1959
|
-
|
|
2067
|
+
type BuilderName = 'webpack5' | '@storybook/builder-webpack5' | string;
|
|
2068
|
+
type RendererName = string;
|
|
1960
2069
|
interface CoreConfig {
|
|
1961
2070
|
builder?: BuilderName | {
|
|
1962
2071
|
name: BuilderName;
|
|
@@ -2008,7 +2117,7 @@ interface LoadedPreset {
|
|
|
2008
2117
|
preset: any;
|
|
2009
2118
|
options: any;
|
|
2010
2119
|
}
|
|
2011
|
-
|
|
2120
|
+
type PresetConfig = string | {
|
|
2012
2121
|
name: string;
|
|
2013
2122
|
options?: unknown;
|
|
2014
2123
|
};
|
|
@@ -2039,7 +2148,7 @@ interface BuilderResult {
|
|
|
2039
2148
|
totalTime?: ReturnType<typeof process.hrtime>;
|
|
2040
2149
|
stats?: Stats;
|
|
2041
2150
|
}
|
|
2042
|
-
|
|
2151
|
+
type PackageJson = PackageJson$1 & Record<string, any>;
|
|
2043
2152
|
interface LoadOptions {
|
|
2044
2153
|
packageJson: PackageJson;
|
|
2045
2154
|
outputDir?: string;
|
|
@@ -2096,7 +2205,7 @@ interface StorybookConfigOptions {
|
|
|
2096
2205
|
presets: Presets;
|
|
2097
2206
|
presetsList?: LoadedPreset[];
|
|
2098
2207
|
}
|
|
2099
|
-
|
|
2208
|
+
type Options = LoadOptions & StorybookConfigOptions & CLIOptions & BuilderOptions;
|
|
2100
2209
|
interface Builder<Config, BuilderStats extends Stats = Stats> {
|
|
2101
2210
|
getConfig: (options: Options) => Promise<Config>;
|
|
2102
2211
|
start: (args: {
|
|
@@ -2170,11 +2279,11 @@ interface CoreCommon_StoriesSpecifier {
|
|
|
2170
2279
|
*/
|
|
2171
2280
|
files?: string;
|
|
2172
2281
|
}
|
|
2173
|
-
|
|
2174
|
-
|
|
2282
|
+
type CoreCommon_StoriesEntry = string | CoreCommon_StoriesSpecifier;
|
|
2283
|
+
type CoreCommon_NormalizedStoriesSpecifier = Required<CoreCommon_StoriesSpecifier> & {
|
|
2175
2284
|
importPathMatcher: RegExp;
|
|
2176
2285
|
};
|
|
2177
|
-
|
|
2286
|
+
type Preset = string | {
|
|
2178
2287
|
name: string;
|
|
2179
2288
|
options?: any;
|
|
2180
2289
|
};
|
|
@@ -2182,14 +2291,14 @@ declare type Preset = string | {
|
|
|
2182
2291
|
* An additional script that gets injected into the
|
|
2183
2292
|
* preview or the manager,
|
|
2184
2293
|
*/
|
|
2185
|
-
|
|
2186
|
-
|
|
2294
|
+
type Entry = string;
|
|
2295
|
+
type CoreCommon_StorybookRefs = Record<string, {
|
|
2187
2296
|
title: string;
|
|
2188
2297
|
url: string;
|
|
2189
2298
|
} | {
|
|
2190
2299
|
disable: boolean;
|
|
2191
2300
|
}>;
|
|
2192
|
-
|
|
2301
|
+
type DocsOptions = {
|
|
2193
2302
|
/**
|
|
2194
2303
|
* Should we generate docs entries at all under any circumstances? (i.e. can they be rendered)
|
|
2195
2304
|
*/
|
|
@@ -2319,13 +2428,13 @@ interface StorybookConfig {
|
|
|
2319
2428
|
previewHead?: (head: string, options: Options) => string;
|
|
2320
2429
|
previewBody?: (body: string, options: Options) => string;
|
|
2321
2430
|
}
|
|
2322
|
-
|
|
2323
|
-
|
|
2431
|
+
type PresetProperty<K, TStorybookConfig = StorybookConfig> = TStorybookConfig[K extends keyof TStorybookConfig ? K : never] | PresetPropertyFn<K, TStorybookConfig>;
|
|
2432
|
+
type PresetPropertyFn<K, TStorybookConfig = StorybookConfig, TOptions = {}> = (config: TStorybookConfig[K extends keyof TStorybookConfig ? K : never], options: Options & TOptions) => TStorybookConfig[K extends keyof TStorybookConfig ? K : never] | Promise<TStorybookConfig[K extends keyof TStorybookConfig ? K : never]>;
|
|
2324
2433
|
interface CoreCommon_ResolvedAddonPreset {
|
|
2325
2434
|
type: 'presets';
|
|
2326
2435
|
name: string;
|
|
2327
2436
|
}
|
|
2328
|
-
|
|
2437
|
+
type PreviewAnnotation = string | {
|
|
2329
2438
|
bare: string;
|
|
2330
2439
|
absolute: string;
|
|
2331
2440
|
};
|
|
@@ -2339,11 +2448,11 @@ interface CoreCommon_ResolvedAddonVirtual {
|
|
|
2339
2448
|
options?: any;
|
|
2340
2449
|
})[];
|
|
2341
2450
|
}
|
|
2342
|
-
|
|
2451
|
+
type CoreCommon_OptionsEntry = {
|
|
2343
2452
|
name: string;
|
|
2344
2453
|
};
|
|
2345
|
-
|
|
2346
|
-
|
|
2454
|
+
type CoreCommon_AddonEntry = string | CoreCommon_OptionsEntry;
|
|
2455
|
+
type CoreCommon_AddonInfo = {
|
|
2347
2456
|
name: string;
|
|
2348
2457
|
inEssentials: boolean;
|
|
2349
2458
|
};
|
|
@@ -2362,13 +2471,13 @@ interface CoreCommon_StorybookInfo {
|
|
|
2362
2471
|
interface BuilderStats {
|
|
2363
2472
|
toJson: () => any;
|
|
2364
2473
|
}
|
|
2365
|
-
|
|
2474
|
+
type Builder_WithRequiredProperty<Type, Key extends keyof Type> = Type & {
|
|
2366
2475
|
[Property in Key]-?: Type[Property];
|
|
2367
2476
|
};
|
|
2368
|
-
|
|
2369
|
-
|
|
2477
|
+
type Builder_Unpromise<T extends Promise<any>> = T extends Promise<infer U> ? U : never;
|
|
2478
|
+
type Builder_EnvsRaw = Record<string, string>;
|
|
2370
2479
|
|
|
2371
|
-
|
|
2480
|
+
type ChannelHandler = (event: ChannelEvent) => void;
|
|
2372
2481
|
interface ChannelTransport {
|
|
2373
2482
|
send(event: ChannelEvent, options?: any): void;
|
|
2374
2483
|
setHandler(handler: ChannelHandler): void;
|
|
@@ -2490,14 +2599,14 @@ interface API_StoryEntry extends API_BaseEntry {
|
|
|
2490
2599
|
/** @deprecated */
|
|
2491
2600
|
isLeaf: true;
|
|
2492
2601
|
}
|
|
2493
|
-
|
|
2494
|
-
|
|
2602
|
+
type API_LeafEntry = API_DocsEntry | API_StoryEntry;
|
|
2603
|
+
type API_HashEntry = API_RootEntry | API_GroupEntry | API_ComponentEntry | API_DocsEntry | API_StoryEntry;
|
|
2495
2604
|
/** @deprecated */
|
|
2496
|
-
|
|
2605
|
+
type API_Root = API_RootEntry;
|
|
2497
2606
|
/** @deprecated */
|
|
2498
|
-
|
|
2607
|
+
type API_Group = API_GroupEntry | API_ComponentEntry;
|
|
2499
2608
|
/** @deprecated */
|
|
2500
|
-
|
|
2609
|
+
type API_Story = API_LeafEntry;
|
|
2501
2610
|
/**
|
|
2502
2611
|
* The `StoriesHash` is our manager-side representation of the `StoryIndex`.
|
|
2503
2612
|
* We create entries in the hash not only for each story or docs entry, but
|
|
@@ -2533,7 +2642,7 @@ interface API_StoryKey {
|
|
|
2533
2642
|
id: StoryId;
|
|
2534
2643
|
refId?: string;
|
|
2535
2644
|
}
|
|
2536
|
-
|
|
2645
|
+
type API_SetStoriesPayload = {
|
|
2537
2646
|
v: 2;
|
|
2538
2647
|
error?: Error;
|
|
2539
2648
|
globals: Args;
|
|
@@ -2552,7 +2661,7 @@ interface API_BaseIndexEntry {
|
|
|
2552
2661
|
title: ComponentTitle;
|
|
2553
2662
|
importPath: Path;
|
|
2554
2663
|
}
|
|
2555
|
-
|
|
2664
|
+
type API_StoryIndexEntry = API_BaseIndexEntry & {
|
|
2556
2665
|
type?: 'story';
|
|
2557
2666
|
};
|
|
2558
2667
|
interface API_V3IndexEntry extends API_BaseIndexEntry {
|
|
@@ -2562,16 +2671,16 @@ interface API_StoryIndexV3 {
|
|
|
2562
2671
|
v: 3;
|
|
2563
2672
|
stories: Record<StoryId, API_V3IndexEntry>;
|
|
2564
2673
|
}
|
|
2565
|
-
|
|
2674
|
+
type API_DocsIndexEntry = API_BaseIndexEntry & {
|
|
2566
2675
|
storiesImports: Path[];
|
|
2567
2676
|
type: 'docs';
|
|
2568
2677
|
};
|
|
2569
|
-
|
|
2678
|
+
type API_IndexEntry = API_StoryIndexEntry | API_DocsIndexEntry;
|
|
2570
2679
|
interface StoryIndex {
|
|
2571
2680
|
v: number;
|
|
2572
2681
|
entries: Record<StoryId, API_IndexEntry>;
|
|
2573
2682
|
}
|
|
2574
|
-
|
|
2683
|
+
type API_PreparedIndexEntry = API_IndexEntry & {
|
|
2575
2684
|
parameters?: Parameters;
|
|
2576
2685
|
argTypes?: ArgTypes;
|
|
2577
2686
|
args?: Args;
|
|
@@ -2585,7 +2694,7 @@ interface API_StoryIndex {
|
|
|
2585
2694
|
v: number;
|
|
2586
2695
|
entries: Record<StoryId, API_IndexEntry>;
|
|
2587
2696
|
}
|
|
2588
|
-
|
|
2697
|
+
type API_OptionsData = {
|
|
2589
2698
|
docsOptions: DocsOptions;
|
|
2590
2699
|
};
|
|
2591
2700
|
interface API_Args {
|
|
@@ -2631,7 +2740,7 @@ interface API_Versions$1 {
|
|
|
2631
2740
|
current?: API_Version;
|
|
2632
2741
|
}
|
|
2633
2742
|
|
|
2634
|
-
|
|
2743
|
+
type API_ViewMode = 'story' | 'info' | 'settings' | 'page' | undefined | string;
|
|
2635
2744
|
interface API_RenderOptions {
|
|
2636
2745
|
active: boolean;
|
|
2637
2746
|
key: string;
|
|
@@ -2662,8 +2771,8 @@ interface API_Addon {
|
|
|
2662
2771
|
interface API_Collection<T = API_Addon> {
|
|
2663
2772
|
[key: string]: T;
|
|
2664
2773
|
}
|
|
2665
|
-
|
|
2666
|
-
|
|
2774
|
+
type API_Panels = API_Collection<API_Addon>;
|
|
2775
|
+
type API_StateMerger<S> = (input: S) => S;
|
|
2667
2776
|
interface API_ProviderData<API> {
|
|
2668
2777
|
provider: API_Provider<API>;
|
|
2669
2778
|
docsOptions: DocsOptions;
|
|
@@ -2681,7 +2790,7 @@ interface API_Provider<API> {
|
|
|
2681
2790
|
} & Partial<API_UIOptions>;
|
|
2682
2791
|
[key: string]: any;
|
|
2683
2792
|
}
|
|
2684
|
-
|
|
2793
|
+
type API_IframeRenderer = (storyId: string, viewMode: ViewMode, id: string, baseUrl: string, scale: number, queryParams: Record<string, any>) => any;
|
|
2685
2794
|
interface API_UIOptions {
|
|
2686
2795
|
name?: string;
|
|
2687
2796
|
url?: string;
|
|
@@ -2710,8 +2819,8 @@ interface API_UI {
|
|
|
2710
2819
|
url?: string;
|
|
2711
2820
|
enableShortcuts: boolean;
|
|
2712
2821
|
}
|
|
2713
|
-
|
|
2714
|
-
|
|
2822
|
+
type API_PanelPositions = 'bottom' | 'right';
|
|
2823
|
+
type API_ActiveTabsType = 'sidebar' | 'canvas' | 'addons';
|
|
2715
2824
|
interface API_SidebarOptions {
|
|
2716
2825
|
showRoots?: boolean;
|
|
2717
2826
|
collapsedRoots?: string[];
|
|
@@ -2730,12 +2839,12 @@ interface API_Notification {
|
|
|
2730
2839
|
};
|
|
2731
2840
|
onClear?: () => void;
|
|
2732
2841
|
}
|
|
2733
|
-
|
|
2734
|
-
|
|
2842
|
+
type API_Versions = Record<string, string>;
|
|
2843
|
+
type API_SetRefData = Partial<API_ComposedRef & {
|
|
2735
2844
|
setStoriesData: API_SetStoriesStoryData;
|
|
2736
2845
|
storyIndex: API_StoryIndex;
|
|
2737
2846
|
}>;
|
|
2738
|
-
|
|
2847
|
+
type API_StoryMapper = (ref: API_ComposedRef, story: API_SetStoriesStory) => API_SetStoriesStory;
|
|
2739
2848
|
interface API_ComposedRef {
|
|
2740
2849
|
id: string;
|
|
2741
2850
|
title?: string;
|
|
@@ -2749,9 +2858,9 @@ interface API_ComposedRef {
|
|
|
2749
2858
|
ready?: boolean;
|
|
2750
2859
|
error?: any;
|
|
2751
2860
|
}
|
|
2752
|
-
|
|
2753
|
-
|
|
2754
|
-
|
|
2755
|
-
|
|
2861
|
+
type API_ComposedRefUpdate = Partial<Pick<API_ComposedRef, 'title' | 'type' | 'expanded' | 'stories' | 'versions' | 'loginUrl' | 'version' | 'ready' | 'error'>>;
|
|
2862
|
+
type API_Refs = Record<string, API_ComposedRef>;
|
|
2863
|
+
type API_RefId = string;
|
|
2864
|
+
type API_RefUrl = string;
|
|
2756
2865
|
|
|
2757
|
-
export { API_ActiveTabsType, API_Addon, API_ArgType, API_ArgTypes, API_Args, API_BaseEntry, API_Collection, API_ComponentEntry, API_ComposedRef, API_ComposedRefUpdate, API_DocsEntry, API_DocsIndexEntry, API_Group, API_GroupEntry, API_HashEntry, API_IframeRenderer, API_IndexEntry, API_Layout, API_LeafEntry, API_MatchOptions, API_Notification, API_OptionsData, API_PanelPositions, API_Panels, API_PreparedStoryIndex, API_Provider, API_ProviderData, API_RefId, API_RefUrl, API_Refs, API_ReleaseNotes, API_RenderOptions, API_Root, API_RootEntry, API_RouteOptions, API_SetGlobalsPayload, API_SetRefData, API_SetStoriesPayload, API_SetStoriesStory, API_SetStoriesStoryData, API_Settings, API_SidebarOptions, API_StateMerger, API_StoriesHash, API_Story, API_StoryEntry, API_StoryIndex, API_StoryIndexEntry, API_StoryIndexV3, API_StoryKey, API_StoryMapper, API_UI, API_UIOptions, API_UnknownEntries, API_Version, API_Versions$1 as API_Versions, API_ViewMode, Addon_AddStoryArgs, Addon_Annotations, Addon_ArgType, Addon_ArgsStoryFn, Addon_BaseAnnotations, Addon_BaseDecorators, Addon_BaseIndexEntry, Addon_BaseMeta, Addon_BaseStoryFn, Addon_BaseStoryObject, Addon_ClientApiAddon, Addon_ClientApiAddons, Addon_ClientApiReturnFn, Addon_ClientStoryApi, Addon_Collection, Addon_Comparator, Addon_Config, Addon_DecoratorFunction, Addon_DocsIndexEntry, Addon_Elements, Addon_IndexEntry, Addon_IndexEntryLegacy, Addon_LegacyStoryFn, Addon_LoadFn, Addon_Loadable, Addon_Loader, Addon_LoaderFunction, Addon_Loaders, Addon_MakeDecoratorResult, Addon_OptionsParameter, Addon_PartialStoryFn, Addon_RenderOptions, Addon_RequireContext, Addon_StandaloneDocsIndexEntry, Addon_StoryApi, Addon_StoryContext, Addon_StoryContextUpdate, Addon_StoryFn, Addon_StoryIndexEntry, Addon_StorySortComparator, Addon_StorySortComparatorV7, Addon_StorySortMethod, Addon_StorySortObjectParameter, Addon_StorySortParameter, Addon_StorySortParameterV7, Addon_StoryWrapper, Addon_TemplateDocsIndexEntry, Addon_ToolbarConfig, Addon_Type, Addon_Types, Addon_TypesEnum, Addon_WrapperSettings, Addons_ArgTypes, AnnotatedStoryFn, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, BaseStory, Builder, BuilderName, BuilderOptions, BuilderResult, BuilderStats, Builder_EnvsRaw, Builder_Unpromise, Builder_WithRequiredProperty, CLIOptions, CSF_Meta, CSF_Story, ClientAPI_AddStoryArgs, ClientAPI_ArgTypesEnhancer, ClientAPI_ArgsEnhancer, ClientAPI_ClientApiAddon, ClientAPI_ClientApiAddons, ClientAPI_ClientApiReturnFn, ClientAPI_ErrorLike, ClientAPI_GetStorybookKind, ClientAPI_GetStorybookStory, ClientAPI_RenderContextWithoutStoryContext, ClientAPI_StoreSelection, ClientAPI_StoreSelectionSpecifier, ClientAPI_StoryMetadata, ComponentAnnotations, ComponentId, ComponentTitle, Conditional, CoreClient_LoaderFunction, CoreClient_PreviewError, CoreClient_RenderStoryFunction, CoreClient_RequireContext, CoreCommon_AddonEntry, CoreCommon_AddonInfo, CoreCommon_IndexedStory, CoreCommon_IndexerOptions, CoreCommon_NormalizedStoriesSpecifier, CoreCommon_OptionsEntry, CoreCommon_ResolvedAddonPreset, CoreCommon_ResolvedAddonVirtual, CoreCommon_StoriesEntry, CoreCommon_StoryIndex, CoreCommon_StoryIndexer, CoreCommon_StorybookInfo, CoreConfig, DecoratorApplicator, DecoratorFunction, DocsOptions, Entry,
|
|
2866
|
+
export { API_ActiveTabsType, API_Addon, API_ArgType, API_ArgTypes, API_Args, API_BaseEntry, API_Collection, API_ComponentEntry, API_ComposedRef, API_ComposedRefUpdate, API_DocsEntry, API_DocsIndexEntry, API_Group, API_GroupEntry, API_HashEntry, API_IframeRenderer, API_IndexEntry, API_Layout, API_LeafEntry, API_MatchOptions, API_Notification, API_OptionsData, API_PanelPositions, API_Panels, API_PreparedStoryIndex, API_Provider, API_ProviderData, API_RefId, API_RefUrl, API_Refs, API_ReleaseNotes, API_RenderOptions, API_Root, API_RootEntry, API_RouteOptions, API_SetGlobalsPayload, API_SetRefData, API_SetStoriesPayload, API_SetStoriesStory, API_SetStoriesStoryData, API_Settings, API_SidebarOptions, API_StateMerger, API_StoriesHash, API_Story, API_StoryEntry, API_StoryIndex, API_StoryIndexEntry, API_StoryIndexV3, API_StoryKey, API_StoryMapper, API_UI, API_UIOptions, API_UnknownEntries, API_Version, API_Versions$1 as API_Versions, API_ViewMode, Addon_AddStoryArgs, Addon_Annotations, Addon_ArgType, Addon_ArgsStoryFn, Addon_BaseAnnotations, Addon_BaseDecorators, Addon_BaseIndexEntry, Addon_BaseMeta, Addon_BaseStoryFn, Addon_BaseStoryObject, Addon_ClientApiAddon, Addon_ClientApiAddons, Addon_ClientApiReturnFn, Addon_ClientStoryApi, Addon_Collection, Addon_Comparator, Addon_Config, Addon_DecoratorFunction, Addon_DocsIndexEntry, Addon_Elements, Addon_IndexEntry, Addon_IndexEntryLegacy, Addon_LegacyStoryFn, Addon_LoadFn, Addon_Loadable, Addon_Loader, Addon_LoaderFunction, Addon_Loaders, Addon_MakeDecoratorResult, Addon_OptionsParameter, Addon_PartialStoryFn, Addon_RenderOptions, Addon_RequireContext, Addon_StandaloneDocsIndexEntry, Addon_StoryApi, Addon_StoryContext, Addon_StoryContextUpdate, Addon_StoryFn, Addon_StoryIndexEntry, Addon_StorySortComparator, Addon_StorySortComparatorV7, Addon_StorySortMethod, Addon_StorySortObjectParameter, Addon_StorySortParameter, Addon_StorySortParameterV7, Addon_StoryWrapper, Addon_TemplateDocsIndexEntry, Addon_ToolbarConfig, Addon_Type, Addon_Types, Addon_TypesEnum, Addon_WrapperSettings, Addons_ArgTypes, AnnotatedStoryFn, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, BaseStory, Builder, BuilderName, BuilderOptions, BuilderResult, BuilderStats, Builder_EnvsRaw, Builder_Unpromise, Builder_WithRequiredProperty, CLIOptions, CSF_Meta, CSF_Story, ClientAPI_AddStoryArgs, ClientAPI_ArgTypesEnhancer, ClientAPI_ArgsEnhancer, ClientAPI_ClientApiAddon, ClientAPI_ClientApiAddons, ClientAPI_ClientApiReturnFn, ClientAPI_ErrorLike, ClientAPI_GetStorybookKind, ClientAPI_GetStorybookStory, ClientAPI_RenderContextWithoutStoryContext, ClientAPI_StoreSelection, ClientAPI_StoreSelectionSpecifier, ClientAPI_StoryMetadata, ComponentAnnotations, ComponentId, ComponentTitle, Conditional, CoreClient_LoaderFunction, CoreClient_PreviewError, CoreClient_RenderStoryFunction, CoreClient_RequireContext, CoreCommon_AddonEntry, CoreCommon_AddonInfo, CoreCommon_IndexedStory, CoreCommon_IndexerOptions, CoreCommon_NormalizedStoriesSpecifier, CoreCommon_OptionsEntry, CoreCommon_ResolvedAddonPreset, CoreCommon_ResolvedAddonVirtual, CoreCommon_StoriesEntry, CoreCommon_StoryIndex, CoreCommon_StoryIndexer, CoreCommon_StorybookInfo, CoreConfig, DecoratorApplicator, DecoratorFunction, DocsOptions, Entry, GlobalTypes, Globals, IncludeExcludeOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn, LegacyStoryFn, LoadOptions, Loadable, LoadedPreset, LoaderFunction, Options, PackageJson, Parameters, PartialStoryFn, Path, PlayFunction, PlayFunctionContext, Preset, PresetConfig, PresetProperty, PresetPropertyFn, Presets, PreviewAnnotation, ProjectAnnotations, Ref, ReleaseNotesData, Store_RenderContext as RenderContext, RenderToCanvas, Renderer, RendererName, SBArrayType, SBEnumType, SBIntersectionType, SBObjectType, SBOtherType, SBScalarType, SBType, SBUnionType, SeparatorOptions, Stats, StepFunction, StepLabel, StepRunner, Store_BoundStory, Store_CSFExports, Store_CSFFile, Store_ComposeStory, Store_ComposedStory, Store_ComposedStoryPlayContext, Store_ComposedStoryPlayFn, Store_ContextStore, Store_ControlsMatchers, Store_DecoratorApplicator, Store_ExtractOptions, Store_ModuleExport, Store_ModuleExports, Store_ModuleImportFn, Store_NormalizedComponentAnnotations, Store_NormalizedProjectAnnotations, Store_NormalizedStoriesSpecifier, Store_NormalizedStoriesSpecifierEntry, Store_NormalizedStoryAnnotations, Store_PromiseLike, Store_PropDescriptor, Store_RenderContext, Store_Selection, Store_SelectionSpecifier, Store_StoriesSpecifier, Store_StoriesWithPartialProps, Store_Story, Store_StoryFn, Store_StoryIndex, Store_StoryIndexV3, Store_StorySpecifier, Store_V2CompatIndexEntry, StoryAnnotations, StoryAnnotationsOrFn, StoryContext, StoryContextForEnhancers, StoryContextForLoaders, StoryContextUpdate, StoryFn, StoryId, StoryIdentifier, StoryIndex, StoryKind, StoryName, StorybookConfig, StorybookConfigOptions, StorybookInternalParameters, StorybookParameters, StrictArgTypes, StrictArgs, StrictGlobalTypes, StrictInputType, Tag, TeardownRenderToCanvas, TypescriptOptions, VersionCheck, ViewMode, WebRenderer };
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var d=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var A=Object.getOwnPropertyNames;var s=Object.prototype.hasOwnProperty;var i=(e
|
|
1
|
+
var d=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var A=Object.getOwnPropertyNames;var s=Object.prototype.hasOwnProperty;var i=(r,e)=>{for(var n in e)d(r,n,{get:e[n],enumerable:!0})},S=(r,e,n,y)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of A(e))!s.call(r,o)&&o!==n&&d(r,o,{get:()=>e[o],enumerable:!(y=p(e,o))||y.enumerable});return r};var _=r=>S(d({},"__esModule",{value:!0}),r);var F={};i(F,{Addon_TypesEnum:()=>a});module.exports=_(F);var a=(t=>(t.TAB="tab",t.PANEL="panel",t.TOOL="tool",t.TOOLEXTRA="toolextra",t.PREVIEW="preview",t.NOTES_ELEMENT="notes-element",t))(a||{});0&&(module.exports={Addon_TypesEnum});
|
package/dist/index.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
var
|
|
1
|
+
var r=(e=>(e.TAB="tab",e.PANEL="panel",e.TOOL="tool",e.TOOLEXTRA="toolextra",e.PREVIEW="preview",e.NOTES_ELEMENT="notes-element",e))(r||{});export{r as Addon_TypesEnum};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storybook/types",
|
|
3
|
-
"version": "7.0.0-alpha.
|
|
3
|
+
"version": "7.0.0-alpha.51",
|
|
4
4
|
"description": "Core Storybook Types",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"storybook"
|
|
@@ -40,17 +40,17 @@
|
|
|
40
40
|
"prep": "../../../scripts/prepare/bundle.ts"
|
|
41
41
|
},
|
|
42
42
|
"dependencies": {
|
|
43
|
-
"@babel/core": "^7.
|
|
44
|
-
"@types/babel__core": "^7.
|
|
43
|
+
"@babel/core": "^7.20.2",
|
|
44
|
+
"@types/babel__core": "^7.1.20",
|
|
45
45
|
"@types/express": "^4.7.0",
|
|
46
46
|
"express": "^4.17.1",
|
|
47
47
|
"file-system-cache": "^2.0.0"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
|
-
"@storybook/csf": "
|
|
51
|
-
"@types/node": "^16.0.0",
|
|
50
|
+
"@storybook/csf": "next",
|
|
51
|
+
"@types/node": "^16.0.0 || ^18.0.0",
|
|
52
52
|
"synchronous-promise": "^2.0.15",
|
|
53
|
-
"typescript": "
|
|
53
|
+
"typescript": "^4.9.3"
|
|
54
54
|
},
|
|
55
55
|
"publishConfig": {
|
|
56
56
|
"access": "public"
|
|
@@ -60,5 +60,5 @@
|
|
|
60
60
|
"./src/index.ts"
|
|
61
61
|
]
|
|
62
62
|
},
|
|
63
|
-
"gitHead": "
|
|
63
|
+
"gitHead": "4fec76c3f5135854d9834ebc1cf2f1f325696ded"
|
|
64
64
|
}
|