@clerk/types 4.60.0-snapshot.v20250604034807 → 4.60.0

package/dist/index.d.mts

@@ -862,11 +862,26 @@ interface SessionVerificationResource extends ClerkResource {
     supportedSecondFactors: SessionVerificationSecondFactor[] | null;
 }
 type SessionVerificationStatus = 'needs_first_factor' | 'needs_second_factor' | 'complete';
+/**
+ * @inline
+ */
 type SessionVerificationTypes = 'strict_mfa' | 'strict' | 'moderate' | 'lax';
+/**
+ * The `ReverificationConfig` type has the following properties:
+ */
 type ReverificationConfig = SessionVerificationTypes | {
+    /**
+     * The reverification level of credentials to check for.
+     */
     level: SessionVerificationLevel;
+    /**
+     * The age of the factor level to check for. Value should be greater than or equal to 1 and less than 99,999.
+     */
     afterMinutes: SessionVerificationAfterMinutes;
 };
+/**
+ * @inline
+ */
 type SessionVerificationLevel = 'first_factor' | 'second_factor' | 'multi_factor';
 type SessionVerificationAfterMinutes = number;
 type SessionVerificationFirstFactor = EmailCodeFactor | PhoneCodeFactor | PasswordFactor | PasskeyFactor;
@@ -1362,12 +1377,27 @@ type CheckAuthorizationFn<Params> = (isAuthorizedParams: Params) => boolean;
 /** @inline */
 type CheckAuthorizationWithCustomPermissions = CheckAuthorizationFn<CheckAuthorizationParamsWithCustomPermissions>;
 type WithReverification<T> = T & {
+    /**
+     * The reverification configuration to check for. This feature is currently in public beta. **It is not recommended for production use.**
+     */
     reverification?: ReverificationConfig;
 };
 type CheckAuthorizationParamsWithCustomPermissions = WithReverification<{
+    /**
+     * The [role](https://clerk.com/docs/organizations/roles-permissions) to check for.
+     */
     role: OrganizationCustomRoleKey;
+    /**
+     * The [permission](https://clerk.com/docs/organizations/roles-permissions) to check for.
+     */
     permission?: never;
+    /**
+     * The [feature](https://clerk.com/docs/billing/overview) to check for.
+     */
     feature?: never;
+    /**
+     * The [plan](https://clerk.com/docs/billing/overview) to check for.
+     */
     plan?: never;
 } | {
     role?: never;
@@ -1392,9 +1422,21 @@ type CheckAuthorizationParamsWithCustomPermissions = WithReverification<{
 }>;
 type CheckAuthorization = CheckAuthorizationFn<CheckAuthorizationParams>;
 type CheckAuthorizationParams = WithReverification<{
+    /**
+     * The [role](https://clerk.com/docs/organizations/roles-permissions) to check for.
+     */
     role: OrganizationCustomRoleKey;
+    /**
+     * The [permission](https://clerk.com/docs/organizations/roles-permissions) to check for.
+     */
     permission?: never;
+    /**
+     * The [feature](https://clerk.com/docs/billing/overview) to check for.
+     */
     feature?: never;
+    /**
+     * The [plan](https://clerk.com/docs/billing/overview) to check for.
+     */
     plan?: never;
 } | {
     role?: never;
@@ -1423,10 +1465,25 @@ type CheckAuthorizationParams = WithReverification<{
  * in session claims and cannot be verified on the server side.
  */
 type CheckAuthorizationFromSessionClaims = <P extends OrganizationCustomPermissionKey>(isAuthorizedParams: CheckAuthorizationParamsFromSessionClaims<P>) => boolean;
+/**
+ * @interface
+ */
 type CheckAuthorizationParamsFromSessionClaims<P extends OrganizationCustomPermissionKey> = WithReverification<{
+    /**
+     * The [role](https://clerk.com/docs/organizations/roles-permissions) to check for.
+     */
     role: OrganizationCustomRoleKey;
+    /**
+     * The [permission](https://clerk.com/docs/organizations/roles-permissions) to check for.
+     */
     permission?: never;
+    /**
+     * The [feature](https://clerk.com/docs/billing/overview) to check for.
+     */
     feature?: never;
+    /**
+     * The [plan](https://clerk.com/docs/billing/overview) to check for.
+     */
     plan?: never;
 } | {
     role?: never;
@@ -1942,7 +1999,7 @@ interface ActClaim {
     [x: string]: unknown;
 }
 /**
- * Session status
+ * The current state of the session which can only be `active` or `pending`.
  */
 type SessionStatusClaim = Extract<SessionStatus, 'active' | 'pending'>;
 
@@ -7131,19 +7188,44 @@ type InitialState = Serializable<{
  * @internal
  */
 type SharedSignedInAuthObjectProperties = {
+    /**
+     * The current user's [session claims](https://clerk.com/docs/backend-requests/resources/session-tokens).
+     */
     sessionClaims: JwtPayload;
+    /**
+     * The ID of the current session.
+     */
     sessionId: string;
+    /**
+     * The current state of the session.
+     */
     sessionStatus: SessionStatusClaim | null;
+    /**
+     * Holds identifier for the user that is impersonating the current user. Read more about [impersonation](https://clerk.com/docs/users/user-impersonation).
+     */
     actor: ActClaim | undefined;
+    /**
+     * The ID of the current user.
+     */
     userId: string;
+    /**
+     * The ID of the user's active organization.
+     */
     orgId: string | undefined;
+    /**
+     * The current user's role in their active organization.
+     */
     orgRole: OrganizationCustomRoleKey | undefined;
+    /**
+     * The URL-friendly identifier of the user's active organization.
+     */
     orgSlug: string | undefined;
+    /**
+     * The current user's active organization permissions.
+     */
     orgPermissions: OrganizationCustomPermissionKey[] | undefined;
     /**
-     * Factor Verification Age
-     * Each item represents the minutes that have passed since the last time a first or second factor were verified.
-     * [fistFactorAge, secondFactorAge]
+     * An array where each item represents the number of minutes since the last verification of a first or second factor: `[firstFactorAge, secondFactorAge]`.
      */
     factorVerificationAge: [firstFactorAge: number, secondFactorAge: number] | null;
 };

package/dist/index.d.ts

@@ -862,11 +862,26 @@ interface SessionVerificationResource extends ClerkResource {
     supportedSecondFactors: SessionVerificationSecondFactor[] | null;
 }
 type SessionVerificationStatus = 'needs_first_factor' | 'needs_second_factor' | 'complete';
+/**
+ * @inline
+ */
 type SessionVerificationTypes = 'strict_mfa' | 'strict' | 'moderate' | 'lax';
+/**
+ * The `ReverificationConfig` type has the following properties:
+ */
 type ReverificationConfig = SessionVerificationTypes | {
+    /**
+     * The reverification level of credentials to check for.
+     */
     level: SessionVerificationLevel;
+    /**
+     * The age of the factor level to check for. Value should be greater than or equal to 1 and less than 99,999.
+     */
     afterMinutes: SessionVerificationAfterMinutes;
 };
+/**
+ * @inline
+ */
 type SessionVerificationLevel = 'first_factor' | 'second_factor' | 'multi_factor';
 type SessionVerificationAfterMinutes = number;
 type SessionVerificationFirstFactor = EmailCodeFactor | PhoneCodeFactor | PasswordFactor | PasskeyFactor;
@@ -1362,12 +1377,27 @@ type CheckAuthorizationFn<Params> = (isAuthorizedParams: Params) => boolean;
 /** @inline */
 type CheckAuthorizationWithCustomPermissions = CheckAuthorizationFn<CheckAuthorizationParamsWithCustomPermissions>;
 type WithReverification<T> = T & {
+    /**
+     * The reverification configuration to check for. This feature is currently in public beta. **It is not recommended for production use.**
+     */
     reverification?: ReverificationConfig;
 };
 type CheckAuthorizationParamsWithCustomPermissions = WithReverification<{
+    /**
+     * The [role](https://clerk.com/docs/organizations/roles-permissions) to check for.
+     */
     role: OrganizationCustomRoleKey;
+    /**
+     * The [permission](https://clerk.com/docs/organizations/roles-permissions) to check for.
+     */
     permission?: never;
+    /**
+     * The [feature](https://clerk.com/docs/billing/overview) to check for.
+     */
     feature?: never;
+    /**
+     * The [plan](https://clerk.com/docs/billing/overview) to check for.
+     */
     plan?: never;
 } | {
     role?: never;
@@ -1392,9 +1422,21 @@ type CheckAuthorizationParamsWithCustomPermissions = WithReverification<{
 }>;
 type CheckAuthorization = CheckAuthorizationFn<CheckAuthorizationParams>;
 type CheckAuthorizationParams = WithReverification<{
+    /**
+     * The [role](https://clerk.com/docs/organizations/roles-permissions) to check for.
+     */
     role: OrganizationCustomRoleKey;
+    /**
+     * The [permission](https://clerk.com/docs/organizations/roles-permissions) to check for.
+     */
     permission?: never;
+    /**
+     * The [feature](https://clerk.com/docs/billing/overview) to check for.
+     */
     feature?: never;
+    /**
+     * The [plan](https://clerk.com/docs/billing/overview) to check for.
+     */
     plan?: never;
 } | {
     role?: never;
@@ -1423,10 +1465,25 @@ type CheckAuthorizationParams = WithReverification<{
  * in session claims and cannot be verified on the server side.
  */
 type CheckAuthorizationFromSessionClaims = <P extends OrganizationCustomPermissionKey>(isAuthorizedParams: CheckAuthorizationParamsFromSessionClaims<P>) => boolean;
+/**
+ * @interface
+ */
 type CheckAuthorizationParamsFromSessionClaims<P extends OrganizationCustomPermissionKey> = WithReverification<{
+    /**
+     * The [role](https://clerk.com/docs/organizations/roles-permissions) to check for.
+     */
     role: OrganizationCustomRoleKey;
+    /**
+     * The [permission](https://clerk.com/docs/organizations/roles-permissions) to check for.
+     */
     permission?: never;
+    /**
+     * The [feature](https://clerk.com/docs/billing/overview) to check for.
+     */
     feature?: never;
+    /**
+     * The [plan](https://clerk.com/docs/billing/overview) to check for.
+     */
     plan?: never;
 } | {
     role?: never;
@@ -1942,7 +1999,7 @@ interface ActClaim {
     [x: string]: unknown;
 }
 /**
- * Session status
+ * The current state of the session which can only be `active` or `pending`.
  */
 type SessionStatusClaim = Extract<SessionStatus, 'active' | 'pending'>;
 
@@ -7131,19 +7188,44 @@ type InitialState = Serializable<{
  * @internal
  */
 type SharedSignedInAuthObjectProperties = {
+    /**
+     * The current user's [session claims](https://clerk.com/docs/backend-requests/resources/session-tokens).
+     */
     sessionClaims: JwtPayload;
+    /**
+     * The ID of the current session.
+     */
     sessionId: string;
+    /**
+     * The current state of the session.
+     */
     sessionStatus: SessionStatusClaim | null;
+    /**
+     * Holds identifier for the user that is impersonating the current user. Read more about [impersonation](https://clerk.com/docs/users/user-impersonation).
+     */
     actor: ActClaim | undefined;
+    /**
+     * The ID of the current user.
+     */
     userId: string;
+    /**
+     * The ID of the user's active organization.
+     */
     orgId: string | undefined;
+    /**
+     * The current user's role in their active organization.
+     */
     orgRole: OrganizationCustomRoleKey | undefined;
+    /**
+     * The URL-friendly identifier of the user's active organization.
+     */
     orgSlug: string | undefined;
+    /**
+     * The current user's active organization permissions.
+     */
     orgPermissions: OrganizationCustomPermissionKey[] | undefined;
     /**
-     * Factor Verification Age
-     * Each item represents the minutes that have passed since the last time a first or second factor were verified.
-     * [fistFactorAge, secondFactorAge]
+     * An array where each item represents the number of minutes since the last verification of a first or second factor: `[firstFactorAge, secondFactorAge]`.
      */
     factorVerificationAge: [firstFactorAge: number, secondFactorAge: number] | null;
 };

package/package.json

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