diff --git a/clerk-typedoc/backend/auth-object.mdx b/clerk-typedoc/backend/auth-object.mdx index 5df005be9a..4f392c755d 100644 --- a/clerk-typedoc/backend/auth-object.mdx +++ b/clerk-typedoc/backend/auth-object.mdx @@ -1,8 +1,8 @@ ## Properties -| Property | Type | Description | -| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `debug` | () => \{ [key: string]: any; \} | Used to help debug issues when using Clerk in development. | -| `getToken` | () => Promise\ \| () => Promise\ \| [ServerGetToken](../types/server-get-token.mdx) \| () => Promise\ | A function that gets the current user's [session token](/docs/guides/sessions/session-tokens) or a [custom JWT template](/docs/guides/sessions/jwt-templates). | -| `has` | [CheckAuthorizationFromSessionClaims](../types/check-authorization-from-session-claims.mdx) \| () => false | A function that checks if the user has an organization role or custom permission. | -| `tokenType` | null \| "api_key" \| "session_token" \| "m2m_token" \| "oauth_token" | The allowed token type. | +| Property | Type | Description | +| ---------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `debug` | () => \{ [key: string]: any; \} | Used to help debug issues when using Clerk in development. | +| `getToken` | () => Promise\ \| () => Promise\ \| ServerGetToken \| () => Promise\ | A function that gets the current user's [session token](/docs/guides/sessions/session-tokens) or a [custom JWT template](/docs/guides/sessions/jwt-templates). | +| `has` | CheckAuthorizationFromSessionClaims \| () => false | A function that checks if the user has an organization role or custom permission. | +| `tokenType` | null \| "api_key" \| "session_token" \| "m2m_token" \| "oauth_token" | The allowed token type. | diff --git a/clerk-typedoc/backend/billing-plan.mdx b/clerk-typedoc/backend/billing-plan.mdx index ec66b8ebcb..ad6913ae32 100644 --- a/clerk-typedoc/backend/billing-plan.mdx +++ b/clerk-typedoc/backend/billing-plan.mdx @@ -2,19 +2,19 @@ The `BillingPlan` object is similar to the [`BillingPlanResource`](/docs/referen ## Properties -| Property | Type | Description | -| ------------------------------------------------ | ----------------------------------------------------------------------------- | --------------------------------------------------------------- | -| `annualFee` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The annual fee of the plan. | -| `annualMonthlyFee` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The annual fee of the plan on a monthly basis. | -| `description` | undefined \| string | The description of the plan. | -| `features` | [Feature](feature.mdx)[] | The features the plan offers. | -| `fee` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The monthly fee of the plan. | -| `forPayerType` | "user" \| "org" | The type of payer for the plan. | -| `hasBaseFee` | `boolean` | Whether the plan has a base fee. | -| `id` | `string` | The unique identifier for the plan. | -| `isDefault` | `boolean` | Whether the plan is the default plan. | -| `isRecurring` | `boolean` | Whether the plan is recurring. | -| `name` | `string` | The name of the plan. | -| `productId` | `string` | The ID of the product the plan belongs to. | -| `publiclyVisible` | `boolean` | Whether the plan is displayed in the `` component. | -| `slug` | `string` | The URL-friendly identifier of the plan. | +| Property | Type | Description | +| ------------------------------------------------ | ------------------------------------- | --------------------------------------------------------------- | +| `annualFee` | `BillingMoneyAmount` | The annual fee of the plan. | +| `annualMonthlyFee` | `BillingMoneyAmount` | The annual fee of the plan on a monthly basis. | +| `description` | undefined \| string | The description of the plan. | +| `features` | [Feature](feature.mdx)[] | The features the plan offers. | +| `fee` | `BillingMoneyAmount` | The monthly fee of the plan. | +| `forPayerType` | "user" \| "org" | The type of payer for the plan. | +| `hasBaseFee` | `boolean` | Whether the plan has a base fee. | +| `id` | `string` | The unique identifier for the plan. | +| `isDefault` | `boolean` | Whether the plan is the default plan. | +| `isRecurring` | `boolean` | Whether the plan is recurring. | +| `name` | `string` | The name of the plan. | +| `productId` | `string` | The ID of the product the plan belongs to. | +| `publiclyVisible` | `boolean` | Whether the plan is displayed in the `` component. | +| `slug` | `string` | The URL-friendly identifier of the plan. | diff --git a/clerk-typedoc/backend/billing-subscription-item.mdx b/clerk-typedoc/backend/billing-subscription-item.mdx index bfbb280fb9..833f75fa21 100644 --- a/clerk-typedoc/backend/billing-subscription-item.mdx +++ b/clerk-typedoc/backend/billing-subscription-item.mdx @@ -2,22 +2,22 @@ The `BillingSubscriptionItem` object is similar to the [`BillingSubscriptionItem ## Properties -| Property | Type | Description | -| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `amount` | undefined \| null \| [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount) | The current amount for the subscription item. | -| `canceledAt` | null \| number | Unix timestamp (milliseconds) of when the subscription item was canceled. | -| `createdAt` | `number` | Unix timestamp (milliseconds) of when the subscription item was created. | -| `endedAt` | null \| number | Unix timestamp (milliseconds) of when the subscription item ended. | -| `id` | `string` | The unique identifier for the subscription item. | -| `isFreeTrial?` | `boolean` | Whether this subscription item is currently in a free trial period. | -| `lifetimePaid?` | null \| [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount) | The lifetime amount paid for this subscription item. | -| `nextPayment` | null \| \{ amount: number; date: number; \} | The next payment information. | -| `pastDueAt` | null \| number | Unix timestamp (milliseconds) of when the subscription item became past due. | -| `payerId` | `string` | The payer ID. | -| `periodEnd` | null \| number | Unix timestamp (milliseconds) of when the current period ends. | -| `periodStart` | `number` | Unix timestamp (milliseconds) of when the current period starts. | -| `plan` | null \| [BillingPlan](billing-plan.mdx) | The plan associated with this subscription item. | -| `planId` | null \| string | The plan ID. | -| `planPeriod` | "month" \| "annual" | The plan period for the subscription item. | -| `status` | `BillingSubscriptionItemStatus` | The status of the subscription item. | -| `updatedAt` | `number` | Unix timestamp (milliseconds) of when the subscription item was last updated. | +| Property | Type | Description | +| ----------------------------------------- | -------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `amount` | undefined \| null \| BillingMoneyAmount | The current amount for the subscription item. | +| `canceledAt` | null \| number | Unix timestamp (milliseconds) of when the subscription item was canceled. | +| `createdAt` | `number` | Unix timestamp (milliseconds) of when the subscription item was created. | +| `endedAt` | null \| number | Unix timestamp (milliseconds) of when the subscription item ended. | +| `id` | `string` | The unique identifier for the subscription item. | +| `isFreeTrial?` | `boolean` | Whether this subscription item is currently in a free trial period. | +| `lifetimePaid?` | null \| BillingMoneyAmount | The lifetime amount paid for this subscription item. | +| `nextPayment` | null \| \{ amount: number; date: number; \} | The next payment information. | +| `pastDueAt` | null \| number | Unix timestamp (milliseconds) of when the subscription item became past due. | +| `payerId` | `string` | The payer ID. | +| `periodEnd` | null \| number | Unix timestamp (milliseconds) of when the current period ends. | +| `periodStart` | `number` | Unix timestamp (milliseconds) of when the current period starts. | +| `plan` | null \| [BillingPlan](billing-plan.mdx) | The plan associated with this subscription item. | +| `planId` | null \| string | The plan ID. | +| `planPeriod` | "month" \| "annual" | The plan period for the subscription item. | +| `status` | `BillingSubscriptionItemStatus` | The status of the subscription item. | +| `updatedAt` | `number` | Unix timestamp (milliseconds) of when the subscription item was last updated. | diff --git a/clerk-typedoc/backend/billing-subscription.mdx b/clerk-typedoc/backend/billing-subscription.mdx index d66c27dc6b..1617a9fa3d 100644 --- a/clerk-typedoc/backend/billing-subscription.mdx +++ b/clerk-typedoc/backend/billing-subscription.mdx @@ -2,15 +2,15 @@ The `BillingSubscription` object is similar to the [`BillingSubscriptionResource ## Properties -| Property | Type | Description | -| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| `activeAt` | null \| number | Unix timestamp (milliseconds) of when the subscription became active. | -| `createdAt` | `number` | Unix timestamp (milliseconds) of when the subscription was created. | -| `eligibleForFreeTrial` | `boolean` | Whether the payer is eligible for a free trial. | -| `id` | `string` | The unique identifier for the billing subscription. | -| `nextPayment` | null \| \{ amount: [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount); date: number; \} | Information about the next scheduled payment. | -| `pastDueAt` | null \| number | Unix timestamp (milliseconds) of when the subscription became past due. | -| `payerId` | `string` | The ID of the payer for this subscription. | -| `status` | "abandoned" \| "active" \| "ended" \| "canceled" \| "incomplete" \| "past_due" | The current status of the subscription. | -| `subscriptionItems` | [BillingSubscriptionItem](billing-subscription-item.mdx)[] | Array of subscription items in this subscription. | -| `updatedAt` | `number` | Unix timestamp (milliseconds) of when the subscription was last updated. | +| Property | Type | Description | +| -------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| `activeAt` | null \| number | Unix timestamp (milliseconds) of when the subscription became active. | +| `createdAt` | `number` | Unix timestamp (milliseconds) of when the subscription was created. | +| `eligibleForFreeTrial` | `boolean` | Whether the payer is eligible for a free trial. | +| `id` | `string` | The unique identifier for the billing subscription. | +| `nextPayment` | null \| \{ amount: BillingMoneyAmount; date: number; \} | Information about the next scheduled payment. | +| `pastDueAt` | null \| number | Unix timestamp (milliseconds) of when the subscription became past due. | +| `payerId` | `string` | The ID of the payer for this subscription. | +| `status` | "abandoned" \| "active" \| "ended" \| "canceled" \| "incomplete" \| "past_due" | The current status of the subscription. | +| `subscriptionItems` | [BillingSubscriptionItem](billing-subscription-item.mdx)[] | Array of subscription items in this subscription. | +| `updatedAt` | `number` | Unix timestamp (milliseconds) of when the subscription was last updated. | diff --git a/clerk-typedoc/backend/get-auth-fn-no-request.mdx b/clerk-typedoc/backend/get-auth-fn-no-request.mdx index e59e808fa3..0111bb1b7f 100644 --- a/clerk-typedoc/backend/get-auth-fn-no-request.mdx +++ b/clerk-typedoc/backend/get-auth-fn-no-request.mdx @@ -64,7 +64,7 @@ Shared generic overload type for auth() or getAuth() helpers that don't require ### Returns -`MaybePromise`\<InvalidTokenAuthObject \| \{ debug: () => \{ [key: string]: any; \}; getToken: () => Promise\; has: [CheckAuthorizationFromSessionClaims](../types/check-authorization-from-session-claims.mdx); id: null; isAuthenticated: false; scopes: null; subject: null; tokenType: "api_key"; \} & \{ claims: null; name: null; orgId: null; userId: null; \} \| \{ debug: () => \{ [key: string]: any; \}; getToken: () => Promise\; has: [CheckAuthorizationFromSessionClaims](../types/check-authorization-from-session-claims.mdx); id: null; isAuthenticated: false; scopes: null; subject: null; tokenType: "m2m_token"; \} & \{ claims: null; machineId: null; \} \| \{ debug: () => \{ [key: string]: any; \}; getToken: () => Promise\; has: [CheckAuthorizationFromSessionClaims](../types/check-authorization-from-session-claims.mdx); id: null; isAuthenticated: false; scopes: null; subject: null; tokenType: "oauth_token"; \} & \{ clientId: null; userId: null; \} \| \{ id: string; subject: string; scopes: string\[\]; getToken: () =\> Promise\; has: CheckAuthorizationFromSessionClaims; debug: AuthObjectDebug; tokenType: "api_key"; isAuthenticated: true; \} & (\{ ...; \} \| \{ ...; \}) \| \{ debug: () => \{ [key: string]: any; \}; getToken: () => Promise\; has: [CheckAuthorizationFromSessionClaims](../types/check-authorization-from-session-claims.mdx); id: string; isAuthenticated: true; scopes: string[]; subject: string; tokenType: "m2m_token"; \} & \{ claims: null \| Claims; machineId: string; \} \| \{ debug: () => \{ [key: string]: any; \}; getToken: () => Promise\; has: [CheckAuthorizationFromSessionClaims](../types/check-authorization-from-session-claims.mdx); id: string; isAuthenticated: true; scopes: string[]; subject: string; tokenType: "oauth_token"; \} & \{ clientId: string; userId: string; \} \| SessionAuthType, `ReturnsPromise`\> +`MaybePromise`\<InvalidTokenAuthObject \| \{ debug: () => \{ [key: string]: any; \}; getToken: () => Promise\; has: CheckAuthorizationFromSessionClaims; id: null; isAuthenticated: false; scopes: null; subject: null; tokenType: "api_key"; \} & \{ claims: null; name: null; orgId: null; userId: null; \} \| \{ debug: () => \{ [key: string]: any; \}; getToken: () => Promise\; has: CheckAuthorizationFromSessionClaims; id: null; isAuthenticated: false; scopes: null; subject: null; tokenType: "m2m_token"; \} & \{ claims: null; machineId: null; \} \| \{ debug: () => \{ [key: string]: any; \}; getToken: () => Promise\; has: CheckAuthorizationFromSessionClaims; id: null; isAuthenticated: false; scopes: null; subject: null; tokenType: "oauth_token"; \} & \{ clientId: null; userId: null; \} \| \{ id: string; subject: string; scopes: string\[\]; getToken: () =\> Promise\; has: CheckAuthorizationFromSessionClaims; debug: AuthObjectDebug; tokenType: "api_key"; isAuthenticated: true; \} & (\{ ...; \} \| \{ ...; \}) \| \{ debug: () => \{ [key: string]: any; \}; getToken: () => Promise\; has: CheckAuthorizationFromSessionClaims; id: string; isAuthenticated: true; scopes: string[]; subject: string; tokenType: "m2m_token"; \} & \{ claims: null \| Claims; machineId: string; \} \| \{ debug: () => \{ [key: string]: any; \}; getToken: () => Promise\; has: CheckAuthorizationFromSessionClaims; id: string; isAuthenticated: true; scopes: string[]; subject: string; tokenType: "oauth_token"; \} & \{ clientId: string; userId: string; \} \| SessionAuthType, `ReturnsPromise`\> ### Example diff --git a/clerk-typedoc/backend/verify-machine-auth-token.mdx b/clerk-typedoc/backend/verify-machine-auth-token.mdx index 43fc12b40b..003154b7b8 100644 --- a/clerk-typedoc/backend/verify-machine-auth-token.mdx +++ b/clerk-typedoc/backend/verify-machine-auth-token.mdx @@ -2,10 +2,19 @@ Verifies any type of machine token by detecting its type from the prefix. ## Parameters -| Parameter | Type | Description | -| --------- | --------------------------------------------- | ------------------------------------------------------------------------- | -| `token` | `string` | The token to verify (e.g. starts with "m2m*", "oauth*", "api*key*", etc.) | -| `options` | [`VerifyTokenOptions`](#verify-token-options) | Options including secretKey for BAPI authorization | +| Parameter | Type | Description | +| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `token` | `string` | The token to verify (e.g. starts with "m2m*", "oauth*", "api*key*", etc.) | +| `options` | \{ apiUrl?: string; apiVersion?: string; audience?: string \| string[]; authorizedParties?: string[]; clockSkewInMs?: number; jwksCacheTtlInMs?: number; jwtKey?: string; secretKey?: string; skipJwksCache?: boolean; \} | Options including secretKey for BAPI authorization | +| `options.apiUrl?` | `string` | The [Clerk Backend API](/docs/reference/backend-api){{ target: '_blank' }} endpoint. Defaults to `'https://api.clerk.com'`. | +| `options.apiVersion?` | `string` | The version passed to the Clerk API. Defaults to `'v1'`. | +| `options.audience?` | string \| string[] | A string or list of [audiences](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3). If passed, it is checked against the `aud` claim in the token. | +| `options.authorizedParties?` | string[] | An allowlist of origins to verify against, to protect your application from the subdomain cookie leaking attack. Example: `['http://localhost:3000', 'https://example.com']`. | +| `options.clockSkewInMs?` | `number` | Specifies the allowed time difference (in milliseconds) between the Clerk server (which generates the token) and the clock of the user's application server when validating a token. Defaults to `5000`. | +| `options.jwksCacheTtlInMs?` | `number` | **Deprecated.** This cache TTL will be removed in the next major version. Specifying a cache TTL is a no-op. | +| `options.jwtKey?` | `string` | Used to verify the session token in a networkless manner. Supply the PEM public key from the **[**API keys**](https://dashboard.clerk.com/last-active?path=api-keys) page -> Show JWT public key -> PEM Public Key** section in the Clerk Dashboard. **It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables) instead.** For more information, refer to [Manual JWT verification](/docs/guides/sessions/manual-jwt-verification). | +| `options.secretKey?` | `string` | The Clerk Secret Key from the [**API keys**](https://dashboard.clerk.com/last-active?path=api-keys) page in the Clerk Dashboard. | +| `options.skipJwksCache?` | `boolean` | A flag to ignore the JWKS cache and always fetch JWKS before each JWT verification. | ## Returns diff --git a/clerk-typedoc/backend/verify-token.mdx b/clerk-typedoc/backend/verify-token.mdx index f723647902..edd9340ec9 100644 --- a/clerk-typedoc/backend/verify-token.mdx +++ b/clerk-typedoc/backend/verify-token.mdx @@ -4,7 +4,17 @@ ```ts function verifyToken( token: string, - options: VerifyTokenOptions, + options: { + apiUrl?: string; + apiVersion?: string; + audience?: string | string[]; + authorizedParties?: string[]; + clockSkewInMs?: number; + jwksCacheTtlInMs?: number; + jwtKey?: string; + secretKey?: string; + skipJwksCache?: boolean; + }, ): Promise>; ``` @@ -12,10 +22,19 @@ Verifies a Clerk-generated token signature. Networkless if the `jwtKey` is provi ## Parameters -| Parameter | Type | Description | -| --------- | --------------------------------------------- | -------------------------------- | -| `token` | `string` | The token to verify. | -| `options` | [`VerifyTokenOptions`](#verify-token-options) | Options for verifying the token. | +| Parameter | Type | Description | +| ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `token` | `string` | The token to verify. | +| `options` | \{ apiUrl?: string; apiVersion?: string; audience?: string \| string[]; authorizedParties?: string[]; clockSkewInMs?: number; jwksCacheTtlInMs?: number; jwtKey?: string; secretKey?: string; skipJwksCache?: boolean; \} | Options for verifying the token. It is recommended to set these options as [environment variables](/docs/guides/development/clerk-environment-variables#api-and-sdk-configuration) where possible, and then pass them to the function. For example, you can set the `secretKey` option using the `CLERK_SECRET_KEY` environment variable, and then pass it to the function like this: `verifyToken(token, { secretKey: process.env.CLERK_SECRET_KEY })`. | +| `options.apiUrl?` | `string` | The [Clerk Backend API](/docs/reference/backend-api){{ target: '_blank' }} endpoint. Defaults to `'https://api.clerk.com'`. | +| `options.apiVersion?` | `string` | The version passed to the Clerk API. Defaults to `'v1'`. | +| `options.audience?` | string \| string[] | A string or list of [audiences](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3). If passed, it is checked against the `aud` claim in the token. | +| `options.authorizedParties?` | string[] | An allowlist of origins to verify against, to protect your application from the subdomain cookie leaking attack. Example: `['http://localhost:3000', 'https://example.com']`. | +| `options.clockSkewInMs?` | `number` | Specifies the allowed time difference (in milliseconds) between the Clerk server (which generates the token) and the clock of the user's application server when validating a token. Defaults to `5000`. | +| `options.jwksCacheTtlInMs?` | `number` | **Deprecated.** This cache TTL will be removed in the next major version. Specifying a cache TTL is a no-op. | +| `options.jwtKey?` | `string` | Used to verify the session token in a networkless manner. Supply the PEM public key from the **[**API keys**](https://dashboard.clerk.com/last-active?path=api-keys) page -> Show JWT public key -> PEM Public Key** section in the Clerk Dashboard. **It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables) instead.** For more information, refer to [Manual JWT verification](/docs/guides/sessions/manual-jwt-verification). | +| `options.secretKey?` | `string` | The Clerk Secret Key from the [**API keys**](https://dashboard.clerk.com/last-active?path=api-keys) page in the Clerk Dashboard. | +| `options.skipJwksCache?` | `boolean` | A flag to ignore the JWKS cache and always fetch JWKS before each JWT verification. | ## Example diff --git a/clerk-typedoc/backend/verify-webhook.mdx b/clerk-typedoc/backend/verify-webhook.mdx index 4270bae4a3..e2ce7b9762 100644 --- a/clerk-typedoc/backend/verify-webhook.mdx +++ b/clerk-typedoc/backend/verify-webhook.mdx @@ -1,7 +1,10 @@ Verifies the authenticity of a webhook request using Standard Webhooks. Returns a promise that resolves to the verified webhook event data. ```ts -function verifyWebhook(request: Request, options: { signingSecret?: string; }): Promise +function verifyWebhook( + request: Request, + options: { signingSecret?: string }, +): Promise; ``` ## Parameters diff --git a/clerk-typedoc/clerk-react/api-keys.mdx b/clerk-typedoc/clerk-react/api-keys.mdx index 091871e995..4e7c1192d0 100644 --- a/clerk-typedoc/clerk-react/api-keys.mdx +++ b/clerk-typedoc/clerk-react/api-keys.mdx @@ -1,8 +1,8 @@ ## Parameters -| Parameter | Type | -| --------- | --------------------------------------------------- | -| `props` | [`Without`](../types/without.mdx)\<`P`, `"clerk"`\> | +| Parameter | Type | +| --------- | --------------------------- | +| `props` | `Without`\<`P`, `"clerk"`\> | ## Returns diff --git a/clerk-typedoc/clerk-react/checkout-button.mdx b/clerk-typedoc/clerk-react/checkout-button.mdx index 08d04e7193..5ce1c27be6 100644 --- a/clerk-typedoc/clerk-react/checkout-button.mdx +++ b/clerk-typedoc/clerk-react/checkout-button.mdx @@ -3,9 +3,9 @@ inside a `` component to ensure the user is authenticated. ## Parameters -| Parameter | Type | -| --------- | --------------------------------------------------- | -| `props` | [`Without`](../types/without.mdx)\<`P`, `"clerk"`\> | +| Parameter | Type | +| --------- | --------------------------- | +| `props` | `Without`\<`P`, `"clerk"`\> | ## Returns diff --git a/clerk-typedoc/clerk-react/clerk-provider-props.mdx b/clerk-typedoc/clerk-react/clerk-provider-props.mdx index 3ace97e6b9..a25272b0cc 100644 --- a/clerk-typedoc/clerk-react/clerk-provider-props.mdx +++ b/clerk-typedoc/clerk-react/clerk-provider-props.mdx @@ -1,43 +1,43 @@ ## Properties -| Property | Type | Description | -| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `afterMultiSessionSingleSignOutUrl?` | null \| string | The full URL or path to navigate to after signing out the current user is complete. This option applies to [multi-session applications](/docs/guides/secure/session-options#multi-session-applications). | -| ~~`afterSignInUrl?`~~ | null \| string | **Deprecated.** Use `signInFallbackRedirectUrl` or `signInForceRedirectUrl` instead. | -| `afterSignOutUrl?` | null \| string | Full URL or path to navigate to after successful sign out. | -| ~~`afterSignUpUrl?`~~ | null \| string | **Deprecated.** Use `signUpFallbackRedirectUrl` or `signUpForceRedirectUrl` instead. | -| `allowedRedirectOrigins?` | (string \| RegExp)[] | An optional array of domains to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console. | -| `allowedRedirectProtocols?` | string[] | An optional array of protocols to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console. | -| `appearance?` | `Appearance` | Optional object to style your components. Will only affect [Clerk Components](/docs/reference/components/overview) and not [Account Portal](/docs/guides/customizing-clerk/account-portal) pages. | -| `clerkJSUrl?` | `string` | The URL that `@clerk/clerk-js` should be hot-loaded from. | -| `clerkJSVariant?` | "" \| "headless" | If your web application only uses [Control Components](/docs/reference/components/overview#control-components), you can set this value to `'headless'` and load a minimal ClerkJS bundle for optimal page performance. | -| `clerkJSVersion?` | `string` | The npm version for `@clerk/clerk-js`. | -| `domain?` | string \| (url: URL) => string | **Required if your application is a satellite application**. Sets the domain of the satellite application. | -| `experimental?` | `Autocomplete`\<\{ commerce: boolean; persistClient: boolean; rethrowOfflineNetworkErrors: boolean; \}, `Record`\<`string`, `any`\>\> | Enable experimental flags to gain access to new features. These flags are not guaranteed to be stable and may change drastically in between patch or minor versions. | -| `initialState?` | `Serializable`\<\{ actor: undefined \| \{ [x: string]: unknown; sub: string; \}; factorVerificationAge: \[number, number\]; organization: undefined \| [OrganizationResource](/docs/reference/javascript/organization); orgId: undefined \| string; orgPermissions: undefined \| string[]; orgRole: undefined \| string; orgSlug: undefined \| string; session: undefined \| [SessionResource](/docs/reference/javascript/session); sessionClaims: JwtPayload; sessionId: undefined \| string; sessionStatus: [SessionStatusClaim](/docs/reference/javascript/types/session-status); user: undefined \| [UserResource](/docs/reference/javascript/user); userId: undefined \| string; \}\> | Provide an initial state of the Clerk client during server-side rendering. You don't need to set this value yourself unless you're [developing an SDK](/docs/guides/development/sdk-development/overview). | -| `isSatellite?` | boolean \| (url: URL) => boolean | A boolean that indicates whether the application is a satellite application. | -| `localization?` | [`LocalizationResource`](/docs/guides/customizing-clerk/localization) | Optional object to localize your components. Will only affect [Clerk Components](/docs/reference/components/overview) and not [Account Portal](/docs/guides/customizing-clerk/account-portal) pages. | -| `newSubscriptionRedirectUrl?` | null \| string | The URL to navigate to after the user completes the checkout and clicks the "Continue" button. | -| `nonce?` | `string` | This nonce value will be passed through to the `@clerk/clerk-js` script tag. Use it to implement a [strict-dynamic CSP](/docs/guides/secure/best-practices/csp-headers#implementing-a-strict-dynamic-csp). Requires the `dynamic` prop to also be set. | -| `proxyUrl?` | string \| (url: URL) => string \| (url: URL) => string | **Required for applications that run behind a reverse proxy**. The URL that Clerk will proxy requests to. Can be either a relative path (`/__clerk`) or a full URL (`https:///__clerk`). | -| `publishableKey` | `string` | The Clerk Publishable Key for your instance. This can be found on the [API keys](https://dashboard.clerk.com/last-active?path=api-keys) page in the Clerk Dashboard. | -| ~~`redirectUrl?`~~ | null \| string | **Deprecated.** Use `signInFallbackRedirectUrl`, `signInForceRedirectUrl`, `signUpFallbackRedirectUrl`, or `signUpForceRedirectUrl` instead. | -| `routerPush?` | (to: string, metadata?: \{ windowNavigate: (to: string \| URL) => void; \}) => unknown | A function which takes the destination path as an argument and performs a "push" navigation. | -| `routerReplace?` | (to: string, metadata?: \{ windowNavigate: (to: string \| URL) => void; \}) => unknown | A function which takes the destination path as an argument and performs a "replace" navigation. | -| `sdkMetadata?` | \{ environment?: string; name: string; version: string; \} | Contains information about the SDK that the host application is using. You don't need to set this value yourself unless you're [developing an SDK](/docs/guides/development/sdk-development/overview). | -| `sdkMetadata.environment?` | `string` | Typically this will be the `NODE_ENV` that the SDK is currently running in. | -| `sdkMetadata.name` | `string` | The npm package name of the SDK. | -| `sdkMetadata.version` | `string` | The npm package version of the SDK. | -| `selectInitialSession?` | (client: ClientResource) => null \| [SignedInSessionResource](/docs/reference/javascript/session) | By default, the last signed-in session is used during client initialization. This option allows you to override that behavior, e.g. by selecting a specific session. | -| `signInFallbackRedirectUrl?` | null \| string | The fallback URL to redirect to after the user signs in, if there's no `redirect_url` in the path already. It's recommended to use the [environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. Defaults to `'/'`. | -| `signInForceRedirectUrl?` | null \| string | This URL will always be redirected to after the user signs in. It's recommended to use the [environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. | -| `signInUrl?` | `string` | This URL will be used for any redirects that might happen and needs to point to your primary application on the client-side. This option is optional for production instances. **It is required to be set for a satellite application in a development instance**. It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. | -| `signUpFallbackRedirectUrl?` | null \| string | The fallback URL to redirect to after the user signs up, if there's no `redirect_url` in the path already. It's recommended to use the [environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. Defaults to `'/'`. | -| `signUpForceRedirectUrl?` | null \| string | This URL will always be redirected to after the user signs up. It's recommended to use the [environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. | -| `signUpUrl?` | `string` | This URL will be used for any redirects that might happen and needs to point to your primary application on the client-side. This option is optional for production instances but **must be set for a satellite application in a development instance**. It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. | -| `standardBrowser?` | `boolean` | By default, ClerkJS is loaded with the assumption that cookies can be set (browser setup). On native platforms this value must be set to `false`. | -| `supportEmail?` | `string` | Optional support email for display in authentication screens. Will only affect [Clerk Components](/docs/reference/components/overview) and not [Account Portal](/docs/guides/customizing-clerk/account-portal) pages. | -| `taskUrls?` | `Record`\<`"choose-organization"`, `string`\> | Customize the URL paths users are redirected to after sign-in or sign-up when specific session tasks need to be completed. When `undefined`, it uses Clerk's default task flow URLs. Defaults to `undefined`. | -| `telemetry?` | false \| \{ debug?: boolean; disabled?: boolean; perEventSampling?: boolean; \} | Controls whether or not Clerk will collect [telemetry data](/docs/guides/how-clerk-works/security/clerk-telemetry). If set to `debug`, telemetry events are only logged to the console and not sent to Clerk. | -| `touchSession?` | `boolean` | By default, the [Clerk Frontend API `touch` endpoint](/docs/reference/frontend-api/tag/Sessions#operation/touchSession) is called during page focus to keep the last active session alive. This option allows you to disable this behavior. | -| `waitlistUrl?` | `string` | The full URL or path to the waitlist page. If `undefined`, will redirect to the [Account Portal waitlist page](/docs/guides/customizing-clerk/account-portal#waitlist). | +| Property | Type | Description | +| ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `afterMultiSessionSingleSignOutUrl?` | null \| string | The full URL or path to navigate to after signing out the current user is complete. This option applies to [multi-session applications](/docs/guides/secure/session-options#multi-session-applications). | +| ~~`afterSignInUrl?`~~ | null \| string | **Deprecated.** Use `signInFallbackRedirectUrl` or `signInForceRedirectUrl` instead. | +| `afterSignOutUrl?` | null \| string | Full URL or path to navigate to after successful sign out. | +| ~~`afterSignUpUrl?`~~ | null \| string | **Deprecated.** Use `signUpFallbackRedirectUrl` or `signUpForceRedirectUrl` instead. | +| `allowedRedirectOrigins?` | (string \| RegExp)[] | An optional array of domains to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console. | +| `allowedRedirectProtocols?` | string[] | An optional array of protocols to validate user-provided redirect URLs against. If no match is made, the redirect is considered unsafe and the default redirect will be used with a warning logged in the console. | +| `appearance?` | `Appearance`\<`Theme`\> | Optional object to style your components. Will only affect [Clerk Components](/docs/reference/components/overview) and not [Account Portal](/docs/guides/customizing-clerk/account-portal) pages. | +| `clerkJSUrl?` | `string` | The URL that `@clerk/clerk-js` should be hot-loaded from. | +| `clerkJSVariant?` | "" \| "headless" | If your web application only uses [Control Components](/docs/reference/components/overview#control-components), you can set this value to `'headless'` and load a minimal ClerkJS bundle for optimal page performance. | +| `clerkJSVersion?` | `string` | The npm version for `@clerk/clerk-js`. | +| `domain?` | string \| (url: URL) => string | **Required if your application is a satellite application**. Sets the domain of the satellite application. | +| `experimental?` | `Autocomplete`\<\{ commerce: boolean; persistClient: boolean; rethrowOfflineNetworkErrors: boolean; \}, `Record`\<`string`, `any`\>\> | Enable experimental flags to gain access to new features. These flags are not guaranteed to be stable and may change drastically in between patch or minor versions. | +| `initialState?` | `Serializable`\<\{ actor: undefined \| \{ [x: string]: unknown; sub: string; \}; factorVerificationAge: \[number, number\]; organization: undefined \| OrganizationResource; orgId: undefined \| string; orgPermissions: undefined \| string[]; orgRole: undefined \| string; orgSlug: undefined \| string; session: undefined \| SessionResource; sessionClaims: JwtPayload; sessionId: undefined \| string; sessionStatus: SessionStatusClaim; user: undefined \| UserResource; userId: undefined \| string; \}\> | Provide an initial state of the Clerk client during server-side rendering. You don't need to set this value yourself unless you're [developing an SDK](/docs/guides/development/sdk-development/overview). | +| `isSatellite?` | boolean \| (url: URL) => boolean | A boolean that indicates whether the application is a satellite application. | +| `localization?` | `LocalizationResource` | Optional object to localize your components. Will only affect [Clerk Components](/docs/reference/components/overview) and not [Account Portal](/docs/guides/customizing-clerk/account-portal) pages. | +| `newSubscriptionRedirectUrl?` | null \| string | The URL to navigate to after the user completes the checkout and clicks the "Continue" button. | +| `nonce?` | `string` | This nonce value will be passed through to the `@clerk/clerk-js` script tag. Use it to implement a [strict-dynamic CSP](/docs/guides/secure/best-practices/csp-headers#implementing-a-strict-dynamic-csp). Requires the `dynamic` prop to also be set. | +| `proxyUrl?` | string \| (url: URL) => string \| (url: URL) => string | **Required for applications that run behind a reverse proxy**. The URL that Clerk will proxy requests to. Can be either a relative path (`/__clerk`) or a full URL (`https:///__clerk`). | +| `publishableKey` | `string` | The Clerk Publishable Key for your instance. This can be found on the [API keys](https://dashboard.clerk.com/last-active?path=api-keys) page in the Clerk Dashboard. | +| ~~`redirectUrl?`~~ | null \| string | **Deprecated.** Use `signInFallbackRedirectUrl`, `signInForceRedirectUrl`, `signUpFallbackRedirectUrl`, or `signUpForceRedirectUrl` instead. | +| `routerPush?` | (to: string, metadata?: \{ windowNavigate: (to: string \| URL) => void; \}) => unknown | A function which takes the destination path as an argument and performs a "push" navigation. | +| `routerReplace?` | (to: string, metadata?: \{ windowNavigate: (to: string \| URL) => void; \}) => unknown | A function which takes the destination path as an argument and performs a "replace" navigation. | +| `sdkMetadata?` | \{ environment?: string; name: string; version: string; \} | Contains information about the SDK that the host application is using. You don't need to set this value yourself unless you're [developing an SDK](/docs/guides/development/sdk-development/overview). | +| `sdkMetadata.environment?` | `string` | Typically this will be the `NODE_ENV` that the SDK is currently running in. | +| `sdkMetadata.name` | `string` | The npm package name of the SDK. | +| `sdkMetadata.version` | `string` | The npm package version of the SDK. | +| `selectInitialSession?` | (client: ClientResource) => null \| SignedInSessionResource | By default, the last signed-in session is used during client initialization. This option allows you to override that behavior, e.g. by selecting a specific session. | +| `signInFallbackRedirectUrl?` | null \| string | The fallback URL to redirect to after the user signs in, if there's no `redirect_url` in the path already. It's recommended to use the [environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. Defaults to `'/'`. | +| `signInForceRedirectUrl?` | null \| string | This URL will always be redirected to after the user signs in. It's recommended to use the [environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. | +| `signInUrl?` | `string` | This URL will be used for any redirects that might happen and needs to point to your primary application on the client-side. This option is optional for production instances. **It is required to be set for a satellite application in a development instance**. It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. | +| `signUpFallbackRedirectUrl?` | null \| string | The fallback URL to redirect to after the user signs up, if there's no `redirect_url` in the path already. It's recommended to use the [environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. Defaults to `'/'`. | +| `signUpForceRedirectUrl?` | null \| string | This URL will always be redirected to after the user signs up. It's recommended to use the [environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. | +| `signUpUrl?` | `string` | This URL will be used for any redirects that might happen and needs to point to your primary application on the client-side. This option is optional for production instances but **must be set for a satellite application in a development instance**. It's recommended to use [the environment variable](/docs/guides/development/clerk-environment-variables#sign-in-and-sign-up-redirects) instead. | +| `standardBrowser?` | `boolean` | By default, ClerkJS is loaded with the assumption that cookies can be set (browser setup). On native platforms this value must be set to `false`. | +| `supportEmail?` | `string` | Optional support email for display in authentication screens. Will only affect [Clerk Components](/docs/reference/components/overview) and not [Account Portal](/docs/guides/customizing-clerk/account-portal) pages. | +| `taskUrls?` | `Record`\<`"choose-organization"`, `string`\> | Customize the URL paths users are redirected to after sign-in or sign-up when specific session tasks need to be completed. When `undefined`, it uses Clerk's default task flow URLs. Defaults to `undefined`. | +| `telemetry?` | false \| \{ debug?: boolean; disabled?: boolean; perEventSampling?: boolean; \} | Controls whether or not Clerk will collect [telemetry data](/docs/guides/how-clerk-works/security/clerk-telemetry). If set to `debug`, telemetry events are only logged to the console and not sent to Clerk. | +| `touchSession?` | `boolean` | By default, the [Clerk Frontend API `touch` endpoint](/docs/reference/frontend-api/tag/Sessions#operation/touchSession) is called during page focus to keep the last active session alive. This option allows you to disable this behavior. | +| `waitlistUrl?` | `string` | The full URL or path to the waitlist page. If `undefined`, will redirect to the [Account Portal waitlist page](/docs/guides/customizing-clerk/account-portal#waitlist). | diff --git a/clerk-typedoc/clerk-react/plan-details-button-props.mdx b/clerk-typedoc/clerk-react/plan-details-button-props.mdx index a92694f227..76fcaf3640 100644 --- a/clerk-typedoc/clerk-react/plan-details-button-props.mdx +++ b/clerk-typedoc/clerk-react/plan-details-button-props.mdx @@ -1,4 +1,4 @@ | Name | Type | | -------------------- | -------------------------------------------------------------------------------------------- | -| `initialPlanPeriod?` | [`BillingSubscriptionPlanPeriod`](../types/billing-subscription-plan-period.mdx) | +| `initialPlanPeriod?` | "month" \| "annual" | | `planDetailsProps?` | \{ appearance?: PlanDetailTheme; portalId?: string; portalRoot?: PortalRoot; \} | diff --git a/clerk-typedoc/clerk-react/plan-details-button.mdx b/clerk-typedoc/clerk-react/plan-details-button.mdx index f5339aabf1..83fcb66250 100644 --- a/clerk-typedoc/clerk-react/plan-details-button.mdx +++ b/clerk-typedoc/clerk-react/plan-details-button.mdx @@ -3,9 +3,9 @@ Clerk's Billing feature which is available under a public beta. ## Parameters -| Parameter | Type | -| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `props` | [`Without`](../types/without.mdx)\<`WithClerkProp`\<`PropsWithChildren`\<[`PlanDetailsButtonProps`](plan-details-button-props.mdx)\>\>, `"clerk"`\> | +| Parameter | Type | +| --------- | --------------------------------------------------------------------------------------------------------------------------- | +| `props` | `Without`\<`WithClerkProp`\<`PropsWithChildren`\<[`PlanDetailsButtonProps`](plan-details-button-props.mdx)\>\>, `"clerk"`\> | ## Returns diff --git a/clerk-typedoc/clerk-react/redirect-to-create-organization.mdx b/clerk-typedoc/clerk-react/redirect-to-create-organization.mdx index 929355bda4..1a378d95d1 100644 --- a/clerk-typedoc/clerk-react/redirect-to-create-organization.mdx +++ b/clerk-typedoc/clerk-react/redirect-to-create-organization.mdx @@ -1,8 +1,8 @@ ## Parameters -| Parameter | Type | -| --------- | --------------------------------------------------- | -| `props` | [`Without`](../types/without.mdx)\<`P`, `"clerk"`\> | +| Parameter | Type | +| --------- | --------------------------- | +| `props` | `Without`\<`P`, `"clerk"`\> | ## Returns diff --git a/clerk-typedoc/clerk-react/redirect-to-organization-profile.mdx b/clerk-typedoc/clerk-react/redirect-to-organization-profile.mdx index cc878fc79d..ec28dded7f 100644 --- a/clerk-typedoc/clerk-react/redirect-to-organization-profile.mdx +++ b/clerk-typedoc/clerk-react/redirect-to-organization-profile.mdx @@ -1,8 +1,8 @@ ## Parameters -| Parameter | Type | -| --------- | --------------------------------------------------- | -| `props` | [`Without`](../types/without.mdx)\<`P`, `"clerk"`\> | +| Parameter | Type | +| --------- | --------------------------- | +| `props` | `Without`\<`P`, `"clerk"`\> | ## Returns diff --git a/clerk-typedoc/clerk-react/redirect-to-user-profile.mdx b/clerk-typedoc/clerk-react/redirect-to-user-profile.mdx index 921f5d5176..a411167734 100644 --- a/clerk-typedoc/clerk-react/redirect-to-user-profile.mdx +++ b/clerk-typedoc/clerk-react/redirect-to-user-profile.mdx @@ -1,8 +1,8 @@ ## Parameters -| Parameter | Type | -| --------- | --------------------------------------------------- | -| `props` | [`Without`](../types/without.mdx)\<`P`, `"clerk"`\> | +| Parameter | Type | +| --------- | --------------------------- | +| `props` | `Without`\<`P`, `"clerk"`\> | ## Returns diff --git a/clerk-typedoc/clerk-react/subscription-details-button-props.mdx b/clerk-typedoc/clerk-react/subscription-details-button-props.mdx index c8ce68a675..0c52848f3c 100644 --- a/clerk-typedoc/clerk-react/subscription-details-button-props.mdx +++ b/clerk-typedoc/clerk-react/subscription-details-button-props.mdx @@ -1,7 +1,7 @@ -> **SubscriptionDetailsButtonProps** = \{ for?: [ForPayerType](../types/for-payer-type.mdx); \} +> **SubscriptionDetailsButtonProps** = \{ for?: "organization" \| "user"; \} ## Properties -| Property | Type | Description | -| ----------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `for?` | [`ForPayerType`](../types/for-payer-type.mdx) | The subscriber type to display the subscription details for. If `organization` is provided, the subscription details will be displayed for the active organization. Defaults to `'user'`. | +| Property | Type | Description | +| ----------------------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `for?` | "organization" \| "user" | The subscriber type to display the subscription details for. If `organization` is provided, the subscription details will be displayed for the active organization. Defaults to `'user'`. | diff --git a/clerk-typedoc/clerk-react/subscription-details-button.mdx b/clerk-typedoc/clerk-react/subscription-details-button.mdx index 2338e9a7dd..efc3931a1d 100644 --- a/clerk-typedoc/clerk-react/subscription-details-button.mdx +++ b/clerk-typedoc/clerk-react/subscription-details-button.mdx @@ -2,9 +2,9 @@ A button component that opens the Clerk Subscription Details drawer when clicked ## Parameters -| Parameter | Type | -| --------- | --------------------------------------------------- | -| `props` | [`Without`](../types/without.mdx)\<`P`, `"clerk"`\> | +| Parameter | Type | +| --------- | --------------------------- | +| `props` | `Without`\<`P`, `"clerk"`\> | ## Returns diff --git a/clerk-typedoc/clerk-react/use-organization-list.mdx b/clerk-typedoc/clerk-react/use-organization-list.mdx index c6f8b6d93c..4f8e3b688e 100644 --- a/clerk-typedoc/clerk-react/use-organization-list.mdx +++ b/clerk-typedoc/clerk-react/use-organization-list.mdx @@ -2,13 +2,13 @@ The `useOrganizationList()` hook provides access to the current user's organizat ## Parameters -| Parameter | Type | -| --------- | ---- | -| `params?` | `T` | +| Parameter | Type | +| --------- | ----- | +| `params?` | `T$1` | ## Returns -[`UseOrganizationListReturn`](../shared/use-organization-list-return.mdx)\<`T`\> +`UseOrganizationListReturn`\<`T$1`\> ## Examples diff --git a/clerk-typedoc/clerk-react/use-organization.mdx b/clerk-typedoc/clerk-react/use-organization.mdx index d37be2324c..0a8561401c 100644 --- a/clerk-typedoc/clerk-react/use-organization.mdx +++ b/clerk-typedoc/clerk-react/use-organization.mdx @@ -2,13 +2,13 @@ The `useOrganization()` hook retrieves attributes of the currently active organi ## Parameters -| Parameter | Type | -| --------- | ---- | -| `params?` | `T` | +| Parameter | Type | +| --------- | ----- | +| `params?` | `T$1` | ## Returns -[`UseOrganizationReturn`](../shared/use-organization-return.mdx)\<`T`\> +`UseOrganizationReturn`\<`T$1`\> ## Examples diff --git a/clerk-typedoc/clerk-react/use-session-list.mdx b/clerk-typedoc/clerk-react/use-session-list.mdx index 75aa725eb2..5b4881b670 100644 --- a/clerk-typedoc/clerk-react/use-session-list.mdx +++ b/clerk-typedoc/clerk-react/use-session-list.mdx @@ -16,8 +16,8 @@ There are multiple variants of this type available which you can select by click | Name | Type | Description | | ------ | ------ | ------ | | `isLoaded` | `true` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | -| `sessions` | [SessionResource](/docs/reference/javascript/session)[] | A list of sessions that have been registered on the client device. | -| `setActive()` | (setActiveParams: [SetActiveParams](/docs/reference/javascript/types/set-active-params)) => Promise\ | A function that sets the active session and/or organization. See the [reference doc](/docs/reference/javascript/clerk#set-active). | +| `sessions` | SessionResource[] | A list of sessions that have been registered on the client device. | +| `setActive()` | (setActiveParams: SetActiveParams) => Promise\ | A function that sets the active session and/or organization. See the [reference doc](/docs/reference/javascript/clerk#set-active). | diff --git a/clerk-typedoc/clerk-react/use-session.mdx b/clerk-typedoc/clerk-react/use-session.mdx index 86492af39d..8f774e5848 100644 --- a/clerk-typedoc/clerk-react/use-session.mdx +++ b/clerk-typedoc/clerk-react/use-session.mdx @@ -24,7 +24,7 @@ There are multiple variants of this type available which you can select by click | ------ | ------ | ------ | | `isLoaded` | `true` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | | `isSignedIn` | `boolean` | A boolean that indicates whether a user is currently signed in. | -| `session` | [`SignedInSessionResource`](/docs/reference/javascript/session) | The current session for the user. | +| `session` | `SignedInSessionResource` | The current session for the user. | diff --git a/clerk-typedoc/clerk-react/use-sign-in-signal.mdx b/clerk-typedoc/clerk-react/use-sign-in-signal.mdx index ef7778ee2f..4b120d0af1 100644 --- a/clerk-typedoc/clerk-react/use-sign-in-signal.mdx +++ b/clerk-typedoc/clerk-react/use-sign-in-signal.mdx @@ -2,7 +2,7 @@ This hook allows you to access the Signal-based `SignIn` resource. ## Returns -[`SignInSignalValue`](../types/sign-in-signal-value.mdx) +`SignInSignalValue` ## Example diff --git a/clerk-typedoc/clerk-react/use-sign-in.mdx b/clerk-typedoc/clerk-react/use-sign-in.mdx index f00ac47ce9..ccf306f5bd 100644 --- a/clerk-typedoc/clerk-react/use-sign-in.mdx +++ b/clerk-typedoc/clerk-react/use-sign-in.mdx @@ -16,8 +16,8 @@ There are multiple variants of this type available which you can select by click | Name | Type | Description | | ------ | ------ | ------ | | `isLoaded` | `true` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | -| `setActive()` | (setActiveParams: [SetActiveParams](/docs/reference/javascript/types/set-active-params)) => Promise\ | A function that sets the active session. See the [reference doc](/docs/reference/javascript/clerk#set-active). | -| `signIn` | [`SignInResource`](/docs/reference/javascript/sign-in) | An object that contains the current sign-in attempt status and methods to create a new sign-in attempt. | +| `setActive()` | (setActiveParams: SetActiveParams) => Promise\ | A function that sets the active session. See the [reference doc](/docs/reference/javascript/clerk#set-active). | +| `signIn` | [SignInResource](/docs/reference/javascript/sign-in) | An object that contains the current sign-in attempt status and methods to create a new sign-in attempt. | diff --git a/clerk-typedoc/clerk-react/use-sign-up.mdx b/clerk-typedoc/clerk-react/use-sign-up.mdx index 26ff444dec..10f1c56dc9 100644 --- a/clerk-typedoc/clerk-react/use-sign-up.mdx +++ b/clerk-typedoc/clerk-react/use-sign-up.mdx @@ -16,8 +16,8 @@ There are multiple variants of this type available which you can select by click | Name | Type | Description | | ------ | ------ | ------ | | `isLoaded` | `true` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | -| `setActive()` | (setActiveParams: [SetActiveParams](/docs/reference/javascript/types/set-active-params)) => Promise\ | A function that sets the active session. See the [reference doc](/docs/reference/javascript/clerk#set-active). | -| `signUp` | [`SignUpResource`](/docs/reference/javascript/sign-up) | An object that contains the current sign-up attempt status and methods to create a new sign-up attempt. | +| `setActive()` | (setActiveParams: SetActiveParams) => Promise\ | A function that sets the active session. See the [reference doc](/docs/reference/javascript/clerk#set-active). | +| `signUp` | `SignUpResource` | An object that contains the current sign-up attempt status and methods to create a new sign-up attempt. | diff --git a/clerk-typedoc/clerk-react/use-user.mdx b/clerk-typedoc/clerk-react/use-user.mdx index 4fb9fccef7..76bd412dcd 100644 --- a/clerk-typedoc/clerk-react/use-user.mdx +++ b/clerk-typedoc/clerk-react/use-user.mdx @@ -24,7 +24,7 @@ There are multiple variants of this type available which you can select by click | ------ | ------ | ------ | | `isLoaded` | `true` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | | `isSignedIn` | `true` | A boolean that returns `true` if the user is signed in. | -| `user` | [`UserResource`](/docs/reference/javascript/user) | The `User` object for the current user. | +| `user` | `UserResource` | The `User` object for the current user. | diff --git a/clerk-typedoc/shared/clerk-api-error.mdx b/clerk-typedoc/shared/clerk-api-error.mdx index 4264acbc3a..dfe793683f 100644 --- a/clerk-typedoc/shared/clerk-api-error.mdx +++ b/clerk-typedoc/shared/clerk-api-error.mdx @@ -2,7 +2,7 @@ This error contains the specific error message, code, and any additional metadat ## Implements -- [`ClerkAPIError`](../types/clerk-api-error.mdx) +- `ClerkAPIError` ## Properties diff --git a/clerk-typedoc/shared/derive-state.mdx b/clerk-typedoc/shared/derive-state.mdx index e1568a4b56..428921642e 100644 --- a/clerk-typedoc/shared/derive-state.mdx +++ b/clerk-typedoc/shared/derive-state.mdx @@ -2,28 +2,28 @@ Derives authentication state based on the current rendering context (SSR or clie ## Parameters -| Parameter | Type | -| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `clerkOperational` | `boolean` | -| `state` | `Resources` | -| `initialState` | undefined \| Serializable\<\{ actor: undefined \| \{ [x: string]: unknown; sub: string; \}; factorVerificationAge: \[number, number\]; organization: undefined \| [OrganizationResource](/docs/reference/javascript/organization); orgId: undefined \| string; orgPermissions: undefined \| string[]; orgRole: undefined \| string; orgSlug: undefined \| string; session: undefined \| [SessionResource](/docs/reference/javascript/session); sessionClaims: JwtPayload; sessionId: undefined \| string; sessionStatus: [SessionStatusClaim](/docs/reference/javascript/types/session-status); user: undefined \| [UserResource](/docs/reference/javascript/user); userId: undefined \| string; \}\> | +| Parameter | Type | +| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `clerkOperational` | `boolean` | +| `state` | `Resources` | +| `initialState` | undefined \| Serializable\<\{ actor: undefined \| \{ [x: string]: unknown; sub: string; \}; factorVerificationAge: \[number, number\]; organization: undefined \| OrganizationResource; orgId: undefined \| string; orgPermissions: undefined \| string[]; orgRole: undefined \| string; orgSlug: undefined \| string; session: undefined \| SessionResource; sessionClaims: JwtPayload; sessionId: undefined \| string; sessionStatus: SessionStatusClaim; user: undefined \| UserResource; userId: undefined \| string; \}\> | ## Returns -\{ actor: undefined \| null \| \{ [x: string]: unknown; sub: string; \}; factorVerificationAge: null \| \[number, number\]; organization: undefined \| null \| [OrganizationResource](/docs/reference/javascript/organization); orgId: undefined \| null \| string; orgPermissions: undefined \| null \| Autocomplete\[]; orgRole: undefined \| null \| string; orgSlug: undefined \| null \| string; session: undefined \| null \| [SignedInSessionResource](/docs/reference/javascript/session); sessionClaims: undefined \| null \| JwtPayload; sessionId: undefined \| null \| string; sessionStatus: undefined \| "active" \| "pending"; user: undefined \| null \| [UserResource](/docs/reference/javascript/user); userId: undefined \| null \| string; \} +\{ actor: undefined \| null \| \{ [x: string]: unknown; sub: string; \}; factorVerificationAge: null \| \[number, number\]; organization: undefined \| null \| OrganizationResource; orgId: undefined \| null \| string; orgPermissions: undefined \| null \| Autocomplete\[]; orgRole: undefined \| null \| string; orgSlug: undefined \| null \| string; session: undefined \| null \| SignedInSessionResource; sessionClaims: undefined \| null \| JwtPayload; sessionId: undefined \| null \| string; sessionStatus: undefined \| "active" \| "pending"; user: undefined \| null \| UserResource; userId: undefined \| null \| string; \} -| Name | Type | -| ----------------------- | ------------------------------------------------------------------------------------------------- | -| `actor` | undefined \| null \| \{ [x: string]: unknown; sub: string; \} | -| `factorVerificationAge` | null \| \[number, number\] | -| `organization` | undefined \| null \| [OrganizationResource](/docs/reference/javascript/organization) | -| `orgId` | undefined \| null \| string | -| `orgPermissions` | undefined \| null \| Autocomplete\[] | -| `orgRole` | undefined \| null \| string | -| `orgSlug` | undefined \| null \| string | -| `session` | undefined \| null \| [SignedInSessionResource](/docs/reference/javascript/session) | -| `sessionClaims` | undefined \| null \| JwtPayload | -| `sessionId` | undefined \| null \| string | -| `sessionStatus` | undefined \| "active" \| "pending" | -| `user` | undefined \| null \| [UserResource](/docs/reference/javascript/user) | -| `userId` | undefined \| null \| string | +| Name | Type | +| ----------------------- | ----------------------------------------------------------------------------------- | +| `actor` | undefined \| null \| \{ [x: string]: unknown; sub: string; \} | +| `factorVerificationAge` | null \| \[number, number\] | +| `organization` | undefined \| null \| OrganizationResource | +| `orgId` | undefined \| null \| string | +| `orgPermissions` | undefined \| null \| Autocomplete\[] | +| `orgRole` | undefined \| null \| string | +| `orgSlug` | undefined \| null \| string | +| `session` | undefined \| null \| SignedInSessionResource | +| `sessionClaims` | undefined \| null \| JwtPayload | +| `sessionId` | undefined \| null \| string | +| `sessionStatus` | undefined \| "active" \| "pending" | +| `user` | undefined \| null \| UserResource | +| `userId` | undefined \| null \| string | diff --git a/clerk-typedoc/shared/paginated-resources.mdx b/clerk-typedoc/shared/paginated-resources.mdx index 73faa6500b..39eb461fff 100644 --- a/clerk-typedoc/shared/paginated-resources.mdx +++ b/clerk-typedoc/shared/paginated-resources.mdx @@ -1,17 +1,17 @@ -| Property | Type | Description | -| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `count` | `number` | The total count of data that exist remotely. | -| `data` | T[] | An array that contains the fetched data. For example, for the `memberships` attribute, data will be an array of [`OrganizationMembership`](/docs/reference/javascript/types/organization-membership) objects. | -| `error` | null \| ClerkAPIResponseError | Clerk's API response error object. | -| `fetchNext` | () => void | A function that triggers the next page to be loaded. This is the same as `fetchPage(page => Math.min(pageCount, page + 1))`. | -| `fetchPage` | `ValueOrSetter`\<`number`\> | A function that triggers a specific page to be loaded. | -| `fetchPrevious` | () => void | A function that triggers the previous page to be loaded. This is the same as `fetchPage(page => Math.max(0, page - 1))`. | -| `hasNextPage` | `boolean` | A boolean that indicates if there are available pages to be fetched. | -| `hasPreviousPage` | `boolean` | A boolean that indicates if there are available pages to be fetched. | -| `isError` | `boolean` | A boolean that indicates the request failed. | -| `isFetching` | `boolean` | A boolean that is `true` if there is an ongoing request or a revalidation. | -| `isLoading` | `boolean` | A boolean that is `true` if there is an ongoing request and there is no fetched data. | -| `page` | `number` | The current page. | -| `pageCount` | `number` | The total amount of pages. It is calculated based on `count`, `initialPage`, and `pageSize`. | -| `revalidate` | () => Promise\ | A function that triggers a revalidation of the current page. | -| `setData` | `Infinite` _extends_ `true` ? `CacheSetter`\<(undefined \| [ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\)[]\> : `CacheSetter`\<undefined \| [ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\\> | A function that allows you to set the data manually. | +| Property | Type | Description | +| ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `count` | `number` | The total count of data that exist remotely. | +| `data` | T[] | An array that contains the fetched data. For example, for the `memberships` attribute, data will be an array of [`OrganizationMembership`](/docs/reference/javascript/types/organization-membership) objects. | +| `error` | null \| ClerkAPIResponseError | Clerk's API response error object. | +| `fetchNext` | () => void | A function that triggers the next page to be loaded. This is the same as `fetchPage(page => Math.min(pageCount, page + 1))`. | +| `fetchPage` | `ValueOrSetter`\<`number`\> | A function that triggers a specific page to be loaded. | +| `fetchPrevious` | () => void | A function that triggers the previous page to be loaded. This is the same as `fetchPage(page => Math.max(0, page - 1))`. | +| `hasNextPage` | `boolean` | A boolean that indicates if there are available pages to be fetched. | +| `hasPreviousPage` | `boolean` | A boolean that indicates if there are available pages to be fetched. | +| `isError` | `boolean` | A boolean that indicates the request failed. | +| `isFetching` | `boolean` | A boolean that is `true` if there is an ongoing request or a revalidation. | +| `isLoading` | `boolean` | A boolean that is `true` if there is an ongoing request and there is no fetched data. | +| `page` | `number` | The current page. | +| `pageCount` | `number` | The total amount of pages. It is calculated based on `count`, `initialPage`, and `pageSize`. | +| `revalidate` | () => Promise\ | A function that triggers a revalidation of the current page. | +| `setData` | `Infinite` _extends_ `true` ? `CacheSetter`\<(undefined \| ClerkPaginatedResponse\)[]\> : `CacheSetter`\<undefined \| ClerkPaginatedResponse\\> | A function that allows you to set the data manually. | diff --git a/clerk-typedoc/shared/use-organization-list-params.mdx b/clerk-typedoc/shared/use-organization-list-params.mdx index 592db3abc4..e1e4a7e160 100644 --- a/clerk-typedoc/shared/use-organization-list-params.mdx +++ b/clerk-typedoc/shared/use-organization-list-params.mdx @@ -1,5 +1,5 @@ | Property | Type | Description | | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `userInvitations?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: "expired" \| "revoked" \| "pending" \| "accepted"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `status`: A string that filters the invitations by the provided status.
  • Any of the properties described in [Shared properties](#shared-properties).
| +| `userInvitations?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: "expired" \| "pending" \| "accepted" \| "revoked"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `status`: A string that filters the invitations by the provided status.
  • Any of the properties described in [Shared properties](#shared-properties).
| | `userMemberships?` | true \| \{ initialPage?: number; pageSize?: number; \} & object & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • Any of the properties described in [Shared properties](#shared-properties).
| | `userSuggestions?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: "pending" \| "accepted" \| ("pending" \| "accepted")[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `status`: A string that filters the suggestions by the provided status.
  • Any of the properties described in [Shared properties](#shared-properties).
| diff --git a/clerk-typedoc/shared/use-organization-list-return.mdx b/clerk-typedoc/shared/use-organization-list-return.mdx index cf66cea9ce..5de7e7ab88 100644 --- a/clerk-typedoc/shared/use-organization-list-return.mdx +++ b/clerk-typedoc/shared/use-organization-list-return.mdx @@ -1,8 +1,8 @@ -| Property | Type | Description | -| ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `createOrganization` | undefined \| (CreateOrganizationParams: [CreateOrganizationParams](#create-organization-params)) => Promise\<[OrganizationResource](/docs/reference/javascript/organization)\> | A function that returns a `Promise` which resolves to the newly created `Organization`. | -| `isLoaded` | `boolean` | A boolean that indicates whether Clerk has completed initialization and there is an authenticated user. Initially `false`, becomes `true` once Clerk loads with a user. | -| `setActive` | undefined \| (setActiveParams: [SetActiveParams](/docs/reference/javascript/types/set-active-params)) => Promise\ | A function that sets the active session and/or organization. | -| `userInvitations` | PaginatedResourcesWithDefault\<[UserOrganizationInvitationResource](/docs/reference/javascript/types/user-organization-invitation)\> \| [PaginatedResources](#paginated-resources)\<[UserOrganizationInvitationResource](/docs/reference/javascript/types/user-organization-invitation), T\["userInvitations"\] _extends_ \{ infinite: true; \} ? true : false\> | Returns `PaginatedResources` which includes a list of the user's organization invitations. | -| `userMemberships` | PaginatedResourcesWithDefault\<[OrganizationMembershipResource](/docs/reference/javascript/types/organization-membership)\> \| [PaginatedResources](#paginated-resources)\<[OrganizationMembershipResource](/docs/reference/javascript/types/organization-membership), T\["userMemberships"\] _extends_ \{ infinite: true; \} ? true : false\> | Returns `PaginatedResources` which includes a list of the user's organization memberships. | -| `userSuggestions` | PaginatedResourcesWithDefault\<[OrganizationSuggestionResource](/docs/reference/javascript/types/organization-suggestion)\> \| [PaginatedResources](#paginated-resources)\<[OrganizationSuggestionResource](/docs/reference/javascript/types/organization-suggestion), T\["userSuggestions"\] _extends_ \{ infinite: true; \} ? true : false\> | Returns `PaginatedResources` which includes a list of suggestions for organizations that the user can join. | +| Property | Type | Description | +| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `createOrganization` | undefined \| (CreateOrganizationParams: CreateOrganizationParams) => Promise\ | A function that returns a `Promise` which resolves to the newly created `Organization`. | +| `isLoaded` | `boolean` | A boolean that indicates whether Clerk has completed initialization and there is an authenticated user. Initially `false`, becomes `true` once Clerk loads with a user. | +| `setActive` | undefined \| (setActiveParams: SetActiveParams) => Promise\ | A function that sets the active session and/or organization. | +| `userInvitations` | PaginatedResourcesWithDefault\ \| [PaginatedResources](#paginated-resources)\ | Returns `PaginatedResources` which includes a list of the user's organization invitations. | +| `userMemberships` | PaginatedResourcesWithDefault\ \| [PaginatedResources](#paginated-resources)\ | Returns `PaginatedResources` which includes a list of the user's organization memberships. | +| `userSuggestions` | PaginatedResourcesWithDefault\ \| [PaginatedResources](#paginated-resources)\ | Returns `PaginatedResources` which includes a list of suggestions for organizations that the user can join. | diff --git a/clerk-typedoc/shared/use-organization-params.mdx b/clerk-typedoc/shared/use-organization-params.mdx index dd8b326d19..a08d9628b9 100644 --- a/clerk-typedoc/shared/use-organization-params.mdx +++ b/clerk-typedoc/shared/use-organization-params.mdx @@ -1,6 +1,6 @@ | Property | Type | Description | | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `domains?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ enrollmentMode?: "manual_invitation" \| "automatic_invitation" \| "automatic_suggestion"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `enrollmentMode`: A string that filters the domains by the provided [enrollment mode](/docs/guides/organizations/verified-domains#enrollment-mode).
  • Any of the properties described in [Shared properties](#shared-properties).
| -| `invitations?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: ("expired" \| "revoked" \| "pending" \| "accepted")[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `status`: A string that filters the invitations by the provided status.
  • Any of the properties described in [Shared properties](#shared-properties).
| -| `membershipRequests?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: "expired" \| "revoked" \| "pending" \| "accepted"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `status`: A string that filters the membership requests by the provided status.
  • Any of the properties described in [Shared properties](#shared-properties).
| +| `invitations?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: ("expired" \| "pending" \| "accepted" \| "revoked")[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `status`: A string that filters the invitations by the provided status.
  • Any of the properties described in [Shared properties](#shared-properties).
| +| `membershipRequests?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ status?: "expired" \| "pending" \| "accepted" \| "revoked"; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `status`: A string that filters the membership requests by the provided status.
  • Any of the properties described in [Shared properties](#shared-properties).
| | `memberships?` | true \| \{ initialPage?: number; pageSize?: number; \} & \{ query?: string; role?: string[]; \} & \{ infinite?: boolean; keepPreviousData?: boolean; \} | If set to `true`, all default properties will be used.
Otherwise, accepts an object with the following optional properties:
  • `role`: An array of [`OrganizationCustomRoleKey`](/docs/reference/javascript/types/organization-custom-role-key).
  • `query`: A string that filters the memberships by the provided string.
  • Any of the properties described in [Shared properties](#shared-properties).
| diff --git a/clerk-typedoc/shared/use-organization-return.mdx b/clerk-typedoc/shared/use-organization-return.mdx index 25bf1d0b7c..d5ea523c6f 100644 --- a/clerk-typedoc/shared/use-organization-return.mdx +++ b/clerk-typedoc/shared/use-organization-return.mdx @@ -1,9 +1,9 @@ -| Property | Type | Description | -| ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -| `domains` | null \| PaginatedResourcesWithDefault\<[OrganizationDomainResource](/docs/reference/javascript/types/organization-domain)\> \| [PaginatedResources](#paginated-resources)\<[OrganizationDomainResource](/docs/reference/javascript/types/organization-domain), T\["membershipRequests"\] _extends_ \{ infinite: true; \} ? true : false\> | Includes a paginated list of the organization's domains. | -| `invitations` | null \| PaginatedResourcesWithDefault\<[OrganizationInvitationResource](/docs/reference/javascript/types/organization-invitation)\> \| [PaginatedResources](#paginated-resources)\<[OrganizationInvitationResource](/docs/reference/javascript/types/organization-invitation), T\["invitations"\] _extends_ \{ infinite: true; \} ? true : false\> | Includes a paginated list of the organization's invitations. | -| `isLoaded` | `boolean` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | -| `membership` | undefined \| null \| [OrganizationMembershipResource](/docs/reference/javascript/types/organization-membership) | The current organization membership. | -| `membershipRequests` | null \| PaginatedResourcesWithDefault\<[OrganizationMembershipRequestResource](/docs/reference/javascript/types/organization-membership-request)\> \| [PaginatedResources](#paginated-resources)\<[OrganizationMembershipRequestResource](/docs/reference/javascript/types/organization-membership-request), T\["membershipRequests"\] _extends_ \{ infinite: true; \} ? true : false\> | Includes a paginated list of the organization's membership requests. | -| `memberships` | null \| PaginatedResourcesWithDefault\<[OrganizationMembershipResource](/docs/reference/javascript/types/organization-membership)\> \| [PaginatedResources](#paginated-resources)\<[OrganizationMembershipResource](/docs/reference/javascript/types/organization-membership), T\["memberships"\] _extends_ \{ infinite: true; \} ? true : false\> | Includes a paginated list of the organization's memberships. | -| `organization` | undefined \| null \| [OrganizationResource](/docs/reference/javascript/organization) | The currently active organization. | +| Property | Type | Description | +| ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `domains` | null \| PaginatedResourcesWithDefault\ \| [PaginatedResources](#paginated-resources)\ | Includes a paginated list of the organization's domains. | +| `invitations` | null \| PaginatedResourcesWithDefault\ \| [PaginatedResources](#paginated-resources)\ | Includes a paginated list of the organization's invitations. | +| `isLoaded` | `boolean` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | +| `membership` | undefined \| null \| OrganizationMembershipResource | The current organization membership. | +| `membershipRequests` | null \| PaginatedResourcesWithDefault\ \| [PaginatedResources](#paginated-resources)\ | Includes a paginated list of the organization's membership requests. | +| `memberships` | null \| PaginatedResourcesWithDefault\ \| [PaginatedResources](#paginated-resources)\ | Includes a paginated list of the organization's memberships. | +| `organization` | undefined \| null \| OrganizationResource | The currently active organization. | diff --git a/clerk-typedoc/shared/use-session-list.mdx b/clerk-typedoc/shared/use-session-list.mdx index 75aa725eb2..5b4881b670 100644 --- a/clerk-typedoc/shared/use-session-list.mdx +++ b/clerk-typedoc/shared/use-session-list.mdx @@ -16,8 +16,8 @@ There are multiple variants of this type available which you can select by click | Name | Type | Description | | ------ | ------ | ------ | | `isLoaded` | `true` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | -| `sessions` | [SessionResource](/docs/reference/javascript/session)[] | A list of sessions that have been registered on the client device. | -| `setActive()` | (setActiveParams: [SetActiveParams](/docs/reference/javascript/types/set-active-params)) => Promise\ | A function that sets the active session and/or organization. See the [reference doc](/docs/reference/javascript/clerk#set-active). | +| `sessions` | SessionResource[] | A list of sessions that have been registered on the client device. | +| `setActive()` | (setActiveParams: SetActiveParams) => Promise\ | A function that sets the active session and/or organization. See the [reference doc](/docs/reference/javascript/clerk#set-active). | diff --git a/clerk-typedoc/shared/use-session.mdx b/clerk-typedoc/shared/use-session.mdx index 86492af39d..8f774e5848 100644 --- a/clerk-typedoc/shared/use-session.mdx +++ b/clerk-typedoc/shared/use-session.mdx @@ -24,7 +24,7 @@ There are multiple variants of this type available which you can select by click | ------ | ------ | ------ | | `isLoaded` | `true` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | | `isSignedIn` | `boolean` | A boolean that indicates whether a user is currently signed in. | -| `session` | [`SignedInSessionResource`](/docs/reference/javascript/session) | The current session for the user. | +| `session` | `SignedInSessionResource` | The current session for the user. | diff --git a/clerk-typedoc/shared/use-user.mdx b/clerk-typedoc/shared/use-user.mdx index 4fb9fccef7..76bd412dcd 100644 --- a/clerk-typedoc/shared/use-user.mdx +++ b/clerk-typedoc/shared/use-user.mdx @@ -24,7 +24,7 @@ There are multiple variants of this type available which you can select by click | ------ | ------ | ------ | | `isLoaded` | `true` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | | `isSignedIn` | `true` | A boolean that returns `true` if the user is signed in. | -| `user` | [`UserResource`](/docs/reference/javascript/user) | The `User` object for the current user. | +| `user` | `UserResource` | The `User` object for the current user. | diff --git a/clerk-typedoc/types/act-claim.mdx b/clerk-typedoc/types/act-claim.mdx deleted file mode 100644 index 3de8a4c99a..0000000000 --- a/clerk-typedoc/types/act-claim.mdx +++ /dev/null @@ -1 +0,0 @@ -JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim). diff --git a/clerk-typedoc/types/act-jwt-claim.mdx b/clerk-typedoc/types/act-jwt-claim.mdx deleted file mode 100644 index 33ad615eb6..0000000000 --- a/clerk-typedoc/types/act-jwt-claim.mdx +++ /dev/null @@ -1,5 +0,0 @@ -JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim). - -## Deprecated - -Use `ActClaim` instead. diff --git a/clerk-typedoc/types/active-session-resource.mdx b/clerk-typedoc/types/active-session-resource.mdx deleted file mode 100644 index 71ce50cf05..0000000000 --- a/clerk-typedoc/types/active-session-resource.mdx +++ /dev/null @@ -1,13 +0,0 @@ -Represents a session resource that has completed all pending tasks -and authentication factors - -## Properties - -| Property | Type | Description | -| ---------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `end` | () => Promise\<[SessionResource](/docs/reference/javascript/session)\> | Marks the session as ended. The session will no longer be active for this `Client` and its status will become **ended**. | -| `factorVerificationAge` | null \| \[number, number\] | An array where each item represents the number of minutes since the last verification of a first or second factor: `[firstFactorAge, secondFactorAge]`. | -| `id` | `string` | The unique identifier for the session. | -| `pathRoot` | `string` | The root path of the resource. | -| `status` | `"active"` | The current state of the session. | -| `user` | [`UserResource`](/docs/reference/javascript/user) | The user associated with the session. | diff --git a/clerk-typedoc/types/add-payment-method-params.mdx b/clerk-typedoc/types/add-payment-method-params.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-checkout-json.mdx b/clerk-typedoc/types/billing-checkout-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-checkout-resource.mdx b/clerk-typedoc/types/billing-checkout-resource.mdx deleted file mode 100644 index fab74d72ac..0000000000 --- a/clerk-typedoc/types/billing-checkout-resource.mdx +++ /dev/null @@ -1,20 +0,0 @@ -The `BillingCheckoutResource` type represents information about a checkout session. - -## Properties - -| Property | Type | Description | -| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| `confirm` | (params: [ConfirmCheckoutParams](/docs/reference/javascript/types/billing-checkout-resource#parameters)) => Promise\ | A function to confirm and finalize the checkout process, usually after payment information has been provided and validated. [Learn more.](#confirm) | -| `externalClientSecret` | `string` | A client secret from an external payment provider (such as Stripe) used to complete the payment on the client-side. | -| `externalGatewayId` | `string` | The identifier for the external payment gateway used for this checkout session. | -| `freeTrialEndsAt` | null \| Date | Unix timestamp (milliseconds) of when the free trial ends. | -| `id` | `string` | The unique identifier for the checkout session. | -| `isImmediatePlanChange` | `boolean` | Whether the plan change will take effect immediately after checkout. | -| `pathRoot` | `string` | The root path of the resource. | -| `payer` | [`BillingPayerResource`](/docs/reference/javascript/types/billing-payer-resource) | The payer associated with the checkout. | -| `paymentMethod?` | [`BillingPaymentMethodResource`](/docs/reference/javascript/types/billing-payment-method-resource) | The payment method being used for the checkout, such as a credit card or bank account. | -| `plan` | [`BillingPlanResource`](/docs/reference/javascript/types/billing-plan-resource) | The subscription plan details for the checkout. | -| `planPeriod` | "month" \| "annual" | The billing period for the plan. | -| `planPeriodStart?` | `number` | Unix timestamp (milliseconds) of when the current period starts. | -| `status` | "completed" \| "needs_confirmation" | The current status of the checkout session. | -| `totals` | [`BillingCheckoutTotals`](/docs/reference/javascript/types/billing-checkout-totals) | The total costs, taxes, and other pricing details for the checkout. | diff --git a/clerk-typedoc/types/billing-checkout-totals-json.mdx b/clerk-typedoc/types/billing-checkout-totals-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-checkout-totals.mdx b/clerk-typedoc/types/billing-checkout-totals.mdx deleted file mode 100644 index 176f19d24b..0000000000 --- a/clerk-typedoc/types/billing-checkout-totals.mdx +++ /dev/null @@ -1,12 +0,0 @@ -The `BillingCheckoutTotals` type represents the total costs, taxes, and other pricing details for a checkout session. - -## Properties - -| Property | Type | Description | -| -------------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `credit` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | Any credits (like account balance or promo credits) that are being applied to the checkout. | -| `grandTotal` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The total amount for the checkout, including taxes and after credits/discounts are applied. This is the final amount due. | -| `pastDue` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | Any outstanding amount from previous unpaid invoices that is being collected as part of the checkout. | -| `subtotal` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The price of the items or plan before taxes, credits, or discounts are applied. | -| `taxTotal` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The amount of tax included in the checkout. | -| `totalDueNow` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The amount that needs to be immediately paid to complete the checkout. | diff --git a/clerk-typedoc/types/billing-initialized-payment-method-json.mdx b/clerk-typedoc/types/billing-initialized-payment-method-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-initialized-payment-method-resource.mdx b/clerk-typedoc/types/billing-initialized-payment-method-resource.mdx deleted file mode 100644 index 9d52d0e91a..0000000000 --- a/clerk-typedoc/types/billing-initialized-payment-method-resource.mdx +++ /dev/null @@ -1,9 +0,0 @@ -## Properties - -| Property | Type | Description | -| -------------------------------------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `externalClientSecret` | `string` | A client secret from an external payment provider (such as Stripe) used to complete the payment on the client-side. | -| `externalGatewayId` | `string` | The identifier for the external payment gateway used for this checkout session. | -| `id?` | `string` | The unique identifier of the resource. | -| `pathRoot` | `string` | The root path of the resource. | -| `paymentMethodOrder` | string[] | The order the payment methods will be displayed in when `` renders. | diff --git a/clerk-typedoc/types/billing-money-amount-json.mdx b/clerk-typedoc/types/billing-money-amount-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-money-amount.mdx b/clerk-typedoc/types/billing-money-amount.mdx deleted file mode 100644 index 00a6dc3201..0000000000 --- a/clerk-typedoc/types/billing-money-amount.mdx +++ /dev/null @@ -1,10 +0,0 @@ -The `BillingMoneyAmount` type represents a monetary value with currency information. - -## Properties - -| Property | Type | Description | -| ---------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `amount` | `number` | The raw amount as a number, usually in the smallest unit of the currency (like cents for USD). For example, `1000` for $10.00. | -| `amountFormatted` | `string` | The amount as a formatted string. For example, `10.00` for $10.00. | -| `currency` | `string` | The ISO currency code for this amount. For example, `USD`. | -| `currencySymbol` | `string` | The symbol for the currency. For example, `$`. | diff --git a/clerk-typedoc/types/billing-namespace.mdx b/clerk-typedoc/types/billing-namespace.mdx deleted file mode 100644 index 2ead382f3d..0000000000 --- a/clerk-typedoc/types/billing-namespace.mdx +++ /dev/null @@ -1,12 +0,0 @@ -## Properties - -| Property | Type | -| ---------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `getPaymentAttempt` | (params: \{ id: string; orgId?: string; \}) => Promise\<[BillingPaymentResource](/docs/reference/javascript/types/billing-payment-resource)\> | -| `getPaymentAttempts` | (params: [GetPaymentAttemptsParams](get-payment-attempts-params.mdx)) => Promise\<[ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\<[BillingPaymentResource](/docs/reference/javascript/types/billing-payment-resource)\>\> | -| `getPlan` | (params: \{ id: string; \}) => Promise\<[BillingPlanResource](/docs/reference/javascript/types/billing-plan-resource)\> | -| `getPlans` | (params?: [GetPlansParams](get-plans-params.mdx)) => Promise\<[ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\<[BillingPlanResource](/docs/reference/javascript/types/billing-plan-resource)\>\> | -| `getStatement` | (params: \{ id: string; orgId?: string; \}) => Promise\<[BillingStatementResource](billing-statement-resource.mdx)\> | -| `getStatements` | (params: [GetStatementsParams](get-statements-params.mdx)) => Promise\<[ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\<[BillingStatementResource](billing-statement-resource.mdx)\>\> | -| `getSubscription` | (params: [GetSubscriptionParams](get-subscription-params.mdx)) => Promise\<[BillingSubscriptionResource](billing-subscription-resource.mdx)\> | -| `startCheckout` | (params: [CreateCheckoutParams](create-checkout-params.mdx)) => Promise\<[BillingCheckoutResource](billing-checkout-resource.mdx)\> | diff --git a/clerk-typedoc/types/billing-payer-json.mdx b/clerk-typedoc/types/billing-payer-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-payer-methods.mdx b/clerk-typedoc/types/billing-payer-methods.mdx deleted file mode 100644 index 3222a1b37c..0000000000 --- a/clerk-typedoc/types/billing-payer-methods.mdx +++ /dev/null @@ -1,7 +0,0 @@ -## Properties - -| Property | Type | -| -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `addPaymentMethod` | (params: [AddPaymentMethodParams](add-payment-method-params.mdx)) => Promise\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\> | -| `getPaymentMethods` | (params: [GetPaymentMethodsParams](get-payment-methods-params.mdx)) => Promise\<[ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\>\> | -| `initializePaymentMethod` | (params: [InitializePaymentMethodParams](initialize-payment-method-params.mdx)) => Promise\<[BillingInitializedPaymentMethodResource](billing-initialized-payment-method-resource.mdx)\> | diff --git a/clerk-typedoc/types/billing-payer-resource-type.mdx b/clerk-typedoc/types/billing-payer-resource-type.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-payer-resource.mdx b/clerk-typedoc/types/billing-payer-resource.mdx deleted file mode 100644 index f6e46498c3..0000000000 --- a/clerk-typedoc/types/billing-payer-resource.mdx +++ /dev/null @@ -1,17 +0,0 @@ -The `BillingPayerResource` type represents a payer associated with a billing subscription. - -## Properties - -| Property | Type | Description | -| ------------------------------------------------- | --------------------------- | --------------------------------------------------------------------- | -| `createdAt` | `Date` | The date and time when the payer was created. | -| `email?` | `string` | The email address of the payer. | -| `firstName?` | `string` | The first name of the payer. | -| `id` | `string` | The unique identifier for the payer. | -| `imageUrl` | null \| string | The URL of the payer's avatar image. | -| `lastName?` | `string` | The last name of the payer. | -| `organizationId?` | `string` | The unique identifier for the organization that the payer belongs to. | -| `organizationName?` | `string` | The name of the organization that the payer belongs to. | -| `pathRoot` | `string` | The root path of the resource. | -| `updatedAt` | `Date` | The date and time when the payer was last updated. | -| `userId?` | `string` | The unique identifier for the payer. | diff --git a/clerk-typedoc/types/billing-payment-charge-type.mdx b/clerk-typedoc/types/billing-payment-charge-type.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-payment-json.mdx b/clerk-typedoc/types/billing-payment-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-payment-method-json.mdx b/clerk-typedoc/types/billing-payment-method-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-payment-method-resource.mdx b/clerk-typedoc/types/billing-payment-method-resource.mdx deleted file mode 100644 index ea5da5db0c..0000000000 --- a/clerk-typedoc/types/billing-payment-method-resource.mdx +++ /dev/null @@ -1,17 +0,0 @@ -The `BillingPaymentMethodResource` type represents a payment method for a checkout session. - -## Properties - -| Property | Type | Description | -| -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `cardType` | `string` | The brand or type of card. For example, `'visa'` or `'mastercard'`. | -| `id` | `string` | The unique identifier for the payment method. | -| `isDefault` | `boolean` | Whether the payment method is set as the default for the account. | -| `isRemovable` | `boolean` | Whether the payment method can be removed by the user. | -| `last4` | `string` | The last four digits of the payment method. | -| `makeDefault` | (params?: \{ orgId?: string; \}) => Promise\ | A function that sets this payment method as the default for the account. Accepts the following parameters:
  • `orgId?` (`string`): The ID of the organization to set as the default.
| -| `pathRoot` | `string` | The root path of the resource. | -| `paymentType` | "link" \| "card" | The type of payment method. For example, `'card'` or `'link'`. | -| `remove` | (params?: \{ orgId?: string; \}) => Promise\<[DeletedObjectResource](/docs/reference/javascript/types/deleted-object-resource)\> | A function that removes this payment method from the account. Accepts the following parameters:
  • `orgId?` (`string`): The ID of the organization to remove the payment method from.
| -| `status` | "active" \| "disconnected" \| "expired" | The current status of the payment method. | -| `walletType` | undefined \| string | The type of digital wallet, if applicable. For example, `'apple_pay'`, or `'google_pay'`. | diff --git a/clerk-typedoc/types/billing-payment-method-status.mdx b/clerk-typedoc/types/billing-payment-method-status.mdx deleted file mode 100644 index 3694f84bd4..0000000000 --- a/clerk-typedoc/types/billing-payment-method-status.mdx +++ /dev/null @@ -1 +0,0 @@ -The status of a payment method. diff --git a/clerk-typedoc/types/billing-payment-resource.mdx b/clerk-typedoc/types/billing-payment-resource.mdx deleted file mode 100644 index 13e6e39dd6..0000000000 --- a/clerk-typedoc/types/billing-payment-resource.mdx +++ /dev/null @@ -1,16 +0,0 @@ -The `BillingPaymentResource` type represents a payment attempt for a user or organization. - -## Properties - -| Property | Type | Description | -| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `amount` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The amount of the payment. | -| `chargeType` | "checkout" \| "recurring" | The type of charge this payment represents. Can be `'checkout'` for one-time payments or `'recurring'` for subscription payments. | -| `failedAt?` | `Date` | The date and time when the payment failed. | -| `id` | `string` | The unique identifier for the payment. | -| `paidAt?` | `Date` | The date and time when the payment was successfully completed. | -| `pathRoot` | `string` | The root path of the resource. | -| `paymentMethod` | [`BillingPaymentMethodResource`](/docs/reference/javascript/types/billing-payment-method-resource) | The payment method being used for the payment, such as credit card or bank account. | -| `status` | "failed" \| "pending" \| "paid" | The current status of the payment. | -| `subscriptionItem` | [`BillingSubscriptionItemResource`](/docs/reference/javascript/types/billing-subscription-item-resource) | The subscription item being paid for. | -| `updatedAt` | `Date` | The date and time when the payment was last updated. | diff --git a/clerk-typedoc/types/billing-payment-status.mdx b/clerk-typedoc/types/billing-payment-status.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-plan-json.mdx b/clerk-typedoc/types/billing-plan-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-plan-resource.mdx b/clerk-typedoc/types/billing-plan-resource.mdx deleted file mode 100644 index dd4940ca23..0000000000 --- a/clerk-typedoc/types/billing-plan-resource.mdx +++ /dev/null @@ -1,23 +0,0 @@ -The `BillingPlanResource` type represents a subscription plan with its details. - -## Properties - -| Property | Type | Description | -| ------------------------------------------------ | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `annualFee` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The annual price of the plan. | -| `annualMonthlyFee` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The effective monthly price when billed annually. | -| `avatarUrl` | `string` | The URL of the plan's avatar image. | -| `description` | `string` | A short description of what the plan offers. | -| `features` | [FeatureResource](/docs/reference/javascript/types/feature-resource)[] | The features the plan offers. | -| `fee` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The monthly price of the plan. | -| `forPayerType` | "user" \| "org" | Specifies the subscriber type this plan is designed for. Each plan is exclusively created for either individual users or organizations, and cannot be used interchangeably. | -| `freeTrialDays` | null \| number | The number of days of the free trial for the plan. `null` if the plan does not have a free trial. | -| `freeTrialEnabled` | `boolean` | Whether the plan has a free trial. | -| `hasBaseFee` | `boolean` | Whether the plan has a base fee. | -| `id` | `string` | The unique identifier for the plan. | -| `isDefault` | `boolean` | Whether the plan is the default plan. | -| `isRecurring` | `boolean` | Whether the plan is recurring. | -| `name` | `string` | The name of the plan. | -| `pathRoot` | `string` | The root path of the resource. | -| `publiclyVisible` | `boolean` | Whether the plan is visible to the public. | -| `slug` | `string` | The URL-friendly identifier of the plan. | diff --git a/clerk-typedoc/types/billing-statement-group-json.mdx b/clerk-typedoc/types/billing-statement-group-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-statement-group.mdx b/clerk-typedoc/types/billing-statement-group.mdx deleted file mode 100644 index 0edb69398e..0000000000 --- a/clerk-typedoc/types/billing-statement-group.mdx +++ /dev/null @@ -1,8 +0,0 @@ -The `BillingStatementGroup` type represents a group of payment items within a statement. - -## Properties - -| Property | Type | Description | -| ---------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `items` | [BillingPaymentResource](/docs/reference/javascript/types/billing-payment-resource)[] | An array of payment resources that belong to this group. | -| `timestamp` | `Date` | The date and time when this group of payment items was created or last updated. | diff --git a/clerk-typedoc/types/billing-statement-json.mdx b/clerk-typedoc/types/billing-statement-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-statement-resource.mdx b/clerk-typedoc/types/billing-statement-resource.mdx deleted file mode 100644 index 66c9415154..0000000000 --- a/clerk-typedoc/types/billing-statement-resource.mdx +++ /dev/null @@ -1,12 +0,0 @@ -The `BillingStatementResource` type represents a billing statement for a user or organization. - -## Properties - -| Property | Type | Description | -| ---------------------------------- | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | -| `groups` | [BillingStatementGroup](/docs/reference/javascript/types/billing-statement-group)[] | An array of statement groups, where each group contains payment items organized by timestamp. | -| `id` | `string` | The unique identifier for the statement. | -| `pathRoot` | `string` | The root path of the resource. | -| `status` | "closed" \| "open" | The current status of the statement. Statements can be either `'open'` (still accumulating charges) or `'closed'` (finalized). | -| `timestamp` | `Date` | The date and time when the statement was created or last updated. | -| `totals` | [`BillingStatementTotals`](/docs/reference/javascript/types/billing-statement-totals) | An object containing the financial totals for the statement, including subtotal, grand total, tax total, credit, and past due amounts. | diff --git a/clerk-typedoc/types/billing-statement-status.mdx b/clerk-typedoc/types/billing-statement-status.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-statement-totals-json.mdx b/clerk-typedoc/types/billing-statement-totals-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/billing-statement-totals.mdx b/clerk-typedoc/types/billing-statement-totals.mdx deleted file mode 100644 index e8c9db593c..0000000000 --- a/clerk-typedoc/types/billing-statement-totals.mdx +++ /dev/null @@ -1,11 +0,0 @@ -The `BillingStatementTotals` type represents the total costs, taxes, and other pricing details for a statement. - -## Properties - -| Property | Type | Description | -| ------------------------------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `credit` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | Any credits (like account balance or promo credits) that are being applied to the checkout. | -| `grandTotal` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The total amount for the checkout, including taxes and after credits/discounts are applied. This is the final amount due. | -| `pastDue` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | Any outstanding amount from previous unpaid invoices that is being collected as part of the checkout. | -| `subtotal` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The price of the items or plan before taxes, credits, or discounts are applied. | -| `taxTotal` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The amount of tax included in the checkout. | diff --git a/clerk-typedoc/types/billing-subscription-item-json.mdx b/clerk-typedoc/types/billing-subscription-item-json.mdx deleted file mode 100644 index 786d93b8c6..0000000000 --- a/clerk-typedoc/types/billing-subscription-item-json.mdx +++ /dev/null @@ -1,5 +0,0 @@ -## Properties - -| Property | Type | Description | -| ------------------------------------ | --------------------------- | ---------------------------------------------------------------------- | -| `period_end` | null \| number | Period end is `null` for subscription items that are on the free plan. | diff --git a/clerk-typedoc/types/billing-subscription-item-resource.mdx b/clerk-typedoc/types/billing-subscription-item-resource.mdx deleted file mode 100644 index ab0be5d63c..0000000000 --- a/clerk-typedoc/types/billing-subscription-item-resource.mdx +++ /dev/null @@ -1,22 +0,0 @@ -The `BillingSubscriptionItemResource` type represents an item in a subscription. - -## Properties - -| Property | Type | Description | -| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `amount?` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The amount charged for the subscription item. | -| `cancel` | (params: \{ orgId?: string; \}) => Promise\<[DeletedObjectResource](/docs/reference/javascript/types/deleted-object-resource)\> | A function to cancel the subscription item. Accepts the following parameters:
  • `orgId?` (`string`): The ID of the organization to cancel the subscription item from.
| -| `canceledAt` | null \| Date | The date and time when the subscription item was canceled. `null` if the subscription item is not canceled. | -| `createdAt` | `Date` | The date and time when the subscription item was created. | -| `credit?` | \{ amount: [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount); \} | The credit from a previous purchase that is being applied to the subscription item. | -| `credit.amount` | [`BillingMoneyAmount`](/docs/reference/javascript/types/billing-money-amount) | The amount of credit from a previous purchase that is being applied to the subscription item. | -| `id` | `string` | The unique identifier for the subscription item. | -| `isFreeTrial` | `boolean` | Whether the subscription item is for a free trial. | -| `pastDueAt` | null \| Date | The date and time when the subscription item became past due. `null` if the subscription item is not past due. | -| `pathRoot` | `string` | The root path of the resource. | -| `paymentMethodId` | `string` | The unique identifier for the payment method being used for the subscription item. | -| `periodEnd` | null \| Date | The date and time when the current billing period ends. `null` if not set. | -| `periodStart` | `Date` | The date and time when the current billing period starts. | -| `plan` | [`BillingPlanResource`](/docs/reference/javascript/types/billing-plan-resource) | The plan associated with the subscription item. | -| `planPeriod` | "month" \| "annual" | The billing period for the subscription item. | -| `status` | "active" \| "ended" \| "upcoming" \| "past_due" | The status of the subscription item. | diff --git a/clerk-typedoc/types/billing-subscription-json.mdx b/clerk-typedoc/types/billing-subscription-json.mdx deleted file mode 100644 index 18342b5f41..0000000000 --- a/clerk-typedoc/types/billing-subscription-json.mdx +++ /dev/null @@ -1,8 +0,0 @@ -## Properties - -| Property | Type | Description | -| ----------------------------------------- | ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `next_payment?` | \{ amount: [BillingMoneyAmountJSON](billing-money-amount-json.mdx); date: number; \} | Describes the details for the next payment cycle. It is `undefined` for subscription items that are cancelled or on the free plan. | -| `next_payment.amount` | [`BillingMoneyAmountJSON`](billing-money-amount-json.mdx) | - | -| `next_payment.date` | `number` | - | -| `status` | "active" \| "past_due" | Due to the free plan subscription item, the top level subscription can either be `active` or `past_due`. | diff --git a/clerk-typedoc/types/billing-subscription-plan-period.mdx b/clerk-typedoc/types/billing-subscription-plan-period.mdx deleted file mode 100644 index 637fd2faa6..0000000000 --- a/clerk-typedoc/types/billing-subscription-plan-period.mdx +++ /dev/null @@ -1 +0,0 @@ -The billing period for the plan. diff --git a/clerk-typedoc/types/billing-subscription-resource.mdx b/clerk-typedoc/types/billing-subscription-resource.mdx deleted file mode 100644 index 6ca576547b..0000000000 --- a/clerk-typedoc/types/billing-subscription-resource.mdx +++ /dev/null @@ -1,16 +0,0 @@ -The `BillingSubscriptionResource` type represents a subscription to a plan. - -## Properties - -| Property | Type | Description | -| --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| `activeAt` | `Date` | The date when the subscription became active. | -| `createdAt` | `Date` | The date when the subscription was created. | -| `eligibleForFreeTrial?` | `boolean` | Whether the payer is eligible for a free trial. | -| `id` | `string` | The unique identifier for the subscription. | -| `nextPayment` | null \| \{ amount: [BillingMoneyAmount](/docs/reference/javascript/types/billing-money-amount); date: Date; \} | Information about the next payment, including the amount and the date it's due. Returns null if there is no upcoming payment. | -| `pastDueAt` | null \| Date | The date when the subscription became past due, or `null` if the subscription is not past due. | -| `pathRoot` | `string` | The root path of the resource. | -| `status` | "active" \| "past_due" | The current status of the subscription. Due to the free plan subscription item, the top level subscription can either be `active` or `past_due`. | -| `subscriptionItems` | [BillingSubscriptionItemResource](/docs/reference/javascript/types/billing-subscription-item-resource)[] | The list of subscription items included in this subscription. | -| `updatedAt` | null \| Date | The date when the subscription was last updated, or `null` if it hasn't been updated. | diff --git a/clerk-typedoc/types/billing-subscription-status.mdx b/clerk-typedoc/types/billing-subscription-status.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/cancel-subscription-params.mdx b/clerk-typedoc/types/cancel-subscription-params.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/check-authorization-fn.mdx b/clerk-typedoc/types/check-authorization-fn.mdx deleted file mode 100644 index cbec4ba71e..0000000000 --- a/clerk-typedoc/types/check-authorization-fn.mdx +++ /dev/null @@ -1,9 +0,0 @@ -## Parameters - -| Parameter | Type | -| -------------------- | -------- | -| `isAuthorizedParams` | `Params` | - -## Returns - -`boolean` diff --git a/clerk-typedoc/types/check-authorization-from-session-claims.mdx b/clerk-typedoc/types/check-authorization-from-session-claims.mdx deleted file mode 100644 index f7357cd71c..0000000000 --- a/clerk-typedoc/types/check-authorization-from-session-claims.mdx +++ /dev/null @@ -1,13 +0,0 @@ -Type guard for server-side authorization checks using session claims. -System permissions are not allowed since they are not included -in session claims and cannot be verified on the server side. - -## Parameters - -| Parameter | Type | -| -------------------- | -------------------------------------------------------------------------------------------------------- | -| `isAuthorizedParams` | [`CheckAuthorizationParamsFromSessionClaims`](check-authorization-params-from-session-claims.mdx)\<`P`\> | - -## Returns - -`boolean` diff --git a/clerk-typedoc/types/check-authorization-params-from-session-claims.mdx b/clerk-typedoc/types/check-authorization-params-from-session-claims.mdx deleted file mode 100644 index 24a67f0074..0000000000 --- a/clerk-typedoc/types/check-authorization-params-from-session-claims.mdx +++ /dev/null @@ -1,9 +0,0 @@ -## Properties - -| Property | Type | Description | -| --------------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| `feature?` | `Autocomplete`\< user:${string} \| org:${string} \> | The [feature](/docs/guides/billing/overview) to check for. | -| `permission?` | `DisallowSystemPermissions`\<`P`\> | The [permission](/docs/guides/organizations/roles-and-permissions) to check for. | -| `plan?` | `Autocomplete`\< user:${string} \| org:${string} \> | The [plan](/docs/guides/billing/overview) to check for. | -| `reverification?` | [`ReverificationConfig`](reverification-config.mdx) | The reverification configuration to check for. This feature is currently in public beta. **It is not recommended for production use.** | -| `role?` | `string` | The [role](/docs/guides/organizations/roles-and-permissions) to check for. | diff --git a/clerk-typedoc/types/check-authorization-with-custom-permissions.mdx b/clerk-typedoc/types/check-authorization-with-custom-permissions.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/clerk-api-error.mdx b/clerk-typedoc/types/clerk-api-error.mdx deleted file mode 100644 index 63a5b74ea7..0000000000 --- a/clerk-typedoc/types/clerk-api-error.mdx +++ /dev/null @@ -1,24 +0,0 @@ -An interface that represents an error returned by the Clerk API. - -## Properties - -| Property | Type | Description | -| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| `code` | `string` | A string code that represents the error, such as `username_exists_code`. | -| `longMessage?` | `string` | A more detailed message that describes the error. | -| `message` | `string` | A message that describes the error. | -| `meta?` | \{ emailAddresses?: string[]; identifiers?: string[]; isPlanUpgradePossible?: boolean; paramName?: string; permissions?: string[]; plan?: \{ amount_formatted: string; annual_monthly_amount_formatted: string; currency_symbol: string; id: string; name: string; \}; sessionId?: string; zxcvbn?: \{ suggestions: \{ code: string; message: string; \}[]; \}; \} | Additional information about the error. | -| `meta.emailAddresses?` | string[] | - | -| `meta.identifiers?` | string[] | - | -| `meta.isPlanUpgradePossible?` | `boolean` | - | -| `meta.paramName?` | `string` | - | -| `meta.permissions?` | string[] | - | -| `meta.plan?` | \{ amount_formatted: string; annual_monthly_amount_formatted: string; currency_symbol: string; id: string; name: string; \} | - | -| `meta.plan.amount_formatted` | `string` | - | -| `meta.plan.annual_monthly_amount_formatted` | `string` | - | -| `meta.plan.currency_symbol` | `string` | - | -| `meta.plan.id` | `string` | - | -| `meta.plan.name` | `string` | - | -| `meta.sessionId?` | `string` | - | -| `meta.zxcvbn?` | \{ suggestions: \{ code: string; message: string; \}[]; \} | - | -| `meta.zxcvbn.suggestions` | \{ code: string; message: string; \}[] | - | diff --git a/clerk-typedoc/types/clerk-api-response-error.mdx b/clerk-typedoc/types/clerk-api-response-error.mdx deleted file mode 100644 index b2f65c266d..0000000000 --- a/clerk-typedoc/types/clerk-api-response-error.mdx +++ /dev/null @@ -1 +0,0 @@ -Interface representing a Clerk API Response Error. diff --git a/clerk-typedoc/types/clerk-host-router.mdx b/clerk-typedoc/types/clerk-host-router.mdx deleted file mode 100644 index c94fdb4345..0000000000 --- a/clerk-typedoc/types/clerk-host-router.mdx +++ /dev/null @@ -1 +0,0 @@ -This type represents a generic router interface that Clerk relies on to interact with the host router. diff --git a/clerk-typedoc/types/clerk-jwt-claims.mdx b/clerk-typedoc/types/clerk-jwt-claims.mdx deleted file mode 100644 index 4aab45ad6c..0000000000 --- a/clerk-typedoc/types/clerk-jwt-claims.mdx +++ /dev/null @@ -1,28 +0,0 @@ -Clerk-issued JWT payload - -## Deprecated - -Use `JwtPayload` instead. - -## Indexable - -\[`propName`: `string`\]: `unknown` - -Any other JWT Claim Set member. - -## Properties - -| Property | Type | Description | -| ------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| ~~`act?`~~ | \{ [x: string]: unknown; sub: string; \} | JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim). | -| `act.sub` | `string` | - | -| ~~`azp?`~~ | `string` | JWT Authorized party - [RFC7800#section-3](https://tools.ietf.org/html/rfc7800#section-3). | -| ~~`exp`~~ | `number` | JWT Expiration Time - [RFC7519#section-4.1.4](https://tools.ietf.org/html/rfc7519#section-4.1.4). | -| ~~`iat`~~ | `number` | JWT Issued At - [RFC7519#section-4.1.6](https://tools.ietf.org/html/rfc7519#section-4.1.6). | -| ~~`iss`~~ | `string` | JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1). | -| ~~`nbf`~~ | `number` | JWT Not Before - [RFC7519#section-4.1.5](https://tools.ietf.org/html/rfc7519#section-4.1.5). | -| ~~`org_id?`~~ | `string` | Active organization ID. | -| ~~`org_role?`~~ | `string` | Active organization role. | -| ~~`org_slug?`~~ | `string` | Active organization slug. | -| ~~`sid`~~ | `string` | Session ID | -| ~~`sub`~~ | `string` | JWT Subject - [RFC7519#section-4.1.2](https://tools.ietf.org/html/rfc7519#section-4.1.2). | diff --git a/clerk-typedoc/types/clerk-paginated-response.mdx b/clerk-typedoc/types/clerk-paginated-response.mdx deleted file mode 100644 index bd31a7df33..0000000000 --- a/clerk-typedoc/types/clerk-paginated-response.mdx +++ /dev/null @@ -1,11 +0,0 @@ -An interface that describes the response of a method that returns a paginated list of resources. - -> [!TIP] -> Clerk's SDKs always use `Promise>`. If the promise resolves, you will get back the properties. If the promise is rejected, you will receive a `ClerkAPIResponseError` or network error. - -## Properties - -| Property | Type | Description | -| -------------------------------------- | ---------------- | -------------------------------------------- | -| `data` | T[] | An array that contains the fetched data. | -| `total_count` | `number` | The total count of data that exist remotely. | diff --git a/clerk-typedoc/types/clerk-pagination-params.mdx b/clerk-typedoc/types/clerk-pagination-params.mdx deleted file mode 100644 index 70057fdc8c..0000000000 --- a/clerk-typedoc/types/clerk-pagination-params.mdx +++ /dev/null @@ -1,6 +0,0 @@ -## Properties - -| Property | Type | Description | -| --------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `initialPage?` | `number` | A number that specifies which page to fetch. For example, if `initialPage` is set to `10`, it will skip the first 9 pages and fetch the 10th page. Defaults to `1`. | -| `pageSize?` | `number` | A number that specifies the maximum number of results to return per page. Defaults to `10`. | diff --git a/clerk-typedoc/types/clerk-pagination-request.mdx b/clerk-typedoc/types/clerk-pagination-request.mdx deleted file mode 100644 index 25e902d5e1..0000000000 --- a/clerk-typedoc/types/clerk-pagination-request.mdx +++ /dev/null @@ -1,8 +0,0 @@ -Pagination params in request - -## Properties - -| Property | Type | Description | -| ----------------------------- | -------- | ---------------------------------------------------- | -| `limit?` | `number` | Maximum number of items returned per request. | -| `offset?` | `number` | This is the starting point for your fetched results. | diff --git a/clerk-typedoc/types/clerk-resource.mdx b/clerk-typedoc/types/clerk-resource.mdx deleted file mode 100644 index 0701ccdfa9..0000000000 --- a/clerk-typedoc/types/clerk-resource.mdx +++ /dev/null @@ -1,8 +0,0 @@ -Defines common properties and methods that all Clerk resources must implement. - -## Properties - -| Property | Type | Description | -| -------------------------------- | -------- | -------------------------------------- | -| `id?` | `string` | The unique identifier of the resource. | -| `pathRoot` | `string` | The root path of the resource. | diff --git a/clerk-typedoc/types/clerk-status.mdx b/clerk-typedoc/types/clerk-status.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/clerk.mdx b/clerk-typedoc/types/clerk.mdx deleted file mode 100644 index ea5453cfd1..0000000000 --- a/clerk-typedoc/types/clerk.mdx +++ /dev/null @@ -1,102 +0,0 @@ -Main Clerk SDK object. - -## Properties - -| Property | Type | Description | -| ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `__experimental_checkout` | `__experimental_CheckoutFunction` | Checkout API | -| `__experimental_prefetchOrganizationSwitcher` | () => void | Prefetches the data displayed by an organization switcher. It can be used when `mountOrganizationSwitcher({ asStandalone: true})`, to avoid unwanted loading states. | -| `__internal_closeCheckout` | () => void | Closes the Clerk Checkout drawer. | -| `__internal_closePlanDetails` | () => void | Closes the Clerk PlanDetails drawer. | -| `__internal_closeReverification` | () => void | Closes the Clerk user verification modal. | -| `__internal_closeSubscriptionDetails` | () => void | Closes the Clerk SubscriptionDetails drawer. | -| `__internal_mountOAuthConsent` | (targetNode: HTMLDivElement, oauthConsentProps?: \_\_internal_OAuthConsentProps) => void | Mounts a OAuth consent component at the target element. | -| `__internal_openCheckout` | (props?: [\_\_internal_CheckoutProps](internal_checkout-props.mdx)) => void | Opens the Clerk Checkout component in a drawer. | -| `__internal_openPlanDetails` | (props: [\_\_internal_PlanDetailsProps](internal_plan-details-props.mdx)) => void | Opens the Clerk PlanDetails drawer component in a drawer. | -| `__internal_openReverification` | (props?: \_\_internal_UserVerificationModalProps) => void | Opens the Clerk UserVerification component in a modal. | -| `__internal_openSubscriptionDetails` | (props?: [\_\_internal_SubscriptionDetailsProps](internal_subscription-details-props.mdx)) => void | Opens the Clerk SubscriptionDetails drawer component in a drawer. | -| `__internal_setActiveInProgress` | `boolean` | Internal flag indicating whether a `setActive` call is in progress. Used to prevent navigations from being initiated outside of the Clerk class. | -| `__internal_state` | `State` | Entrypoint for Clerk's Signal API containing resource signals along with accessible versions of `computed()` and `effect()` that can be used to subscribe to changes from Signals. | -| `__internal_unmountOAuthConsent` | (targetNode: HTMLDivElement) => void | Unmounts a OAuth consent component from the target element. | -| `addListener` | (callback: ListenerCallback) => UnsubscribeCallback | Register a listener that triggers a callback each time important Clerk resources are changed. Allows to hook up at different steps in the sign up, sign in processes. Some important checkpoints: When there is an active session, user === session.user. When there is no active session, user and session will both be null. When a session is loading, user and session will be undefined. | -| `apiKeys` | `APIKeysNamespace` | API Keys Object | -| `authenticateWithBase` | (params?: AuthenticateWithBaseParams) => Promise\ | Authenticates user using Base Account SDK | -| `authenticateWithCoinbaseWallet` | (params?: AuthenticateWithCoinbaseWalletParams) => Promise\ | Authenticates user using their Coinbase Smart Wallet and browser extension | -| `authenticateWithGoogleOneTap` | (params: AuthenticateWithGoogleOneTapParams) => Promise\<[SignInResource](/docs/reference/javascript/sign-in) \| [SignUpResource](/docs/reference/javascript/sign-up)\> | Authenticates user using a Google token generated from Google identity services. | -| `authenticateWithMetamask` | (params?: AuthenticateWithMetamaskParams) => Promise\ | Authenticates user using their Metamask browser extension | -| `authenticateWithOKXWallet` | (params?: AuthenticateWithOKXWalletParams) => Promise\ | Authenticates user using their OKX Wallet browser extension | -| `authenticateWithWeb3` | (params: ClerkAuthenticateWithWeb3Params) => Promise\ | Authenticates user using their Web3 Wallet browser extension | -| `billing` | [`BillingNamespace`](billing-namespace.mdx) | - | -| `client` | undefined \| ClientResource | Client handling most Clerk operations. | -| `closeCreateOrganization` | () => void | Closes the Clerk CreateOrganization modal. | -| `closeGoogleOneTap` | () => void | Opens the Google One Tap component. If the component is not already open, results in a noop. | -| `closeOrganizationProfile` | () => void | Closes the Clerk OrganizationProfile modal. | -| `closeSignIn` | () => void | Closes the Clerk SignIn modal. | -| `closeSignUp` | () => void | Closes the Clerk SignUp modal. | -| `closeUserProfile` | () => void | Closes the Clerk UserProfile modal. | -| `closeWaitlist` | () => void | Closes the Clerk Waitlist modal. | -| `createOrganization` | (params: [CreateOrganizationParams](#create-organization-params)) => Promise\<[OrganizationResource](/docs/reference/javascript/organization)\> | Creates an organization, adding the current user as admin. | -| `domain` | `string` | Clerk Satellite Frontend API string. | -| `getOrganization` | (organizationId: string) => Promise\<[OrganizationResource](/docs/reference/javascript/organization)\> | Retrieves a single organization by id. | -| `handleEmailLinkVerification` | (params: HandleEmailLinkVerificationParams, customNavigate?: (to: string) => Promise\) => Promise\ | Completes a Email Link flow started by Clerk.client.signIn.createEmailLinkFlow or Clerk.client.signUp.createEmailLinkFlow | -| `handleGoogleOneTapCallback` | (signInOrUp: [SignInResource](/docs/reference/javascript/sign-in) \| [SignUpResource](/docs/reference/javascript/sign-up), params: HandleOAuthCallbackParams, customNavigate?: (to: string) => Promise\) => Promise\ | Completes a Google One Tap redirection flow started by [Clerk.authenticateWithGoogleOneTap](#authenticatewithgoogleonetap) | -| `handleRedirectCallback` | (params: HandleOAuthCallbackParams, customNavigate?: (to: string) => Promise\) => Promise\ | Completes an OAuth or SAML redirection flow started by Clerk.client.signIn.authenticateWithRedirect or Clerk.client.signUp.authenticateWithRedirect | -| `handleUnauthenticated` | () => Promise\ | Handles a 401 response from Frontend API by refreshing the client and session object accordingly | -| `instanceType` | undefined \| InstanceType | Clerk Instance type is defined from the Publishable key | -| `isSatellite` | `boolean` | Clerk Flag for satellite apps. | -| `isSignedIn` | `boolean` | Indicates whether the current user has a valid signed-in client session | -| `isStandardBrowser` | undefined \| boolean | Clerk flag for loading Clerk in a standard browser setup | -| `loaded` | `boolean` | If true the bootstrapping of Clerk.load() has completed successfully. | -| `mountApiKeys` | (targetNode: HTMLDivElement, props?: APIKeysProps) => void | This API is in early access and may change in future releases. Mount a api keys component at the target element. | -| `mountCreateOrganization` | (targetNode: HTMLDivElement, props?: CreateOrganizationProps) => void | Mount a CreateOrganization component at the target element. | -| `mountOrganizationList` | (targetNode: HTMLDivElement, props?: OrganizationListProps) => void | Mount an organization list component at the target element. | -| `mountOrganizationProfile` | (targetNode: HTMLDivElement, props?: OrganizationProfileProps) => void | Mount an organization profile component at the target element. | -| `mountOrganizationSwitcher` | (targetNode: HTMLDivElement, props?: OrganizationSwitcherProps) => void | Mount an organization switcher component at the target element. | -| `mountPricingTable` | (targetNode: HTMLDivElement, props?: PricingTableProps) => void | Mounts a pricing table component at the target element. | -| `mountSignIn` | (targetNode: HTMLDivElement, signInProps?: SignInProps) => void | Mounts a sign in flow component at the target element. | -| `mountSignUp` | (targetNode: HTMLDivElement, signUpProps?: SignUpProps) => void | Mounts a sign up flow component at the target element. | -| `mountTaskChooseOrganization` | (targetNode: HTMLDivElement, props?: TaskChooseOrganizationProps) => void | Mounts a TaskChooseOrganization component at the target element. | -| `mountUserAvatar` | (targetNode: HTMLDivElement, userAvatarProps?: UserAvatarProps) => void | Mount a user avatar component at the target element. | -| `mountUserButton` | (targetNode: HTMLDivElement, userButtonProps?: UserButtonProps) => void | Mount a user button component at the target element. | -| `mountUserProfile` | (targetNode: HTMLDivElement, userProfileProps?: UserProfileProps) => void | Mount a user profile component at the target element. | -| `mountWaitlist` | (targetNode: HTMLDivElement, props?: WaitlistProps) => void | Mount a waitlist at the target element. | -| `navigate` | `CustomNavigation` | Function used to commit a navigation after certain steps in the Clerk processes. | -| `off` | `OffEventListener` | Removes an event handler for a specific Clerk event. **Param** The event name to unsubscribe from **Param** The callback function to remove | -| `on` | `OnEventListener` | Registers an event handler for a specific Clerk event. **Param** The event name to subscribe to **Param** The callback function to execute when the event is dispatched **Param** Optional configuration object **Param** If true and the event was previously dispatched, handler will be called immediately with the latest payload | -| `openCreateOrganization` | (props?: CreateOrganizationModalProps) => void | Opens the Clerk CreateOrganization modal. | -| `openGoogleOneTap` | (props?: GoogleOneTapProps) => void | Opens the Google One Tap component. | -| `openOrganizationProfile` | (props?: OrganizationProfileModalProps) => void | Opens the Clerk OrganizationProfile modal. | -| `openSignIn` | (props?: SignInModalProps) => void | Opens the Clerk SignIn component in a modal. | -| `openSignUp` | (props?: SignUpModalProps) => void | Opens the Clerk SignUp component in a modal. | -| `openUserProfile` | (props?: UserProfileModalProps) => void | Opens the Clerk UserProfile modal. | -| `openWaitlist` | (props?: WaitlistProps) => void | Opens the Clerk Waitlist modal. | -| `organization` | undefined \| null \| [OrganizationResource](/docs/reference/javascript/organization) | Active Organization | -| `proxyUrl` | undefined \| string | Clerk Proxy url string. | -| `publishableKey` | `string` | Clerk Publishable Key string. | -| `redirectToAfterSignIn` | () => void | Redirects to the configured afterSignIn URL. | -| `redirectToAfterSignOut` | () => void | Redirects to the configured afterSignOut URL. | -| `redirectToAfterSignUp` | () => void | Redirects to the configured afterSignUp URL. | -| `redirectToCreateOrganization` | () => Promise\ | Redirects to the configured URL where `` is mounted. | -| `redirectToOrganizationProfile` | () => Promise\ | Redirects to the configured URL where `` is mounted. | -| `redirectToUserProfile` | () => Promise\ | Redirects to the configured URL where `` is mounted. | -| `redirectToWaitlist` | () => void | Redirects to the configured URL where `` is mounted. | -| `sdkMetadata` | undefined \| \{ environment?: string; name: string; version: string; \} | If present, contains information about the SDK that the host application is using. For example, if Clerk is loaded through `@clerk/nextjs`, this would be `{ name: '@clerk/nextjs', version: '1.0.0' }` | -| `session` | undefined \| null \| [SignedInSessionResource](/docs/reference/javascript/session) | Current Session. | -| `setActive` | (setActiveParams: [SetActiveParams](/docs/reference/javascript/types/set-active-params)) => Promise\ | Set the active session and organization explicitly. If the session param is `null`, the active session is deleted. In a similar fashion, if the organization param is `null`, the current organization is removed as active. | -| `signOut` | \{ (options?: SignOutOptions): Promise\; (signOutCallback?: SignOutCallback, options?: SignOutOptions): Promise\; \} | Signs out the current user on single-session instances, or all users on multi-session instances **Param** Optional A callback that runs after sign out completes. **Param** Optional Configuration options, see SignOutOptions | -| `status` | "error" \| "loading" \| "ready" \| "degraded" | Describes the state the clerk singleton operates in: - `"error"`: Clerk failed to initialize. - `"loading"`: Clerk is still attempting to load. - `"ready"`: Clerk singleton is fully operational. - `"degraded"`: Clerk singleton is partially operational. | -| `unmountApiKeys` | (targetNode: HTMLDivElement) => void | This API is in early access and may change in future releases. Unmount a api keys component from the target element. If there is no component mounted at the target node, results in a noop. | -| `unmountCreateOrganization` | (targetNode: HTMLDivElement) => void | Unmount the CreateOrganization component from the target node. | -| `unmountOrganizationList` | (targetNode: HTMLDivElement) => void | Unmount the organization list component from the target node.\* | -| `unmountOrganizationProfile` | (targetNode: HTMLDivElement) => void | Unmount the organization profile component from the target node. | -| `unmountOrganizationSwitcher` | (targetNode: HTMLDivElement) => void | Unmount the organization profile component from the target node.\* | -| `unmountPricingTable` | (targetNode: HTMLDivElement) => void | Unmount a pricing table component from the target element. If there is no component mounted at the target node, results in a noop. | -| `unmountSignIn` | (targetNode: HTMLDivElement) => void | Unmount a sign in flow component from the target element. If there is no component mounted at the target node, results in a noop. | -| `unmountSignUp` | (targetNode: HTMLDivElement) => void | Unmount a sign up flow component from the target element. If there is no component mounted at the target node, results in a noop. | -| `unmountTaskChooseOrganization` | (targetNode: HTMLDivElement) => void | Unmount a TaskChooseOrganization component from the target element. If there is no component mounted at the target node, results in a noop. | -| `unmountUserAvatar` | (targetNode: HTMLDivElement) => void | Unmount a user avatar component at the target element. If there is no component mounted at the target node, results in a noop. | -| `unmountUserButton` | (targetNode: HTMLDivElement) => void | Unmount a user button component at the target element. If there is no component mounted at the target node, results in a noop. | -| `unmountUserProfile` | (targetNode: HTMLDivElement) => void | Unmount a user profile component at the target element. If there is no component mounted at the target node, results in a noop. | -| `unmountWaitlist` | (targetNode: HTMLDivElement) => void | Unmount the Waitlist component from the target node. | -| `user` | undefined \| null \| [UserResource](/docs/reference/javascript/user) | Current User. | -| `version` | undefined \| string | Clerk SDK version number. | diff --git a/clerk-typedoc/types/confirm-checkout-params.mdx b/clerk-typedoc/types/confirm-checkout-params.mdx deleted file mode 100644 index f60f169d9b..0000000000 --- a/clerk-typedoc/types/confirm-checkout-params.mdx +++ /dev/null @@ -1,23 +0,0 @@ -The `confirm()` method accepts the following parameters. **Only one of `paymentSourceId`, `paymentToken`, or `useTestCard` should be provided.** - -There are multiple variants of this type available which you can select by clicking on one of the tabs. - - - -| Name | Type | Description | -| ------ | ------ | ------ | -| `paymentSourceId?` | `string` | The ID of a saved payment method to use for this checkout. | - - -| Name | Type | Description | -| ------ | ------ | ------ | -| `gateway?` | "stripe" \| "paypal" | The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. | -| `paymentToken?` | `string` | A token representing payment details, usually from a payment form. **Requires** `gateway` to be provided. | - - -| Name | Type | Description | -| ------ | ------ | ------ | -| `gateway?` | "stripe" \| "paypal" | The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. | -| `useTestCard?` | `boolean` | If true, uses a test card for the checkout. **Requires** `gateway` to be provided. | - - diff --git a/clerk-typedoc/types/create-checkout-params.mdx b/clerk-typedoc/types/create-checkout-params.mdx deleted file mode 100644 index 0265096a03..0000000000 --- a/clerk-typedoc/types/create-checkout-params.mdx +++ /dev/null @@ -1 +0,0 @@ -The `startCheckout()` method accepts the following parameters. diff --git a/clerk-typedoc/types/create-organization-params.mdx b/clerk-typedoc/types/create-organization-params.mdx deleted file mode 100644 index 77db98c597..0000000000 --- a/clerk-typedoc/types/create-organization-params.mdx +++ /dev/null @@ -1,4 +0,0 @@ -| Property | Type | Description | -| ------------------------- | -------- | ----------------------------- | -| `name` | `string` | The name of the organization. | -| `slug?` | `string` | The slug of the organization. | diff --git a/clerk-typedoc/types/deleted-object-resource.mdx b/clerk-typedoc/types/deleted-object-resource.mdx deleted file mode 100644 index e896d72323..0000000000 --- a/clerk-typedoc/types/deleted-object-resource.mdx +++ /dev/null @@ -1,10 +0,0 @@ -The `DeletedObjectResource` type represents an item that has been deleted from the database. - -## Properties - -| Property | Type | Description | -| ------------------------------ | --------- | --------------------------------------------------- | -| `deleted` | `boolean` | Whether the object has been deleted. | -| `id?` | `string` | The unique identifier for the deleted object. | -| `object` | `string` | The type of object that has been deleted. | -| `slug?` | `string` | The URL-friendly identifier for the deleted object. | diff --git a/clerk-typedoc/types/element-object-key.mdx b/clerk-typedoc/types/element-object-key.mdx deleted file mode 100644 index f5fec84468..0000000000 --- a/clerk-typedoc/types/element-object-key.mdx +++ /dev/null @@ -1 +0,0 @@ -Convert a kebab-cased key from ElementsConfig into a camelCased Elements key diff --git a/clerk-typedoc/types/elements-config.mdx b/clerk-typedoc/types/elements-config.mdx deleted file mode 100644 index 603ae040f4..0000000000 --- a/clerk-typedoc/types/elements-config.mdx +++ /dev/null @@ -1,3 +0,0 @@ -A map that describes the possible combinations we need to generate -for each unique base element -Kebab-case is used to differentiate between the container and child elements diff --git a/clerk-typedoc/types/errors.mdx b/clerk-typedoc/types/errors.mdx deleted file mode 100644 index 757f955f73..0000000000 --- a/clerk-typedoc/types/errors.mdx +++ /dev/null @@ -1,9 +0,0 @@ -Represents the errors that occurred during the last fetch of the parent resource. - -## Properties - -| Property | Type | Description | -| ---------------------------- | --------------------------------- | ------------------------------------------------------------- | -| `fields` | [`FieldErrors`](field-errors.mdx) | Represents the collection of possible errors on known fields. | -| `global` | null \| unknown[] | Parsed errors that are not related to any specific field. | -| `raw` | null \| unknown[] | The raw, unparsed errors from the Clerk API. | diff --git a/clerk-typedoc/types/experimental_checkout-button-props.mdx b/clerk-typedoc/types/experimental_checkout-button-props.mdx deleted file mode 100644 index 4fb5cf31aa..0000000000 --- a/clerk-typedoc/types/experimental_checkout-button-props.mdx +++ /dev/null @@ -1,7 +0,0 @@ -> **\_\_experimental_CheckoutButtonProps** = \{ newSubscriptionRedirectUrl?: string; \} - -## Properties - -| Property | Type | Description | -| --------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `newSubscriptionRedirectUrl?` | `string` | Full URL or path to navigate to after checkout is complete and the user clicks the "Continue" button. Defaults to `undefined`. | diff --git a/clerk-typedoc/types/experimental_plan-details-button-props.mdx b/clerk-typedoc/types/experimental_plan-details-button-props.mdx deleted file mode 100644 index 5c1e8862f2..0000000000 --- a/clerk-typedoc/types/experimental_plan-details-button-props.mdx +++ /dev/null @@ -1,4 +0,0 @@ -| Name | Type | -| -------------------- | -------------------------------------------------------------------------------------------- | -| `initialPlanPeriod?` | [`BillingSubscriptionPlanPeriod`](billing-subscription-plan-period.mdx) | -| `planDetailsProps?` | \{ appearance?: PlanDetailTheme; portalId?: string; portalRoot?: PortalRoot; \} | diff --git a/clerk-typedoc/types/experimental_subscription-details-button-props.mdx b/clerk-typedoc/types/experimental_subscription-details-button-props.mdx deleted file mode 100644 index b1d5c05866..0000000000 --- a/clerk-typedoc/types/experimental_subscription-details-button-props.mdx +++ /dev/null @@ -1,7 +0,0 @@ -> **\_\_experimental_SubscriptionDetailsButtonProps** = \{ for?: [ForPayerType](for-payer-type.mdx); \} - -## Properties - -| Property | Type | Description | -| ----------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `for?` | [`ForPayerType`](for-payer-type.mdx) | The subscriber type to display the subscription details for. If `organization` is provided, the subscription details will be displayed for the active organization. Defaults to `'user'`. | diff --git a/clerk-typedoc/types/feature-json.mdx b/clerk-typedoc/types/feature-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/feature-resource.mdx b/clerk-typedoc/types/feature-resource.mdx deleted file mode 100644 index 53a5d2721a..0000000000 --- a/clerk-typedoc/types/feature-resource.mdx +++ /dev/null @@ -1,12 +0,0 @@ -The `FeatureResource` type represents a feature of a plan. - -## Properties - -| Property | Type | Description | -| -------------------------------------- | -------- | -------------------------------------------------- | -| `avatarUrl` | `string` | The URL of the feature's avatar image. | -| `description` | `string` | A short description of what the feature provides. | -| `id` | `string` | The unique identifier for the feature. | -| `name` | `string` | The display name of the feature. | -| `pathRoot` | `string` | The root path of the resource. | -| `slug` | `string` | A unique, URL-friendly identifier for the feature. | diff --git a/clerk-typedoc/types/field-error.mdx b/clerk-typedoc/types/field-error.mdx deleted file mode 100644 index b336806df2..0000000000 --- a/clerk-typedoc/types/field-error.mdx +++ /dev/null @@ -1,9 +0,0 @@ -Represents an error on a specific field. - -## Properties - -| Property | Type | Description | -| --------------------------------------- | -------- | ------------------------------------------------------- | -| `code` | `string` | The error code of the error, returned by the Clerk API. | -| `longMessage?` | `string` | A more detailed message that describes the error. | -| `message` | `string` | A message that describes the error. | diff --git a/clerk-typedoc/types/field-errors.mdx b/clerk-typedoc/types/field-errors.mdx deleted file mode 100644 index 2c3f08e479..0000000000 --- a/clerk-typedoc/types/field-errors.mdx +++ /dev/null @@ -1,16 +0,0 @@ -Represents the collection of possible errors on known fields. - -## Properties - -| Property | Type | Description | -| ------------------------------------------ | -------------------------------------------------- | --------------------------------------- | -| `captcha` | null \| [FieldError](field-error.mdx) | The error for the captcha field. | -| `code` | null \| [FieldError](field-error.mdx) | The error for the code field. | -| `emailAddress` | null \| [FieldError](field-error.mdx) | The error for the email address field. | -| `firstName` | null \| [FieldError](field-error.mdx) | The error for the first name field. | -| `identifier` | null \| [FieldError](field-error.mdx) | The error for the identifier field. | -| `lastName` | null \| [FieldError](field-error.mdx) | The error for the last name field. | -| `legalAccepted` | null \| [FieldError](field-error.mdx) | The error for the legal accepted field. | -| `password` | null \| [FieldError](field-error.mdx) | The error for the password field. | -| `phoneNumber` | null \| [FieldError](field-error.mdx) | The error for the phone number field. | -| `username` | null \| [FieldError](field-error.mdx) | The error for the username field. | diff --git a/clerk-typedoc/types/for-payer-type.mdx b/clerk-typedoc/types/for-payer-type.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/get-payment-attempts-params.mdx b/clerk-typedoc/types/get-payment-attempts-params.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/get-payment-methods-params.mdx b/clerk-typedoc/types/get-payment-methods-params.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/get-plans-params.mdx b/clerk-typedoc/types/get-plans-params.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/get-statements-params.mdx b/clerk-typedoc/types/get-statements-params.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/get-subscription-params.mdx b/clerk-typedoc/types/get-subscription-params.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/get-token.mdx b/clerk-typedoc/types/get-token.mdx deleted file mode 100644 index 60dbf10f03..0000000000 --- a/clerk-typedoc/types/get-token.mdx +++ /dev/null @@ -1,9 +0,0 @@ -## Parameters - -| Parameter | Type | -| ---------- | ----------------- | -| `options?` | `GetTokenOptions` | - -## Returns - -`Promise`\<string \| null\> diff --git a/clerk-typedoc/types/id-selectors.mdx b/clerk-typedoc/types/id-selectors.mdx deleted file mode 100644 index 29c20772b8..0000000000 --- a/clerk-typedoc/types/id-selectors.mdx +++ /dev/null @@ -1 +0,0 @@ -Create a type union consisting of the base element with all valid ids appended diff --git a/clerk-typedoc/types/initialize-payment-method-params.mdx b/clerk-typedoc/types/initialize-payment-method-params.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/internal_checkout-props.mdx b/clerk-typedoc/types/internal_checkout-props.mdx deleted file mode 100644 index c8a207ad18..0000000000 --- a/clerk-typedoc/types/internal_checkout-props.mdx +++ /dev/null @@ -1,7 +0,0 @@ -> **\_\_internal_CheckoutProps** = \{ newSubscriptionRedirectUrl?: string; \} - -## Properties - -| Property | Type | Description | -| --------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ | -| `newSubscriptionRedirectUrl?` | `string` | Full URL or path to navigate to after checkout is complete and the user clicks the "Continue" button. Defaults to `undefined`. | diff --git a/clerk-typedoc/types/internal_plan-details-props.mdx b/clerk-typedoc/types/internal_plan-details-props.mdx deleted file mode 100644 index 909d67d1d7..0000000000 --- a/clerk-typedoc/types/internal_plan-details-props.mdx +++ /dev/null @@ -1,6 +0,0 @@ -| Name | Type | -| -------------------- | ----------------------------------------------------------------------- | -| `appearance?` | `PlanDetailTheme` | -| `initialPlanPeriod?` | [`BillingSubscriptionPlanPeriod`](billing-subscription-plan-period.mdx) | -| `portalId?` | `string` | -| `portalRoot?` | `PortalRoot` | diff --git a/clerk-typedoc/types/internal_subscription-details-props.mdx b/clerk-typedoc/types/internal_subscription-details-props.mdx deleted file mode 100644 index 5e902c097d..0000000000 --- a/clerk-typedoc/types/internal_subscription-details-props.mdx +++ /dev/null @@ -1,7 +0,0 @@ -> **\_\_internal_SubscriptionDetailsProps** = \{ for?: [ForPayerType](for-payer-type.mdx); \} - -## Properties - -| Property | Type | Description | -| ----------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `for?` | [`ForPayerType`](for-payer-type.mdx) | The subscriber type to display the subscription details for. If `organization` is provided, the subscription details will be displayed for the active organization. Defaults to `'user'`. | diff --git a/clerk-typedoc/types/jwt-claims.mdx b/clerk-typedoc/types/jwt-claims.mdx deleted file mode 100644 index 16182c2435..0000000000 --- a/clerk-typedoc/types/jwt-claims.mdx +++ /dev/null @@ -1,27 +0,0 @@ -## Deprecated - -Use `JwtPayload` instead. - -## Indexable - -\[`propName`: `string`\]: `unknown` - -Any other JWT Claim Set member. - -## Properties - -| Property | Type | Description | -| ------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| ~~`__raw`~~ | `string` | Encoded token supporting the `getRawString` method. | -| ~~`act?`~~ | \{ [x: string]: unknown; sub: string; \} | JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim). | -| `act.sub` | `string` | - | -| ~~`azp?`~~ | `string` | JWT Authorized party - [RFC7800#section-3](https://tools.ietf.org/html/rfc7800#section-3). | -| ~~`exp`~~ | `number` | JWT Expiration Time - [RFC7519#section-4.1.4](https://tools.ietf.org/html/rfc7519#section-4.1.4). | -| ~~`iat`~~ | `number` | JWT Issued At - [RFC7519#section-4.1.6](https://tools.ietf.org/html/rfc7519#section-4.1.6). | -| ~~`iss`~~ | `string` | JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1). | -| ~~`nbf`~~ | `number` | JWT Not Before - [RFC7519#section-4.1.5](https://tools.ietf.org/html/rfc7519#section-4.1.5). | -| ~~`org_id?`~~ | `string` | Active organization ID. | -| ~~`org_role?`~~ | `string` | Active organization role. | -| ~~`org_slug?`~~ | `string` | Active organization slug. | -| ~~`sid`~~ | `string` | Session ID | -| ~~`sub`~~ | `string` | JWT Subject - [RFC7519#section-4.1.2](https://tools.ietf.org/html/rfc7519#section-4.1.2). | diff --git a/clerk-typedoc/types/jwt-header.mdx b/clerk-typedoc/types/jwt-header.mdx deleted file mode 100644 index ad47ca006c..0000000000 --- a/clerk-typedoc/types/jwt-header.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Deprecated - -Use `JwtHeader` instead. diff --git a/clerk-typedoc/types/legacy-redirect-props.mdx b/clerk-typedoc/types/legacy-redirect-props.mdx deleted file mode 100644 index 62b50d2039..0000000000 --- a/clerk-typedoc/types/legacy-redirect-props.mdx +++ /dev/null @@ -1,13 +0,0 @@ -> **LegacyRedirectProps** = \{ afterSignInUrl?: string \| null; afterSignUpUrl?: string \| null; redirectUrl?: string \| null; \} - -## Deprecated - -This will be removed in a future release. - -## Properties - -| Property | Type | Description | -| ------------------------------------------------- | --------------------------- | ------------------------------------------------------------------------ | -| ~~`afterSignInUrl?`~~ | string \| null | **Deprecated.** Use `fallbackRedirectUrl` or `forceRedirectUrl` instead. | -| ~~`afterSignUpUrl?`~~ | string \| null | **Deprecated.** Use `fallbackRedirectUrl` or `forceRedirectUrl` instead. | -| ~~`redirectUrl?`~~ | string \| null | **Deprecated.** Use `fallbackRedirectUrl` or `forceRedirectUrl` instead. | diff --git a/clerk-typedoc/types/localization-resource.mdx b/clerk-typedoc/types/localization-resource.mdx deleted file mode 100644 index 55e3447b4a..0000000000 --- a/clerk-typedoc/types/localization-resource.mdx +++ /dev/null @@ -1,14 +0,0 @@ -A type containing all the possible localization keys the prebuilt Clerk components support. -Users aiming to customize a few strings can also peak at the `data-localization-key` attribute by inspecting -the DOM and updating the corresponding key. -Users aiming to completely localize the components by providing a complete translation can use -the default english resource object from [Clerk's open source repo](https://github.com/clerk/javascript) -as a starting point. - -## Properties - -| Property | Type | Description | -| ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `lastAuthenticationStrategy?` | `string` | Label for the “Last used” badge on authentication strategies. | -| `roles?` | `DeepPartial`\<`DeepLocalizationWithoutObjects`\<\{ [r: string]: string; \}\>\> | Add role keys and their localized values, e.g. `roles: { 'org:teacher': 'Teacher'}`. | -| `socialButtonsBlockButtonManyInView?` | `DeepPartial`\<\`$\{string\}\{\{provider\|titleize\}\}$\{string\}\` & \{ \_\_params: UnionToRecordWithPrimitives\; \}\> | It should be used to provide a shorter variation of `socialButtonsBlockButton`. It is explicitly typed, in order to avoid contributions that use LLM tools to generate translations that misinterpret the correct usage of this property. | diff --git a/clerk-typedoc/types/make-default-payment-method-params.mdx b/clerk-typedoc/types/make-default-payment-method-params.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/multi-domain-and-or-proxy.mdx b/clerk-typedoc/types/multi-domain-and-or-proxy.mdx deleted file mode 100644 index 74aaeba53a..0000000000 --- a/clerk-typedoc/types/multi-domain-and-or-proxy.mdx +++ /dev/null @@ -1,24 +0,0 @@ -You can configure proxy and satellite domains in a few ways: - -1. none of them are set -2. only `proxyUrl` is set -3. `isSatellite` and `proxyUrl` are set -4. `isSatellite` and `domain` are set - -| Name | Type | Description | -| -------------- | ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `domain?` | `never` | **Required if your application is a satellite application**. Sets the domain of the satellite application. | -| `isSatellite?` | `never` | A boolean that indicates whether the application is a satellite application. | -| `proxyUrl?` | never \| string \| (url: URL) => string | **Required for applications that run behind a reverse proxy**. The URL that Clerk will proxy requests to. Can be either a relative path (`/__clerk`) or a full URL (`https:///__clerk`). | - -| Name | Type | -| ------------- | ----------------------------------------------------------- | -| `domain` | string \| (url: URL) => string | -| `isSatellite` | `Exclude`\<`ClerkOptions`\[`"isSatellite"`\], `undefined`\> | -| `proxyUrl?` | `never` | - -| Name | Type | -| ------------- | ----------------------------------------------------------- | -| `domain?` | `never` | -| `isSatellite` | `Exclude`\<`ClerkOptions`\[`"isSatellite"`\], `undefined`\> | -| `proxyUrl` | string \| (url: URL) => string | diff --git a/clerk-typedoc/types/organization-custom-role-key.mdx b/clerk-typedoc/types/organization-custom-role-key.mdx deleted file mode 100644 index 5a0af4dce8..0000000000 --- a/clerk-typedoc/types/organization-custom-role-key.mdx +++ /dev/null @@ -1,3 +0,0 @@ -`OrganizationCustomRoleKey` is a type that represents the user's role in an organization. It will be string unless the developer has provided their own types through [`ClerkAuthorization`](/docs/guides/development/override-clerk-types-interfaces#example-custom-roles-and-permissions). - -Clerk provides the [default roles](/docs/guides/organizations/roles-and-permissions#default-roles) `org:admin` and `org:member`. However, you can create [custom roles](/docs/guides/organizations/roles-and-permissions#custom-roles) as well. diff --git a/clerk-typedoc/types/organization-domain-resource.mdx b/clerk-typedoc/types/organization-domain-resource.mdx deleted file mode 100644 index 5c7869964b..0000000000 --- a/clerk-typedoc/types/organization-domain-resource.mdx +++ /dev/null @@ -1,8 +0,0 @@ -The `OrganizationDomain` object is the model around an organization domain. - -## Properties - -| Property | Type | Description | -| -------------------------------- | -------- | -------------------------------------- | -| `id` | `string` | The unique identifier of the resource. | -| `pathRoot` | `string` | The root path of the resource. | diff --git a/clerk-typedoc/types/organization-domain-verification-status.mdx b/clerk-typedoc/types/organization-domain-verification-status.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/organization-enrollment-mode.mdx b/clerk-typedoc/types/organization-enrollment-mode.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/organization-invitation-resource.mdx b/clerk-typedoc/types/organization-invitation-resource.mdx deleted file mode 100644 index e948d20de9..0000000000 --- a/clerk-typedoc/types/organization-invitation-resource.mdx +++ /dev/null @@ -1,8 +0,0 @@ -The `OrganizationInvitation` object is the model around an organization invitation. - -## Properties - -| Property | Type | Description | -| -------------------------------- | -------- | -------------------------------------- | -| `id` | `string` | The unique identifier of the resource. | -| `pathRoot` | `string` | The root path of the resource. | diff --git a/clerk-typedoc/types/organization-invitation-status.mdx b/clerk-typedoc/types/organization-invitation-status.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/organization-membership-request-resource.mdx b/clerk-typedoc/types/organization-membership-request-resource.mdx deleted file mode 100644 index aa0e24946e..0000000000 --- a/clerk-typedoc/types/organization-membership-request-resource.mdx +++ /dev/null @@ -1,8 +0,0 @@ -The `OrganizationMembershipRequest` object is the model that describes the request of a user to join an organization. - -## Properties - -| Property | Type | Description | -| -------------------------------- | -------- | -------------------------------------- | -| `id` | `string` | The unique identifier of the resource. | -| `pathRoot` | `string` | The root path of the resource. | diff --git a/clerk-typedoc/types/organization-membership-resource.mdx b/clerk-typedoc/types/organization-membership-resource.mdx deleted file mode 100644 index 882ca41aef..0000000000 --- a/clerk-typedoc/types/organization-membership-resource.mdx +++ /dev/null @@ -1,8 +0,0 @@ -The `OrganizationMembership` object is the model around an organization membership entity and describes the relationship between users and organizations. - -## Properties - -| Property | Type | Description | -| -------------------------------- | -------- | -------------------------------------- | -| `id` | `string` | The unique identifier of the resource. | -| `pathRoot` | `string` | The root path of the resource. | diff --git a/clerk-typedoc/types/organization-permission-key.mdx b/clerk-typedoc/types/organization-permission-key.mdx deleted file mode 100644 index 32332de64d..0000000000 --- a/clerk-typedoc/types/organization-permission-key.mdx +++ /dev/null @@ -1,2 +0,0 @@ -OrganizationPermissionKey is a combination of system and custom permissions. -System permissions are only accessible from FAPI and client-side operations/utils diff --git a/clerk-typedoc/types/organization-resource.mdx b/clerk-typedoc/types/organization-resource.mdx deleted file mode 100644 index 06983d809a..0000000000 --- a/clerk-typedoc/types/organization-resource.mdx +++ /dev/null @@ -1,13 +0,0 @@ -The `Organization` object holds information about an organization, as well as methods for managing it. - -To use these methods, you must have the **Organizations** feature [enabled in your app's settings in the Clerk Dashboard](/docs/guides/organizations/overview#enable-organizations-in-your-application). - -## Properties - -| Property | Type | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -| `addPaymentMethod` | (params: [AddPaymentMethodParams](add-payment-method-params.mdx)) => Promise\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\> | - | -| `getPaymentMethods` | (params: [GetPaymentMethodsParams](get-payment-methods-params.mdx)) => Promise\<[ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\>\> | - | -| `id` | `string` | The unique identifier of the resource. | -| `initializePaymentMethod` | (params: [InitializePaymentMethodParams](initialize-payment-method-params.mdx)) => Promise\<[BillingInitializedPaymentMethodResource](billing-initialized-payment-method-resource.mdx)\> | - | -| `pathRoot` | `string` | The root path of the resource. | diff --git a/clerk-typedoc/types/organization-suggestion-resource.mdx b/clerk-typedoc/types/organization-suggestion-resource.mdx deleted file mode 100644 index 25b3c4703f..0000000000 --- a/clerk-typedoc/types/organization-suggestion-resource.mdx +++ /dev/null @@ -1,8 +0,0 @@ -An interface representing an organization suggestion. - -## Properties - -| Property | Type | Description | -| -------------------------------- | -------- | -------------------------------------- | -| `id` | `string` | The unique identifier of the resource. | -| `pathRoot` | `string` | The root path of the resource. | diff --git a/clerk-typedoc/types/organization-suggestion-status.mdx b/clerk-typedoc/types/organization-suggestion-status.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/organizations-jwt-claim.mdx b/clerk-typedoc/types/organizations-jwt-claim.mdx deleted file mode 100644 index cd60c4db28..0000000000 --- a/clerk-typedoc/types/organizations-jwt-claim.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Deprecated - -This type will be removed in the next major version. diff --git a/clerk-typedoc/types/override.mdx b/clerk-typedoc/types/override.mdx deleted file mode 100644 index 6aec62ed95..0000000000 --- a/clerk-typedoc/types/override.mdx +++ /dev/null @@ -1,4 +0,0 @@ -Overrides the type of existing properties -const obj = { a: string, b: number } as const; -type Value = Override -Value contains: { a:string, b: string } diff --git a/clerk-typedoc/types/path-value.mdx b/clerk-typedoc/types/path-value.mdx deleted file mode 100644 index 6b63699056..0000000000 --- a/clerk-typedoc/types/path-value.mdx +++ /dev/null @@ -1,4 +0,0 @@ -Used to read the value of a string path inside an object defined as const -const obj = { a: { b: 'hello' }} as const; -type Value = PathValue -Value is now a union set containing a single type: 'hello' diff --git a/clerk-typedoc/types/payment-gateway.mdx b/clerk-typedoc/types/payment-gateway.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/pending-session-options.mdx b/clerk-typedoc/types/pending-session-options.mdx deleted file mode 100644 index 3b210e465f..0000000000 --- a/clerk-typedoc/types/pending-session-options.mdx +++ /dev/null @@ -1,7 +0,0 @@ -> **PendingSessionOptions** = \{ treatPendingAsSignedOut?: boolean; \} - -## Properties - -| Property | Type | Description | -| --------------------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------------------------- | -| `treatPendingAsSignedOut?` | `boolean` | A boolean that indicates whether pending sessions are considered as signed out or not. Defaults to `true`. | diff --git a/clerk-typedoc/types/pending-session-resource.mdx b/clerk-typedoc/types/pending-session-resource.mdx deleted file mode 100644 index 05ec3f4187..0000000000 --- a/clerk-typedoc/types/pending-session-resource.mdx +++ /dev/null @@ -1,12 +0,0 @@ -Represents a session resource that has completed sign-in but has pending tasks - -## Properties - -| Property | Type | Description | -| ---------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `end` | () => Promise\<[SessionResource](/docs/reference/javascript/session)\> | Marks the session as ended. The session will no longer be active for this `Client` and its status will become **ended**. | -| `factorVerificationAge` | null \| \[number, number\] | An array where each item represents the number of minutes since the last verification of a first or second factor: `[firstFactorAge, secondFactorAge]`. | -| `id` | `string` | The unique identifier for the session. | -| `pathRoot` | `string` | The root path of the resource. | -| `status` | `"pending"` | The current state of the session. | -| `user` | [`UserResource`](/docs/reference/javascript/user) | The user associated with the session. | diff --git a/clerk-typedoc/types/protect-props.mdx b/clerk-typedoc/types/protect-props.mdx deleted file mode 100644 index caa5998e83..0000000000 --- a/clerk-typedoc/types/protect-props.mdx +++ /dev/null @@ -1,22 +0,0 @@ -Props for the `` component, which restricts access to its children based on authentication and authorization. - -Use `ProtectProps` to specify the required role, permission, feature, or plan for access. - -## Example - -```tsx -// Require a specific permission - - -// Require a specific role - - -// Use a custom condition callback - has({ permission: "a_permission_key" })} /> - -// Require a specific feature - - -// Require a specific plan - -``` diff --git a/clerk-typedoc/types/record-to-path.mdx b/clerk-typedoc/types/record-to-path.mdx deleted file mode 100644 index d89089101d..0000000000 --- a/clerk-typedoc/types/record-to-path.mdx +++ /dev/null @@ -1,4 +0,0 @@ -Used to construct a type union containing all the keys (even if nested) of an object defined as const -const obj = { a: { b: '' }, c: '' } as const; -type Paths = RecordToPath -Paths contains: 'a' | 'a.b' | 'c' diff --git a/clerk-typedoc/types/redirect-options.mdx b/clerk-typedoc/types/redirect-options.mdx deleted file mode 100644 index b505ddb60c..0000000000 --- a/clerk-typedoc/types/redirect-options.mdx +++ /dev/null @@ -1,2 +0,0 @@ -Redirect URLs for different actions. -Mainly used to be used to type internal Clerk functions. diff --git a/clerk-typedoc/types/remove-payment-method-params.mdx b/clerk-typedoc/types/remove-payment-method-params.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/reverification-config.mdx b/clerk-typedoc/types/reverification-config.mdx deleted file mode 100644 index 9ce8f049f6..0000000000 --- a/clerk-typedoc/types/reverification-config.mdx +++ /dev/null @@ -1,8 +0,0 @@ -The `ReverificationConfig` type has the following properties: - -"strict" \| "strict_mfa" \| "moderate" \| "lax" - -| Name | Type | Description | -| -------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `afterMinutes` | `SessionVerificationAfterMinutes` | The age of the factor level to check for. Value should be greater than or equal to 1 and less than 99,999. | -| `level` | "first_factor" \| "second_factor" \| "multi_factor" | The reverification level of credentials to check for. | diff --git a/clerk-typedoc/types/saml-strategy.mdx b/clerk-typedoc/types/saml-strategy.mdx deleted file mode 100644 index a8f26d96d3..0000000000 --- a/clerk-typedoc/types/saml-strategy.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Deprecated - -Use `EnterpriseSSOStrategy` instead. diff --git a/clerk-typedoc/types/sdk-metadata.mdx b/clerk-typedoc/types/sdk-metadata.mdx deleted file mode 100644 index 42ddd4d54c..0000000000 --- a/clerk-typedoc/types/sdk-metadata.mdx +++ /dev/null @@ -1,9 +0,0 @@ -> **SDKMetadata** = \{ environment?: string; name: string; version: string; \} - -## Properties - -| Property | Type | Description | -| --------------------------------------- | -------- | --------------------------------------------------------------------------- | -| `environment?` | `string` | Typically this will be the `NODE_ENV` that the SDK is currently running in. | -| `name` | `string` | The npm package name of the SDK. | -| `version` | `string` | The npm package version of the SDK. | diff --git a/clerk-typedoc/types/server-get-token-options.mdx b/clerk-typedoc/types/server-get-token-options.mdx deleted file mode 100644 index a63b221731..0000000000 --- a/clerk-typedoc/types/server-get-token-options.mdx +++ /dev/null @@ -1,10 +0,0 @@ -> **ServerGetTokenOptions** = \{ expiresInSeconds?: number; template?: string; \} - -Options for retrieving a session token. - -## Properties - -| Property | Type | Description | -| ------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `expiresInSeconds?` | `number` | The expiration time for the token in seconds. If provided, the token will expire after the specified number of seconds. Must be a positive integer. | -| `template?` | `string` | The name of a JWT template configured in the Clerk Dashboard. If provided, a JWT will be generated using the specified template. If not provided, the raw session token will be returned. | diff --git a/clerk-typedoc/types/server-get-token.mdx b/clerk-typedoc/types/server-get-token.mdx deleted file mode 100644 index b0e14e560a..0000000000 --- a/clerk-typedoc/types/server-get-token.mdx +++ /dev/null @@ -1,11 +0,0 @@ -A function that retrieves a session token or JWT template. - -## Parameters - -| Parameter | Type | Description | -| ---------- | ------------------------------------------------------- | ----------------------------------------- | -| `options?` | [`ServerGetTokenOptions`](server-get-token-options.mdx) | Configuration options for token retrieval | - -## Returns - -`Promise`\<string \| null\> — A promise that resolves to the token string, or null if no session exists diff --git a/clerk-typedoc/types/session-resource.mdx b/clerk-typedoc/types/session-resource.mdx deleted file mode 100644 index 783f36e579..0000000000 --- a/clerk-typedoc/types/session-resource.mdx +++ /dev/null @@ -1,23 +0,0 @@ -The `Session` object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server. - -The `Session` object includes methods for recording session activity and ending the session client-side. For security reasons, sessions can also expire server-side. - -As soon as a [`User`](/docs/reference/javascript/user) signs in, Clerk creates a `Session` for the current [`Client`](/docs/reference/javascript/client). Clients can have more than one sessions at any point in time, but only one of those sessions will be **active**. - -In certain scenarios, a session might be replaced by another one. This is often the case with [multi-session applications](/docs/guides/secure/session-options#multi-session-applications). - -All sessions that are **expired**, **removed**, **replaced**, **ended** or **abandoned** are not considered valid. - -> [!NOTE] -> For more information regarding the different session states, see the [guide on session management](/docs/guides/secure/session-options). - -## Properties - -| Property | Type | Description | -| ---------------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `end` | () => Promise\ | Marks the session as ended. The session will no longer be active for this `Client` and its status will become **ended**. | -| `factorVerificationAge` | null \| \[number, number\] | An array where each item represents the number of minutes since the last verification of a first or second factor: `[firstFactorAge, secondFactorAge]`. | -| `id` | `string` | The unique identifier for the session. | -| `pathRoot` | `string` | The root path of the resource. | -| `status` | `SessionStatus` | The current state of the session. | -| `user` | null \| [UserResource](/docs/reference/javascript/user) | The user associated with the session. | diff --git a/clerk-typedoc/types/session-status-claim.mdx b/clerk-typedoc/types/session-status-claim.mdx deleted file mode 100644 index de59753547..0000000000 --- a/clerk-typedoc/types/session-status-claim.mdx +++ /dev/null @@ -1 +0,0 @@ -The current state of the session which can only be `active` or `pending`. diff --git a/clerk-typedoc/types/session-task.mdx b/clerk-typedoc/types/session-task.mdx deleted file mode 100644 index 12c0552a25..0000000000 --- a/clerk-typedoc/types/session-task.mdx +++ /dev/null @@ -1,7 +0,0 @@ -Represents the current pending task of a session. - -## Properties - -| Property | Type | Description | -| ---------------------- | ----------------------- | -------------------------------- | -| `key` | `"choose-organization"` | A unique identifier for the task | diff --git a/clerk-typedoc/types/session-verification-level.mdx b/clerk-typedoc/types/session-verification-level.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/session-verification-types.mdx b/clerk-typedoc/types/session-verification-types.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/set-active-params.mdx b/clerk-typedoc/types/set-active-params.mdx deleted file mode 100644 index 9f78b7a35d..0000000000 --- a/clerk-typedoc/types/set-active-params.mdx +++ /dev/null @@ -1,11 +0,0 @@ -The parameters for the `setActive()` method. - -## Properties - -| Property | Type | Description | -| ----------------------------------------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ~~`beforeEmit?`~~ | `BeforeEmitCallback` | **Deprecated.** Use `redirectUrl` instead. Callback run just before the active session and/or organization is set to the passed object. Can be used to set up for pre-navigation actions. | -| `navigate?` | `SetActiveNavigate` | A custom navigation function to be called just before the session and/or organization is set. When provided, it takes precedence over the `redirectUrl` parameter for navigation. Example: `await clerk.setActive({ session, navigate: async ({ session }) => { const currentTask = session.currentTask; if (currentTask) { await router.push(`./onboarding/${currentTask.key}`) return } router.push('/dashboard'); } });` | -| `organization?` | null \| string \| [OrganizationResource](/docs/reference/javascript/organization) | The organization resource or organization ID/slug (string version) to be set as active in the current session. If `null`, the currently active organization is removed as active. | -| `redirectUrl?` | `string` | The full URL or path to redirect to just before the session and/or organization is set. | -| `session?` | null \| string \| [SignedInSessionResource](/docs/reference/javascript/session) | The session resource or session ID (string version) to be set as active. If `null`, the current session is deleted. | diff --git a/clerk-typedoc/types/set-active.mdx b/clerk-typedoc/types/set-active.mdx deleted file mode 100644 index adbe2253d4..0000000000 --- a/clerk-typedoc/types/set-active.mdx +++ /dev/null @@ -1,9 +0,0 @@ -## Parameters - -| Parameter | Type | -| ----------------- | ----------------------------------------------------------------------- | -| `setActiveParams` | [`SetActiveParams`](/docs/reference/javascript/types/set-active-params) | - -## Returns - -`Promise`\<`void`\> diff --git a/clerk-typedoc/types/sign-in-future-resource.mdx b/clerk-typedoc/types/sign-in-future-resource.mdx deleted file mode 100644 index b98a5fe064..0000000000 --- a/clerk-typedoc/types/sign-in-future-resource.mdx +++ /dev/null @@ -1,43 +0,0 @@ -The `SignInFuture` class holds the state of the current sign-in and provides helper methods to navigate and complete -the sign-in process. It is used to manage the sign-in lifecycle, including the first and second factor verification, -and the creation of a new session. - -## Properties - -| Property | Type | Description | -| ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `create` | (params: SignInFutureCreateParams) => Promise\<\{ error: unknown; \}\> | Creates a new `SignIn` instance initialized with the provided parameters. The instance maintains the sign-in lifecycle state through its `status` property, which updates as the authentication flow progresses. What you must pass to `params` depends on which [sign-in options](/docs/guides/configure/auth-strategies/sign-up-sign-in-options) you have enabled in your app's settings in the Clerk Dashboard. You can complete the sign-in process in one step if you supply the required fields to `create()`. Otherwise, Clerk's sign-in process provides great flexibility and allows users to easily create multi-step sign-in flows. > [!WARNING] > Once the sign-in process is complete, call the `signIn.finalize()` method to set the newly created session as > the active session. | -| `createdSessionId` | null \| string | The identifier of the session that was created upon completion of the current sign-in. The value of this property is `null` if the sign-in status is not `'complete'`. | -| `emailCode` | \{ sendCode: (params: SignInFutureEmailCodeSendParams) => Promise\<\{ error: unknown; \}\>; verifyCode: (params: SignInFutureEmailCodeVerifyParams) => Promise\<\{ error: unknown; \}\>; \} | - | -| `emailCode.sendCode` | (params: SignInFutureEmailCodeSendParams) => Promise\<\{ error: unknown; \}\> | Used to send an email code to sign-in | -| `emailCode.verifyCode` | (params: SignInFutureEmailCodeVerifyParams) => Promise\<\{ error: unknown; \}\> | Used to verify a code sent via email to sign-in | -| `emailLink` | \{ sendLink: (params: SignInFutureEmailLinkSendParams) => Promise\<\{ error: unknown; \}\>; verification: null \| \{ createdSessionId: string; status: "failed" \| "expired" \| "verified" \| "client_mismatch"; verifiedFromTheSameClient: boolean; \}; waitForVerification: () => Promise\<\{ error: unknown; \}\>; \} | - | -| `emailLink.sendLink` | (params: SignInFutureEmailLinkSendParams) => Promise\<\{ error: unknown; \}\> | Used to send an email link to sign-in | -| `emailLink.verification` | null \| \{ createdSessionId: string; status: "failed" \| "expired" \| "verified" \| "client_mismatch"; verifiedFromTheSameClient: boolean; \} | The verification status | -| `emailLink.waitForVerification` | () => Promise\<\{ error: unknown; \}\> | Will wait for verification to complete or expire | -| `finalize` | (params?: SignInFutureFinalizeParams) => Promise\<\{ error: unknown; \}\> | Used to convert a sign-in with `status === 'complete'` into an active session. Will cause anything observing the session state (such as the `useUser()` hook) to update automatically. | -| `firstFactorVerification` | `VerificationResource` | The state of the verification process for the selected first factor. Initially, this property contains an empty verification object, since there is no first factor selected. | -| `id?` | `string` | The unique identifier for the current sign-in attempt. | -| `identifier` | null \| string | The authentication identifier value for the current sign-in. `null` if the `strategy` is `'oauth_'` or `'enterprise_sso'`. | -| `isTransferable` | `boolean` | Indicates that there is not a matching user for the first-factor verification used, and that the sign-in can be transferred to a sign-up. | -| `mfa` | \{ sendPhoneCode: () => Promise\<\{ error: unknown; \}\>; verifyBackupCode: (params: SignInFutureBackupCodeVerifyParams) => Promise\<\{ error: unknown; \}\>; verifyPhoneCode: (params: SignInFutureMFAPhoneCodeVerifyParams) => Promise\<\{ error: unknown; \}\>; verifyTOTP: (params: SignInFutureTOTPVerifyParams) => Promise\<\{ error: unknown; \}\>; \} | - | -| `mfa.sendPhoneCode` | () => Promise\<\{ error: unknown; \}\> | Used to send a phone code as a second factor to sign-in | -| `mfa.verifyBackupCode` | (params: SignInFutureBackupCodeVerifyParams) => Promise\<\{ error: unknown; \}\> | Used to verify a backup code as a second factor to sign-in | -| `mfa.verifyPhoneCode` | (params: SignInFutureMFAPhoneCodeVerifyParams) => Promise\<\{ error: unknown; \}\> | Used to verify a phone code sent as a second factor to sign-in | -| `mfa.verifyTOTP` | (params: SignInFutureTOTPVerifyParams) => Promise\<\{ error: unknown; \}\> | Used to verify a TOTP code as a second factor to sign-in | -| `password` | (params: SignInFuturePasswordParams) => Promise\<\{ error: unknown; \}\> | Used to submit a password to sign-in. | -| `phoneCode` | \{ sendCode: (params: SignInFuturePhoneCodeSendParams) => Promise\<\{ error: unknown; \}\>; verifyCode: (params: SignInFuturePhoneCodeVerifyParams) => Promise\<\{ error: unknown; \}\>; \} | - | -| `phoneCode.sendCode` | (params: SignInFuturePhoneCodeSendParams) => Promise\<\{ error: unknown; \}\> | Used to send a phone code to sign-in | -| `phoneCode.verifyCode` | (params: SignInFuturePhoneCodeVerifyParams) => Promise\<\{ error: unknown; \}\> | Used to verify a code sent via phone to sign-in | -| `resetPasswordEmailCode` | \{ sendCode: () => Promise\<\{ error: unknown; \}\>; submitPassword: (params: SignInFutureResetPasswordSubmitParams) => Promise\<\{ error: unknown; \}\>; verifyCode: (params: SignInFutureEmailCodeVerifyParams) => Promise\<\{ error: unknown; \}\>; \} | - | -| `resetPasswordEmailCode.sendCode` | () => Promise\<\{ error: unknown; \}\> | Used to send a password reset code to the first email address on the account | -| `resetPasswordEmailCode.submitPassword` | (params: SignInFutureResetPasswordSubmitParams) => Promise\<\{ error: unknown; \}\> | Used to submit a new password, and move the `signIn.status` to `'complete'`. | -| `resetPasswordEmailCode.verifyCode` | (params: SignInFutureEmailCodeVerifyParams) => Promise\<\{ error: unknown; \}\> | Used to verify a password reset code sent via email. Will cause `signIn.status` to become `'needs_new_password'`. | -| `secondFactorVerification` | `VerificationResource` | The state of the verification process for the selected second factor. Initially, this property contains an empty verification object, since there is no second factor selected. | -| `sso` | (params: SignInFutureSSOParams) => Promise\<\{ error: unknown; \}\> | Used to perform OAuth authentication. | -| `status` | `SignInStatus` | The current status of the sign-in. | -| `supportedFirstFactors` | SignInFirstFactor[] | Array of the first factors that are supported in the current sign-in. Each factor contains information about the verification strategy that can be used. | -| `supportedSecondFactors` | SignInSecondFactor[] | 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. | -| `ticket` | (params?: SignInFutureTicketParams) => Promise\<\{ error: unknown; \}\> | Used to perform a ticket-based sign-in. | -| `userData` | `UserData` | An object containing information about the user of the current sign-in. This property is populated only once an identifier is given to the `SignIn` object through `signIn.create()` or another method that populates the `identifier` property. | -| `web3` | (params: SignInFutureWeb3Params) => Promise\<\{ error: unknown; \}\> | Used to perform a Web3-based sign-in. | diff --git a/clerk-typedoc/types/sign-in-resource.mdx b/clerk-typedoc/types/sign-in-resource.mdx deleted file mode 100644 index b640ec8717..0000000000 --- a/clerk-typedoc/types/sign-in-resource.mdx +++ /dev/null @@ -1,10 +0,0 @@ -The `SignIn` object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process. It is used to manage the sign-in lifecycle, including the first and second factor verification, and the creation of a new session. - -## Properties - -| Property | Type | Description | -| ------------------------------------------------------------ | --------------------------------- | ------------------------------------------------------------------------- | -| `id?` | `string` | The unique identifier of the resource. | -| `pathRoot` | `string` | The root path of the resource. | -| `status` | null \| SignInStatus | The current status of the sign-in. | -| ~~`supportedIdentifiers`~~ | SignInIdentifier[] | **Deprecated.** This attribute will be removed in the next major version. | diff --git a/clerk-typedoc/types/sign-in-signal-value.mdx b/clerk-typedoc/types/sign-in-signal-value.mdx deleted file mode 100644 index cf08779dd5..0000000000 --- a/clerk-typedoc/types/sign-in-signal-value.mdx +++ /dev/null @@ -1,9 +0,0 @@ -The value returned by the `useSignInSignal` hook. - -## Properties - -| Property | Type | Description | -| -------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `errors` | [`Errors`](errors.mdx) | Represents the errors that occurred during the last fetch of the parent resource. | -| `fetchStatus` | "idle" \| "fetching" | The fetch status of the underlying `SignIn` resource. | -| `signIn` | [`SignInFutureResource`](sign-in-future-resource.mdx) | An instance representing the currently active `SignIn`, with new APIs designed specifically for custom flows. | diff --git a/clerk-typedoc/types/sign-out.mdx b/clerk-typedoc/types/sign-out.mdx deleted file mode 100644 index 2ec222553c..0000000000 --- a/clerk-typedoc/types/sign-out.mdx +++ /dev/null @@ -1,24 +0,0 @@ -## Call Signature - -### Parameters - -| Parameter | Type | -| ---------- | ---------------- | -| `options?` | `SignOutOptions` | - -### Returns - -`Promise`\<`void`\> - -## Call Signature - -### Parameters - -| Parameter | Type | -| ------------------ | ----------------- | -| `signOutCallback?` | `SignOutCallback` | -| `options?` | `SignOutOptions` | - -### Returns - -`Promise`\<`void`\> diff --git a/clerk-typedoc/types/sign-up-authenticate-with-metamask-params.mdx b/clerk-typedoc/types/sign-up-authenticate-with-metamask-params.mdx deleted file mode 100644 index 2ad5ab70fe..0000000000 --- a/clerk-typedoc/types/sign-up-authenticate-with-metamask-params.mdx +++ /dev/null @@ -1,3 +0,0 @@ -## Deprecated - -Use `SignUpAuthenticateWithWeb3Params` instead. diff --git a/clerk-typedoc/types/sign-up-enterprise-connection-json.mdx b/clerk-typedoc/types/sign-up-enterprise-connection-json.mdx deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/clerk-typedoc/types/sign-up-enterprise-connection-resource.mdx b/clerk-typedoc/types/sign-up-enterprise-connection-resource.mdx deleted file mode 100644 index 3fb0093d3d..0000000000 --- a/clerk-typedoc/types/sign-up-enterprise-connection-resource.mdx +++ /dev/null @@ -1,6 +0,0 @@ -## Properties - -| Property | Type | Description | -| -------------------------------- | -------- | -------------------------------------- | -| `id` | `string` | The unique identifier of the resource. | -| `pathRoot` | `string` | The root path of the resource. | diff --git a/clerk-typedoc/types/sign-up-future-resource.mdx b/clerk-typedoc/types/sign-up-future-resource.mdx deleted file mode 100644 index 54adeb0f82..0000000000 --- a/clerk-typedoc/types/sign-up-future-resource.mdx +++ /dev/null @@ -1,39 +0,0 @@ -The `SignUpFuture` class holds the state of the current sign-up attempt and provides methods to drive custom sign-up -flows, including email/phone verification, password, SSO, ticket-based, and Web3-based account creation. - -## Properties - -| Property | Type | Description | -| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `abandonAt` | null \| number | The epoch numerical time when the sign-up was abandoned by the user. | -| `create` | (params: SignUpFutureCreateParams) => Promise\<\{ error: unknown; \}\> | Creates a new `SignUp` instance initialized with the provided parameters. The instance maintains the sign-up lifecycle state through its `status` property, which updates as the authentication flow progresses. Will also deactivate any existing sign-up process the client may already have in progress. What you must pass to `params` depends on which [sign-up options](/docs/guides/configure/auth-strategies/sign-up-sign-in-options) you have enabled in your app's settings in the Clerk Dashboard. You can complete the sign-up process in one step if you supply the required fields to `create()`. Otherwise, Clerk's sign-up process provides great flexibility and allows users to easily create multi-step sign-up flows. > [!WARNING] > Once the sign-up process is complete, call the `signUp.finalize()` method to set the newly created session as > the active session. | -| `createdSessionId` | null \| string | The identifier of the newly-created session. This attribute is populated only when the sign-up is complete. | -| `createdUserId` | null \| string | The identifier of the newly-created user. This attribute is populated only when the sign-up is complete. | -| `emailAddress` | null \| string | The `emailAddress` supplied to the current sign-up. Only supported if [email address](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#email) is enabled in the instance settings. | -| `finalize` | (params?: SignUpFutureFinalizeParams) => Promise\<\{ error: unknown; \}\> | Used to convert a sign-up with `status === 'complete'` into an active session. Will cause anything observing the session state (such as the `useUser()` hook) to update automatically. | -| `firstName` | null \| string | The `firstName` supplied to the current sign-up. Only supported if [First and last name](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#user-model) is enabled in the instance settings. | -| `hasPassword` | `boolean` | The value of this attribute is true if a password was supplied to the current sign-up. Only supported if [password](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#password) is enabled in the instance settings. | -| `id?` | `string` | The unique identifier of the current sign-up. | -| `isTransferable` | `boolean` | Indicates that there is a matching user for provided identifier, and that the sign-up can be transferred to a sign-in. | -| `lastName` | null \| string | The `lastName` supplied to the current sign-up. Only supported if [First and last name](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#user-model) is enabled in the instance settings. | -| `legalAcceptedAt` | null \| number | The epoch numerical time when the user agreed to the [legal compliance](/docs/guides/secure/legal-compliance) documents. | -| `locale` | null \| string | The locale of the user in BCP 47 format. | -| `missingFields` | SignUpField[] | An array of all the fields whose values are not supplied yet but they are mandatory in order for a sign-up to be marked as complete. | -| `optionalFields` | SignUpField[] | An array of all the fields that can be supplied to the sign-up, but their absence does not prevent the sign-up from being marked as complete. | -| `password` | (params: SignUpFuturePasswordParams) => Promise\<\{ error: unknown; \}\> | Used to sign up using an email address and password. | -| `phoneNumber` | null \| string | The `phoneNumber` supplied to the current sign-up in E.164 format. Only supported if [phone number](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#phone) is enabled in the instance settings. | -| `requiredFields` | SignUpField[] | An array of all the required fields that need to be supplied and verified in order for this sign-up to be marked as complete and converted into a user. | -| `sso` | (params: SignUpFutureSSOParams) => Promise\<\{ error: unknown; \}\> | Used to create an account using an OAuth connection. | -| `status` | `SignUpStatus` | The status of the current sign-up. | -| `ticket` | (params?: SignUpFutureTicketParams) => Promise\<\{ error: unknown; \}\> | Used to perform a ticket-based sign-up. | -| `unsafeMetadata` | `SignUpUnsafeMetadata` | Metadata that can be read and set from the frontend. Once the sign-up is complete, the value of this field will be automatically copied to the newly created user's unsafe metadata. One common use case for this attribute is to use it to implement custom fields that can be collected during sign-up and will automatically be attached to the created User object. | -| `unverifiedFields` | SignUpIdentificationField[] | An array of all the fields whose values have been supplied, but they need additional verification in order for them to be accepted. Examples of such fields are `email_address` and `phone_number`. | -| `update` | (params: SignUpFutureUpdateParams) => Promise\<\{ error: unknown; \}\> | Updates the current `SignUp`. | -| `username` | null \| string | The `username` supplied to the current sign-up. Only supported if [username](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#username) is enabled in the instance settings. | -| `verifications` | \{ sendEmailCode: () => Promise\<\{ error: unknown; \}\>; sendPhoneCode: (params: SignUpFuturePhoneCodeSendParams) => Promise\<\{ error: unknown; \}\>; verifyEmailCode: (params: SignUpFutureEmailCodeVerifyParams) => Promise\<\{ error: unknown; \}\>; verifyPhoneCode: (params: SignUpFuturePhoneCodeVerifyParams) => Promise\<\{ error: unknown; \}\>; \} | - | -| `verifications.sendEmailCode` | () => Promise\<\{ error: unknown; \}\> | Used to send an email code to verify an email address. | -| `verifications.sendPhoneCode` | (params: SignUpFuturePhoneCodeSendParams) => Promise\<\{ error: unknown; \}\> | Used to send a phone code to verify a phone number. | -| `verifications.verifyEmailCode` | (params: SignUpFutureEmailCodeVerifyParams) => Promise\<\{ error: unknown; \}\> | Used to verify a code sent via email. | -| `verifications.verifyPhoneCode` | (params: SignUpFuturePhoneCodeVerifyParams) => Promise\<\{ error: unknown; \}\> | Used to verify a code sent via phone. | -| `web3` | (params: SignUpFutureWeb3Params) => Promise\<\{ error: unknown; \}\> | Used to perform a Web3-based sign-up. | -| `web3Wallet` | null \| string | The Web3 wallet address supplied to the current sign-up, made up of 0x + 40 hexadecimal characters. Only supported if [Web3 authentication](/docs/guides/configure/auth-strategies/sign-up-sign-in-options#web3-authentication) is enabled in the instance settings. | diff --git a/clerk-typedoc/types/sign-up-resource.mdx b/clerk-typedoc/types/sign-up-resource.mdx deleted file mode 100644 index f792e0b2a0..0000000000 --- a/clerk-typedoc/types/sign-up-resource.mdx +++ /dev/null @@ -1,10 +0,0 @@ -The `SignUp` object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up process. Once a sign-up is complete, a new user is created. - -## Properties - -| Property | Type | Description | -| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -| `__experimental_getEnterpriseConnections` | () => Promise\<[SignUpEnterpriseConnectionResource](sign-up-enterprise-connection-resource.mdx)[]\> | - | -| `id?` | `string` | The unique identifier of the resource. | -| `pathRoot` | `string` | The root path of the resource. | -| `status` | null \| SignUpStatus | The current status of the sign-up. | diff --git a/clerk-typedoc/types/signed-in-session-resource.mdx b/clerk-typedoc/types/signed-in-session-resource.mdx deleted file mode 100644 index a682dc8b4d..0000000000 --- a/clerk-typedoc/types/signed-in-session-resource.mdx +++ /dev/null @@ -1,2 +0,0 @@ -Represents session resources for users who have completed -the full sign-in flow diff --git a/clerk-typedoc/types/state-selectors.mdx b/clerk-typedoc/types/state-selectors.mdx deleted file mode 100644 index cecc110aac..0000000000 --- a/clerk-typedoc/types/state-selectors.mdx +++ /dev/null @@ -1 +0,0 @@ -Create a type union of all state + id combinations diff --git a/clerk-typedoc/types/telemetry-log-entry.mdx b/clerk-typedoc/types/telemetry-log-entry.mdx deleted file mode 100644 index 4b91f4af44..0000000000 --- a/clerk-typedoc/types/telemetry-log-entry.mdx +++ /dev/null @@ -1 +0,0 @@ -Debug log entry interface for telemetry collector diff --git a/clerk-typedoc/types/use-auth-return.mdx b/clerk-typedoc/types/use-auth-return.mdx deleted file mode 100644 index 6dde7d99cd..0000000000 --- a/clerk-typedoc/types/use-auth-return.mdx +++ /dev/null @@ -1,59 +0,0 @@ -| Name | Type | Description | -| --------------- | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `actor` | `undefined` | The JWT actor for the session. Holds identifier for the user that is impersonating the current user. Read more about [impersonation](/docs/guides/users/impersonation). | -| `getToken` | [`GetToken`](get-token.mdx) | A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](/docs/reference/javascript/session#get-token). | -| `has` | \{ \} | A function that checks if the user has specific permissions or roles. See the [reference doc](/docs/reference/backend/types/auth-object#has). | -| `isLoaded` | `false` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | -| `isSignedIn` | `undefined` | A boolean that indicates whether a user is currently signed in. | -| `orgId` | `undefined` | The ID of the user's active organization. | -| `orgRole` | `undefined` | The current user's role in their active organization. | -| `orgSlug` | `undefined` | The URL-friendly identifier of the user's active organization. | -| `sessionClaims` | `undefined` | The current user's [session claims](/docs/guides/sessions/session-tokens). | -| `sessionId` | `undefined` | The ID for the current session. | -| `signOut` | [`SignOut`](sign-out.mdx) | A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](/docs/reference/javascript/clerk#sign-out). | -| `userId` | `undefined` | The ID of the current user. | - -| Name | Type | -| --------------- | ----------------------------------------------------------------------------- | -| `actor` | `null` | -| `getToken` | [`GetToken`](get-token.mdx) | -| `has()` | (params: CheckAuthorizationParamsWithCustomPermissions) => false | -| `isLoaded` | `true` | -| `isSignedIn` | `false` | -| `orgId` | `null` | -| `orgRole` | `null` | -| `orgSlug` | `null` | -| `sessionClaims` | `null` | -| `sessionId` | `null` | -| `signOut` | [`SignOut`](sign-out.mdx) | -| `userId` | `null` | - -| Name | Type | -| --------------- | -------------------------------------------------------------------------------------------- | -| `actor` | [ActClaim](act-claim.mdx) \| null | -| `getToken` | [`GetToken`](get-token.mdx) | -| `has` | [`CheckAuthorizationWithCustomPermissions`](check-authorization-with-custom-permissions.mdx) | -| `isLoaded` | `true` | -| `isSignedIn` | `true` | -| `orgId` | `null` | -| `orgRole` | `null` | -| `orgSlug` | `null` | -| `sessionClaims` | `JwtPayload` | -| `sessionId` | `string` | -| `signOut` | [`SignOut`](sign-out.mdx) | -| `userId` | `string` | - -| Name | Type | -| --------------- | -------------------------------------------------------------------------------------------- | -| `actor` | [ActClaim](act-claim.mdx) \| null | -| `getToken` | [`GetToken`](get-token.mdx) | -| `has` | [`CheckAuthorizationWithCustomPermissions`](check-authorization-with-custom-permissions.mdx) | -| `isLoaded` | `true` | -| `isSignedIn` | `true` | -| `orgId` | `string` | -| `orgRole` | [`OrganizationCustomRoleKey`](organization-custom-role-key.mdx) | -| `orgSlug` | string \| null | -| `sessionClaims` | `JwtPayload` | -| `sessionId` | `string` | -| `signOut` | [`SignOut`](sign-out.mdx) | -| `userId` | `string` | diff --git a/clerk-typedoc/types/use-session-list-return.mdx b/clerk-typedoc/types/use-session-list-return.mdx deleted file mode 100644 index 2f319ab413..0000000000 --- a/clerk-typedoc/types/use-session-list-return.mdx +++ /dev/null @@ -1,11 +0,0 @@ -| Name | Type | Description | -| ----------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `isLoaded` | `false` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | -| `sessions` | `undefined` | A list of sessions that have been registered on the client device. | -| `setActive` | `undefined` | A function that sets the active session and/or organization. See the [reference doc](/docs/reference/javascript/clerk#set-active). | - -| Name | Type | -| ----------- | -------------------------------------------------------------------- | -| `isLoaded` | `true` | -| `sessions` | [SessionResource](/docs/reference/javascript/session)[] | -| `setActive` | [`SetActive`](set-active.mdx) | diff --git a/clerk-typedoc/types/use-session-return.mdx b/clerk-typedoc/types/use-session-return.mdx deleted file mode 100644 index 9b817b9ab6..0000000000 --- a/clerk-typedoc/types/use-session-return.mdx +++ /dev/null @@ -1,17 +0,0 @@ -| Name | Type | Description | -| ------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------ | -| `isLoaded` | `false` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | -| `isSignedIn` | `undefined` | A boolean that indicates whether a user is currently signed in. | -| `session` | `undefined` | The current session for the user. | - -| Name | Type | -| ------------ | ------- | -| `isLoaded` | `true` | -| `isSignedIn` | `false` | -| `session` | `null` | - -| Name | Type | -| ------------ | --------------------------------------------------------------- | -| `isLoaded` | `true` | -| `isSignedIn` | `boolean` | -| `session` | [`SignedInSessionResource`](/docs/reference/javascript/session) | diff --git a/clerk-typedoc/types/use-sign-in-return.mdx b/clerk-typedoc/types/use-sign-in-return.mdx deleted file mode 100644 index 5d5bec237c..0000000000 --- a/clerk-typedoc/types/use-sign-in-return.mdx +++ /dev/null @@ -1,11 +0,0 @@ -| Name | Type | Description | -| ----------- | ----------- | ------------------------------------------------------------------------------------------------------------------------ | -| `isLoaded` | `false` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | -| `setActive` | `undefined` | A function that sets the active session. See the [reference doc](/docs/reference/javascript/clerk#set-active). | -| `signIn` | `undefined` | An object that contains the current sign-in attempt status and methods to create a new sign-in attempt. | - -| Name | Type | -| ----------- | ------------------------------------------------------ | -| `isLoaded` | `true` | -| `setActive` | [`SetActive`](set-active.mdx) | -| `signIn` | [`SignInResource`](/docs/reference/javascript/sign-in) | diff --git a/clerk-typedoc/types/use-sign-up-return.mdx b/clerk-typedoc/types/use-sign-up-return.mdx deleted file mode 100644 index 548ee6ab45..0000000000 --- a/clerk-typedoc/types/use-sign-up-return.mdx +++ /dev/null @@ -1,11 +0,0 @@ -| Name | Type | Description | -| ----------- | ----------- | ------------------------------------------------------------------------------------------------------------------------ | -| `isLoaded` | `false` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | -| `setActive` | `undefined` | A function that sets the active session. See the [reference doc](/docs/reference/javascript/clerk#set-active). | -| `signUp` | `undefined` | An object that contains the current sign-up attempt status and methods to create a new sign-up attempt. | - -| Name | Type | -| ----------- | ------------------------------------------------------ | -| `isLoaded` | `true` | -| `setActive` | [`SetActive`](set-active.mdx) | -| `signUp` | [`SignUpResource`](/docs/reference/javascript/sign-up) | diff --git a/clerk-typedoc/types/use-user-return.mdx b/clerk-typedoc/types/use-user-return.mdx deleted file mode 100644 index 401f45c521..0000000000 --- a/clerk-typedoc/types/use-user-return.mdx +++ /dev/null @@ -1,17 +0,0 @@ -| Name | Type | Description | -| ------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------ | -| `isLoaded` | `false` | A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads. | -| `isSignedIn` | `undefined` | A boolean that returns `true` if the user is signed in. | -| `user` | `undefined` | The `User` object for the current user. | - -| Name | Type | -| ------------ | ------- | -| `isLoaded` | `true` | -| `isSignedIn` | `false` | -| `user` | `null` | - -| Name | Type | -| ------------ | ------------------------------------------------- | -| `isLoaded` | `true` | -| `isSignedIn` | `true` | -| `user` | [`UserResource`](/docs/reference/javascript/user) | diff --git a/clerk-typedoc/types/user-organization-invitation-resource.mdx b/clerk-typedoc/types/user-organization-invitation-resource.mdx deleted file mode 100644 index e948d20de9..0000000000 --- a/clerk-typedoc/types/user-organization-invitation-resource.mdx +++ /dev/null @@ -1,8 +0,0 @@ -The `OrganizationInvitation` object is the model around an organization invitation. - -## Properties - -| Property | Type | Description | -| -------------------------------- | -------- | -------------------------------------- | -| `id` | `string` | The unique identifier of the resource. | -| `pathRoot` | `string` | The root path of the resource. | diff --git a/clerk-typedoc/types/user-resource.mdx b/clerk-typedoc/types/user-resource.mdx deleted file mode 100644 index 10fe99e936..0000000000 --- a/clerk-typedoc/types/user-resource.mdx +++ /dev/null @@ -1,18 +0,0 @@ -The `User` object holds all of the information for a single user of your application and provides a set of methods to manage their account. - -A user can be contacted at their primary email address or primary phone number. They can have more than one registered email address, but only one of them will be their primary email address. This goes for phone numbers as well; a user can have more than one, but only one phone number will be their primary. At the same time, a user can also have one or more external accounts by connecting to [social providers](/docs/guides/configure/auth-strategies/social-connections/all-providers) such as Google, Apple, Facebook, and many more. - -Finally, a `User` object holds profile data like the user's name, profile picture, and a set of [metadata](/docs/guides/users/extending) that can be used internally to store arbitrary information. The metadata are split into `publicMetadata` and `privateMetadata`. Both types are set from the [Backend API](/docs/reference/backend-api){{ target: '_blank' }}, but public metadata can also be accessed from the [Frontend API](/docs/reference/frontend-api){{ target: '_blank' }}. - -The ClerkJS SDK provides some helper [methods](#methods) on the `User` object to help retrieve and update user information and authentication status. - -## Properties - -| Property | Type | Description | -| -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -| `addPaymentMethod` | (params: [AddPaymentMethodParams](add-payment-method-params.mdx)) => Promise\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\> | - | -| `getPaymentMethods` | (params: [GetPaymentMethodsParams](get-payment-methods-params.mdx)) => Promise\<[ClerkPaginatedResponse](/docs/reference/javascript/types/clerk-paginated-response)\<[BillingPaymentMethodResource](/docs/reference/javascript/types/billing-payment-method-resource)\>\> | - | -| `id` | `string` | The unique identifier of the resource. | -| `initializePaymentMethod` | (params: [InitializePaymentMethodParams](initialize-payment-method-params.mdx)) => Promise\<[BillingInitializedPaymentMethodResource](billing-initialized-payment-method-resource.mdx)\> | - | -| `pathRoot` | `string` | The root path of the resource. | -| ~~`samlAccounts`~~ | SamlAccountResource[] | **Deprecated.** Use `enterpriseAccounts` instead. | diff --git a/clerk-typedoc/types/without.mdx b/clerk-typedoc/types/without.mdx deleted file mode 100644 index a4185e8e64..0000000000 --- a/clerk-typedoc/types/without.mdx +++ /dev/null @@ -1 +0,0 @@ -Omit without union flattening