@bamboocss/types 1.11.1 → 1.11.3

package/dist/reporter.d.ts

@@ -0,0 +1,167 @@
+import type { ParserResultInterface } from './parser'
+
+export type ReportItemType =
+  | 'css'
+  | 'cva'
+  | 'sva'
+  | 'token'
+  | 'pattern'
+  | 'recipe'
+  | 'jsx-factory'
+  | 'jsx-pattern'
+  | 'jsx-recipe'
+  | 'jsx'
+
+type ComponentKind = 'component' | 'function'
+
+interface PropertyLocationRange {
+  startPosition: number
+  startLineNumber: number
+  startColumn: number
+  endPosition: number
+  endLineNumber: number
+  endColumn: number
+}
+
+export interface PropertyReportItem {
+  index: string
+  componentIndex: ComponentReportItem['componentIndex']
+  componentName: ComponentReportItem['componentName']
+  reportItemKind: 'token' | 'utility'
+  reportItemType: ReportItemType
+
+  path: string[]
+  conditionName?: string | undefined
+  propName: string
+  value: string | number | boolean
+
+  tokenType?: string
+  isKnownValue: boolean
+
+  range: PropertyLocationRange | null
+  filepath: string
+}
+
+/**
+ * An component is either a component usage or a function usage
+ * @example an component name could be 'Button', 'css', 'bamboo.div', 'vstack', ...
+ */
+export interface ComponentReportItem extends Pick<PropertyReportItem, 'filepath'> {
+  componentIndex: string
+  componentName: string
+  reportItemType: ReportItemType
+  kind: ComponentKind
+  contains: Array<PropertyReportItem['index']>
+  value: Record<string, any>
+  range: PropertyLocationRange | null
+  debug?: boolean
+}
+
+export interface ReportDerivedMaps {
+  byComponentOfKind: Map<ComponentKind, Set<ComponentReportItem['componentIndex']>>
+  byPropertyName: Map<string, Set<PropertyReportItem['index']>>
+  byTokenType: Map<string, Set<PropertyReportItem['index']>>
+  byConditionName: Map<string, Set<PropertyReportItem['index']>>
+  byShorthand: Map<string, Set<PropertyReportItem['index']>>
+  byTokenName: Map<string, Set<PropertyReportItem['index']>>
+  byPropertyPath: Map<string, Set<PropertyReportItem['index']>>
+  fromKind: Map<ComponentKind, Set<PropertyReportItem['index']>>
+  byType: Map<string, Set<PropertyReportItem['index']>>
+  byComponentName: Map<string, Set<PropertyReportItem['index']>>
+  colorsUsed: Map<string, Set<PropertyReportItem['index']>>
+}
+
+interface ReportDerivedMapsJSON {
+  byComponentOfKind: Record<ComponentKind, Array<ComponentReportItem['componentIndex']>>
+  byPropertyName: Record<string, Array<PropertyReportItem['index']>>
+  byTokenType: Record<string, Array<PropertyReportItem['index']>>
+  byConditionName: Record<string, Array<PropertyReportItem['index']>>
+  byShorthand: Record<string, Array<PropertyReportItem['index']>>
+  byTokenName: Record<string, Array<PropertyReportItem['index']>>
+  byPropertyPath: Record<string, Array<PropertyReportItem['index']>>
+  fromKind: Record<ComponentKind, Array<PropertyReportItem['index']>>
+  byType: Record<string, Array<PropertyReportItem['index']>>
+  byComponentName: Record<string, Array<PropertyReportItem['index']>>
+  colorsUsed: Record<string, Array<PropertyReportItem['index']>>
+}
+
+export interface ReportCounts {
+  filesWithTokens: number
+  propNameUsed: number
+  tokenUsed: number
+  shorthandUsed: number
+  propertyPathUsed: number
+  typeUsed: number
+  componentNameUsed: number
+  kindUsed: number
+  componentOfKindUsed: number
+  colorsUsed: number
+}
+
+export interface MostUsedItem {
+  key: string
+  count: number
+}
+
+export interface ReportStats {
+  filesWithMostComponent: Record<string, number>
+  mostUseds: {
+    propNames: Array<MostUsedItem>
+    tokens: Array<MostUsedItem>
+    shorthands: Array<MostUsedItem>
+    categories: Array<MostUsedItem>
+    conditions: Array<MostUsedItem>
+    propertyPaths: Array<MostUsedItem>
+    types: Array<MostUsedItem>
+    componentNames: Array<MostUsedItem>
+    fromKinds: Array<MostUsedItem>
+    componentOfKinds: Array<MostUsedItem>
+    colors: Array<MostUsedItem>
+  }
+}
+
+export interface ReportDetails {
+  counts: ReportCounts
+  stats: ReportStats
+}
+
+export interface AnalysisOptions {
+  onResult?: (file: string, result: ParserResultInterface) => void
+}
+
+interface ReportDerivedMap {
+  byFilepath: Map<string, Set<PropertyReportItem['index']>>
+  byComponentInFilepath: Map<string, Set<ComponentReportItem['componentIndex']>>
+  globalMaps: ReportDerivedMaps
+  byFilePathMaps: Map<string, ReportDerivedMaps>
+}
+
+interface ReportDerivedMapJSON {
+  byFilepath: Record<string, Array<PropertyReportItem['index']>>
+  byComponentInFilepath: Record<string, Array<ComponentReportItem['componentIndex']>>
+  globalMaps: ReportDerivedMapsJSON
+  byFilePathMaps: Record<string, ReportDerivedMapsJSON>
+}
+
+export interface AnalysisReport {
+  schemaVersion: string
+  details: ReportDetails
+
+  propByIndex: Map<PropertyReportItem['index'], PropertyReportItem>
+  componentByIndex: Map<ComponentReportItem['componentIndex'], ComponentReportItem>
+
+  derived: ReportDerivedMap
+}
+
+export interface ReportSnapshotJSON extends Omit<AnalysisReport, 'propByIndex' | 'componentByIndex' | 'derived'> {
+  propByIndex: Record<PropertyReportItem['index'], PropertyReportItem>
+  componentByIndex: Record<ComponentReportItem['componentIndex'], ComponentReportItem>
+  derived: ReportDerivedMapJSON
+}
+
+export interface ClassifyReport {
+  propById: Map<string, PropertyReportItem>
+  componentById: Map<ComponentReportItem['componentIndex'], ComponentReportItem>
+  details: Pick<ReportDetails, 'counts' | 'stats'>
+  derived: ReportDerivedMap
+}

package/dist/runtime.d.ts

@@ -0,0 +1,48 @@
+interface Watcher {
+  on(event: 'add' | 'addDir' | 'change', listener: (path: string) => void): this
+  on(event: 'all', listener: (evt: 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir', path: string) => void): this
+  close(): Promise<void>
+}
+
+interface InputOptions {
+  include: string[]
+  exclude?: string[]
+  cwd?: string
+}
+
+export type WatcherEventType = 'add' | 'addDir' | 'change' | 'unlink' | 'unlinkDir'
+
+export interface WatchOptions extends InputOptions {
+  poll?: boolean
+}
+
+interface FileSystem {
+  readDirSync(dir: string): string[]
+  existsSync(fileLike: string): boolean
+  glob(opts: InputOptions): string[]
+  readFileSync(filePath: string): string
+  rmDirSync(dirPath: string): void
+  writeFile(file: string, content: string): Promise<void>
+  rmFileSync(file: string): void
+  ensureDirSync(dirPath: string): void
+  writeFileSync(filePath: string, content: string): void
+  watch(options: WatchOptions): Watcher
+}
+
+interface Path {
+  join(...paths: string[]): string
+  dirname(path: string): string
+  resolve(...paths: string[]): string
+  extname(path: string): string
+  relative(from: string, to: string): string
+  isAbsolute(path: string): boolean
+  sep: string
+  abs(cwd: string, path: string): string
+}
+
+export interface Runtime {
+  fs: FileSystem
+  path: Path
+  cwd(): string
+  env(name: string): string | undefined
+}

package/dist/selectors.d.ts

@@ -0,0 +1,58 @@
+import type { Pseudos } from './csstype'
+
+type AriaAttributes =
+  | '[aria-disabled]'
+  | '[aria-hidden]'
+  | '[aria-invalid]'
+  | '[aria-readonly]'
+  | '[aria-required]'
+  | '[aria-selected]'
+  | '[aria-checked]'
+  | '[aria-expanded]'
+  | '[aria-pressed]'
+  | `[aria-current=${'page' | 'step' | 'location' | 'date' | 'time'}]`
+  | '[aria-invalid]'
+  | `[aria-sort=${'ascending' | 'descending'}]`
+
+type DataAttributes =
+  | '[data-selected]'
+  | '[data-highlighted]'
+  | '[data-hover]'
+  | '[data-active]'
+  | '[data-checked]'
+  | '[data-disabled]'
+  | '[data-readonly]'
+  | '[data-focus]'
+  | '[data-focus-visible]'
+  | '[data-focus-visible-added]'
+  | '[data-invalid]'
+  | '[data-pressed]'
+  | '[data-expanded]'
+  | '[data-grabbed]'
+  | '[data-dragged]'
+  | '[data-orientation=horizontal]'
+  | '[data-orientation=vertical]'
+  | '[data-in-range]'
+  | '[data-out-of-range]'
+  | '[data-placeholder-shown]'
+  | `[data-part=${string}]`
+  | `[data-attr=${string}]`
+  | `[data-placement=${string}]`
+  | `[data-theme=${string}]`
+  | `[data-size=${string}]`
+  | `[data-state=${string}]`
+  | '[data-empty]'
+  | '[data-loading]'
+  | '[data-loaded]'
+  | '[data-enter]'
+  | '[data-entering]'
+  | '[data-exited]'
+  | '[data-exiting]'
+
+type AttributeSelector = `&${Pseudos | DataAttributes | AriaAttributes}`
+type ParentSelector = `${DataAttributes | AriaAttributes} &`
+
+type AtRuleType = 'media' | 'layer' | 'container' | 'supports' | 'page' | 'scope' | 'starting-style'
+
+export type AnySelector = `${string}&` | `&${string}` | `@${AtRuleType}${string}`
+export type Selectors = AttributeSelector | ParentSelector

package/dist/shared.d.ts

@@ -0,0 +1,39 @@
+type Primitive = string | number | boolean | null | undefined
+
+export type LiteralUnion<T, K extends Primitive = string> = T | (K & Record<never, never>)
+
+export interface Recursive<T> {
+  [key: string]: T | Recursive<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<T = any> = (...args: T[]) => any
+
+export type Nullable<T> = T | null | undefined
+
+export type Keys<T> = keyof NonNullable<T>
+
+type Subtract<T extends number, D extends number> = T extends D ? 0 : T extends D | any ? Exclude<T, D> : never
+
+/**
+ * Get all the (nested) paths of an object until a certain depth
+ * e.g. Paths<{a: {b: {c: 1}}}, '', 2> => 'a' | 'a.b' | 'a.b.c'
+ */
+type Paths<T, Prefix extends string = '', Depth extends number = 0> = {
+  [K in keyof T]: Depth extends 0
+    ? never
+    : T[K] extends object
+      ? K extends string
+        ? `${Prefix}${K}` | Paths<T[K], `${Prefix}${K}.`, Depth extends 1 ? 0 : Subtract<Depth, 1>>
+        : never
+      : K extends string | number
+        ? `${Prefix}${K}`
+        : never
+}[keyof T]
+
+export type PathIn<T, Key extends keyof T> = Key extends string ? Paths<T[Key], `${Key}.`, 1> : never
+
+export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>

package/dist/spec.d.ts

@@ -0,0 +1,197 @@
+export type SpecType =
+  | 'tokens'
+  | 'recipes'
+  | 'patterns'
+  | 'conditions'
+  | 'keyframes'
+  | 'semantic-tokens'
+  | 'text-styles'
+  | 'layer-styles'
+  | 'animation-styles'
+  | 'color-palette'
+  | 'themes'
+
+interface Examples {
+  functionExamples: string[]
+  jsxExamples: string[]
+}
+
+export interface TokenValue {
+  name: string
+  value: any
+  description?: string
+  deprecated?: boolean | string
+  cssVar?: string
+}
+
+export interface TokenGroupDefinition extends Examples {
+  type: string
+  values: TokenValue[]
+  tokenFunctionExamples: string[]
+}
+
+export interface TokenSpec {
+  type: 'tokens'
+  data: TokenGroupDefinition[]
+}
+
+export interface SemanticTokenValue {
+  name: string
+  values: Array<{ value: string; condition?: string }>
+  description?: string
+  deprecated?: boolean | string
+  cssVar?: string
+}
+
+export interface SemanticTokenGroupDefinition extends Examples {
+  type: string
+  values: SemanticTokenValue[]
+  tokenFunctionExamples: string[]
+}
+
+export interface SemanticTokenSpec {
+  type: 'semantic-tokens'
+  data: SemanticTokenGroupDefinition[]
+}
+
+export interface RecipeSpecDefinition extends Examples {
+  name: string
+  description?: string
+  variants: Record<string, string[]>
+  defaultVariants: Record<string, any>
+}
+
+export interface RecipeSpec {
+  type: 'recipes'
+  data: RecipeSpecDefinition[]
+}
+
+export interface PatternSpecProperty {
+  name: string
+  type: string
+  description?: string
+  required?: boolean
+  defaultValue?: any
+}
+
+export interface PatternSpecDefinition extends Examples {
+  name: string
+  description?: string
+  properties: PatternSpecProperty[]
+  jsx?: string
+}
+
+export interface PatternSpec {
+  type: 'patterns'
+  data: PatternSpecDefinition[]
+}
+
+export interface ConditionSpecDefinition extends Examples {
+  name: string
+  value: string
+}
+
+export interface ConditionSpec {
+  type: 'conditions'
+  data: ConditionSpecDefinition[]
+}
+
+export interface KeyframeSpecDefinition extends Examples {
+  name: string
+}
+
+export interface KeyframeSpec {
+  type: 'keyframes'
+  data: KeyframeSpecDefinition[]
+}
+
+export interface TextStyleSpecDefinition extends Examples {
+  name: string
+  description?: string
+}
+
+export interface TextStyleSpec {
+  type: 'text-styles'
+  data: TextStyleSpecDefinition[]
+}
+
+export interface LayerStyleSpecDefinition extends Examples {
+  name: string
+  description?: string
+}
+
+export interface LayerStyleSpec {
+  type: 'layer-styles'
+  data: LayerStyleSpecDefinition[]
+}
+
+export interface AnimationStyleSpecDefinition extends Examples {
+  name: string
+  description?: string
+}
+
+export interface AnimationStyleSpec {
+  type: 'animation-styles'
+  data: AnimationStyleSpecDefinition[]
+}
+
+export interface ColorPaletteSpec {
+  type: 'color-palette'
+  data: {
+    values: string[]
+    functionExamples: string[]
+    jsxExamples: string[]
+  }
+}
+
+export interface ThemeTokenValue {
+  name: string
+  values: Array<{ value: string; condition?: string }>
+  description?: string
+  deprecated?: boolean | string
+  cssVar?: string
+}
+
+export interface ThemeTokenGroupDefinition extends Examples {
+  type: string
+  values: ThemeTokenValue[]
+  tokenFunctionExamples: string[]
+}
+
+export interface ThemeSpecDefinition {
+  name: string
+  tokens: ThemeTokenGroupDefinition[]
+  semanticTokens: ThemeTokenGroupDefinition[]
+}
+
+export interface ThemesSpec {
+  type: 'themes'
+  data: ThemeSpecDefinition[]
+}
+
+export type SpecFile =
+  | TokenSpec
+  | SemanticTokenSpec
+  | RecipeSpec
+  | PatternSpec
+  | ConditionSpec
+  | KeyframeSpec
+  | TextStyleSpec
+  | LayerStyleSpec
+  | AnimationStyleSpec
+  | ColorPaletteSpec
+  | ThemesSpec
+
+export interface SpecTypeMap {
+  tokens: TokenSpec
+  'semantic-tokens': SemanticTokenSpec
+  recipes: RecipeSpec
+  patterns: PatternSpec
+  conditions: ConditionSpec
+  keyframes: KeyframeSpec
+  'text-styles': TextStyleSpec
+  'layer-styles': LayerStyleSpec
+  'animation-styles': AnimationStyleSpec
+  'color-palette': ColorPaletteSpec
+  themes: ThemesSpec
+}

package/dist/static-css.d.ts

@@ -0,0 +1,55 @@
+interface ConditionOptions {
+  /**
+   * The conditions to generate for the rule.
+   * @example ['hover', 'focus']
+   */
+  conditions?: string[]
+  /**
+   * Whether to generate responsive styles for the rule.
+   */
+  responsive?: boolean
+}
+
+export interface CssRule extends ConditionOptions {
+  /**
+   * The css properties to generate utilities for.
+   * @example ['margin', 'padding']
+   */
+  properties: {
+    [property: string]: Array<string | number>
+  }
+}
+
+interface RecipeRuleVariants {
+  [variant: string]: boolean | string[]
+}
+
+export type RecipeRuleObject = RecipeRuleVariants & ConditionOptions
+export type RecipeRule = '*' | RecipeRuleObject
+
+export type PatternRule = '*' | CssRule
+
+export interface StaticCssOptions {
+  /**
+   * The css utility classes to generate.
+   */
+  css?: CssRule[]
+  /**
+   * The css recipes to generate.
+   */
+  recipes?:
+    | '*'
+    | {
+        [recipe: string]: RecipeRule[]
+      }
+  /**
+   * The css patterns to generate.
+   */
+  patterns?: {
+    [pattern: string]: PatternRule[]
+  }
+  /**
+   * The CSS themes to generate
+   */
+  themes?: string[]
+}

package/dist/style-props.d.ts

@@ -0,0 +1,20 @@
+import type { ConditionalValue } from './conditions'
+import type { PropertiesFallback } from './csstype'
+import type { PropertyValue } from './prop-type'
+
+type String = string & {}
+type Number = number & {}
+
+/* -----------------------------------------------------------------------------
+ * Shadowed export (in CLI): DO NOT REMOVE
+ * -----------------------------------------------------------------------------*/
+
+type CssProperties = PropertiesFallback<String | Number>
+
+export type CssVarProperties = {
+  [key in `--${string}`]?: ConditionalValue<string | number>
+}
+
+export type SystemProperties = {
+  [K in keyof CssProperties]?: PropertyValue<K>
+}

package/dist/style-rules.d.ts

@@ -0,0 +1,41 @@
+import type { ConditionDetails } from './conditions'
+
+export interface StyleResultObject {
+  [key: string]: any
+}
+export interface StyleProps extends StyleResultObject {
+  css?: StyleResultObject
+}
+
+export interface StyleEntry {
+  prop: string
+  value: string | number | boolean
+  cond: string
+  recipe?: string
+  slot?: string
+  layer?: string
+  variants?: boolean
+}
+
+export interface AtomicStyleResult {
+  result: StyleResultObject
+  entry: StyleEntry
+  hash: string
+  className: string
+  conditions?: ConditionDetails[]
+  layer?: string
+}
+
+export interface GroupedResult extends Pick<AtomicStyleResult, 'result' | 'className'> {
+  hashSet: Set<string>
+  details: GroupedStyleResultDetails[]
+}
+
+export interface RecipeBaseResult extends GroupedResult {
+  recipe: string
+  slot?: string
+}
+
+export interface GroupedStyleResultDetails extends Pick<AtomicStyleResult, 'hash' | 'entry' | 'conditions'> {
+  result: StyleResultObject
+}