-
Notifications
You must be signed in to change notification settings - Fork 81
/
types.ts
103 lines (91 loc) · 3.96 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
/* Copyright (c) 2021, 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 { SendVerifyEmail } from "./components/themes/emailVerification/sendVerifyEmail";
import type { VerifyEmailLinkClicked } from "./components/themes/emailVerification/verifyEmailLinkClicked";
import type { ComponentOverride } from "../../components/componentOverride/componentOverride";
import type { FeatureBaseConfig, ThemeBaseProps, UserContext } from "../../types";
import type {
Config as RecipeModuleConfig,
NormalisedConfig as NormalisedRecipeModuleConfig,
UserInput as RecipeModuleUserInput,
} from "../recipeModule/types";
import type { OverrideableBuilder } from "supertokens-js-override";
import type { RecipeInterface } from "supertokens-web-js/recipe/emailverification";
export type ComponentOverrideMap = {
EmailVerificationSendVerifyEmail_Override?: ComponentOverride<typeof SendVerifyEmail>;
EmailVerificationVerifyEmailLinkClicked_Override?: ComponentOverride<typeof VerifyEmailLinkClicked>;
};
// Config is what does in the constructor of the recipe.
export type UserInput = {
mode?: "OPTIONAL" | "REQUIRED";
disableDefaultUI?: boolean;
sendVerifyEmailScreen?: FeatureBaseConfig;
verifyEmailLinkClickedScreen?: FeatureBaseConfig;
override?: {
functions?: (
originalImplementation: RecipeInterface,
builder: OverrideableBuilder<RecipeInterface>
) => RecipeInterface;
};
} & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
// Config is what does in the constructor of the recipe.
export type Config = UserInput &
RecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
export type NormalisedConfig = {
mode: "OPTIONAL" | "REQUIRED";
disableDefaultUI: boolean;
sendVerifyEmailScreen: FeatureBaseConfig;
verifyEmailLinkClickedScreen: FeatureBaseConfig;
override: {
functions: (
originalImplementation: RecipeInterface,
builder: OverrideableBuilder<RecipeInterface>
) => RecipeInterface;
};
} & NormalisedRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
export type GetRedirectionURLContext = {
action: "VERIFY_EMAIL";
};
export type PreAndPostAPIHookAction = "VERIFY_EMAIL" | "SEND_VERIFY_EMAIL" | "IS_EMAIL_VERIFIED";
export type PreAPIHookContext = {
action: PreAndPostAPIHookAction;
requestInit: RequestInit;
url: string;
userContext: UserContext;
};
export type OnHandleEventContext = {
action: "VERIFY_EMAIL_SENT" | "EMAIL_VERIFIED_SUCCESSFUL";
userContext: UserContext;
};
export type EmailVerificationThemeProps = {
sendVerifyEmailScreen: SendVerifyEmailThemeProps;
verifyEmailLinkClickedScreen?: VerifyEmailLinkClickedThemeProps;
config: NormalisedConfig;
userContext?: UserContext;
};
export type SendVerifyEmailThemeProps = ThemeBaseProps & {
recipeImplementation: RecipeInterface;
config: NormalisedConfig;
signOut: () => Promise<void>;
onEmailAlreadyVerified: () => Promise<void>;
redirectToAuth: () => Promise<void>;
};
export type VerifyEmailLinkClickedThemeProps = ThemeBaseProps & {
recipeImplementation: RecipeInterface;
config: NormalisedConfig;
onSuccess: () => Promise<void>;
onTokenInvalidRedirect: () => Promise<void>;
token: string;
};