@o3r/design 11.4.0-prerelease.4 → 11.4.0-prerelease.40

package/README.md

@@ -33,25 +33,30 @@ Otter Design module provides a set of code generators based on [Angular schemati
 
 Otter Design module provides a set of builders based on [Angular builders](https://angular.io/guide/cli-builder).
 
-### generate-css
+### generate-style
 
-The `generate-css` builder can generate CSS and CMS Metadata based on given Design Token Json files.
+The `generate-style` builder can generate CSS and CMS Metadata based on given Design Token Json files.
 The following configurations are available:
 
-| Options                     | Default Value  | Description                                                                                                                          |
-| --------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
-| **designTokenFilePatterns** | [] *Require*   | Path patterns to the Design Token JSON files. <br /> Files in dependencies are supported and resolved with Node Resolver.            |
-| **variableType**            | `'css'`        | Type of the variables to generate for a Design Token.                                                                                |
-| **output**                  | *null*         | Output file where the CSS will be generated. <br /> The path specified in `o3rTargetFile` will be ignore if this option is specified |
-| **defaultStyleFile**        | src/theme.scss | File path to generate the variable if not determined by the specifications                                                           |
-| **metadataOutput**          | *null*         | Path to generate the metadata for the CMS. <br /> The metadata will be generated only if the file path is specified.                 |
-| **metadataIgnorePrivate**   | false          | Ignore the private variable in the metadata generation.                                                                              |
-| **rootPath**                | *null*         | Root path of files where the CSS will be generated.                                                                                  |
-| **failOnDuplicate**         | false          | Determine if the process should stop in case of Token duplication.                                                                   |
-| **templateFile**            | *null*         | Path to a template file to apply as default configuration to a Design Token extension.                                               |
-| **prefix**                  | *null*         | Prefix to append to generated variables.                                                                                             |
-| **prefixPrivate**           | *null*         | Prefix to append to generated private variables.                                                                                     |
-| **watch**                   | false          | Enable Watch mode.                                                                                                                   |
+| Options                     | Default Value      | Description                                                                                                                                  |
+| --------------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| **language**                | `'css'` *Required* | Default styling language to generate to the given Design Token. *(`css`, `scss` and `sass` are available)*                                   |
+| **designTokenFilePatterns** | `[]` *Required*    | Path patterns to the Design Token JSON files. <br /> Files in dependencies are supported and resolved with Node Resolver.                    |
+| **variableType**            | *null*             | Type of the variables to generate for a Design Token.                                                                                        |
+| **output**                  | *null*             | Output file where the CSS will be generated. <br /> The path specified in `o3rTargetFile` will be ignored if this option is specified        |
+| **defaultStyleFile**        | `'src/theme.scss'` | File path to generate the variable if not determined by the specifications                                                                   |
+| **metadataOutput**          | *null*             | Path to generate the metadata for the CMS. <br /> The metadata will be generated only if the file path is specified.                         |
+| **metadataIgnorePrivate**   | false              | Ignore private variables in the metadata generation.                                                                                         |
+| **rootPath**                | *null*             | Root path of files where the CSS will be generated.                                                                                          |
+| **failOnDuplicate**         | false              | Determine if the process should stop in case of Token duplication.                                                                           |
+| **templateFile**            | *null*             | Path to a template file (or a list of template files) to apply as default configuration to a Design Token extension.                         |
+| **prefix**                  | *null*             | Prefix to append to generated variables.                                                                                                     |
+| **prefixPrivate**           | *null*             | Prefix to append to generated private variables.                                                                                             |
+| **renderPrivateVariableTo** | *null*             | Generate the private variable in the given language (if not specified, in case of CSS, the variable will be ignored in the generated style). |
+| **watch**                   | false              | Enable watch mode.                                                                                                                           |
+
+> [!NOTE]
+> The document of the deprecated builder `generate-css` is available on [this page](https://github.com/AmadeusITGroup/otter/blob/main/docs/design/DEPRECATE_GENERATE_CSS.md).
 
 ### generate-jsonschema
 
@@ -92,15 +97,16 @@ It comes with the following options:
 
 To enhance the features of default Design Token standard and provide additional information to renderers, the [$extensions](https://tr.designtokens.org/format/#extensions) properties has been enhanced by Otter Tooling with the following options:
 
-| Extension property | Supporting Renderers                                     | Description                                                                                                                                                                                                                                                                      |
-| ------------------ | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **o3rTargetFile**  | `css`, `sass`                                            | Information regarding the path to file where the token requests to be generated                                                                                                                                                                                                  |
-| **o3rPrivate**     | `css`, `sass`, `json-schema`, `metadata`, `design-token` | Determine if the token is flagged as private                                                                                                                                                                                                                                     |
-| **o3rImportant**   | `css`                                                    | Determine if the token should be flagged as important when generated                                                                                                                                                                                                             |
-| **o3rScope**       | `css`, `sass`                                            | Scope to apply to the generated variable                                                                                                                                                                                                                                         |
-| **o3rMetadata**    | `css`, `sass`, `json-schema`, `metadata`, `design-token` | Additional information to provide to the metadata if generated                                                                                                                                                                                                                   |
-| **o3rUnit**        | `css`, `sass`, `metadata`, `design-token`                | Convert a numeric value from the specified unit to the new unit. It will add a unit to the token with type "number" for which the unit is not specified.<br />In case of complex type (such as shadow, transition, etc...), the unit will be applied to all numeric types in it. |
-| **o3rRatio**       | `css`, `sass`, `metadata`, `design-token`                | Ratio to apply to previous value. The ratio will be applied only on token with "number" type or on the first numbers determined in "string" like types.<br />In case of complex type (such as shadow, transition, etc...), the ratio will be applied to all numeric types in it. |
+| Extension property    | Supporting Renderers                                     | Description                                                                                                                                                                                                                                                                        |
+| --------------------- | -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **o3rTargetFile**     | `css`, `sass`                                            | Information regarding the path to the file where the token will be generated                                                                                                                                                                                                       |
+| **o3rPrivate**        | `css`, `sass`, `json-schema`, `metadata`, `design-token` | Determine if the token is flagged as private                                                                                                                                                                                                                                       |
+| **o3rImportant**      | `css`                                                    | Determine if the token should be flagged as important when generated                                                                                                                                                                                                               |
+| **o3rScope**          | `css`, `sass`                                            | Scope to apply to the generated variable                                                                                                                                                                                                                                           |
+| **o3rMetadata**       | `css`, `sass`, `json-schema`, `metadata`, `design-token` | Additional information to provide to the metadata if generated                                                                                                                                                                                                                     |
+| **o3rUnit**           | `css`, `sass`, `metadata`, `design-token`                | Convert a numeric value from the specified unit to the new unit. It will add a unit to the token with type "number" for which the unit is not specified.<br />In case of a complex type (such as shadow, transition, etc...), the unit will be applied to all numeric types in it. |
+| **o3rRatio**          | `css`, `sass`, `metadata`, `design-token`                | Ratio to apply to previous value. The ratio will only be applied to a token of type "number" or to the first numbers determined in "string" types.<br />In case of a complex type (such as shadow, transition, etc...), the ratio will be applied to all numeric types in it.      |
+| **o3rExpectOverride** | `css`, `sass`                                            | Indicate that the token is expected to be overridden by external rules.                                                                                                                                                                                                            |
 
 > [!NOTE]
 > In case of implementation of custom renderer, additional properties dedicated to this renderer can be added following Design Token Extensions [guidelines](https://tr.designtokens.org/format/#extensions).

package/builders/generate-css/schema.d.ts

@@ -28,7 +28,7 @@ export interface GenerateCssSchematicsSchema extends SchematicOptionObject {
     failOnDuplicate?: boolean;
     /** Prefix to happen to generated variables */
     prefix?: string;
-    /** Generate the Private Variable to the given language */
+    /** Generate the private variable to the given language */
     renderPrivateVariableTo?: 'sass';
     /** Prefix to happen to generated private variables */
     prefixPrivate?: string;
@@ -36,7 +36,7 @@ export interface GenerateCssSchematicsSchema extends SchematicOptionObject {
     failOnMissingReference?: boolean;
     /** Type of the variables to generate for a Design Token */
     variableType?: 'css' | 'sass';
-    /** Path to a template file to apply as default configuration to a Design Token extension */
+    /** Path to a template file (or a list of template files) to apply as default configuration to a Design Token extension */
     templateFile?: string | string[];
 }
 //# sourceMappingURL=schema.d.ts.map

package/builders/generate-css/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../builders/generate-css/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,mDAAmD;IACnD,uBAAuB,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE3C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,gFAAgF;IAChF,gBAAgB,EAAE,MAAM,CAAC;IAEzB,wBAAwB;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,wEAAwE;IACxE,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,0DAA0D;IAC1D,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,sDAAsD;IACtD,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,2FAA2F;IAC3F,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC,2DAA2D;IAC3D,YAAY,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE9B,4FAA4F;IAC5F,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAClC"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../builders/generate-css/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE7D,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,mDAAmD;IACnD,uBAAuB,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE3C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,gFAAgF;IAChF,gBAAgB,EAAE,MAAM,CAAC;IAEzB,wBAAwB;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,wEAAwE;IACxE,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,0DAA0D;IAC1D,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,sDAAsD;IACtD,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,2FAA2F;IAC3F,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC,2DAA2D;IAC3D,YAAY,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAE9B,0HAA0H;IAC1H,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAClC"}

package/builders/generate-css/schema.json

@@ -29,7 +29,7 @@
     },
     "output": {
       "type": "string",
-      "description": "Path to generate the metadata for CMS. The Metadata will be generated only if the file path is specified"
+      "description": "Path to generate the Metadata for CMS. The Metadata will be generated only if the file path is specified"
     },
     "defaultStyleFile": {
       "type": "string",
@@ -43,7 +43,7 @@
     "metadataIgnorePrivate": {
       "type": "boolean",
       "default": false,
-      "description": "Ignore the private variable in the metadata generation."
+      "description": "Ignore the private variable in the Metadata generation."
     },
     "rootPath": {
       "type": "string",
@@ -60,7 +60,7 @@
       "description": "Determine if the process should stop in case of Token duplication"
     },
     "templateFile": {
-      "description": "Path to a template file(s) to apply as default configuration to a Design Token extension. In case of multiple files, the JSON will be deeply merged in the order defined by the list.",
+      "description": "Path to a template file (or a list of template files) to apply as default configuration to a Design Token extension. In case of multiple files, the JSON will be deeply merged in the order defined by the list.",
       "oneOf": [
         {
           "type": "string"
@@ -86,7 +86,7 @@
       "enum": [
         "sass"
       ],
-      "description": "Generate the Private Variable to the given language (the variable is not generated if not specified)"
+      "description": "Generate the private variable to the given language (the variable is not generated if not specified)"
     },
     "failOnMissingReference": {
       "type": "boolean",

package/builders/generate-style/helpers/metadata-renderer-options.d.ts

@@ -0,0 +1,5 @@
+import type { BuilderContext } from '@angular-devkit/architect';
+import { type DesignTokenRendererOptions, type TokenKeyRenderer } from '../../../src/public_api';
+import type { GenerateStyleSchematicsSchema } from '../schema';
+export declare const getMetadataRenderDesignTokenOptions: (tokenVariableNameRenderer: TokenKeyRenderer | undefined, options: GenerateStyleSchematicsSchema, context: BuilderContext) => DesignTokenRendererOptions;
+//# sourceMappingURL=metadata-renderer-options.d.ts.map

package/builders/generate-style/helpers/metadata-renderer-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata-renderer-options.d.ts","sourceRoot":"","sources":["../../../../builders/generate-style/helpers/metadata-renderer-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EACL,KAAK,0BAA0B,EAG/B,KAAK,gBAAgB,EACtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAG/D,eAAO,MAAM,mCAAmC,8BACnB,gBAAgB,GAAG,SAAS,WAC9C,6BAA6B,WAC7B,cAAc,KAAG,0BAc3B,CAAC"}

package/builders/generate-style/helpers/metadata-renderer-options.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetadataRenderDesignTokenOptions = void 0;
+const public_api_1 = require("../../../src/public_api");
+const node_path_1 = require("node:path");
+const getMetadataRenderDesignTokenOptions = (tokenVariableNameRenderer, options, context) => {
+    /** Builder logger */
+    const logger = context.logger;
+    return {
+        determineFileToUpdate: () => (0, node_path_1.resolve)(context.workspaceRoot, options.metadataOutput || 'style.metadata.json'),
+        styleContentUpdater: (0, public_api_1.getMetadataStyleContentUpdater)(),
+        tokenDefinitionRenderer: (0, public_api_1.getMetadataTokenDefinitionRenderer)({
+            tokenVariableNameRenderer,
+            ignorePrivateVariable: options.metadataIgnorePrivate
+        }),
+        logger
+    };
+};
+exports.getMetadataRenderDesignTokenOptions = getMetadataRenderDesignTokenOptions;
+//# sourceMappingURL=metadata-renderer-options.js.map

package/builders/generate-style/helpers/style-renderer-options.d.ts

@@ -0,0 +1,5 @@
+import type { BuilderContext } from '@angular-devkit/architect';
+import { type DesignTokenRendererOptions, type TokenKeyRenderer } from '../../../src/public_api';
+import type { GenerateStyleSchematicsSchema } from '../schema';
+export declare const getStyleRendererOptions: (tokenVariableNameRenderer: TokenKeyRenderer | undefined, options: GenerateStyleSchematicsSchema, context: BuilderContext) => DesignTokenRendererOptions;
+//# sourceMappingURL=style-renderer-options.d.ts.map

package/builders/generate-style/helpers/style-renderer-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"style-renderer-options.d.ts","sourceRoot":"","sources":["../../../../builders/generate-style/helpers/style-renderer-options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,EAGL,KAAK,0BAA0B,EAY/B,KAAK,gBAAgB,EAEtB,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAI/D,eAAO,MAAM,uBAAuB,8BAA+B,gBAAgB,GAAG,SAAS,WAAY,6BAA6B,WAAW,cAAc,KAAG,0BA8HnK,CAAC"}

package/builders/generate-style/helpers/style-renderer-options.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStyleRendererOptions = void 0;
+const public_api_1 = require("../../../src/public_api");
+const node_path_1 = require("node:path");
+const promises_1 = require("node:fs/promises");
+const getStyleRendererOptions = (tokenVariableNameRenderer, options, context) => {
+    /**
+     * Function to determine files to update based on the Design Token
+     * @param token
+     */
+    const determineFileToUpdate = options.output ? () => (0, node_path_1.resolve)(context.workspaceRoot, options.output) :
+        (token) => {
+            if (token.extensions.o3rTargetFile) {
+                return token.context?.basePath && !options.rootPath
+                    ? (0, node_path_1.resolve)(token.context.basePath, token.extensions.o3rTargetFile)
+                    : (0, node_path_1.resolve)(context.workspaceRoot, options.rootPath || '', token.extensions.o3rTargetFile);
+            }
+            return (0, node_path_1.resolve)(context.workspaceRoot, options.defaultStyleFile);
+        };
+    /** Builder logger */
+    const logger = context.logger;
+    /**
+     * File writer with logging when writing file
+     * @param file
+     * @param {...any} args
+     */
+    const writeFileWithLogger = async (file, ...args) => {
+        const res = await (0, promises_1.writeFile)(file, ...args);
+        // eslint-disable-next-line @typescript-eslint/no-base-to-string
+        logger.info(`Updated ${file.toString()} with Design Token content.`);
+        return res;
+    };
+    /** Render for the private variables if specified */
+    const privateDefinitionRenderer = options.renderPrivateVariableTo === 'sass' ? (0, public_api_1.getSassTokenDefinitionRenderer)({
+        tokenVariableNameRenderer: (v) => (options?.prefixPrivate || '') + (0, public_api_1.tokenVariableNameSassRenderer)(v),
+        logger
+    }) : undefined;
+    /** Update of file content based on selected language */
+    const styleContentUpdater = ((language) => {
+        switch (language) {
+            case 'css': {
+                return (0, public_api_1.getCssStyleContentUpdater)();
+            }
+            case 'scss':
+            case 'sass': {
+                return (0, public_api_1.getSassStyleContentUpdater)();
+            }
+            default: {
+                throw new Error(`No available updater for "${language}"`);
+            }
+        }
+    })(options.language);
+    /** Style token value renderer based on selected language */
+    const tokenValueRenderer = ((language) => {
+        const tokenValueRendererOptions = {
+            tokenVariableNameRenderer,
+            logger,
+            unregisteredReferenceRenderer: options.failOnMissingReference ? (refName) => { throw new Error(`The Design Token ${refName} is not registered`); } : undefined
+        };
+        switch (language) {
+            case 'css': {
+                return (0, public_api_1.getCssTokenValueRenderer)(tokenValueRendererOptions);
+            }
+            case 'scss':
+            case 'sass': {
+                return (0, public_api_1.getSassTokenValueRenderer)(tokenValueRendererOptions);
+            }
+            default: {
+                throw new Error(`No available value renderer for "${language}"`);
+            }
+        }
+    })(options.variableReferenceType || options.language);
+    /** Style token variable set renderer based on selected language */
+    const tokenDefinitionRenderer = ((language) => {
+        const tokenDefinitionRendererOptions = {
+            privateDefinitionRenderer,
+            tokenVariableNameRenderer,
+            tokenValueRenderer,
+            logger
+        };
+        switch (language) {
+            case 'css': {
+                const variableReferenceType = options.variableReferenceType || options.language;
+                return (0, public_api_1.getCssTokenDefinitionRenderer)({
+                    ...tokenDefinitionRendererOptions,
+                    tokenValueRenderer: ['sass', 'scss'].includes(variableReferenceType)
+                        ? (...arg) => `#{${tokenValueRenderer(...arg)}}`
+                        : tokenValueRenderer
+                });
+            }
+            case 'scss':
+            case 'sass': {
+                return (0, public_api_1.getSassTokenDefinitionRenderer)(tokenDefinitionRendererOptions);
+            }
+            default: {
+                throw new Error(`No available value renderer for "${language}"`);
+            }
+        }
+    })(options.variableType || options.language);
+    /** Sorting strategy of variables based on selected language */
+    const tokenListTransforms = ((language) => {
+        switch (language) {
+            case 'scss':
+            case 'sass': {
+                return [public_api_1.getTokenSorterByName, public_api_1.getTokenSorterByRef];
+            }
+            case 'css':
+            default: {
+                return [public_api_1.getTokenSorterByName];
+            }
+        }
+    })(options.variableType || options.language);
+    /** Option to be used by the style renderer */
+    return {
+        tokenListTransforms,
+        writeFile: writeFileWithLogger,
+        styleContentUpdater,
+        determineFileToUpdate,
+        tokenDefinitionRenderer,
+        logger
+    };
+};
+exports.getStyleRendererOptions = getStyleRendererOptions;
+//# sourceMappingURL=style-renderer-options.js.map

package/builders/generate-style/helpers/token-template.d.ts

@@ -0,0 +1,9 @@
+import { type DesignTokenGroupTemplate } from '../../../src/public_api';
+import type { BuilderContext } from '@angular-devkit/architect';
+/**
+ * Generate template object
+ * @param templateFilePaths list of template files
+ * @param context builder context
+ */
+export declare const generateTemplate: (templateFilePaths: string[], context: BuilderContext) => Promise<DesignTokenGroupTemplate>;
+//# sourceMappingURL=token-template.d.ts.map

package/builders/generate-style/helpers/token-template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-template.d.ts","sourceRoot":"","sources":["../../../../builders/generate-style/helpers/token-template.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,KAAK,wBAAwB,EAE9B,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAEhE;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,sBAA6B,MAAM,EAAE,WAAW,cAAc,KAAG,OAAO,CAAC,wBAAwB,CAgB7H,CAAC"}

package/builders/generate-style/helpers/token-template.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTemplate = void 0;
+const promises_1 = require("node:fs/promises");
+const node_fs_1 = require("node:fs");
+const public_api_1 = require("../../../src/public_api");
+const node_path_1 = require("node:path");
+/**
+ * Generate template object
+ * @param templateFilePaths list of template files
+ * @param context builder context
+ */
+const generateTemplate = async (templateFilePaths, context) => {
+    const templateFiles = await Promise.all(templateFilePaths
+        .map(async (templateFile) => {
+        let templateFilePath = (0, node_path_1.resolve)(context.workspaceRoot, templateFile);
+        if (!(0, node_fs_1.existsSync)(templateFilePath)) {
+            try {
+                templateFilePath = require.resolve(templateFile);
+            }
+            catch {
+                context.logger.error(`Cannot resolve the template file at '${templateFile}', it will be ignored.`);
+            }
+        }
+        return JSON.parse(await (0, promises_1.readFile)(templateFilePath, { encoding: 'utf8' }));
+    }));
+    return templateFiles.reduce((acc, cur) => (0, public_api_1.mergeDesignTokenTemplates)(acc, cur), {});
+};
+exports.generateTemplate = generateTemplate;
+//# sourceMappingURL=token-template.js.map

package/builders/generate-style/index.d.ts

@@ -0,0 +1,8 @@
+import type { GenerateStyleSchematicsSchema } from './schema';
+/**
+ * Generate CSS from Design Token files
+ * @param options
+ */
+declare const _default: import("@angular-devkit/architect/src/internal").Builder<GenerateStyleSchematicsSchema & import("@angular-devkit/core").JsonObject>;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/builders/generate-style/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../builders/generate-style/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,UAAU,CAAC;AA6B9D;;;GAGG;;AACH,wBA+GI"}

package/builders/generate-style/index.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const architect_1 = require("@angular-devkit/architect");
+const public_api_1 = require("../../src/public_api");
+const node_path_1 = require("node:path");
+const globby_1 = require("globby");
+const node_os_1 = require("node:os");
+const token_template_1 = require("./helpers/token-template");
+const style_renderer_options_1 = require("./helpers/style-renderer-options");
+const metadata_renderer_options_1 = require("./helpers/metadata-renderer-options");
+const createBuilderWithMetricsIfInstalled = (builderFn) => async (opts, ctx) => {
+    let wrapper = (fn) => fn;
+    try {
+        const { createBuilderWithMetrics } = await Promise.resolve().then(() => require('@o3r/telemetry'));
+        wrapper = createBuilderWithMetrics;
+    }
+    catch { }
+    return wrapper(builderFn)(opts, ctx);
+};
+/**
+ * Generate CSS from Design Token files
+ * @param options
+ */
+exports.default = (0, architect_1.createBuilder)(createBuilderWithMetricsIfInstalled(async (options, context) => {
+    /** List of template files */
+    const templateFilePaths = options.templateFile
+        && (typeof options.templateFile === 'string' ? [options.templateFile] : options.templateFile)
+        || undefined;
+    /** Template object */
+    const template = templateFilePaths && await (0, token_template_1.generateTemplate)(templateFilePaths, context);
+    /** List of input Design Token file patterns */
+    const designTokenFilePatterns = Array.isArray(options.designTokenFilePatterns) ? options.designTokenFilePatterns : [options.designTokenFilePatterns];
+    /**
+     * Render the variable name if the option `prefix` is defined
+     * @param variable
+     */
+    const tokenVariableNameRenderer = options.prefix ? (variable) => options.prefix + variable.getKey() : undefined;
+    /** Option to be used by the style renderer */
+    const renderStyleDesignTokenOptions = (0, style_renderer_options_1.getStyleRendererOptions)(tokenVariableNameRenderer, options, context);
+    /** Option to be used by the metadata renderer */
+    const renderMetadataDesignTokenOptions = (0, metadata_renderer_options_1.getMetadataRenderDesignTokenOptions)(tokenVariableNameRenderer, options, context);
+    /**
+     * Runner for a single renderer
+     * @param renderDesignTokenOptions
+     */
+    const execute = async (renderDesignTokenOptions) => {
+        const files = (0, globby_1.sync)(designTokenFilePatterns, { cwd: context.workspaceRoot, absolute: true });
+        const inDependencies = designTokenFilePatterns
+            .filter((pathName) => !pathName.startsWith('.') && !pathName.startsWith('*') && !pathName.startsWith('/'))
+            .map((pathName) => {
+            try {
+                return require.resolve(pathName);
+            }
+            catch {
+                return undefined;
+            }
+        })
+            .filter((pathName) => !!pathName);
+        files.push(...inDependencies);
+        try {
+            const duplicatedToken = [];
+            const tokens = (await Promise.all(files.map(async (file) => ({ file, parsed: await (0, public_api_1.parseDesignTokenFile)(file, { specificationContext: { template } }) }))))
+                .reduce((acc, { file, parsed }) => {
+                parsed.forEach((variable, key) => {
+                    if (acc.has(key)) {
+                        context.logger[options.failOnDuplicate ? 'error' : 'warn'](`A duplication of the variable ${key} is found in ${file}`);
+                        duplicatedToken.push(variable);
+                    }
+                    acc.set(key, variable);
+                });
+                return acc;
+            }, new Map());
+            if (options.failOnDuplicate && duplicatedToken.length > 0) {
+                throw new Error(`Found ${duplicatedToken.length} duplicated Design Token keys`);
+            }
+            await (0, public_api_1.renderDesignTokens)(tokens, renderDesignTokenOptions);
+            return { success: true };
+        }
+        catch (err) {
+            return { success: false, error: String(err) };
+        }
+    };
+    /** Runner for all the renderers based on options */
+    const executeMultiRenderer = async () => {
+        return (await Promise.allSettled([
+            execute(renderStyleDesignTokenOptions),
+            ...(options.metadataOutput ? [execute(renderMetadataDesignTokenOptions)] : [])
+        ])).reduce((acc, res) => {
+            if (res.status === 'fulfilled') {
+                acc.success &&= res.value.success;
+                if (res.value.error) {
+                    acc.error ||= '';
+                    acc.error += node_os_1.EOL + res.value.error;
+                }
+            }
+            else {
+                acc.success = false;
+                if (res.reason) {
+                    acc.error ||= '';
+                    // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
+                    acc.error += node_os_1.EOL + res.reason;
+                }
+            }
+            return acc;
+        }, { success: true });
+    };
+    if (!options.watch) {
+        return await executeMultiRenderer();
+    }
+    else {
+        try {
+            await Promise.resolve().then(() => require('chokidar')).then((chokidar) => chokidar.watch([
+                ...designTokenFilePatterns.map((p) => (0, node_path_1.resolve)(context.workspaceRoot, p)),
+                ...(templateFilePaths || [])
+            ]))
+                .then((watcher) => watcher.on('all', async () => {
+                const res = await executeMultiRenderer();
+                if (res.error) {
+                    context.logger.error(res.error);
+                }
+            }));
+            return { success: true };
+        }
+        catch (err) {
+            return { success: false, error: String(err) };
+        }
+    }
+}));
+//# sourceMappingURL=index.js.map

package/builders/generate-style/schema.d.ts

@@ -0,0 +1,54 @@
+import type { SchematicOptionObject } from '@o3r/schematics';
+/** Available style languages */
+export type AvailableLanguage = 'css' | 'sass' | 'scss';
+export interface GenerateStyleSchematicsSchema extends SchematicOptionObject {
+    /**
+     * Language defined to generate the styling
+     * Note: This will drive the default behavior of {@link variableType} and {@link variableReferenceType}
+     */
+    language: AvailableLanguage;
+    /** Type of the variables to generate for a Design Token */
+    variableType?: AvailableLanguage;
+    /** Type of the variables to generate for a Design Token reference */
+    variableReferenceType?: AvailableLanguage;
+    /** Path patterns to the Design Token JSON files */
+    designTokenFilePatterns: string | string[];
+    /**
+     * Path to generate the metadata for CMS
+     * The Metadata will be generated only if the file path is specified
+     */
+    metadataOutput?: string;
+    /**
+     * Ignore private variables in the metadata generation
+     */
+    metadataIgnorePrivate?: boolean;
+    /**
+     * Output file where to generate the CSS
+     *
+     * If specified, all the generated CSS variables will be generated in the given file.
+     * Otherwise, the output file will be determined based on the variable parameters
+     */
+    output?: string;
+    /** File path to generate the variable if not determined by the specification */
+    defaultStyleFile: string;
+    /** Enable Watch mode */
+    watch?: boolean;
+    /** Root path of the files where the CSS will be generated */
+    rootPath?: string;
+    /** Determine if the process should stop in case of Design Token duplication */
+    failOnDuplicate?: boolean;
+    /** Prefix to append to generated variables */
+    prefix?: string;
+    /**
+     * Generate the private variable in the given language
+     * Note: if not provided, the private variable will not be rendered in the CSS language.
+     */
+    renderPrivateVariableTo?: Exclude<AvailableLanguage, 'css'>;
+    /** Prefix to append to generated private variables */
+    prefixPrivate?: string;
+    /** Determine if the builder should fail if a missing Design Token reference is detected */
+    failOnMissingReference?: boolean;
+    /** Path to a template file to apply as default configuration to a Design Token extension */
+    templateFile?: string | string[];
+}
+//# sourceMappingURL=schema.d.ts.map

package/builders/generate-style/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../builders/generate-style/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE7D,gCAAgC;AAChC,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAExD,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;IAC1E;;;OAGG;IACH,QAAQ,EAAE,iBAAiB,CAAC;IAE5B,2DAA2D;IAC3D,YAAY,CAAC,EAAE,iBAAiB,CAAC;IAEjC,qEAAqE;IACrE,qBAAqB,CAAC,EAAE,iBAAiB,CAAC;IAE1C,mDAAmD;IACnD,uBAAuB,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE3C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,gFAAgF;IAChF,gBAAgB,EAAE,MAAM,CAAC;IAEzB,wBAAwB;IACxB,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB,6DAA6D;IAC7D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,+EAA+E;IAC/E,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;IAE5D,sDAAsD;IACtD,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,2FAA2F;IAC3F,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC,4FAA4F;IAC5F,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CAClC"}

package/builders/generate-style/schema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schema.js.map