@clerk/shared 4.32.0-snapshot.v20260904162929 → 4.32.0
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/_chunks/{error-C-B61RHn.js → error-CdWUgmMd.js} +4 -4
- package/dist/_chunks/error-CdWUgmMd.js.map +1 -0
- package/dist/_chunks/{error-CYyD2kei.mjs → error-wrUdW78M.mjs} +4 -4
- package/dist/_chunks/error-wrUdW78M.mjs.map +1 -0
- package/dist/error.js +1 -1
- package/dist/error.mjs +1 -1
- package/dist/errors/errorThrower.d.mts +3 -3
- package/dist/errors/errorThrower.d.ts +3 -3
- package/dist/errors/errorThrower.js +3 -3
- package/dist/internal/clerk-js/componentGuards.d.mts +2 -1
- package/dist/internal/clerk-js/componentGuards.d.ts +2 -1
- package/dist/internal/clerk-js/componentGuards.js +4 -0
- package/dist/internal/clerk-js/componentGuards.js.map +1 -1
- package/dist/internal/clerk-js/componentGuards.mjs +4 -1
- package/dist/internal/clerk-js/componentGuards.mjs.map +1 -1
- package/dist/internal/clerk-js/passkeys.js +1 -1
- package/dist/internal/clerk-js/passkeys.mjs +1 -1
- package/dist/internal/clerk-js/protectCheck.js +1 -1
- package/dist/internal/clerk-js/protectCheck.mjs +1 -1
- package/dist/internal/clerk-js/warnings.d.mts +3 -2
- package/dist/internal/clerk-js/warnings.d.ts +3 -2
- package/dist/internal/clerk-js/warnings.js +2 -1
- package/dist/internal/clerk-js/warnings.js.map +1 -1
- package/dist/internal/clerk-js/warnings.mjs +2 -1
- package/dist/internal/clerk-js/warnings.mjs.map +1 -1
- package/dist/internal/clerk-js/web3.js +1 -1
- package/dist/internal/clerk-js/web3.mjs +1 -1
- package/dist/keys.d.mts +1 -6
- package/dist/keys.d.ts +1 -6
- package/dist/keys.js +2 -8
- package/dist/keys.js.map +1 -1
- package/dist/keys.mjs +3 -8
- package/dist/keys.mjs.map +1 -1
- package/dist/loadClerkJsScript.js +2 -2
- package/dist/loadClerkJsScript.js.map +1 -1
- package/dist/loadClerkJsScript.mjs +2 -2
- package/dist/loadClerkJsScript.mjs.map +1 -1
- package/dist/react/hooks/index.d.mts +2 -0
- package/dist/react/hooks/index.d.ts +2 -0
- package/dist/react/hooks/index.js +2 -0
- package/dist/react/hooks/useClerk.d.mts +1 -1
- package/dist/react/hooks/useClerk.d.ts +1 -1
- package/dist/react/hooks/useClerk.js +1 -1
- package/dist/react/hooks/useOAuthDeviceVerification.types.d.mts +31 -2
- package/dist/react/hooks/useOAuthDeviceVerification.types.d.ts +31 -2
- package/dist/react/hooks/useOrganization.d.mts +1 -1
- package/dist/react/hooks/useOrganization.d.ts +1 -1
- package/dist/react/hooks/useOrganizationDirectorySync.d.mts +27 -0
- package/dist/react/hooks/useOrganizationDirectorySync.d.ts +27 -0
- package/dist/react/hooks/useOrganizationDirectorySync.js +89 -0
- package/dist/react/hooks/useOrganizationDirectorySync.shared.js +49 -0
- package/dist/react/hooks/useOrganizationDirectorySyncUsers.d.mts +53 -0
- package/dist/react/hooks/useOrganizationDirectorySyncUsers.d.ts +53 -0
- package/dist/react/hooks/useOrganizationDirectorySyncUsers.js +71 -0
- package/dist/react/hooks/useOrganizationEnterpriseConnectionTestRuns.js +7 -5
- package/dist/react/hooks/useOrganizationList.d.mts +1 -1
- package/dist/react/hooks/useOrganizationList.d.ts +1 -1
- package/dist/react/hooks/useReverification.d.mts +1 -1
- package/dist/react/hooks/useReverification.d.ts +1 -1
- package/dist/react/index.d.mts +3 -1
- package/dist/react/index.d.ts +3 -1
- package/dist/react/index.js +199 -8
- package/dist/react/index.js.map +1 -1
- package/dist/react/index.mjs +198 -9
- package/dist/react/index.mjs.map +1 -1
- package/dist/react/stable-keys.js +5 -1
- package/dist/types/billing.d.mts +1 -1
- package/dist/types/billing.d.ts +1 -1
- package/dist/types/clerk.d.mts +19 -3
- package/dist/types/clerk.d.ts +19 -3
- package/dist/types/directorySync.d.mts +123 -0
- package/dist/types/directorySync.d.ts +123 -0
- package/dist/types/elementIds.d.mts +2 -2
- package/dist/types/elementIds.d.ts +2 -2
- package/dist/types/hooks.d.mts +11 -11
- package/dist/types/hooks.d.ts +11 -11
- package/dist/types/index.d.mts +2 -1
- package/dist/types/index.d.ts +2 -1
- package/dist/types/localization.d.mts +108 -0
- package/dist/types/localization.d.ts +108 -0
- package/dist/types/oauthApplication.d.mts +76 -3
- package/dist/types/oauthApplication.d.ts +76 -3
- package/dist/types/organization.d.mts +11 -1
- package/dist/types/organization.d.ts +11 -1
- package/dist/types/organizationDomain.d.mts +3 -3
- package/dist/types/organizationDomain.d.ts +3 -3
- package/dist/types/signIn.d.mts +2 -0
- package/dist/types/signIn.d.ts +2 -0
- package/dist/types/signInFuture.d.mts +19 -7
- package/dist/types/signInFuture.d.ts +19 -7
- package/dist/types/signUpFuture.d.mts +5 -5
- package/dist/types/signUpFuture.d.ts +5 -5
- package/dist/types/user.d.mts +1 -1
- package/dist/types/user.d.ts +1 -1
- package/dist/types/userSettings.d.mts +2 -1
- package/dist/types/userSettings.d.ts +2 -1
- package/dist/versionSelector.js +1 -1
- package/dist/versionSelector.js.map +1 -1
- package/dist/versionSelector.mjs +1 -1
- package/dist/versionSelector.mjs.map +1 -1
- package/package.json +2 -2
- package/dist/_chunks/error-C-B61RHn.js.map +0 -1
- package/dist/_chunks/error-CYyD2kei.mjs.map +0 -1
|
@@ -96,27 +96,78 @@ type OAuthConsentInfo = {
|
|
|
96
96
|
*/
|
|
97
97
|
scopes: OAuthConsentScope[];
|
|
98
98
|
};
|
|
99
|
-
|
|
99
|
+
/**
|
|
100
|
+
* The current status of an OAuth device authorization.
|
|
101
|
+
*
|
|
102
|
+
* @inline
|
|
103
|
+
*/
|
|
104
|
+
type OAuthDeviceVerificationStatus =
|
|
105
|
+
/**
|
|
106
|
+
* The device authorization is awaiting approval or denial.
|
|
107
|
+
*/
|
|
108
|
+
'pending'
|
|
109
|
+
/**
|
|
110
|
+
* The device authorization was approved.
|
|
111
|
+
*/
|
|
112
|
+
| 'approved'
|
|
113
|
+
/**
|
|
114
|
+
* The device authorization was denied.
|
|
115
|
+
*/
|
|
116
|
+
| 'denied'
|
|
117
|
+
/**
|
|
118
|
+
* The approved device authorization has already been used by the device.
|
|
119
|
+
*/
|
|
120
|
+
| 'consumed';
|
|
100
121
|
/**
|
|
101
122
|
* A scope requested by an OAuth device authorization.
|
|
123
|
+
*
|
|
124
|
+
* @interface
|
|
102
125
|
*/
|
|
103
126
|
type OAuthDeviceVerificationScope = OAuthConsentScope;
|
|
104
127
|
/**
|
|
105
|
-
* Information about an OAuth device authorization
|
|
128
|
+
* Information about an OAuth device authorization.
|
|
129
|
+
*
|
|
130
|
+
* @interface
|
|
106
131
|
*/
|
|
107
132
|
type OAuthDeviceVerificationInfo = {
|
|
133
|
+
/**
|
|
134
|
+
* The display name of the OAuth application requesting authorization.
|
|
135
|
+
*/
|
|
108
136
|
oauthApplicationName: string;
|
|
137
|
+
/**
|
|
138
|
+
* The URL of the OAuth application's logo image, or `null` if no logo is available.
|
|
139
|
+
*/
|
|
109
140
|
oauthApplicationLogoUrl: string | null;
|
|
141
|
+
/**
|
|
142
|
+
* The OAuth `client_id` that identifies the application requesting authorization.
|
|
143
|
+
*/
|
|
110
144
|
clientId: string;
|
|
145
|
+
/**
|
|
146
|
+
* The scopes the OAuth application is requesting.
|
|
147
|
+
*/
|
|
111
148
|
scopes: OAuthDeviceVerificationScope[];
|
|
112
|
-
|
|
149
|
+
/**
|
|
150
|
+
* The current status of the device authorization.
|
|
151
|
+
*/
|
|
152
|
+
status: OAuthDeviceVerificationStatus;
|
|
153
|
+
/**
|
|
154
|
+
* The expiration time of the device authorization, as a Unix timestamp in milliseconds.
|
|
155
|
+
*/
|
|
113
156
|
expiresAt: number;
|
|
114
157
|
};
|
|
115
158
|
/**
|
|
116
159
|
* The result of approving or denying an OAuth device authorization.
|
|
160
|
+
*
|
|
161
|
+
* @interface
|
|
117
162
|
*/
|
|
118
163
|
type OAuthDeviceVerificationResult = {
|
|
164
|
+
/**
|
|
165
|
+
* The type of the resource.
|
|
166
|
+
*/
|
|
119
167
|
object: 'oauth_device_verification';
|
|
168
|
+
/**
|
|
169
|
+
* The final decision for the device authorization.
|
|
170
|
+
*/
|
|
120
171
|
status: Extract<OAuthDeviceVerificationStatus, 'approved' | 'denied'>;
|
|
121
172
|
};
|
|
122
173
|
type GetOAuthConsentInfoParams = {
|
|
@@ -124,12 +175,34 @@ type GetOAuthConsentInfoParams = {
|
|
|
124
175
|
scope?: string; /** The redirect URI from the authorize request. When provided, the backend returns a PSL-resolved `redirectDomain`. */
|
|
125
176
|
redirectUri?: string;
|
|
126
177
|
};
|
|
178
|
+
/**
|
|
179
|
+
* The parameters for looking up an OAuth device authorization.
|
|
180
|
+
*
|
|
181
|
+
* @interface
|
|
182
|
+
*/
|
|
127
183
|
type LookupOAuthDeviceVerificationParams = {
|
|
184
|
+
/**
|
|
185
|
+
* The user code displayed by the device requesting authorization.
|
|
186
|
+
*/
|
|
128
187
|
userCode: string;
|
|
129
188
|
};
|
|
189
|
+
/**
|
|
190
|
+
* The parameters for approving or denying an OAuth device authorization.
|
|
191
|
+
*
|
|
192
|
+
* @interface
|
|
193
|
+
*/
|
|
130
194
|
type SubmitOAuthDeviceVerificationParams = {
|
|
195
|
+
/**
|
|
196
|
+
* The user code displayed by the device requesting authorization.
|
|
197
|
+
*/
|
|
131
198
|
userCode: string;
|
|
199
|
+
/**
|
|
200
|
+
* Whether to approve or deny the authorization request.
|
|
201
|
+
*/
|
|
132
202
|
approved: boolean;
|
|
203
|
+
/**
|
|
204
|
+
* The ID of the Organization to authorize the request for. Omit this to authorize the request for the user's personal account.
|
|
205
|
+
*/
|
|
133
206
|
organizationId?: string;
|
|
134
207
|
};
|
|
135
208
|
/**
|
|
@@ -4,6 +4,7 @@ import { ClerkResource } from "./resource.mjs";
|
|
|
4
4
|
import { BillingPayerMethods } from "./billing.mjs";
|
|
5
5
|
import { CreateOrganizationDomainParams, OrganizationDomainResource, OrganizationDomainsBulkOwnershipVerificationResource, OrganizationEnrollmentMode } from "./organizationDomain.mjs";
|
|
6
6
|
import { OrganizationJSONSnapshot } from "./snapshots.mjs";
|
|
7
|
+
import { CreateDirectorySyncParams, DirectorySyncResource } from "./directorySync.mjs";
|
|
7
8
|
import { CreateOrganizationEnterpriseConnectionParams, EnterpriseConnectionResource, UpdateOrganizationEnterpriseConnectionParams } from "./enterpriseConnection.mjs";
|
|
8
9
|
import { EnterpriseConnectionTestRunInitResource, EnterpriseConnectionTestRunResource, GetEnterpriseConnectionTestRunsParams } from "./enterpriseConnectionTestRun.mjs";
|
|
9
10
|
import { OrganizationInvitationResource, OrganizationInvitationStatus } from "./organizationInvitation.mjs";
|
|
@@ -171,7 +172,7 @@ interface OrganizationResource extends ClerkResource, BillingPayerMethods {
|
|
|
171
172
|
*/
|
|
172
173
|
prepareOwnershipVerification: (domainIds: string[]) => Promise<OrganizationDomainsBulkOwnershipVerificationResource>;
|
|
173
174
|
/**
|
|
174
|
-
* Completes the verification process started by [`prepareOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#
|
|
175
|
+
* Completes the verification process started by [`prepareOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#prepareownershipverification), by resolving the published TXT record for each of the given domains in a single request. A single bad domain does not fail the batch; it lands in the returned [`OrganizationDomainsBulkOwnershipVerificationResource`](https://clerk.com/docs/reference/types/organization-domains-bulk-ownership-verification-resource) object's `errors` array.
|
|
175
176
|
* @returns An [`OrganizationDomainsBulkOwnershipVerificationResource`](https://clerk.com/docs/reference/types/organization-domains-bulk-ownership-verification-resource) object.
|
|
176
177
|
* @param domainIds - The unique identifiers of the domains to attempt.
|
|
177
178
|
*/
|
|
@@ -195,6 +196,15 @@ interface OrganizationResource extends ClerkResource, BillingPayerMethods {
|
|
|
195
196
|
deleteEnterpriseConnection: (enterpriseConnectionId: string) => Promise<DeletedObjectResource>;
|
|
196
197
|
createEnterpriseConnectionTestRun: (enterpriseConnectionId: string) => Promise<EnterpriseConnectionTestRunInitResource>;
|
|
197
198
|
getEnterpriseConnectionTestRuns: (enterpriseConnectionId: string, params?: GetEnterpriseConnectionTestRunsParams) => Promise<ClerkPaginatedResponse<EnterpriseConnectionTestRunResource>>;
|
|
199
|
+
/**
|
|
200
|
+
* Gets the Directory Sync directory bound to the given enterprise connection.
|
|
201
|
+
*/
|
|
202
|
+
getDirectorySync: (enterpriseConnectionId: string) => Promise<DirectorySyncResource>;
|
|
203
|
+
/**
|
|
204
|
+
* Provisions Directory Sync for the given enterprise connection. The returned resource is the only place the SCIM
|
|
205
|
+
* bearer token (`apiKey`) is ever available; rotate it to obtain a new one.
|
|
206
|
+
*/
|
|
207
|
+
createDirectorySync: (enterpriseConnectionId: string, params?: CreateDirectorySyncParams) => Promise<DirectorySyncResource>;
|
|
198
208
|
/**
|
|
199
209
|
* Deletes the Organization. Only administrators can delete an Organization.
|
|
200
210
|
*
|
|
@@ -4,6 +4,7 @@ import { ClerkResource } from "./resource.js";
|
|
|
4
4
|
import { BillingPayerMethods } from "./billing.js";
|
|
5
5
|
import { CreateOrganizationDomainParams, OrganizationDomainResource, OrganizationDomainsBulkOwnershipVerificationResource, OrganizationEnrollmentMode } from "./organizationDomain.js";
|
|
6
6
|
import { OrganizationJSONSnapshot } from "./snapshots.js";
|
|
7
|
+
import { CreateDirectorySyncParams, DirectorySyncResource } from "./directorySync.js";
|
|
7
8
|
import { CreateOrganizationEnterpriseConnectionParams, EnterpriseConnectionResource, UpdateOrganizationEnterpriseConnectionParams } from "./enterpriseConnection.js";
|
|
8
9
|
import { EnterpriseConnectionTestRunInitResource, EnterpriseConnectionTestRunResource, GetEnterpriseConnectionTestRunsParams } from "./enterpriseConnectionTestRun.js";
|
|
9
10
|
import { OrganizationInvitationResource, OrganizationInvitationStatus } from "./organizationInvitation.js";
|
|
@@ -171,7 +172,7 @@ interface OrganizationResource extends ClerkResource, BillingPayerMethods {
|
|
|
171
172
|
*/
|
|
172
173
|
prepareOwnershipVerification: (domainIds: string[]) => Promise<OrganizationDomainsBulkOwnershipVerificationResource>;
|
|
173
174
|
/**
|
|
174
|
-
* Completes the verification process started by [`prepareOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#
|
|
175
|
+
* Completes the verification process started by [`prepareOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#prepareownershipverification), by resolving the published TXT record for each of the given domains in a single request. A single bad domain does not fail the batch; it lands in the returned [`OrganizationDomainsBulkOwnershipVerificationResource`](https://clerk.com/docs/reference/types/organization-domains-bulk-ownership-verification-resource) object's `errors` array.
|
|
175
176
|
* @returns An [`OrganizationDomainsBulkOwnershipVerificationResource`](https://clerk.com/docs/reference/types/organization-domains-bulk-ownership-verification-resource) object.
|
|
176
177
|
* @param domainIds - The unique identifiers of the domains to attempt.
|
|
177
178
|
*/
|
|
@@ -195,6 +196,15 @@ interface OrganizationResource extends ClerkResource, BillingPayerMethods {
|
|
|
195
196
|
deleteEnterpriseConnection: (enterpriseConnectionId: string) => Promise<DeletedObjectResource>;
|
|
196
197
|
createEnterpriseConnectionTestRun: (enterpriseConnectionId: string) => Promise<EnterpriseConnectionTestRunInitResource>;
|
|
197
198
|
getEnterpriseConnectionTestRuns: (enterpriseConnectionId: string, params?: GetEnterpriseConnectionTestRunsParams) => Promise<ClerkPaginatedResponse<EnterpriseConnectionTestRunResource>>;
|
|
199
|
+
/**
|
|
200
|
+
* Gets the Directory Sync directory bound to the given enterprise connection.
|
|
201
|
+
*/
|
|
202
|
+
getDirectorySync: (enterpriseConnectionId: string) => Promise<DirectorySyncResource>;
|
|
203
|
+
/**
|
|
204
|
+
* Provisions Directory Sync for the given enterprise connection. The returned resource is the only place the SCIM
|
|
205
|
+
* bearer token (`apiKey`) is ever available; rotate it to obtain a new one.
|
|
206
|
+
*/
|
|
207
|
+
createDirectorySync: (enterpriseConnectionId: string, params?: CreateDirectorySyncParams) => Promise<DirectorySyncResource>;
|
|
198
208
|
/**
|
|
199
209
|
* Deletes the Organization. Only administrators can delete an Organization.
|
|
200
210
|
*
|
|
@@ -167,7 +167,7 @@ interface OrganizationDomainResource extends ClerkResource {
|
|
|
167
167
|
*/
|
|
168
168
|
prepareAffiliationVerification: (params: PrepareAffiliationVerificationParams) => Promise<OrganizationDomainResource>;
|
|
169
169
|
/**
|
|
170
|
-
* Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/reference/types/organization-domain-resource#
|
|
170
|
+
* Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/reference/types/organization-domain-resource#prepareaffiliationverification), by validating the provided verification code.
|
|
171
171
|
* @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
|
|
172
172
|
*/
|
|
173
173
|
attemptAffiliationVerification: (params: AttemptAffiliationVerificationParams) => Promise<OrganizationDomainResource>;
|
|
@@ -220,11 +220,11 @@ interface OrganizationDomainBulkOwnershipVerificationError {
|
|
|
220
220
|
code: string;
|
|
221
221
|
}
|
|
222
222
|
/**
|
|
223
|
-
* The `OrganizationDomainsBulkOwnershipVerificationResource` object is the result of a bulk ownership verification flow, such as [`prepareOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#
|
|
223
|
+
* The `OrganizationDomainsBulkOwnershipVerificationResource` object is the result of a bulk ownership verification flow, such as [`prepareOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#prepareownershipverification) or [`attemptOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#attemptownershipverification), where ownership is verified for several of an Organization's [Verified Domains](https://clerk.com/docs/guides/organizations/add-members/verified-domains) at once. Because the operation can partially succeed, each requested domain is reported in either `data` or `errors`.
|
|
224
224
|
*/
|
|
225
225
|
interface OrganizationDomainsBulkOwnershipVerificationResource {
|
|
226
226
|
/**
|
|
227
|
-
* The domains that were processed successfully. After [`prepareOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#
|
|
227
|
+
* The domains that were processed successfully. After [`prepareOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#prepareownershipverification), each domain's `ownershipVerification` carries the `txtRecordName` and `txtRecordValue` that must be published to a DNS TXT record.
|
|
228
228
|
*/
|
|
229
229
|
data: OrganizationDomainResource[];
|
|
230
230
|
/**
|
|
@@ -167,7 +167,7 @@ interface OrganizationDomainResource extends ClerkResource {
|
|
|
167
167
|
*/
|
|
168
168
|
prepareAffiliationVerification: (params: PrepareAffiliationVerificationParams) => Promise<OrganizationDomainResource>;
|
|
169
169
|
/**
|
|
170
|
-
* Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/reference/types/organization-domain-resource#
|
|
170
|
+
* Completes the verification process started by [`prepareAffiliationVerification()`](https://clerk.com/docs/reference/types/organization-domain-resource#prepareaffiliationverification), by validating the provided verification code.
|
|
171
171
|
* @returns The updated [`OrganizationDomainResource`](https://clerk.com/docs/reference/types/organization-domain-resource) object.
|
|
172
172
|
*/
|
|
173
173
|
attemptAffiliationVerification: (params: AttemptAffiliationVerificationParams) => Promise<OrganizationDomainResource>;
|
|
@@ -220,11 +220,11 @@ interface OrganizationDomainBulkOwnershipVerificationError {
|
|
|
220
220
|
code: string;
|
|
221
221
|
}
|
|
222
222
|
/**
|
|
223
|
-
* The `OrganizationDomainsBulkOwnershipVerificationResource` object is the result of a bulk ownership verification flow, such as [`prepareOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#
|
|
223
|
+
* The `OrganizationDomainsBulkOwnershipVerificationResource` object is the result of a bulk ownership verification flow, such as [`prepareOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#prepareownershipverification) or [`attemptOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#attemptownershipverification), where ownership is verified for several of an Organization's [Verified Domains](https://clerk.com/docs/guides/organizations/add-members/verified-domains) at once. Because the operation can partially succeed, each requested domain is reported in either `data` or `errors`.
|
|
224
224
|
*/
|
|
225
225
|
interface OrganizationDomainsBulkOwnershipVerificationResource {
|
|
226
226
|
/**
|
|
227
|
-
* The domains that were processed successfully. After [`prepareOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#
|
|
227
|
+
* The domains that were processed successfully. After [`prepareOwnershipVerification()`](https://clerk.com/docs/reference/objects/organization#prepareownershipverification), each domain's `ownershipVerification` carries the `txtRecordName` and `txtRecordValue` that must be published to a DNS TXT record.
|
|
228
228
|
*/
|
|
229
229
|
data: OrganizationDomainResource[];
|
|
230
230
|
/**
|
package/dist/types/signIn.d.mts
CHANGED
|
@@ -29,6 +29,7 @@ interface SignInResource extends ClerkResource {
|
|
|
29
29
|
supportedIdentifiers: SignInIdentifier[];
|
|
30
30
|
supportedFirstFactors: SignInFirstFactor[] | null;
|
|
31
31
|
supportedSecondFactors: SignInSecondFactor[] | null;
|
|
32
|
+
ssoFallbackFirstFactors: SignInFirstFactor[] | null;
|
|
32
33
|
clientTrustState?: ClientTrustState;
|
|
33
34
|
firstFactorVerification: VerificationResource;
|
|
34
35
|
secondFactorVerification: VerificationResource;
|
|
@@ -90,6 +91,7 @@ interface SignInJSON extends ClerkResourceJSON {
|
|
|
90
91
|
user_data: UserDataJSON;
|
|
91
92
|
supported_first_factors: SignInFirstFactorJSON[];
|
|
92
93
|
supported_second_factors: SignInSecondFactorJSON[];
|
|
94
|
+
sso_fallback_first_factors?: SignInFirstFactorJSON[];
|
|
93
95
|
first_factor_verification: VerificationJSON | null;
|
|
94
96
|
second_factor_verification: VerificationJSON | null;
|
|
95
97
|
created_session_id: string | null;
|
package/dist/types/signIn.d.ts
CHANGED
|
@@ -29,6 +29,7 @@ interface SignInResource extends ClerkResource {
|
|
|
29
29
|
supportedIdentifiers: SignInIdentifier[];
|
|
30
30
|
supportedFirstFactors: SignInFirstFactor[] | null;
|
|
31
31
|
supportedSecondFactors: SignInSecondFactor[] | null;
|
|
32
|
+
ssoFallbackFirstFactors: SignInFirstFactor[] | null;
|
|
32
33
|
clientTrustState?: ClientTrustState;
|
|
33
34
|
firstFactorVerification: VerificationResource;
|
|
34
35
|
secondFactorVerification: VerificationResource;
|
|
@@ -90,6 +91,7 @@ interface SignInJSON extends ClerkResourceJSON {
|
|
|
90
91
|
user_data: UserDataJSON;
|
|
91
92
|
supported_first_factors: SignInFirstFactorJSON[];
|
|
92
93
|
supported_second_factors: SignInSecondFactorJSON[];
|
|
94
|
+
sso_fallback_first_factors?: SignInFirstFactorJSON[];
|
|
93
95
|
first_factor_verification: VerificationJSON | null;
|
|
94
96
|
second_factor_verification: VerificationJSON | null;
|
|
95
97
|
created_session_id: string | null;
|
|
@@ -26,6 +26,14 @@ interface SignInFutureCreateParams {
|
|
|
26
26
|
* The full URL or path that the OAuth provider should redirect to after successful authorization on their part.
|
|
27
27
|
*/
|
|
28
28
|
redirectUrl?: string;
|
|
29
|
+
/**
|
|
30
|
+
* The value to pass to the [OIDC `prompt` parameter](https://openid.net/specs/openid-connect-core-1_0.html#:~:text=prompt,reauthentication%20and%20consent.) in the generated OAuth redirect URL.
|
|
31
|
+
*/
|
|
32
|
+
oidcPrompt?: string;
|
|
33
|
+
/**
|
|
34
|
+
* The value to pass to the [OIDC `login_hint` parameter](https://openid.net/specs/openid-connect-core-1_0.html#:~:text=login_hint,in%20\(if%20necessary\).) in the generated OAuth redirect URL.
|
|
35
|
+
*/
|
|
36
|
+
oidcLoginHint?: string;
|
|
29
37
|
/**
|
|
30
38
|
* The URL that the user will be redirected to, after successful authorization from the OAuth provider and Clerk sign-in.
|
|
31
39
|
*/
|
|
@@ -303,13 +311,17 @@ interface SignInFutureResource {
|
|
|
303
311
|
* Array of the second factors that are supported in the current sign-in. Each factor contains information about the verification strategy that can be used. This property is populated only when the first factor is verified.
|
|
304
312
|
*/
|
|
305
313
|
readonly supportedSecondFactors: SignInSecondFactor[];
|
|
314
|
+
/**
|
|
315
|
+
* Factors an enterprise SSO user can fall back to when they cannot reach their identity provider. Empty unless the instance has allowlisted this user for a fallback.
|
|
316
|
+
*/
|
|
317
|
+
readonly ssoFallbackFirstFactors: SignInFirstFactor[];
|
|
306
318
|
/**
|
|
307
319
|
* The current status of the sign-in.
|
|
308
320
|
* <ul>
|
|
309
321
|
* <li>`'complete'` - The sign-in process has been completed successfully.</li>
|
|
310
322
|
* <li>`'needs_client_trust'` - The user is signing in from a new device and must complete a [second factor verification](!second-factor-verification) to establish [Device Trust](https://clerk.com/docs/guides/secure/device-trust). See the [Device Trust custom flow guide](https://clerk.com/docs/guides/development/custom-flows/authentication/device-trust) for more information.</li>
|
|
311
323
|
* <li>`'needs_identifier'` - The user's identifier (e.g., email address, phone number, username) hasn't been provided.</li>
|
|
312
|
-
* <li>`'needs_first_factor'` - One of the following [first factor verification](!first-factor-verification) strategies is missing: `'email_link'`, `'email_code'`, `passkey`, `password`, `'phone_code'`, `'web3_base_signature'`, `'web3_metamask_signature'`, `'web3_coinbase_wallet_signature'`, `'web3_okx_wallet_signature'`, `'web3_solana_signature'`, [`OAuthStrategy`](https://clerk.com/docs/reference/types/sso#
|
|
324
|
+
* <li>`'needs_first_factor'` - One of the following [first factor verification](!first-factor-verification) strategies is missing: `'email_link'`, `'email_code'`, `passkey`, `password`, `'phone_code'`, `'web3_base_signature'`, `'web3_metamask_signature'`, `'web3_coinbase_wallet_signature'`, `'web3_okx_wallet_signature'`, `'web3_solana_signature'`, [`OAuthStrategy`](https://clerk.com/docs/reference/types/sso#oauthstrategy), or `'enterprise_sso'`.</li>
|
|
313
325
|
* <li>`'needs_second_factor'` - One of the following [second factor verification](!second-factor-verification) strategies is missing: `'phone_code'`, `'totp'`, `'backup_code'`, `'email_code'`, or `'email_link'`.</li>
|
|
314
326
|
* <li>`'needs_new_password'` - The user needs to set a new password. See the [dedicated custom flow](/docs/guides/development/custom-flows/authentication/forgot-password) guide for more information.</li>
|
|
315
327
|
* <li>`'needs_protect_check'` - A Clerk Protect challenge must be resolved before the sign-in can continue. This status is only returned when Protect mid-flow challenges are explicitly enabled for the instance; upgrading the SDK alone does not enable it. Run the challenge described by `protectCheck` and resolve it via `submitProtectCheck()`. The pre-built components handle this automatically.</li>
|
|
@@ -394,7 +406,7 @@ interface SignInFutureResource {
|
|
|
394
406
|
error: ClerkError | null;
|
|
395
407
|
}>;
|
|
396
408
|
/**
|
|
397
|
-
* Verifies a code sent with the [`emailCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#
|
|
409
|
+
* Verifies a code sent with the [`emailCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#emailcode-sendcode) method.
|
|
398
410
|
*/
|
|
399
411
|
verifyCode: (params: SignInFutureEmailCodeVerifyParams) => Promise<{
|
|
400
412
|
error: ClerkError | null;
|
|
@@ -441,7 +453,7 @@ interface SignInFutureResource {
|
|
|
441
453
|
error: ClerkError | null;
|
|
442
454
|
}>;
|
|
443
455
|
/**
|
|
444
|
-
* Verifies a code sent with the [`phoneCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#
|
|
456
|
+
* Verifies a code sent with the [`phoneCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#phonecode-sendcode) method.
|
|
445
457
|
*/
|
|
446
458
|
verifyCode: (params: SignInFuturePhoneCodeVerifyParams) => Promise<{
|
|
447
459
|
error: ClerkError | null;
|
|
@@ -456,7 +468,7 @@ interface SignInFutureResource {
|
|
|
456
468
|
error: ClerkError | null;
|
|
457
469
|
}>;
|
|
458
470
|
/**
|
|
459
|
-
* Verifies a password reset code sent with the [`resetPasswordEmailCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#
|
|
471
|
+
* Verifies a password reset code sent with the [`resetPasswordEmailCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#resetpasswordemailcode-sendcode) method. Will cause `signIn.status` to become `'needs_new_password'`. This is when you will call the [`resetPasswordEmailCode.submitPassword()`](https://clerk.com/docs/reference/objects/sign-in-future#resetpasswordemailcode-submitpassword) method to complete the password reset flow.
|
|
460
472
|
*/
|
|
461
473
|
verifyCode: (params: SignInFutureEmailCodeVerifyParams) => Promise<{
|
|
462
474
|
error: ClerkError | null;
|
|
@@ -477,7 +489,7 @@ interface SignInFutureResource {
|
|
|
477
489
|
error: ClerkError | null;
|
|
478
490
|
}>;
|
|
479
491
|
/**
|
|
480
|
-
* Verifies a password reset code sent with the [`resetPasswordPhoneCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#
|
|
492
|
+
* Verifies a password reset code sent with the [`resetPasswordPhoneCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#resetpasswordphonecode-sendcode) method. Will cause `signIn.status` to become `'needs_new_password'`. This is when you will call the [`resetPasswordPhoneCode.submitPassword()`](https://clerk.com/docs/reference/objects/sign-in-future#resetpasswordphonecode-submitpassword) method to complete the password reset flow.
|
|
481
493
|
*/
|
|
482
494
|
verifyCode: (params: SignInFutureResetPasswordPhoneCodeVerifyParams) => Promise<{
|
|
483
495
|
error: ClerkError | null;
|
|
@@ -504,7 +516,7 @@ interface SignInFutureResource {
|
|
|
504
516
|
error: ClerkError | null;
|
|
505
517
|
}>;
|
|
506
518
|
/**
|
|
507
|
-
* Verifies a phone code sent with the [`mfa.sendPhoneCode()`](https://clerk.com/docs/reference/objects/sign-in-future#mfa-
|
|
519
|
+
* Verifies a phone code sent with the [`mfa.sendPhoneCode()`](https://clerk.com/docs/reference/objects/sign-in-future#mfa-sendphonecode) method.
|
|
508
520
|
*/
|
|
509
521
|
verifyPhoneCode: (params: SignInFutureMFAPhoneCodeVerifyParams) => Promise<{
|
|
510
522
|
error: ClerkError | null;
|
|
@@ -516,7 +528,7 @@ interface SignInFutureResource {
|
|
|
516
528
|
error: ClerkError | null;
|
|
517
529
|
}>;
|
|
518
530
|
/**
|
|
519
|
-
* Verifies an email code sent with the [`mfa.sendEmailCode()`](https://clerk.com/docs/reference/objects/sign-in-future#mfa-
|
|
531
|
+
* Verifies an email code sent with the [`mfa.sendEmailCode()`](https://clerk.com/docs/reference/objects/sign-in-future#mfa-sendemailcode) method.
|
|
520
532
|
*/
|
|
521
533
|
verifyEmailCode: (params: SignInFutureMFAEmailCodeVerifyParams) => Promise<{
|
|
522
534
|
error: ClerkError | null;
|
|
@@ -26,6 +26,14 @@ interface SignInFutureCreateParams {
|
|
|
26
26
|
* The full URL or path that the OAuth provider should redirect to after successful authorization on their part.
|
|
27
27
|
*/
|
|
28
28
|
redirectUrl?: string;
|
|
29
|
+
/**
|
|
30
|
+
* The value to pass to the [OIDC `prompt` parameter](https://openid.net/specs/openid-connect-core-1_0.html#:~:text=prompt,reauthentication%20and%20consent.) in the generated OAuth redirect URL.
|
|
31
|
+
*/
|
|
32
|
+
oidcPrompt?: string;
|
|
33
|
+
/**
|
|
34
|
+
* The value to pass to the [OIDC `login_hint` parameter](https://openid.net/specs/openid-connect-core-1_0.html#:~:text=login_hint,in%20\(if%20necessary\).) in the generated OAuth redirect URL.
|
|
35
|
+
*/
|
|
36
|
+
oidcLoginHint?: string;
|
|
29
37
|
/**
|
|
30
38
|
* The URL that the user will be redirected to, after successful authorization from the OAuth provider and Clerk sign-in.
|
|
31
39
|
*/
|
|
@@ -303,13 +311,17 @@ interface SignInFutureResource {
|
|
|
303
311
|
* Array of the second factors that are supported in the current sign-in. Each factor contains information about the verification strategy that can be used. This property is populated only when the first factor is verified.
|
|
304
312
|
*/
|
|
305
313
|
readonly supportedSecondFactors: SignInSecondFactor[];
|
|
314
|
+
/**
|
|
315
|
+
* Factors an enterprise SSO user can fall back to when they cannot reach their identity provider. Empty unless the instance has allowlisted this user for a fallback.
|
|
316
|
+
*/
|
|
317
|
+
readonly ssoFallbackFirstFactors: SignInFirstFactor[];
|
|
306
318
|
/**
|
|
307
319
|
* The current status of the sign-in.
|
|
308
320
|
* <ul>
|
|
309
321
|
* <li>`'complete'` - The sign-in process has been completed successfully.</li>
|
|
310
322
|
* <li>`'needs_client_trust'` - The user is signing in from a new device and must complete a [second factor verification](!second-factor-verification) to establish [Device Trust](https://clerk.com/docs/guides/secure/device-trust). See the [Device Trust custom flow guide](https://clerk.com/docs/guides/development/custom-flows/authentication/device-trust) for more information.</li>
|
|
311
323
|
* <li>`'needs_identifier'` - The user's identifier (e.g., email address, phone number, username) hasn't been provided.</li>
|
|
312
|
-
* <li>`'needs_first_factor'` - One of the following [first factor verification](!first-factor-verification) strategies is missing: `'email_link'`, `'email_code'`, `passkey`, `password`, `'phone_code'`, `'web3_base_signature'`, `'web3_metamask_signature'`, `'web3_coinbase_wallet_signature'`, `'web3_okx_wallet_signature'`, `'web3_solana_signature'`, [`OAuthStrategy`](https://clerk.com/docs/reference/types/sso#
|
|
324
|
+
* <li>`'needs_first_factor'` - One of the following [first factor verification](!first-factor-verification) strategies is missing: `'email_link'`, `'email_code'`, `passkey`, `password`, `'phone_code'`, `'web3_base_signature'`, `'web3_metamask_signature'`, `'web3_coinbase_wallet_signature'`, `'web3_okx_wallet_signature'`, `'web3_solana_signature'`, [`OAuthStrategy`](https://clerk.com/docs/reference/types/sso#oauthstrategy), or `'enterprise_sso'`.</li>
|
|
313
325
|
* <li>`'needs_second_factor'` - One of the following [second factor verification](!second-factor-verification) strategies is missing: `'phone_code'`, `'totp'`, `'backup_code'`, `'email_code'`, or `'email_link'`.</li>
|
|
314
326
|
* <li>`'needs_new_password'` - The user needs to set a new password. See the [dedicated custom flow](/docs/guides/development/custom-flows/authentication/forgot-password) guide for more information.</li>
|
|
315
327
|
* <li>`'needs_protect_check'` - A Clerk Protect challenge must be resolved before the sign-in can continue. This status is only returned when Protect mid-flow challenges are explicitly enabled for the instance; upgrading the SDK alone does not enable it. Run the challenge described by `protectCheck` and resolve it via `submitProtectCheck()`. The pre-built components handle this automatically.</li>
|
|
@@ -394,7 +406,7 @@ interface SignInFutureResource {
|
|
|
394
406
|
error: ClerkError | null;
|
|
395
407
|
}>;
|
|
396
408
|
/**
|
|
397
|
-
* Verifies a code sent with the [`emailCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#
|
|
409
|
+
* Verifies a code sent with the [`emailCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#emailcode-sendcode) method.
|
|
398
410
|
*/
|
|
399
411
|
verifyCode: (params: SignInFutureEmailCodeVerifyParams) => Promise<{
|
|
400
412
|
error: ClerkError | null;
|
|
@@ -441,7 +453,7 @@ interface SignInFutureResource {
|
|
|
441
453
|
error: ClerkError | null;
|
|
442
454
|
}>;
|
|
443
455
|
/**
|
|
444
|
-
* Verifies a code sent with the [`phoneCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#
|
|
456
|
+
* Verifies a code sent with the [`phoneCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#phonecode-sendcode) method.
|
|
445
457
|
*/
|
|
446
458
|
verifyCode: (params: SignInFuturePhoneCodeVerifyParams) => Promise<{
|
|
447
459
|
error: ClerkError | null;
|
|
@@ -456,7 +468,7 @@ interface SignInFutureResource {
|
|
|
456
468
|
error: ClerkError | null;
|
|
457
469
|
}>;
|
|
458
470
|
/**
|
|
459
|
-
* Verifies a password reset code sent with the [`resetPasswordEmailCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#
|
|
471
|
+
* Verifies a password reset code sent with the [`resetPasswordEmailCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#resetpasswordemailcode-sendcode) method. Will cause `signIn.status` to become `'needs_new_password'`. This is when you will call the [`resetPasswordEmailCode.submitPassword()`](https://clerk.com/docs/reference/objects/sign-in-future#resetpasswordemailcode-submitpassword) method to complete the password reset flow.
|
|
460
472
|
*/
|
|
461
473
|
verifyCode: (params: SignInFutureEmailCodeVerifyParams) => Promise<{
|
|
462
474
|
error: ClerkError | null;
|
|
@@ -477,7 +489,7 @@ interface SignInFutureResource {
|
|
|
477
489
|
error: ClerkError | null;
|
|
478
490
|
}>;
|
|
479
491
|
/**
|
|
480
|
-
* Verifies a password reset code sent with the [`resetPasswordPhoneCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#
|
|
492
|
+
* Verifies a password reset code sent with the [`resetPasswordPhoneCode.sendCode()`](https://clerk.com/docs/reference/objects/sign-in-future#resetpasswordphonecode-sendcode) method. Will cause `signIn.status` to become `'needs_new_password'`. This is when you will call the [`resetPasswordPhoneCode.submitPassword()`](https://clerk.com/docs/reference/objects/sign-in-future#resetpasswordphonecode-submitpassword) method to complete the password reset flow.
|
|
481
493
|
*/
|
|
482
494
|
verifyCode: (params: SignInFutureResetPasswordPhoneCodeVerifyParams) => Promise<{
|
|
483
495
|
error: ClerkError | null;
|
|
@@ -504,7 +516,7 @@ interface SignInFutureResource {
|
|
|
504
516
|
error: ClerkError | null;
|
|
505
517
|
}>;
|
|
506
518
|
/**
|
|
507
|
-
* Verifies a phone code sent with the [`mfa.sendPhoneCode()`](https://clerk.com/docs/reference/objects/sign-in-future#mfa-
|
|
519
|
+
* Verifies a phone code sent with the [`mfa.sendPhoneCode()`](https://clerk.com/docs/reference/objects/sign-in-future#mfa-sendphonecode) method.
|
|
508
520
|
*/
|
|
509
521
|
verifyPhoneCode: (params: SignInFutureMFAPhoneCodeVerifyParams) => Promise<{
|
|
510
522
|
error: ClerkError | null;
|
|
@@ -516,7 +528,7 @@ interface SignInFutureResource {
|
|
|
516
528
|
error: ClerkError | null;
|
|
517
529
|
}>;
|
|
518
530
|
/**
|
|
519
|
-
* Verifies an email code sent with the [`mfa.sendEmailCode()`](https://clerk.com/docs/reference/objects/sign-in-future#mfa-
|
|
531
|
+
* Verifies an email code sent with the [`mfa.sendEmailCode()`](https://clerk.com/docs/reference/objects/sign-in-future#mfa-sendemailcode) method.
|
|
520
532
|
*/
|
|
521
533
|
verifyEmailCode: (params: SignInFutureMFAEmailCodeVerifyParams) => Promise<{
|
|
522
534
|
error: ClerkError | null;
|
|
@@ -37,7 +37,7 @@ interface SignUpFutureCreateParams extends SignUpFutureAdditionalParams {
|
|
|
37
37
|
* <li>`'oauth_<provider>'`: The user will be authenticated with their [social connection account](https://clerk.com/docs/guides/configure/auth-strategies/social-connections/overview). See a list of [supported values for `<provider>`](https://clerk.com/docs/reference/types/sso).</li>
|
|
38
38
|
* <li>`'enterprise_sso'`: The user will be authenticated either through SAML or OIDC depending on the configuration of their [enterprise SSO account](https://clerk.com/docs/guides/configure/auth-strategies/enterprise-connections/overview).</li>
|
|
39
39
|
* <li>`'ticket'`: The user will be authenticated via the ticket _or token_ generated from the Backend API.</li>
|
|
40
|
-
* <li>`'google_one_tap'`: The user will be authenticated with the Google One Tap UI. It's recommended to use [`authenticateWithGoogleOneTap()`](https://clerk.com/docs/reference/components/authentication/google-one-tap#
|
|
40
|
+
* <li>`'google_one_tap'`: The user will be authenticated with the Google One Tap UI. It's recommended to use [`authenticateWithGoogleOneTap()`](https://clerk.com/docs/reference/components/authentication/google-one-tap#authenticatewithgoogleonetap) instead, as it will also set the user's current session as active for you.</li>
|
|
41
41
|
* <li>`'oauth_token_apple'`: The user will be authenticated using a native [Sign in with Apple](https://clerk.com/docs/guides/configure/auth-strategies/sign-in-with-apple) identity token.</li>
|
|
42
42
|
* <li>`'phone_code'`: The user will receive a one-time code via SMS to verify their phone number.</li>
|
|
43
43
|
* </ul>
|
|
@@ -184,7 +184,7 @@ interface SignUpFuturePhoneCodeVerifyParams {
|
|
|
184
184
|
/** @generateWithEmptyComment */
|
|
185
185
|
interface SignUpFutureSSOParams extends SignUpFutureAdditionalParams {
|
|
186
186
|
/**
|
|
187
|
-
* The strategy to use for authentication. Either [`OAuthStrategy`](https://clerk.com/docs/reference/types/sso#
|
|
187
|
+
* The strategy to use for authentication. Either [`OAuthStrategy`](https://clerk.com/docs/reference/types/sso#oauthstrategy) or [`EnterpriseSSOStrategy`](https://clerk.com/docs/reference/types/sso#enterprisessostrategy).
|
|
188
188
|
*/
|
|
189
189
|
strategy: string;
|
|
190
190
|
/**
|
|
@@ -293,7 +293,7 @@ interface SignUpFutureVerifications {
|
|
|
293
293
|
error: ClerkError | null;
|
|
294
294
|
}>;
|
|
295
295
|
/**
|
|
296
|
-
* Verifies a code sent with the [`verifications.sendEmailCode()`](https://clerk.com/docs/reference/objects/sign-up-future#verifications-
|
|
296
|
+
* Verifies a code sent with the [`verifications.sendEmailCode()`](https://clerk.com/docs/reference/objects/sign-up-future#verifications-sendemailcode) method.
|
|
297
297
|
*/
|
|
298
298
|
verifyEmailCode: (params: SignUpFutureEmailCodeVerifyParams) => Promise<{
|
|
299
299
|
error: ClerkError | null;
|
|
@@ -305,7 +305,7 @@ interface SignUpFutureVerifications {
|
|
|
305
305
|
error: ClerkError | null;
|
|
306
306
|
}>;
|
|
307
307
|
/**
|
|
308
|
-
* Will wait for email link verification to complete or expire after calling [`verifications.sendEmailLink()`](https://clerk.com/docs/reference/objects/sign-up-future#verifications-
|
|
308
|
+
* Will wait for email link verification to complete or expire after calling [`verifications.sendEmailLink()`](https://clerk.com/docs/reference/objects/sign-up-future#verifications-sendemaillink).
|
|
309
309
|
*/
|
|
310
310
|
waitForEmailLinkVerification: () => Promise<{
|
|
311
311
|
error: ClerkError | null;
|
|
@@ -317,7 +317,7 @@ interface SignUpFutureVerifications {
|
|
|
317
317
|
error: ClerkError | null;
|
|
318
318
|
}>;
|
|
319
319
|
/**
|
|
320
|
-
* Verifies a code sent with the [`verifications.sendPhoneCode()`](https://clerk.com/docs/reference/objects/sign-up-future#verifications-
|
|
320
|
+
* Verifies a code sent with the [`verifications.sendPhoneCode()`](https://clerk.com/docs/reference/objects/sign-up-future#verifications-sendphonecode) method.
|
|
321
321
|
*/
|
|
322
322
|
verifyPhoneCode: (params: SignUpFuturePhoneCodeVerifyParams) => Promise<{
|
|
323
323
|
error: ClerkError | null;
|
|
@@ -37,7 +37,7 @@ interface SignUpFutureCreateParams extends SignUpFutureAdditionalParams {
|
|
|
37
37
|
* <li>`'oauth_<provider>'`: The user will be authenticated with their [social connection account](https://clerk.com/docs/guides/configure/auth-strategies/social-connections/overview). See a list of [supported values for `<provider>`](https://clerk.com/docs/reference/types/sso).</li>
|
|
38
38
|
* <li>`'enterprise_sso'`: The user will be authenticated either through SAML or OIDC depending on the configuration of their [enterprise SSO account](https://clerk.com/docs/guides/configure/auth-strategies/enterprise-connections/overview).</li>
|
|
39
39
|
* <li>`'ticket'`: The user will be authenticated via the ticket _or token_ generated from the Backend API.</li>
|
|
40
|
-
* <li>`'google_one_tap'`: The user will be authenticated with the Google One Tap UI. It's recommended to use [`authenticateWithGoogleOneTap()`](https://clerk.com/docs/reference/components/authentication/google-one-tap#
|
|
40
|
+
* <li>`'google_one_tap'`: The user will be authenticated with the Google One Tap UI. It's recommended to use [`authenticateWithGoogleOneTap()`](https://clerk.com/docs/reference/components/authentication/google-one-tap#authenticatewithgoogleonetap) instead, as it will also set the user's current session as active for you.</li>
|
|
41
41
|
* <li>`'oauth_token_apple'`: The user will be authenticated using a native [Sign in with Apple](https://clerk.com/docs/guides/configure/auth-strategies/sign-in-with-apple) identity token.</li>
|
|
42
42
|
* <li>`'phone_code'`: The user will receive a one-time code via SMS to verify their phone number.</li>
|
|
43
43
|
* </ul>
|
|
@@ -184,7 +184,7 @@ interface SignUpFuturePhoneCodeVerifyParams {
|
|
|
184
184
|
/** @generateWithEmptyComment */
|
|
185
185
|
interface SignUpFutureSSOParams extends SignUpFutureAdditionalParams {
|
|
186
186
|
/**
|
|
187
|
-
* The strategy to use for authentication. Either [`OAuthStrategy`](https://clerk.com/docs/reference/types/sso#
|
|
187
|
+
* The strategy to use for authentication. Either [`OAuthStrategy`](https://clerk.com/docs/reference/types/sso#oauthstrategy) or [`EnterpriseSSOStrategy`](https://clerk.com/docs/reference/types/sso#enterprisessostrategy).
|
|
188
188
|
*/
|
|
189
189
|
strategy: string;
|
|
190
190
|
/**
|
|
@@ -293,7 +293,7 @@ interface SignUpFutureVerifications {
|
|
|
293
293
|
error: ClerkError | null;
|
|
294
294
|
}>;
|
|
295
295
|
/**
|
|
296
|
-
* Verifies a code sent with the [`verifications.sendEmailCode()`](https://clerk.com/docs/reference/objects/sign-up-future#verifications-
|
|
296
|
+
* Verifies a code sent with the [`verifications.sendEmailCode()`](https://clerk.com/docs/reference/objects/sign-up-future#verifications-sendemailcode) method.
|
|
297
297
|
*/
|
|
298
298
|
verifyEmailCode: (params: SignUpFutureEmailCodeVerifyParams) => Promise<{
|
|
299
299
|
error: ClerkError | null;
|
|
@@ -305,7 +305,7 @@ interface SignUpFutureVerifications {
|
|
|
305
305
|
error: ClerkError | null;
|
|
306
306
|
}>;
|
|
307
307
|
/**
|
|
308
|
-
* Will wait for email link verification to complete or expire after calling [`verifications.sendEmailLink()`](https://clerk.com/docs/reference/objects/sign-up-future#verifications-
|
|
308
|
+
* Will wait for email link verification to complete or expire after calling [`verifications.sendEmailLink()`](https://clerk.com/docs/reference/objects/sign-up-future#verifications-sendemaillink).
|
|
309
309
|
*/
|
|
310
310
|
waitForEmailLinkVerification: () => Promise<{
|
|
311
311
|
error: ClerkError | null;
|
|
@@ -317,7 +317,7 @@ interface SignUpFutureVerifications {
|
|
|
317
317
|
error: ClerkError | null;
|
|
318
318
|
}>;
|
|
319
319
|
/**
|
|
320
|
-
* Verifies a code sent with the [`verifications.sendPhoneCode()`](https://clerk.com/docs/reference/objects/sign-up-future#verifications-
|
|
320
|
+
* Verifies a code sent with the [`verifications.sendPhoneCode()`](https://clerk.com/docs/reference/objects/sign-up-future#verifications-sendphonecode) method.
|
|
321
321
|
*/
|
|
322
322
|
verifyPhoneCode: (params: SignUpFuturePhoneCodeVerifyParams) => Promise<{
|
|
323
323
|
error: ClerkError | null;
|
package/dist/types/user.d.mts
CHANGED
|
@@ -371,7 +371,7 @@ type CreateExternalAccountParams = {
|
|
|
371
371
|
*/
|
|
372
372
|
enterpriseConnectionId?: string;
|
|
373
373
|
/**
|
|
374
|
-
* The full URL or path that the OAuth provider should redirect to, on successful authorization on their part. Typically, this will be a simple `/sso-callback` route that calls [`Clerk.handleRedirectCallback`](https://clerk.com/docs/reference/objects/clerk#
|
|
374
|
+
* The full URL or path that the OAuth provider should redirect to, on successful authorization on their part. Typically, this will be a simple `/sso-callback` route that calls [`Clerk.handleRedirectCallback`](https://clerk.com/docs/reference/objects/clerk#handleredirectcallback) or mounts the [`<AuthenticateWithRedirectCallback />`](https://clerk.com/docs/reference/components/control/authenticate-with-redirect-callback) component. See the [custom flow](https://clerk.com/docs/guides/development/custom-flows/authentication/oauth-connections) for implementation details.
|
|
375
375
|
*/
|
|
376
376
|
redirectUrl?: string;
|
|
377
377
|
/**
|
package/dist/types/user.d.ts
CHANGED
|
@@ -371,7 +371,7 @@ type CreateExternalAccountParams = {
|
|
|
371
371
|
*/
|
|
372
372
|
enterpriseConnectionId?: string;
|
|
373
373
|
/**
|
|
374
|
-
* The full URL or path that the OAuth provider should redirect to, on successful authorization on their part. Typically, this will be a simple `/sso-callback` route that calls [`Clerk.handleRedirectCallback`](https://clerk.com/docs/reference/objects/clerk#
|
|
374
|
+
* The full URL or path that the OAuth provider should redirect to, on successful authorization on their part. Typically, this will be a simple `/sso-callback` route that calls [`Clerk.handleRedirectCallback`](https://clerk.com/docs/reference/objects/clerk#handleredirectcallback) or mounts the [`<AuthenticateWithRedirectCallback />`](https://clerk.com/docs/reference/components/control/authenticate-with-redirect-callback) component. See the [custom flow](https://clerk.com/docs/guides/development/custom-flows/authentication/oauth-connections) for implementation details.
|
|
375
375
|
*/
|
|
376
376
|
redirectUrl?: string;
|
|
377
377
|
/**
|
|
@@ -75,7 +75,8 @@ type PasskeySettingsData = {
|
|
|
75
75
|
type OAuthProviders = { [provider in OAuthStrategy]: OAuthProviderSettings };
|
|
76
76
|
type EnterpriseSSOSettings = {
|
|
77
77
|
enabled: boolean;
|
|
78
|
-
self_serve_sso: boolean;
|
|
78
|
+
self_serve_sso: boolean; /** Whether end-users may manage Directory Sync for their enterprise connections. */
|
|
79
|
+
self_serve_directory_sync: boolean;
|
|
79
80
|
};
|
|
80
81
|
type AttributesJSON = { [attribute in Attribute]: AttributeDataJSON };
|
|
81
82
|
type Attributes = { [attribute in Attribute]: AttributeData };
|
|
@@ -75,7 +75,8 @@ type PasskeySettingsData = {
|
|
|
75
75
|
type OAuthProviders = { [provider in OAuthStrategy]: OAuthProviderSettings };
|
|
76
76
|
type EnterpriseSSOSettings = {
|
|
77
77
|
enabled: boolean;
|
|
78
|
-
self_serve_sso: boolean;
|
|
78
|
+
self_serve_sso: boolean; /** Whether end-users may manage Directory Sync for their enterprise connections. */
|
|
79
|
+
self_serve_directory_sync: boolean;
|
|
79
80
|
};
|
|
80
81
|
type AttributesJSON = { [attribute in Attribute]: AttributeDataJSON };
|
|
81
82
|
type Attributes = { [attribute in Attribute]: AttributeData };
|
package/dist/versionSelector.js
CHANGED
|
@@ -12,7 +12,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
|
|
|
12
12
|
* @param packageVersion - The version of `@clerk/clerk-js` that will be used if an explicit version is not provided
|
|
13
13
|
* @returns The npm tag, version or major version to use
|
|
14
14
|
*/
|
|
15
|
-
const versionSelector = (clerkJSVersion, packageVersion = "6.
|
|
15
|
+
const versionSelector = (clerkJSVersion, packageVersion = "6.32.0") => {
|
|
16
16
|
if (clerkJSVersion) return clerkJSVersion;
|
|
17
17
|
const prereleaseTag = getPrereleaseTag(packageVersion);
|
|
18
18
|
if (prereleaseTag) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"versionSelector.js","names":[],"sources":["../src/versionSelector.ts"],"sourcesContent":["/**\n * This version selector is a bit complicated, so here is the flow:\n * 1. Use the clerkJSVersion prop on the provider\n * 2. Use the exact `@clerk/clerk-js` version if it is a `@snapshot` prerelease\n * 3. Use the prerelease tag of `@clerk/clerk-js` or the packageVersion provided\n * 4. Fallback to the major version of `@clerk/clerk-js` or the packageVersion provided\n *\n * @param clerkJSVersion - The optional clerkJSVersion prop on the provider\n * @param packageVersion - The version of `@clerk/clerk-js` that will be used if an explicit version is not provided\n * @returns The npm tag, version or major version to use\n */\nexport const versionSelector = (clerkJSVersion: string | undefined, packageVersion = JS_PACKAGE_VERSION) => {\n if (clerkJSVersion) {\n return clerkJSVersion;\n }\n\n const prereleaseTag = getPrereleaseTag(packageVersion);\n if (prereleaseTag) {\n if (prereleaseTag === 'snapshot') {\n return packageVersion;\n }\n\n return prereleaseTag;\n }\n\n return getMajorVersion(packageVersion);\n};\n\nconst getPrereleaseTag = (packageVersion: string) =>\n packageVersion\n .trim()\n .replace(/^v/, '')\n .match(/-(.+?)(\\.|$)/)?.[1];\n\nexport const getMajorVersion = (packageVersion: string) => packageVersion.trim().replace(/^v/, '').split('.')[0];\n"],"mappings":";;;;;;;;;;;;;;AAWA,MAAa,mBAAmB,gBAAoC,
|
|
1
|
+
{"version":3,"file":"versionSelector.js","names":[],"sources":["../src/versionSelector.ts"],"sourcesContent":["/**\n * This version selector is a bit complicated, so here is the flow:\n * 1. Use the clerkJSVersion prop on the provider\n * 2. Use the exact `@clerk/clerk-js` version if it is a `@snapshot` prerelease\n * 3. Use the prerelease tag of `@clerk/clerk-js` or the packageVersion provided\n * 4. Fallback to the major version of `@clerk/clerk-js` or the packageVersion provided\n *\n * @param clerkJSVersion - The optional clerkJSVersion prop on the provider\n * @param packageVersion - The version of `@clerk/clerk-js` that will be used if an explicit version is not provided\n * @returns The npm tag, version or major version to use\n */\nexport const versionSelector = (clerkJSVersion: string | undefined, packageVersion = JS_PACKAGE_VERSION) => {\n if (clerkJSVersion) {\n return clerkJSVersion;\n }\n\n const prereleaseTag = getPrereleaseTag(packageVersion);\n if (prereleaseTag) {\n if (prereleaseTag === 'snapshot') {\n return packageVersion;\n }\n\n return prereleaseTag;\n }\n\n return getMajorVersion(packageVersion);\n};\n\nconst getPrereleaseTag = (packageVersion: string) =>\n packageVersion\n .trim()\n .replace(/^v/, '')\n .match(/-(.+?)(\\.|$)/)?.[1];\n\nexport const getMajorVersion = (packageVersion: string) => packageVersion.trim().replace(/^v/, '').split('.')[0];\n"],"mappings":";;;;;;;;;;;;;;AAWA,MAAa,mBAAmB,gBAAoC,8BAAwC;CAC1G,IAAI,gBACF,OAAO;CAGT,MAAM,gBAAgB,iBAAiB,cAAc;CACrD,IAAI,eAAe;EACjB,IAAI,kBAAkB,YACpB,OAAO;EAGT,OAAO;CACT;CAEA,OAAO,gBAAgB,cAAc;AACvC;AAEA,MAAM,oBAAoB,mBACxB,eACG,KAAK,CAAC,CACN,QAAQ,MAAM,EAAE,CAAC,CACjB,MAAM,cAAc,CAAC,GAAG;AAE7B,MAAa,mBAAmB,mBAA2B,eAAe,KAAK,CAAC,CAAC,QAAQ,MAAM,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC"}
|