@ama-styling/style-dictionary 13.0.0-next.2 → 13.0.0-next.21

package/README.md

@@ -159,7 +159,7 @@ To enhance and facilitate the configuration of the `StyleDictionary` instance, t
 
 The `getTargetFiles` function is used to parameterize the generated file based on Design Token (following the same logic as `$extensions`):
 
-```typescript
+```javascript
 // Example to generate the `color-primary-**` variables in `my-color-primary.css`
 
 import { getTargetFiles } from '@ama-styling/style-dictionary';
@@ -190,6 +190,22 @@ register(sd); // Register all Otter modules
 > The `format` option will be applied to all the files provided to the `getTargetFiles` function (including `defaultFile`).
 > `defaultFile` defines the default file where variables not matching any rule will be generated.
 
+The helper function `getTargetFiles` is registering the filter into `StyleDictionary` with a unique ID.\
+This IDs can be retrieved as follows:
+
+```javascript
+import { getTargetFiles } from '@ama-styling/style-dictionary';
+
+const sd = new StyleDictionary();
+const files = getTargetFiles({ rules, { styleDictionary: sd } });
+
+/**
+ * Filter IDs registered in {@link sd} Style Dictionary instance
+ * @type {string[]}
+ **/
+const filterIds = files.map(({ filter }) => filter);
+```
+
 ## Advanced
 
 ### Basic Node Configuration Example

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ama-styling/style-dictionary",
-  "version": "13.0.0-next.2",
+  "version": "13.0.0-next.21",
   "type": "module",
   "publishConfig": {
     "access": "public"
@@ -39,17 +39,17 @@
     }
   },
   "dependencies": {
-    "@angular-devkit/architect": "~0.1902.0",
-    "@angular-devkit/schematics": "~19.2.0",
-    "@o3r/schematics": "^13.0.0-next.2",
-    "@schematics/angular": "~19.2.0",
+    "@angular-devkit/architect": "~0.2000.0",
+    "@angular-devkit/schematics": "~20.0.0",
+    "@o3r/schematics": "^13.0.0-next.21",
+    "@schematics/angular": "~20.0.0",
     "tslib": "^2.6.2"
   },
   "peerDependencies": {
-    "@o3r/core": "^13.0.0-next.2",
-    "@o3r/schematics": "^13.0.0-next.2",
-    "@o3r/telemetry": "^13.0.0-next.2",
-    "style-dictionary": "^4.3.2",
+    "@o3r/core": "^13.0.0-next.21",
+    "@o3r/schematics": "^13.0.0-next.21",
+    "@o3r/telemetry": "^13.0.0-next.21",
+    "style-dictionary": "^5.0.0",
     "type-fest": "^4.30.1"
   },
   "peerDependenciesMeta": {
@@ -73,32 +73,32 @@
     }
   },
   "devDependencies": {
-    "@babel/core": "~7.27.0",
-    "@babel/preset-env": "~7.27.0",
+    "@babel/core": "~7.28.0",
+    "@babel/preset-env": "~7.28.0",
     "@babel/preset-typescript": "~7.27.0",
     "@compodoc/compodoc": "^1.1.19",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.0",
-    "@nx/eslint": "~20.8.0",
-    "@nx/eslint-plugin": "~20.8.0",
-    "@nx/jest": "~20.8.0",
-    "@nx/js": "~20.8.0",
-    "@o3r/build-helpers": "^13.0.0-next.2",
-    "@o3r/core": "^13.0.0-next.2",
-    "@o3r/eslint-plugin": "^13.0.0-next.2",
-    "@o3r/telemetry": "^13.0.0-next.2",
-    "@o3r/test-helpers": "^13.0.0-next.2",
-    "@schematics/angular": "~19.2.0",
+    "@nx/eslint": "~21.3.11",
+    "@nx/eslint-plugin": "~21.3.11",
+    "@nx/jest": "~21.3.11",
+    "@nx/js": "~21.3.11",
+    "@o3r/build-helpers": "^13.0.0-next.21",
+    "@o3r/core": "^13.0.0-next.21",
+    "@o3r/eslint-plugin": "^13.0.0-next.21",
+    "@o3r/telemetry": "^13.0.0-next.21",
+    "@o3r/test-helpers": "^13.0.0-next.21",
+    "@schematics/angular": "~20.0.0",
     "@stylistic/eslint-plugin": "~3.1.0",
     "@types/jest": "~29.5.2",
     "@types/minimist": "^1.2.2",
     "@types/node": "^20.0.0",
     "@types/semver": "^7.3.13",
-    "@typescript-eslint/parser": "~8.35.0",
-    "angular-eslint": "~19.4.0",
+    "@typescript-eslint/parser": "~8.37.0",
+    "angular-eslint": "~20.1.0",
     "babel-jest": "^29.7.0",
     "chokidar": "^4.0.3",
     "cpy-cli": "^5.0.0",
-    "eslint": "~9.29.0",
+    "eslint": "~9.31.0",
     "eslint-import-resolver-node": "~0.3.9",
     "eslint-import-resolver-typescript": "~3.10.0",
     "eslint-plugin-import": "~2.32.0",
@@ -113,18 +113,18 @@
     "jest-junit": "~16.0.0",
     "jest-resolve": "~29.7.0",
     "jsonc-eslint-parser": "~2.4.0",
-    "nx": "~20.8.0",
+    "nx": "~21.3.11",
     "pid-from-port": "^1.1.3",
-    "style-dictionary": "~4.4.0",
+    "style-dictionary": "~5.0.0",
     "ts-jest": "~29.3.0",
     "ts-node": "~10.9.2",
     "type-fest": "^4.30.1",
     "typescript": "~5.8.2",
-    "typescript-eslint": "~8.35.0",
+    "typescript-eslint": "~8.37.0",
     "zone.js": "~0.15.0"
   },
   "engines": {
-    "node": "^20.11.1 || >=22.0.0"
+    "node": "^20.19.0 || ^22.12.0 || ^24.0.0"
   },
   "schematics": "./collection.json",
   "contributors": [

package/schematics/ng-add/schema.json

@@ -9,7 +9,8 @@
       "description": "Project name",
       "$default": {
         "$source": "projectName"
-      }
+      },
+      "alias": "project"
     },
     "exactO3rVersion": {
       "type": "boolean",

package/src/filters/target-file.filter.d.mts

@@ -1,3 +1,4 @@
+import StyleDictionary from 'style-dictionary';
 import type { File, FormatFn } from 'style-dictionary/types';
 /** Options to get file filters */
 interface TargetFileOptions {
@@ -7,6 +8,8 @@ interface TargetFileOptions {
     rootPath?: string;
     /** Default file if not matching any rule */
     defaultFile?: string;
+    /** styleDictionary instance */
+    styleDictionary?: StyleDictionary;
 }
 /** Mapping of the Design Tokens to a given file */
 export interface FileRuleNode {

package/src/filters/target-file.filter.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"target-file.filter.d.mts","sourceRoot":"","sources":["../../../src/filters/target-file.filter.mts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EACV,IAAI,EACJ,QAAQ,EACT,MAAM,wBAAwB,CAAC;AAKhC,kCAAkC;AAClC,UAAU,iBAAiB;IACzB,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC3B,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,mDAAmD;AACnD,MAAM,WAAW,YAAY;IAC3B,oDAAoD;IACpD,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,YAAY,CAAC;CACvC;AAgBD;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,WAAW,YAAY,EAAE,UAAU,iBAAiB,KAAG,IAAI,EAgCzF,CAAC"}
+{"version":3,"file":"target-file.filter.d.mts","sourceRoot":"","sources":["../../../src/filters/target-file.filter.mts"],"names":[],"mappings":"AAOA,OAAO,eAEN,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACV,IAAI,EACJ,QAAQ,EACT,MAAM,wBAAwB,CAAC;AAQhC,kCAAkC;AAClC,UAAU,iBAAiB;IACzB,mCAAmC;IACnC,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC3B,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+BAA+B;IAC/B,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED,mDAAmD;AACnD,MAAM,WAAW,YAAY;IAC3B,oDAAoD;IACpD,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,YAAY,CAAC;CACvC;AAgBD;;;;GAIG;AACH,eAAO,MAAM,cAAc,GAAI,WAAW,YAAY,EAAE,UAAU,iBAAiB,KAAG,IAAI,EAwCzF,CAAC"}

package/src/filters/target-file.filter.mjs

@@ -1,4 +1,7 @@
+import { randomUUID, } from 'node:crypto';
 import { normalize, resolve, } from 'node:path';
+import StyleDictionary from 'style-dictionary';
+import { OTTER_NAME_PREFIX, } from '../constants.mjs';
 import { deflatten, } from '../helpers/config-deflatten.helpers.mjs';
 const getPathMap = (rule, path = [], map = new Map()) => {
     return Object.entries(rule)
@@ -18,27 +21,33 @@ const getPathMap = (rule, path = [], map = new Map()) => {
  * @param options
  */
 export const getTargetFiles = (fileRules, options) => {
+    const styleDictionary = options?.styleDictionary || StyleDictionary;
     const flatterRules = deflatten(fileRules);
     const fileMap = getPathMap(flatterRules);
     const fileMapEntries = [...fileMap.entries()];
-    return [
-        ...fileMapEntries
-            .map(([filePath, nodes]) => {
-            return {
-                destination: options?.rootPath ? resolve(options.rootPath, filePath) : filePath,
-                format: options?.format,
-                filter: (token) => nodes.some((path) => path.every((item, idx) => token.path[idx] === item))
-            };
-        }),
-        ...(options?.defaultFile
-            ? [{
-                    destination: options.rootPath ? resolve(options.rootPath, options.defaultFile) : options.defaultFile,
-                    format: options?.format,
-                    filter: (token) => !fileMapEntries
-                        .filter(([filePath]) => normalize(filePath) !== normalize(options.defaultFile))
-                        .some(([, nodes]) => nodes.some((path) => path.every((item, idx) => token.path[idx] === item)))
-                }]
-            : [])
-    ];
+    const files = fileMapEntries
+        .map(([filePath, nodes]) => {
+        const filter = (token) => nodes.some((path) => path.every((item, idx) => token.path[idx] === item));
+        const name = `${OTTER_NAME_PREFIX}/filter/${randomUUID()}`;
+        styleDictionary.registerFilter({ name, filter });
+        return {
+            destination: options?.rootPath ? resolve(options.rootPath, filePath) : filePath,
+            format: options?.format,
+            filter: name
+        };
+    });
+    if (options?.defaultFile) {
+        const filter = (token) => !fileMapEntries
+            .filter(([filePath]) => normalize(filePath) !== normalize(options.defaultFile))
+            .some(([, nodes]) => nodes.some((path) => path.every((item, idx) => token.path[idx] === item)));
+        const name = `${OTTER_NAME_PREFIX}/filter/${randomUUID()}`;
+        styleDictionary.registerFilter({ name, filter });
+        files.push({
+            destination: options.rootPath ? resolve(options.rootPath, options.defaultFile) : options.defaultFile,
+            format: options?.format,
+            filter: name
+        });
+    }
+    return files;
 };
 //# sourceMappingURL=target-file.filter.mjs.map

package/src/filters/target-file.filter.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"target-file.filter.mjs","sourceRoot":"","sources":["../../../src/filters/target-file.filter.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,OAAO,GACR,MAAM,WAAW,CAAC;AAKnB,OAAO,EACL,SAAS,GACV,MAAM,yCAAyC,CAAC;AAkBjD,MAAM,UAAU,GAAG,CAAC,IAAkB,EAAE,OAAiB,EAAE,EAAE,MAA+B,IAAI,GAAG,EAAE,EAA2B,EAAE;IAChI,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACxB,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,aAAa,CAAC;SAC1C,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;QAC7B,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,CAAC;QACpC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;YACzD,OAAO,GAAG,CAAC;QACb,CAAC;QAED,OAAO,UAAU,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC,EAAE,GAAG,CAAC,CAAC;AACZ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,SAAuB,EAAE,OAA2B,EAAU,EAAE;IAC7F,MAAM,YAAY,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;IACzC,MAAM,cAAc,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAE9C,OAAO;QACL,GAAG,cAAc;aACd,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAQ,EAAE;YAC/B,OAAO;gBACL,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ;gBAC/E,MAAM,EAAE,OAAO,EAAE,MAAM;gBACvB,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAChB,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAClB,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,CACpD;aACJ,CAAC;QACJ,CAAC,CAAC;QACJ,GAAG,CAAC,OAAO,EAAE,WAAW;YACtB,CAAC,CAAC,CAAC;oBACD,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW;oBACpG,MAAM,EAAE,OAAO,EAAE,MAAM;oBACvB,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAChB,CAAC,cAAc;yBACZ,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,OAAO,CAAC,WAAY,CAAC,CAAC;yBAC/E,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAClB,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAClB,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,CACpD,CACF;iBACS,CAAC;YACjB,CAAC,CAAC,EAAE,CAAC;KACR,CAAC;AACJ,CAAC,CAAC"}
+{"version":3,"file":"target-file.filter.mjs","sourceRoot":"","sources":["../../../src/filters/target-file.filter.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,GACX,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,SAAS,EACT,OAAO,GACR,MAAM,WAAW,CAAC;AACnB,OAAO,eAEN,MAAM,kBAAkB,CAAC;AAK1B,OAAO,EACL,iBAAiB,GAClB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,SAAS,GACV,MAAM,yCAAyC,CAAC;AAoBjD,MAAM,UAAU,GAAG,CAAC,IAAkB,EAAE,OAAiB,EAAE,EAAE,MAA+B,IAAI,GAAG,EAAE,EAA2B,EAAE;IAChI,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACxB,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,aAAa,CAAC;SAC1C,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE;QAC7B,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,CAAC;QACpC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;YACzD,OAAO,GAAG,CAAC;QACb,CAAC;QAED,OAAO,UAAU,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC,EAAE,GAAG,CAAC,CAAC;AACZ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,SAAuB,EAAE,OAA2B,EAAU,EAAE;IAC7F,MAAM,eAAe,GAAG,OAAO,EAAE,eAAe,IAAI,eAAe,CAAC;IACpE,MAAM,YAAY,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC;IACzC,MAAM,cAAc,GAAG,CAAC,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAE9C,MAAM,KAAK,GAAG,cAAc;SACzB,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAQ,EAAE;QAC/B,MAAM,MAAM,GAAqB,CAAC,KAAK,EAAE,EAAE,CACzC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAClB,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,CACpD,CAAC;QACJ,MAAM,IAAI,GAAG,GAAG,iBAAiB,WAAW,UAAU,EAAE,EAAE,CAAC;QAC3D,eAAe,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACjD,OAAO;YACL,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ;YAC/E,MAAM,EAAE,OAAO,EAAE,MAAM;YACvB,MAAM,EAAE,IAAI;SACb,CAAC;IACJ,CAAC,CAAC,CAAC;IAEL,IAAI,OAAO,EAAE,WAAW,EAAE,CAAC;QACzB,MAAM,MAAM,GAAqB,CAAC,KAAK,EAAE,EAAE,CACzC,CAAC,cAAc;aACZ,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,OAAO,CAAC,WAAY,CAAC,CAAC;aAC/E,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAClB,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAClB,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,CACpD,CACF,CAAC;QACN,MAAM,IAAI,GAAG,GAAG,iBAAiB,WAAW,UAAU,EAAE,EAAE,CAAC;QAC3D,eAAe,CAAC,cAAc,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QACjD,KAAK,CAAC,IAAI,CAAC;YACT,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW;YACpG,MAAM,EAAE,OAAO,EAAE,MAAM;YACvB,MAAM,EAAE,IAAI;SACb,CAAC,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC,CAAC"}