@clerk/types 4.54.0-snapshot.v20250414153812 → 4.54.0

package/dist/index.d.mts

@@ -469,6 +469,10 @@ type OrganizationDomainVerificationStatus = 'unverified' | 'verified';
  * @inline
  */
 type OrganizationEnrollmentMode = 'manual_invitation' | 'automatic_invitation' | 'automatic_suggestion';
+/**
+ * The `OrganizationDomain` object is the model around an organization domain.
+ * @interface
+ */
 interface OrganizationDomainResource extends ClerkResource {
     id: string;
     name: string;
@@ -508,6 +512,10 @@ declare global {
         [k: string]: unknown;
     }
 }
+/**
+ * The `OrganizationInvitation` object is the model around an organization invitation.
+ * @interface
+ */
 interface OrganizationInvitationResource extends ClerkResource {
     id: string;
     emailAddress: string;
@@ -997,6 +1005,10 @@ interface ImageResource extends ClerkResource {
  * @inline
  */
 type OrganizationSuggestionStatus = 'pending' | 'accepted';
+/**
+ * An interface representing an organization suggestion.
+ * @interface
+ */
 interface OrganizationSuggestionResource extends ClerkResource {
     id: string;
     publicOrganizationData: {
@@ -1090,6 +1102,10 @@ declare global {
         [k: string]: unknown;
     }
 }
+/**
+ * The `OrganizationInvitation` object is the model around an organization invitation.
+ * @interface
+ */
 interface UserOrganizationInvitationResource extends ClerkResource {
     id: string;
     emailAddress: string;
@@ -1510,6 +1526,10 @@ type SessionVerifyAttemptFirstFactorParams = EmailCodeAttempt | PhoneCodeAttempt
 type SessionVerifyPrepareSecondFactorParams = PhoneCodeSecondFactorConfig;
 type SessionVerifyAttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt;
 
+/**
+ * The `OrganizationMembershipRequest` object is the model that describes the request of a user to join an organization.
+ * @interface
+ */
 interface OrganizationMembershipRequestResource extends ClerkResource {
     id: string;
     organizationId: string;
@@ -1559,6 +1579,13 @@ declare global {
         [k: string]: unknown;
     }
 }
+/**
+ * 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/organizations/overview#enable-organizations-in-your-application).
+ *
+ * @interface
+ */
 interface OrganizationResource extends ClerkResource {
     id: string;
     name: string;
@@ -1661,6 +1688,10 @@ declare global {
         [k: string]: unknown;
     }
 }
+/**
+ * The `OrganizationMembership` object is the model around an organization membership entity and describes the relationship between users and organizations.
+ * @interface
+ */
 interface OrganizationMembershipResource extends ClerkResource {
     id: string;
     organization: OrganizationResource;
@@ -1672,6 +1703,9 @@ interface OrganizationMembershipResource extends ClerkResource {
     updatedAt: Date;
     destroy: () => Promise<OrganizationMembershipResource>;
     update: (updateParams: UpdateOrganizationMembershipParams) => Promise<OrganizationMembershipResource>;
+    /**
+     * @internal
+     */
     __internal_toSnapshot: () => OrganizationMembershipJSONSnapshot;
 }
 type OrganizationCustomPermissionKey = ClerkAuthorization extends Placeholder ? ClerkAuthorization['permission'] extends string ? ClerkAuthorization['permission'] : Base['permission'] : Base['permission'];
@@ -3016,12 +3050,16 @@ interface __experimental_CommerceCheckoutJSON extends ClerkResourceJSON {
 }
 
 interface __experimental_CommerceSettingsJSON extends ClerkResourceJSON {
-    enabled: boolean;
-    stripe_publishable_key: string;
+    billing: {
+        enabled: boolean;
+        stripe_publishable_key: string;
+    };
 }
 interface __experimental_CommerceSettingsResource extends ClerkResource {
-    enabled: boolean;
-    stripePublishableKey: string;
+    billing: {
+        enabled: boolean;
+        stripePublishableKey: string;
+    };
     __internal_toSnapshot: () => __experimental_CommerceSettingsJSONSnapshot;
 }
 
@@ -3861,7 +3899,6 @@ interface ClientResource extends ClerkResource {
     signIn: SignInResource;
     isNew: () => boolean;
     create: () => Promise<ClientResource>;
-    sendCaptchaToken: (params: unknown) => Promise<ClientResource>;
     destroy: () => Promise<void>;
     removeSessions: () => Promise<ClientResource>;
     clearCache: () => void;
@@ -3874,6 +3911,7 @@ interface ClientResource extends ClerkResource {
     cookieExpiresAt: Date | null;
     createdAt: Date | null;
     updatedAt: Date | null;
+    __internal_sendCaptchaToken: (params: unknown) => Promise<ClientResource>;
     __internal_toSnapshot: () => ClientJSONSnapshot;
     /**
      * @deprecated Use `signedInSessions` instead
@@ -5515,11 +5553,11 @@ type ClerkOptionsNavigation = {
 };
 type ClerkOptions = PendingSessionOptions & ClerkOptionsNavigation & SignInForceRedirectUrl & SignInFallbackRedirectUrl & SignUpForceRedirectUrl & SignUpFallbackRedirectUrl & LegacyRedirectProps & AfterSignOutUrl & AfterMultiSessionSingleSignOutUrl & {
     /**
-     * Optional object to style your components. Will only affect [Clerk Components](https://clerk.com/docs/components/overview) and not [Account Portal](https://clerk.com/docs/customization/account-portal/overview) pages.
+     * Optional object to style your components. Will only affect [Clerk Components](https://clerk.com/docs/components/overview) and not [Account Portal](https://clerk.com/docs/account-portal/overview) pages.
      */
     appearance?: Appearance;
     /**
-     * Optional object to localize your components. Will only affect [Clerk Components](https://clerk.com/docs/components/overview) and not [Account Portal](https://clerk.com/docs/customization/account-portal/overview) pages.
+     * Optional object to localize your components. Will only affect [Clerk Components](https://clerk.com/docs/components/overview) and not [Account Portal](https://clerk.com/docs/account-portal/overview) pages.
      */
     localization?: LocalizationResource;
     polling?: boolean;
@@ -5532,7 +5570,7 @@ type ClerkOptions = PendingSessionOptions & ClerkOptionsNavigation & SignInForce
      */
     standardBrowser?: boolean;
     /**
-     * Optional support email for display in authentication screens. Will only affect [Clerk Components](https://clerk.com/docs/components/overview) and not [Account Portal](https://clerk.com/docs/customization/account-portal/overview) pages.
+     * Optional support email for display in authentication screens. Will only affect [Clerk Components](https://clerk.com/docs/components/overview) and not [Account Portal](https://clerk.com/docs/account-portal/overview) pages.
      */
     supportEmail?: string;
     /**
@@ -6228,7 +6266,6 @@ type CreateBulkOrganizationInvitationParams = {
     role: OrganizationCustomRoleKey;
 };
 /**
- * Parameters for the `createOrganization()` method.
  * @interface
  */
 interface CreateOrganizationParams {
@@ -6314,11 +6351,7 @@ type CheckAuthorizationWithoutOrgOrUser = (params: Parameters<CheckAuthorization
 /**
  * @inline
  */
-type UseAuthReturn = 
-/**
- * During initialization
- */
-{
+type UseAuthReturn = {
     /**
      * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
      */
@@ -6367,11 +6400,7 @@ type UseAuthReturn =
      * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
      */
     getToken: GetToken;
-}
-/**
- * When signed out
- */
- | {
+} | {
     isLoaded: true;
     isSignedIn: false;
     userId: null;
@@ -6384,11 +6413,7 @@ type UseAuthReturn =
     has: CheckAuthorizationWithoutOrgOrUser;
     signOut: SignOut;
     getToken: GetToken;
-}
-/**
- * When signed in (no active organization)
- */
- | {
+} | {
     isLoaded: true;
     isSignedIn: true;
     userId: string;
@@ -6401,11 +6426,7 @@ type UseAuthReturn =
     has: CheckAuthorizationWithCustomPermissions;
     signOut: SignOut;
     getToken: GetToken;
-}
-/**
- * When signed in (with active organization)
- */
- | {
+} | {
     isLoaded: true;
     isSignedIn: true;
     userId: string;

package/dist/index.d.ts

@@ -469,6 +469,10 @@ type OrganizationDomainVerificationStatus = 'unverified' | 'verified';
  * @inline
  */
 type OrganizationEnrollmentMode = 'manual_invitation' | 'automatic_invitation' | 'automatic_suggestion';
+/**
+ * The `OrganizationDomain` object is the model around an organization domain.
+ * @interface
+ */
 interface OrganizationDomainResource extends ClerkResource {
     id: string;
     name: string;
@@ -508,6 +512,10 @@ declare global {
         [k: string]: unknown;
     }
 }
+/**
+ * The `OrganizationInvitation` object is the model around an organization invitation.
+ * @interface
+ */
 interface OrganizationInvitationResource extends ClerkResource {
     id: string;
     emailAddress: string;
@@ -997,6 +1005,10 @@ interface ImageResource extends ClerkResource {
  * @inline
  */
 type OrganizationSuggestionStatus = 'pending' | 'accepted';
+/**
+ * An interface representing an organization suggestion.
+ * @interface
+ */
 interface OrganizationSuggestionResource extends ClerkResource {
     id: string;
     publicOrganizationData: {
@@ -1090,6 +1102,10 @@ declare global {
         [k: string]: unknown;
     }
 }
+/**
+ * The `OrganizationInvitation` object is the model around an organization invitation.
+ * @interface
+ */
 interface UserOrganizationInvitationResource extends ClerkResource {
     id: string;
     emailAddress: string;
@@ -1510,6 +1526,10 @@ type SessionVerifyAttemptFirstFactorParams = EmailCodeAttempt | PhoneCodeAttempt
 type SessionVerifyPrepareSecondFactorParams = PhoneCodeSecondFactorConfig;
 type SessionVerifyAttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt;
 
+/**
+ * The `OrganizationMembershipRequest` object is the model that describes the request of a user to join an organization.
+ * @interface
+ */
 interface OrganizationMembershipRequestResource extends ClerkResource {
     id: string;
     organizationId: string;
@@ -1559,6 +1579,13 @@ declare global {
         [k: string]: unknown;
     }
 }
+/**
+ * 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/organizations/overview#enable-organizations-in-your-application).
+ *
+ * @interface
+ */
 interface OrganizationResource extends ClerkResource {
     id: string;
     name: string;
@@ -1661,6 +1688,10 @@ declare global {
         [k: string]: unknown;
     }
 }
+/**
+ * The `OrganizationMembership` object is the model around an organization membership entity and describes the relationship between users and organizations.
+ * @interface
+ */
 interface OrganizationMembershipResource extends ClerkResource {
     id: string;
     organization: OrganizationResource;
@@ -1672,6 +1703,9 @@ interface OrganizationMembershipResource extends ClerkResource {
     updatedAt: Date;
     destroy: () => Promise<OrganizationMembershipResource>;
     update: (updateParams: UpdateOrganizationMembershipParams) => Promise<OrganizationMembershipResource>;
+    /**
+     * @internal
+     */
     __internal_toSnapshot: () => OrganizationMembershipJSONSnapshot;
 }
 type OrganizationCustomPermissionKey = ClerkAuthorization extends Placeholder ? ClerkAuthorization['permission'] extends string ? ClerkAuthorization['permission'] : Base['permission'] : Base['permission'];
@@ -3016,12 +3050,16 @@ interface __experimental_CommerceCheckoutJSON extends ClerkResourceJSON {
 }
 
 interface __experimental_CommerceSettingsJSON extends ClerkResourceJSON {
-    enabled: boolean;
-    stripe_publishable_key: string;
+    billing: {
+        enabled: boolean;
+        stripe_publishable_key: string;
+    };
 }
 interface __experimental_CommerceSettingsResource extends ClerkResource {
-    enabled: boolean;
-    stripePublishableKey: string;
+    billing: {
+        enabled: boolean;
+        stripePublishableKey: string;
+    };
     __internal_toSnapshot: () => __experimental_CommerceSettingsJSONSnapshot;
 }
 
@@ -3861,7 +3899,6 @@ interface ClientResource extends ClerkResource {
     signIn: SignInResource;
     isNew: () => boolean;
     create: () => Promise<ClientResource>;
-    sendCaptchaToken: (params: unknown) => Promise<ClientResource>;
     destroy: () => Promise<void>;
     removeSessions: () => Promise<ClientResource>;
     clearCache: () => void;
@@ -3874,6 +3911,7 @@ interface ClientResource extends ClerkResource {
     cookieExpiresAt: Date | null;
     createdAt: Date | null;
     updatedAt: Date | null;
+    __internal_sendCaptchaToken: (params: unknown) => Promise<ClientResource>;
     __internal_toSnapshot: () => ClientJSONSnapshot;
     /**
      * @deprecated Use `signedInSessions` instead
@@ -5515,11 +5553,11 @@ type ClerkOptionsNavigation = {
 };
 type ClerkOptions = PendingSessionOptions & ClerkOptionsNavigation & SignInForceRedirectUrl & SignInFallbackRedirectUrl & SignUpForceRedirectUrl & SignUpFallbackRedirectUrl & LegacyRedirectProps & AfterSignOutUrl & AfterMultiSessionSingleSignOutUrl & {
     /**
-     * Optional object to style your components. Will only affect [Clerk Components](https://clerk.com/docs/components/overview) and not [Account Portal](https://clerk.com/docs/customization/account-portal/overview) pages.
+     * Optional object to style your components. Will only affect [Clerk Components](https://clerk.com/docs/components/overview) and not [Account Portal](https://clerk.com/docs/account-portal/overview) pages.
      */
     appearance?: Appearance;
     /**
-     * Optional object to localize your components. Will only affect [Clerk Components](https://clerk.com/docs/components/overview) and not [Account Portal](https://clerk.com/docs/customization/account-portal/overview) pages.
+     * Optional object to localize your components. Will only affect [Clerk Components](https://clerk.com/docs/components/overview) and not [Account Portal](https://clerk.com/docs/account-portal/overview) pages.
      */
     localization?: LocalizationResource;
     polling?: boolean;
@@ -5532,7 +5570,7 @@ type ClerkOptions = PendingSessionOptions & ClerkOptionsNavigation & SignInForce
      */
     standardBrowser?: boolean;
     /**
-     * Optional support email for display in authentication screens. Will only affect [Clerk Components](https://clerk.com/docs/components/overview) and not [Account Portal](https://clerk.com/docs/customization/account-portal/overview) pages.
+     * Optional support email for display in authentication screens. Will only affect [Clerk Components](https://clerk.com/docs/components/overview) and not [Account Portal](https://clerk.com/docs/account-portal/overview) pages.
      */
     supportEmail?: string;
     /**
@@ -6228,7 +6266,6 @@ type CreateBulkOrganizationInvitationParams = {
     role: OrganizationCustomRoleKey;
 };
 /**
- * Parameters for the `createOrganization()` method.
  * @interface
  */
 interface CreateOrganizationParams {
@@ -6314,11 +6351,7 @@ type CheckAuthorizationWithoutOrgOrUser = (params: Parameters<CheckAuthorization
 /**
  * @inline
  */
-type UseAuthReturn = 
-/**
- * During initialization
- */
-{
+type UseAuthReturn = {
     /**
      * A boolean that indicates whether Clerk has completed initialization. Initially `false`, becomes `true` once Clerk loads.
      */
@@ -6367,11 +6400,7 @@ type UseAuthReturn =
      * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/references/javascript/session#get-token).
      */
     getToken: GetToken;
-}
-/**
- * When signed out
- */
- | {
+} | {
     isLoaded: true;
     isSignedIn: false;
     userId: null;
@@ -6384,11 +6413,7 @@ type UseAuthReturn =
     has: CheckAuthorizationWithoutOrgOrUser;
     signOut: SignOut;
     getToken: GetToken;
-}
-/**
- * When signed in (no active organization)
- */
- | {
+} | {
     isLoaded: true;
     isSignedIn: true;
     userId: string;
@@ -6401,11 +6426,7 @@ type UseAuthReturn =
     has: CheckAuthorizationWithCustomPermissions;
     signOut: SignOut;
     getToken: GetToken;
-}
-/**
- * When signed in (with active organization)
- */
- | {
+} | {
     isLoaded: true;
     isSignedIn: true;
     userId: string;

package/package.json

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