@pandacss/types 0.29.1 → 0.30.1

package/dist/artifact.d.ts

@@ -1,5 +1,4 @@
 import { type Difference } from 'microdiff'
-import type { Nullable } from './shared'
 
 export interface ArtifactContent {
   file: string
@@ -31,11 +30,11 @@ export type ArtifactId =
 
 export type CssArtifactType = 'preflight' | 'tokens' | 'static' | 'global' | 'keyframes'
 
-export type Artifact = Nullable<{
+export type Artifact = {
   id: ArtifactId
   dir?: string[]
   files: ArtifactContent[]
-}>
+}
 
 export interface AffectedArtifacts {
   recipes: string[]

package/dist/config.d.ts

@@ -354,12 +354,12 @@ export interface Config
    */
   eject?: boolean
   /**
-   * The validation strcictnesss to use when validating the config.
+   * The validation strictness to use when validating the config.
    * - When set to 'none', no validation will be performed.
    * - When set to 'warn', warnings will be logged when validation fails.
    * - When set to 'error', errors will be thrown when validation fails.
    *
-   * @default 'error'
+   * @default 'warn'
    */
   validation?: 'none' | 'warn' | 'error'
 }

package/dist/hooks.d.ts

@@ -1,16 +1,23 @@
-import type { ArtifactId, DiffConfigResult } from './artifact'
+import type { Artifact, ArtifactId, DiffConfigResult } from './artifact'
 import type { LoadConfigResult, UserConfig } from './config'
 import type { HooksApiInterface } from './hooks-api'
+import type { LoggerInterface } from './logger'
 import type { ParserResultInterface } from './parser'
 
-type MaybeAsyncReturn<T = void> = Promise<T> | T
-
 export interface PandaHooks {
   /**
    * Called when the config is resolved, after all the presets are loaded and merged.
    * This is the first hook called, you can use it to tweak the config before the context is created.
    */
-  'config:resolved': (args: { conf: LoadConfigResult }) => MaybeAsyncReturn
+  'config:resolved': (args: ConfigResolvedHookArgs) => MaybeAsyncReturn<void | ConfigResolvedHookArgs['config']>
+  /**
+   * Called when the token engine has been created
+   */
+  'tokens:created': (args: TokenCreatedHookArgs) => MaybeAsyncReturn
+  /**
+   * Called when the classname engine has been created
+   */
+  'utility:created': (args: UtilityCreatedHookArgs) => MaybeAsyncReturn
   /**
    * Called when the Panda context has been created and the API is ready to be used.
    */
@@ -30,6 +37,11 @@ export interface PandaHooks {
    * You can also use this hook to add your own extraction results from your custom parser to the ParserResult object.
    */
   'parser:after': (args: { filePath: string; result: ParserResultInterface | undefined }) => void
+  /**
+   * Called right before writing the codegen files to disk.
+   * You can use this hook to tweak the codegen files before they are written to disk.
+   */
+  'codegen:prepare': (args: { artifacts: Artifact[]; changed: ArtifactId[] | undefined }) => MaybeAsyncReturn
   /**
    * Called after the codegen is completed
    */
@@ -45,17 +57,58 @@ export interface PandaHooks {
   }) => string | void
 }
 
-export interface LoggerInterface {
-  level: 'debug' | 'info' | 'warn' | 'error' | 'silent'
-  print(data: any): void
-  warn: (type: string, data: any) => void
-  info: (type: string, data: any) => void
-  debug: (type: string, data: any) => void
-  error: (type: string, data: any) => void
-  log: (data: string) => void
-  time: {
-    info: (msg: string) => (_msg?: string) => void
-    debug: (msg: string) => (_msg?: string) => void
-  }
-  isDebug: boolean
+type MaybeAsyncReturn<T = void> = Promise<T> | T
+
+interface TokenCssVarOptions {
+  fallback?: string
+  prefix?: string
+  hash?: boolean
+}
+
+interface TokenCssVar {
+  var: `--${string}`
+  ref: string
+}
+
+export interface TokenConfigureOptions {
+  formatTokenName?: (path: string[]) => string
+  formatCssVar?: (path: string[], options: TokenCssVarOptions) => TokenCssVar
+}
+
+export interface TokenCreatedHookArgs {
+  configure(opts: TokenConfigureOptions): void
+}
+
+export interface UtilityConfigureOptions {
+  toHash?(path: string[], toHash: (str: string) => string): string
+}
+
+export interface UtilityCreatedHookArgs {
+  configure(opts: UtilityConfigureOptions): void
+}
+
+interface ConfigResolvedHookUtils {
+  omit: <T, K extends keyof T | (string & {})>(obj: T, paths: K[]) => Omit<T, K>
+  traverse: TraverseFn
+}
+
+export interface ConfigResolvedHookArgs {
+  config: LoadConfigResult['config']
+  path: string
+  dependencies: string[]
+  utils: ConfigResolvedHookUtils
+}
+
+type CallbackFn = (args: CallbackItem) => void
+type CallbackItem = { value: any; path: string; depth: number; parent: any[] | Record<string, unknown>; key: string }
+
+interface TraverseFn {
+  (
+    obj: any,
+    callback: CallbackFn,
+    options?: {
+      separator: string
+      maxDepth?: number | undefined
+    },
+  ): void
 }

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export type * from './conditions'
 export type * from './config'
 export type * from './hooks'
 export type * from './hooks-api'
+export type * from './logger'
 export type * from './parser'
 export type * from './parts'
 export type * from './pattern'

package/dist/logger.d.ts

@@ -0,0 +1,23 @@
+export type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'silent'
+
+export interface LogEntry {
+  level: LogLevel | null
+  msg: string
+  [key: string]: any
+}
+
+export interface LoggerInterface {
+  level: 'debug' | 'info' | 'warn' | 'error' | 'silent'
+  print(data: any): void
+  onLog?: (entry: LogEntry) => void
+  warn: (type: string, data: any) => void
+  info: (type: string, data: any) => void
+  debug: (type: string, data: any) => void
+  error: (type: string, data: any) => void
+  log: (data: string) => void
+  time: {
+    info: (msg: string) => (_msg?: string) => void
+    debug: (msg: string) => (_msg?: string) => void
+  }
+  isDebug: boolean
+}

package/dist/parser.d.ts

@@ -3,7 +3,7 @@ import type { BoxNodeArray, BoxNodeLiteral, BoxNodeMap, Unboxed } from '@pandacs
 export interface ResultItem {
   name?: string
   data: Array<Unboxed['raw']>
-  type?: 'object' | 'cva' | 'sva' | 'pattern' | 'recipe' | 'jsx-factory' | 'jsx-pattern' | 'jsx-recipe' | 'jsx'
+  type?: 'css' | 'cva' | 'sva' | 'pattern' | 'recipe' | 'jsx-factory' | 'jsx-pattern' | 'jsx-recipe' | 'jsx'
   box?: BoxNodeMap | BoxNodeLiteral | BoxNodeArray
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pandacss/types",
-  "version": "0.29.1",
+  "version": "0.30.1",
   "description": "The types for css panda",
   "main": "dist/index.d.ts",
   "author": "Segun Adebayo <joseshegs@gmail.com>",
@@ -30,7 +30,7 @@
     "microdiff": "^1.3.2",
     "ncp": "^2.0.0",
     "pkg-types": "1.0.3",
-    "@pandacss/extractor": "0.29.1"
+    "@pandacss/extractor": "0.30.1"
   },
   "scripts": {
     "dev": "tsx scripts/watch.ts",