-
Notifications
You must be signed in to change notification settings - Fork 84
/
types.ts
162 lines (140 loc) · 5.48 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
/* 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 { ProvidersForm } from "./components/themes/signInAndUp/providersForm";
import type { SignInAndUpHeader } from "./components/themes/signInAndUp/signInAndUpHeader";
import type { SignUpFooter } from "./components/themes/signInAndUp/signUpFooter";
import type { SignInAndUpCallbackTheme } from "./components/themes/signInAndUpCallback";
import type Provider from "./providers";
import type { CustomProviderConfig } from "./providers/types";
import type { ComponentOverride } from "../../components/componentOverride/componentOverride";
import type { FeatureBaseConfig, NormalisedBaseConfig, UserContext, WebJSRecipeInterface } from "../../types";
import type {
OnHandleEventContext as AuthRecipeModuleOnHandleEventContext,
Config as AuthRecipeModuleConfig,
NormalisedConfig as NormalisedAuthRecipeModuleConfig,
UserInput as AuthRecipeModuleUserInput,
} from "../authRecipe/types";
import type { OverrideableBuilder } from "supertokens-js-override";
import type ThirdPartyWebJS from "supertokens-web-js/recipe/thirdparty";
import type { StateObject as WebJsStateObject, RecipeInterface } from "supertokens-web-js/recipe/thirdparty";
import type { User } from "supertokens-web-js/types";
export type ComponentOverrideMap = {
ThirdPartySignUpFooter_Override?: ComponentOverride<typeof SignUpFooter>;
ThirdPartySignInAndUpHeader_Override?: ComponentOverride<typeof SignInAndUpHeader>;
ThirdPartySignInAndUpProvidersForm_Override?: ComponentOverride<typeof ProvidersForm>;
ThirdPartySignInAndUpCallbackTheme_Override?: ComponentOverride<typeof SignInAndUpCallbackTheme>;
};
export type UserInput = {
signInAndUpFeature?: SignInAndUpFeatureUserInput;
oAuthCallbackScreen?: FeatureBaseConfig;
override?: {
functions?: (
originalImplementation: RecipeInterface,
builder: OverrideableBuilder<RecipeInterface>
) => RecipeInterface;
};
} & AuthRecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
export type Config = UserInput &
AuthRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
export type NormalisedConfig = {
signInAndUpFeature: NormalisedSignInAndUpFeatureConfig;
oAuthCallbackScreen: FeatureBaseConfig;
override: {
functions: (
originalImplementation: RecipeInterface,
builder: OverrideableBuilder<RecipeInterface>
) => RecipeInterface;
};
} & NormalisedAuthRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;
export type SignInAndUpFeatureUserInput = FeatureBaseConfig & {
/*
* Disable default implementation with default routes.
*/
disableDefaultUI?: boolean;
/*
* Privacy policy link for sign up form.
*/
privacyPolicyLink?: string;
/*
* Terms and conditions link for sign up form.
*/
termsOfServiceLink?: string;
/*
* Providers
*/
providers?: (Provider | CustomProviderConfig)[];
};
export type NormalisedSignInAndUpFeatureConfig = NormalisedBaseConfig & {
/*
* Disable default implementation with default routes.
*/
disableDefaultUI: boolean;
/*
* Privacy policy link for sign up form.
*/
privacyPolicyLink?: string;
/*
* Terms and conditions link for sign up form.
*/
termsOfServiceLink?: string;
/*
* Providers
*/
providers: Provider[];
};
// The redirection callback will never be called for thirdparty
export type GetRedirectionURLContext = never;
export type PreAndPostAPIHookAction = "GET_AUTHORISATION_URL" | "THIRD_PARTY_SIGN_IN_UP";
export type PreAPIHookContext = {
action: PreAndPostAPIHookAction;
requestInit: RequestInit;
url: string;
userContext: UserContext;
};
export type OnHandleEventContext =
| AuthRecipeModuleOnHandleEventContext
| {
rid: "thirdparty";
action: "SUCCESS";
isNewRecipeUser: boolean;
createdNewSession: boolean;
user: User;
userContext: UserContext;
};
export type SignInAndUpThemeProps = {
featureState: {
error: string | undefined;
};
dispatch: (action: ThirdPartySignInUpActions) => void;
providers: Pick<Provider, "id" | "getButton">[];
recipeImplementation: WebJSRecipeInterface<typeof ThirdPartyWebJS>;
config: NormalisedConfig;
};
export type ThirdPartySignInUpChildProps = Omit<SignInAndUpThemeProps, "featureState" | "dispatch">;
export type ThirdPartySignInUpActions = {
type: "setError";
error: string | undefined;
};
export type ThirdPartySignInAndUpState = {
error: string | undefined;
};
export type StateObject = WebJsStateObject & {
rid?: string;
redirectToPath?: string;
};
export type CustomStateProperties = {
rid: string;
redirectToPath: string;
};