@clerk/shared 4.25.6-snapshot.v20260720201619 → 4.25.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/dist/loadClerkJsScript.js +1 -1
  2. package/dist/loadClerkJsScript.js.map +1 -1
  3. package/dist/loadClerkJsScript.mjs +1 -1
  4. package/dist/loadClerkJsScript.mjs.map +1 -1
  5. package/dist/react/billing/payment-element.d.mts +1 -1
  6. package/dist/react/billing/payment-element.d.ts +1 -1
  7. package/dist/react/contexts.d.mts +1 -1
  8. package/dist/react/contexts.d.ts +1 -1
  9. package/dist/react/hooks/useOAuthConsent.d.mts +1 -1
  10. package/dist/react/hooks/useOAuthConsent.d.ts +1 -1
  11. package/dist/react/hooks/useOAuthConsent.js +1 -1
  12. package/dist/react/hooks/useOrganization.d.mts +1 -1
  13. package/dist/react/hooks/useOrganization.d.ts +1 -1
  14. package/dist/react/hooks/useOrganizationList.d.mts +1 -1
  15. package/dist/react/hooks/useOrganizationList.d.ts +1 -1
  16. package/dist/react/index.js +1 -1
  17. package/dist/react/index.js.map +1 -1
  18. package/dist/react/index.mjs +1 -1
  19. package/dist/react/index.mjs.map +1 -1
  20. package/dist/types/billing.d.mts +9 -9
  21. package/dist/types/billing.d.ts +9 -9
  22. package/dist/types/clerk.d.mts +10 -6
  23. package/dist/types/clerk.d.ts +10 -6
  24. package/dist/types/enterpriseConnection.d.mts +1 -1
  25. package/dist/types/enterpriseConnection.d.ts +1 -1
  26. package/dist/types/hooks.d.mts +6 -6
  27. package/dist/types/hooks.d.ts +6 -6
  28. package/dist/types/json.d.mts +5 -5
  29. package/dist/types/json.d.ts +5 -5
  30. package/dist/types/localization.d.mts +1 -1
  31. package/dist/types/localization.d.ts +1 -1
  32. package/dist/types/organizationDomain.d.mts +1 -1
  33. package/dist/types/organizationDomain.d.ts +1 -1
  34. package/dist/types/redirects.d.mts +1 -1
  35. package/dist/types/redirects.d.ts +1 -1
  36. package/dist/types/session.d.mts +3 -3
  37. package/dist/types/session.d.ts +3 -3
  38. package/dist/versionSelector.js +1 -1
  39. package/dist/versionSelector.js.map +1 -1
  40. package/dist/versionSelector.mjs +1 -1
  41. package/dist/versionSelector.mjs.map +1 -1
  42. package/package.json +1 -1
@@ -230,7 +230,7 @@ interface BillingPlanResource extends ClerkResource {
230
230
  */
231
231
  features: FeatureResource[];
232
232
  /**
233
- * Per-unit pricing tiers for this Plan (for example, seats).
233
+ * Per-unit pricing tiers for this Plan (e.g., seats).
234
234
  */
235
235
  unitPrices?: BillingPlanUnitPrice[];
236
236
  /**
@@ -286,7 +286,7 @@ interface BillingPlanUnitPriceTier {
286
286
  feePerBlock: BillingMoneyAmount;
287
287
  }
288
288
  /**
289
- * The `BillingPlanUnitPrice` type represents unit pricing for a specific unit type (for example, seats) on a plan.
289
+ * The `BillingPlanUnitPrice` type represents unit pricing for a specific unit type (e.g., seats) on a plan.
290
290
  *
291
291
  * @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.
292
292
  */
@@ -518,7 +518,7 @@ type BillingPaymentChargeType = 'checkout' | 'recurring';
518
518
  type BillingPaymentStatus = 'pending' | 'paid' | 'failed';
519
519
  /**
520
520
  * The `BillingPaymentTotals` type represents the per-payment cost breakdown, including any base fee
521
- * and per-unit (for example, seats) subtotals.
521
+ * and per-unit (e.g., seats) subtotals.
522
522
  *
523
523
  * @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.
524
524
  */
@@ -540,7 +540,7 @@ interface BillingPaymentTotals {
540
540
  */
541
541
  baseFee?: BillingMoneyAmount | null;
542
542
  /**
543
- * Per-unit cost breakdown for this payment (for example, seats).
543
+ * Per-unit cost breakdown for this payment (e.g., seats).
544
544
  */
545
545
  perUnitTotals?: BillingPerUnitTotal[];
546
546
  /**
@@ -591,7 +591,7 @@ interface BillingPaymentResource extends ClerkResource {
591
591
  */
592
592
  status: BillingPaymentStatus;
593
593
  /**
594
- * Per-payment breakdown with optional base fee and per-unit (for example, seats) subtotals.
594
+ * Per-payment breakdown with optional base fee and per-unit (e.g., seats) subtotals.
595
595
  * Absent on older responses.
596
596
  */
597
597
  totals?: BillingPaymentTotals | null;
@@ -698,7 +698,7 @@ interface BillingSubscriptionNextPayment {
698
698
  */
699
699
  date: Date;
700
700
  /**
701
- * Per-unit cost breakdown for the next payment (for example, seats).
701
+ * Per-unit cost breakdown for the next payment (e.g., seats).
702
702
  */
703
703
  perUnitTotals?: BillingPerUnitTotal[];
704
704
  /**
@@ -721,7 +721,7 @@ interface BillingSubscriptionItemNextPayment {
721
721
  */
722
722
  date: Date;
723
723
  /**
724
- * Per-unit cost breakdown for the next payment (for example, seats).
724
+ * Per-unit cost breakdown for the next payment (e.g., seats).
725
725
  */
726
726
  perUnitTotals?: BillingPerUnitTotal[];
727
727
  /**
@@ -1052,7 +1052,7 @@ interface BillingTotals {
1052
1052
  */
1053
1053
  totalDueNow?: BillingMoneyAmount;
1054
1054
  /**
1055
- * Per-unit total breakdown (for example, seats)
1055
+ * Per-unit total breakdown (e.g., seats)
1056
1056
  */
1057
1057
  perUnitTotals?: BillingPerUnitTotal[];
1058
1058
  /**
@@ -1089,7 +1089,7 @@ interface BillingCheckoutTotals {
1089
1089
  */
1090
1090
  taxTotal: BillingMoneyAmount;
1091
1091
  /**
1092
- * Per-unit cost breakdown for items actively being purchased in this checkout (for example, seats being added).
1092
+ * Per-unit cost breakdown for items actively being purchased in this checkout (e.g., seats being added).
1093
1093
  * When only adding seats mid-cycle, this only covers the seats being added, not seats already paid for.
1094
1094
  */
1095
1095
  perUnitTotals?: BillingPerUnitTotal[];
@@ -230,7 +230,7 @@ interface BillingPlanResource extends ClerkResource {
230
230
  */
231
231
  features: FeatureResource[];
232
232
  /**
233
- * Per-unit pricing tiers for this Plan (for example, seats).
233
+ * Per-unit pricing tiers for this Plan (e.g., seats).
234
234
  */
235
235
  unitPrices?: BillingPlanUnitPrice[];
236
236
  /**
@@ -286,7 +286,7 @@ interface BillingPlanUnitPriceTier {
286
286
  feePerBlock: BillingMoneyAmount;
287
287
  }
288
288
  /**
289
- * The `BillingPlanUnitPrice` type represents unit pricing for a specific unit type (for example, seats) on a plan.
289
+ * The `BillingPlanUnitPrice` type represents unit pricing for a specific unit type (e.g., seats) on a plan.
290
290
  *
291
291
  * @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.
292
292
  */
@@ -518,7 +518,7 @@ type BillingPaymentChargeType = 'checkout' | 'recurring';
518
518
  type BillingPaymentStatus = 'pending' | 'paid' | 'failed';
519
519
  /**
520
520
  * The `BillingPaymentTotals` type represents the per-payment cost breakdown, including any base fee
521
- * and per-unit (for example, seats) subtotals.
521
+ * and per-unit (e.g., seats) subtotals.
522
522
  *
523
523
  * @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.
524
524
  */
@@ -540,7 +540,7 @@ interface BillingPaymentTotals {
540
540
  */
541
541
  baseFee?: BillingMoneyAmount | null;
542
542
  /**
543
- * Per-unit cost breakdown for this payment (for example, seats).
543
+ * Per-unit cost breakdown for this payment (e.g., seats).
544
544
  */
545
545
  perUnitTotals?: BillingPerUnitTotal[];
546
546
  /**
@@ -591,7 +591,7 @@ interface BillingPaymentResource extends ClerkResource {
591
591
  */
592
592
  status: BillingPaymentStatus;
593
593
  /**
594
- * Per-payment breakdown with optional base fee and per-unit (for example, seats) subtotals.
594
+ * Per-payment breakdown with optional base fee and per-unit (e.g., seats) subtotals.
595
595
  * Absent on older responses.
596
596
  */
597
597
  totals?: BillingPaymentTotals | null;
@@ -698,7 +698,7 @@ interface BillingSubscriptionNextPayment {
698
698
  */
699
699
  date: Date;
700
700
  /**
701
- * Per-unit cost breakdown for the next payment (for example, seats).
701
+ * Per-unit cost breakdown for the next payment (e.g., seats).
702
702
  */
703
703
  perUnitTotals?: BillingPerUnitTotal[];
704
704
  /**
@@ -721,7 +721,7 @@ interface BillingSubscriptionItemNextPayment {
721
721
  */
722
722
  date: Date;
723
723
  /**
724
- * Per-unit cost breakdown for the next payment (for example, seats).
724
+ * Per-unit cost breakdown for the next payment (e.g., seats).
725
725
  */
726
726
  perUnitTotals?: BillingPerUnitTotal[];
727
727
  /**
@@ -1052,7 +1052,7 @@ interface BillingTotals {
1052
1052
  */
1053
1053
  totalDueNow?: BillingMoneyAmount;
1054
1054
  /**
1055
- * Per-unit total breakdown (for example, seats)
1055
+ * Per-unit total breakdown (e.g., seats)
1056
1056
  */
1057
1057
  perUnitTotals?: BillingPerUnitTotal[];
1058
1058
  /**
@@ -1089,7 +1089,7 @@ interface BillingCheckoutTotals {
1089
1089
  */
1090
1090
  taxTotal: BillingMoneyAmount;
1091
1091
  /**
1092
- * Per-unit cost breakdown for items actively being purchased in this checkout (for example, seats being added).
1092
+ * Per-unit cost breakdown for items actively being purchased in this checkout (e.g., seats being added).
1093
1093
  * When only adding seats mid-cycle, this only covers the seats being added, not seats already paid for.
1094
1094
  */
1095
1095
  perUnitTotals?: BillingPerUnitTotal[];
@@ -898,7 +898,7 @@ interface Clerk {
898
898
  /**
899
899
  * Redirects to the configured URL where [session tasks](https://clerk.com/docs/reference/objects/session) are mounted.
900
900
  *
901
- * @param opts - Options to control the redirect (e.g. redirect URL after tasks are complete).
901
+ * @param opts - Options to control the redirect (e.g., redirect URL after tasks are complete).
902
902
  */
903
903
  redirectToTasks(opts?: TasksRedirectOptions): Promise<unknown>;
904
904
  /**
@@ -1018,7 +1018,7 @@ interface Clerk {
1018
1018
  */
1019
1019
  apiKeys: APIKeysNamespace;
1020
1020
  /**
1021
- * OAuth application helpers (e.g. consent metadata for custom consent UIs).
1021
+ * OAuth application helpers (e.g., consent metadata for custom consent UIs).
1022
1022
  */
1023
1023
  oauthApplication: OAuthApplicationNamespace;
1024
1024
  /**
@@ -1183,7 +1183,7 @@ type ClerkOptions = ClerkOptionsNavigation & SignInForceRedirectUrl & SignInFall
1183
1183
  */
1184
1184
  polling?: boolean;
1185
1185
  /**
1186
- * 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.
1186
+ * 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.
1187
1187
  */
1188
1188
  selectInitialSession?: (client: ClientResource) => SignedInSessionResource | null;
1189
1189
  /**
@@ -1268,6 +1268,10 @@ type ClerkOptions = ClerkOptionsNavigation & SignInForceRedirectUrl & SignInFall
1268
1268
  * directly with the provided Clerk instance. Used by React Native / Expo.
1269
1269
  */
1270
1270
  runtimeEnvironment: 'headless';
1271
+ /**
1272
+ * Temporary flag that gates the self-serve OIDC flow in `<ConfigureSSO />`. Remove once the self-serve OIDC flow reaches GA.
1273
+ */
1274
+ oidcSelfServe: boolean;
1271
1275
  }, Record<string, any>>;
1272
1276
  /**
1273
1277
  * The URL a developer should be redirected to in order to claim an instance created in Keyless mode.
@@ -1693,7 +1697,7 @@ type UserProfileProps = RoutingOptions & {
1693
1697
  __experimental_startPath?: string;
1694
1698
  /**
1695
1699
  * Specify options for the underlying <APIKeys /> component.
1696
- * e.g. <UserProfile apiKeysProps={{ showDescription: true }} />
1700
+ * e.g., <UserProfile apiKeysProps={{ showDescription: true }} />
1697
1701
  *
1698
1702
  * @experimental
1699
1703
  */
@@ -1737,7 +1741,7 @@ type OrganizationProfileProps = RoutingOptions & {
1737
1741
  __experimental_startPath?: string;
1738
1742
  /**
1739
1743
  * Specify options for the underlying <APIKeys /> component.
1740
- * e.g. <OrganizationProfile apiKeysProps={{ showDescription: true }} />
1744
+ * e.g., <OrganizationProfile apiKeysProps={{ showDescription: true }} />
1741
1745
  *
1742
1746
  * @experimental
1743
1747
  */
@@ -1831,7 +1835,7 @@ type UserButtonProps = UserButtonProfileMode & {
1831
1835
  appearance?: ClerkAppearanceTheme;
1832
1836
  /**
1833
1837
  * Specify options for the underlying <UserProfile /> component.
1834
- * e.g. <UserButton userProfileProps={{additionalOAuthScopes: {google: ['foo', 'bar'], github: ['qux']}}} />
1838
+ * e.g., <UserButton userProfileProps={{additionalOAuthScopes: {google: ['foo', 'bar'], github: ['qux']}}} />
1835
1839
  */
1836
1840
  userProfileProps?: Pick<UserProfileProps, 'additionalOAuthScopes' | 'appearance' | 'customPages' | 'apiKeysProps'>;
1837
1841
  customMenuItems?: CustomMenuItem[];
@@ -898,7 +898,7 @@ interface Clerk {
898
898
  /**
899
899
  * Redirects to the configured URL where [session tasks](https://clerk.com/docs/reference/objects/session) are mounted.
900
900
  *
901
- * @param opts - Options to control the redirect (e.g. redirect URL after tasks are complete).
901
+ * @param opts - Options to control the redirect (e.g., redirect URL after tasks are complete).
902
902
  */
903
903
  redirectToTasks(opts?: TasksRedirectOptions): Promise<unknown>;
904
904
  /**
@@ -1018,7 +1018,7 @@ interface Clerk {
1018
1018
  */
1019
1019
  apiKeys: APIKeysNamespace;
1020
1020
  /**
1021
- * OAuth application helpers (e.g. consent metadata for custom consent UIs).
1021
+ * OAuth application helpers (e.g., consent metadata for custom consent UIs).
1022
1022
  */
1023
1023
  oauthApplication: OAuthApplicationNamespace;
1024
1024
  /**
@@ -1183,7 +1183,7 @@ type ClerkOptions = ClerkOptionsNavigation & SignInForceRedirectUrl & SignInFall
1183
1183
  */
1184
1184
  polling?: boolean;
1185
1185
  /**
1186
- * 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.
1186
+ * 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.
1187
1187
  */
1188
1188
  selectInitialSession?: (client: ClientResource) => SignedInSessionResource | null;
1189
1189
  /**
@@ -1268,6 +1268,10 @@ type ClerkOptions = ClerkOptionsNavigation & SignInForceRedirectUrl & SignInFall
1268
1268
  * directly with the provided Clerk instance. Used by React Native / Expo.
1269
1269
  */
1270
1270
  runtimeEnvironment: 'headless';
1271
+ /**
1272
+ * Temporary flag that gates the self-serve OIDC flow in `<ConfigureSSO />`. Remove once the self-serve OIDC flow reaches GA.
1273
+ */
1274
+ oidcSelfServe: boolean;
1271
1275
  }, Record<string, any>>;
1272
1276
  /**
1273
1277
  * The URL a developer should be redirected to in order to claim an instance created in Keyless mode.
@@ -1693,7 +1697,7 @@ type UserProfileProps = RoutingOptions & {
1693
1697
  __experimental_startPath?: string;
1694
1698
  /**
1695
1699
  * Specify options for the underlying <APIKeys /> component.
1696
- * e.g. <UserProfile apiKeysProps={{ showDescription: true }} />
1700
+ * e.g., <UserProfile apiKeysProps={{ showDescription: true }} />
1697
1701
  *
1698
1702
  * @experimental
1699
1703
  */
@@ -1737,7 +1741,7 @@ type OrganizationProfileProps = RoutingOptions & {
1737
1741
  __experimental_startPath?: string;
1738
1742
  /**
1739
1743
  * Specify options for the underlying <APIKeys /> component.
1740
- * e.g. <OrganizationProfile apiKeysProps={{ showDescription: true }} />
1744
+ * e.g., <OrganizationProfile apiKeysProps={{ showDescription: true }} />
1741
1745
  *
1742
1746
  * @experimental
1743
1747
  */
@@ -1831,7 +1835,7 @@ type UserButtonProps = UserButtonProfileMode & {
1831
1835
  appearance?: ClerkAppearanceTheme;
1832
1836
  /**
1833
1837
  * Specify options for the underlying <UserProfile /> component.
1834
- * e.g. <UserButton userProfileProps={{additionalOAuthScopes: {google: ['foo', 'bar'], github: ['qux']}}} />
1838
+ * e.g., <UserButton userProfileProps={{additionalOAuthScopes: {google: ['foo', 'bar'], github: ['qux']}}} />
1835
1839
  */
1836
1840
  userProfileProps?: Pick<UserProfileProps, 'additionalOAuthScopes' | 'appearance' | 'customPages' | 'apiKeysProps'>;
1837
1841
  customMenuItems?: CustomMenuItem[];
@@ -27,7 +27,7 @@ interface EnterpriseConnectionResource extends ClerkResource {
27
27
  name: string;
28
28
  /** Whether the enterprise connection is active. */
29
29
  active: boolean;
30
- /** The identity provider the connection uses (e.g. `saml_okta`, `oidc_custom`). */
30
+ /** The identity provider the connection uses (e.g., `saml_okta`, `oidc_custom`). */
31
31
  provider: string;
32
32
  /** The public URL of the identity provider's logo, or `null` when none is set. */
33
33
  logoPublicUrl: string | null;
@@ -27,7 +27,7 @@ interface EnterpriseConnectionResource extends ClerkResource {
27
27
  name: string;
28
28
  /** Whether the enterprise connection is active. */
29
29
  active: boolean;
30
- /** The identity provider the connection uses (e.g. `saml_okta`, `oidc_custom`). */
30
+ /** The identity provider the connection uses (e.g., `saml_okta`, `oidc_custom`). */
31
31
  provider: string;
32
32
  /** The public URL of the identity provider's logo, or `null` when none is set. */
33
33
  logoPublicUrl: string | null;
@@ -20,7 +20,7 @@ type CheckAuthorizationSignedOut = CheckAuthorizationWithoutOrgOrUser;
20
20
  */
21
21
  type UseAuthReturn = {
22
22
  /**
23
- * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (for example, when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
23
+ * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (e.g., when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
24
24
  */
25
25
  isLoaded: false;
26
26
  /**
@@ -112,7 +112,7 @@ type UseAuthReturn = {
112
112
  */
113
113
  type UseSignInReturn = {
114
114
  /**
115
- * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (for example, when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
115
+ * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (e.g., when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
116
116
  */
117
117
  isLoaded: false;
118
118
  /**
@@ -133,7 +133,7 @@ type UseSignInReturn = {
133
133
  */
134
134
  type UseSignUpReturn = {
135
135
  /**
136
- * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (for example, when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
136
+ * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (e.g., when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
137
137
  */
138
138
  isLoaded: false;
139
139
  /**
@@ -154,7 +154,7 @@ type UseSignUpReturn = {
154
154
  */
155
155
  type UseSessionReturn = {
156
156
  /**
157
- * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (for example, when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
157
+ * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (e.g., when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
158
158
  */
159
159
  isLoaded: false;
160
160
  /**
@@ -179,7 +179,7 @@ type UseSessionReturn = {
179
179
  */
180
180
  type UseSessionListReturn = {
181
181
  /**
182
- * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (for example, when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
182
+ * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (e.g., when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
183
183
  */
184
184
  isLoaded: false;
185
185
  /**
@@ -200,7 +200,7 @@ type UseSessionListReturn = {
200
200
  */
201
201
  type UseUserReturn = {
202
202
  /**
203
- * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (for example, when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
203
+ * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (e.g., when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
204
204
  */
205
205
  isLoaded: false;
206
206
  /**
@@ -20,7 +20,7 @@ type CheckAuthorizationSignedOut = CheckAuthorizationWithoutOrgOrUser;
20
20
  */
21
21
  type UseAuthReturn = {
22
22
  /**
23
- * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (for example, when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
23
+ * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (e.g., when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
24
24
  */
25
25
  isLoaded: false;
26
26
  /**
@@ -112,7 +112,7 @@ type UseAuthReturn = {
112
112
  */
113
113
  type UseSignInReturn = {
114
114
  /**
115
- * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (for example, when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
115
+ * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (e.g., when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
116
116
  */
117
117
  isLoaded: false;
118
118
  /**
@@ -133,7 +133,7 @@ type UseSignInReturn = {
133
133
  */
134
134
  type UseSignUpReturn = {
135
135
  /**
136
- * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (for example, when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
136
+ * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (e.g., when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
137
137
  */
138
138
  isLoaded: false;
139
139
  /**
@@ -154,7 +154,7 @@ type UseSignUpReturn = {
154
154
  */
155
155
  type UseSessionReturn = {
156
156
  /**
157
- * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (for example, when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
157
+ * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (e.g., when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
158
158
  */
159
159
  isLoaded: false;
160
160
  /**
@@ -179,7 +179,7 @@ type UseSessionReturn = {
179
179
  */
180
180
  type UseSessionListReturn = {
181
181
  /**
182
- * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (for example, when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
182
+ * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (e.g., when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
183
183
  */
184
184
  isLoaded: false;
185
185
  /**
@@ -200,7 +200,7 @@ type UseSessionListReturn = {
200
200
  */
201
201
  type UseUserReturn = {
202
202
  /**
203
- * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (for example, when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
203
+ * Indicates whether Clerk has loaded the current authentication state. Initially `false`, becomes `true` once Clerk loads, and can revert to `false` while auth state is updating (e.g., when switching organizations via [`setActive()`](https://clerk.com/docs/reference/objects/clerk#set-active)).
204
204
  */
205
205
  isLoaded: false;
206
206
  /**
@@ -609,7 +609,7 @@ interface BillingPlanUnitPriceTierJSON extends ClerkResourceJSON {
609
609
  /**
610
610
  * @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.
611
611
  *
612
- * Represents unit pricing for a specific unit type (for example, seats) on a plan.
612
+ * Represents unit pricing for a specific unit type (e.g., seats) on a plan.
613
613
  */
614
614
  interface BillingPlanUnitPriceJSON {
615
615
  name: string;
@@ -668,7 +668,7 @@ interface BillingPlanJSON extends ClerkResourceJSON {
668
668
  free_trial_days?: number | null;
669
669
  free_trial_enabled?: boolean;
670
670
  /**
671
- * Per-unit pricing tiers for this plan (for example, seats).
671
+ * Per-unit pricing tiers for this plan (e.g., seats).
672
672
  */
673
673
  unit_prices?: BillingPlanUnitPriceJSON[];
674
674
  available_prices?: BillingPriceJSON[];
@@ -722,7 +722,7 @@ interface BillingStatementGroupJSON extends ClerkResourceJSON {
722
722
  /**
723
723
  * @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.
724
724
  *
725
- * Per-payment cost breakdown including optional base fee and per-unit (for example, seats) subtotals.
725
+ * Per-payment cost breakdown including optional base fee and per-unit (e.g., seats) subtotals.
726
726
  */
727
727
  interface BillingPaymentTotalsJSON {
728
728
  subtotal: BillingMoneyAmountJSON;
@@ -750,7 +750,7 @@ interface BillingPaymentJSON extends ClerkResourceJSON {
750
750
  charge_type: BillingPaymentChargeType;
751
751
  status: BillingPaymentStatus;
752
752
  /**
753
- * Per-payment breakdown with optional base fee and per-unit (for example, seats)
753
+ * Per-payment breakdown with optional base fee and per-unit (e.g., seats)
754
754
  * subtotals. Absent on older responses.
755
755
  */
756
756
  totals?: BillingPaymentTotalsJSON | null;
@@ -947,7 +947,7 @@ interface BillingCheckoutTotalsJSON {
947
947
  base_fee: BillingMoneyAmountJSON;
948
948
  tax_total: BillingMoneyAmountJSON;
949
949
  /**
950
- * Per-unit cost breakdown for items actively being purchased in this checkout (for example, seats being added).
950
+ * Per-unit cost breakdown for items actively being purchased in this checkout (e.g., seats being added).
951
951
  * When only adding seats mid-cycle, this only covers the seats being added, not seats already paid for.
952
952
  * Omitted when the checkout is not seat-based.
953
953
  */
@@ -609,7 +609,7 @@ interface BillingPlanUnitPriceTierJSON extends ClerkResourceJSON {
609
609
  /**
610
610
  * @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.
611
611
  *
612
- * Represents unit pricing for a specific unit type (for example, seats) on a plan.
612
+ * Represents unit pricing for a specific unit type (e.g., seats) on a plan.
613
613
  */
614
614
  interface BillingPlanUnitPriceJSON {
615
615
  name: string;
@@ -668,7 +668,7 @@ interface BillingPlanJSON extends ClerkResourceJSON {
668
668
  free_trial_days?: number | null;
669
669
  free_trial_enabled?: boolean;
670
670
  /**
671
- * Per-unit pricing tiers for this plan (for example, seats).
671
+ * Per-unit pricing tiers for this plan (e.g., seats).
672
672
  */
673
673
  unit_prices?: BillingPlanUnitPriceJSON[];
674
674
  available_prices?: BillingPriceJSON[];
@@ -722,7 +722,7 @@ interface BillingStatementGroupJSON extends ClerkResourceJSON {
722
722
  /**
723
723
  * @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.
724
724
  *
725
- * Per-payment cost breakdown including optional base fee and per-unit (for example, seats) subtotals.
725
+ * Per-payment cost breakdown including optional base fee and per-unit (e.g., seats) subtotals.
726
726
  */
727
727
  interface BillingPaymentTotalsJSON {
728
728
  subtotal: BillingMoneyAmountJSON;
@@ -750,7 +750,7 @@ interface BillingPaymentJSON extends ClerkResourceJSON {
750
750
  charge_type: BillingPaymentChargeType;
751
751
  status: BillingPaymentStatus;
752
752
  /**
753
- * Per-payment breakdown with optional base fee and per-unit (for example, seats)
753
+ * Per-payment breakdown with optional base fee and per-unit (e.g., seats)
754
754
  * subtotals. Absent on older responses.
755
755
  */
756
756
  totals?: BillingPaymentTotalsJSON | null;
@@ -947,7 +947,7 @@ interface BillingCheckoutTotalsJSON {
947
947
  base_fee: BillingMoneyAmountJSON;
948
948
  tax_total: BillingMoneyAmountJSON;
949
949
  /**
950
- * Per-unit cost breakdown for items actively being purchased in this checkout (for example, seats being added).
950
+ * Per-unit cost breakdown for items actively being purchased in this checkout (e.g., seats being added).
951
951
  * When only adding seats mid-cycle, this only covers the seats being added, not seats already paid for.
952
952
  * Omitted when the checkout is not seat-based.
953
953
  */
@@ -56,7 +56,7 @@ type __internal_LocalizationResource = {
56
56
  locale: string;
57
57
  maintenanceMode: LocalizationValue;
58
58
  /**
59
- * Add Role keys and their localized values, e.g. `roles: { 'org:teacher': 'Teacher'}`.
59
+ * Add Role keys and their localized values, e.g., `roles: { 'org:teacher': 'Teacher'}`.
60
60
  *
61
61
  * @experimental
62
62
  */
@@ -56,7 +56,7 @@ type __internal_LocalizationResource = {
56
56
  locale: string;
57
57
  maintenanceMode: LocalizationValue;
58
58
  /**
59
- * Add Role keys and their localized values, e.g. `roles: { 'org:teacher': 'Teacher'}`.
59
+ * Add Role keys and their localized values, e.g., `roles: { 'org:teacher': 'Teacher'}`.
60
60
  *
61
61
  * @experimental
62
62
  */
@@ -77,7 +77,7 @@ interface OrganizationDomainOwnershipVerification {
77
77
  */
78
78
  strategy: OrganizationDomainOwnershipVerificationStrategy;
79
79
  /**
80
- * The number of verification attempts that have been made for the current ownership verification, or `null` when ownership was not established through a per-attempt flow (for example, the `legacy` strategy).
80
+ * The number of verification attempts that have been made for the current ownership verification, or `null` when ownership was not established through a per-attempt flow (e.g., the `legacy` strategy).
81
81
  */
82
82
  attempts: number | null;
83
83
  /**
@@ -77,7 +77,7 @@ interface OrganizationDomainOwnershipVerification {
77
77
  */
78
78
  strategy: OrganizationDomainOwnershipVerificationStrategy;
79
79
  /**
80
- * The number of verification attempts that have been made for the current ownership verification, or `null` when ownership was not established through a per-attempt flow (for example, the `legacy` strategy).
80
+ * The number of verification attempts that have been made for the current ownership verification, or `null` when ownership was not established through a per-attempt flow (e.g., the `legacy` strategy).
81
81
  */
82
82
  attempts: number | null;
83
83
  /**
@@ -34,7 +34,7 @@ type AuthenticateWithRedirectParams = {
34
34
  */
35
35
  redirectUrlComplete: string;
36
36
  /**
37
- * Whether to continue (i.e. PATCH) an existing SignUp (if present) or create a new SignUp.
37
+ * Whether to continue (i.e., PATCH) an existing SignUp (if present) or create a new SignUp.
38
38
  */
39
39
  continueSignUp?: boolean;
40
40
  /**
@@ -34,7 +34,7 @@ type AuthenticateWithRedirectParams = {
34
34
  */
35
35
  redirectUrlComplete: string;
36
36
  /**
37
- * Whether to continue (i.e. PATCH) an existing SignUp (if present) or create a new SignUp.
37
+ * Whether to continue (i.e., PATCH) an existing SignUp (if present) or create a new SignUp.
38
38
  */
39
39
  continueSignUp?: boolean;
40
40
  /**
@@ -243,7 +243,7 @@ interface SessionResource extends ClerkResource {
243
243
  /**
244
244
  * Gets the current user's [session token](https://clerk.com/docs/guides/sessions/session-tokens) or a [custom JWT template](https://clerk.com/docs/guides/sessions/jwt-templates).
245
245
  *
246
- * This method uses a cache so a network request will only be made if the token in memory has expired. The TTL for a Clerk token is one minute. It retries on transient failures (e.g. network errors); when the browser is offline and retries are exhausted, it throws `ClerkOfflineError`.
246
+ * This method uses a cache so a network request will only be made if the token in memory has expired. The TTL for a Clerk token is one minute. It retries on transient failures (e.g., network errors); when the browser is offline and retries are exhausted, it throws `ClerkOfflineError`.
247
247
  *
248
248
  * Tokens can only be generated if the user is signed in.
249
249
  */
@@ -441,11 +441,11 @@ type GetTokenOptions = {
441
441
  */
442
442
  organizationId?: string;
443
443
  /**
444
- * Whether to skip the cache lookup and force a call to the server instead, even within the TTL. Useful if the token claims are time-sensitive or depend on data that can be updated (e.g. user fields). Defaults to `false`.
444
+ * Whether to skip the cache lookup and force a call to the server instead, even within the TTL. Useful if the token claims are time-sensitive or depend on data that can be updated (e.g., user fields). Defaults to `false`.
445
445
  */
446
446
  skipCache?: boolean;
447
447
  /**
448
- * The name of the JWT template from the [Clerk Dashboard](https://dashboard.clerk.com/~/jwt-templates) to generate a new token from. E.g. 'firebase', 'grafbase', or your custom template's name.
448
+ * The name of the JWT template from the [Clerk Dashboard](https://dashboard.clerk.com/~/jwt-templates) to generate a new token from. E.g., 'firebase', 'grafbase', or your custom template's name.
449
449
  */
450
450
  template?: string;
451
451
  };
@@ -243,7 +243,7 @@ interface SessionResource extends ClerkResource {
243
243
  /**
244
244
  * Gets the current user's [session token](https://clerk.com/docs/guides/sessions/session-tokens) or a [custom JWT template](https://clerk.com/docs/guides/sessions/jwt-templates).
245
245
  *
246
- * This method uses a cache so a network request will only be made if the token in memory has expired. The TTL for a Clerk token is one minute. It retries on transient failures (e.g. network errors); when the browser is offline and retries are exhausted, it throws `ClerkOfflineError`.
246
+ * This method uses a cache so a network request will only be made if the token in memory has expired. The TTL for a Clerk token is one minute. It retries on transient failures (e.g., network errors); when the browser is offline and retries are exhausted, it throws `ClerkOfflineError`.
247
247
  *
248
248
  * Tokens can only be generated if the user is signed in.
249
249
  */
@@ -441,11 +441,11 @@ type GetTokenOptions = {
441
441
  */
442
442
  organizationId?: string;
443
443
  /**
444
- * Whether to skip the cache lookup and force a call to the server instead, even within the TTL. Useful if the token claims are time-sensitive or depend on data that can be updated (e.g. user fields). Defaults to `false`.
444
+ * Whether to skip the cache lookup and force a call to the server instead, even within the TTL. Useful if the token claims are time-sensitive or depend on data that can be updated (e.g., user fields). Defaults to `false`.
445
445
  */
446
446
  skipCache?: boolean;
447
447
  /**
448
- * The name of the JWT template from the [Clerk Dashboard](https://dashboard.clerk.com/~/jwt-templates) to generate a new token from. E.g. 'firebase', 'grafbase', or your custom template's name.
448
+ * The name of the JWT template from the [Clerk Dashboard](https://dashboard.clerk.com/~/jwt-templates) to generate a new token from. E.g., 'firebase', 'grafbase', or your custom template's name.
449
449
  */
450
450
  template?: string;
451
451
  };
@@ -12,7 +12,7 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
12
12
  * @param packageVersion - The version of `@clerk/clerk-js` that will be used if an explicit version is not provided
13
13
  * @returns The npm tag, version or major version to use
14
14
  */
15
- const versionSelector = (clerkJSVersion, packageVersion = "6.25.6-snapshot.v20260720201619") => {
15
+ const versionSelector = (clerkJSVersion, packageVersion = "6.25.6") => {
16
16
  if (clerkJSVersion) return clerkJSVersion;
17
17
  const prereleaseTag = getPrereleaseTag(packageVersion);
18
18
  if (prereleaseTag) {
@@ -1 +1 @@
1
- {"version":3,"file":"versionSelector.js","names":[],"sources":["../src/versionSelector.ts"],"sourcesContent":["/**\n * This version selector is a bit complicated, so here is the flow:\n * 1. Use the clerkJSVersion prop on the provider\n * 2. Use the exact `@clerk/clerk-js` version if it is a `@snapshot` prerelease\n * 3. Use the prerelease tag of `@clerk/clerk-js` or the packageVersion provided\n * 4. Fallback to the major version of `@clerk/clerk-js` or the packageVersion provided\n *\n * @param clerkJSVersion - The optional clerkJSVersion prop on the provider\n * @param packageVersion - The version of `@clerk/clerk-js` that will be used if an explicit version is not provided\n * @returns The npm tag, version or major version to use\n */\nexport const versionSelector = (clerkJSVersion: string | undefined, packageVersion = JS_PACKAGE_VERSION) => {\n if (clerkJSVersion) {\n return clerkJSVersion;\n }\n\n const prereleaseTag = getPrereleaseTag(packageVersion);\n if (prereleaseTag) {\n if (prereleaseTag === 'snapshot') {\n return packageVersion;\n }\n\n return prereleaseTag;\n }\n\n return getMajorVersion(packageVersion);\n};\n\nconst getPrereleaseTag = (packageVersion: string) =>\n packageVersion\n .trim()\n .replace(/^v/, '')\n .match(/-(.+?)(\\.|$)/)?.[1];\n\nexport const getMajorVersion = (packageVersion: string) => packageVersion.trim().replace(/^v/, '').split('.')[0];\n"],"mappings":";;;;;;;;;;;;;;AAWA,MAAa,mBAAmB,gBAAoC,uDAAwC;CAC1G,IAAI,gBACF,OAAO;CAGT,MAAM,gBAAgB,iBAAiB,cAAc;CACrD,IAAI,eAAe;EACjB,IAAI,kBAAkB,YACpB,OAAO;EAGT,OAAO;CACT;CAEA,OAAO,gBAAgB,cAAc;AACvC;AAEA,MAAM,oBAAoB,mBACxB,eACG,KAAK,CAAC,CACN,QAAQ,MAAM,EAAE,CAAC,CACjB,MAAM,cAAc,CAAC,GAAG;AAE7B,MAAa,mBAAmB,mBAA2B,eAAe,KAAK,CAAC,CAAC,QAAQ,MAAM,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC"}
1
+ {"version":3,"file":"versionSelector.js","names":[],"sources":["../src/versionSelector.ts"],"sourcesContent":["/**\n * This version selector is a bit complicated, so here is the flow:\n * 1. Use the clerkJSVersion prop on the provider\n * 2. Use the exact `@clerk/clerk-js` version if it is a `@snapshot` prerelease\n * 3. Use the prerelease tag of `@clerk/clerk-js` or the packageVersion provided\n * 4. Fallback to the major version of `@clerk/clerk-js` or the packageVersion provided\n *\n * @param clerkJSVersion - The optional clerkJSVersion prop on the provider\n * @param packageVersion - The version of `@clerk/clerk-js` that will be used if an explicit version is not provided\n * @returns The npm tag, version or major version to use\n */\nexport const versionSelector = (clerkJSVersion: string | undefined, packageVersion = JS_PACKAGE_VERSION) => {\n if (clerkJSVersion) {\n return clerkJSVersion;\n }\n\n const prereleaseTag = getPrereleaseTag(packageVersion);\n if (prereleaseTag) {\n if (prereleaseTag === 'snapshot') {\n return packageVersion;\n }\n\n return prereleaseTag;\n }\n\n return getMajorVersion(packageVersion);\n};\n\nconst getPrereleaseTag = (packageVersion: string) =>\n packageVersion\n .trim()\n .replace(/^v/, '')\n .match(/-(.+?)(\\.|$)/)?.[1];\n\nexport const getMajorVersion = (packageVersion: string) => packageVersion.trim().replace(/^v/, '').split('.')[0];\n"],"mappings":";;;;;;;;;;;;;;AAWA,MAAa,mBAAmB,gBAAoC,8BAAwC;CAC1G,IAAI,gBACF,OAAO;CAGT,MAAM,gBAAgB,iBAAiB,cAAc;CACrD,IAAI,eAAe;EACjB,IAAI,kBAAkB,YACpB,OAAO;EAGT,OAAO;CACT;CAEA,OAAO,gBAAgB,cAAc;AACvC;AAEA,MAAM,oBAAoB,mBACxB,eACG,KAAK,CAAC,CACN,QAAQ,MAAM,EAAE,CAAC,CACjB,MAAM,cAAc,CAAC,GAAG;AAE7B,MAAa,mBAAmB,mBAA2B,eAAe,KAAK,CAAC,CAAC,QAAQ,MAAM,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC"}