@ornikar/bumper 3.11.0 → 3.12.0

package/src/system/types.ts

@@ -4,6 +4,7 @@ import type {
   TokensParsed,
   WithMediaProps,
 } from '@tamagui/core';
+import type { ReactNode } from 'react';
 
 /**
  * Rewrite of Tamagui PropsWithoutMediaStyles to make all responsive props optionnal.
@@ -29,14 +30,14 @@ export type TamaguiMediaProps<A> = PropsWithoutMediaStyles<A> & WithMediaProps<I
 export type DefaultIgnoredKeys = 'children';
 
 /**
- * Maps a component's variant-prop interface `T` to a Tamagui `variants` config whose entries produce
- * style objects of type `V`.
+ * Maps a component's variant-prop interface `VariantProps` to a Tamagui `variants` config whose
+ * entries produce style objects of type `StyleProps`.
  *
- * For each key `K` of `T`, the entry must be either:
+ * For each key `K` of `VariantProps`, the entry must be either:
  * - a record keyed by the prop's literal values (with `boolean` props normalised to `'true' | 'false'`),
- *   where each value is a style `V` or a function returning `V`, or
+ *   where each value is a `StyleProps` or a function returning `StyleProps`, or
  * - a function that receives the raw prop value and a {@link VariantGoodiesParams} context and returns
- *   a style `V` (or `undefined`).
+ *   a `StyleProps` (or `undefined`).
  *
  * Pass a union of keys as `IgnoredKeys` to skip props that should never be variants (e.g.
  * event handlers). Ignored keys are stripped only from both the top-level map, not from `params.props`.
@@ -45,13 +46,24 @@ export type DefaultIgnoredKeys = 'children';
  * config is inferred `as const` while still being checked against the component's prop types, e.g.
  * `{ ... } as const satisfies PropsToTamaguiVariants<MyVariantProps, ViewProps, 'size'>`.
  */
-export type PropsToTamaguiVariants<T, V, IgnoredKeys extends keyof T = never> = {
-  [K in keyof T as K extends IgnoredKeys | Extract<keyof T, DefaultIgnoredKeys> ? never : K]: NonNullable<
-    T[K]
-  > extends boolean
-    ? Record<'true' | 'false', V | ((value: boolean | string | number, params: VariantGoodiesParams<T>) => V)>
-    : NonNullable<T[K]> extends PropertyKey
-    ? Record<NonNullable<T[K]>, V> | ((value: NonNullable<T[K]>, params: VariantGoodiesParams<T>) => V | undefined)
+export type PropsToTamaguiVariants<VariantProps, StyleProps, IgnoredKeys extends keyof VariantProps = never> = {
+  [K in keyof VariantProps as K extends IgnoredKeys | Extract<keyof VariantProps, DefaultIgnoredKeys>
+    ? never
+    : K]: NonNullable<VariantProps[K]> extends boolean
+    ? Record<
+        'true' | 'false',
+        | StyleProps
+        | ((value: boolean | string | number, params: VariantGoodiesParams<VariantProps & StyleProps>) => StyleProps)
+      >
+    : NonNullable<VariantProps[K]> extends PropertyKey
+    ?
+        | Record<NonNullable<VariantProps[K]>, StyleProps>
+        | ((
+            value: NonNullable<VariantProps[K]>,
+            params: VariantGoodiesParams<VariantProps & StyleProps>,
+          ) => StyleProps | undefined)
+    : NonNullable<VariantProps[K]> extends ReactNode
+    ? StyleProps
     : never;
 };
 
@@ -62,7 +74,7 @@ export type PropsToTamaguiVariants<T, V, IgnoredKeys extends keyof T = never> =
  *   props (e.g. read `disabled` or `isOnContrasted` while resolving `type`).
  * - `tokens`: Tamagui's parsed token map, for resolving design tokens from inside the variant.
  */
-interface VariantGoodiesParams<T> {
-  props: T;
+interface VariantGoodiesParams<Props> {
+  props: Props;
   tokens: TokensParsed;
 }