@clerk/types 4.54.2-snapshot.v20250417032557 → 4.54.2

package/dist/index.d.mts

@@ -1304,7 +1304,7 @@ type GetOrganizationMemberships = (params?: GetUserOrganizationMembershipParams)
  */
 type PendingSessionOptions = {
     /**
-     * Determines if pending sessions are considered as signed-out state.
+     * A boolean that indicates whether pending sessions are considered as signed out or not.
      * @default true
      */
     treatPendingAsSignedOut?: boolean;
@@ -2090,8 +2090,8 @@ type AfterSignOutUrl = {
 };
 type AfterMultiSessionSingleSignOutUrl = {
     /**
-     * Full URL or path to navigate to after signing out the current user is complete.
-     * This option applies to multi-session applications.
+     * The full URL or path to navigate to after signing out the current user is complete.
+     * This option applies to [multi-session applications](https://clerk.com/docs/authentication/configuration/session-options#multi-session-applications).
      */
     afterMultiSessionSingleSignOutUrl?: string | null;
 };
@@ -2119,13 +2119,13 @@ type LegacyRedirectProps = {
 type RedirectOptions = SignInForceRedirectUrl & SignInFallbackRedirectUrl & SignUpForceRedirectUrl & SignUpFallbackRedirectUrl & LegacyRedirectProps;
 type AuthenticateWithRedirectParams = {
     /**
-     * Full URL or path to the route that will complete the OAuth or SAML flow.
+     * The full URL or path to the route that will complete the OAuth or SAML flow.
      * Typically, this will be a simple `/sso-callback` route that calls `Clerk.handleRedirectCallback`
      * or mounts the <AuthenticateWithRedirectCallback /> component.
      */
     redirectUrl: string;
     /**
-     * Full URL or path to navigate to after the OAuth or SAML flow completes.
+     * The full URL or path to navigate to after the OAuth or SAML flow completes.
      */
     redirectUrlComplete: string;
     /**
@@ -2161,7 +2161,7 @@ type RedirectUrlProp = {
 };
 type SignUpForceRedirectUrl = {
     /**
-     * If provided, this URL will always be redirected to after the user signs up. It's recommended to use the [environment variable](https://clerk.com/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
+     * This URL will always be redirected to after the user signs up. It's recommended to use the [environment variable](https://clerk.com/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
      */
     signUpForceRedirectUrl?: string | null;
 };
@@ -2181,14 +2181,13 @@ type SignInFallbackRedirectUrl = {
 };
 type SignInForceRedirectUrl = {
     /**
-     * If provided, this URL will always be redirected to after the user signs in. It's recommended to use the [environment variable](https://clerk.com/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
+     * This URL will always be redirected to after the user signs in. It's recommended to use the [environment variable](https://clerk.com/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
      */
     signInForceRedirectUrl?: string | null;
 };
 
 /**
  * The `SignIn` object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process. It is used to manage the sign-in lifecycle, including the first and second factor verification, and the creation of a new session.
- * @interface
  */
 interface SignInResource extends ClerkResource {
     /**
@@ -2221,6 +2220,9 @@ interface SignInResource extends ClerkResource {
     authenticateWithPasskey: (params?: AuthenticateWithPasskeyParams) => Promise<SignInResource>;
     createEmailLinkFlow: () => CreateEmailLinkFlowReturn<SignInStartEmailLinkFlowParams, SignInResource>;
     validatePassword: (password: string, callbacks?: ValidatePasswordCallbacks) => void;
+    /**
+     * @internal
+     */
     __internal_toSnapshot: () => SignInJSONSnapshot;
 }
 type SignInStatus = 'needs_identifier' | 'needs_first_factor' | 'needs_second_factor' | 'needs_new_password' | 'complete';
@@ -3539,12 +3541,20 @@ type ElementsConfig = {
     invoiceRoot: WithOptions;
     invoiceCard: WithOptions;
     invoiceHeader: WithOptions;
+    invoiceHeaderContent: WithOptions;
     invoiceTitle: WithOptions;
+    invoiceHeaderTitleBadgeContainer: WithOptions;
+    invoiceTitleIdContainer: WithOptions;
+    invoiceId: WithOptions;
+    invoiceIdContainer: WithOptions;
     invoiceBadge: WithOptions;
     invoiceDetails: WithOptions;
     invoiceDetailsItem: WithOptions;
     invoiceDetailsItemTitle: WithOptions;
+    invoiceDetailsItemTitleText: WithOptions;
     invoiceDetailsItemValue: WithOptions;
+    invoiceDetailsItemValueText: WithOptions;
+    invoiceCopyButton: WithOptions;
     invoiceContent: WithOptions;
     menuButton: WithOptions<MenuId>;
     menuButtonEllipsis: WithOptions;
@@ -3973,7 +3983,7 @@ type InstanceType = 'production' | 'development';
 type LocalizationValue = string;
 /**
  * A type containing all the possible localization keys the prebuilt Clerk components support.
- * Users aiming to customise a few strings can also peak at the `data-localization-key` attribute by inspecting
+ * Users aiming to customize a few strings can also peak at the `data-localization-key` attribute by inspecting
  * the DOM and updating the corresponding key.
  * Users aiming to completely localize the components by providing a complete translation can use
  * the default english resource object from {@link https://github.com/clerk/javascript Clerk's open source repo}
@@ -6545,7 +6555,7 @@ type UseSessionReturn = {
      */
     isSignedIn: undefined;
     /**
-     * Holds the current active session for the user.
+     * The current active session for the user.
      */
     session: undefined;
 } | {
@@ -6591,7 +6601,7 @@ type UseUserReturn = {
      */
     isSignedIn: undefined;
     /**
-     * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
+     * The `User` object for the current user.
      */
     user: undefined;
 } | {
@@ -6619,7 +6629,7 @@ type PublishableKey = {
  */
 type MultiDomainAndOrProxy = {
     /**
-     * Whether the application is a satellite application.
+     * A boolean that indicates whether the application is a satellite application.
      */
     isSatellite?: never;
     /**
@@ -6641,7 +6651,7 @@ type MultiDomainAndOrProxy = {
 };
 type MultiDomainAndOrProxyPrimitives = {
     /**
-     * Whether the application is a satellite application.
+     * A boolean that indicates whether the application is a satellite application.
      */
     isSatellite?: never;
     /**

package/dist/index.d.ts

@@ -1304,7 +1304,7 @@ type GetOrganizationMemberships = (params?: GetUserOrganizationMembershipParams)
  */
 type PendingSessionOptions = {
     /**
-     * Determines if pending sessions are considered as signed-out state.
+     * A boolean that indicates whether pending sessions are considered as signed out or not.
      * @default true
      */
     treatPendingAsSignedOut?: boolean;
@@ -2090,8 +2090,8 @@ type AfterSignOutUrl = {
 };
 type AfterMultiSessionSingleSignOutUrl = {
     /**
-     * Full URL or path to navigate to after signing out the current user is complete.
-     * This option applies to multi-session applications.
+     * The full URL or path to navigate to after signing out the current user is complete.
+     * This option applies to [multi-session applications](https://clerk.com/docs/authentication/configuration/session-options#multi-session-applications).
      */
     afterMultiSessionSingleSignOutUrl?: string | null;
 };
@@ -2119,13 +2119,13 @@ type LegacyRedirectProps = {
 type RedirectOptions = SignInForceRedirectUrl & SignInFallbackRedirectUrl & SignUpForceRedirectUrl & SignUpFallbackRedirectUrl & LegacyRedirectProps;
 type AuthenticateWithRedirectParams = {
     /**
-     * Full URL or path to the route that will complete the OAuth or SAML flow.
+     * The full URL or path to the route that will complete the OAuth or SAML flow.
      * Typically, this will be a simple `/sso-callback` route that calls `Clerk.handleRedirectCallback`
      * or mounts the <AuthenticateWithRedirectCallback /> component.
      */
     redirectUrl: string;
     /**
-     * Full URL or path to navigate to after the OAuth or SAML flow completes.
+     * The full URL or path to navigate to after the OAuth or SAML flow completes.
      */
     redirectUrlComplete: string;
     /**
@@ -2161,7 +2161,7 @@ type RedirectUrlProp = {
 };
 type SignUpForceRedirectUrl = {
     /**
-     * If provided, this URL will always be redirected to after the user signs up. It's recommended to use the [environment variable](https://clerk.com/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
+     * This URL will always be redirected to after the user signs up. It's recommended to use the [environment variable](https://clerk.com/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
      */
     signUpForceRedirectUrl?: string | null;
 };
@@ -2181,14 +2181,13 @@ type SignInFallbackRedirectUrl = {
 };
 type SignInForceRedirectUrl = {
     /**
-     * If provided, this URL will always be redirected to after the user signs in. It's recommended to use the [environment variable](https://clerk.com/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
+     * This URL will always be redirected to after the user signs in. It's recommended to use the [environment variable](https://clerk.com/docs/deployments/clerk-environment-variables#sign-in-and-sign-up-redirects) instead.
      */
     signInForceRedirectUrl?: string | null;
 };
 
 /**
  * The `SignIn` object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process. It is used to manage the sign-in lifecycle, including the first and second factor verification, and the creation of a new session.
- * @interface
  */
 interface SignInResource extends ClerkResource {
     /**
@@ -2221,6 +2220,9 @@ interface SignInResource extends ClerkResource {
     authenticateWithPasskey: (params?: AuthenticateWithPasskeyParams) => Promise<SignInResource>;
     createEmailLinkFlow: () => CreateEmailLinkFlowReturn<SignInStartEmailLinkFlowParams, SignInResource>;
     validatePassword: (password: string, callbacks?: ValidatePasswordCallbacks) => void;
+    /**
+     * @internal
+     */
     __internal_toSnapshot: () => SignInJSONSnapshot;
 }
 type SignInStatus = 'needs_identifier' | 'needs_first_factor' | 'needs_second_factor' | 'needs_new_password' | 'complete';
@@ -3539,12 +3541,20 @@ type ElementsConfig = {
     invoiceRoot: WithOptions;
     invoiceCard: WithOptions;
     invoiceHeader: WithOptions;
+    invoiceHeaderContent: WithOptions;
     invoiceTitle: WithOptions;
+    invoiceHeaderTitleBadgeContainer: WithOptions;
+    invoiceTitleIdContainer: WithOptions;
+    invoiceId: WithOptions;
+    invoiceIdContainer: WithOptions;
     invoiceBadge: WithOptions;
     invoiceDetails: WithOptions;
     invoiceDetailsItem: WithOptions;
     invoiceDetailsItemTitle: WithOptions;
+    invoiceDetailsItemTitleText: WithOptions;
     invoiceDetailsItemValue: WithOptions;
+    invoiceDetailsItemValueText: WithOptions;
+    invoiceCopyButton: WithOptions;
     invoiceContent: WithOptions;
     menuButton: WithOptions<MenuId>;
     menuButtonEllipsis: WithOptions;
@@ -3973,7 +3983,7 @@ type InstanceType = 'production' | 'development';
 type LocalizationValue = string;
 /**
  * A type containing all the possible localization keys the prebuilt Clerk components support.
- * Users aiming to customise a few strings can also peak at the `data-localization-key` attribute by inspecting
+ * Users aiming to customize a few strings can also peak at the `data-localization-key` attribute by inspecting
  * the DOM and updating the corresponding key.
  * Users aiming to completely localize the components by providing a complete translation can use
  * the default english resource object from {@link https://github.com/clerk/javascript Clerk's open source repo}
@@ -6545,7 +6555,7 @@ type UseSessionReturn = {
      */
     isSignedIn: undefined;
     /**
-     * Holds the current active session for the user.
+     * The current active session for the user.
      */
     session: undefined;
 } | {
@@ -6591,7 +6601,7 @@ type UseUserReturn = {
      */
     isSignedIn: undefined;
     /**
-     * The `User` object for the current user. If the user isn't signed in, `user` will be `null`.
+     * The `User` object for the current user.
      */
     user: undefined;
 } | {
@@ -6619,7 +6629,7 @@ type PublishableKey = {
  */
 type MultiDomainAndOrProxy = {
     /**
-     * Whether the application is a satellite application.
+     * A boolean that indicates whether the application is a satellite application.
      */
     isSatellite?: never;
     /**
@@ -6641,7 +6651,7 @@ type MultiDomainAndOrProxy = {
 };
 type MultiDomainAndOrProxyPrimitives = {
     /**
-     * Whether the application is a satellite application.
+     * A boolean that indicates whether the application is a satellite application.
      */
     isSatellite?: never;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clerk/types",
-  "version": "4.54.2-snapshot.v20250417032557",
+  "version": "4.54.2",
   "description": "Typings for Clerk libraries.",
   "keywords": [
     "clerk",