@pandacss/token-dictionary 0.4.0 → 0.5.0

package/dist/index.d.mts

@@ -0,0 +1,156 @@
+import { Tokens, SemanticTokens } from '@pandacss/types';
+
+type TokenStatus = 'deprecated' | 'experimental' | 'new';
+type ExtensionData = {
+    status?: TokenStatus;
+    category?: string;
+    references?: TokenReferences;
+    condition?: string;
+    conditions?: TokenConditions;
+};
+type TokenConditions = Record<string, string>;
+type TokenReferences = Record<string, Token>;
+type TokenExtensions = ExtensionData & {
+    [key: string]: any;
+};
+type ExtendedToken = {
+    name: string;
+    value: any;
+    type?: string;
+    path?: string[];
+    description?: string;
+    extensions?: TokenExtensions;
+};
+/**
+ * Represents a design token in the dictionary
+ */
+declare class Token {
+    name: string;
+    value: any;
+    originalValue: any;
+    path: string[];
+    type?: string;
+    description?: string;
+    extensions: TokenExtensions;
+    constructor(data: ExtendedToken);
+    /**
+     * The unique identifier of the token.
+     */
+    get id(): string;
+    /**
+     * Whether the token is a conditional token.
+     * Conditional tokens are tokens that have multiple values based on a condition.
+     */
+    get isConditional(): boolean;
+    /**
+     * Whether the token has a reference in its value.
+     * e.g. {color.gray.100}
+     */
+    get hasReference(): boolean;
+    /**
+     * Whether the token is a complex or composite token.
+     */
+    get isComposite(): boolean;
+    /**
+     * Returns the token value with the references expanded.
+     * e.g. {color.gray.100} => #f7fafc
+     *
+     */
+    expandReferences(): string;
+    /**
+     * Whether this token has a reference to another token
+     */
+    get isReference(): boolean;
+    /**
+     * Returns the list of references in the token value
+     */
+    get references(): string[];
+    clone(): Token;
+    /**
+     * Returns an array of tokens per conditions.
+     * It is commonly used in semantic tokens, and can have multiple values based on a condition.
+     * e.g. primary: { light: '#000', dark: '#fff' }
+     */
+    getConditionTokens(): Token[] | undefined;
+    /**
+     * Add more extensions to the token
+     */
+    setExtensions(extensions: TokenExtensions): this;
+    setType(): void;
+}
+
+type EnforcePhase = 'pre' | 'post';
+type Options = {
+    prefix?: string;
+    hash?: boolean;
+};
+type TokenTransformer = {
+    name: string;
+    enforce?: EnforcePhase;
+    type?: 'value' | 'name' | 'extensions';
+    match?: (token: Token) => boolean;
+    transform: (token: Token, options: Options) => any;
+};
+type TokenDictionaryOptions = {
+    tokens?: Tokens;
+    semanticTokens?: SemanticTokens;
+    breakpoints?: Record<string, string>;
+    prefix?: string;
+    hash?: boolean;
+};
+type TokenMiddleware = {
+    enforce?: EnforcePhase;
+    transform: (dict: TokenDictionary$1, options: Options) => void;
+};
+declare class TokenDictionary$1 {
+    allTokens: Token[];
+    prefix: string | undefined;
+    hash: boolean | undefined;
+    get allNames(): string[];
+    constructor(options: TokenDictionaryOptions);
+    getByName: (name: string) => Token | undefined;
+    private transforms;
+    registerTransform(...transforms: TokenTransformer[]): this;
+    private execTransform;
+    transformTokens(enforce: EnforcePhase): this;
+    private middlewares;
+    registerMiddleware(...middlewares: TokenMiddleware[]): this;
+    applyMiddlewares(enforce: EnforcePhase): void;
+    getReferences(value: string): Token[];
+    usesReference(value: any): boolean;
+    addReferences(): this;
+    filter(pattern: Partial<Token> | ((token: Token) => boolean)): Token[];
+    addConditionalTokens(): this;
+    expandReferences(): this;
+    build(): void;
+    get isEmpty(): boolean;
+}
+
+declare class TokenDictionary extends TokenDictionary$1 {
+    constructor(options: TokenDictionaryOptions);
+    get get(): (path: string, fallback?: string | number | undefined) => string;
+    get conditionMap(): Map<string, Set<Token>>;
+    get categoryMap(): Map<string, Map<string, Token>>;
+    get values(): Map<string, Map<string, string>>;
+    get colorPalettes(): {
+        clear: never;
+        delete: never;
+        forEach: never;
+        get: never;
+        has: never;
+        set: never;
+        readonly size: never;
+        entries: never;
+        keys: never;
+        values: never;
+        [Symbol.iterator]: never;
+        readonly [Symbol.toStringTag]: never;
+    };
+    get vars(): Map<string, Map<string, string>>;
+    getValue(path: string): {
+        [k: string]: string;
+    } | undefined;
+    getTokenVar(path: string): any;
+}
+
+export { Token, TokenDictionary };

package/dist/index.js

@@ -71,7 +71,7 @@ function assertTokenFormat(token) {
 }
 
 // src/token.ts
-var Token = class {
+var Token = class _Token {
   name;
   value;
   originalValue;
@@ -153,7 +153,7 @@ var Token = class {
     return getReferences(this.originalValue);
   }
   clone() {
-    return new Token({
+    return new _Token({
       name: this.name,
       value: this.value,
       type: this.type,

package/dist/index.mjs

@@ -44,7 +44,7 @@ function assertTokenFormat(token) {
 }
 
 // src/token.ts
-var Token = class {
+var Token = class _Token {
   name;
   value;
   originalValue;
@@ -126,7 +126,7 @@ var Token = class {
     return getReferences(this.originalValue);
   }
   clone() {
-    return new Token({
+    return new _Token({
       name: this.name,
       value: this.value,
       type: this.type,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pandacss/token-dictionary",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Common error messages for css panda",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -15,11 +15,11 @@
   ],
   "dependencies": {
     "ts-pattern": "4.3.0",
-    "@pandacss/types": "0.4.0",
-    "@pandacss/shared": "0.4.0"
+    "@pandacss/types": "0.5.0",
+    "@pandacss/shared": "0.5.0"
   },
   "devDependencies": {
-    "@pandacss/fixture": "0.4.0"
+    "@pandacss/fixture": "0.5.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format=esm,cjs --dts",