forked from clerk/javascript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtypes.ts
More file actions
193 lines (169 loc) · 4.8 KB
/
Copy pathtypes.ts
File metadata and controls
193 lines (169 loc) · 4.8 KB
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
189
190
191
192
193
import type {
Clerk,
ClerkOptions,
ClientResource,
DomainOrProxyUrl,
InitialState,
LoadedClerk,
MultiDomainAndOrProxy,
RedirectUrlProp,
SignInProps,
SignInRedirectOptions,
SignUpProps,
SignUpRedirectOptions,
Without,
} from '@clerk/types';
import type React from 'react';
declare global {
interface Window {
__clerk_publishable_key?: string;
__clerk_proxy_url?: Clerk['proxyUrl'];
__clerk_domain?: Clerk['domain'];
}
}
export type IsomorphicClerkOptions = Without<ClerkOptions, 'isSatellite'> & {
Clerk?: ClerkProp;
/**
* Define the URL that `@clerk/clerk-js` should be hot-loaded from
*/
clerkJSUrl?: string;
/**
* If your web application only uses Control components, you can set this value to `'headless'` and load a minimal ClerkJS bundle for optimal page performance.
*/
clerkJSVariant?: 'headless' | '';
/**
* Define the npm version for `@clerk/clerk-js`
*/
clerkJSVersion?: string;
/**
* The Clerk publishable key for your instance
* @note This can be found in your Clerk Dashboard on the [API Keys](https://dashboard.clerk.com/last-active?path=api-keys) page
*/
publishableKey: string;
/**
* This nonce value will be passed through to the `@clerk/clerk-js` script tag.
* @note You can use this to implement [strict-dynamic CSP](https://clerk.com/docs/security/clerk-csp#implementing-a-strict-dynamic-csp)
*/
nonce?: string;
} & MultiDomainAndOrProxy;
export type ClerkProviderProps = IsomorphicClerkOptions & {
children: React.ReactNode;
/**
* Provide an initial state of the Clerk client during server-side rendering (SSR)
*/
initialState?: InitialState;
/**
* Indicates to silently fail the initialization process when the publishable keys is not provided, instead of throwing an error.
* Defaults to `false`.
*/
__internal_bypassMissingPublishableKey?: boolean;
};
export interface BrowserClerkConstructor {
new (publishableKey: string, options?: DomainOrProxyUrl): BrowserClerk;
}
export interface HeadlessBrowserClerkConstructor {
new (publishableKey: string, options?: DomainOrProxyUrl): HeadlessBrowserClerk;
}
export type WithClerkProp<T = unknown> = T & { clerk: LoadedClerk };
export interface CustomPortalsRendererProps {
customPagesPortals?: any[];
customMenuItemsPortals?: any[];
}
// Clerk object
export interface MountProps {
mount: (node: HTMLDivElement, props: any) => void;
unmount: (node: HTMLDivElement) => void;
updateProps: (props: any) => void;
props?: any;
}
export interface OpenProps {
open: (props: any) => void;
close: () => void;
props?: any;
}
export interface HeadlessBrowserClerk extends Clerk {
load: (opts?: Without<ClerkOptions, 'isSatellite'>) => Promise<void>;
updateClient: (client: ClientResource) => void;
}
export interface BrowserClerk extends HeadlessBrowserClerk {
onComponentsReady: Promise<void>;
components: any;
}
export type ClerkProp =
| BrowserClerkConstructor
| BrowserClerk
| HeadlessBrowserClerk
| HeadlessBrowserClerkConstructor
| undefined
| null;
type ButtonProps = {
mode?: 'redirect' | 'modal';
children?: React.ReactNode;
};
export type SignInButtonProps = ButtonProps &
Pick<
SignInProps,
| 'fallbackRedirectUrl'
| 'forceRedirectUrl'
| 'signUpForceRedirectUrl'
| 'signUpFallbackRedirectUrl'
| 'initialValues'
>;
export type SignUpButtonProps = {
unsafeMetadata?: SignUpUnsafeMetadata;
} & ButtonProps &
Pick<
SignUpProps,
| 'fallbackRedirectUrl'
| 'forceRedirectUrl'
| 'signInForceRedirectUrl'
| 'signInFallbackRedirectUrl'
| 'initialValues'
>;
export type SignInWithMetamaskButtonProps = ButtonProps & RedirectUrlProp;
export type RedirectToSignInProps = SignInRedirectOptions;
export type RedirectToSignUpProps = SignUpRedirectOptions;
type PageProps<T extends string> =
| {
label: string;
url: string;
labelIcon: React.ReactNode;
}
| {
label: T;
url?: never;
labelIcon?: never;
};
export type UserProfilePageProps = PageProps<'account' | 'security'>;
export type UserProfileLinkProps = {
url: string;
label: string;
labelIcon: React.ReactNode;
};
export type OrganizationProfilePageProps = PageProps<'general' | 'members'>;
export type OrganizationProfileLinkProps = UserProfileLinkProps;
type ButtonActionProps<T extends string> =
| {
label: string;
labelIcon: React.ReactNode;
onClick: () => void;
open?: never;
}
| {
label: T;
labelIcon?: never;
onClick?: never;
open?: never;
}
| {
label: string;
labelIcon: React.ReactNode;
onClick?: never;
open: string;
};
export type UserButtonActionProps = ButtonActionProps<'manageAccount' | 'signOut'>;
export type UserButtonLinkProps = {
href: string;
label: string;
labelIcon: React.ReactNode;
};