From c163ca8cbb368dac59e0dabffcc99c877c0f7f2d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 5 Nov 2025 15:21:25 +0000 Subject: [PATCH] docs: update TypeDoc documentation from clerk/javascript@f97679a --- clerk-typedoc/backend/auth-object.mdx | 12 +-- clerk-typedoc/backend/billing-plan.mdx | 32 ++++---- .../backend/billing-subscription-item.mdx | 38 ++++----- .../backend/billing-subscription.mdx | 24 +++--- .../backend/get-auth-fn-no-request.mdx | 2 +- .../backend/verify-machine-auth-token.mdx | 17 +++- clerk-typedoc/backend/verify-token.mdx | 29 +++++-- clerk-typedoc/backend/verify-webhook.mdx | 5 +- clerk-typedoc/clerk-react/api-keys.mdx | 6 +- clerk-typedoc/clerk-react/checkout-button.mdx | 6 +- .../clerk-react/clerk-provider-props.mdx | 82 +++++++++---------- .../clerk-react/plan-details-button-props.mdx | 2 +- .../clerk-react/plan-details-button.mdx | 6 +- .../redirect-to-create-organization.mdx | 6 +- .../redirect-to-organization-profile.mdx | 6 +- .../clerk-react/redirect-to-user-profile.mdx | 6 +- .../subscription-details-button-props.mdx | 8 +- .../subscription-details-button.mdx | 6 +- .../clerk-react/use-organization-list.mdx | 8 +- .../clerk-react/use-organization.mdx | 8 +- .../clerk-react/use-session-list.mdx | 4 +- clerk-typedoc/clerk-react/use-session.mdx | 2 +- .../clerk-react/use-sign-in-signal.mdx | 2 +- clerk-typedoc/clerk-react/use-sign-in.mdx | 4 +- clerk-typedoc/clerk-react/use-sign-up.mdx | 4 +- clerk-typedoc/clerk-react/use-user.mdx | 2 +- .../act-claim.mdx => shared/act-claim-1.mdx} | 0 clerk-typedoc/shared/act-claim.mdx | 1 + .../{types => shared}/act-jwt-claim.mdx | 0 .../active-session-resource.mdx | 0 .../shared/add-payment-method-params.mdx | 8 ++ .../billing-checkout-json.mdx | 0 .../billing-checkout-resource.mdx | 3 +- .../billing-checkout-totals-json.mdx | 0 .../billing-checkout-totals.mdx | 0 ...illing-initialized-payment-method-json.mdx | 0 ...ng-initialized-payment-method-resource.mdx | 0 .../billing-money-amount-json.mdx | 0 .../billing-money-amount.mdx | 0 .../{types => shared}/billing-namespace.mdx | 0 .../{types => shared}/billing-payer-json.mdx | 0 .../billing-payer-methods.mdx | 10 +-- .../billing-payer-resource-type.mdx | 0 .../billing-payer-resource.mdx | 0 .../billing-payment-charge-type.mdx | 0 .../billing-payment-json.mdx | 0 .../billing-payment-method-json.mdx | 0 .../billing-payment-method-resource.mdx | 4 +- .../billing-payment-method-status.mdx | 0 .../billing-payment-resource.mdx | 2 +- .../billing-payment-status.mdx | 0 .../{types => shared}/billing-plan-json.mdx | 0 .../billing-plan-resource.mdx | 2 +- .../billing-statement-group-json.mdx | 0 .../billing-statement-group.mdx | 0 .../billing-statement-json.mdx | 0 .../billing-statement-resource.mdx | 2 +- .../billing-statement-status.mdx | 0 .../billing-statement-totals-json.mdx | 0 .../billing-statement-totals.mdx | 0 .../billing-subscription-item-json.mdx | 0 .../billing-subscription-item-resource.mdx | 0 .../billing-subscription-json.mdx | 0 .../billing-subscription-plan-period.mdx | 0 .../billing-subscription-resource.mdx | 0 .../billing-subscription-status.mdx | 0 .../cancel-subscription-params.mdx | 0 .../check-authorization-fn.mdx | 0 ...heck-authorization-from-session-claims.mdx | 0 ...thorization-params-from-session-claims.mdx | 0 ...-authorization-with-custom-permissions.mdx | 0 .../clerk-api-error-1.mdx} | 0 clerk-typedoc/shared/clerk-api-error.mdx | 2 +- .../clerk-api-response-error.mdx | 0 .../{types => shared}/clerk-host-router.mdx | 0 .../{types => shared}/clerk-jwt-claims.mdx | 0 .../clerk-paginated-response.mdx | 0 .../clerk-pagination-params.mdx | 0 .../clerk-pagination-request.mdx | 0 .../{types => shared}/clerk-resource.mdx | 0 .../{types => shared}/clerk-status.mdx | 0 clerk-typedoc/{types => shared}/clerk.mdx | 2 +- .../confirm-checkout-params.mdx | 4 +- .../create-checkout-params.mdx | 0 .../create-organization-params.mdx | 0 .../deleted-object-resource.mdx | 0 .../{types => shared}/element-object-key.mdx | 0 .../{types => shared}/elements-config.mdx | 0 clerk-typedoc/{types => shared}/errors.mdx | 0 .../experimental_checkout-button-props.mdx | 0 ...experimental_plan-details-button-props.mdx | 0 ...ntal_subscription-details-button-props.mdx | 0 .../{types => shared}/feature-json.mdx | 0 .../{types => shared}/feature-resource.mdx | 0 .../{types => shared}/field-error.mdx | 0 .../{types => shared}/field-errors.mdx | 0 .../{types => shared}/for-payer-type.mdx | 0 .../get-payment-attempts-params.mdx | 0 .../get-payment-methods-params.mdx | 0 .../{types => shared}/get-plans-params.mdx | 0 .../get-statements-params.mdx | 0 .../get-subscription-params.mdx | 0 clerk-typedoc/{types => shared}/get-token.mdx | 0 .../{types => shared}/id-selectors.mdx | 0 .../initialize-payment-method-params.mdx | 7 ++ .../internal_checkout-props.mdx | 0 .../internal_plan-details-props.mdx | 0 .../internal_subscription-details-props.mdx | 0 .../{types => shared}/jwt-claims.mdx | 0 .../{types => shared}/jwt-header.mdx | 0 .../legacy-redirect-props.mdx | 0 .../localization-resource.mdx | 0 .../make-default-payment-method-params.mdx | 0 .../multi-domain-and-or-proxy.mdx | 0 .../organization-custom-role-key.mdx | 0 .../organization-domain-resource.mdx | 0 ...rganization-domain-verification-status.mdx | 0 .../organization-enrollment-mode.mdx | 0 .../organization-invitation-resource.mdx | 0 .../organization-invitation-status.mdx | 0 ...ganization-membership-request-resource.mdx | 0 .../organization-membership-resource.mdx | 0 .../organization-permission-key.mdx | 0 .../organization-resource.mdx | 14 ++-- .../organization-suggestion-resource.mdx | 0 .../organization-suggestion-status.mdx | 0 .../organizations-jwt-claim.mdx | 0 .../override.mdx => shared/override-1.mdx} | 0 clerk-typedoc/shared/override.mdx | 4 + .../path-value-1.mdx} | 0 clerk-typedoc/shared/path-value.mdx | 4 + .../{types => shared}/payment-gateway.mdx | 0 .../pending-session-options.mdx | 0 .../pending-session-resource.mdx | 0 .../{types => shared}/protect-props.mdx | 0 .../record-to-path-1.mdx} | 0 clerk-typedoc/shared/record-to-path.mdx | 4 + .../{types => shared}/redirect-options.mdx | 0 .../remove-payment-method-params.mdx | 0 .../reverification-config.mdx | 2 +- .../{types => shared}/saml-strategy.mdx | 0 .../{types => shared}/sdk-metadata.mdx | 0 .../server-get-token-options.mdx | 0 .../{types => shared}/server-get-token.mdx | 0 .../{types => shared}/session-resource.mdx | 0 .../session-status-claim.mdx | 0 .../{types => shared}/session-task.mdx | 0 .../session-verification-level.mdx | 0 .../session-verification-types.mdx | 0 .../{types => shared}/set-active-params.mdx | 0 .../{types => shared}/set-active.mdx | 0 .../sign-in-future-resource.mdx | 5 +- .../{types => shared}/sign-in-resource.mdx | 0 .../sign-in-signal-value.mdx | 0 clerk-typedoc/{types => shared}/sign-out.mdx | 0 ...n-up-authenticate-with-metamask-params.mdx | 0 .../sign-up-enterprise-connection-json.mdx | 0 ...sign-up-enterprise-connection-resource.mdx | 0 .../sign-up-future-resource.mdx | 0 .../{types => shared}/sign-up-resource.mdx | 0 .../signed-in-session-resource.mdx | 0 clerk-typedoc/shared/simplify.mdx | 2 + .../{types => shared}/state-selectors.mdx | 0 .../{types => shared}/telemetry-log-entry.mdx | 0 .../{types => shared}/use-auth-return.mdx | 4 +- .../shared/use-organization-list-params.mdx | 2 +- .../shared/use-organization-params.mdx | 4 +- .../use-session-list-return.mdx | 0 .../{types => shared}/use-session-return.mdx | 0 .../{types => shared}/use-sign-in-return.mdx | 0 .../{types => shared}/use-sign-up-return.mdx | 0 .../{types => shared}/use-user-return.mdx | 0 .../user-organization-invitation-resource.mdx | 0 .../{types => shared}/user-resource.mdx | 16 ++-- .../without.mdx => shared/without-1.mdx} | 0 clerk-typedoc/shared/without.mdx | 1 + .../types/add-payment-method-params.mdx | 0 .../initialize-payment-method-params.mdx | 0 178 files changed, 250 insertions(+), 186 deletions(-) rename clerk-typedoc/{types/act-claim.mdx => shared/act-claim-1.mdx} (100%) create mode 100644 clerk-typedoc/shared/act-claim.mdx rename clerk-typedoc/{types => shared}/act-jwt-claim.mdx (100%) rename clerk-typedoc/{types => shared}/active-session-resource.mdx (100%) create mode 100644 clerk-typedoc/shared/add-payment-method-params.mdx rename clerk-typedoc/{types => shared}/billing-checkout-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-checkout-resource.mdx (93%) rename clerk-typedoc/{types => shared}/billing-checkout-totals-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-checkout-totals.mdx (100%) rename clerk-typedoc/{types => shared}/billing-initialized-payment-method-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-initialized-payment-method-resource.mdx (100%) rename clerk-typedoc/{types => shared}/billing-money-amount-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-money-amount.mdx (100%) rename clerk-typedoc/{types => shared}/billing-namespace.mdx (100%) rename clerk-typedoc/{types => shared}/billing-payer-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-payer-methods.mdx (77%) rename clerk-typedoc/{types => shared}/billing-payer-resource-type.mdx (100%) rename clerk-typedoc/{types => shared}/billing-payer-resource.mdx (100%) rename clerk-typedoc/{types => shared}/billing-payment-charge-type.mdx (100%) rename clerk-typedoc/{types => shared}/billing-payment-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-payment-method-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-payment-method-resource.mdx (96%) rename clerk-typedoc/{types => shared}/billing-payment-method-status.mdx (100%) rename clerk-typedoc/{types => shared}/billing-payment-resource.mdx (96%) rename clerk-typedoc/{types => shared}/billing-payment-status.mdx (100%) rename clerk-typedoc/{types => shared}/billing-plan-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-plan-resource.mdx (97%) rename clerk-typedoc/{types => shared}/billing-statement-group-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-statement-group.mdx (100%) rename clerk-typedoc/{types => shared}/billing-statement-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-statement-resource.mdx (97%) rename clerk-typedoc/{types => shared}/billing-statement-status.mdx (100%) rename clerk-typedoc/{types => shared}/billing-statement-totals-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-statement-totals.mdx (100%) rename clerk-typedoc/{types => shared}/billing-subscription-item-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-subscription-item-resource.mdx (100%) rename clerk-typedoc/{types => shared}/billing-subscription-json.mdx (100%) rename clerk-typedoc/{types => shared}/billing-subscription-plan-period.mdx (100%) rename clerk-typedoc/{types => shared}/billing-subscription-resource.mdx (100%) rename clerk-typedoc/{types => shared}/billing-subscription-status.mdx (100%) rename clerk-typedoc/{types => shared}/cancel-subscription-params.mdx (100%) rename clerk-typedoc/{types => shared}/check-authorization-fn.mdx (100%) rename clerk-typedoc/{types => shared}/check-authorization-from-session-claims.mdx (100%) rename clerk-typedoc/{types => shared}/check-authorization-params-from-session-claims.mdx (100%) rename clerk-typedoc/{types => shared}/check-authorization-with-custom-permissions.mdx (100%) rename clerk-typedoc/{types/clerk-api-error.mdx => shared/clerk-api-error-1.mdx} (100%) rename clerk-typedoc/{types => shared}/clerk-api-response-error.mdx (100%) rename clerk-typedoc/{types => shared}/clerk-host-router.mdx (100%) rename clerk-typedoc/{types => shared}/clerk-jwt-claims.mdx (100%) rename clerk-typedoc/{types => shared}/clerk-paginated-response.mdx (100%) rename clerk-typedoc/{types => shared}/clerk-pagination-params.mdx (100%) rename clerk-typedoc/{types => shared}/clerk-pagination-request.mdx (100%) rename clerk-typedoc/{types => shared}/clerk-resource.mdx (100%) rename clerk-typedoc/{types => shared}/clerk-status.mdx (100%) rename clerk-typedoc/{types => shared}/clerk.mdx (99%) rename clerk-typedoc/{types => shared}/confirm-checkout-params.mdx (75%) rename clerk-typedoc/{types => shared}/create-checkout-params.mdx (100%) rename clerk-typedoc/{types => shared}/create-organization-params.mdx (100%) rename clerk-typedoc/{types => shared}/deleted-object-resource.mdx (100%) rename clerk-typedoc/{types => shared}/element-object-key.mdx (100%) rename clerk-typedoc/{types => shared}/elements-config.mdx (100%) rename clerk-typedoc/{types => shared}/errors.mdx (100%) rename clerk-typedoc/{types => shared}/experimental_checkout-button-props.mdx (100%) rename clerk-typedoc/{types => shared}/experimental_plan-details-button-props.mdx (100%) rename clerk-typedoc/{types => shared}/experimental_subscription-details-button-props.mdx (100%) rename clerk-typedoc/{types => shared}/feature-json.mdx (100%) rename clerk-typedoc/{types => shared}/feature-resource.mdx (100%) rename clerk-typedoc/{types => shared}/field-error.mdx (100%) rename clerk-typedoc/{types => shared}/field-errors.mdx (100%) rename clerk-typedoc/{types => shared}/for-payer-type.mdx (100%) rename clerk-typedoc/{types => shared}/get-payment-attempts-params.mdx (100%) rename clerk-typedoc/{types => shared}/get-payment-methods-params.mdx (100%) rename clerk-typedoc/{types => shared}/get-plans-params.mdx (100%) rename clerk-typedoc/{types => shared}/get-statements-params.mdx (100%) rename clerk-typedoc/{types => shared}/get-subscription-params.mdx (100%) rename clerk-typedoc/{types => shared}/get-token.mdx (100%) rename clerk-typedoc/{types => shared}/id-selectors.mdx (100%) create mode 100644 clerk-typedoc/shared/initialize-payment-method-params.mdx rename clerk-typedoc/{types => shared}/internal_checkout-props.mdx (100%) rename clerk-typedoc/{types => shared}/internal_plan-details-props.mdx (100%) rename clerk-typedoc/{types => shared}/internal_subscription-details-props.mdx (100%) rename clerk-typedoc/{types => shared}/jwt-claims.mdx (100%) rename clerk-typedoc/{types => shared}/jwt-header.mdx (100%) rename clerk-typedoc/{types => shared}/legacy-redirect-props.mdx (100%) rename clerk-typedoc/{types => shared}/localization-resource.mdx (100%) rename clerk-typedoc/{types => shared}/make-default-payment-method-params.mdx (100%) rename clerk-typedoc/{types => shared}/multi-domain-and-or-proxy.mdx (100%) rename clerk-typedoc/{types => shared}/organization-custom-role-key.mdx (100%) rename clerk-typedoc/{types => shared}/organization-domain-resource.mdx (100%) rename clerk-typedoc/{types => shared}/organization-domain-verification-status.mdx (100%) rename clerk-typedoc/{types => shared}/organization-enrollment-mode.mdx (100%) rename clerk-typedoc/{types => shared}/organization-invitation-resource.mdx (100%) rename clerk-typedoc/{types => shared}/organization-invitation-status.mdx (100%) rename clerk-typedoc/{types => shared}/organization-membership-request-resource.mdx (100%) rename clerk-typedoc/{types => shared}/organization-membership-resource.mdx (100%) rename clerk-typedoc/{types => shared}/organization-permission-key.mdx (100%) rename clerk-typedoc/{types => shared}/organization-resource.mdx (75%) rename clerk-typedoc/{types => shared}/organization-suggestion-resource.mdx (100%) rename clerk-typedoc/{types => shared}/organization-suggestion-status.mdx (100%) rename clerk-typedoc/{types => shared}/organizations-jwt-claim.mdx (100%) rename clerk-typedoc/{types/override.mdx => shared/override-1.mdx} (100%) create mode 100644 clerk-typedoc/shared/override.mdx rename clerk-typedoc/{types/path-value.mdx => shared/path-value-1.mdx} (100%) create mode 100644 clerk-typedoc/shared/path-value.mdx rename clerk-typedoc/{types => shared}/payment-gateway.mdx (100%) rename clerk-typedoc/{types => shared}/pending-session-options.mdx (100%) rename clerk-typedoc/{types => shared}/pending-session-resource.mdx (100%) rename clerk-typedoc/{types => shared}/protect-props.mdx (100%) rename clerk-typedoc/{types/record-to-path.mdx => shared/record-to-path-1.mdx} (100%) create mode 100644 clerk-typedoc/shared/record-to-path.mdx rename clerk-typedoc/{types => shared}/redirect-options.mdx (100%) rename clerk-typedoc/{types => shared}/remove-payment-method-params.mdx (100%) rename clerk-typedoc/{types => shared}/reverification-config.mdx (93%) rename clerk-typedoc/{types => shared}/saml-strategy.mdx (100%) rename clerk-typedoc/{types => shared}/sdk-metadata.mdx (100%) rename clerk-typedoc/{types => shared}/server-get-token-options.mdx (100%) rename clerk-typedoc/{types => shared}/server-get-token.mdx (100%) rename clerk-typedoc/{types => shared}/session-resource.mdx (100%) rename clerk-typedoc/{types => shared}/session-status-claim.mdx (100%) rename clerk-typedoc/{types => shared}/session-task.mdx (100%) rename clerk-typedoc/{types => shared}/session-verification-level.mdx (100%) rename clerk-typedoc/{types => shared}/session-verification-types.mdx (100%) rename clerk-typedoc/{types => shared}/set-active-params.mdx (100%) rename clerk-typedoc/{types => shared}/set-active.mdx (100%) rename clerk-typedoc/{types => shared}/sign-in-future-resource.mdx (96%) rename clerk-typedoc/{types => shared}/sign-in-resource.mdx (100%) rename clerk-typedoc/{types => shared}/sign-in-signal-value.mdx (100%) rename clerk-typedoc/{types => shared}/sign-out.mdx (100%) rename clerk-typedoc/{types => shared}/sign-up-authenticate-with-metamask-params.mdx (100%) rename clerk-typedoc/{types => shared}/sign-up-enterprise-connection-json.mdx (100%) rename clerk-typedoc/{types => shared}/sign-up-enterprise-connection-resource.mdx (100%) rename clerk-typedoc/{types => shared}/sign-up-future-resource.mdx (100%) rename clerk-typedoc/{types => shared}/sign-up-resource.mdx (100%) rename clerk-typedoc/{types => shared}/signed-in-session-resource.mdx (100%) create mode 100644 clerk-typedoc/shared/simplify.mdx rename clerk-typedoc/{types => shared}/state-selectors.mdx (100%) rename clerk-typedoc/{types => shared}/telemetry-log-entry.mdx (100%) rename clerk-typedoc/{types => shared}/use-auth-return.mdx (97%) rename clerk-typedoc/{types => shared}/use-session-list-return.mdx (100%) rename clerk-typedoc/{types => shared}/use-session-return.mdx (100%) rename clerk-typedoc/{types => shared}/use-sign-in-return.mdx (100%) rename clerk-typedoc/{types => shared}/use-sign-up-return.mdx (100%) rename clerk-typedoc/{types => shared}/use-user-return.mdx (100%) rename clerk-typedoc/{types => shared}/user-organization-invitation-resource.mdx (100%) rename clerk-typedoc/{types => shared}/user-resource.mdx (80%) rename clerk-typedoc/{types/without.mdx => shared/without-1.mdx} (100%) create mode 100644 clerk-typedoc/shared/without.mdx delete mode 100644 clerk-typedoc/types/add-payment-method-params.mdx delete mode 100644 clerk-typedoc/types/initialize-payment-method-params.mdx 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/types/act-claim.mdx b/clerk-typedoc/shared/act-claim-1.mdx similarity index 100% rename from clerk-typedoc/types/act-claim.mdx rename to clerk-typedoc/shared/act-claim-1.mdx diff --git a/clerk-typedoc/shared/act-claim.mdx b/clerk-typedoc/shared/act-claim.mdx new file mode 100644 index 0000000000..3de8a4c99a --- /dev/null +++ b/clerk-typedoc/shared/act-claim.mdx @@ -0,0 +1 @@ +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/shared/act-jwt-claim.mdx similarity index 100% rename from clerk-typedoc/types/act-jwt-claim.mdx rename to clerk-typedoc/shared/act-jwt-claim.mdx diff --git a/clerk-typedoc/types/active-session-resource.mdx b/clerk-typedoc/shared/active-session-resource.mdx similarity index 100% rename from clerk-typedoc/types/active-session-resource.mdx rename to clerk-typedoc/shared/active-session-resource.mdx diff --git a/clerk-typedoc/shared/add-payment-method-params.mdx b/clerk-typedoc/shared/add-payment-method-params.mdx new file mode 100644 index 0000000000..1ec15dddde --- /dev/null +++ b/clerk-typedoc/shared/add-payment-method-params.mdx @@ -0,0 +1,8 @@ +> **AddPaymentMethodParams** = \{ gateway: "stripe"; paymentToken: string; \} + +## Properties + +| Property | Type | Description | +| ---------------------------------------- | ---------- | ------------------------------------------------------------------ | +| `gateway` | `"stripe"` | The payment gateway to use. | +| `paymentToken` | `string` | A token representing payment details, usually from a payment form. | diff --git a/clerk-typedoc/types/billing-checkout-json.mdx b/clerk-typedoc/shared/billing-checkout-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-checkout-json.mdx rename to clerk-typedoc/shared/billing-checkout-json.mdx diff --git a/clerk-typedoc/types/billing-checkout-resource.mdx b/clerk-typedoc/shared/billing-checkout-resource.mdx similarity index 93% rename from clerk-typedoc/types/billing-checkout-resource.mdx rename to clerk-typedoc/shared/billing-checkout-resource.mdx index fab74d72ac..01fda5217b 100644 --- a/clerk-typedoc/types/billing-checkout-resource.mdx +++ b/clerk-typedoc/shared/billing-checkout-resource.mdx @@ -10,11 +10,12 @@ The `BillingCheckoutResource` type represents information about a checkout sessi | `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. | +| `needsPaymentMethod` | `boolean` | Whether a payment method is required for this 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. | +| `status` | "needs_confirmation" \| "completed" | 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/shared/billing-checkout-totals-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-checkout-totals-json.mdx rename to clerk-typedoc/shared/billing-checkout-totals-json.mdx diff --git a/clerk-typedoc/types/billing-checkout-totals.mdx b/clerk-typedoc/shared/billing-checkout-totals.mdx similarity index 100% rename from clerk-typedoc/types/billing-checkout-totals.mdx rename to clerk-typedoc/shared/billing-checkout-totals.mdx diff --git a/clerk-typedoc/types/billing-initialized-payment-method-json.mdx b/clerk-typedoc/shared/billing-initialized-payment-method-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-initialized-payment-method-json.mdx rename to clerk-typedoc/shared/billing-initialized-payment-method-json.mdx diff --git a/clerk-typedoc/types/billing-initialized-payment-method-resource.mdx b/clerk-typedoc/shared/billing-initialized-payment-method-resource.mdx similarity index 100% rename from clerk-typedoc/types/billing-initialized-payment-method-resource.mdx rename to clerk-typedoc/shared/billing-initialized-payment-method-resource.mdx diff --git a/clerk-typedoc/types/billing-money-amount-json.mdx b/clerk-typedoc/shared/billing-money-amount-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-money-amount-json.mdx rename to clerk-typedoc/shared/billing-money-amount-json.mdx diff --git a/clerk-typedoc/types/billing-money-amount.mdx b/clerk-typedoc/shared/billing-money-amount.mdx similarity index 100% rename from clerk-typedoc/types/billing-money-amount.mdx rename to clerk-typedoc/shared/billing-money-amount.mdx diff --git a/clerk-typedoc/types/billing-namespace.mdx b/clerk-typedoc/shared/billing-namespace.mdx similarity index 100% rename from clerk-typedoc/types/billing-namespace.mdx rename to clerk-typedoc/shared/billing-namespace.mdx diff --git a/clerk-typedoc/types/billing-payer-json.mdx b/clerk-typedoc/shared/billing-payer-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-payer-json.mdx rename to clerk-typedoc/shared/billing-payer-json.mdx diff --git a/clerk-typedoc/types/billing-payer-methods.mdx b/clerk-typedoc/shared/billing-payer-methods.mdx similarity index 77% rename from clerk-typedoc/types/billing-payer-methods.mdx rename to clerk-typedoc/shared/billing-payer-methods.mdx index 3222a1b37c..8e347196ab 100644 --- a/clerk-typedoc/types/billing-payer-methods.mdx +++ b/clerk-typedoc/shared/billing-payer-methods.mdx @@ -1,7 +1,7 @@ ## 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)\> | +| 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/shared/billing-payer-resource-type.mdx similarity index 100% rename from clerk-typedoc/types/billing-payer-resource-type.mdx rename to clerk-typedoc/shared/billing-payer-resource-type.mdx diff --git a/clerk-typedoc/types/billing-payer-resource.mdx b/clerk-typedoc/shared/billing-payer-resource.mdx similarity index 100% rename from clerk-typedoc/types/billing-payer-resource.mdx rename to clerk-typedoc/shared/billing-payer-resource.mdx diff --git a/clerk-typedoc/types/billing-payment-charge-type.mdx b/clerk-typedoc/shared/billing-payment-charge-type.mdx similarity index 100% rename from clerk-typedoc/types/billing-payment-charge-type.mdx rename to clerk-typedoc/shared/billing-payment-charge-type.mdx diff --git a/clerk-typedoc/types/billing-payment-json.mdx b/clerk-typedoc/shared/billing-payment-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-payment-json.mdx rename to clerk-typedoc/shared/billing-payment-json.mdx diff --git a/clerk-typedoc/types/billing-payment-method-json.mdx b/clerk-typedoc/shared/billing-payment-method-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-payment-method-json.mdx rename to clerk-typedoc/shared/billing-payment-method-json.mdx diff --git a/clerk-typedoc/types/billing-payment-method-resource.mdx b/clerk-typedoc/shared/billing-payment-method-resource.mdx similarity index 96% rename from clerk-typedoc/types/billing-payment-method-resource.mdx rename to clerk-typedoc/shared/billing-payment-method-resource.mdx index ea5da5db0c..7870ab0c2f 100644 --- a/clerk-typedoc/types/billing-payment-method-resource.mdx +++ b/clerk-typedoc/shared/billing-payment-method-resource.mdx @@ -11,7 +11,7 @@ The `BillingPaymentMethodResource` type represents a payment method for a checko | `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'`. | +| `paymentType` | "card" \| "link" | 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. | +| `status` | "active" \| "expired" \| "disconnected" | 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/shared/billing-payment-method-status.mdx similarity index 100% rename from clerk-typedoc/types/billing-payment-method-status.mdx rename to clerk-typedoc/shared/billing-payment-method-status.mdx diff --git a/clerk-typedoc/types/billing-payment-resource.mdx b/clerk-typedoc/shared/billing-payment-resource.mdx similarity index 96% rename from clerk-typedoc/types/billing-payment-resource.mdx rename to clerk-typedoc/shared/billing-payment-resource.mdx index 13e6e39dd6..e61cfd6afd 100644 --- a/clerk-typedoc/types/billing-payment-resource.mdx +++ b/clerk-typedoc/shared/billing-payment-resource.mdx @@ -11,6 +11,6 @@ The `BillingPaymentResource` type represents a payment attempt for a user or org | `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. | +| `status` | "pending" \| "paid" \| "failed" | 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/shared/billing-payment-status.mdx similarity index 100% rename from clerk-typedoc/types/billing-payment-status.mdx rename to clerk-typedoc/shared/billing-payment-status.mdx diff --git a/clerk-typedoc/types/billing-plan-json.mdx b/clerk-typedoc/shared/billing-plan-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-plan-json.mdx rename to clerk-typedoc/shared/billing-plan-json.mdx diff --git a/clerk-typedoc/types/billing-plan-resource.mdx b/clerk-typedoc/shared/billing-plan-resource.mdx similarity index 97% rename from clerk-typedoc/types/billing-plan-resource.mdx rename to clerk-typedoc/shared/billing-plan-resource.mdx index dd4940ca23..23523ec49a 100644 --- a/clerk-typedoc/types/billing-plan-resource.mdx +++ b/clerk-typedoc/shared/billing-plan-resource.mdx @@ -10,7 +10,7 @@ The `BillingPlanResource` type represents a subscription plan with its details. | `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. | +| `forPayerType` | "org" \| "user" | 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. | diff --git a/clerk-typedoc/types/billing-statement-group-json.mdx b/clerk-typedoc/shared/billing-statement-group-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-statement-group-json.mdx rename to clerk-typedoc/shared/billing-statement-group-json.mdx diff --git a/clerk-typedoc/types/billing-statement-group.mdx b/clerk-typedoc/shared/billing-statement-group.mdx similarity index 100% rename from clerk-typedoc/types/billing-statement-group.mdx rename to clerk-typedoc/shared/billing-statement-group.mdx diff --git a/clerk-typedoc/types/billing-statement-json.mdx b/clerk-typedoc/shared/billing-statement-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-statement-json.mdx rename to clerk-typedoc/shared/billing-statement-json.mdx diff --git a/clerk-typedoc/types/billing-statement-resource.mdx b/clerk-typedoc/shared/billing-statement-resource.mdx similarity index 97% rename from clerk-typedoc/types/billing-statement-resource.mdx rename to clerk-typedoc/shared/billing-statement-resource.mdx index 66c9415154..49909acd1b 100644 --- a/clerk-typedoc/types/billing-statement-resource.mdx +++ b/clerk-typedoc/shared/billing-statement-resource.mdx @@ -7,6 +7,6 @@ The `BillingStatementResource` type represents a billing statement for a user or | `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). | +| `status` | "open" \| "closed" | 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/shared/billing-statement-status.mdx similarity index 100% rename from clerk-typedoc/types/billing-statement-status.mdx rename to clerk-typedoc/shared/billing-statement-status.mdx diff --git a/clerk-typedoc/types/billing-statement-totals-json.mdx b/clerk-typedoc/shared/billing-statement-totals-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-statement-totals-json.mdx rename to clerk-typedoc/shared/billing-statement-totals-json.mdx diff --git a/clerk-typedoc/types/billing-statement-totals.mdx b/clerk-typedoc/shared/billing-statement-totals.mdx similarity index 100% rename from clerk-typedoc/types/billing-statement-totals.mdx rename to clerk-typedoc/shared/billing-statement-totals.mdx diff --git a/clerk-typedoc/types/billing-subscription-item-json.mdx b/clerk-typedoc/shared/billing-subscription-item-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-subscription-item-json.mdx rename to clerk-typedoc/shared/billing-subscription-item-json.mdx diff --git a/clerk-typedoc/types/billing-subscription-item-resource.mdx b/clerk-typedoc/shared/billing-subscription-item-resource.mdx similarity index 100% rename from clerk-typedoc/types/billing-subscription-item-resource.mdx rename to clerk-typedoc/shared/billing-subscription-item-resource.mdx diff --git a/clerk-typedoc/types/billing-subscription-json.mdx b/clerk-typedoc/shared/billing-subscription-json.mdx similarity index 100% rename from clerk-typedoc/types/billing-subscription-json.mdx rename to clerk-typedoc/shared/billing-subscription-json.mdx diff --git a/clerk-typedoc/types/billing-subscription-plan-period.mdx b/clerk-typedoc/shared/billing-subscription-plan-period.mdx similarity index 100% rename from clerk-typedoc/types/billing-subscription-plan-period.mdx rename to clerk-typedoc/shared/billing-subscription-plan-period.mdx diff --git a/clerk-typedoc/types/billing-subscription-resource.mdx b/clerk-typedoc/shared/billing-subscription-resource.mdx similarity index 100% rename from clerk-typedoc/types/billing-subscription-resource.mdx rename to clerk-typedoc/shared/billing-subscription-resource.mdx diff --git a/clerk-typedoc/types/billing-subscription-status.mdx b/clerk-typedoc/shared/billing-subscription-status.mdx similarity index 100% rename from clerk-typedoc/types/billing-subscription-status.mdx rename to clerk-typedoc/shared/billing-subscription-status.mdx diff --git a/clerk-typedoc/types/cancel-subscription-params.mdx b/clerk-typedoc/shared/cancel-subscription-params.mdx similarity index 100% rename from clerk-typedoc/types/cancel-subscription-params.mdx rename to clerk-typedoc/shared/cancel-subscription-params.mdx diff --git a/clerk-typedoc/types/check-authorization-fn.mdx b/clerk-typedoc/shared/check-authorization-fn.mdx similarity index 100% rename from clerk-typedoc/types/check-authorization-fn.mdx rename to clerk-typedoc/shared/check-authorization-fn.mdx diff --git a/clerk-typedoc/types/check-authorization-from-session-claims.mdx b/clerk-typedoc/shared/check-authorization-from-session-claims.mdx similarity index 100% rename from clerk-typedoc/types/check-authorization-from-session-claims.mdx rename to clerk-typedoc/shared/check-authorization-from-session-claims.mdx diff --git a/clerk-typedoc/types/check-authorization-params-from-session-claims.mdx b/clerk-typedoc/shared/check-authorization-params-from-session-claims.mdx similarity index 100% rename from clerk-typedoc/types/check-authorization-params-from-session-claims.mdx rename to clerk-typedoc/shared/check-authorization-params-from-session-claims.mdx diff --git a/clerk-typedoc/types/check-authorization-with-custom-permissions.mdx b/clerk-typedoc/shared/check-authorization-with-custom-permissions.mdx similarity index 100% rename from clerk-typedoc/types/check-authorization-with-custom-permissions.mdx rename to clerk-typedoc/shared/check-authorization-with-custom-permissions.mdx diff --git a/clerk-typedoc/types/clerk-api-error.mdx b/clerk-typedoc/shared/clerk-api-error-1.mdx similarity index 100% rename from clerk-typedoc/types/clerk-api-error.mdx rename to clerk-typedoc/shared/clerk-api-error-1.mdx diff --git a/clerk-typedoc/shared/clerk-api-error.mdx b/clerk-typedoc/shared/clerk-api-error.mdx index 4264acbc3a..766884ce7b 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`](clerk-api-error-1.mdx) ## Properties diff --git a/clerk-typedoc/types/clerk-api-response-error.mdx b/clerk-typedoc/shared/clerk-api-response-error.mdx similarity index 100% rename from clerk-typedoc/types/clerk-api-response-error.mdx rename to clerk-typedoc/shared/clerk-api-response-error.mdx diff --git a/clerk-typedoc/types/clerk-host-router.mdx b/clerk-typedoc/shared/clerk-host-router.mdx similarity index 100% rename from clerk-typedoc/types/clerk-host-router.mdx rename to clerk-typedoc/shared/clerk-host-router.mdx diff --git a/clerk-typedoc/types/clerk-jwt-claims.mdx b/clerk-typedoc/shared/clerk-jwt-claims.mdx similarity index 100% rename from clerk-typedoc/types/clerk-jwt-claims.mdx rename to clerk-typedoc/shared/clerk-jwt-claims.mdx diff --git a/clerk-typedoc/types/clerk-paginated-response.mdx b/clerk-typedoc/shared/clerk-paginated-response.mdx similarity index 100% rename from clerk-typedoc/types/clerk-paginated-response.mdx rename to clerk-typedoc/shared/clerk-paginated-response.mdx diff --git a/clerk-typedoc/types/clerk-pagination-params.mdx b/clerk-typedoc/shared/clerk-pagination-params.mdx similarity index 100% rename from clerk-typedoc/types/clerk-pagination-params.mdx rename to clerk-typedoc/shared/clerk-pagination-params.mdx diff --git a/clerk-typedoc/types/clerk-pagination-request.mdx b/clerk-typedoc/shared/clerk-pagination-request.mdx similarity index 100% rename from clerk-typedoc/types/clerk-pagination-request.mdx rename to clerk-typedoc/shared/clerk-pagination-request.mdx diff --git a/clerk-typedoc/types/clerk-resource.mdx b/clerk-typedoc/shared/clerk-resource.mdx similarity index 100% rename from clerk-typedoc/types/clerk-resource.mdx rename to clerk-typedoc/shared/clerk-resource.mdx diff --git a/clerk-typedoc/types/clerk-status.mdx b/clerk-typedoc/shared/clerk-status.mdx similarity index 100% rename from clerk-typedoc/types/clerk-status.mdx rename to clerk-typedoc/shared/clerk-status.mdx diff --git a/clerk-typedoc/types/clerk.mdx b/clerk-typedoc/shared/clerk.mdx similarity index 99% rename from clerk-typedoc/types/clerk.mdx rename to clerk-typedoc/shared/clerk.mdx index ea5453cfd1..737031679d 100644 --- a/clerk-typedoc/types/clerk.mdx +++ b/clerk-typedoc/shared/clerk.mdx @@ -84,7 +84,7 @@ Main Clerk SDK object. | `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. | +| `status` | "error" \| "loading" \| "degraded" \| "ready" | 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.\* | diff --git a/clerk-typedoc/types/confirm-checkout-params.mdx b/clerk-typedoc/shared/confirm-checkout-params.mdx similarity index 75% rename from clerk-typedoc/types/confirm-checkout-params.mdx rename to clerk-typedoc/shared/confirm-checkout-params.mdx index f60f169d9b..0333701da2 100644 --- a/clerk-typedoc/types/confirm-checkout-params.mdx +++ b/clerk-typedoc/shared/confirm-checkout-params.mdx @@ -11,13 +11,13 @@ There are multiple variants of this type available which you can select by click | Name | Type | Description | | ------ | ------ | ------ | -| `gateway?` | "stripe" \| "paypal" | The payment gateway to use. **Required** if `paymentToken` or `useTestCard` is provided. | +| `gateway?` | `"stripe"` | 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. | +| `gateway?` | `"stripe"` | 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/shared/create-checkout-params.mdx similarity index 100% rename from clerk-typedoc/types/create-checkout-params.mdx rename to clerk-typedoc/shared/create-checkout-params.mdx diff --git a/clerk-typedoc/types/create-organization-params.mdx b/clerk-typedoc/shared/create-organization-params.mdx similarity index 100% rename from clerk-typedoc/types/create-organization-params.mdx rename to clerk-typedoc/shared/create-organization-params.mdx diff --git a/clerk-typedoc/types/deleted-object-resource.mdx b/clerk-typedoc/shared/deleted-object-resource.mdx similarity index 100% rename from clerk-typedoc/types/deleted-object-resource.mdx rename to clerk-typedoc/shared/deleted-object-resource.mdx diff --git a/clerk-typedoc/types/element-object-key.mdx b/clerk-typedoc/shared/element-object-key.mdx similarity index 100% rename from clerk-typedoc/types/element-object-key.mdx rename to clerk-typedoc/shared/element-object-key.mdx diff --git a/clerk-typedoc/types/elements-config.mdx b/clerk-typedoc/shared/elements-config.mdx similarity index 100% rename from clerk-typedoc/types/elements-config.mdx rename to clerk-typedoc/shared/elements-config.mdx diff --git a/clerk-typedoc/types/errors.mdx b/clerk-typedoc/shared/errors.mdx similarity index 100% rename from clerk-typedoc/types/errors.mdx rename to clerk-typedoc/shared/errors.mdx diff --git a/clerk-typedoc/types/experimental_checkout-button-props.mdx b/clerk-typedoc/shared/experimental_checkout-button-props.mdx similarity index 100% rename from clerk-typedoc/types/experimental_checkout-button-props.mdx rename to clerk-typedoc/shared/experimental_checkout-button-props.mdx diff --git a/clerk-typedoc/types/experimental_plan-details-button-props.mdx b/clerk-typedoc/shared/experimental_plan-details-button-props.mdx similarity index 100% rename from clerk-typedoc/types/experimental_plan-details-button-props.mdx rename to clerk-typedoc/shared/experimental_plan-details-button-props.mdx diff --git a/clerk-typedoc/types/experimental_subscription-details-button-props.mdx b/clerk-typedoc/shared/experimental_subscription-details-button-props.mdx similarity index 100% rename from clerk-typedoc/types/experimental_subscription-details-button-props.mdx rename to clerk-typedoc/shared/experimental_subscription-details-button-props.mdx diff --git a/clerk-typedoc/types/feature-json.mdx b/clerk-typedoc/shared/feature-json.mdx similarity index 100% rename from clerk-typedoc/types/feature-json.mdx rename to clerk-typedoc/shared/feature-json.mdx diff --git a/clerk-typedoc/types/feature-resource.mdx b/clerk-typedoc/shared/feature-resource.mdx similarity index 100% rename from clerk-typedoc/types/feature-resource.mdx rename to clerk-typedoc/shared/feature-resource.mdx diff --git a/clerk-typedoc/types/field-error.mdx b/clerk-typedoc/shared/field-error.mdx similarity index 100% rename from clerk-typedoc/types/field-error.mdx rename to clerk-typedoc/shared/field-error.mdx diff --git a/clerk-typedoc/types/field-errors.mdx b/clerk-typedoc/shared/field-errors.mdx similarity index 100% rename from clerk-typedoc/types/field-errors.mdx rename to clerk-typedoc/shared/field-errors.mdx diff --git a/clerk-typedoc/types/for-payer-type.mdx b/clerk-typedoc/shared/for-payer-type.mdx similarity index 100% rename from clerk-typedoc/types/for-payer-type.mdx rename to clerk-typedoc/shared/for-payer-type.mdx diff --git a/clerk-typedoc/types/get-payment-attempts-params.mdx b/clerk-typedoc/shared/get-payment-attempts-params.mdx similarity index 100% rename from clerk-typedoc/types/get-payment-attempts-params.mdx rename to clerk-typedoc/shared/get-payment-attempts-params.mdx diff --git a/clerk-typedoc/types/get-payment-methods-params.mdx b/clerk-typedoc/shared/get-payment-methods-params.mdx similarity index 100% rename from clerk-typedoc/types/get-payment-methods-params.mdx rename to clerk-typedoc/shared/get-payment-methods-params.mdx diff --git a/clerk-typedoc/types/get-plans-params.mdx b/clerk-typedoc/shared/get-plans-params.mdx similarity index 100% rename from clerk-typedoc/types/get-plans-params.mdx rename to clerk-typedoc/shared/get-plans-params.mdx diff --git a/clerk-typedoc/types/get-statements-params.mdx b/clerk-typedoc/shared/get-statements-params.mdx similarity index 100% rename from clerk-typedoc/types/get-statements-params.mdx rename to clerk-typedoc/shared/get-statements-params.mdx diff --git a/clerk-typedoc/types/get-subscription-params.mdx b/clerk-typedoc/shared/get-subscription-params.mdx similarity index 100% rename from clerk-typedoc/types/get-subscription-params.mdx rename to clerk-typedoc/shared/get-subscription-params.mdx diff --git a/clerk-typedoc/types/get-token.mdx b/clerk-typedoc/shared/get-token.mdx similarity index 100% rename from clerk-typedoc/types/get-token.mdx rename to clerk-typedoc/shared/get-token.mdx diff --git a/clerk-typedoc/types/id-selectors.mdx b/clerk-typedoc/shared/id-selectors.mdx similarity index 100% rename from clerk-typedoc/types/id-selectors.mdx rename to clerk-typedoc/shared/id-selectors.mdx diff --git a/clerk-typedoc/shared/initialize-payment-method-params.mdx b/clerk-typedoc/shared/initialize-payment-method-params.mdx new file mode 100644 index 0000000000..2eb26e27b4 --- /dev/null +++ b/clerk-typedoc/shared/initialize-payment-method-params.mdx @@ -0,0 +1,7 @@ +> **InitializePaymentMethodParams** = \{ gateway: "stripe"; \} + +## Properties + +| Property | Type | Description | +| ------------------------------ | ---------- | --------------------------- | +| `gateway` | `"stripe"` | The payment gateway to use. | diff --git a/clerk-typedoc/types/internal_checkout-props.mdx b/clerk-typedoc/shared/internal_checkout-props.mdx similarity index 100% rename from clerk-typedoc/types/internal_checkout-props.mdx rename to clerk-typedoc/shared/internal_checkout-props.mdx diff --git a/clerk-typedoc/types/internal_plan-details-props.mdx b/clerk-typedoc/shared/internal_plan-details-props.mdx similarity index 100% rename from clerk-typedoc/types/internal_plan-details-props.mdx rename to clerk-typedoc/shared/internal_plan-details-props.mdx diff --git a/clerk-typedoc/types/internal_subscription-details-props.mdx b/clerk-typedoc/shared/internal_subscription-details-props.mdx similarity index 100% rename from clerk-typedoc/types/internal_subscription-details-props.mdx rename to clerk-typedoc/shared/internal_subscription-details-props.mdx diff --git a/clerk-typedoc/types/jwt-claims.mdx b/clerk-typedoc/shared/jwt-claims.mdx similarity index 100% rename from clerk-typedoc/types/jwt-claims.mdx rename to clerk-typedoc/shared/jwt-claims.mdx diff --git a/clerk-typedoc/types/jwt-header.mdx b/clerk-typedoc/shared/jwt-header.mdx similarity index 100% rename from clerk-typedoc/types/jwt-header.mdx rename to clerk-typedoc/shared/jwt-header.mdx diff --git a/clerk-typedoc/types/legacy-redirect-props.mdx b/clerk-typedoc/shared/legacy-redirect-props.mdx similarity index 100% rename from clerk-typedoc/types/legacy-redirect-props.mdx rename to clerk-typedoc/shared/legacy-redirect-props.mdx diff --git a/clerk-typedoc/types/localization-resource.mdx b/clerk-typedoc/shared/localization-resource.mdx similarity index 100% rename from clerk-typedoc/types/localization-resource.mdx rename to clerk-typedoc/shared/localization-resource.mdx diff --git a/clerk-typedoc/types/make-default-payment-method-params.mdx b/clerk-typedoc/shared/make-default-payment-method-params.mdx similarity index 100% rename from clerk-typedoc/types/make-default-payment-method-params.mdx rename to clerk-typedoc/shared/make-default-payment-method-params.mdx diff --git a/clerk-typedoc/types/multi-domain-and-or-proxy.mdx b/clerk-typedoc/shared/multi-domain-and-or-proxy.mdx similarity index 100% rename from clerk-typedoc/types/multi-domain-and-or-proxy.mdx rename to clerk-typedoc/shared/multi-domain-and-or-proxy.mdx diff --git a/clerk-typedoc/types/organization-custom-role-key.mdx b/clerk-typedoc/shared/organization-custom-role-key.mdx similarity index 100% rename from clerk-typedoc/types/organization-custom-role-key.mdx rename to clerk-typedoc/shared/organization-custom-role-key.mdx diff --git a/clerk-typedoc/types/organization-domain-resource.mdx b/clerk-typedoc/shared/organization-domain-resource.mdx similarity index 100% rename from clerk-typedoc/types/organization-domain-resource.mdx rename to clerk-typedoc/shared/organization-domain-resource.mdx diff --git a/clerk-typedoc/types/organization-domain-verification-status.mdx b/clerk-typedoc/shared/organization-domain-verification-status.mdx similarity index 100% rename from clerk-typedoc/types/organization-domain-verification-status.mdx rename to clerk-typedoc/shared/organization-domain-verification-status.mdx diff --git a/clerk-typedoc/types/organization-enrollment-mode.mdx b/clerk-typedoc/shared/organization-enrollment-mode.mdx similarity index 100% rename from clerk-typedoc/types/organization-enrollment-mode.mdx rename to clerk-typedoc/shared/organization-enrollment-mode.mdx diff --git a/clerk-typedoc/types/organization-invitation-resource.mdx b/clerk-typedoc/shared/organization-invitation-resource.mdx similarity index 100% rename from clerk-typedoc/types/organization-invitation-resource.mdx rename to clerk-typedoc/shared/organization-invitation-resource.mdx diff --git a/clerk-typedoc/types/organization-invitation-status.mdx b/clerk-typedoc/shared/organization-invitation-status.mdx similarity index 100% rename from clerk-typedoc/types/organization-invitation-status.mdx rename to clerk-typedoc/shared/organization-invitation-status.mdx diff --git a/clerk-typedoc/types/organization-membership-request-resource.mdx b/clerk-typedoc/shared/organization-membership-request-resource.mdx similarity index 100% rename from clerk-typedoc/types/organization-membership-request-resource.mdx rename to clerk-typedoc/shared/organization-membership-request-resource.mdx diff --git a/clerk-typedoc/types/organization-membership-resource.mdx b/clerk-typedoc/shared/organization-membership-resource.mdx similarity index 100% rename from clerk-typedoc/types/organization-membership-resource.mdx rename to clerk-typedoc/shared/organization-membership-resource.mdx diff --git a/clerk-typedoc/types/organization-permission-key.mdx b/clerk-typedoc/shared/organization-permission-key.mdx similarity index 100% rename from clerk-typedoc/types/organization-permission-key.mdx rename to clerk-typedoc/shared/organization-permission-key.mdx diff --git a/clerk-typedoc/types/organization-resource.mdx b/clerk-typedoc/shared/organization-resource.mdx similarity index 75% rename from clerk-typedoc/types/organization-resource.mdx rename to clerk-typedoc/shared/organization-resource.mdx index 06983d809a..b5128e2f6a 100644 --- a/clerk-typedoc/types/organization-resource.mdx +++ b/clerk-typedoc/shared/organization-resource.mdx @@ -4,10 +4,10 @@ To use these methods, you must have the **Organizations** feature [enabled in yo ## 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. | +| 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/shared/organization-suggestion-resource.mdx similarity index 100% rename from clerk-typedoc/types/organization-suggestion-resource.mdx rename to clerk-typedoc/shared/organization-suggestion-resource.mdx diff --git a/clerk-typedoc/types/organization-suggestion-status.mdx b/clerk-typedoc/shared/organization-suggestion-status.mdx similarity index 100% rename from clerk-typedoc/types/organization-suggestion-status.mdx rename to clerk-typedoc/shared/organization-suggestion-status.mdx diff --git a/clerk-typedoc/types/organizations-jwt-claim.mdx b/clerk-typedoc/shared/organizations-jwt-claim.mdx similarity index 100% rename from clerk-typedoc/types/organizations-jwt-claim.mdx rename to clerk-typedoc/shared/organizations-jwt-claim.mdx diff --git a/clerk-typedoc/types/override.mdx b/clerk-typedoc/shared/override-1.mdx similarity index 100% rename from clerk-typedoc/types/override.mdx rename to clerk-typedoc/shared/override-1.mdx diff --git a/clerk-typedoc/shared/override.mdx b/clerk-typedoc/shared/override.mdx new file mode 100644 index 0000000000..6aec62ed95 --- /dev/null +++ b/clerk-typedoc/shared/override.mdx @@ -0,0 +1,4 @@ +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/shared/path-value-1.mdx similarity index 100% rename from clerk-typedoc/types/path-value.mdx rename to clerk-typedoc/shared/path-value-1.mdx diff --git a/clerk-typedoc/shared/path-value.mdx b/clerk-typedoc/shared/path-value.mdx new file mode 100644 index 0000000000..6b63699056 --- /dev/null +++ b/clerk-typedoc/shared/path-value.mdx @@ -0,0 +1,4 @@ +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/shared/payment-gateway.mdx similarity index 100% rename from clerk-typedoc/types/payment-gateway.mdx rename to clerk-typedoc/shared/payment-gateway.mdx diff --git a/clerk-typedoc/types/pending-session-options.mdx b/clerk-typedoc/shared/pending-session-options.mdx similarity index 100% rename from clerk-typedoc/types/pending-session-options.mdx rename to clerk-typedoc/shared/pending-session-options.mdx diff --git a/clerk-typedoc/types/pending-session-resource.mdx b/clerk-typedoc/shared/pending-session-resource.mdx similarity index 100% rename from clerk-typedoc/types/pending-session-resource.mdx rename to clerk-typedoc/shared/pending-session-resource.mdx diff --git a/clerk-typedoc/types/protect-props.mdx b/clerk-typedoc/shared/protect-props.mdx similarity index 100% rename from clerk-typedoc/types/protect-props.mdx rename to clerk-typedoc/shared/protect-props.mdx diff --git a/clerk-typedoc/types/record-to-path.mdx b/clerk-typedoc/shared/record-to-path-1.mdx similarity index 100% rename from clerk-typedoc/types/record-to-path.mdx rename to clerk-typedoc/shared/record-to-path-1.mdx diff --git a/clerk-typedoc/shared/record-to-path.mdx b/clerk-typedoc/shared/record-to-path.mdx new file mode 100644 index 0000000000..d89089101d --- /dev/null +++ b/clerk-typedoc/shared/record-to-path.mdx @@ -0,0 +1,4 @@ +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/shared/redirect-options.mdx similarity index 100% rename from clerk-typedoc/types/redirect-options.mdx rename to clerk-typedoc/shared/redirect-options.mdx diff --git a/clerk-typedoc/types/remove-payment-method-params.mdx b/clerk-typedoc/shared/remove-payment-method-params.mdx similarity index 100% rename from clerk-typedoc/types/remove-payment-method-params.mdx rename to clerk-typedoc/shared/remove-payment-method-params.mdx diff --git a/clerk-typedoc/types/reverification-config.mdx b/clerk-typedoc/shared/reverification-config.mdx similarity index 93% rename from clerk-typedoc/types/reverification-config.mdx rename to clerk-typedoc/shared/reverification-config.mdx index 9ce8f049f6..b67a3a48bd 100644 --- a/clerk-typedoc/types/reverification-config.mdx +++ b/clerk-typedoc/shared/reverification-config.mdx @@ -1,6 +1,6 @@ The `ReverificationConfig` type has the following properties: -"strict" \| "strict_mfa" \| "moderate" \| "lax" +"strict_mfa" \| "strict" \| "moderate" \| "lax" | Name | Type | Description | | -------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | diff --git a/clerk-typedoc/types/saml-strategy.mdx b/clerk-typedoc/shared/saml-strategy.mdx similarity index 100% rename from clerk-typedoc/types/saml-strategy.mdx rename to clerk-typedoc/shared/saml-strategy.mdx diff --git a/clerk-typedoc/types/sdk-metadata.mdx b/clerk-typedoc/shared/sdk-metadata.mdx similarity index 100% rename from clerk-typedoc/types/sdk-metadata.mdx rename to clerk-typedoc/shared/sdk-metadata.mdx diff --git a/clerk-typedoc/types/server-get-token-options.mdx b/clerk-typedoc/shared/server-get-token-options.mdx similarity index 100% rename from clerk-typedoc/types/server-get-token-options.mdx rename to clerk-typedoc/shared/server-get-token-options.mdx diff --git a/clerk-typedoc/types/server-get-token.mdx b/clerk-typedoc/shared/server-get-token.mdx similarity index 100% rename from clerk-typedoc/types/server-get-token.mdx rename to clerk-typedoc/shared/server-get-token.mdx diff --git a/clerk-typedoc/types/session-resource.mdx b/clerk-typedoc/shared/session-resource.mdx similarity index 100% rename from clerk-typedoc/types/session-resource.mdx rename to clerk-typedoc/shared/session-resource.mdx diff --git a/clerk-typedoc/types/session-status-claim.mdx b/clerk-typedoc/shared/session-status-claim.mdx similarity index 100% rename from clerk-typedoc/types/session-status-claim.mdx rename to clerk-typedoc/shared/session-status-claim.mdx diff --git a/clerk-typedoc/types/session-task.mdx b/clerk-typedoc/shared/session-task.mdx similarity index 100% rename from clerk-typedoc/types/session-task.mdx rename to clerk-typedoc/shared/session-task.mdx diff --git a/clerk-typedoc/types/session-verification-level.mdx b/clerk-typedoc/shared/session-verification-level.mdx similarity index 100% rename from clerk-typedoc/types/session-verification-level.mdx rename to clerk-typedoc/shared/session-verification-level.mdx diff --git a/clerk-typedoc/types/session-verification-types.mdx b/clerk-typedoc/shared/session-verification-types.mdx similarity index 100% rename from clerk-typedoc/types/session-verification-types.mdx rename to clerk-typedoc/shared/session-verification-types.mdx diff --git a/clerk-typedoc/types/set-active-params.mdx b/clerk-typedoc/shared/set-active-params.mdx similarity index 100% rename from clerk-typedoc/types/set-active-params.mdx rename to clerk-typedoc/shared/set-active-params.mdx diff --git a/clerk-typedoc/types/set-active.mdx b/clerk-typedoc/shared/set-active.mdx similarity index 100% rename from clerk-typedoc/types/set-active.mdx rename to clerk-typedoc/shared/set-active.mdx diff --git a/clerk-typedoc/types/sign-in-future-resource.mdx b/clerk-typedoc/shared/sign-in-future-resource.mdx similarity index 96% rename from clerk-typedoc/types/sign-in-future-resource.mdx rename to clerk-typedoc/shared/sign-in-future-resource.mdx index b98a5fe064..de49cf3287 100644 --- a/clerk-typedoc/types/sign-in-future-resource.mdx +++ b/clerk-typedoc/shared/sign-in-future-resource.mdx @@ -11,9 +11,9 @@ and the creation of a new session. | `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; \}\>; verification: null \| \{ createdSessionId: string; status: "expired" \| "failed" \| "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.verification` | null \| \{ createdSessionId: string; status: "expired" \| "failed" \| "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. | @@ -25,6 +25,7 @@ and the creation of a new session. | `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 | +| `passkey` | (params?: SignInFuturePasskeyParams) => Promise\<\{ error: unknown; \}\> | Initiates a passkey-based authentication flow, enabling users to authenticate using a previously registered passkey. When called without parameters, this method requires a prior call to `SignIn.create({ strategy: 'passkey' })` to initialize the sign-in context. This pattern is particularly useful in scenarios where the authentication strategy needs to be determined dynamically at runtime. | | `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 | diff --git a/clerk-typedoc/types/sign-in-resource.mdx b/clerk-typedoc/shared/sign-in-resource.mdx similarity index 100% rename from clerk-typedoc/types/sign-in-resource.mdx rename to clerk-typedoc/shared/sign-in-resource.mdx diff --git a/clerk-typedoc/types/sign-in-signal-value.mdx b/clerk-typedoc/shared/sign-in-signal-value.mdx similarity index 100% rename from clerk-typedoc/types/sign-in-signal-value.mdx rename to clerk-typedoc/shared/sign-in-signal-value.mdx diff --git a/clerk-typedoc/types/sign-out.mdx b/clerk-typedoc/shared/sign-out.mdx similarity index 100% rename from clerk-typedoc/types/sign-out.mdx rename to clerk-typedoc/shared/sign-out.mdx diff --git a/clerk-typedoc/types/sign-up-authenticate-with-metamask-params.mdx b/clerk-typedoc/shared/sign-up-authenticate-with-metamask-params.mdx similarity index 100% rename from clerk-typedoc/types/sign-up-authenticate-with-metamask-params.mdx rename to clerk-typedoc/shared/sign-up-authenticate-with-metamask-params.mdx diff --git a/clerk-typedoc/types/sign-up-enterprise-connection-json.mdx b/clerk-typedoc/shared/sign-up-enterprise-connection-json.mdx similarity index 100% rename from clerk-typedoc/types/sign-up-enterprise-connection-json.mdx rename to clerk-typedoc/shared/sign-up-enterprise-connection-json.mdx diff --git a/clerk-typedoc/types/sign-up-enterprise-connection-resource.mdx b/clerk-typedoc/shared/sign-up-enterprise-connection-resource.mdx similarity index 100% rename from clerk-typedoc/types/sign-up-enterprise-connection-resource.mdx rename to clerk-typedoc/shared/sign-up-enterprise-connection-resource.mdx diff --git a/clerk-typedoc/types/sign-up-future-resource.mdx b/clerk-typedoc/shared/sign-up-future-resource.mdx similarity index 100% rename from clerk-typedoc/types/sign-up-future-resource.mdx rename to clerk-typedoc/shared/sign-up-future-resource.mdx diff --git a/clerk-typedoc/types/sign-up-resource.mdx b/clerk-typedoc/shared/sign-up-resource.mdx similarity index 100% rename from clerk-typedoc/types/sign-up-resource.mdx rename to clerk-typedoc/shared/sign-up-resource.mdx diff --git a/clerk-typedoc/types/signed-in-session-resource.mdx b/clerk-typedoc/shared/signed-in-session-resource.mdx similarity index 100% rename from clerk-typedoc/types/signed-in-session-resource.mdx rename to clerk-typedoc/shared/signed-in-session-resource.mdx diff --git a/clerk-typedoc/shared/simplify.mdx b/clerk-typedoc/shared/simplify.mdx new file mode 100644 index 0000000000..9bdd6c62a1 --- /dev/null +++ b/clerk-typedoc/shared/simplify.mdx @@ -0,0 +1,2 @@ +Useful to flatten the type output to improve type hints shown in editors. And also to transform an interface into a type to aide with assignability. +https://github.com/sindresorhus/type-fest/blob/main/source/simplify.d.ts diff --git a/clerk-typedoc/types/state-selectors.mdx b/clerk-typedoc/shared/state-selectors.mdx similarity index 100% rename from clerk-typedoc/types/state-selectors.mdx rename to clerk-typedoc/shared/state-selectors.mdx diff --git a/clerk-typedoc/types/telemetry-log-entry.mdx b/clerk-typedoc/shared/telemetry-log-entry.mdx similarity index 100% rename from clerk-typedoc/types/telemetry-log-entry.mdx rename to clerk-typedoc/shared/telemetry-log-entry.mdx diff --git a/clerk-typedoc/types/use-auth-return.mdx b/clerk-typedoc/shared/use-auth-return.mdx similarity index 97% rename from clerk-typedoc/types/use-auth-return.mdx rename to clerk-typedoc/shared/use-auth-return.mdx index 6dde7d99cd..30878bfb36 100644 --- a/clerk-typedoc/types/use-auth-return.mdx +++ b/clerk-typedoc/shared/use-auth-return.mdx @@ -30,7 +30,7 @@ | Name | Type | | --------------- | -------------------------------------------------------------------------------------------- | -| `actor` | [ActClaim](act-claim.mdx) \| null | +| `actor` | [ActClaim](act-claim-1.mdx) \| null | | `getToken` | [`GetToken`](get-token.mdx) | | `has` | [`CheckAuthorizationWithCustomPermissions`](check-authorization-with-custom-permissions.mdx) | | `isLoaded` | `true` | @@ -45,7 +45,7 @@ | Name | Type | | --------------- | -------------------------------------------------------------------------------------------- | -| `actor` | [ActClaim](act-claim.mdx) \| null | +| `actor` | [ActClaim](act-claim-1.mdx) \| null | | `getToken` | [`GetToken`](get-token.mdx) | | `has` | [`CheckAuthorizationWithCustomPermissions`](check-authorization-with-custom-permissions.mdx) | | `isLoaded` | `true` | 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-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/types/use-session-list-return.mdx b/clerk-typedoc/shared/use-session-list-return.mdx similarity index 100% rename from clerk-typedoc/types/use-session-list-return.mdx rename to clerk-typedoc/shared/use-session-list-return.mdx diff --git a/clerk-typedoc/types/use-session-return.mdx b/clerk-typedoc/shared/use-session-return.mdx similarity index 100% rename from clerk-typedoc/types/use-session-return.mdx rename to clerk-typedoc/shared/use-session-return.mdx diff --git a/clerk-typedoc/types/use-sign-in-return.mdx b/clerk-typedoc/shared/use-sign-in-return.mdx similarity index 100% rename from clerk-typedoc/types/use-sign-in-return.mdx rename to clerk-typedoc/shared/use-sign-in-return.mdx diff --git a/clerk-typedoc/types/use-sign-up-return.mdx b/clerk-typedoc/shared/use-sign-up-return.mdx similarity index 100% rename from clerk-typedoc/types/use-sign-up-return.mdx rename to clerk-typedoc/shared/use-sign-up-return.mdx diff --git a/clerk-typedoc/types/use-user-return.mdx b/clerk-typedoc/shared/use-user-return.mdx similarity index 100% rename from clerk-typedoc/types/use-user-return.mdx rename to clerk-typedoc/shared/use-user-return.mdx diff --git a/clerk-typedoc/types/user-organization-invitation-resource.mdx b/clerk-typedoc/shared/user-organization-invitation-resource.mdx similarity index 100% rename from clerk-typedoc/types/user-organization-invitation-resource.mdx rename to clerk-typedoc/shared/user-organization-invitation-resource.mdx diff --git a/clerk-typedoc/types/user-resource.mdx b/clerk-typedoc/shared/user-resource.mdx similarity index 80% rename from clerk-typedoc/types/user-resource.mdx rename to clerk-typedoc/shared/user-resource.mdx index 10fe99e936..efe5b80a36 100644 --- a/clerk-typedoc/types/user-resource.mdx +++ b/clerk-typedoc/shared/user-resource.mdx @@ -8,11 +8,11 @@ The ClerkJS SDK provides some helper [methods](#methods) on the `User` object to ## 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. | +| 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/shared/without-1.mdx similarity index 100% rename from clerk-typedoc/types/without.mdx rename to clerk-typedoc/shared/without-1.mdx diff --git a/clerk-typedoc/shared/without.mdx b/clerk-typedoc/shared/without.mdx new file mode 100644 index 0000000000..a4185e8e64 --- /dev/null +++ b/clerk-typedoc/shared/without.mdx @@ -0,0 +1 @@ +Omit without union flattening 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/initialize-payment-method-params.mdx b/clerk-typedoc/types/initialize-payment-method-params.mdx deleted file mode 100644 index e69de29bb2..0000000000