@clerk/types 4.70.1 → 4.71.0-canary.v20250729130541

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.
package/dist/index.d.mts CHANGED
@@ -2952,12 +2952,11 @@ interface PublicUserData {
2952
2952
  userId?: string;
2953
2953
  }
2954
2954
  /**
2955
- * Represents a required action that a user must complete
2956
- * before their session becomes fully active
2955
+ * Represents the current pending task of a session.
2957
2956
  */
2958
2957
  interface SessionTask {
2959
2958
  /**
2960
- * The unique identifier for the type of task that needs to be completed
2959
+ * A unique identifier for the task
2961
2960
  */
2962
2961
  key: 'select-organization';
2963
2962
  }
@@ -5513,11 +5512,27 @@ type Variables = {
5513
5512
  type BaseThemeTaggedType = {
5514
5513
  __type: 'prebuilt_appearance';
5515
5514
  };
5516
- type BaseTheme = BaseThemeTaggedType & {
5515
+ type BaseTheme = (BaseThemeTaggedType | 'clerk' | 'simple') & {
5517
5516
  cssLayerName?: string;
5518
5517
  };
5519
5518
  type Theme = {
5520
5519
  /**
5520
+ * A theme used as the base theme for the components.
5521
+ * For further customisation, you can use the {@link Theme.layout}, {@link Theme.variables} and {@link Theme.elements} props.
5522
+ *
5523
+ * Supports both object-based themes and string-based themes:
5524
+ * @example
5525
+ * import { dark } from "@clerk/themes";
5526
+ * appearance={{ theme: dark }}
5527
+ *
5528
+ * @example
5529
+ * // Use string-based theme
5530
+ * appearance={{ theme: 'clerk' }}
5531
+ * appearance={{ theme: 'simple' }}
5532
+ */
5533
+ theme?: BaseTheme | BaseTheme[];
5534
+ /**
5535
+ * @deprecated Use `theme` instead. This property will be removed in a future version.
5521
5536
  * A theme used as the base theme for the components.
5522
5537
  * For further customisation, you can use the {@link Theme.layout}, {@link Theme.variables} and {@link Theme.elements} props.
5523
5538
  * @example
@@ -5546,7 +5561,7 @@ type Theme = {
5546
5561
  /**
5547
5562
  * The appearance of the CAPTCHA widget.
5548
5563
  * This will be used to style the CAPTCHA widget.
5549
- * Eg: `theme: 'dark'`
5564
+ * Eg: `captcha: { theme: 'dark' }`
5550
5565
  */
5551
5566
  captcha?: CaptchaAppearanceOptions;
5552
5567
  };
package/dist/index.d.ts CHANGED
@@ -2952,12 +2952,11 @@ interface PublicUserData {
2952
2952
  userId?: string;
2953
2953
  }
2954
2954
  /**
2955
- * Represents a required action that a user must complete
2956
- * before their session becomes fully active
2955
+ * Represents the current pending task of a session.
2957
2956
  */
2958
2957
  interface SessionTask {
2959
2958
  /**
2960
- * The unique identifier for the type of task that needs to be completed
2959
+ * A unique identifier for the task
2961
2960
  */
2962
2961
  key: 'select-organization';
2963
2962
  }
@@ -5513,11 +5512,27 @@ type Variables = {
5513
5512
  type BaseThemeTaggedType = {
5514
5513
  __type: 'prebuilt_appearance';
5515
5514
  };
5516
- type BaseTheme = BaseThemeTaggedType & {
5515
+ type BaseTheme = (BaseThemeTaggedType | 'clerk' | 'simple') & {
5517
5516
  cssLayerName?: string;
5518
5517
  };
5519
5518
  type Theme = {
5520
5519
  /**
5520
+ * A theme used as the base theme for the components.
5521
+ * For further customisation, you can use the {@link Theme.layout}, {@link Theme.variables} and {@link Theme.elements} props.
5522
+ *
5523
+ * Supports both object-based themes and string-based themes:
5524
+ * @example
5525
+ * import { dark } from "@clerk/themes";
5526
+ * appearance={{ theme: dark }}
5527
+ *
5528
+ * @example
5529
+ * // Use string-based theme
5530
+ * appearance={{ theme: 'clerk' }}
5531
+ * appearance={{ theme: 'simple' }}
5532
+ */
5533
+ theme?: BaseTheme | BaseTheme[];
5534
+ /**
5535
+ * @deprecated Use `theme` instead. This property will be removed in a future version.
5521
5536
  * A theme used as the base theme for the components.
5522
5537
  * For further customisation, you can use the {@link Theme.layout}, {@link Theme.variables} and {@link Theme.elements} props.
5523
5538
  * @example
@@ -5546,7 +5561,7 @@ type Theme = {
5546
5561
  /**
5547
5562
  * The appearance of the CAPTCHA widget.
5548
5563
  * This will be used to style the CAPTCHA widget.
5549
- * Eg: `theme: 'dark'`
5564
+ * Eg: `captcha: { theme: 'dark' }`
5550
5565
  */
5551
5566
  captcha?: CaptchaAppearanceOptions;
5552
5567
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@clerk/types",
3
- "version": "4.70.1",
3
+ "version": "4.71.0-canary.v20250729130541",
4
4
  "description": "Typings for Clerk libraries.",
5
5
  "keywords": [
6
6
  "clerk",