style-dictionary 4.2.0 → 4.3.0

package/types/Config.d.ts

@@ -6,6 +6,10 @@ import type { Preprocessor } from './Preprocessor.js';
 import type { Transform } from './Transform.js';
 import type { Format, OutputReferences } from './Format.js';
 import type { Action } from './Action.js';
+import { logBrokenReferenceLevels, logWarningLevels, logVerbosityLevels } from '../lib/enums/index.js';
+type logWarningLevels = typeof logWarningLevels;
+type logVerbosityLevels = typeof logVerbosityLevels;
+type logBrokenReferenceLevels = typeof logBrokenReferenceLevels;
 export interface Hooks {
     parsers?: Record<string, Omit<Parser, 'name'>>;
     preprocessors?: Record<string, Preprocessor['preprocessor']>;
@@ -47,10 +51,10 @@ export interface ResolveReferencesOptionsInternal extends ResolveReferencesOptio
     firstIteration?: boolean;
 }
 export interface LogConfig {
-    warnings?: 'warn' | 'error' | 'disabled';
-    verbosity?: 'default' | 'silent' | 'verbose';
+    warnings?: logWarningLevels[keyof logWarningLevels];
+    verbosity?: logVerbosityLevels[keyof logVerbosityLevels];
     errors?: {
-        brokenReferences?: 'throw' | 'console';
+        brokenReferences?: logBrokenReferenceLevels[keyof logBrokenReferenceLevels];
     };
 }
 export type ExpandFilter = (token: DesignToken, options: Config, platform?: PlatformConfig) => boolean;
@@ -65,6 +69,7 @@ export interface PlatformConfig extends RegexOptions {
     transformGroup?: string;
     transforms?: string[] | Omit<Transform, 'name'>[];
     expand?: ExpandConfig;
+    preprocessors?: string[];
     prefix?: string;
     buildPath?: string;
     files?: File[];
@@ -84,3 +89,4 @@ export interface Config {
     preprocessors?: string[];
     usesDtcg?: boolean;
 }
+export {};

package/types/DesignToken.d.ts

@@ -12,6 +12,10 @@ export interface DesignToken {
     comment?: string;
     themeable?: boolean;
     attributes?: Record<string, unknown>;
+    /**
+     * When flattening tokens, DesignToken is given a key that matches the original ancestor tree e.g. `{colors.red.500}`
+     */
+    key?: string;
     [key: string]: any;
 }
 export interface DesignTokens {
@@ -51,6 +55,8 @@ export interface TransformedTokens {
 export interface Dictionary {
     tokens: TransformedTokens;
     allTokens: TransformedToken[];
+    tokenMap: Map<string, TransformedToken>;
     unfilteredTokens?: TransformedTokens;
     unfilteredAllTokens?: TransformedToken[];
+    unfilteredTokenMap?: Map<string, TransformedToken>;
 }

package/types/File.d.ts

@@ -2,6 +2,9 @@ import type { TransformedToken } from './DesignToken.js';
 import type { FormatFn } from './Format.js';
 import type { LocalOptions, Config } from './Config.js';
 import type { Filter } from './Filter.js';
+import { commentPositions, commentStyles } from '../lib/enums/index.js';
+type commentStyles = typeof commentStyles;
+type commentPositions = typeof commentPositions;
 export interface FormattingOptions extends FormattingOverrides {
     prefix?: string;
     suffix?: string;
@@ -9,8 +12,8 @@ export interface FormattingOptions extends FormattingOverrides {
     separator?: string;
 }
 export interface FormattingOverrides {
-    commentStyle?: 'short' | 'long' | 'none';
-    commentPosition?: 'above' | 'inline';
+    commentStyle?: commentStyles[keyof commentStyles];
+    commentPosition?: commentPositions[keyof commentPositions];
     indentation?: string;
     header?: string;
     footer?: string;
@@ -23,3 +26,4 @@ export interface File {
     filter?: string | Partial<TransformedToken> | Filter['filter'];
     options?: LocalOptions;
 }
+export {};

package/types/Format.d.ts

@@ -1,6 +1,8 @@
 import type { Dictionary, TransformedToken } from './DesignToken.js';
 import type { File } from './File.js';
 import type { LocalOptions, Config, PlatformConfig } from './Config.js';
+import { formats } from '../lib/enums/index.js';
+type formats = typeof formats;
 export interface FormatFnArguments {
     /**
      * The transformed and resolved dictionary object
@@ -27,10 +29,11 @@ export type FormatFn = ((args: FormatFnArguments) => unknown | Promise<unknown>)
     nested?: boolean;
 };
 export interface Format {
-    name: string;
+    name: string | formats[keyof formats];
     format: FormatFn;
 }
 export type OutputReferences = ((token: TransformedToken, options: {
     dictionary: Dictionary;
     usesDtcg?: boolean;
 }) => boolean) | boolean;
+export {};

package/types/Transform.d.ts

@@ -2,6 +2,7 @@ import type { Filter } from './Filter.js';
 import type { TransformedToken } from './DesignToken.js';
 import type { PlatformConfig, Config } from './Config.js';
 import type { Volume } from './Volume.js';
+import { transformTypes } from '../lib/enums/index.js';
 interface BaseTransform<Type, Value> {
     name: string;
     type: Type;
@@ -9,8 +10,8 @@ interface BaseTransform<Type, Value> {
     transitive?: boolean;
     transform: (token: TransformedToken, config: PlatformConfig, options: Config, vol?: Volume) => Promise<Value> | Value;
 }
-export type NameTransform = BaseTransform<'name', string>;
-export type AttributeTransform = BaseTransform<'attribute', Record<string, unknown>>;
-export type ValueTransform = BaseTransform<'value', unknown | undefined>;
+export type NameTransform = BaseTransform<typeof transformTypes.name, string>;
+export type AttributeTransform = BaseTransform<typeof transformTypes.attribute, Record<string, unknown>>;
+export type ValueTransform = BaseTransform<typeof transformTypes.value, unknown | undefined>;
 export type Transform = NameTransform | AttributeTransform | ValueTransform;
 export {};