@pandacss/types 0.30.0 → 0.30.2

package/dist/hooks.d.ts

@@ -21,44 +21,45 @@ export interface PandaHooks {
   /**
    * Called when the Panda context has been created and the API is ready to be used.
    */
-  'context:created': (args: { ctx: HooksApiInterface; logger: LoggerInterface }) => void
+  'context:created': (args: ContextCreatedHookArgs) => void
   /**
    * Called when the config file or one of its dependencies (imports) has changed.
    */
-  'config:change': (args: { config: UserConfig; changes: DiffConfigResult }) => MaybeAsyncReturn
+  'config:change': (args: ConfigChangeHookArgs) => MaybeAsyncReturn
   /**
    * Called after reading the file content but before parsing it.
    * You can use this hook to transform the file content to a tsx-friendly syntax so that Panda's parser can parse it.
    * You can also use this hook to parse the file's content on your side using a custom parser, in this case you don't have to return anything.
    */
-  'parser:before': (args: { filePath: string; content: string }) => string | void
+  'parser:before': (args: ParserResultBeforeHookArgs) => string | void
   /**
    * Called after the file styles are extracted and processed into the resulting ParserResult object.
    * 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
+  'parser:after': (args: ParserResultAfterHookArgs) => 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
+  'codegen:prepare': (args: CodegenPrepareHookArgs) => MaybeAsyncReturn
   /**
    * Called after the codegen is completed
    */
-  'codegen:done': (args: { changed: ArtifactId[] | undefined }) => MaybeAsyncReturn
+  'codegen:done': (args: CodegenDoneHookArgs) => MaybeAsyncReturn
   /**
    * Called right before adding the design-system CSS (global, static, preflight, tokens, keyframes) to the final CSS
    * Called right before writing/injecting the final CSS (styles.css) that contains the design-system CSS and the parser CSS
    * You can use it to tweak the CSS content before it's written to disk or injected through the postcss plugin.
    */
-  'cssgen:done': (args: {
-    artifact: 'global' | 'static' | 'reset' | 'tokens' | 'keyframes' | 'styles.css'
-    content: string
-  }) => string | void
+  'cssgen:done': (args: CssgenDoneHookArgs) => string | void
 }
 
 type MaybeAsyncReturn<T = void> = Promise<T> | T
 
+/* -----------------------------------------------------------------------------
+ * Token hooks
+ * -----------------------------------------------------------------------------*/
+
 interface TokenCssVarOptions {
   fallback?: string
   prefix?: string
@@ -79,6 +80,10 @@ export interface TokenCreatedHookArgs {
   configure(opts: TokenConfigureOptions): void
 }
 
+/* -----------------------------------------------------------------------------
+ * Utility hooks
+ * -----------------------------------------------------------------------------*/
+
 export interface UtilityConfigureOptions {
   toHash?(path: string[], toHash: (str: string) => string): string
 }
@@ -87,6 +92,29 @@ export interface UtilityCreatedHookArgs {
   configure(opts: UtilityConfigureOptions): void
 }
 
+/* -----------------------------------------------------------------------------
+ * Config hooks
+ * -----------------------------------------------------------------------------*/
+
+interface CallbackItem {
+  value: any
+  path: string
+  depth: number
+  parent: any[] | Record<string, unknown>
+  key: string
+}
+
+type CallbackFn = (args: CallbackItem) => void
+
+interface TraverseOptions {
+  separator: string
+  maxDepth?: number | undefined
+}
+
+interface TraverseFn {
+  (obj: any, callback: CallbackFn, options?: TraverseOptions): void
+}
+
 interface ConfigResolvedHookUtils {
   omit: <T, K extends keyof T | (string & {})>(obj: T, paths: K[]) => Omit<T, K>
   traverse: TraverseFn
@@ -99,16 +127,60 @@ export interface ConfigResolvedHookArgs {
   utils: ConfigResolvedHookUtils
 }
 
-type CallbackFn = (args: CallbackItem) => void
-type CallbackItem = { value: any; path: string; depth: number; parent: any[] | Record<string, unknown>; key: string }
+export interface ConfigChangeHookArgs {
+  config: UserConfig
+  changes: DiffConfigResult
+}
 
-interface TraverseFn {
-  (
-    obj: any,
-    callback: CallbackFn,
-    options?: {
-      separator: string
-      maxDepth?: number | undefined
-    },
-  ): void
+/* -----------------------------------------------------------------------------
+ * Parser hooks
+ * -----------------------------------------------------------------------------*/
+
+export interface ParserResultConfigureOptions {
+  matchTag?: (tag: string, isPandaComponent: boolean) => boolean
+  matchTagProp?: (tag: string, prop: string) => boolean
+}
+
+export interface ParserResultBeforeHookArgs {
+  filePath: string
+  content: string
+  configure: (opts: ParserResultConfigureOptions) => void
+}
+
+export interface ParserResultAfterHookArgs {
+  filePath: string
+  result: ParserResultInterface | undefined
+}
+
+/* -----------------------------------------------------------------------------
+ * Codegen hooks
+ * -----------------------------------------------------------------------------*/
+
+export interface CodegenPrepareHookArgs {
+  artifacts: Artifact[]
+  changed: ArtifactId[] | undefined
+}
+
+export interface CodegenDoneHookArgs {
+  changed: ArtifactId[] | undefined
+}
+
+/* -----------------------------------------------------------------------------
+ * Cssgen hooks
+ * -----------------------------------------------------------------------------*/
+
+type CssgenArtifact = 'global' | 'static' | 'reset' | 'tokens' | 'keyframes' | 'styles.css'
+
+export interface CssgenDoneHookArgs {
+  artifact: CssgenArtifact
+  content: string
+}
+
+/* -----------------------------------------------------------------------------
+ * Context hooks
+ * -----------------------------------------------------------------------------*/
+
+export interface ContextCreatedHookArgs {
+  ctx: HooksApiInterface
+  logger: LoggerInterface
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pandacss/types",
-  "version": "0.30.0",
+  "version": "0.30.2",
   "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.30.0"
+    "@pandacss/extractor": "0.30.2"
   },
   "scripts": {
     "dev": "tsx scripts/watch.ts",