style-dictionary 3.7.1 → 3.7.2

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/utils/references/resolveReference.js

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+function resolveReference(path, obj) {
+  let i,
+      ref = obj;
+
+  if (!Array.isArray(path)) {
+    return;
+  }
+
+  for (i = 0; i < path.length; i++) {
+    // Check for undefined as 0 is a valid, truthy value
+    if (typeof ref[path[i]] !== 'undefined') {
+      ref = ref[path[i]];
+    } else {
+      // set the reference as undefined if we don't find anything
+      ref = undefined;
+      break;
+    }
+  }
+
+  return ref;
+}
+
+module.exports = resolveReference;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/utils/references/usesReference.js

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+const createRegex = require('./createReferenceRegex');
+
+/**
+ * Checks if the value uses a value reference.
+ * @memberof Dictionary
+ * @param {string} value
+ * @param {Object|RegExp} regexOrOptions
+ * @returns {boolean} - True, if the value uses a value reference
+ */
+function usesReference(value, regexOrOptions = {}) {
+  const regex = regexOrOptions instanceof RegExp ? regexOrOptions : createRegex(regexOrOptions);
+
+  if (typeof value === 'string') {
+    return regex.test(value);
+  }
+
+  if (typeof value === 'object') {
+    let hasReference = false;
+    // iterate over each property in the object,
+    // if any element passes the regex test,
+    // the whole thing should be true
+    for (const key in value) {
+      if (value.hasOwnProperty(key)) {
+        const element = value[key];
+        let reference = usesReference(element, regexOrOptions);
+        if (reference) {
+          hasReference = true;
+          break;
+        }
+      }
+    }
+    return hasReference;
+  }
+
+  return false;
+}
+
+module.exports = usesReference;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/utils/resolveObject.js

@@ -0,0 +1,175 @@
+/*
+ * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+const _ = require('./es6_'),
+    GroupMessages = require('./groupMessages'),
+    usesReference = require('./references/usesReference'),
+    getName = require('./references/getName'),
+    getPath = require('./references/getPathFromName'),
+    createReferenceRegex = require('./references/createReferenceRegex'),
+    resolveReference = require('./references/resolveReference');
+
+const PROPERTY_REFERENCE_WARNINGS = GroupMessages.GROUP.PropertyReferenceWarnings;
+
+let current_context = []; // To maintain the context to be able to test for circular definitions
+const defaults = {
+  ignoreKeys: ['original'],
+  ignorePaths: [],
+};
+let updated_object, regex, options;
+
+
+function resolveObject(object, opts) {
+  options = Object.assign({}, defaults, opts);
+
+  updated_object = _.cloneDeep(object);  // This object will be edited
+
+  regex = createReferenceRegex(options);
+
+  if (typeof object === 'object') {
+    current_context = [];
+    return traverseObj( updated_object );
+  } else {
+    throw new Error('Please pass an object in');
+  }
+}
+
+
+
+function traverseObj(obj) {
+  let key;
+
+  for (key in obj) {
+    if (!obj.hasOwnProperty(key)) {
+      continue;
+    }
+
+    // We want to check for ignoredKeys, this is to
+    // skip over attributes that should not be
+    // mutated, like a copy of the original property.
+    if (options.ignoreKeys && options.ignoreKeys.indexOf(key) !== -1) {
+      continue;
+    }
+
+    current_context.push(key);
+    if (typeof obj[key] === 'object') {
+      traverseObj( obj[key] );
+    } else {
+      if (typeof obj[key] === 'string' && obj[key].indexOf('{') > -1) {
+        obj[key] = compile_value( obj[key], [getName(current_context)] );
+      }
+    }
+    current_context.pop();
+  }
+
+  return obj;
+}
+
+
+let foundCirc = {};
+function compile_value(value, stack) {
+
+  let to_ret = value, ref;
+
+  // Replace the reference inline, but don't replace the whole string because
+  // references can be part of the value such as "1px solid {color.border.light}"
+  value.replace(regex, function(match, variable) {
+    variable = variable.trim();
+
+    // Find what the value is referencing
+    const pathName = getPath(variable, options);
+    const context = getName(current_context, options);
+    const refHasValue = pathName[pathName.length-1] === 'value';
+
+    if (refHasValue && options.ignorePaths.indexOf(variable) !== -1) {
+      return value;
+    } else if (!refHasValue && options.ignorePaths.indexOf(`${variable}.value`) !== -1) {
+      return value;
+    }
+
+    stack.push(variable);
+
+    ref = resolveReference(pathName, updated_object);
+
+    // If the reference doesn't end in 'value'
+    // and
+    // the reference points to someplace that has a `value` attribute
+    // we should take the '.value' of the reference
+    // per the W3C draft spec where references do not have .value
+    // https://design-tokens.github.io/community-group/format/#aliases-references
+    if (!refHasValue && ref && ref.hasOwnProperty('value')) {
+      ref = ref.value;
+    }
+
+    if (typeof ref !== 'undefined') {
+      if (typeof ref === 'string' || typeof ref === 'number') {
+        to_ret = value.replace(match, ref);
+
+        // Recursive, therefore we can compute multi-layer variables like a = b, b = c, eventually a = c
+        if (usesReference(to_ret, regex)) {
+          var reference = to_ret.slice(1, -1);
+
+          // Compare to found circular references
+          if (foundCirc.hasOwnProperty(reference)) {
+            // If the current reference is a member of a circular reference, do nothing
+          }
+          else if(stack.indexOf(reference)!==-1) {
+            // If the current stack already contains the current reference, we found a new circular reference
+            // chop down only the circular part, save it to our circular reference info, and spit out an error
+
+            // Get the position of the existing reference in the stack
+            var stackIndexReference = stack.indexOf(reference);
+
+            // Get the portion of the stack that starts at the circular reference and brings you through until the end
+            var circStack = stack.slice(stackIndexReference);
+
+            // For all the references in this list, add them to the list of references that end up in a circular reference
+            circStack.forEach(function(key) { foundCirc[key] = true; });
+
+            // Add our found circular reference to the end of the cycle
+            circStack.push(reference);
+
+            // Add circ reference info to our list of warning messages
+            GroupMessages.add(
+              PROPERTY_REFERENCE_WARNINGS,
+              "Circular definition cycle:  " + circStack.join(', ')
+            );
+          }
+          else {
+            to_ret = compile_value( to_ret, stack );
+          }
+        }
+        // if evaluated value is a number and equal to the reference, we want to keep the type
+        if (typeof ref === 'number' && ref.toString() === to_ret) {
+          to_ret = ref;
+        }
+      } else {
+        // if evaluated value is not a string or number, we want to keep the type
+        to_ret = ref;
+      }
+    } else {
+      GroupMessages.add(
+        PROPERTY_REFERENCE_WARNINGS,
+        "Reference doesn't exist: " + context + " tries to reference " + variable + ", which is not defined"
+      );
+      to_ret = ref;
+    }
+    stack.pop(variable);
+
+    return to_ret;
+  });
+
+  return to_ret;
+}
+
+module.exports = resolveObject;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/package.json

@@ -0,0 +1,155 @@
+{
+  "name": "style-dictionary",
+  "version": "3.7.1",
+  "description": "Style once, use everywhere. A build system for creating cross-platform styles.",
+  "keywords": [
+    "style dictionary",
+    "style",
+    "dictionary",
+    "amazon",
+    "css",
+    "design",
+    "properties",
+    "tokens",
+    "sass",
+    "scss",
+    "iOS",
+    "Android",
+    "react",
+    "react native",
+    "style guide"
+  ],
+  "main": "index.js",
+  "types": "types/index.d.ts",
+  "bin": {
+    "style-dictionary": "./bin/style-dictionary"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "files": [
+    "bin",
+    "lib",
+    "examples",
+    "index.js",
+    "LICENSE",
+    "NOTICE",
+    "types"
+  ],
+  "scripts": {
+    "lint": "eslint --fix index.js \"lib/**/*.js\" \"__tests__/**/*.js\"",
+    "test": "npm run test-types && npm run lint && jest --runInBand --silent --coverage",
+    "test-types": "tsd",
+    "test-watch": "npm run test-types && npm run lint && jest --runInBand --watch",
+    "generate-docs": "node ./scripts/generateDocs.js",
+    "serve-docs": "docsify serve docs -p 3000 -P 12345",
+    "install-cli": "npm install -g $(npm pack)",
+    "release": "git add . && standard-version -a",
+    "prepare": "husky install"
+  },
+  "standard-version": {
+    "scripts": {
+      "postbump": "node ./scripts/version.js && npm run generate-docs"
+    }
+  },
+  "jest": {
+    "verbose": false,
+    "collectCoverageFrom": [
+      "lib/**/*.js"
+    ],
+    "coverageReporters": [
+      "html"
+    ],
+    "coverageDirectory": "docs/coverage",
+    "roots": [
+      "__tests__",
+      "__integration__"
+    ],
+    "setupFilesAfterEnv": [
+      "<rootDir>/__tests__/__setup.js"
+    ],
+    "testPathIgnorePatterns": [
+      "/__tests__/__setup.js",
+      "/__tests__/__helpers.js",
+      "/__tests__/__assets/",
+      "/__tests__/__configs/",
+      "/__tests__/__json_files/",
+      "/__tests__/__properties/",
+      "/__tests__/__output/",
+      "/__tests__/formats/__constants.js"
+    ],
+    "transform": {
+      "^.+\\.json5$": "json5-jest",
+      "^.+\\.jsonc$": "json5-jest",
+      "^.+\\.jsx?$": "babel-jest"
+    }
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm test && lint-staged",
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
+  "lint-staged": {
+    "*.js": [
+      "npm run lint",
+      "git add"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/amzn/style-dictionary.git"
+  },
+  "author": "Amazon",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/amzn/style-dictionary/issues"
+  },
+  "contributors": [
+    "Yuliya Baran <baranyu@amazon.com>",
+    "Charles Dorner <dornerc@amazon.com>",
+    "Dustin Boudreau <boudrd@amazon.com>",
+    "Danny Banks <djb@amazon.com>"
+  ],
+  "homepage": "https://github.com/amzn/style-dictionary",
+  "dependencies": {
+    "chalk": "^4.0.0",
+    "change-case": "^4.1.2",
+    "commander": "^8.3.0",
+    "fs-extra": "^10.0.0",
+    "glob": "^7.2.0",
+    "json5": "^2.2.0",
+    "jsonc-parser": "^3.0.0",
+    "lodash": "^4.17.15",
+    "tinycolor2": "^1.4.1"
+  },
+  "devDependencies": {
+    "@babel/preset-env": "^7.16.11",
+    "@commitlint/cli": "^16.1.0",
+    "@commitlint/config-conventional": "^16.0.0",
+    "babel-jest": "^27.4.6",
+    "babel-preset-env": "^1.7.0",
+    "docsify": "^4.12.2",
+    "docsify-cli": "^4.4.3",
+    "eslint": "^8.7.0",
+    "eslint-plugin-jest": "^26.0.0",
+    "husky": "^7.0.0",
+    "istanbul": "^0.4.5",
+    "jest": "^27.4.7",
+    "jsdoc-escape-at": "^1.0.1",
+    "jsdoc-to-markdown": "^7.1.0",
+    "json5-jest": "^1.0.1",
+    "less": "^4.1.2",
+    "lint-staged": "^12.3.1",
+    "node-sass": "^7.0.1",
+    "standard-version": "^9.3.2",
+    "stylus": "^0.56.0",
+    "tsd": "^0.19.1",
+    "yaml": "^1.10.2"
+  }
+}

package/examples/advanced/custom-file-header/node_modules/style-dictionary/types/Action.d.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+import { Dictionary } from './Dictionary';
+import { Platform } from './Platform';
+
+export interface Action {
+  /** The action in the form of a function. */
+  do(dictionary: Dictionary, config: Platform): void;
+
+  /** A function that undoes the action. */
+  undo?(dictionary: Dictionary, config: Platform): void;
+}

package/examples/advanced/custom-file-header/node_modules/style-dictionary/types/Config.d.ts

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+import { Parser } from './Parser';
+import { Transform } from './Transform';
+import { TransformGroup } from './TransformGroup';
+import { Filter } from './Filter';
+import { FileHeader } from './FileHeader';
+import { Formatter } from './Format';
+import { Action } from './Action';
+import { Platform } from './Platform';
+import { DesignTokens } from './DesignToken';
+
+export interface Config {
+  parsers?: Parser[];
+  transform?: Record<string, Transform>;
+  transformGroup?: Record<string, TransformGroup>;
+  format?: Record<string, Formatter>;
+  filter?: Record<string, Filter>;
+  fileHeader?: Record<string, FileHeader>;
+  action?: Record<string, Action>;
+  include?: string[];
+  source?: string[];
+  tokens?: DesignTokens;
+  properties?: DesignTokens;
+  platforms: Record<string, Platform>;
+}

package/examples/advanced/custom-file-header/node_modules/style-dictionary/types/DesignToken.d.ts

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+/**
+ * This type is also used in the `typescript/module-declarations` format,
+ * but we only want to include the lines of the DesignToken interface.
+ * The comments surrounding the definition are used to trim the lines of
+ * this file in that format.
+ */
+
+//start
+interface DesignToken {
+  value: any;
+  name?: string;
+  comment?: string;
+  themeable?: boolean;
+  attributes?: {
+    category?: string;
+    type?: string;
+    item?: string;
+    subitem?: string;
+    state?: string;
+    [key: string]: any;
+  };
+  [key: string]: any;
+}
+//end
+
+export { DesignToken };
+export interface DesignTokens {
+  [key: string]: DesignTokens | DesignToken;
+}

package/examples/advanced/custom-file-header/node_modules/style-dictionary/types/Dictionary.d.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+import { TransformedToken, TransformedTokens } from './TransformedToken';
+
+export interface Dictionary {
+  allTokens: TransformedToken[];
+  tokens: TransformedTokens;
+  allProperties: TransformedToken[];
+  properties: TransformedTokens;
+  usesReference: (value: any) => boolean;
+  getReferences: (value: any) => TransformedToken[];
+}

package/examples/advanced/custom-file-header/node_modules/style-dictionary/types/File.d.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+import { Options } from './Options';
+import { TransformedToken } from './TransformedToken';
+
+export interface File {
+  className?: string;
+  destination: string;
+  format?: string;
+  filter?: string | Partial<TransformedToken> | ((token: TransformedToken) => boolean);
+  options?: Options;
+}

package/examples/advanced/custom-file-header/node_modules/style-dictionary/types/FileHeader.d.ts

@@ -0,0 +1,14 @@
+/*
+ * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+export type FileHeader = (defaultMessage: string[]) => string[];

package/examples/advanced/custom-file-header/node_modules/style-dictionary/types/Filter.d.ts

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+import { Matcher } from './Matcher';
+
+export interface Filter {
+  name: string;
+  matcher: Matcher;
+}

package/examples/advanced/custom-file-header/node_modules/style-dictionary/types/Format.d.ts

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
+ * the License. A copy of the License is located at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
+ * and limitations under the License.
+ */
+
+import { Dictionary } from './Dictionary';
+import { File } from './File';
+import { Options } from './Options';
+import { Platform } from './Platform';
+
+export interface FormatterArguments {
+  /**
+   * The transformed and resolved dictionary object
+   */
+  dictionary: Dictionary;
+  /**
+   * The file configuration the format is called in
+   */
+  file: File;
+  /**
+   * The options object,
+   */
+  options: Options;
+  /**
+   * The platform configuration the format is called in
+   */
+  platform: Platform;
+}
+
+/**
+ * The formatter function receives an overloaded object as its arguments and
+ * it should return a string, which will be written to a file.
+ */
+export type Formatter = (arguments: FormatterArguments) => string;
+
+export interface Format {
+  name: string;
+  formatter: Formatter;
+}