@pandacss/types 0.0.0-dev-20221121152823

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Segun Adebayo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@pandacss/types",
+  "version": "0.0.0-dev-20221121152823",
+  "description": "The types for css panda",
+  "main": "src/index.d.ts",
+  "author": "Segun Adebayo <joseshegs@gmail.com>",
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "src"
+  ],
+  "devDependencies": {
+    "csstype": "3.1.1"
+  },
+  "scripts": {}
+}

package/src/composition.d.ts

@@ -0,0 +1,106 @@
+import type { PandaConditionalValue, Properties } from './panda-csstype'
+
+export type Composition<V = any> = {
+  value: V
+  description?: string
+}
+
+type Nested<T> = {
+  [key: string]: T | Nested<T>
+}
+
+type TextStyleProperty =
+  | 'fontSize'
+  | 'fontSizeAdjust'
+  | 'fontVariationSettings'
+  | 'fontVariantPosition'
+  | 'fontVariantCaps'
+  | 'fontVariantNumeric'
+  | 'fontVariantAlternates'
+  | 'fontVariantLigatures'
+  | 'fontFamily'
+  | 'fontWeight'
+  | 'fontSynthesis'
+  | 'fontStyle'
+  | 'fontVariant'
+  | 'lineHeight'
+  | 'letterSpacing'
+  | 'textDecoration'
+  | 'textTransform'
+  | 'textIndent'
+  | 'textDecorationColor'
+  | 'textDecorationLine'
+  | 'textDecorationStyle'
+  | 'textEmphasisColor'
+  | 'textEmphasisPosition'
+  | 'textEmphasisStyle'
+  | 'hyphenateCharacter'
+  | 'textOrientation'
+  | 'textOverflow'
+  | 'textRendering'
+  | (string & {})
+
+type TCondition = Record<string, string>
+
+type TextStyle<Conditions extends TCondition = TCondition> = {
+  [K in TextStyleProperty]?: PandaConditionalValue<Conditions, Properties[K] | (string & {})>
+}
+
+type Placement =
+  | 'Top'
+  | 'Right'
+  | 'Bottom'
+  | 'Left'
+  | 'Inline'
+  | 'Block'
+  | 'InlineStart'
+  | 'InlineEnd'
+  | 'BlockStart'
+  | 'BlockEnd'
+
+type Radius =
+  | `Top${'Right' | 'Left' | 'Start' | 'End'}`
+  | `Bottom${'Right' | 'Left' | 'Start' | 'End'}`
+  | `Start${'Start' | 'End'}`
+  | `End${'Start' | 'End'}`
+
+type LayerStyleProperty =
+  | 'background'
+  | 'backgroundColor'
+  | 'backgroundImage'
+  | 'borderRadius'
+  | 'border'
+  | 'borderWidth'
+  | 'borderColor'
+  | 'borderStyle'
+  | 'boxShadow'
+  | 'filter'
+  | 'backdropFilter'
+  | 'transform'
+  | 'color'
+  | 'opacity'
+  | 'backgroundBlendMode'
+  | 'backgroundAttachment'
+  | 'backgroundClip'
+  | 'backgroundOrigin'
+  | 'backgroundPosition'
+  | 'backgroundRepeat'
+  | 'backgroundSize'
+  | `border${Placement}`
+  | `border${Placement}Width`
+  | `border${Radius}Radius`
+  | `border${Placement}Color`
+  | `border${Placement}Style`
+  | 'padding'
+  | `padding${Placement}`
+  | 'margin'
+  | `margin${Placement}`
+  | (string & {})
+
+type LayerStyle<Conditions extends TCondition = TCondition> = {
+  [K in LayerStyleProperty]?: PandaConditionalValue<Conditions, Properties[K]>
+}
+
+export type TextStyles<Conditions extends TCondition = TCondition> = Nested<Composition<TextStyle<Conditions>>>
+
+export type LayerStyles<Conditions extends TCondition = TCondition> = Nested<Composition<LayerStyle<Conditions>>>

package/src/conditions.d.ts

@@ -0,0 +1,17 @@
+export type BaseConditionType = 'at-rule' | 'parent-nesting' | 'self-nesting' | 'combinator-nesting'
+
+export type BaseCondition = {
+  type: BaseConditionType
+  value: string
+  [key: string]: string
+}
+
+export type RawCondition = BaseCondition & { raw: string }
+
+export type Conditions = {
+  [condition: string]: string
+}
+
+export type RecursiveCondition<T extends string, C extends string> =
+  | T
+  | { [K in C]?: RecursiveCondition<T, Exclude<C, K>> }

package/src/config.d.ts

@@ -0,0 +1,158 @@
+import type { LayerStyles, TextStyles } from './composition'
+import type { Conditions as TConditions } from './conditions'
+import type { Keyframes, GlobalCss } from './panda-csstype'
+import type { PatternConfig } from './pattern'
+import type { RecipeConfig } from './recipe'
+import type { Dict, RequiredBy } from './shared'
+import type { PartialTokens, SemanticTokens } from './tokens'
+import type { UtilityConfig } from './utility'
+import type { ClassGeneratorOptions } from './generator'
+
+export type Config<
+  Conditions extends TConditions = TConditions,
+  Breakpoints extends Dict = Dict,
+  Tokens extends PartialTokens = PartialTokens,
+> = {
+  /**
+   * The value separator used in the generated class names.
+   * @default '_'
+   */
+  separator?: '_' | '=' | '-'
+  /**
+   * The log level for the built-in logger.
+   */
+  logLevel?: 'debug' | 'info' | 'warn' | 'error' | 'silent'
+  /**
+   * Used to create reusable config presets for your project or team.
+   */
+  presets?: string[]
+  /**
+   * Whether to include css reset styles in the generated css.
+   */
+  preflight?: boolean
+  /**
+   * Whether to minify the generated css.
+   */
+  minify?: boolean
+  /**
+   * The current working directory.
+   */
+  cwd?: string
+  /**
+   * Whether to hash the generated class names.
+   * This is useful if want to shorten the class names.
+   */
+  hash?: boolean
+  /**
+   * Whether to clean the output directory before generating the css.
+   */
+  clean?: boolean
+  /**
+   * The output directory.
+   */
+  outdir?: string
+  /**
+   * The css variable options for the generated design tokens
+   */
+  cssVar?: {
+    /**
+     * The prefix for the css variables.
+     */
+    prefix?: string
+    /**
+     * The root selector for the css variables.
+     * @default ':where(:host, :root)'
+     */
+    root?: string
+  }
+  /**
+   * Files to watch for changes.
+   */
+  include?: string[]
+  /**
+   * Files to ignore.
+   */
+  exclude?: string[]
+  /**
+   * Whether to watch for changes and regenerate the css.
+   */
+  watch?: boolean
+  /**
+   * Whether to use polling instead of filesystem events when watching.
+   */
+  poll?: boolean
+  /**
+   * The css selectors or media queries shortcuts.
+   * @example `{ hover: "&:hover" }`
+   */
+  conditions?: TConditions
+  /**
+   * The breakpoints for your project.
+   */
+  breakpoints?: Breakpoints
+  /**
+   * The css animation keyframes definitions.
+   */
+  keyframes?: Keyframes
+  /**
+   * The global styles for your project.
+   */
+  globalCss?: GlobalCss
+  /**
+   * The design tokens for your project.
+   */
+  tokens?: Tokens
+  /**
+   * The semantic design tokens for your project.
+   */
+  semanticTokens?: SemanticTokens<keyof Conditions | keyof Breakpoints | 'base' | '_'>
+  /**
+   * The typography styles for your project.
+   */
+  textStyles?: TextStyles
+  /**
+   * The layer styles for your project.
+   */
+  layerStyles?: LayerStyles
+  /**
+   * The css utility definitions.
+   */
+  utilities?: UtilityConfig
+  /**
+   * Multi-variant style definitions for your project.
+   * Useful for defining component styles.
+   */
+  recipes?: Record<string, RecipeConfig>
+  /**
+   * Common styling or layout patterns for your project.
+   */
+  patterns?: Record<string, PatternConfig>
+  /**
+   * The framework to use for generating supercharged elements.
+   * @default 'react'
+   */
+  jsxFramework?: 'react' | 'solid' | 'preact'
+  /**
+   * The factory name of the element
+   * @default 'panda'
+   *
+   * @example
+   * ```jsx
+   * <panda.button marginTop="40px">Click me</panda.button>
+   * ```
+   */
+  jsxFactory?: string
+  /**
+   * Options for the generated typescript definitions.
+   */
+  strictTokens?: boolean
+  /**
+   * @experimental
+   * Used to generate css utility classes for your project.
+   */
+  generator?: ClassGeneratorOptions
+}
+
+export type TConfig = Config<TConditions, Dict, Dict>
+
+export type UserConfig = RequiredBy<Config, 'outdir' | 'cwd' | 'include'>