fix: add missing expand config types, docs note (#1335)

.changeset/little-pugs-pump.md

@@ -0,0 +1,5 @@
+---
+'style-dictionary': patch
+---
+
+Add missing type interfaces, most notably the ExpandConfig types.

__tests__/utils/flattenProperties.test.js → __tests__/utils/flattenTokens.test.js

@@ -67,5 +67,29 @@ describe('utils', () => {
       const sortedRet = ret.sort(sortBy('value'));
       expect(sortedRet).to.eql(sortedExpectedRet);
     });
+
+    it('should return nested leaf node values using DTCG spec as an array', () => {
+      const tokens = {
+        color: {
+          black: {
+            name: 'color.black',
+            $value: '#000000',
+            $type: 'color',
+          },
+          white: {
+            name: 'color.white',
+            $value: '#FFFFFF',
+            $type: 'color',
+          },
+        },
+      };
+      const ret = flattenTokens(tokens, { usesDtcg: true });
+
+      const expected_ret = [tokens.color.black, tokens.color.white];
+      const sortedExpectedRet = expected_ret.sort(sortBy('value'));
+      const sortedRet = ret.sort(sortBy('value'));
+
+      expect(sortedRet).to.eql(sortedExpectedRet);
+    });
   });
 });

docs/src/content/docs/reference/Utils/tokens.md

@@ -8,6 +8,10 @@ These utilities have to do with processing/formatting tokens object.
 
 Flatten dictionary tokens object to an array of flattened tokens.
 
+:::note
+Only the "value" / "$value" property is required for this utility to consider a leaf node a "token" to be added to the flattened array output.
+:::
+
 ```javascript title="build-tokens.js"
 import StyleDictionary from 'style-dictionary';
 import { flattenTokens } from 'style-dictionary/utils';

lib/Register.js

@@ -293,7 +293,7 @@ export class Register {
   }
 
   /**
-   * @param {import('../types/Parser.ts').Parser} parser
+   * @param {Parser} parser
    * @param {typeof Register | Register} target
    */
   static __registerParser(parser, target) {

types/index.ts

@@ -1,6 +1,15 @@
 export type { Action } from './Action.ts';
 
-export type { PlatformConfig, Config, LocalOptions, LogConfig } from './Config.ts';
+export type {
+  PlatformConfig,
+  Config,
+  LocalOptions,
+  LogConfig,
+  Hooks,
+  ExpandFilter,
+  Expand,
+  ExpandConfig,
+} from './Config.ts';
 
 export type {
   DesignToken,