storybook 10.0.0-beta.0 → 10.0.0-beta.10
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/assets/server/openBrowser.applescript +94 -0
- package/dist/_browser-chunks/Color-KPLIACXP.js +1569 -0
- package/dist/_browser-chunks/{WithTooltip-2E62HIBN.js → WithTooltip-SK46ZJ2J.js} +1 -1
- package/dist/_browser-chunks/{chunk-YY5GICNT.js → chunk-6E2SHJSL.js} +175 -32
- package/dist/_browser-chunks/{chunk-FWKO3E35.js → chunk-BOOOPFZF.js} +10 -3
- package/dist/_browser-chunks/{chunk-YWDKX534.js → chunk-FA42P6MO.js} +49 -4
- package/dist/_browser-chunks/chunk-G33S6YM3.js +521 -0
- package/dist/_browser-chunks/{chunk-MZNYTCNT.js → chunk-HMIIJ6UD.js} +6 -6
- package/dist/_browser-chunks/{chunk-4QPX7WIQ.js → chunk-JJZMHC3A.js} +57 -166
- package/dist/_browser-chunks/{chunk-MD2FTHCZ.js → chunk-JVSKG4YS.js} +3 -16
- package/dist/_browser-chunks/{chunk-E7VLET3C.js → chunk-KSCAWCCE.js} +3947 -4291
- package/dist/_browser-chunks/{chunk-PYK5ZTFK.js → chunk-PS3AOQI4.js} +48 -25
- package/dist/_browser-chunks/chunk-QK3L5AXO.js +372 -0
- package/dist/_browser-chunks/chunk-SHR3NNR3.js +5810 -0
- package/dist/_browser-chunks/{chunk-O5R5CGFA.js → chunk-TMDZCWME.js} +1 -2
- package/dist/_browser-chunks/chunk-VUAFL5XK.js +20 -0
- package/dist/_browser-chunks/{chunk-T7RCAJIX.js → chunk-Y3M7TW6K.js} +43 -47
- package/dist/_browser-chunks/{syntaxhighlighter-YYAA4CS4.js → syntaxhighlighter-R46XOLMC.js} +1 -1
- package/dist/_node-chunks/{builder-manager-OW6YGKXV.js → builder-manager-SJGIDEN6.js} +45 -155
- package/dist/_node-chunks/camelcase-VZHWABQV.js +18 -0
- package/dist/_node-chunks/{chunk-6JSVPEAU.js → chunk-6CZW7AGN.js} +7 -7
- package/dist/_node-chunks/{chunk-CD3IP6HA.js → chunk-6XT5OLNL.js} +12 -12
- package/dist/_node-chunks/{chunk-2H7LZ2SD.js → chunk-AHRH5RPR.js} +7 -7
- package/dist/_node-chunks/{chunk-5HLANIBM.js → chunk-AOH6ABSV.js} +7 -7
- package/dist/_node-chunks/chunk-C5V22GP7.js +79 -0
- package/dist/_node-chunks/{chunk-IBXERYDG.js → chunk-FIROF4DV.js} +7 -7
- package/dist/_node-chunks/{chunk-I3YCPGZJ.js → chunk-GUJVZUYI.js} +7 -7
- package/dist/_node-chunks/chunk-IHPLRRAR.js +4741 -0
- package/dist/_node-chunks/{chunk-7TISOZS6.js → chunk-JMXKCRWR.js} +30 -21
- package/dist/_node-chunks/{chunk-YWGNEBRO.js → chunk-JUMUXWEV.js} +162 -103
- package/dist/_node-chunks/{chunk-UIREEOC7.js → chunk-KGX33KXX.js} +7 -7
- package/dist/_node-chunks/{chunk-3QB3ZG6H.js → chunk-KLVABNEU.js} +7 -7
- package/dist/_node-chunks/{chunk-H5LTFJHQ.js → chunk-OL6DY6BT.js} +631 -752
- package/dist/_node-chunks/{chunk-X5GAZ3EW.js → chunk-ONJV3K2L.js} +399 -116
- package/dist/_node-chunks/{chunk-LKB7KRSV.js → chunk-PTHTD4RO.js} +223 -243
- package/dist/_node-chunks/{chunk-UHHZPSP7.js → chunk-QQ3Z5KGJ.js} +6 -6
- package/dist/_node-chunks/{chunk-MUD3GH3L.js → chunk-QRTDDTZJ.js} +9 -9
- package/dist/_node-chunks/chunk-R54K4KSM.js +1540 -0
- package/dist/_node-chunks/{chunk-IQAUGVYR.js → chunk-S2LZC6JK.js} +8 -8
- package/dist/_node-chunks/chunk-SFJFSPRT.js +62 -0
- package/dist/_node-chunks/{chunk-LH3BEEIR.js → chunk-SSN5PKIY.js} +6 -6
- package/dist/_node-chunks/{chunk-NOQITS3C.js → chunk-SXR2DITB.js} +7 -7
- package/dist/_node-chunks/{chunk-FWUE7SRE.js → chunk-TH5QVQRL.js} +7 -7
- package/dist/_node-chunks/chunk-U34NWAU2.js +18 -0
- package/dist/_node-chunks/{chunk-FBMMEEO4.js → chunk-UV3CZ3KS.js} +7 -7
- package/dist/_node-chunks/{chunk-NZGJJABJ.js → chunk-UVUGJDAI.js} +60 -102
- package/dist/_node-chunks/{chunk-GZUNYRFU.js → chunk-VOUNSD2E.js} +7 -7
- package/dist/_node-chunks/chunk-WFCPBKQJ.js +64656 -0
- package/dist/_node-chunks/{chunk-BFXER3XW.js → chunk-XHF3WWNP.js} +623 -750
- package/dist/_node-chunks/{chunk-ANEKBWDX.js → chunk-XU45KXNQ.js} +16 -25
- package/dist/_node-chunks/{camelcase-2K3EMR6G.js → chunk-YHO6XR7U.js} +9 -8
- package/dist/_node-chunks/{dist-465RSKRC.js → dist-IIC5PBL7.js} +9 -9
- package/dist/_node-chunks/{globby-LJ3MVB6M.js → globby-CJACC3HJ.js} +17 -13
- package/dist/_node-chunks/{lib-OW3DENXB.js → lib-ZY4TKSOR.js} +40 -16
- package/dist/_node-chunks/{mdx-N42X6CFJ-PYX2IFUO.js → mdx-N42X6CFJ-3XNW3DFO.js} +8 -8
- package/dist/_node-chunks/{p-limit-X4OG45RB.js → p-limit-R2OFT5HE.js} +76 -10
- package/dist/_node-chunks/{plugin-ALTIQMDE.js → plugin-5XD5R2KD.js} +10 -10
- package/dist/_node-chunks/{plugin-GE36R32R.js → plugin-WAWVQMVR.js} +10 -12
- package/dist/_node-chunks/{webpack-inject-mocker-runtime-plugin-NLCAF7S6.js → webpack-inject-mocker-runtime-plugin-SCRGJLIS.js} +1307 -847
- package/dist/_node-chunks/{webpack-mock-plugin-BRYODMCC.js → webpack-mock-plugin-3VAXEGG2.js} +9 -11
- package/dist/babel/index.d.ts +1 -1
- package/dist/babel/index.js +11 -12
- package/dist/bin/core.js +638 -187
- package/dist/bin/dispatcher.js +11 -11
- package/dist/bin/loader.js +8 -8
- package/dist/cli/index.d.ts +62 -75
- package/dist/cli/index.js +66 -56
- package/dist/common/index.d.ts +3 -1
- package/dist/common/index.js +22 -22
- package/dist/components/index.d.ts +234 -2
- package/dist/components/index.js +74 -5741
- package/dist/core-events/index.d.ts +18 -2
- package/dist/core-events/index.js +7 -1
- package/dist/core-server/index.d.ts +540 -39
- package/dist/core-server/index.js +4647 -4182
- package/dist/core-server/presets/common-manager.js +1570 -1272
- package/dist/core-server/presets/common-override-preset.js +9 -9
- package/dist/core-server/presets/common-preset.js +691 -38
- package/dist/core-server/presets/webpack/loaders/storybook-mock-transform-loader.js +9 -11
- package/dist/core-server/presets/webpack/loaders/webpack-automock-loader.js +10 -12
- package/dist/csf/index.d.ts +9 -4
- package/dist/csf/index.js +50 -15
- package/dist/csf-tools/index.d.ts +47 -6
- package/dist/csf-tools/index.js +9 -9
- package/dist/docs-tools/index.js +4 -4
- package/dist/instrumenter/index.js +1 -1
- package/dist/manager/globals-runtime.js +9233 -18113
- package/dist/manager/globals.d.ts +0 -4
- package/dist/manager/globals.js +1 -6
- package/dist/manager/runtime.js +13396 -11518
- package/dist/manager-api/index.d.ts +540 -32
- package/dist/manager-api/index.js +364 -90
- package/dist/manager-errors.d.ts +527 -0
- package/dist/node-logger/index.d.ts +1 -1
- package/dist/node-logger/index.js +1136 -662
- package/dist/preview/globals.js +1 -1
- package/dist/preview/runtime.js +12103 -21579
- package/dist/preview-api/index.d.ts +3 -3
- package/dist/preview-api/index.js +10 -10
- package/dist/preview-errors.d.ts +527 -0
- package/dist/router/index.d.ts +668 -10
- package/dist/router/index.js +2 -2
- package/dist/server-errors.d.ts +527 -0
- package/dist/server-errors.js +10 -10
- package/dist/telemetry/index.d.ts +1 -1
- package/dist/telemetry/index.js +23 -25
- package/dist/test/index.js +1874 -4024
- package/dist/theming/index.d.ts +2 -2
- package/dist/theming/index.js +6 -6
- package/dist/types/index.d.ts +553 -16
- package/dist/viewport/index.d.ts +36 -4
- package/dist/viewport/index.js +1 -1
- package/package.json +9 -46
- package/dist/_browser-chunks/Color-SFYJJKWL.js +0 -605
- package/dist/_browser-chunks/chunk-DHO2SA6L.js +0 -12
- package/dist/_browser-chunks/chunk-WPHPDNUA.js +0 -974
- package/dist/_node-chunks/chunk-27W2Z6VL.js +0 -28502
- package/dist/_node-chunks/chunk-G46DWX7Z.js +0 -266
- package/dist/_node-chunks/chunk-GZZDIJIB.js +0 -80
- package/dist/_node-chunks/chunk-JDKH3XYB.js +0 -9845
- package/dist/_node-chunks/chunk-R7RKO2DC.js +0 -35783
- package/dist/_node-chunks/chunk-T23YQHYB.js +0 -62
- package/dist/_node-chunks/chunk-VKKLKNFC.js +0 -2377
- package/dist/_node-chunks/chunk-W6GKFQ7F.js +0 -87
- package/dist/_node-chunks/chunk-YUYBO6S7.js +0 -18
- package/dist/_node-chunks/default-browser-id-Z6WQ7DZA.js +0 -1719
package/dist/types/index.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
|
-
import { StoryId as StoryId$1, StoryName, ComponentTitle, Tag as Tag$1, Parameters, Args, ArgTypes, ComponentId, StoryKind, Globals as Globals$1, GlobalTypes as GlobalTypes$1, InputType, Renderer, StoryContext, PartialStoryFn, LegacyStoryFn, ArgsStoryFn, StoryFn, DecoratorFunction, LoaderFunction, ViewMode as ViewMode$1, StoryIdentifier, ProjectAnnotations as ProjectAnnotations$1, StrictArgTypes, StrictGlobalTypes, StepRunner, BeforeAll, ComponentAnnotations, StoryAnnotations, StoryContextForEnhancers, CleanupCallback, Canvas, StoryAnnotationsOrFn, AnnotatedStoryFn } from 'storybook/internal/csf';
|
|
2
|
-
export { AfterEach, AnnotatedStoryFn, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, ProjectAnnotations as BaseProjectAnnotations, BeforeAll, BeforeEach, Canvas, CleanupCallback, ComponentAnnotations, ComponentId, ComponentTitle, Conditional, DecoratorApplicator, DecoratorFunction, GlobalTypes, Globals, IncludeExcludeOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn, LegacyStoryFn, LoaderFunction, Parameters, PartialStoryFn, PlayFunction, PlayFunctionContext, 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, Tag } from 'storybook/internal/csf';
|
|
1
|
+
import { StoryId as StoryId$1, StoryName, ComponentTitle, Tag as Tag$1, Parameters, Args, ArgTypes, ComponentId, StoryKind, Globals as Globals$1, GlobalTypes as GlobalTypes$1, InputType, Renderer, StoryContext, PartialStoryFn, LegacyStoryFn, ArgsStoryFn, StoryFn, DecoratorFunction, LoaderFunction as LoaderFunction$1, ViewMode as ViewMode$1, StoryIdentifier, ProjectAnnotations as ProjectAnnotations$1, StrictArgTypes, StrictGlobalTypes, StepRunner, BeforeAll, ComponentAnnotations, StoryAnnotations, StoryContextForEnhancers, CleanupCallback, Canvas, StoryAnnotationsOrFn, AnnotatedStoryFn } from 'storybook/internal/csf';
|
|
2
|
+
export { AfterEach, AnnotatedStoryFn, ArgTypes, ArgTypesEnhancer, Args, ArgsEnhancer, ArgsFromMeta, ArgsStoryFn, BaseAnnotations, ProjectAnnotations as BaseProjectAnnotations, BeforeAll, BeforeEach, Canvas, CleanupCallback, ComponentAnnotations, ComponentId, ComponentTitle, Conditional, DecoratorApplicator, DecoratorFunction, GlobalTypes, Globals, IncludeExcludeOptions, InputType, LegacyAnnotatedStoryFn, LegacyStoryAnnotationsOrFn, LegacyStoryFn, LoaderFunction, Parameters, PartialStoryFn, PlayFunction, PlayFunctionContext, 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, Tag, TestFunction } from 'storybook/internal/csf';
|
|
3
3
|
import { ReactElement, FC, ReactNode, PropsWithChildren } from 'react';
|
|
4
|
-
import * as R from 'react-router-dom';
|
|
5
4
|
import { RouterData as RouterData$1 } from 'storybook/internal/router';
|
|
6
5
|
import { Globals, GlobalTypes, API_Layout as API_Layout$1, API_LayoutCustomisations as API_LayoutCustomisations$1, API_UI as API_UI$1, API_Notification as API_Notification$1, API_Refs as API_Refs$1, API_Settings as API_Settings$1, API_LoadedRefData as API_LoadedRefData$1, StoryId, API_PreparedStoryIndex as API_PreparedStoryIndex$1, API_ViewMode as API_ViewMode$1, API_FilterFunction as API_FilterFunction$1, API_Versions as API_Versions$2, API_UnknownEntries as API_UnknownEntries$1, API_OptionsData as API_OptionsData$1, NormalizedProjectAnnotations as NormalizedProjectAnnotations$1, ProjectAnnotations as ProjectAnnotations$2, ComposedStoryFn as ComposedStoryFn$1 } from 'storybook/internal/types';
|
|
7
6
|
import { ThemeVars as ThemeVars$1 } from 'storybook/theming';
|
|
@@ -11,6 +10,521 @@ import { Server, IncomingMessage, ServerResponse } from 'http';
|
|
|
11
10
|
import { Server as Server$1 } from 'net';
|
|
12
11
|
import { Channel as Channel$1 } from 'storybook/internal/channels';
|
|
13
12
|
|
|
13
|
+
/**
|
|
14
|
+
* Actions represent the type of change to a location value.
|
|
15
|
+
*/
|
|
16
|
+
declare enum Action {
|
|
17
|
+
/**
|
|
18
|
+
* A POP indicates a change to an arbitrary index in the history stack, such
|
|
19
|
+
* as a back or forward navigation. It does not describe the direction of the
|
|
20
|
+
* navigation, only that the current index changed.
|
|
21
|
+
*
|
|
22
|
+
* Note: This is the default action for newly created history objects.
|
|
23
|
+
*/
|
|
24
|
+
Pop = "POP",
|
|
25
|
+
/**
|
|
26
|
+
* A PUSH indicates a new entry being added to the history stack, such as when
|
|
27
|
+
* a link is clicked and a new page loads. When this happens, all subsequent
|
|
28
|
+
* entries in the stack are lost.
|
|
29
|
+
*/
|
|
30
|
+
Push = "PUSH",
|
|
31
|
+
/**
|
|
32
|
+
* A REPLACE indicates the entry at the current index in the history stack
|
|
33
|
+
* being replaced by a new one.
|
|
34
|
+
*/
|
|
35
|
+
Replace = "REPLACE"
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* The pathname, search, and hash values of a URL.
|
|
39
|
+
*/
|
|
40
|
+
interface Path$1 {
|
|
41
|
+
/**
|
|
42
|
+
* A URL pathname, beginning with a /.
|
|
43
|
+
*/
|
|
44
|
+
pathname: string;
|
|
45
|
+
/**
|
|
46
|
+
* A URL search string, beginning with a ?.
|
|
47
|
+
*/
|
|
48
|
+
search: string;
|
|
49
|
+
/**
|
|
50
|
+
* A URL fragment identifier, beginning with a #.
|
|
51
|
+
*/
|
|
52
|
+
hash: string;
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* An entry in a history stack. A location contains information about the
|
|
56
|
+
* URL path, as well as possibly some arbitrary state and a key.
|
|
57
|
+
*/
|
|
58
|
+
interface Location extends Path$1 {
|
|
59
|
+
/**
|
|
60
|
+
* A value of arbitrary data associated with this location.
|
|
61
|
+
*/
|
|
62
|
+
state: any;
|
|
63
|
+
/**
|
|
64
|
+
* A unique string associated with this location. May be used to safely store
|
|
65
|
+
* and retrieve data in some other storage API, like `localStorage`.
|
|
66
|
+
*
|
|
67
|
+
* Note: This value is always "default" on the initial location.
|
|
68
|
+
*/
|
|
69
|
+
key: string;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Describes a location that is the destination of some navigation, either via
|
|
73
|
+
* `history.push` or `history.replace`. May be either a URL or the pieces of a
|
|
74
|
+
* URL path.
|
|
75
|
+
*/
|
|
76
|
+
type To = string | Partial<Path$1>;
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* Map of routeId -> data returned from a loader/action/error
|
|
80
|
+
*/
|
|
81
|
+
interface RouteData {
|
|
82
|
+
[routeId: string]: any;
|
|
83
|
+
}
|
|
84
|
+
declare enum ResultType {
|
|
85
|
+
data = "data",
|
|
86
|
+
deferred = "deferred",
|
|
87
|
+
redirect = "redirect",
|
|
88
|
+
error = "error"
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Successful result from a loader or action
|
|
92
|
+
*/
|
|
93
|
+
interface SuccessResult {
|
|
94
|
+
type: ResultType.data;
|
|
95
|
+
data: any;
|
|
96
|
+
statusCode?: number;
|
|
97
|
+
headers?: Headers;
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Successful defer() result from a loader or action
|
|
101
|
+
*/
|
|
102
|
+
interface DeferredResult {
|
|
103
|
+
type: ResultType.deferred;
|
|
104
|
+
deferredData: DeferredData;
|
|
105
|
+
statusCode?: number;
|
|
106
|
+
headers?: Headers;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* Redirect result from a loader or action
|
|
110
|
+
*/
|
|
111
|
+
interface RedirectResult {
|
|
112
|
+
type: ResultType.redirect;
|
|
113
|
+
status: number;
|
|
114
|
+
location: string;
|
|
115
|
+
revalidate: boolean;
|
|
116
|
+
reloadDocument?: boolean;
|
|
117
|
+
}
|
|
118
|
+
/**
|
|
119
|
+
* Unsuccessful result from a loader or action
|
|
120
|
+
*/
|
|
121
|
+
interface ErrorResult {
|
|
122
|
+
type: ResultType.error;
|
|
123
|
+
error: any;
|
|
124
|
+
headers?: Headers;
|
|
125
|
+
}
|
|
126
|
+
/**
|
|
127
|
+
* Result from a loader or action - potentially successful or unsuccessful
|
|
128
|
+
*/
|
|
129
|
+
type DataResult = SuccessResult | DeferredResult | RedirectResult | ErrorResult;
|
|
130
|
+
type LowerCaseFormMethod = "get" | "post" | "put" | "patch" | "delete";
|
|
131
|
+
type UpperCaseFormMethod = Uppercase<LowerCaseFormMethod>;
|
|
132
|
+
/**
|
|
133
|
+
* Active navigation/fetcher form methods are exposed in lowercase on the
|
|
134
|
+
* RouterState
|
|
135
|
+
*/
|
|
136
|
+
type FormMethod = LowerCaseFormMethod;
|
|
137
|
+
/**
|
|
138
|
+
* In v7, active navigation/fetcher form methods are exposed in uppercase on the
|
|
139
|
+
* RouterState. This is to align with the normalization done via fetch().
|
|
140
|
+
*/
|
|
141
|
+
type V7_FormMethod = UpperCaseFormMethod;
|
|
142
|
+
type FormEncType = "application/x-www-form-urlencoded" | "multipart/form-data" | "application/json" | "text/plain";
|
|
143
|
+
type JsonObject = {
|
|
144
|
+
[Key in string]: JsonValue;
|
|
145
|
+
} & {
|
|
146
|
+
[Key in string]?: JsonValue | undefined;
|
|
147
|
+
};
|
|
148
|
+
type JsonArray = JsonValue[] | readonly JsonValue[];
|
|
149
|
+
type JsonPrimitive = string | number | boolean | null;
|
|
150
|
+
type JsonValue = JsonPrimitive | JsonObject | JsonArray;
|
|
151
|
+
/**
|
|
152
|
+
* @private
|
|
153
|
+
* Internal interface to pass around for action submissions, not intended for
|
|
154
|
+
* external consumption
|
|
155
|
+
*/
|
|
156
|
+
type Submission = {
|
|
157
|
+
formMethod: FormMethod | V7_FormMethod;
|
|
158
|
+
formAction: string;
|
|
159
|
+
formEncType: FormEncType;
|
|
160
|
+
formData: FormData;
|
|
161
|
+
json: undefined;
|
|
162
|
+
text: undefined;
|
|
163
|
+
} | {
|
|
164
|
+
formMethod: FormMethod | V7_FormMethod;
|
|
165
|
+
formAction: string;
|
|
166
|
+
formEncType: FormEncType;
|
|
167
|
+
formData: undefined;
|
|
168
|
+
json: JsonValue;
|
|
169
|
+
text: undefined;
|
|
170
|
+
} | {
|
|
171
|
+
formMethod: FormMethod | V7_FormMethod;
|
|
172
|
+
formAction: string;
|
|
173
|
+
formEncType: FormEncType;
|
|
174
|
+
formData: undefined;
|
|
175
|
+
json: undefined;
|
|
176
|
+
text: string;
|
|
177
|
+
};
|
|
178
|
+
/**
|
|
179
|
+
* @private
|
|
180
|
+
* Arguments passed to route loader/action functions. Same for now but we keep
|
|
181
|
+
* this as a private implementation detail in case they diverge in the future.
|
|
182
|
+
*/
|
|
183
|
+
interface DataFunctionArgs {
|
|
184
|
+
request: Request;
|
|
185
|
+
params: Params;
|
|
186
|
+
context?: any;
|
|
187
|
+
}
|
|
188
|
+
/**
|
|
189
|
+
* Arguments passed to loader functions
|
|
190
|
+
*/
|
|
191
|
+
interface LoaderFunctionArgs extends DataFunctionArgs {
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* Arguments passed to action functions
|
|
195
|
+
*/
|
|
196
|
+
interface ActionFunctionArgs extends DataFunctionArgs {
|
|
197
|
+
}
|
|
198
|
+
/**
|
|
199
|
+
* Loaders and actions can return anything except `undefined` (`null` is a
|
|
200
|
+
* valid return value if there is no data to return). Responses are preferred
|
|
201
|
+
* and will ease any future migration to Remix
|
|
202
|
+
*/
|
|
203
|
+
type DataFunctionValue = Response | NonNullable<unknown> | null;
|
|
204
|
+
/**
|
|
205
|
+
* Route loader function signature
|
|
206
|
+
*/
|
|
207
|
+
interface LoaderFunction {
|
|
208
|
+
(args: LoaderFunctionArgs): Promise<DataFunctionValue> | DataFunctionValue;
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* Route action function signature
|
|
212
|
+
*/
|
|
213
|
+
interface ActionFunction {
|
|
214
|
+
(args: ActionFunctionArgs): Promise<DataFunctionValue> | DataFunctionValue;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* Route shouldRevalidate function signature. This runs after any submission
|
|
218
|
+
* (navigation or fetcher), so we flatten the navigation/fetcher submission
|
|
219
|
+
* onto the arguments. It shouldn't matter whether it came from a navigation
|
|
220
|
+
* or a fetcher, what really matters is the URLs and the formData since loaders
|
|
221
|
+
* have to re-run based on the data models that were potentially mutated.
|
|
222
|
+
*/
|
|
223
|
+
interface ShouldRevalidateFunction {
|
|
224
|
+
(args: {
|
|
225
|
+
currentUrl: URL;
|
|
226
|
+
currentParams: AgnosticDataRouteMatch["params"];
|
|
227
|
+
nextUrl: URL;
|
|
228
|
+
nextParams: AgnosticDataRouteMatch["params"];
|
|
229
|
+
formMethod?: Submission["formMethod"];
|
|
230
|
+
formAction?: Submission["formAction"];
|
|
231
|
+
formEncType?: Submission["formEncType"];
|
|
232
|
+
text?: Submission["text"];
|
|
233
|
+
formData?: Submission["formData"];
|
|
234
|
+
json?: Submission["json"];
|
|
235
|
+
actionResult?: DataResult;
|
|
236
|
+
defaultShouldRevalidate: boolean;
|
|
237
|
+
}): boolean;
|
|
238
|
+
}
|
|
239
|
+
/**
|
|
240
|
+
* Keys we cannot change from within a lazy() function. We spread all other keys
|
|
241
|
+
* onto the route. Either they're meaningful to the router, or they'll get
|
|
242
|
+
* ignored.
|
|
243
|
+
*/
|
|
244
|
+
type ImmutableRouteKey = "lazy" | "caseSensitive" | "path" | "id" | "index" | "children";
|
|
245
|
+
type RequireOne<T, Key = keyof T> = Exclude<{
|
|
246
|
+
[K in keyof T]: K extends Key ? Omit<T, K> & Required<Pick<T, K>> : never;
|
|
247
|
+
}[keyof T], undefined>;
|
|
248
|
+
/**
|
|
249
|
+
* lazy() function to load a route definition, which can add non-matching
|
|
250
|
+
* related properties to a route
|
|
251
|
+
*/
|
|
252
|
+
interface LazyRouteFunction<R extends AgnosticRouteObject> {
|
|
253
|
+
(): Promise<RequireOne<Omit<R, ImmutableRouteKey>>>;
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
* Base RouteObject with common props shared by all types of routes
|
|
257
|
+
*/
|
|
258
|
+
type AgnosticBaseRouteObject = {
|
|
259
|
+
caseSensitive?: boolean;
|
|
260
|
+
path?: string;
|
|
261
|
+
id?: string;
|
|
262
|
+
loader?: LoaderFunction;
|
|
263
|
+
action?: ActionFunction;
|
|
264
|
+
hasErrorBoundary?: boolean;
|
|
265
|
+
shouldRevalidate?: ShouldRevalidateFunction;
|
|
266
|
+
handle?: any;
|
|
267
|
+
lazy?: LazyRouteFunction<AgnosticBaseRouteObject>;
|
|
268
|
+
};
|
|
269
|
+
/**
|
|
270
|
+
* Index routes must not have children
|
|
271
|
+
*/
|
|
272
|
+
type AgnosticIndexRouteObject = AgnosticBaseRouteObject & {
|
|
273
|
+
children?: undefined;
|
|
274
|
+
index: true;
|
|
275
|
+
};
|
|
276
|
+
/**
|
|
277
|
+
* Non-index routes may have children, but cannot have index
|
|
278
|
+
*/
|
|
279
|
+
type AgnosticNonIndexRouteObject = AgnosticBaseRouteObject & {
|
|
280
|
+
children?: AgnosticRouteObject[];
|
|
281
|
+
index?: false;
|
|
282
|
+
};
|
|
283
|
+
/**
|
|
284
|
+
* A route object represents a logical route, with (optionally) its child
|
|
285
|
+
* routes organized in a tree-like structure.
|
|
286
|
+
*/
|
|
287
|
+
type AgnosticRouteObject = AgnosticIndexRouteObject | AgnosticNonIndexRouteObject;
|
|
288
|
+
type AgnosticDataIndexRouteObject = AgnosticIndexRouteObject & {
|
|
289
|
+
id: string;
|
|
290
|
+
};
|
|
291
|
+
type AgnosticDataNonIndexRouteObject = AgnosticNonIndexRouteObject & {
|
|
292
|
+
children?: AgnosticDataRouteObject[];
|
|
293
|
+
id: string;
|
|
294
|
+
};
|
|
295
|
+
/**
|
|
296
|
+
* A data route object, which is just a RouteObject with a required unique ID
|
|
297
|
+
*/
|
|
298
|
+
type AgnosticDataRouteObject = AgnosticDataIndexRouteObject | AgnosticDataNonIndexRouteObject;
|
|
299
|
+
/**
|
|
300
|
+
* The parameters that were parsed from the URL path.
|
|
301
|
+
*/
|
|
302
|
+
type Params<Key extends string = string> = {
|
|
303
|
+
readonly [key in Key]: string | undefined;
|
|
304
|
+
};
|
|
305
|
+
/**
|
|
306
|
+
* A RouteMatch contains info about how a route matched a URL.
|
|
307
|
+
*/
|
|
308
|
+
interface AgnosticRouteMatch<ParamKey extends string = string, RouteObjectType extends AgnosticRouteObject = AgnosticRouteObject> {
|
|
309
|
+
/**
|
|
310
|
+
* The names and values of dynamic parameters in the URL.
|
|
311
|
+
*/
|
|
312
|
+
params: Params<ParamKey>;
|
|
313
|
+
/**
|
|
314
|
+
* The portion of the URL pathname that was matched.
|
|
315
|
+
*/
|
|
316
|
+
pathname: string;
|
|
317
|
+
/**
|
|
318
|
+
* The portion of the URL pathname that was matched before child routes.
|
|
319
|
+
*/
|
|
320
|
+
pathnameBase: string;
|
|
321
|
+
/**
|
|
322
|
+
* The route object that was used to match.
|
|
323
|
+
*/
|
|
324
|
+
route: RouteObjectType;
|
|
325
|
+
}
|
|
326
|
+
interface AgnosticDataRouteMatch extends AgnosticRouteMatch<string, AgnosticDataRouteObject> {
|
|
327
|
+
}
|
|
328
|
+
declare class DeferredData {
|
|
329
|
+
private pendingKeysSet;
|
|
330
|
+
private controller;
|
|
331
|
+
private abortPromise;
|
|
332
|
+
private unlistenAbortSignal;
|
|
333
|
+
private subscribers;
|
|
334
|
+
data: Record<string, unknown>;
|
|
335
|
+
init?: ResponseInit;
|
|
336
|
+
deferredKeys: string[];
|
|
337
|
+
constructor(data: Record<string, unknown>, responseInit?: ResponseInit);
|
|
338
|
+
private trackPromise;
|
|
339
|
+
private onSettle;
|
|
340
|
+
private emit;
|
|
341
|
+
subscribe(fn: (aborted: boolean, settledKey?: string) => void): () => boolean;
|
|
342
|
+
cancel(): void;
|
|
343
|
+
resolveData(signal: AbortSignal): Promise<boolean>;
|
|
344
|
+
get done(): boolean;
|
|
345
|
+
get unwrappedData(): {};
|
|
346
|
+
get pendingKeys(): string[];
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
/**
|
|
350
|
+
* State maintained internally by the router. During a navigation, all states
|
|
351
|
+
* reflect the the "old" location unless otherwise noted.
|
|
352
|
+
*/
|
|
353
|
+
interface RouterState {
|
|
354
|
+
/**
|
|
355
|
+
* The action of the most recent navigation
|
|
356
|
+
*/
|
|
357
|
+
historyAction: Action;
|
|
358
|
+
/**
|
|
359
|
+
* The current location reflected by the router
|
|
360
|
+
*/
|
|
361
|
+
location: Location;
|
|
362
|
+
/**
|
|
363
|
+
* The current set of route matches
|
|
364
|
+
*/
|
|
365
|
+
matches: AgnosticDataRouteMatch[];
|
|
366
|
+
/**
|
|
367
|
+
* Tracks whether we've completed our initial data load
|
|
368
|
+
*/
|
|
369
|
+
initialized: boolean;
|
|
370
|
+
/**
|
|
371
|
+
* Current scroll position we should start at for a new view
|
|
372
|
+
* - number -> scroll position to restore to
|
|
373
|
+
* - false -> do not restore scroll at all (used during submissions)
|
|
374
|
+
* - null -> don't have a saved position, scroll to hash or top of page
|
|
375
|
+
*/
|
|
376
|
+
restoreScrollPosition: number | false | null;
|
|
377
|
+
/**
|
|
378
|
+
* Indicate whether this navigation should skip resetting the scroll position
|
|
379
|
+
* if we are unable to restore the scroll position
|
|
380
|
+
*/
|
|
381
|
+
preventScrollReset: boolean;
|
|
382
|
+
/**
|
|
383
|
+
* Tracks the state of the current navigation
|
|
384
|
+
*/
|
|
385
|
+
navigation: Navigation;
|
|
386
|
+
/**
|
|
387
|
+
* Tracks any in-progress revalidations
|
|
388
|
+
*/
|
|
389
|
+
revalidation: RevalidationState;
|
|
390
|
+
/**
|
|
391
|
+
* Data from the loaders for the current matches
|
|
392
|
+
*/
|
|
393
|
+
loaderData: RouteData;
|
|
394
|
+
/**
|
|
395
|
+
* Data from the action for the current matches
|
|
396
|
+
*/
|
|
397
|
+
actionData: RouteData | null;
|
|
398
|
+
/**
|
|
399
|
+
* Errors caught from loaders for the current matches
|
|
400
|
+
*/
|
|
401
|
+
errors: RouteData | null;
|
|
402
|
+
/**
|
|
403
|
+
* Map of current fetchers
|
|
404
|
+
*/
|
|
405
|
+
fetchers: Map<string, Fetcher>;
|
|
406
|
+
/**
|
|
407
|
+
* Map of current blockers
|
|
408
|
+
*/
|
|
409
|
+
blockers: Map<string, Blocker>;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* Data that can be passed into hydrate a Router from SSR
|
|
413
|
+
*/
|
|
414
|
+
type HydrationState = Partial<Pick<RouterState, "loaderData" | "actionData" | "errors">>;
|
|
415
|
+
type RelativeRoutingType = "route" | "path";
|
|
416
|
+
/**
|
|
417
|
+
* Potential states for state.navigation
|
|
418
|
+
*/
|
|
419
|
+
type NavigationStates = {
|
|
420
|
+
Idle: {
|
|
421
|
+
state: "idle";
|
|
422
|
+
location: undefined;
|
|
423
|
+
formMethod: undefined;
|
|
424
|
+
formAction: undefined;
|
|
425
|
+
formEncType: undefined;
|
|
426
|
+
formData: undefined;
|
|
427
|
+
json: undefined;
|
|
428
|
+
text: undefined;
|
|
429
|
+
};
|
|
430
|
+
Loading: {
|
|
431
|
+
state: "loading";
|
|
432
|
+
location: Location;
|
|
433
|
+
formMethod: Submission["formMethod"] | undefined;
|
|
434
|
+
formAction: Submission["formAction"] | undefined;
|
|
435
|
+
formEncType: Submission["formEncType"] | undefined;
|
|
436
|
+
formData: Submission["formData"] | undefined;
|
|
437
|
+
json: Submission["json"] | undefined;
|
|
438
|
+
text: Submission["text"] | undefined;
|
|
439
|
+
};
|
|
440
|
+
Submitting: {
|
|
441
|
+
state: "submitting";
|
|
442
|
+
location: Location;
|
|
443
|
+
formMethod: Submission["formMethod"];
|
|
444
|
+
formAction: Submission["formAction"];
|
|
445
|
+
formEncType: Submission["formEncType"];
|
|
446
|
+
formData: Submission["formData"];
|
|
447
|
+
json: Submission["json"];
|
|
448
|
+
text: Submission["text"];
|
|
449
|
+
};
|
|
450
|
+
};
|
|
451
|
+
type Navigation = NavigationStates[keyof NavigationStates];
|
|
452
|
+
type RevalidationState = "idle" | "loading";
|
|
453
|
+
/**
|
|
454
|
+
* Potential states for fetchers
|
|
455
|
+
*/
|
|
456
|
+
type FetcherStates<TData = any> = {
|
|
457
|
+
Idle: {
|
|
458
|
+
state: "idle";
|
|
459
|
+
formMethod: undefined;
|
|
460
|
+
formAction: undefined;
|
|
461
|
+
formEncType: undefined;
|
|
462
|
+
text: undefined;
|
|
463
|
+
formData: undefined;
|
|
464
|
+
json: undefined;
|
|
465
|
+
data: TData | undefined;
|
|
466
|
+
" _hasFetcherDoneAnything "?: boolean;
|
|
467
|
+
};
|
|
468
|
+
Loading: {
|
|
469
|
+
state: "loading";
|
|
470
|
+
formMethod: Submission["formMethod"] | undefined;
|
|
471
|
+
formAction: Submission["formAction"] | undefined;
|
|
472
|
+
formEncType: Submission["formEncType"] | undefined;
|
|
473
|
+
text: Submission["text"] | undefined;
|
|
474
|
+
formData: Submission["formData"] | undefined;
|
|
475
|
+
json: Submission["json"] | undefined;
|
|
476
|
+
data: TData | undefined;
|
|
477
|
+
" _hasFetcherDoneAnything "?: boolean;
|
|
478
|
+
};
|
|
479
|
+
Submitting: {
|
|
480
|
+
state: "submitting";
|
|
481
|
+
formMethod: Submission["formMethod"];
|
|
482
|
+
formAction: Submission["formAction"];
|
|
483
|
+
formEncType: Submission["formEncType"];
|
|
484
|
+
text: Submission["text"];
|
|
485
|
+
formData: Submission["formData"];
|
|
486
|
+
json: Submission["json"];
|
|
487
|
+
data: TData | undefined;
|
|
488
|
+
" _hasFetcherDoneAnything "?: boolean;
|
|
489
|
+
};
|
|
490
|
+
};
|
|
491
|
+
type Fetcher<TData = any> = FetcherStates<TData>[keyof FetcherStates<TData>];
|
|
492
|
+
interface BlockerBlocked {
|
|
493
|
+
state: "blocked";
|
|
494
|
+
reset(): void;
|
|
495
|
+
proceed(): void;
|
|
496
|
+
location: Location;
|
|
497
|
+
}
|
|
498
|
+
interface BlockerUnblocked {
|
|
499
|
+
state: "unblocked";
|
|
500
|
+
reset: undefined;
|
|
501
|
+
proceed: undefined;
|
|
502
|
+
location: undefined;
|
|
503
|
+
}
|
|
504
|
+
interface BlockerProceeding {
|
|
505
|
+
state: "proceeding";
|
|
506
|
+
reset: undefined;
|
|
507
|
+
proceed: undefined;
|
|
508
|
+
location: Location;
|
|
509
|
+
}
|
|
510
|
+
type Blocker = BlockerUnblocked | BlockerBlocked | BlockerProceeding;
|
|
511
|
+
|
|
512
|
+
interface NavigateOptions$1 {
|
|
513
|
+
replace?: boolean;
|
|
514
|
+
state?: any;
|
|
515
|
+
preventScrollReset?: boolean;
|
|
516
|
+
relative?: RelativeRoutingType;
|
|
517
|
+
}
|
|
518
|
+
|
|
519
|
+
/**
|
|
520
|
+
* NOTE: If you refactor this to split up the modules into separate files,
|
|
521
|
+
* you'll need to update the rollup config for react-router-dom-v5-compat.
|
|
522
|
+
*/
|
|
523
|
+
|
|
524
|
+
declare global {
|
|
525
|
+
var __staticRouterHydrationData: HydrationState | undefined;
|
|
526
|
+
}
|
|
527
|
+
|
|
14
528
|
interface StoryData {
|
|
15
529
|
viewMode?: string;
|
|
16
530
|
storyId?: string;
|
|
@@ -21,12 +535,12 @@ interface Other$1 extends StoryData {
|
|
|
21
535
|
path: string;
|
|
22
536
|
singleStory?: boolean;
|
|
23
537
|
}
|
|
24
|
-
type NavigateOptions =
|
|
538
|
+
type NavigateOptions = NavigateOptions$1 & {
|
|
25
539
|
plain?: boolean;
|
|
26
540
|
};
|
|
27
|
-
type NavigateFunction = (to:
|
|
541
|
+
type NavigateFunction = (to: To | number, options?: NavigateOptions) => void;
|
|
28
542
|
type RouterData = {
|
|
29
|
-
location: Partial<
|
|
543
|
+
location: Partial<Location>;
|
|
30
544
|
navigate: NavigateFunction;
|
|
31
545
|
} & Other$1;
|
|
32
546
|
type RenderData = Pick<RouterData, 'location'> & Other$1;
|
|
@@ -165,6 +679,8 @@ interface API_Shortcuts {
|
|
|
165
679
|
collapseAll: API_KeyCollection;
|
|
166
680
|
expandAll: API_KeyCollection;
|
|
167
681
|
remount: API_KeyCollection;
|
|
682
|
+
openInEditor: API_KeyCollection;
|
|
683
|
+
copyStoryLink: API_KeyCollection;
|
|
168
684
|
}
|
|
169
685
|
|
|
170
686
|
interface SubState$3 extends API_LoadedRefData$1 {
|
|
@@ -1548,6 +2064,11 @@ interface BaseIndexEntry {
|
|
|
1548
2064
|
}
|
|
1549
2065
|
type StoryIndexEntry = BaseIndexEntry & {
|
|
1550
2066
|
type: 'story';
|
|
2067
|
+
subtype: 'story' | 'test';
|
|
2068
|
+
componentPath?: string;
|
|
2069
|
+
exportName?: string;
|
|
2070
|
+
parent?: StoryId$1;
|
|
2071
|
+
parentName?: StoryName;
|
|
1551
2072
|
};
|
|
1552
2073
|
type DocsIndexEntry = BaseIndexEntry & {
|
|
1553
2074
|
storiesImports: Path[];
|
|
@@ -1557,6 +2078,7 @@ type IndexEntry = StoryIndexEntry | DocsIndexEntry;
|
|
|
1557
2078
|
interface IndexInputStats {
|
|
1558
2079
|
loaders?: boolean;
|
|
1559
2080
|
play?: boolean;
|
|
2081
|
+
tests?: boolean;
|
|
1560
2082
|
render?: boolean;
|
|
1561
2083
|
storyFn?: boolean;
|
|
1562
2084
|
mount?: boolean;
|
|
@@ -1600,6 +2122,9 @@ type BaseIndexInput = {
|
|
|
1600
2122
|
/** The input for indexing a story entry. */
|
|
1601
2123
|
type StoryIndexInput = BaseIndexInput & {
|
|
1602
2124
|
type: 'story';
|
|
2125
|
+
subtype?: 'story' | 'test';
|
|
2126
|
+
parent?: StoryId$1;
|
|
2127
|
+
parentName?: StoryName;
|
|
1603
2128
|
};
|
|
1604
2129
|
/** The input for indexing a docs entry. */
|
|
1605
2130
|
type DocsIndexInput = BaseIndexInput & {
|
|
@@ -1608,7 +2133,7 @@ type DocsIndexInput = BaseIndexInput & {
|
|
|
1608
2133
|
storiesImports?: Path[];
|
|
1609
2134
|
};
|
|
1610
2135
|
type IndexInput = StoryIndexInput | DocsIndexInput;
|
|
1611
|
-
interface V3CompatIndexEntry extends Omit<StoryIndexEntry, 'type' | 'tags'> {
|
|
2136
|
+
interface V3CompatIndexEntry extends Omit<StoryIndexEntry, 'type' | 'tags' | 'subtype'> {
|
|
1612
2137
|
kind: ComponentTitle;
|
|
1613
2138
|
story: StoryName;
|
|
1614
2139
|
parameters: Parameters;
|
|
@@ -1773,6 +2298,7 @@ interface BuilderOptions {
|
|
|
1773
2298
|
versionCheck?: VersionCheck;
|
|
1774
2299
|
disableWebpackDefaults?: boolean;
|
|
1775
2300
|
serverChannelUrl?: string;
|
|
2301
|
+
networkAddress?: string;
|
|
1776
2302
|
}
|
|
1777
2303
|
interface StorybookConfigOptions {
|
|
1778
2304
|
presets: Presets;
|
|
@@ -1877,6 +2403,8 @@ interface TestBuildConfig {
|
|
|
1877
2403
|
}
|
|
1878
2404
|
type Tag = string;
|
|
1879
2405
|
interface TagOptions {
|
|
2406
|
+
/** Visually include or exclude stories with this tag in the sidebar by default */
|
|
2407
|
+
defaultFilterSelection?: 'include' | 'exclude';
|
|
1880
2408
|
excludeFromSidebar: boolean;
|
|
1881
2409
|
excludeFromDocsStories: boolean;
|
|
1882
2410
|
}
|
|
@@ -2151,7 +2679,7 @@ interface API_BaseEntry {
|
|
|
2151
2679
|
name: string;
|
|
2152
2680
|
tags: Tag$1[];
|
|
2153
2681
|
refId?: string;
|
|
2154
|
-
renderLabel?: (item:
|
|
2682
|
+
renderLabel?: (item: API_HashEntry, api: any) => any;
|
|
2155
2683
|
}
|
|
2156
2684
|
interface API_RootEntry extends API_BaseEntry {
|
|
2157
2685
|
type: 'root';
|
|
@@ -2167,6 +2695,7 @@ interface API_ComponentEntry extends API_BaseEntry {
|
|
|
2167
2695
|
type: 'component';
|
|
2168
2696
|
parent?: StoryId$1;
|
|
2169
2697
|
children: StoryId$1[];
|
|
2698
|
+
importPath?: Path;
|
|
2170
2699
|
}
|
|
2171
2700
|
interface API_DocsEntry extends API_BaseEntry {
|
|
2172
2701
|
type: 'docs';
|
|
@@ -2180,9 +2709,11 @@ interface API_DocsEntry extends API_BaseEntry {
|
|
|
2180
2709
|
}
|
|
2181
2710
|
interface API_StoryEntry extends API_BaseEntry {
|
|
2182
2711
|
type: 'story';
|
|
2712
|
+
subtype: 'story';
|
|
2183
2713
|
parent: StoryId$1;
|
|
2184
2714
|
title: ComponentTitle;
|
|
2185
2715
|
importPath: Path;
|
|
2716
|
+
exportName: string;
|
|
2186
2717
|
prepared: boolean;
|
|
2187
2718
|
parameters?: {
|
|
2188
2719
|
[parameterName: string]: any;
|
|
@@ -2190,9 +2721,13 @@ interface API_StoryEntry extends API_BaseEntry {
|
|
|
2190
2721
|
args?: Args;
|
|
2191
2722
|
argTypes?: ArgTypes;
|
|
2192
2723
|
initialArgs?: Args;
|
|
2724
|
+
children?: StoryId$1[];
|
|
2725
|
+
}
|
|
2726
|
+
interface API_TestEntry extends Omit<API_StoryEntry, 'subtype' | 'children'> {
|
|
2727
|
+
subtype: 'test';
|
|
2193
2728
|
}
|
|
2194
|
-
type API_LeafEntry = API_DocsEntry | API_StoryEntry;
|
|
2195
|
-
type API_HashEntry = API_RootEntry | API_GroupEntry | API_ComponentEntry | API_DocsEntry | API_StoryEntry;
|
|
2729
|
+
type API_LeafEntry = API_DocsEntry | API_StoryEntry | API_TestEntry;
|
|
2730
|
+
type API_HashEntry = API_RootEntry | API_GroupEntry | API_ComponentEntry | API_DocsEntry | API_StoryEntry | API_TestEntry;
|
|
2196
2731
|
/**
|
|
2197
2732
|
* The `IndexHash` is our manager-side representation of the `StoryIndex`. We create entries in the
|
|
2198
2733
|
* hash not only for each story or docs entry, but also for each "group" of the component (split on
|
|
@@ -2362,6 +2897,7 @@ interface API_Layout {
|
|
|
2362
2897
|
showToolbar: boolean;
|
|
2363
2898
|
}
|
|
2364
2899
|
interface API_LayoutCustomisations {
|
|
2900
|
+
showPanel?: (state: State, defaultValue: boolean) => boolean | undefined;
|
|
2365
2901
|
showSidebar?: (state: State, defaultValue: boolean) => boolean | undefined;
|
|
2366
2902
|
showToolbar?: (state: State, defaultValue: boolean) => boolean | undefined;
|
|
2367
2903
|
}
|
|
@@ -2480,7 +3016,7 @@ type Addon_LegacyStoryFn<ReturnType = unknown> = LegacyStoryFn<Addon_ReturnTypeF
|
|
|
2480
3016
|
type Addon_ArgsStoryFn<ReturnType = unknown> = ArgsStoryFn<Addon_ReturnTypeFramework<ReturnType>>;
|
|
2481
3017
|
type Addon_StoryFn<ReturnType = unknown> = StoryFn<Addon_ReturnTypeFramework<ReturnType>>;
|
|
2482
3018
|
type Addon_DecoratorFunction<StoryFnReturnType = unknown> = DecoratorFunction<Addon_ReturnTypeFramework<StoryFnReturnType>>;
|
|
2483
|
-
type Addon_LoaderFunction = LoaderFunction<Addon_ReturnTypeFramework<unknown>>;
|
|
3019
|
+
type Addon_LoaderFunction = LoaderFunction$1<Addon_ReturnTypeFramework<unknown>>;
|
|
2484
3020
|
interface Addon_WrapperSettings {
|
|
2485
3021
|
options: object;
|
|
2486
3022
|
parameters: {
|
|
@@ -2779,7 +3315,8 @@ interface Addon_ToolbarConfig {
|
|
|
2779
3315
|
}
|
|
2780
3316
|
interface Addon_Config {
|
|
2781
3317
|
theme?: ThemeVars;
|
|
2782
|
-
|
|
3318
|
+
layoutCustomisations?: {
|
|
3319
|
+
showPanel?: API_LayoutCustomisations['showPanel'];
|
|
2783
3320
|
showSidebar?: API_LayoutCustomisations['showSidebar'];
|
|
2784
3321
|
showToolbar?: API_LayoutCustomisations['showToolbar'];
|
|
2785
3322
|
};
|
|
@@ -2863,7 +3400,7 @@ type NormalizedProjectAnnotations<TRenderer extends Renderer = Renderer> = Omit<
|
|
|
2863
3400
|
argTypes?: StrictArgTypes;
|
|
2864
3401
|
globalTypes?: StrictGlobalTypes;
|
|
2865
3402
|
decorators?: DecoratorFunction<TRenderer>[];
|
|
2866
|
-
loaders?: LoaderFunction<TRenderer>[];
|
|
3403
|
+
loaders?: LoaderFunction$1<TRenderer>[];
|
|
2867
3404
|
runStep: StepRunner<TRenderer>;
|
|
2868
3405
|
beforeAll: BeforeAll;
|
|
2869
3406
|
};
|
|
@@ -2872,7 +3409,7 @@ type NormalizedComponentAnnotations<TRenderer extends Renderer = Renderer> = Omi
|
|
|
2872
3409
|
title: ComponentTitle;
|
|
2873
3410
|
argTypes?: StrictArgTypes;
|
|
2874
3411
|
decorators?: DecoratorFunction<TRenderer>[];
|
|
2875
|
-
loaders?: LoaderFunction<TRenderer>[];
|
|
3412
|
+
loaders?: LoaderFunction$1<TRenderer>[];
|
|
2876
3413
|
};
|
|
2877
3414
|
type NormalizedStoryAnnotations<TRenderer extends Renderer = Renderer> = Omit<StoryAnnotations<TRenderer>, 'storyName' | 'story' | 'decorators' | 'loaders'> & {
|
|
2878
3415
|
moduleExport: ModuleExport;
|
|
@@ -2881,7 +3418,7 @@ type NormalizedStoryAnnotations<TRenderer extends Renderer = Renderer> = Omit<St
|
|
|
2881
3418
|
name: StoryName;
|
|
2882
3419
|
userStoryFn?: ArgsStoryFn<TRenderer>;
|
|
2883
3420
|
decorators?: DecoratorFunction<TRenderer>[];
|
|
2884
|
-
loaders?: LoaderFunction<TRenderer>[];
|
|
3421
|
+
loaders?: LoaderFunction$1<TRenderer>[];
|
|
2885
3422
|
};
|
|
2886
3423
|
type CSFFile<TRenderer extends Renderer = Renderer> = {
|
|
2887
3424
|
meta: NormalizedComponentAnnotations<TRenderer>;
|
|
@@ -3075,4 +3612,4 @@ type SupportedFrameworks = 'angular' | 'ember' | 'html-vite' | 'nextjs' | 'nextj
|
|
|
3075
3612
|
|
|
3076
3613
|
type SupportedRenderers = 'react' | 'react-native' | 'vue3' | 'angular' | 'ember' | 'preact' | 'svelte' | 'qwik' | 'html' | 'web-components' | 'server' | 'solid' | 'nuxt';
|
|
3077
3614
|
|
|
3078
|
-
export { type API_ActiveTabsType, type API_BaseEntry, type API_ComponentEntry, type API_ComposedRef, type API_ComposedRefUpdate, type API_DocsEntry, type API_FilterFunction, type API_GroupEntry, type API_HashEntry, type API_IframeRenderer, type API_IndexHash, type API_Layout, type API_LayoutCustomisations, type API_LeafEntry, type API_LoadedRefData, type API_MatchOptions, type API_Notification, type API_OptionsData, type API_PanelPositions, type API_PreparedIndexEntry, type API_PreparedStoryIndex, type API_Provider, type API_ProviderData, type API_RefId, type API_RefUrl, type API_Refs, type API_ReleaseNotes, type API_RenderOptions, type API_RootEntry, type API_RouteOptions, type API_SetRefData, type API_Settings, type API_SidebarOptions, type API_StateMerger, type API_StoryEntry, type API_StoryMapper, type API_UI, type API_UIOptions, type API_UnknownEntries, type API_Version, type API_Versions$1 as API_Versions, type API_ViewMode, type Actor, type Addon_AddStoryArgs, type Addon_Annotations, type Addon_ArgType, type Addon_ArgsStoryFn, type Addon_BaseAnnotations, type Addon_BaseDecorators, type Addon_BaseMeta, type Addon_BaseStoryFn, type Addon_BaseStoryObject, type Addon_BaseType, type Addon_ClientApiAddon, type Addon_ClientApiAddons, type Addon_ClientApiReturnFn, type Addon_ClientStoryApi, type Addon_Collection, type Addon_Comparator, type Addon_Config, type Addon_DecoratorFunction, type Addon_Elements, type Addon_LegacyStoryFn, type Addon_LoadFn, type Addon_Loadable, type Addon_Loader, type Addon_LoaderFunction, type Addon_Loaders, type Addon_MakeDecoratorResult, type Addon_OptionsParameter, type Addon_OptionsParameterV7, type Addon_PageType, type Addon_PartialStoryFn, type Addon_RenderOptions, type Addon_RequireContext, type Addon_StoryApi, type Addon_StoryContext, type Addon_StoryContextUpdate, type Addon_StoryFn, type Addon_StorySortComparator, type Addon_StorySortComparatorV7, type Addon_StorySortMethod, type Addon_StorySortObjectParameter, type Addon_StorySortParameter, type Addon_StorySortParameterV7, type Addon_StoryWrapper, type Addon_TestProviderType, type Addon_ToolbarConfig, type Addon_Type, type Addon_Types, Addon_TypesEnum, type Addon_TypesMapping, type Addon_WrapperSettings, type Addon_WrapperType, type Addons_ArgTypes, type BaseIndexEntry, type BaseIndexInput, type BaseStory, type BoundStory, type Builder, type BuilderName, type BuilderOptions, type BuilderResult, type BuilderStats, type Builder_EnvsRaw, type Builder_Unpromise, type Builder_WithRequiredProperty, type CLIBaseOptions, type CLIOptions, type CSFFile, type CompatibleString, type ComposeStoryFn, type ComposedStoryFn, type CoreCommon_AddonEntry, type CoreCommon_AddonInfo, type CoreCommon_OptionsEntry, type CoreCommon_ResolvedAddonPreset, type CoreCommon_ResolvedAddonVirtual, type CoreCommon_StorybookInfo, type CoreConfig, type DocsContextProps, type DocsIndexEntry, type DocsIndexInput, type DocsOptions, type DocsPreparedPayload, type DocsRenderFunction, type Entry, type Event, type EventInfo, type GlobalsUpdatedPayload, type IndexEntry, type IndexEntryLegacy, type IndexInput, type IndexInputStats, type IndexedCSFFile, type IndexedStory, type Indexer, type IndexerOptions, type LoadOptions, type LoadedPreset, type Middleware, MockUniversalStore, type ModuleExport, type ModuleExports, type ModuleImportFn, type NamedOrDefaultProjectAnnotations, type NormalizedComponentAnnotations, type NormalizedProjectAnnotations, type NormalizedStoriesSpecifier, type NormalizedStoryAnnotations, type Options, type PackageJson, type PartialArgsStoryFn, type Path, type PreparedMeta, type PreparedStory, type Preset, type PresetConfig, type PresetProperty, type PresetPropertyFn, type PresetValue, type Presets, type PreviewAnnotation, type ProjectAnnotations, type Ref, type RenderContext, type RenderContextCallbacks, type RenderToCanvas, type RendererName, type ResolvedModuleExport, type ResolvedModuleExportFromType, type ResolvedModuleExportType, type SetGlobalsPayload, type SetStoriesPayload, type SetStoriesStory, type SetStoriesStoryData, type Stats, type Status, type StatusByTypeId, type StatusStore, type StatusStoreByTypeId, type StatusTypeId, type StatusValue, type StatusesByStoryIdAndTypeId, type StoreOptions, type Store_CSFExports, type StoriesEntry, type StoriesSpecifier, type StoriesWithPartialProps, type StoryIndex, type StoryIndexEntry, type StoryIndexInput, type StoryIndexV2, type StoryIndexV3, type StoryPreparedPayload, type StoryRenderOptions, type StorybookConfig, type StorybookConfigOptions, type StorybookConfigRaw, type StorybookInternalParameters, type StorybookParameters, type StorybookTypes, type SupportedFrameworks, type SupportedRenderers, type TagOptions, type TagsOptions, type TeardownRenderToCanvas, type TestBuildConfig, type TestBuildFlags, type TestProviderId, type TestProviderState, type TestProviderStateByProviderId, type TestProviderStoreById, type TypescriptOptions, UniversalStore, type UseStatusStore, type UseTestProviderStore, type V3CompatIndexEntry, type VersionCheck, type ViewMode, type WebRenderer };
|
|
3615
|
+
export { type API_ActiveTabsType, type API_BaseEntry, type API_ComponentEntry, type API_ComposedRef, type API_ComposedRefUpdate, type API_DocsEntry, type API_FilterFunction, type API_GroupEntry, type API_HashEntry, type API_IframeRenderer, type API_IndexHash, type API_Layout, type API_LayoutCustomisations, type API_LeafEntry, type API_LoadedRefData, type API_MatchOptions, type API_Notification, type API_OptionsData, type API_PanelPositions, type API_PreparedIndexEntry, type API_PreparedStoryIndex, type API_Provider, type API_ProviderData, type API_RefId, type API_RefUrl, type API_Refs, type API_ReleaseNotes, type API_RenderOptions, type API_RootEntry, type API_RouteOptions, type API_SetRefData, type API_Settings, type API_SidebarOptions, type API_StateMerger, type API_StoryEntry, type API_StoryMapper, type API_TestEntry, type API_UI, type API_UIOptions, type API_UnknownEntries, type API_Version, type API_Versions$1 as API_Versions, type API_ViewMode, type Actor, type Addon_AddStoryArgs, type Addon_Annotations, type Addon_ArgType, type Addon_ArgsStoryFn, type Addon_BaseAnnotations, type Addon_BaseDecorators, type Addon_BaseMeta, type Addon_BaseStoryFn, type Addon_BaseStoryObject, type Addon_BaseType, type Addon_ClientApiAddon, type Addon_ClientApiAddons, type Addon_ClientApiReturnFn, type Addon_ClientStoryApi, type Addon_Collection, type Addon_Comparator, type Addon_Config, type Addon_DecoratorFunction, type Addon_Elements, type Addon_LegacyStoryFn, type Addon_LoadFn, type Addon_Loadable, type Addon_Loader, type Addon_LoaderFunction, type Addon_Loaders, type Addon_MakeDecoratorResult, type Addon_OptionsParameter, type Addon_OptionsParameterV7, type Addon_PageType, type Addon_PartialStoryFn, type Addon_RenderOptions, type Addon_RequireContext, type Addon_StoryApi, type Addon_StoryContext, type Addon_StoryContextUpdate, type Addon_StoryFn, type Addon_StorySortComparator, type Addon_StorySortComparatorV7, type Addon_StorySortMethod, type Addon_StorySortObjectParameter, type Addon_StorySortParameter, type Addon_StorySortParameterV7, type Addon_StoryWrapper, type Addon_TestProviderType, type Addon_ToolbarConfig, type Addon_Type, type Addon_Types, Addon_TypesEnum, type Addon_TypesMapping, type Addon_WrapperSettings, type Addon_WrapperType, type Addons_ArgTypes, type BaseIndexEntry, type BaseIndexInput, type BaseStory, type BoundStory, type Builder, type BuilderName, type BuilderOptions, type BuilderResult, type BuilderStats, type Builder_EnvsRaw, type Builder_Unpromise, type Builder_WithRequiredProperty, type CLIBaseOptions, type CLIOptions, type CSFFile, type CompatibleString, type ComposeStoryFn, type ComposedStoryFn, type CoreCommon_AddonEntry, type CoreCommon_AddonInfo, type CoreCommon_OptionsEntry, type CoreCommon_ResolvedAddonPreset, type CoreCommon_ResolvedAddonVirtual, type CoreCommon_StorybookInfo, type CoreConfig, type DocsContextProps, type DocsIndexEntry, type DocsIndexInput, type DocsOptions, type DocsPreparedPayload, type DocsRenderFunction, type Entry, type Event, type EventInfo, type GlobalsUpdatedPayload, type IndexEntry, type IndexEntryLegacy, type IndexInput, type IndexInputStats, type IndexedCSFFile, type IndexedStory, type Indexer, type IndexerOptions, type LoadOptions, type LoadedPreset, type Middleware, MockUniversalStore, type ModuleExport, type ModuleExports, type ModuleImportFn, type NamedOrDefaultProjectAnnotations, type NormalizedComponentAnnotations, type NormalizedProjectAnnotations, type NormalizedStoriesSpecifier, type NormalizedStoryAnnotations, type Options, type PackageJson, type PartialArgsStoryFn, type Path, type PreparedMeta, type PreparedStory, type Preset, type PresetConfig, type PresetProperty, type PresetPropertyFn, type PresetValue, type Presets, type PreviewAnnotation, type ProjectAnnotations, type Ref, type RenderContext, type RenderContextCallbacks, type RenderToCanvas, type RendererName, type ResolvedModuleExport, type ResolvedModuleExportFromType, type ResolvedModuleExportType, type SetGlobalsPayload, type SetStoriesPayload, type SetStoriesStory, type SetStoriesStoryData, type Stats, type Status, type StatusByTypeId, type StatusStore, type StatusStoreByTypeId, type StatusTypeId, type StatusValue, type StatusesByStoryIdAndTypeId, type StoreOptions, type Store_CSFExports, type StoriesEntry, type StoriesSpecifier, type StoriesWithPartialProps, type StoryIndex, type StoryIndexEntry, type StoryIndexInput, type StoryIndexV2, type StoryIndexV3, type StoryPreparedPayload, type StoryRenderOptions, type StorybookConfig, type StorybookConfigOptions, type StorybookConfigRaw, type StorybookInternalParameters, type StorybookParameters, type StorybookTypes, type SupportedFrameworks, type SupportedRenderers, type TagOptions, type TagsOptions, type TeardownRenderToCanvas, type TestBuildConfig, type TestBuildFlags, type TestProviderId, type TestProviderState, type TestProviderStateByProviderId, type TestProviderStoreById, type TypescriptOptions, UniversalStore, type UseStatusStore, type UseTestProviderStore, type V3CompatIndexEntry, type VersionCheck, type ViewMode, type WebRenderer };
|