@pandacss/types 0.0.0-dev-20221121152823

package/src/generator.d.ts

@@ -0,0 +1,39 @@
+interface UtilityProperties {
+  /**
+   * The css properties to generate utilities for.
+   * @example ['margin', 'padding']
+   */
+  properties: string[]
+  /**
+   * The css conditions to generate utilities for.
+   * @example ['hover', 'focus']
+   */
+  conditions?: string[]
+  /**
+   * The values to generate utilities for.
+   * @example ['2', '40px']
+   */
+  values?: string[]
+}
+
+interface RecipeProperties {
+  conditions: string[]
+  [variant: string]: string[]
+}
+
+export type ClassGeneratorOptions = {
+  /**
+   * The output path for the generated css file.
+   */
+  outfile?: string
+  /**
+   * The css utility classes to generate.
+   */
+  css?: UtilityProperties[]
+  /**
+   * The css recipes to generate.
+   */
+  recipes?: {
+    [recipe: string]: RecipeProperties[]
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,9 @@
+export type * from './conditions'
+export type * from './config'
+export type * from './utility'
+export type * from './panda-csstype'
+export type * from './pattern'
+export type * from './recipe'
+export type * from './composition'
+export type * from './tokens'
+export type * from './shared'

package/src/panda-csstype.d.ts

@@ -0,0 +1,95 @@
+import type { PropertiesFallback, SimplePseudos } from './csstype'
+
+type Loose<T = string> = T & { __type?: never }
+
+type ContainerProperties = {
+  container?: string
+  containerType?: 'size' | 'inline-size' | Loose
+  containerName?: string
+}
+
+export type Properties = PropertiesFallback<Loose<string> | Loose<number>> & ContainerProperties
+
+export type CssProperty = keyof Properties
+
+type Pseudo = `&${SimplePseudos}`
+
+export type CssProperties = Properties & {
+  [property: string]: string | number | Record<string, any> | undefined
+}
+
+export type Keyframes = {
+  [time: string]: CssProperties
+}
+
+type TCondition = Record<string, string>
+
+export type PandaConditionalValue<Condition extends TCondition, Value> =
+  | Value
+  | {
+      [Key in keyof Condition]?: PandaConditionalValue<Condition, Value>
+    }
+
+type NeverType = { __type?: 'never' }
+
+type Union<
+  Key extends string,
+  CssProperties extends Record<Key, any>,
+  UserProperties,
+> = UserProperties extends NeverType
+  ? CssProperties[Key] | Loose
+  : Key extends keyof UserProperties
+  ? CssProperties[Key] | UserProperties[Key]
+  : CssProperties[Key]
+
+type Strict<
+  Key extends string,
+  CssProperties extends Record<Key, any>,
+  UserProperties,
+> = Key extends keyof UserProperties ? UserProperties[Key] : CssProperties[Key]
+
+export type ConditionCssProperties<
+  Conditions extends TCondition = TCondition,
+  UserProperties extends Record<string, any> = NeverType,
+  StrictValue extends boolean = false,
+> = {
+  [Key in keyof Properties]?: PandaConditionalValue<
+    Conditions,
+    true extends StrictValue ? Strict<Key, Properties, UserProperties> : Union<Key, Properties, UserProperties>
+  >
+} & {
+  [Key in keyof Omit<UserProperties, keyof Properties>]?: PandaConditionalValue<Conditions, UserProperties[Key]>
+} & {
+  [Key in keyof Conditions]?: ConditionCssProperties<Omit<Conditions, Key>, UserProperties, StrictValue>
+}
+
+type NestedCss<T> = T & {
+  [key in Pseudo | Loose]?: NestedCss<T> | Loose<string> | Loose<number> | boolean
+}
+
+export type GroupedCss<T> = {
+  selectors?: {
+    [key in Pseudo | Loose]?: T
+  }
+  '@media'?: {
+    [query: string]: T
+  }
+  '@container'?: {
+    [query: string]: T
+  }
+}
+
+export type PandaCssObject<
+  Conditions extends TCondition,
+  UserProperties extends Record<string, any> = NeverType,
+  Strict extends boolean = false,
+> = NestedCss<ConditionCssProperties<Conditions, UserProperties, Strict>> &
+  GroupedCss<ConditionCssProperties<Conditions, UserProperties, Strict>>
+
+export type GlobalCss<
+  Conditions extends TCondition,
+  UserProperties extends Record<string, any> = NeverType,
+  Strict extends boolean = false,
+> = Record<string, NestedCss<ConditionCssProperties<Conditions, UserProperties, Strict>>>
+
+export {}

package/src/pattern.d.ts

@@ -0,0 +1,38 @@
+import type { CssProperty, ConditionCssProperties } from './panda-csstype'
+import type { TokenCategory } from './tokens'
+
+export type PatternProperty =
+  | { type: 'property'; value: CssProperty }
+  | { type: 'enum'; value: string[] }
+  | { type: 'token'; value: TokenCategory; property?: CssProperty }
+  | { type: 'string' | 'boolean' | 'number' }
+
+type Value = string | { [key: string]: Value }
+
+export type TransformHelpers = {
+  map: (value: Value, fn: (value: string) => string | undefined) => any
+}
+
+export type PatternConfig = {
+  /**
+   * The description of the pattern. This will be used in the JSDoc comment.
+   */
+  description?: string
+  /**
+   * The properties of the pattern.
+   */
+  properties: Record<string, PatternProperty>
+  /**
+   * The css object this pattern will generate.
+   */
+  transform?: (props: Record<string, Value>, helpers: TransformHelpers) => ConditionCssProperties
+  /**
+   * The jsx element name this pattern will generate.
+   */
+  jsx?: string
+  /**
+   * Whether to only generate types for the specified properties.
+   * This will disallow css properties
+   */
+  strict?: boolean
+}

package/src/recipe.d.ts

@@ -0,0 +1,30 @@
+import type { CssProperties, WithNesting } from './panda-csstype'
+
+export type RecipeVariant = Record<string, WithNesting<CssProperties>>
+
+type TRecipe = Record<string, RecipeVariant>
+
+export type RecipeConfig<Variants extends TRecipe = TRecipe> = {
+  /**
+   * The name of the recipe.
+   */
+  name: string
+  /**
+   * The base styles of the recipe.
+   */
+  base?: WithNesting<CssProperties>
+  /**
+   * The multi-variant styles of the recipe.
+   */
+  variants?: Variants
+  /**
+   * The default variants of the recipe.
+   */
+  defaultVariants?: {
+    [K in keyof Variants]?: keyof Variants[K]
+  }
+  /**
+   * The description of the recipe. This will be used in the JSDoc comment.
+   */
+  description?: string
+}

package/src/shared.d.ts

@@ -0,0 +1,33 @@
+export type Loose = string & Record<never, never>
+
+type Str<T> = T extends number ? `${T}` : T
+
+type PathsToStringProps<T> = T extends string
+  ? []
+  : {
+      [Key in Extract<keyof T, string | number>]: [Str<Key>, ...PathsToStringProps<T[Key]>]
+    }[Extract<keyof T, string | number>]
+
+type Join<Paths extends string[], Delimiter extends string> = Paths extends []
+  ? never
+  : Paths extends [infer Property]
+  ? Property
+  : Paths extends [infer Property, ...infer Rest]
+  ? Property extends string
+    ? `${Property}${Delimiter}${Join<Extract<Rest, string[]>, Delimiter>}`
+    : never
+  : string
+
+type TDotPath = Record<string, any> | string
+
+export type DotPath<T extends TDotPath> = Join<PathsToStringProps<T>, '.'>
+
+export type Primitive = string | number | boolean | null | undefined
+
+export type Entry<T> = [keyof T, T[keyof T]]
+
+export type Dict<T = any> = Record<string, T>
+
+export type RequiredBy<T, K extends keyof T> = Partial<Omit<T, K>> & Required<Pick<T, K>>
+
+export type AnyFunction = (...args: any[]) => any

package/src/tokens.d.ts

@@ -0,0 +1,78 @@
+export type TokenStatus = 'deprecated' | 'experimental' | 'new'
+
+export type Token<V = any> = {
+  value: V
+  description?: string
+  type?: string
+  extensions?: {
+    status?: TokenStatus
+    [key: string]: any
+  }
+}
+
+export type SemanticToken<V = string, C extends string = string> = {
+  description?: string
+  type?: string
+  value: V | Record<C, V>
+  extensions?: {
+    [key: string]: any
+  }
+}
+
+type Border = {
+  color: string
+  width: string | number
+  style: string
+}
+
+type Shadow = {
+  offsetX: number
+  offsetY: number
+  blur: number
+  spread: number
+  color: string
+  inset?: boolean
+}
+
+type Gradient = {
+  type: 'linear' | 'radial'
+  placement: string | number
+  stops: Array<{
+    color: string
+    position: number
+  }>
+}
+
+type Nested<T> = { [key: string]: T | Nested<T> }
+
+export type TokenValues = {
+  zIndex: number
+  opacity: number
+  colors: string
+  fonts: string | string[]
+  fontSizes: string
+  fontWeights: string | number
+  lineHeights: string | number
+  letterSpacings: string
+  sizes: string
+  largeSizes: string
+  shadows: Shadow | Shadow[] | string | string[]
+  spacing: string | number
+  radii: string
+  borders: string | Border
+  durations: string
+  easings: string | number[]
+  animations: string
+  blurs: string
+  gradients: string | Gradient
+}
+
+export type Tokens = {
+  [key in keyof TokenValues]?: Nested<Token<TokenValues[key]>>
+}
+
+export type SemanticTokens<C extends string = string> = {
+  [key in keyof TokenValues]?: Nested<SemanticToken<TokenValues[key], C>>
+}
+
+export type TokenCategory = keyof TokenValues

package/src/utility.d.ts

@@ -0,0 +1,53 @@
+import type { Properties } from './panda-csstype'
+
+type ClassNameFn = (value: string, prop: string) => string
+
+export type PropertyClassName = string | ClassNameFn
+
+type Getter = (path: string) => any
+
+type ThemeFn = (token: Getter) => Record<string, string>
+
+type CssObject =
+  | Properties
+  | {
+      [selector: string]: string | number | null | undefined | Properties
+    }
+
+export type PropertyValues = string | string[] | { type: string } | Record<string, string> | ThemeFn
+
+export type PropertyTransform<T = CssObject> = (value: any, token: Getter) => T
+
+export type PropertyConfig = {
+  /**
+   * @internal
+   * The cascade layer to which the property  belongs
+   */
+  layer?: string
+  /**
+   * The classname this property will generate.
+   */
+  className?: string
+  /**
+   * The css style object this property will generate.
+   */
+  transform?: PropertyTransform
+  /**
+   * The possible values this property can have.
+   */
+  values?: PropertyValues
+  /**
+   * The css property this utility maps to.
+   */
+  property?: keyof Properties
+  /**
+   * The shorthand of the property.
+   */
+  shorthand?: string
+}
+
+export type UtilityConfig = {
+  [property in keyof Properties]?: PropertyConfig
+} & {
+  [key: string]: PropertyConfig
+}