@clerk/react 6.9.0 → 6.9.1-canary.v20260610190754
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/dist/ClerkProvider-9lxHp9j5.cjs +1623 -0
- package/dist/ClerkProvider-9lxHp9j5.cjs.map +1 -0
- package/dist/ClerkProvider-LQpPtmNL.mjs +1533 -0
- package/dist/ClerkProvider-LQpPtmNL.mjs.map +1 -0
- package/dist/errors.cjs +69 -0
- package/dist/errors.d.cts +2 -0
- package/dist/errors.d.mts +2 -1
- package/dist/errors.mjs +2 -29
- package/dist/experimental.cjs +270 -0
- package/dist/experimental.cjs.map +1 -0
- package/dist/{experimental.d.ts → experimental.d.cts} +18 -18
- package/dist/experimental.d.mts +18 -18
- package/dist/experimental.mjs +201 -165
- package/dist/experimental.mjs.map +1 -1
- package/dist/hooks-BiY5Zgpp.mjs +1369 -0
- package/dist/hooks-BiY5Zgpp.mjs.map +1 -0
- package/dist/hooks-CBghYU21.cjs +1606 -0
- package/dist/hooks-CBghYU21.cjs.map +1 -0
- package/dist/index.cjs +447 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +345 -0
- package/dist/index.d.mts +183 -157
- package/dist/index.mjs +285 -380
- package/dist/index.mjs.map +1 -1
- package/dist/internal.cjs +107 -0
- package/dist/internal.cjs.map +1 -0
- package/dist/internal.d.cts +51 -0
- package/dist/internal.d.mts +24 -26
- package/dist/internal.mjs +39 -73
- package/dist/internal.mjs.map +1 -1
- package/dist/legacy.cjs +134 -0
- package/dist/legacy.cjs.map +1 -0
- package/dist/{legacy.d.ts → legacy.d.cts} +6 -3
- package/dist/legacy.d.mts +6 -3
- package/dist/legacy.mjs +126 -42
- package/dist/legacy.mjs.map +1 -1
- package/dist/types-Bwenmt7y.d.cts +10951 -0
- package/dist/types-CiIhevkA.d.mts +10951 -0
- package/dist/types.cjs +0 -0
- package/dist/types.d.cts +3 -0
- package/dist/types.d.mts +3 -109
- package/dist/types.mjs +1 -2
- package/dist/useAssertWrappedByClerkProvider-Cm0djUcB.cjs +52 -0
- package/dist/useAssertWrappedByClerkProvider-Cm0djUcB.cjs.map +1 -0
- package/dist/useAssertWrappedByClerkProvider-GaNwZpWo.mjs +29 -0
- package/dist/useAssertWrappedByClerkProvider-GaNwZpWo.mjs.map +1 -0
- package/dist/{useAuth-Dlg_G1_7.d.mts → useAuth-BK5Y4htK.d.mts} +58 -39
- package/dist/{useAuth-Cv6iRjL9.d.ts → useAuth-BMxaWktj.d.cts} +58 -39
- package/package.json +18 -18
- package/dist/chunk-E5QRIS4Z.mjs +0 -20
- package/dist/chunk-E5QRIS4Z.mjs.map +0 -1
- package/dist/chunk-FQVXBXXF.mjs +0 -1487
- package/dist/chunk-FQVXBXXF.mjs.map +0 -1
- package/dist/chunk-GVGS7DUS.mjs +0 -2097
- package/dist/chunk-GVGS7DUS.mjs.map +0 -1
- package/dist/chunk-RQWALB2R.mjs +0 -26
- package/dist/chunk-RQWALB2R.mjs.map +0 -1
- package/dist/errors.d.ts +0 -1
- package/dist/errors.js +0 -51
- package/dist/errors.js.map +0 -1
- package/dist/errors.mjs.map +0 -1
- package/dist/experimental.js +0 -1505
- package/dist/experimental.js.map +0 -1
- package/dist/index.d.ts +0 -319
- package/dist/index.js +0 -3919
- package/dist/index.js.map +0 -1
- package/dist/internal.d.ts +0 -53
- package/dist/internal.js +0 -3339
- package/dist/internal.js.map +0 -1
- package/dist/legacy.js +0 -90
- package/dist/legacy.js.map +0 -1
- package/dist/types.d.ts +0 -109
- package/dist/types.js +0 -19
- package/dist/types.js.map +0 -1
- package/dist/types.mjs.map +0 -1
package/dist/index.d.mts
CHANGED
|
@@ -1,225 +1,247 @@
|
|
|
1
|
-
import { Theme, Ui } from
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
|
|
5
|
-
import
|
|
6
|
-
import {
|
|
7
|
-
export { A as AuthenticateWithRedirectCallback, C as ClerkDegraded, a as ClerkFailed, b as ClerkLoaded, c as ClerkLoading, R as RedirectToCreateOrganization, d as RedirectToOrganizationProfile, e as RedirectToSignIn, f as RedirectToSignUp, g as RedirectToTasks, h as RedirectToUserProfile, S as Show, i as ShowProps, j as useAuth } from './useAuth-Dlg_G1_7.mjs';
|
|
8
|
-
export { UNSAFE_PortalProvider, __experimental_CheckoutProvider, __experimental_PaymentElement, __experimental_PaymentElementProvider, __experimental_useCheckout, __experimental_usePaymentElement, useAPIKeys, useClerk, useOAuthConsent, useOrganization, useOrganizationCreationDefaults, useOrganizationList, useReverification, useSession, useSessionList, useUser } from '@clerk/shared/react';
|
|
9
|
-
export { getToken } from '@clerk/shared/getToken';
|
|
10
|
-
import '@clerk/shared/ui';
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* Augments the global ClerkAppearanceRegistry with the Theme type from @clerk/ui.
|
|
14
|
-
* This provides full type safety for appearance props in @clerk/react without creating circular dependencies.
|
|
15
|
-
*/
|
|
1
|
+
import { _ as Theme, a as OrganizationProfileLinkProps, d as Ui, f as UserButtonActionProps, g as WithClerkProp, h as UserProfilePageProps, m as UserProfileLinkProps, o as OrganizationProfilePageProps, p as UserButtonLinkProps, t as ClerkProviderProps, u as SignInWithMetamaskButtonProps } from "./types-CiIhevkA.mjs";
|
|
2
|
+
import { a as ClerkFailed, d as RedirectToSignIn, f as RedirectToSignUp, g as ShowProps, h as Show, i as ClerkDegraded, l as RedirectToCreateOrganization, m as RedirectToUserProfile, o as ClerkLoaded, p as RedirectToTasks, r as AuthenticateWithRedirectCallback, s as ClerkLoading, t as useAuth, u as RedirectToOrganizationProfile } from "./useAuth-BK5Y4htK.mjs";
|
|
3
|
+
import React, { PropsWithChildren, ReactNode } from "react";
|
|
4
|
+
import { UNSAFE_PortalProvider, __experimental_CheckoutProvider, __experimental_PaymentElement, __experimental_PaymentElementProvider, __experimental_useCheckout, __experimental_usePaymentElement, useAPIKeys, useClerk, useOAuthConsent, useOrganization, useOrganizationCreationDefaults, useOrganizationList, useReverification, useSession, useSessionList, useUser } from "@clerk/shared/react";
|
|
5
|
+
import { getToken } from "@clerk/shared/getToken";
|
|
6
|
+
import { APIKeysProps, BrowserClerk, BrowserClerkConstructor, ClerkProp, CreateEmailLinkFlowReturn, CreateOrganizationProps, EmailAddressResource, HeadlessBrowserClerk, HeadlessBrowserClerkConstructor, IsomorphicClerkOptions, OrganizationListProps, OrganizationProfileProps, OrganizationSwitcherProps, SetActiveNavigate, SignInButtonProps, SignInProps, SignInResource, SignInSignalValue, SignInStartEmailLinkFlowParams, SignOutOptions, SignUpButtonProps, SignUpProps, SignUpResource, SignUpSignalValue, StartEmailLinkFlowParams, TaskChooseOrganizationProps, TaskResetPasswordProps, TaskSetupMFAProps, UserAvatarProps, UserButtonProps, UserProfileProps, WaitlistProps, WaitlistSignalValue, Without } from "@clerk/shared/types";
|
|
16
7
|
|
|
8
|
+
//#region src/types/appearance.d.ts
|
|
17
9
|
declare global {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
10
|
+
interface ClerkAppearanceRegistry {
|
|
11
|
+
theme: Theme;
|
|
12
|
+
}
|
|
21
13
|
}
|
|
22
|
-
|
|
14
|
+
//#endregion
|
|
15
|
+
//#region ../ui/register/index.d.ts
|
|
16
|
+
declare global {
|
|
17
|
+
var __clerkSharedModules: {
|
|
18
|
+
react: typeof import('react');
|
|
19
|
+
'react-dom': typeof import('react-dom');
|
|
20
|
+
'react-dom/client': typeof import('react-dom/client');
|
|
21
|
+
'react/jsx-runtime': typeof import('react/jsx-runtime');
|
|
22
|
+
} | undefined;
|
|
23
|
+
}
|
|
24
|
+
//#endregion
|
|
25
|
+
//#region src/components/uiComponents.d.ts
|
|
23
26
|
type FallbackProp = {
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
27
|
+
/**
|
|
28
|
+
* The element to render while the component is mounting.
|
|
29
|
+
*/
|
|
30
|
+
fallback?: ReactNode;
|
|
28
31
|
};
|
|
29
32
|
type UserProfileExportType = typeof _UserProfile & {
|
|
30
|
-
|
|
31
|
-
|
|
33
|
+
Page: typeof UserProfilePage;
|
|
34
|
+
Link: typeof UserProfileLink;
|
|
32
35
|
};
|
|
33
36
|
type UserButtonExportType = typeof _UserButton & {
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
37
|
+
UserProfilePage: typeof UserProfilePage;
|
|
38
|
+
UserProfileLink: typeof UserProfileLink;
|
|
39
|
+
MenuItems: typeof MenuItems;
|
|
40
|
+
Action: typeof MenuAction;
|
|
41
|
+
Link: typeof MenuLink;
|
|
42
|
+
/**
|
|
43
|
+
* The `<Outlet />` component can be used in conjunction with `asProvider` in order to control rendering
|
|
44
|
+
* of the `<UserButton />` without affecting its configuration or any custom pages that could be mounted
|
|
45
|
+
* @experimental This API is experimental and may change at any moment.
|
|
46
|
+
*/
|
|
47
|
+
__experimental_Outlet: typeof UserButtonOutlet;
|
|
45
48
|
};
|
|
46
49
|
type UserButtonPropsWithoutCustomPages = Without<UserButtonProps, 'userProfileProps' | '__experimental_asStandalone'> & {
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
50
|
+
userProfileProps?: Pick<UserProfileProps, 'additionalOAuthScopes' | 'appearance' | 'apiKeysProps'>;
|
|
51
|
+
/**
|
|
52
|
+
* Adding `asProvider` will defer rendering until the `<Outlet />` component is mounted.
|
|
53
|
+
*
|
|
54
|
+
* @experimental This API is experimental and may change at any moment.
|
|
55
|
+
* @default undefined
|
|
56
|
+
*/
|
|
57
|
+
__experimental_asProvider?: boolean;
|
|
55
58
|
};
|
|
56
59
|
type OrganizationProfileExportType = typeof _OrganizationProfile & {
|
|
57
|
-
|
|
58
|
-
|
|
60
|
+
Page: typeof OrganizationProfilePage;
|
|
61
|
+
Link: typeof OrganizationProfileLink;
|
|
59
62
|
};
|
|
60
63
|
type OrganizationSwitcherExportType = typeof _OrganizationSwitcher & {
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
64
|
+
OrganizationProfilePage: typeof OrganizationProfilePage;
|
|
65
|
+
OrganizationProfileLink: typeof OrganizationProfileLink;
|
|
66
|
+
/**
|
|
67
|
+
* The `<Outlet />` component can be used in conjunction with `asProvider` in order to control rendering
|
|
68
|
+
* of the `<OrganizationSwitcher />` without affecting its configuration or any custom pages that could be mounted
|
|
69
|
+
*
|
|
70
|
+
* @experimental This API is experimental and may change at any moment.
|
|
71
|
+
*/
|
|
72
|
+
__experimental_Outlet: typeof OrganizationSwitcherOutlet;
|
|
70
73
|
};
|
|
71
74
|
type OrganizationSwitcherPropsWithoutCustomPages = Without<OrganizationSwitcherProps, 'organizationProfileProps' | '__experimental_asStandalone'> & {
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
75
|
+
organizationProfileProps?: Pick<OrganizationProfileProps, 'appearance'>;
|
|
76
|
+
/**
|
|
77
|
+
* Adding `asProvider` will defer rendering until the `<Outlet />` component is mounted.
|
|
78
|
+
*
|
|
79
|
+
* @experimental This API is experimental and may change at any moment.
|
|
80
|
+
* @default undefined
|
|
81
|
+
*/
|
|
82
|
+
__experimental_asProvider?: boolean;
|
|
80
83
|
};
|
|
81
84
|
declare const SignIn: {
|
|
82
|
-
|
|
83
|
-
|
|
85
|
+
(props: Without<WithClerkProp<SignInProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
86
|
+
displayName: string;
|
|
84
87
|
};
|
|
85
88
|
declare const SignUp: {
|
|
86
|
-
|
|
87
|
-
|
|
89
|
+
(props: Without<WithClerkProp<SignUpProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
90
|
+
displayName: string;
|
|
88
91
|
};
|
|
89
|
-
declare function UserProfilePage({
|
|
90
|
-
|
|
92
|
+
declare function UserProfilePage({
|
|
93
|
+
children
|
|
94
|
+
}: PropsWithChildren<UserProfilePageProps>): React.JSX.Element;
|
|
95
|
+
declare function UserProfileLink({
|
|
96
|
+
children
|
|
97
|
+
}: PropsWithChildren<UserProfileLinkProps>): React.JSX.Element;
|
|
91
98
|
declare const _UserProfile: {
|
|
92
|
-
|
|
93
|
-
|
|
99
|
+
(props: Without<WithClerkProp<PropsWithChildren<Without<UserProfileProps, "customPages">> & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
100
|
+
displayName: string;
|
|
94
101
|
};
|
|
95
102
|
declare const UserProfile: UserProfileExportType;
|
|
96
103
|
declare const _UserButton: {
|
|
97
|
-
|
|
98
|
-
|
|
104
|
+
(props: Without<WithClerkProp<PropsWithChildren<UserButtonPropsWithoutCustomPages> & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
105
|
+
displayName: string;
|
|
99
106
|
};
|
|
100
|
-
declare function MenuItems({
|
|
101
|
-
|
|
102
|
-
|
|
107
|
+
declare function MenuItems({
|
|
108
|
+
children
|
|
109
|
+
}: PropsWithChildren): React.JSX.Element;
|
|
110
|
+
declare function MenuAction({
|
|
111
|
+
children
|
|
112
|
+
}: PropsWithChildren<UserButtonActionProps>): React.JSX.Element;
|
|
113
|
+
declare function MenuLink({
|
|
114
|
+
children
|
|
115
|
+
}: PropsWithChildren<UserButtonLinkProps>): React.JSX.Element;
|
|
103
116
|
declare function UserButtonOutlet(outletProps: Without<UserButtonProps, 'userProfileProps'>): React.JSX.Element;
|
|
104
117
|
declare const UserButton: UserButtonExportType;
|
|
105
|
-
declare function OrganizationProfilePage({
|
|
106
|
-
|
|
118
|
+
declare function OrganizationProfilePage({
|
|
119
|
+
children
|
|
120
|
+
}: PropsWithChildren<OrganizationProfilePageProps>): React.JSX.Element;
|
|
121
|
+
declare function OrganizationProfileLink({
|
|
122
|
+
children
|
|
123
|
+
}: PropsWithChildren<OrganizationProfileLinkProps>): React.JSX.Element;
|
|
107
124
|
declare const _OrganizationProfile: {
|
|
108
|
-
|
|
109
|
-
|
|
125
|
+
(props: Without<WithClerkProp<PropsWithChildren<Without<OrganizationProfileProps, "customPages">> & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
126
|
+
displayName: string;
|
|
110
127
|
};
|
|
111
128
|
declare const OrganizationProfile: OrganizationProfileExportType;
|
|
112
129
|
declare const CreateOrganization: {
|
|
113
|
-
|
|
114
|
-
|
|
130
|
+
(props: Without<WithClerkProp<CreateOrganizationProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
131
|
+
displayName: string;
|
|
115
132
|
};
|
|
116
133
|
declare const _OrganizationSwitcher: {
|
|
117
|
-
|
|
118
|
-
|
|
134
|
+
(props: Without<WithClerkProp<PropsWithChildren<OrganizationSwitcherPropsWithoutCustomPages> & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
135
|
+
displayName: string;
|
|
119
136
|
};
|
|
120
137
|
declare function OrganizationSwitcherOutlet(outletProps: Without<OrganizationSwitcherProps, 'organizationProfileProps'>): React.JSX.Element;
|
|
121
138
|
declare const OrganizationSwitcher: OrganizationSwitcherExportType;
|
|
122
139
|
declare const OrganizationList: {
|
|
123
|
-
|
|
124
|
-
|
|
140
|
+
(props: Without<WithClerkProp<OrganizationListProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
141
|
+
displayName: string;
|
|
125
142
|
};
|
|
126
143
|
declare const GoogleOneTap: {
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
144
|
+
(props: Without<WithClerkProp<import("@clerk/shared/types").SignInForceRedirectUrl & import("@clerk/shared/types").SignUpForceRedirectUrl & {
|
|
145
|
+
cancelOnTapOutside?: boolean;
|
|
146
|
+
itpSupport?: boolean;
|
|
147
|
+
fedCmSupport?: boolean;
|
|
148
|
+
appearance?: import("@clerk/shared/types").ClerkAppearanceTheme;
|
|
149
|
+
} & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
150
|
+
displayName: string;
|
|
134
151
|
};
|
|
135
152
|
declare const Waitlist: {
|
|
136
|
-
|
|
137
|
-
|
|
153
|
+
(props: Without<WithClerkProp<WaitlistProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
154
|
+
displayName: string;
|
|
138
155
|
};
|
|
139
156
|
declare const PricingTable: {
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
157
|
+
(props: Without<WithClerkProp<{
|
|
158
|
+
highlightedPlan?: string;
|
|
159
|
+
for?: import("@clerk/shared/types").ForPayerType;
|
|
160
|
+
appearance?: import("@clerk/shared/types").ClerkAppearanceTheme;
|
|
161
|
+
checkoutProps?: Pick<import("@clerk/shared/types").__internal_CheckoutProps, "appearance">;
|
|
162
|
+
} & {
|
|
163
|
+
ctaPosition?: "top" | "bottom";
|
|
164
|
+
collapseFeatures?: boolean;
|
|
165
|
+
newSubscriptionRedirectUrl?: string;
|
|
166
|
+
} & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
167
|
+
displayName: string;
|
|
151
168
|
};
|
|
152
169
|
/**
|
|
153
170
|
* @experimental This component is in early access and may change in future releases.
|
|
154
171
|
*/
|
|
155
172
|
declare const APIKeys: {
|
|
156
|
-
|
|
157
|
-
|
|
173
|
+
(props: Without<WithClerkProp<APIKeysProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
174
|
+
displayName: string;
|
|
158
175
|
};
|
|
159
176
|
declare const OAuthConsent: {
|
|
160
|
-
|
|
161
|
-
|
|
177
|
+
(props: Without<WithClerkProp<import("@clerk/shared/types").OAuthConsentProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
178
|
+
displayName: string;
|
|
162
179
|
};
|
|
163
180
|
declare const UserAvatar: {
|
|
164
|
-
|
|
165
|
-
|
|
181
|
+
(props: Without<WithClerkProp<UserAvatarProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
182
|
+
displayName: string;
|
|
166
183
|
};
|
|
167
184
|
declare const TaskChooseOrganization: {
|
|
168
|
-
|
|
169
|
-
|
|
185
|
+
(props: Without<WithClerkProp<TaskChooseOrganizationProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
186
|
+
displayName: string;
|
|
170
187
|
};
|
|
171
188
|
declare const TaskResetPassword: {
|
|
172
|
-
|
|
173
|
-
|
|
189
|
+
(props: Without<WithClerkProp<TaskResetPasswordProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
190
|
+
displayName: string;
|
|
174
191
|
};
|
|
175
192
|
declare const TaskSetupMFA: {
|
|
176
|
-
|
|
177
|
-
|
|
193
|
+
(props: Without<WithClerkProp<TaskSetupMFAProps & FallbackProp>, "clerk">): React.JSX.Element | null;
|
|
194
|
+
displayName: string;
|
|
178
195
|
};
|
|
179
|
-
|
|
196
|
+
//#endregion
|
|
197
|
+
//#region src/components/SignInButton.d.ts
|
|
180
198
|
declare const SignInButton: {
|
|
181
|
-
|
|
182
|
-
|
|
199
|
+
(props: import("@clerk/shared/types").Without<WithClerkProp<React.PropsWithChildren<SignInButtonProps>>, "clerk">): React.JSX.Element | null;
|
|
200
|
+
displayName: string;
|
|
183
201
|
};
|
|
184
|
-
|
|
202
|
+
//#endregion
|
|
203
|
+
//#region src/components/SignInWithMetamaskButton.d.ts
|
|
185
204
|
declare const SignInWithMetamaskButton: {
|
|
186
|
-
|
|
187
|
-
|
|
205
|
+
(props: import("@clerk/shared/_chunks/index-Cr_OtBLq").Xm<WithClerkProp<SignInWithMetamaskButtonProps>, "clerk">): React.JSX.Element | null;
|
|
206
|
+
displayName: string;
|
|
188
207
|
};
|
|
189
|
-
|
|
208
|
+
//#endregion
|
|
209
|
+
//#region src/components/SignOutButton.d.ts
|
|
190
210
|
type SignOutButtonProps = {
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
211
|
+
redirectUrl?: string;
|
|
212
|
+
sessionId?: string;
|
|
213
|
+
/**
|
|
214
|
+
* @deprecated Use the `redirectUrl` and `sessionId` props directly instead.
|
|
215
|
+
*/
|
|
216
|
+
signOutOptions?: SignOutOptions;
|
|
217
|
+
children?: React.ReactNode;
|
|
198
218
|
};
|
|
199
219
|
declare const SignOutButton: {
|
|
200
|
-
|
|
201
|
-
|
|
220
|
+
(props: import("@clerk/shared/types").Without<React.PropsWithChildren<WithClerkProp<SignOutButtonProps>>, "clerk">): React.JSX.Element | null;
|
|
221
|
+
displayName: string;
|
|
202
222
|
};
|
|
203
|
-
|
|
223
|
+
//#endregion
|
|
224
|
+
//#region src/components/SignUpButton.d.ts
|
|
204
225
|
declare const SignUpButton: {
|
|
205
|
-
|
|
206
|
-
|
|
226
|
+
(props: import("@clerk/shared/types").Without<WithClerkProp<React.PropsWithChildren<SignUpButtonProps>>, "clerk">): React.JSX.Element | null;
|
|
227
|
+
displayName: string;
|
|
207
228
|
};
|
|
208
|
-
|
|
229
|
+
//#endregion
|
|
230
|
+
//#region src/components/HandleSSOCallback.d.ts
|
|
209
231
|
interface HandleSSOCallbackProps {
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
232
|
+
/**
|
|
233
|
+
* Called when the SSO callback is complete and a session has been created.
|
|
234
|
+
*/
|
|
235
|
+
navigateToApp: (...params: Parameters<SetActiveNavigate>) => void;
|
|
236
|
+
/**
|
|
237
|
+
* Called when a sign-in requires additional verification, or a sign-up is transfered to a sign-in that requires
|
|
238
|
+
* additional verification.
|
|
239
|
+
*/
|
|
240
|
+
navigateToSignIn: () => void;
|
|
241
|
+
/**
|
|
242
|
+
* Called when a sign-in is transfered to a sign-up that requires additional verification.
|
|
243
|
+
*/
|
|
244
|
+
navigateToSignUp: () => void;
|
|
223
245
|
}
|
|
224
246
|
/**
|
|
225
247
|
* Use this component when building custom UI to handle the SSO callback and navigate to the appropriate page based on
|
|
@@ -266,19 +288,22 @@ interface HandleSSOCallbackProps {
|
|
|
266
288
|
* ```
|
|
267
289
|
*/
|
|
268
290
|
declare function HandleSSOCallback(props: HandleSSOCallbackProps): ReactNode;
|
|
269
|
-
|
|
291
|
+
//#endregion
|
|
292
|
+
//#region src/contexts/ClerkProvider.d.ts
|
|
270
293
|
declare function ClerkProviderBase<TUi extends Ui>(props: ClerkProviderProps<TUi>): React.JSX.Element;
|
|
271
294
|
declare const ClerkProvider: typeof ClerkProviderBase & {
|
|
272
|
-
|
|
295
|
+
displayName: string;
|
|
273
296
|
};
|
|
274
|
-
|
|
297
|
+
//#endregion
|
|
298
|
+
//#region src/hooks/useEmailLink.d.ts
|
|
275
299
|
type UseEmailLinkSignInReturn = CreateEmailLinkFlowReturn<SignInStartEmailLinkFlowParams, SignInResource>;
|
|
276
300
|
type UseEmailLinkSignUpReturn = CreateEmailLinkFlowReturn<StartEmailLinkFlowParams, SignUpResource>;
|
|
277
301
|
type UseEmailLinkEmailAddressReturn = CreateEmailLinkFlowReturn<StartEmailLinkFlowParams, EmailAddressResource>;
|
|
278
302
|
declare function useEmailLink(resource: SignInResource): UseEmailLinkSignInReturn;
|
|
279
303
|
declare function useEmailLink(resource: SignUpResource): UseEmailLinkSignUpReturn;
|
|
280
304
|
declare function useEmailLink(resource: EmailAddressResource): UseEmailLinkEmailAddressReturn;
|
|
281
|
-
|
|
305
|
+
//#endregion
|
|
306
|
+
//#region src/hooks/useClerkSignal.d.ts
|
|
282
307
|
/**
|
|
283
308
|
* This hook allows you to access the Signal-based `SignIn` resource.
|
|
284
309
|
*
|
|
@@ -315,5 +340,6 @@ declare const useSignUp: () => SignUpSignalValue;
|
|
|
315
340
|
* }
|
|
316
341
|
*/
|
|
317
342
|
declare function useWaitlist(): WaitlistSignalValue;
|
|
318
|
-
|
|
319
|
-
export { APIKeys, ClerkProvider, ClerkProviderProps, CreateOrganization, GoogleOneTap, HandleSSOCallback, OAuthConsent, OrganizationList, OrganizationProfile, OrganizationSwitcher, PricingTable, SignIn, SignInButton, SignInWithMetamaskButton, SignOutButton, SignUp, SignUpButton, TaskChooseOrganization, TaskResetPassword, TaskSetupMFA, UserAvatar, UserButton, UserProfile, Waitlist, useEmailLink, useSignIn, useSignUp, useWaitlist };
|
|
343
|
+
//#endregion
|
|
344
|
+
export { APIKeys, AuthenticateWithRedirectCallback, type BrowserClerk, type BrowserClerkConstructor, ClerkDegraded, ClerkFailed, ClerkLoaded, ClerkLoading, type ClerkProp, ClerkProvider, type ClerkProviderProps, CreateOrganization, GoogleOneTap, HandleSSOCallback, type HeadlessBrowserClerk, type HeadlessBrowserClerkConstructor, type IsomorphicClerkOptions, OAuthConsent, OrganizationList, OrganizationProfile, OrganizationSwitcher, PricingTable, RedirectToCreateOrganization, RedirectToOrganizationProfile, RedirectToSignIn, RedirectToSignUp, RedirectToTasks, RedirectToUserProfile, Show, type ShowProps, SignIn, SignInButton, SignInWithMetamaskButton, SignOutButton, SignUp, SignUpButton, TaskChooseOrganization, TaskResetPassword, TaskSetupMFA, UNSAFE_PortalProvider, UserAvatar, UserButton, UserProfile, Waitlist, __experimental_CheckoutProvider, __experimental_PaymentElement, __experimental_PaymentElementProvider, __experimental_useCheckout, __experimental_usePaymentElement, getToken, useAPIKeys, useAuth, useClerk, useEmailLink, useOAuthConsent, useOrganization, useOrganizationCreationDefaults, useOrganizationList, useReverification, useSession, useSessionList, useSignIn, useSignUp, useUser, useWaitlist };
|
|
345
|
+
//# sourceMappingURL=index.d.mts.map
|