-
Notifications
You must be signed in to change notification settings - Fork 84
/
types.ts
188 lines (171 loc) · 6.22 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
/* Copyright (c) 2024, VRAI Labs and/or its affiliates. All rights reserved.
*
* This software is licensed under the Apache License, Version 2.0 (the
* "License") as published by the Apache Software Foundation.
*
* You may not use this file except in compliance with the License. You may
* obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
import type { BlockedScreen } from "./components/themes/mfa/blockedScreen";
import type { LoadingScreen } from "./components/themes/mfa/loadingScreen";
import type { CodeForm } from "./components/themes/mfa/totpCodeForm";
import type { CodeVerificationFooter } from "./components/themes/mfa/totpCodeVerificationFooter";
import type { CodeVerificationHeader } from "./components/themes/mfa/totpCodeVerificationHeader";
import type { DeviceInfoSection } from "./components/themes/mfa/totpDeviceInfoSection";
import type { DeviceSetupFooter } from "./components/themes/mfa/totpDeviceSetupFooter";
import type { DeviceSetupHeader } from "./components/themes/mfa/totpDeviceSetupHeader";
import type { ComponentOverride } from "../../components/componentOverride/componentOverride";
import type { UserContext } from "../../types";
import type {
Config as RecipeModuleConfig,
NormalisedConfig as NormalisedRecipeModuleConfig,
UserInput as RecipeModuleUserInput,
} from "../recipeModule/types";
import type { Dispatch } from "react";
import type { OverrideableBuilder } from "supertokens-js-override";
import type { RecipeInterface } from "supertokens-web-js/recipe/totp";
export type ComponentOverrideMap = {
TOTPBlockedScreen_Override?: ComponentOverride<typeof BlockedScreen>;
TOTPLoadingScreen_Override?: ComponentOverride<typeof LoadingScreen>;
TOTPCodeForm_Override?: ComponentOverride<typeof CodeForm>;
TOTPCodeVerificationFooter_Override?: ComponentOverride<typeof CodeVerificationFooter>;
TOTPCodeVerificationHeader_Override?: ComponentOverride<typeof CodeVerificationHeader>;
TOTPDeviceSetupFooter_Override?: ComponentOverride<typeof DeviceSetupFooter>;
TOTPDeviceSetupHeader_Override?: ComponentOverride<typeof DeviceSetupHeader>;
TOTPDeviceInfoSection_Override?: ComponentOverride<typeof DeviceInfoSection>;
};
export type TOTPDeviceInfo = {
deviceName: string;
secret: string;
qrCodeString: string;
userIdentifier?: string | undefined;
};
export type TOTPMFAAction =
| {
type: "load";
showBackButton: boolean;
deviceInfo: TOTPDeviceInfo | undefined;
showAccessDenied: boolean;
error: string | undefined;
callingCreateDevice: boolean;
}
| {
type: "createDevice";
deviceInfo: TOTPDeviceInfo;
}
| {
type: "setBlocked";
error: string | undefined;
nextRetryAt: number;
}
| {
type: "setError";
showAccessDenied: boolean;
error: string | undefined;
maxAttemptCount?: number;
currAttemptCount?: number;
}
| {
type: "restartFlow";
error: string | undefined;
}
| {
type: "success";
}
| {
type: "showSecret";
};
export type TOTPMFAState = {
deviceInfo?: TOTPDeviceInfo;
showSecret: boolean;
nextRetryAt?: number;
isBlocked: boolean;
showBackButton: boolean;
loaded: boolean;
error: string | undefined;
maxAttemptCount?: number;
currAttemptCount?: number;
showAccessDenied: boolean;
};
export type TOTPMFACommonProps = {
featureState: TOTPMFAState;
recipeImplementation: RecipeInterface;
config: NormalisedConfig;
userContext?: UserContext;
};
export type TOTPMFAProps = {
recipeImplementation: RecipeInterface;
config: NormalisedConfig;
onSuccess: () => void;
onShowSecretClicked: () => void;
onBackButtonClicked: () => void;
onRetryClicked: () => void;
onSignOutClicked: () => void;
dispatch: Dispatch<TOTPMFAAction>;
featureState: TOTPMFAState;
userContext?: UserContext;
};
export type TOTPMFAChildProps = Omit<TOTPMFAProps, "featureState" | "dispatch">;
export type TOTPMFAScreenConfig = {
disableDefaultUI: boolean;
setupScreenStyle: string;
verificationScreenStyle: string;
blockedScreenStyle: string;
loadingScreenStyle: string;
};
export type UserInput = {
totpMFAScreen?: Partial<TOTPMFAScreenConfig>;
override?: {
functions?: (
originalImplementation: RecipeInterface,
builder?: OverrideableBuilder<RecipeInterface>
) => RecipeInterface;
};
} & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
export type Config = UserInput &
RecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
export type NormalisedConfig = {
totpMFAScreen: TOTPMFAScreenConfig;
override: {
functions: (
originalImplementation: RecipeInterface,
builder?: OverrideableBuilder<RecipeInterface>
) => RecipeInterface;
};
} & NormalisedRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
// The redirection callback will never be called for totp
export type GetRedirectionURLContext = never;
export type PreAndPostAPIHookAction =
| "CREATE_DEVICE"
| "VERIFY_CODE"
| "VERIFY_DEVICE"
| "REMOVE_DEVICE"
| "LIST_DEVICES";
export type PreAPIHookContext = {
action: PreAndPostAPIHookAction;
requestInit: RequestInit;
url: string;
userContext: UserContext;
};
export type OnHandleEventContext =
| {
action: "TOTP_CODE_VERIFIED";
userContext: UserContext;
}
| {
action: "TOTP_DEVICE_VERIFIED";
deviceName: string;
wasAlreadyVerified: boolean;
userContext: UserContext;
}
| {
action: "TOTP_DEVICE_CREATED";
deviceName: string;
userContext: UserContext;
};