@clerk/shared 4.0.0-snapshot.v20251208202852 → 4.0.0-snapshot.v20251215203425

package/dist/types/index.d.ts

@@ -338,7 +338,7 @@ type ForceNull<T$1> = { [K in keyof T$1]: null };
 //#region src/types/billing.d.ts
 type WithOptionalOrgType<T$1> = T$1 & {
   /**
-   * The organization ID to perform the request on.
+   * The Organization ID to perform the request on.
    */
   orgId?: string;
 };
@@ -406,7 +406,7 @@ type ForPayerType = 'organization' | 'user';
  */
 type BillingSubscriptionStatus = 'active' | 'ended' | 'upcoming' | 'past_due';
 /**
- * The billing period for the plan.
+ * The billing period for the Plan.
  *
  * @inline
  */
@@ -433,107 +433,107 @@ interface BillingPayerMethods {
  */
 type GetPlansParams = ClerkPaginationParams<{
   /**
-   * The type of payer for the plans.
+   * The type of payer for the Plans.
    */
   for?: ForPayerType;
 }>;
 /**
- * The `BillingPlanResource` type represents a subscription plan with its details.
+ * The `BillingPlanResource` type represents a Subscription Plan with its details.
  *
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */
 interface BillingPlanResource extends ClerkResource {
   /**
-   * The unique identifier for the plan.
+   * The unique identifier for the Plan.
    */
   id: string;
   /**
-   * The name of the plan.
+   * The name of the Plan.
    */
   name: string;
   /**
-   * The monthly price of the plan.
+   * The monthly price of the Plan.
    */
   fee: BillingMoneyAmount;
   /**
-   * The annual price of the plan or `null` if the plan is not annual.
+   * The annual price of the Plan or `null` if the Plan is not annual.
    */
   annualFee: BillingMoneyAmount | null;
   /**
-   * The effective monthly price when billed annually or `null` if the plan is not annual.
+   * The effective monthly price when billed annually or `null` if the Plan is not annual.
    */
   annualMonthlyFee: BillingMoneyAmount | null;
   /**
-   * A short description of what the plan offers, or `null` if no description is provided.
+   * A short description of what the Plan offers, or `null` if no description is provided.
    */
   description: string | null;
   /**
-   * Whether the plan is the default plan.
+   * Whether the Plan is the default Plan.
    */
   isDefault: boolean;
   /**
-   * Whether the plan is recurring.
+   * Whether the Plan is recurring.
    */
   isRecurring: boolean;
   /**
-   * Whether the plan has a base fee.
+   * Whether the Plan has a base fee.
    */
   hasBaseFee: boolean;
   /**
-   * Specifies the subscriber type this plan is designed for.
+   * 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.
+   * Each Plan is exclusively created for either individual users or Organizations, and cannot be used interchangeably.
    */
   forPayerType: BillingPayerResourceType;
   /**
-   * Whether the plan is visible to the public.
+   * Whether the Plan is visible to the public.
    */
   publiclyVisible: boolean;
   /**
-   * The URL-friendly identifier of the plan.
+   * The URL-friendly identifier of the Plan.
    */
   slug: string;
   /**
-   * The URL of the plan's avatar image, or `null` if not set.
+   * The URL of the Plan's avatar image, or `null` if not set.
    */
   avatarUrl: string | null;
   /**
-   * The features the plan offers.
+   * The Features the Plan offers.
    */
   features: FeatureResource[];
   /**
-   * The number of days of the free trial for the plan. `null` if the plan does not have a free trial.
+   * The number of days of the free trial for the Plan. `null` if the Plan does not have a free trial.
    */
   freeTrialDays: number | null;
   /**
-   * Whether the plan has a free trial.
+   * Whether the Plan has a free trial.
    */
   freeTrialEnabled: boolean;
 }
 /**
- * The `FeatureResource` type represents a feature of a plan.
+ * The `FeatureResource` type represents a Feature of a Plan.
  *
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */
 interface FeatureResource extends ClerkResource {
   /**
-   * The unique identifier for the feature.
+   * The unique identifier for the Feature.
    */
   id: string;
   /**
-   * The display name of the feature.
+   * The display name of the Feature.
    */
   name: string;
   /**
-   * A short description of what the feature provides, or `null` if not provided.
+   * A short description of what the Feature provides, or `null` if not provided.
    */
   description: string | null;
   /**
-   * A unique, URL-friendly identifier for the feature.
+   * A unique, URL-friendly identifier for the Feature.
    */
   slug: string;
   /**
-   * The URL of the feature's avatar image, or `null` if not set.
+   * The URL of the Feature's avatar image, or `null` if not set.
    */
   avatarUrl: string | null;
 }
@@ -640,7 +640,7 @@ interface BillingPaymentMethodResource extends ClerkResource {
   /**
    * A function that removes this payment method from the account. Accepts the following parameters:
    * <ul>
-   *  <li>`orgId?` (`string`): The ID of the organization to remove the payment method from.</li>
+   *  <li>`orgId?` (`string`): The ID of the Organization to remove the payment method from.</li>
    * </ul>
    *
    * @param params - The parameters for the remove operation.
@@ -650,7 +650,7 @@ interface BillingPaymentMethodResource extends ClerkResource {
   /**
    * A function that sets this payment method as the default for the account. Accepts the following parameters:
    * <ul>
-   *  <li>`orgId?` (`string`): The ID of the organization to set as the default.</li>
+   *  <li>`orgId?` (`string`): The ID of the Organization to set as the default.</li>
    * </ul>
    *
    * @param params - The parameters for the make default operation.
@@ -688,7 +688,7 @@ type BillingPaymentChargeType = 'checkout' | 'recurring';
  */
 type BillingPaymentStatus = 'pending' | 'paid' | 'failed';
 /**
- * The `BillingPaymentResource` type represents a payment attempt for a user or organization.
+ * The `BillingPaymentResource` type represents a payment attempt for a user or Organization.
  *
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */
@@ -745,7 +745,7 @@ type GetStatementsParams = WithOptionalOrgType<ClerkPaginationParams>;
  */
 type BillingStatementStatus = 'open' | 'closed';
 /**
- * The `BillingStatementResource` type represents a billing statement for a user or organization.
+ * The `BillingStatementResource` type represents a billing statement for a user or Organization.
  *
  * @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
  */
@@ -807,7 +807,7 @@ interface BillingSubscriptionItemResource extends ClerkResource {
    */
   id: string;
   /**
-   * The plan associated with the subscription item.
+   * The Plan associated with the subscription item.
    */
   plan: BillingPlanResource;
   /**
@@ -854,7 +854,7 @@ interface BillingSubscriptionItemResource extends ClerkResource {
   /**
    * A function to cancel the subscription item. Accepts the following parameters:
    * <ul>
-   *  <li>`orgId?` (`string`): The ID of the organization to cancel the subscription item from.</li>
+   *  <li>`orgId?` (`string`): The ID of the Organization to cancel the subscription item from.</li>
    * </ul>
    *
    * @param params - The parameters for the cancel operation.
@@ -948,7 +948,7 @@ interface BillingMoneyAmount {
  */
 interface BillingCheckoutTotals {
   /**
-   * The price of the items or plan before taxes, credits, or discounts are applied.
+   * The price of the items or Plan before taxes, credits, or discounts are applied.
    */
   subtotal: BillingMoneyAmount;
   /**
@@ -983,7 +983,7 @@ interface BillingCheckoutTotals {
  */
 interface BillingStatementTotals {
   /**
-   * The price of the items or plan before taxes, credits, or discounts are applied.
+   * The price of the items or Plan before taxes, credits, or discounts are applied.
    */
   subtotal: BillingMoneyAmount;
   /**
@@ -1002,11 +1002,11 @@ interface BillingStatementTotals {
  */
 type CreateCheckoutParams = WithOptionalOrgType<{
   /**
-   * The unique identifier for the plan.
+   * The unique identifier for the Plan.
    */
   planId: string;
   /**
-   * The billing period for the plan.
+   * The billing period for the Plan.
    */
   planPeriod: BillingSubscriptionPlanPeriod;
 }>;
@@ -1065,15 +1065,15 @@ interface BillingCheckoutResource extends ClerkResource {
    */
   paymentMethod?: BillingPaymentMethodResource;
   /**
-   * The subscription plan details for the checkout.
+   * The Subscription Plan details for the checkout.
    */
   plan: BillingPlanResource;
   /**
-   * The billing period for the plan.
+   * The billing period for the Plan.
    */
   planPeriod: BillingSubscriptionPlanPeriod;
   /**
-   * The start date of the plan period, represented as a Unix timestamp.
+   * The start date of the Plan period, represented as a Unix timestamp.
    */
   planPeriodStart?: number;
   /**
@@ -1089,7 +1089,7 @@ interface BillingCheckoutResource extends ClerkResource {
    */
   confirm: (params: ConfirmCheckoutParams) => Promise<BillingCheckoutResource>;
   /**
-   * Whether the plan change will take effect immediately after checkout.
+   * Whether the Plan change will take effect immediately after checkout.
    */
   isImmediatePlanChange: boolean;
   /**
@@ -1144,11 +1144,11 @@ interface BillingPayerResource extends ClerkResource {
    */
   lastName?: string | null;
   /**
-   * The unique identifier for the organization that the payer belongs to.
+   * The unique identifier for the Organization that the payer belongs to.
    */
   organizationId: string | null;
   /**
-   * The name of the organization that the payer belongs to.
+   * The name of the Organization that the payer belongs to.
    */
   organizationName?: string | null;
 }
@@ -2114,7 +2114,7 @@ type Web3WalletIdentifier = 'web3_wallet';
 type EmailAddressOrPhoneNumberIdentifier = 'email_address_or_phone_number';
 //#endregion
 //#region src/types/signInCommon.d.ts
-type SignInStatus = 'needs_identifier' | 'needs_first_factor' | 'needs_second_factor' | 'needs_new_password' | 'complete';
+type SignInStatus = 'needs_identifier' | 'needs_first_factor' | 'needs_second_factor' | 'needs_client_trust' | 'needs_new_password' | 'complete';
 type SignInIdentifier = UsernameIdentifier | EmailAddressIdentifier | PhoneNumberIdentifier | Web3WalletIdentifier;
 type SignInFirstFactor = EmailCodeFactor | EmailLinkFactor | PhoneCodeFactor | PasswordFactor | PasskeyFactor | ResetPasswordPhoneCodeFactor | ResetPasswordEmailCodeFactor | Web3SignatureFactor | OauthFactor | EnterpriseSSOFactor;
 type SignInSecondFactor = PhoneCodeFactor | TOTPFactor | BackupCodeFactor | EmailCodeFactor | EmailLinkFactor;
@@ -2867,7 +2867,7 @@ declare global {
   /**
    * If you want to provide custom types for the organizationInvitation.publicMetadata
    * object, simply redeclare this rule in the global namespace.
-   * Every organizationInvitation object will use the provided type.
+   * Every OrganizationInvitation object will use the provided type.
    */
   interface OrganizationInvitationPublicMetadata {
     [k: string]: unknown;
@@ -2877,7 +2877,7 @@ declare global {
   }
 }
 /**
- * The `OrganizationInvitation` object is the model around an organization invitation.
+ * The `OrganizationInvitation` object is the model around an Organization invitation.
  *
  * @interface
  */
@@ -3011,15 +3011,15 @@ interface ClerkJWTClaims {
    */
   act?: ActClaim;
   /**
-   * Active organization ID.
+   * Active Organization ID.
    */
   org_id?: string;
   /**
-   * Active organization slug.
+   * Active Organization Slug.
    */
   org_slug?: string;
   /**
-   * Active organization role.
+   * Active Organization Role.
    */
   org_role?: OrganizationCustomRoleKey;
   /**
@@ -3393,19 +3393,19 @@ type WithReverification<T$1> = T$1 & {
 };
 type CheckAuthorizationParamsWithCustomPermissions = WithReverification<{
   /**
-   * The [role](https://clerk.com/docs/guides/organizations/roles-and-permissions) to check for.
+   * The [Role](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
    */
   role: OrganizationCustomRoleKey;
   /**
-   * The [permission](https://clerk.com/docs/guides/organizations/roles-and-permissions) to check for.
+   * The [Permission](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
    */
   permission?: never;
   /**
-   * The [feature](https://clerk.com/docs/guides/billing/overview) to check for.
+   * The [Feature](https://clerk.com/docs/guides/billing/overview) to check for.
    */
   feature?: never;
   /**
-   * The [plan](https://clerk.com/docs/guides/billing/overview) to check for.
+   * The [Plan](https://clerk.com/docs/guides/billing/overview) to check for.
    */
   plan?: never;
 } | {
@@ -3432,19 +3432,19 @@ type CheckAuthorizationParamsWithCustomPermissions = WithReverification<{
 type CheckAuthorization = CheckAuthorizationFn<CheckAuthorizationParams>;
 type CheckAuthorizationParams = WithReverification<{
   /**
-   * The [role](https://clerk.com/docs/guides/organizations/roles-and-permissions) to check for.
+   * The [Role](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
    */
   role: OrganizationCustomRoleKey;
   /**
-   * The [permission](https://clerk.com/docs/guides/organizations/roles-and-permissions) to check for.
+   * The [Permission](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
    */
   permission?: never;
   /**
-   * The [feature](https://clerk.com/docs/guides/billing/overview) to check for.
+   * The [Feature](https://clerk.com/docs/guides/billing/overview) to check for.
    */
   feature?: never;
   /**
-   * The [plan](https://clerk.com/docs/guides/billing/overview) to check for.
+   * The [Plan](https://clerk.com/docs/guides/billing/overview) to check for.
    */
   plan?: never;
 } | {
@@ -3470,7 +3470,7 @@ type CheckAuthorizationParams = WithReverification<{
 }>;
 /**
  * Type guard for server-side authorization checks using session claims.
- * System permissions are not allowed since they are not included
+ * System Permissions are not allowed since they are not included
  * in session claims and cannot be verified on the server side.
  */
 type CheckAuthorizationFromSessionClaims = <P extends OrganizationCustomPermissionKey>(isAuthorizedParams: CheckAuthorizationParamsFromSessionClaims<P>) => boolean;
@@ -3479,19 +3479,19 @@ type CheckAuthorizationFromSessionClaims = <P extends OrganizationCustomPermissi
  */
 type CheckAuthorizationParamsFromSessionClaims<P$1 extends OrganizationCustomPermissionKey> = WithReverification<{
   /**
-   * The [role](https://clerk.com/docs/guides/organizations/roles-and-permissions) to check for.
+   * The [Role](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
    */
   role: OrganizationCustomRoleKey;
   /**
-   * The [permission](https://clerk.com/docs/guides/organizations/roles-and-permissions) to check for.
+   * The [Permission](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions) to check for.
    */
   permission?: never;
   /**
-   * The [feature](https://clerk.com/docs/guides/billing/overview) to check for.
+   * The [Feature](https://clerk.com/docs/guides/billing/overview) to check for.
    */
   feature?: never;
   /**
-   * The [plan](https://clerk.com/docs/guides/billing/overview) to check for.
+   * The [Plan](https://clerk.com/docs/guides/billing/overview) to check for.
    */
   plan?: never;
 } | {
@@ -3698,7 +3698,7 @@ declare global {
   /**
    * If you want to provide custom types for the organization.publicMetadata object,
    * simply redeclare this rule in the global namespace.
-   * Every organization object will use the provided type.
+   * Every Organization object will use the provided type.
    */
   interface OrganizationPublicMetadata {
     [k: string]: unknown;
@@ -3706,16 +3706,16 @@ declare global {
   /**
    * If you want to provide custom types for the organization.privateMetadata object,
    * simply redeclare this rule in the global namespace.
-   * Every organization object will use the provided type.
+   * Every Organization object will use the provided type.
    */
   interface OrganizationPrivateMetadata {
     [k: string]: unknown;
   }
 }
 /**
- * The `Organization` object holds information about an organization, as well as methods for managing it.
+ * The `Organization` object holds information about an Organization, as well as methods for managing it.
  *
- * To use these methods, you must have the **Organizations** feature [enabled in your app's settings in the Clerk Dashboard](https://clerk.com/docs/guides/organizations/overview#enable-organizations-in-your-application).
+ * To use these methods, you must have the **Organizations** feature [enabled in your app's settings in the Clerk Dashboard](https://clerk.com/docs/guides/organizations/configure#enable-organizations).
  *
  * @interface
  */
@@ -3808,7 +3808,7 @@ declare global {
   /**
    * If you want to provide custom types for the organizationMembership.publicMetadata
    * object, simply redeclare this rule in the global namespace.
-   * Every organizationMembership object will use the provided type.
+   * Every OrganizationMembership object will use the provided type.
    */
   interface OrganizationMembershipPublicMetadata {
     [k: string]: unknown;
@@ -3816,7 +3816,7 @@ declare global {
   /**
    * If you want to provide custom types for the organizationMembership.publicMetadata
    * object, simply redeclare this rule in the global namespace.
-   * Every organizationMembership object will use the provided type.
+   * Every OrganizationMembership object will use the provided type.
    */
   interface OrganizationMembershipPrivateMetadata {
     [k: string]: unknown;
@@ -3846,9 +3846,9 @@ interface OrganizationMembershipResource extends ClerkResource {
 }
 type OrganizationCustomPermissionKey = ClerkAuthorization extends Placeholder ? ClerkAuthorization['permission'] extends string ? ClerkAuthorization['permission'] : Base['permission'] : Base['permission'];
 /**
- * `OrganizationCustomRoleKey` is a type that represents the user's role in an organization. It will be string unless the developer has provided their own types through [`ClerkAuthorization`](https://clerk.com/docs/guides/development/override-clerk-types-interfaces#example-custom-roles-and-permissions).
+ * `OrganizationCustomRoleKey` is a type that represents the user's Role in an Organization. It will be string unless the developer has provided their own types through [`ClerkAuthorization`](https://clerk.com/docs/guides/development/override-clerk-types-interfaces#example-custom-roles-and-permissions).
  *
- * Clerk provides the [default roles](https://clerk.com/docs/guides/organizations/roles-and-permissions#default-roles) `org:admin` and `org:member`. However, you can create [custom roles](https://clerk.com/docs/guides/organizations/roles-and-permissions#custom-roles) as well.
+ * Clerk provides the [default Roles](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions#default-roles) `org:admin` and `org:member`. However, you can create [Custom Roles](https://clerk.com/docs/guides/organizations/control-access/roles-and-permissions#custom-roles) as well.
  *
  * @interface
  */
@@ -3856,8 +3856,8 @@ type OrganizationCustomRoleKey = ClerkAuthorization extends Placeholder ? ClerkA
 type OrganizationSystemPermissionPrefix = 'org:sys_';
 type OrganizationSystemPermissionKey = `${OrganizationSystemPermissionPrefix}domains:manage` | `${OrganizationSystemPermissionPrefix}profile:manage` | `${OrganizationSystemPermissionPrefix}profile:delete` | `${OrganizationSystemPermissionPrefix}memberships:read` | `${OrganizationSystemPermissionPrefix}memberships:manage` | `${OrganizationSystemPermissionPrefix}domains:read`;
 /**
- * OrganizationPermissionKey is a combination of system and custom permissions.
- * System permissions are only accessible from FAPI and client-side operations/utils
+ * OrganizationPermissionKey is a combination of System and Custom Permissions.
+ * System Permissions are only accessible from FAPI and client-side operations/utils
  */
 type OrganizationPermissionKey = ClerkAuthorization extends Placeholder ? ClerkAuthorization['permission'] extends string ? ClerkAuthorization['permission'] | OrganizationSystemPermissionKey : Autocomplete<OrganizationSystemPermissionKey> : Autocomplete<OrganizationSystemPermissionKey>;
 type UpdateOrganizationMembershipParams = {
@@ -3953,19 +3953,19 @@ type VersionedJwtPayload = {
   v?: undefined;
   /**
    *
-   * Active organization permissions.
+   * Active Organization Permissions.
    */
   org_permissions?: OrganizationCustomPermissionKey[];
   /**
-   * Active organization ID.
+   * Active Organization ID.
    */
   org_id?: string;
   /**
-   * Active organization slug.
+   * Active Organization slug.
    */
   org_slug?: string;
   /**
-   * Active organization role.
+   * Active Organization Role.
    */
   org_role?: OrganizationCustomRoleKey;
 } | {
@@ -3984,25 +3984,25 @@ type VersionedJwtPayload = {
    */
   pla?: string;
   /**
-   * Active organization information.
+   * Active Organization information.
    *
    * @experimental This structure is subject to change.
    */
   o?: {
     /**
-     * Active organization ID.
+     * Active Organization ID.
      */
     id: string;
     /**
-     * Active organization slug.
+     * Active Organization slug.
      */
     slg?: string;
     /**
-     * Active organization role.
+     * Active Organization role.
      */
     rol?: OrganizationCustomRoleKey;
     /**
-     * Active organization permissions.
+     * Active Organization permissions.
      */
     per?: string;
     /**
@@ -5473,7 +5473,7 @@ type __internal_LocalizationResource = {
   locale: string;
   maintenanceMode: LocalizationValue;
   /**
-   * Add role keys and their localized values, e.g. `roles: { 'org:teacher': 'Teacher'}`.
+   * Add Role keys and their localized values, e.g. `roles: { 'org:teacher': 'Teacher'}`.
    *
    * @experimental
    */
@@ -6707,6 +6707,8 @@ type __internal_LocalizationResource = {
 };
 type WithParamName<T$1> = T$1 & Partial<Record<`${keyof T$1 & string}__${CamelToSnake<Exclude<FieldId, 'role'>>}`, LocalizationValue>>;
 type UnstableErrors = WithParamName<{
+  avatar_file_type_invalid: LocalizationValue;
+  avatar_file_size_exceeded: LocalizationValue;
   external_account_not_found: LocalizationValue;
   identification_deletion_failed: LocalizationValue;
   phone_number_exists: LocalizationValue;
@@ -6733,10 +6735,12 @@ type UnstableErrors = WithParamName<{
   form_param_type_invalid: LocalizationValue;
   form_param_type_invalid__phone_number: LocalizationValue;
   form_param_type_invalid__email_address: LocalizationValue;
+  form_email_address_blocked: LocalizationValue;
   form_password_length_too_short: LocalizationValue;
   form_param_nil: LocalizationValue;
   form_code_incorrect: LocalizationValue;
   form_password_incorrect: LocalizationValue;
+  form_password_or_identifier_incorrect: LocalizationValue;
   form_password_validation_failed: LocalizationValue;
   not_allowed_access: LocalizationValue;
   form_identifier_exists: LocalizationValue;
@@ -7498,14 +7502,14 @@ interface Clerk {
    */
   unmountUserProfile: (targetNode: HTMLDivElement) => void;
   /**
-   * Mount an organization profile component at the target element.
+   * Mount an Organization profile component at the target element.
    *
    * @param targetNode - Target to mount the OrganizationProfile component.
    * @param props - Configuration parameters.
    */
   mountOrganizationProfile: (targetNode: HTMLDivElement, props?: OrganizationProfileProps) => void;
   /**
-   * Unmount the organization profile component from the target node.
+   * Unmount the Organization profile component from the target node.
    *
    * @param targetNode - Target node to unmount the OrganizationProfile component from.
    */
@@ -7524,20 +7528,20 @@ interface Clerk {
    */
   unmountCreateOrganization: (targetNode: HTMLDivElement) => void;
   /**
-   * Mount an organization switcher component at the target element.
+   * Mount an Organization switcher component at the target element.
    *
    * @param targetNode - Target to mount the OrganizationSwitcher component.
    * @param props - Configuration parameters.
    */
   mountOrganizationSwitcher: (targetNode: HTMLDivElement, props?: OrganizationSwitcherProps) => void;
   /**
-   * Unmount the organization profile component from the target node.*
+   * Unmount the Organization switcher component from the target node.*
    *
    * @param targetNode - Target node to unmount the OrganizationSwitcher component from.
    */
   unmountOrganizationSwitcher: (targetNode: HTMLDivElement) => void;
   /**
-   * Prefetches the data displayed by an organization switcher.
+   * Prefetches the data displayed by an Organization switcher.
    * It can be used when `mountOrganizationSwitcher({ asStandalone: true})`, to avoid unwanted loading states.
    *
    * @experimental This experimental API is subject to change.
@@ -7546,14 +7550,14 @@ interface Clerk {
    */
   __experimental_prefetchOrganizationSwitcher: () => void;
   /**
-   * Mount an organization list component at the target element.
+   * Mount an Organization list component at the target element.
    *
    * @param targetNode - Target to mount the OrganizationList component.
    * @param props - Configuration parameters.
    */
   mountOrganizationList: (targetNode: HTMLDivElement, props?: OrganizationListProps) => void;
   /**
-   * Unmount the organization list component from the target node.*
+   * Unmount the Organization list component from the target node.*
    *
    * @param targetNode - Target node to unmount the OrganizationList component from.
    */
@@ -7690,7 +7694,7 @@ interface Clerk {
    */
   __internal_addNavigationListener: (callback: () => void) => UnsubscribeCallback;
   /**
-   * Set the active session and organization explicitly.
+   * 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.
@@ -7860,11 +7864,11 @@ interface Clerk {
    */
   authenticateWithGoogleOneTap: (params: AuthenticateWithGoogleOneTapParams) => Promise<SignInResource | SignUpResource>;
   /**
-   * Creates an organization, adding the current user as admin.
+   * Creates an Organization, adding the current user as admin.
    */
   createOrganization: (params: CreateOrganizationParams) => Promise<OrganizationResource>;
   /**
-   * Retrieves a single organization by id.
+   * Retrieves a single Organization by ID.
    */
   getOrganization: (organizationId: string) => Promise<OrganizationResource>;
   /**
@@ -7981,7 +7985,7 @@ type ClerkOptions = ClerkOptionsNavigation & SignInForceRedirectUrl & SignInFall
    */
   appearance?: any;
   /**
-   * Optional object to localize your components. Will only affect [Clerk Components](https://clerk.com/docs/reference/components/overview) and not [Account Portal](https://clerk.com/docs/guides/customizing-clerk/account-portal) pages.
+   * Optional object to localize your components. Will only affect [Clerk Components](https://clerk.com/docs/reference/components/overview) and not [Account Portal](https://clerk.com/docs/guides/account-portal/overview) pages.
    */
   localization?: LocalizationResource;
   polling?: boolean;
@@ -7994,7 +7998,7 @@ type ClerkOptions = ClerkOptionsNavigation & SignInForceRedirectUrl & SignInFall
    */
   standardBrowser?: boolean;
   /**
-   * Optional support email for display in authentication screens. Will only affect [Clerk Components](https://clerk.com/docs/reference/components/overview) and not [Account Portal](https://clerk.com/docs/guides/customizing-clerk/account-portal) pages.
+   * Optional support email for display in authentication screens. Will only affect [Clerk Components](https://clerk.com/docs/reference/components/overview) and not [Account Portal](https://clerk.com/docs/guides/account-portal/overview) pages.
    */
   supportEmail?: string;
   /**
@@ -8042,7 +8046,7 @@ type ClerkOptions = ClerkOptionsNavigation & SignInForceRedirectUrl & SignInFall
    */
   sdkMetadata?: SDKMetadata;
   /**
-   * The full URL or path to the waitlist page. If `undefined`, will redirect to the [Account Portal waitlist page](https://clerk.com/docs/guides/customizing-clerk/account-portal#waitlist).
+   * The full URL or path to the waitlist page. If `undefined`, will redirect to the [Account Portal waitlist page](https://clerk.com/docs/guides/account-portal/overview#waitlist).
    */
   waitlistUrl?: string;
   /**
@@ -8185,7 +8189,7 @@ type SetActiveParams = {
    */
   session?: SignedInSessionResource | string | null;
   /**
-   * The organization resource or organization ID/slug (string version) to be set as active in the current session. If `null`, the currently active organization is removed as active.
+   * The Organization resource or Organization ID/slug (string version) to be set as active in the current session. If `null`, the currently Active Organization is removed as active.
    */
   organization?: OrganizationResource | string | null;
   /**
@@ -8193,7 +8197,7 @@ type SetActiveParams = {
    */
   redirectUrl?: string;
   /**
-   * A custom navigation function to be called just before the session and/or organization is set.
+   * A custom navigation function to be called just before the session and/or Organization is set.
    *
    * When provided, it takes precedence over the `redirectUrl` parameter for navigation.
    *
@@ -8299,8 +8303,21 @@ interface TransferableOption {
    */
   transferable?: boolean;
 }
-type SignInModalProps = WithoutRouting<SignInProps>;
+type SignInModalProps = WithoutRouting<SignInProps> & {
+  /**
+   * Function that returns the container element where portals should be rendered.
+   * This allows Clerk components to render inside external dialogs/popovers
+   * (e.g., Radix Dialog, React Aria Components) instead of document.body.
+   */
+  getContainer?: () => HTMLElement | null;
+};
 type __internal_UserVerificationProps = RoutingOptions & {
+  /**
+   * Function that returns the container element where portals should be rendered.
+   * This allows Clerk components to render inside external dialogs/popovers
+   * (e.g., Radix Dialog, React Aria Components) instead of document.body.
+   */
+  getContainer?: () => HTMLElement | null;
   /**
    * Non-awaitable callback for when verification is completed successfully
    */
@@ -8418,7 +8435,14 @@ type SignUpProps = RoutingOptions & {
    */
   oidcPrompt?: string;
 } & SignInFallbackRedirectUrl & SignInForceRedirectUrl & AfterSignOutUrl;
-type SignUpModalProps = WithoutRouting<SignUpProps>;
+type SignUpModalProps = WithoutRouting<SignUpProps> & {
+  /**
+   * Function that returns the container element where portals should be rendered.
+   * This allows Clerk components to render inside external dialogs/popovers
+   * (e.g., Radix Dialog, React Aria Components) instead of document.body.
+   */
+  getContainer?: () => HTMLElement | null;
+};
 type UserProfileProps = RoutingOptions & {
   /**
    * Customisation options to fully match the Clerk components to your own brand.
@@ -8451,10 +8475,17 @@ type UserProfileProps = RoutingOptions & {
     hide?: boolean;
   };
 };
-type UserProfileModalProps = WithoutRouting<UserProfileProps>;
+type UserProfileModalProps = WithoutRouting<UserProfileProps> & {
+  /**
+   * Function that returns the container element where portals should be rendered.
+   * This allows Clerk components to render inside external dialogs/popovers
+   * (e.g., Radix Dialog, React Aria Components) instead of document.body.
+   */
+  getContainer?: () => HTMLElement | null;
+};
 type OrganizationProfileProps = RoutingOptions & {
   /**
-   * Full URL or path to navigate to after the user leaves the currently active organization.
+   * Full URL or path to navigate to after the user leaves the currently Active Organization.
    *
    * @default undefined
    */
@@ -8467,7 +8498,7 @@ type OrganizationProfileProps = RoutingOptions & {
   appearance?: ClerkAppearanceTheme;
   customPages?: CustomPage[];
   /**
-   * Specify on which page the organization profile modal will open.
+   * Specify on which page the Organization profile modal will open.
    *
    * @example __experimental_startPath: '/organization-members'
    *
@@ -8489,16 +8520,23 @@ type OrganizationProfileProps = RoutingOptions & {
     hide?: boolean;
   };
 };
-type OrganizationProfileModalProps = WithoutRouting<OrganizationProfileProps>;
+type OrganizationProfileModalProps = WithoutRouting<OrganizationProfileProps> & {
+  /**
+   * Function that returns the container element where portals should be rendered.
+   * This allows Clerk components to render inside external dialogs/popovers
+   * (e.g., Radix Dialog, React Aria Components) instead of document.body.
+   */
+  getContainer?: () => HTMLElement | null;
+};
 type CreateOrganizationProps = RoutingOptions & {
   /**
-   * Full URL or path to navigate to after creating a new organization.
+   * Full URL or path to navigate to after creating a new Organization.
    *
    * @default undefined
    */
   afterCreateOrganizationUrl?: ((organization: OrganizationResource) => string) | LooseExtractedParams<PrimitiveKeys<OrganizationResource>>;
   /**
-   * Hides the screen for sending invitations after an organization is created.
+   * Hides the screen for sending invitations after an Organization is created.
    *
    * @default undefined When left undefined Clerk will automatically hide the screen if
    * the number of max allowed members is equal to 1
@@ -8511,7 +8549,14 @@ type CreateOrganizationProps = RoutingOptions & {
    */
   appearance?: ClerkAppearanceTheme;
 };
-type CreateOrganizationModalProps = WithoutRouting<CreateOrganizationProps>;
+type CreateOrganizationModalProps = WithoutRouting<CreateOrganizationProps> & {
+  /**
+   * Function that returns the container element where portals should be rendered.
+   * This allows Clerk components to render inside external dialogs/popovers
+   * (e.g., Radix Dialog, React Aria Components) instead of document.body.
+   */
+  getContainer?: () => HTMLElement | null;
+};
 type UserProfileMode = 'modal' | 'navigation';
 type UserButtonProfileMode = {
   userProfileUrl?: never;
@@ -8596,10 +8641,10 @@ type OrganizationSwitcherProps = CreateOrganizationMode & OrganizationProfileMod
    */
   __experimental_asStandalone?: boolean | ((opened: boolean) => void);
   /**
-   * By default, users can switch between organization and their personal account.
+   * By default, users can switch between Organization and their personal account.
    * This option controls whether OrganizationSwitcher will include the user's personal account
-   * in the organization list. Setting this to `false` will hide the personal account entry,
-   * and users will only be able to switch between organizations.
+   * in the Organization list. Setting this to `false` will hide the personal account entry,
+   * and users will only be able to switch between Organizations.
    *
    * @default true
    */
@@ -8611,7 +8656,7 @@ type OrganizationSwitcherProps = CreateOrganizationMode & OrganizationProfileMod
    */
   afterCreateOrganizationUrl?: ((organization: OrganizationResource) => string) | LooseExtractedParams<PrimitiveKeys<OrganizationResource>>;
   /**
-   * Full URL or path to navigate to after a successful organization selection.
+   * Full URL or path to navigate to after a successful Organization selection.
    * Accepts a function that returns URL or path
    *
    * @default undefined`
@@ -8625,13 +8670,13 @@ type OrganizationSwitcherProps = CreateOrganizationMode & OrganizationProfileMod
    */
   afterSelectPersonalUrl?: ((user: UserResource) => string) | LooseExtractedParams<PrimitiveKeys<UserResource>>;
   /**
-   * Full URL or path to navigate to after the user leaves the currently active organization.
+   * Full URL or path to navigate to after the user leaves the currently Active Organization.
    *
    * @default undefined
    */
   afterLeaveOrganizationUrl?: string;
   /**
-   * Hides the screen for sending invitations after an organization is created.
+   * Hides the screen for sending invitations after an Organization is created.
    *
    * @default undefined When left undefined Clerk will automatically hide the screen if
    * the number of max allowed members is equal to 1
@@ -8647,13 +8692,13 @@ type OrganizationSwitcherProps = CreateOrganizationMode & OrganizationProfileMod
 };
 type OrganizationListProps = {
   /**
-   * Full URL or path to navigate to after creating a new organization.
+   * Full URL or path to navigate to after creating a new Organization.
    *
    * @default undefined
    */
   afterCreateOrganizationUrl?: ((organization: OrganizationResource) => string) | LooseExtractedParams<PrimitiveKeys<OrganizationResource>>;
   /**
-   * Full URL or path to navigate to after a successful organization selection.
+   * Full URL or path to navigate to after a successful Organization selection.
    * Accepts a function that returns URL or path
    *
    * @default undefined`
@@ -8666,17 +8711,17 @@ type OrganizationListProps = {
    */
   appearance?: ClerkAppearanceTheme;
   /**
-   * Hides the screen for sending invitations after an organization is created.
+   * Hides the screen for sending invitations after an Organization is created.
    *
    * @default undefined When left undefined Clerk will automatically hide the screen if
    * the number of max allowed members is equal to 1
    */
   skipInvitationScreen?: boolean;
   /**
-   * By default, users can switch between organization and their personal account.
+   * By default, users can switch between Organization and their personal account.
    * This option controls whether OrganizationList will include the user's personal account
-   * in the organization list. Setting this to `false` will hide the personal account entry,
-   * and users will only be able to switch between organizations.
+   * in the Organization list. Setting this to `false` will hide the personal account entry,
+   * and users will only be able to switch between Organizations.
    *
    * @default true
    */
@@ -8705,7 +8750,14 @@ type WaitlistProps = {
    */
   signInUrl?: string;
 };
-type WaitlistModalProps = WaitlistProps;
+type WaitlistModalProps = WaitlistProps & {
+  /**
+   * Function that returns the container element where portals should be rendered.
+   * This allows Clerk components to render inside external dialogs/popovers
+   * (e.g., Radix Dialog, React Aria Components) instead of document.body.
+   */
+  getContainer?: () => HTMLElement | null;
+};
 type PricingTableDefaultProps = {
   /**
    * The position of the CTA button.
@@ -8714,7 +8766,7 @@ type PricingTableDefaultProps = {
    */
   ctaPosition?: 'top' | 'bottom';
   /**
-   * Whether to collapse features on the pricing table.
+   * Whether to collapse Features on the pricing table.
    *
    * @default false
    */
@@ -8729,7 +8781,7 @@ type PricingTableDefaultProps = {
 type PricingTableBaseProps = {
   /**
    * The subscriber type to display plans for.
-   * If `organization`, show plans for the active organization; otherwise for the user.
+   * If `organization`, show Plans for the Active Organization; otherwise for the user.
    *
    * @default 'user'
    */
@@ -8826,7 +8878,7 @@ type __internal_PlanDetailsProps = ({
   plan?: never;
 } | {
   /**
-   * The plan object will be used as initial data until the plan is fetched from the server.
+   * The Plan object will be used as initial data until the Plan is fetched from the server.
    */
   plan: BillingPlanResource;
   planId?: never;
@@ -8844,7 +8896,7 @@ type __experimental_PlanDetailsButtonProps = ({
   plan?: never;
 } | {
   /**
-   * The plan object will be used as initial data until the plan is fetched from the server.
+   * The Plan object will be used as initial data until the Plan is fetched from the server.
    */
   plan: BillingPlanResource;
   planId?: never;
@@ -8862,7 +8914,7 @@ type __experimental_PlanDetailsButtonProps = ({
 type __internal_SubscriptionDetailsProps = {
   /**
    * The subscriber type to display the subscription details for.
-   * If `organization` is provided, the subscription details will be displayed for the active organization.
+   * If `organization` is provided, the subscription details will be displayed for the Active Organization.
    *
    * @default 'user'
    */
@@ -8878,7 +8930,7 @@ type __internal_SubscriptionDetailsProps = {
 type __experimental_SubscriptionDetailsButtonProps = {
   /**
    * The subscriber type to display the subscription details for.
-   * If `organization` is provided, the subscription details will be displayed for the active organization.
+   * If `organization` is provided, the subscription details will be displayed for the Active Organization.
    *
    * @default 'user'
    */
@@ -8983,11 +9035,11 @@ type CreateBulkOrganizationInvitationParams = {
  */
 interface CreateOrganizationParams {
   /**
-   * The name of the organization.
+   * The name of the Organization.
    */
   name: string;
   /**
-   * The slug of the organization.
+   * The slug of the Organization.
    */
   slug?: string;
 }
@@ -9179,19 +9231,19 @@ type SharedSignedInAuthObjectProperties = {
    */
   userId: string;
   /**
-   * The ID of the user's active organization.
+   * The ID of the user's Active Organization.
    */
   orgId: string | undefined;
   /**
-   * The current user's role in their active organization.
+   * The current user's Role in their Active Organization.
    */
   orgRole: OrganizationCustomRoleKey | undefined;
   /**
-   * The URL-friendly identifier of the user's active organization.
+   * The URL-friendly identifier of the user's Active Organization.
    */
   orgSlug: string | undefined;
   /**
-   * The current user's active organization permissions.
+   * The current user's Organization Permissions.
    */
   orgPermissions: OrganizationCustomPermissionKey[] | undefined;
   /**
@@ -9269,19 +9321,19 @@ type UseAuthReturn = {
    */
   actor: undefined;
   /**
-   * The ID of the user's active organization.
+   * The ID of the user's active Organization.
    */
   orgId: undefined;
   /**
-   * The current user's role in their active organization.
+   * The current user's Role in their active Organization.
    */
   orgRole: undefined;
   /**
-   * The URL-friendly identifier of the user's active organization.
+   * The URL-friendly identifier of the user's Active Organization.
    */
   orgSlug: undefined;
   /**
-   * A function that checks if the user has specific permissions or roles. See the [reference doc](https://clerk.com/docs/reference/backend/types/auth-object#has).
+   * A function that checks if the user has specific Permissions or Roles. See the [reference doc](https://clerk.com/docs/reference/backend/types/auth-object#has).
    */
   has: CheckAuthorizationSignedOut;
   /**
@@ -9412,7 +9464,7 @@ type UseSessionListReturn = {
    */
   sessions: undefined;
   /**
-   * A function that sets the active session and/or organization. See the [reference doc](https://clerk.com/docs/reference/javascript/clerk#set-active).
+   * A function that sets the active session and/or Organization. See the [reference doc](https://clerk.com/docs/reference/javascript/clerk#set-active).
    */
   setActive: undefined;
 } | {
@@ -9456,24 +9508,24 @@ type PublishableKey = {
 /**
  * Props for the `<Protect />` component, which restricts access to its children based on authentication and authorization.
  *
- * Use `ProtectProps` to specify the required role, permission, feature, or plan for access.
+ * Use `ProtectProps` to specify the required Role, Permission, Feature, or Plan for access.
  *
  * @example
  * ```tsx
- * // Require a specific permission
+ * // Require a specific Permission
  * <Protect permission="a_permission_key" />
  *
- * // Require a specific role
+ * // Require a specific Role
  * <Protect role="a_role_key" />
  *
  * // Use a custom condition callback
  * <Protect condition={(has) => has({ permission: "a_permission_key" })} />
  *
- * // Require a specific feature
+ * // Require a specific Feature
  * <Protect feature="a_feature_key" />
  *
- * // Require a specific plan
- * <Protect plan=a_plan_key" />
+ * // Require a specific Plan
+ * <Protect plan="a_plan_key" />
  * ```
  */
 type ProtectProps = {