@bamboocss/types 1.11.1 → 1.11.3

package/dist/system-types.d.ts

@@ -0,0 +1,150 @@
+import type { ConditionalValue, Nested } from './conditions'
+import type { AtRule, Globals, PropertiesFallback } from './csstype'
+import type { SystemProperties, CssVarProperties } from './style-props'
+
+type String = string & {}
+type Number = number & {}
+
+export type Pretty<T> = { [K in keyof T]: T[K] } & {}
+
+export type DistributiveOmit<T, K extends keyof any> = T extends unknown ? Omit<T, K> : never
+
+export type DistributiveUnion<T, U> = {
+  [K in keyof T]: K extends keyof U ? U[K] | T[K] : T[K]
+} & DistributiveOmit<U, keyof T>
+
+export type Assign<T, U> = {
+  [K in keyof T]: K extends keyof U ? U[K] : T[K]
+} & U
+
+/* -----------------------------------------------------------------------------
+ * Native css properties
+ * -----------------------------------------------------------------------------*/
+
+type CornerShapeValue = 'round' | 'square' | 'bevel' | 'scoop' | 'notch' | 'squircle' | `superellipse(${number})`
+
+export interface ModernCssProperties {
+  /**
+   * Controls whether the entire element should be draggable instead of its contents.
+   */
+  WebkitUserDrag?: Globals | 'auto' | 'element' | 'none'
+
+  /**
+   * Specifies whether an element can be used to drag the entire app window (Electron).
+   */
+  WebkitAppRegion?: Globals | 'drag' | 'no-drag'
+
+  /**
+   * Sets the horizontal spacing between table borders.
+   */
+  WebkitBorderHorizontalSpacing?: Globals | String | Number
+
+  /**
+   * Sets the vertical spacing between table borders.
+   */
+  WebkitBorderVerticalSpacing?: Globals | String | Number
+
+  /**
+   * Controls the display of text content for security purposes (e.g., password fields).
+   */
+  WebkitTextSecurity?: Globals | 'none' | 'circle' | 'disc' | 'square'
+
+  /**
+   * Specifies the shape of a box's corners within the area defined by the border-radius property.
+   * @experimental
+   * @see https://developer.mozilla.org/en-US/docs/Web/CSS/corner-shape
+   */
+  cornerShape?:
+    | Globals
+    | CornerShapeValue
+    | `${CornerShapeValue} ${CornerShapeValue}`
+    | `${CornerShapeValue} ${CornerShapeValue} ${CornerShapeValue}`
+    | `${CornerShapeValue} ${CornerShapeValue} ${CornerShapeValue} ${CornerShapeValue}`
+    | String
+}
+
+export type CssProperty = keyof PropertiesFallback
+
+export interface CssProperties extends PropertiesFallback<String | Number>, CssVarProperties, ModernCssProperties {}
+
+export interface CssKeyframes {
+  [name: string]: {
+    [time: string]: CssProperties
+  }
+}
+
+/* -----------------------------------------------------------------------------
+ * Conditional css properties
+ * -----------------------------------------------------------------------------*/
+
+interface GenericProperties {
+  [key: string]: ConditionalValue<String | Number | boolean>
+}
+
+/* -----------------------------------------------------------------------------
+ * Native css props
+ * -----------------------------------------------------------------------------*/
+
+export type NestedCssProperties = Nested<CssProperties>
+
+export type SystemStyleObject = Nested<(SystemProperties | GenericProperties) & CssVarProperties>
+
+export interface GlobalStyleObject {
+  [selector: string]: SystemStyleObject
+}
+export interface ExtendableGlobalStyleObject {
+  [selector: string]: SystemStyleObject | undefined
+  extend?: GlobalStyleObject | undefined
+}
+
+/* -----------------------------------------------------------------------------
+ * Composition (text styles, layer styles)
+ * -----------------------------------------------------------------------------*/
+
+type FilterStyleObject<P extends string> = {
+  [K in P]?: K extends keyof SystemStyleObject ? SystemStyleObject[K] : unknown
+}
+
+export type CompositionStyleObject<Property extends string> = Nested<FilterStyleObject<Property> & CssVarProperties>
+
+/* -----------------------------------------------------------------------------
+ * Font face
+ * -----------------------------------------------------------------------------*/
+
+export type GlobalFontfaceRule = Omit<AtRule.FontFaceFallback, 'src'> & Required<Pick<AtRule.FontFaceFallback, 'src'>>
+
+export type FontfaceRule = Omit<GlobalFontfaceRule, 'fontFamily'>
+
+export interface GlobalFontface {
+  [name: string]: FontfaceRule | FontfaceRule[]
+}
+
+export interface ExtendableGlobalFontface {
+  [name: string]: FontfaceRule | FontfaceRule[] | GlobalFontface | undefined
+  extend?: GlobalFontface | undefined
+}
+
+/* -----------------------------------------------------------------------------
+ * Jsx style props
+ * -----------------------------------------------------------------------------*/
+interface WithCss {
+  css?: SystemStyleObject | SystemStyleObject[]
+}
+
+export type JsxStyleProps = SystemStyleObject & WithCss
+
+export interface PatchedHTMLProps {
+  htmlWidth?: string | number
+  htmlHeight?: string | number
+  htmlTranslate?: 'yes' | 'no' | undefined
+  htmlContent?: string
+}
+
+export type OmittedHTMLProps = 'color' | 'translate' | 'transition' | 'width' | 'height' | 'content'
+
+type WithHTMLProps<T> = DistributiveOmit<T, OmittedHTMLProps> & PatchedHTMLProps
+
+export type JsxHTMLProps<T extends Record<string, any>, P extends Record<string, any> = {}> = Assign<
+  WithHTMLProps<T>,
+  P
+>

package/dist/theme.d.ts

@@ -0,0 +1,94 @@
+import type { AnimationStyles, LayerStyles, TextStyles } from './composition'
+import type { RecipeConfig, SlotRecipeConfig } from './recipe'
+import type { CssKeyframes } from './system-types'
+import type { SemanticTokens, Tokens } from './tokens'
+
+export interface ColorPaletteOptions {
+  /**
+   * Whether to enable color palette generation.
+   * @default true
+   */
+  enabled?: boolean
+  /**
+   * List of color names to include in color palette generation.
+   * When specified, only these colors will be used for color palettes.
+   */
+  include?: string[]
+  /**
+   * List of color names to exclude from color palette generation.
+   * When specified, these colors will not be used for color palettes.
+   */
+  exclude?: string[]
+}
+
+export interface Theme {
+  /**
+   * The breakpoints for your project.
+   */
+  breakpoints?: Record<string, string>
+  /**
+   * The css animation keyframes definitions.
+   */
+  keyframes?: CssKeyframes
+  /**
+   * The design tokens for your project.
+   */
+  tokens?: Tokens
+  /**
+   * The semantic design tokens for your project.
+   */
+  semanticTokens?: SemanticTokens
+  /**
+   * The typography styles for your project.
+   */
+  textStyles?: TextStyles
+  /**
+   * The layer styles for your project.
+   */
+  layerStyles?: LayerStyles
+  /**
+   * The animation styles for your project.
+   */
+  animationStyles?: AnimationStyles
+  /**
+   * Multi-variant style definitions for your project.
+   * Useful for defining component styles.
+   */
+  recipes?: Record<string, RecipeConfig>
+  /**
+   * Multi-variant style definitions for component slots.
+   */
+  slotRecipes?: Record<string, SlotRecipeConfig>
+  /**
+   * The predefined container names for your project.
+   */
+  containerNames?: string[]
+  /**
+   * The predefined container sizes for your project.
+   */
+  containerSizes?: Record<string, string>
+  /**
+   * The color palette configuration for your project.
+   */
+  colorPalette?: ColorPaletteOptions
+}
+
+interface PartialTheme extends Omit<Theme, 'recipes' | 'slotRecipes'> {
+  /**
+   * Multi-variant style definitions for your project.
+   * Useful for defining component styles.
+   */
+  recipes?: Record<string, Partial<RecipeConfig>>
+  /**
+   * Multi-variant style definitions for component slots.
+   */
+  slotRecipes?: Record<string, Partial<SlotRecipeConfig>>
+  /**
+   * The color palette configuration for your project.
+   */
+  colorPalette?: Partial<ColorPaletteOptions>
+}
+
+export interface ExtendableTheme extends Theme {
+  extend?: PartialTheme | undefined
+}

package/dist/tokens.d.ts

@@ -0,0 +1,104 @@
+import type { Recursive } from './shared'
+
+export interface Token<Value = any> {
+  value: Value
+  description?: string
+  type?: string
+  deprecated?: boolean | string
+  extensions?: {
+    [key: string]: any
+  }
+}
+
+type RecursiveToken<C extends string, V> =
+  | V
+  | {
+      [K in C]: RecursiveToken<C, V>
+    }
+
+export interface SemanticToken<Value = string, Condition extends string = string> extends Token<
+  RecursiveToken<Condition, Value>
+> {}
+
+/* -----------------------------------------------------------------------------
+ * Token data types
+ * -----------------------------------------------------------------------------*/
+
+type BorderStyle =
+  | 'dashed'
+  | 'dotted'
+  | 'double'
+  | 'groove'
+  | 'hidden'
+  | 'inset'
+  | 'none'
+  | 'outset'
+  | 'ridge'
+  | 'solid'
+
+export interface Border {
+  color: string
+  width: string | number
+  style: BorderStyle
+}
+
+export interface Shadow {
+  offsetX: number | string
+  offsetY: number | string
+  blur: number | string
+  spread: number | string
+  color: string
+  inset?: boolean
+}
+
+export interface Gradient {
+  type: 'linear' | 'radial'
+  placement: string | number
+  stops:
+    | Array<{
+        color: string
+        position: number
+      }>
+    | Array<string>
+}
+
+export interface Asset {
+  type: 'url' | 'svg'
+  value: string
+}
+
+export interface TokenDataTypes {
+  cursor: string
+  zIndex: string | number
+  opacity: string | number
+  colors: string
+  fonts: string | string[]
+  fontSizes: string
+  fontWeights: string | number
+  lineHeights: string | number
+  letterSpacings: string
+  sizes: 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
+  assets: string | Asset
+  borderWidths: string
+  aspectRatios: string
+  containerNames: string
+}
+
+export type Tokens = {
+  [key in keyof TokenDataTypes]?: Recursive<Token<TokenDataTypes[key]>>
+}
+
+export type SemanticTokens<ConditionKey extends string = string> = {
+  [key in keyof TokenDataTypes]?: Recursive<SemanticToken<TokenDataTypes[key], ConditionKey>>
+}
+
+export type TokenCategory = keyof TokenDataTypes

package/dist/utility.d.ts

@@ -0,0 +1,114 @@
+import type { LiteralUnion } from './shared'
+import type { CssProperty, NestedCssProperties } from './system-types'
+import type { Token, TokenCategory } from './tokens'
+
+interface TokenFn {
+  (path: string): string | undefined
+  raw: (path: string) => Token | undefined
+}
+
+type ThemeFn = (token: (path: string) => any) => Record<string, string>
+
+export type PropertyValues =
+  | LiteralUnion<TokenCategory | 'keyframes'>
+  | string[]
+  | { type: string }
+  | Record<string, string>
+  | ThemeFn
+
+export interface ColorMixResult {
+  invalid: boolean
+  value: string
+  color?: string
+}
+
+export interface TransformUtils {
+  colorMix(value: string): ColorMixResult
+}
+
+export interface TransformArgs<T = any> {
+  token: TokenFn
+  raw: T
+  utils: TransformUtils
+}
+
+export type PropertyTransform = (value: any, args: TransformArgs) => NestedCssProperties | undefined
+
+export interface 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?: CssProperty
+  /**
+   * The shorthand of the property.
+   */
+  shorthand?: string | string[]
+  /**
+   * The CSS semantic group this property belongs
+   */
+  group?: CssSemanticGroup
+  /**
+   * Whether this utility is deprecated or not.
+   */
+  deprecated?: boolean
+}
+
+export type CssSemanticGroup =
+  | 'Animation'
+  | 'Background Gradient'
+  | 'Background'
+  | 'Border Radius'
+  | 'Border'
+  | 'Color'
+  | 'Container'
+  | 'Display'
+  | 'Focus Ring'
+  | 'Effect'
+  | 'Flex Layout'
+  | 'Grid Layout'
+  | 'Height'
+  | 'Interactivity'
+  | 'Layout'
+  | 'List'
+  | 'Margin'
+  | 'Other'
+  | 'Padding'
+  | 'Position'
+  | 'Scroll'
+  | 'Shadow'
+  | 'System'
+  | 'Table'
+  | 'Transform'
+  | 'Transition'
+  | 'Typography'
+  | 'Visibility'
+  | 'Width'
+
+export type UtilityConfig = {
+  [property in LiteralUnion<CssProperty>]?: PropertyConfig
+}
+
+type UtilityConfigWithExtend = {
+  [pattern in LiteralUnion<CssProperty>]?: PropertyConfig | UtilityConfig | undefined
+}
+
+export type ExtendableUtilityConfig = UtilityConfigWithExtend & {
+  extend?: UtilityConfig | undefined
+}

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@bamboocss/types",
-  "version": "1.11.1",
+  "version": "1.11.3",
   "description": "The types for css bamboo",
   "homepage": "https://bamboo-css.com",
   "license": "MIT",
   "author": "Segun Adebayo <joseshegs@gmail.com>",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/chakra-ui/bamboo.git",
+    "url": "git+https://github.com/bamboocss/bamboo.git",
     "directory": "packages/types"
   },
   "files": [
     "dist"
   ],
   "sideEffects": false,
-  "main": "dist/index.d.ts",
+  "main": "dist/index.d.cts",
   "exports": {
     ".": {
       "source": "./src/index.ts",
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.d.ts"
+      "types": "./dist/index.d.cts",
+      "default": "./dist/index.d.cts"
     },
     "./package.json": "./package.json"
   },
@@ -32,7 +32,7 @@
     "ncp": "2.0.0",
     "pkg-types": "2.3.0",
     "ts-morph": "28.0.0",
-    "@bamboocss/extractor": "1.11.1"
+    "@bamboocss/extractor": "1.11.3"
   },
   "scripts": {
     "dev": "tsx scripts/watch.ts",