style-dictionary 3.7.0 → 3.7.2

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

@@ -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.
+ */
+
+const cleanDir = require('./cleanDir');
+
+/**
+ * Takes a platform config object and a properties
+ * object and cleans all the files. Properties object
+ * should have been transformed and resolved before this
+ * point.
+ * @memberOf StyleDictionary
+ * @param {Object} dictionary
+ * @param {Object} platform
+ * @returns {null}
+ */
+function cleanDirs(dictionary, platform) {
+  if (platform.buildPath && platform.buildPath.slice(-1) !== '/') {
+    throw new Error('Build path must end in a trailing slash or you will get weird file names.')
+  }
+
+  // while neither the format or dictionary are used by clean file I'm passing them in for symmetry to buildFile
+  platform.files.forEach(function (file) {
+    if (file.format) {
+      cleanDir(file, platform, dictionary);
+    } else {
+      throw new Error('Please supply a format')
+    }
+  });
+}
+
+
+module.exports = cleanDirs;

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

@@ -0,0 +1,50 @@
+/*
+ * 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.
+ */
+
+var fs    = require('fs-extra'),
+    chalk = require('chalk');
+
+
+/**
+ * Takes the style property object and a format and returns a
+ * string that can be written to a file.
+ * @memberOf StyleDictionary
+ * @param {String} destination
+ * @param {Function} format (unused)
+ * @param {Object} platform
+ * @param {Object} dictionary (unused)
+ * @param {Function} filter (unused)
+ * @returns {null}
+ */
+function cleanFile(file = {}, platform = {}) {
+  var { destination } = file;
+
+  if (typeof destination !== 'string')
+    throw new Error('Please enter a valid destination');
+
+  // if there is a clean path, prepend the destination with it
+  if (platform.buildPath) {
+    destination = platform.buildPath + destination;
+  }
+
+  if (!fs.existsSync(destination)) {
+    console.log(chalk.bold.red('!') + ' ' + destination + ', does not exist');
+    return;
+  }
+
+  fs.unlinkSync(destination);
+  console.log(chalk.bold.red('-') + ' ' + destination);
+}
+
+
+module.exports = cleanFile;

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

@@ -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.
+ */
+
+const cleanFile = require('./cleanFile');
+
+/**
+ * Takes a platform config object and a dictionary
+ * object and cleans all the files. Dictionary object
+ * should have been transformed and resolved before this
+ * point.
+ * @memberOf StyleDictionary
+ * @param {Object} dictionary
+ * @param {Object} platform
+ * @returns {null}
+ */
+function cleanFiles(dictionary, platform) {
+  if (platform.buildPath && platform.buildPath.slice(-1) !== '/') {
+    throw new Error('Build path must end in a trailing slash or you will get weird file names.')
+  }
+
+  // while neither the format or dictionary are used by clean file I'm passing them in for symmetry to buildFile
+  platform.files.forEach(function (file) {
+    if (file.format) {
+      cleanFile(file, platform, dictionary);
+    } else {
+      throw new Error('Please supply a template or formatter')
+    }
+  });
+}
+
+
+module.exports = cleanFiles;

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

@@ -0,0 +1,62 @@
+/*
+ * 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.
+ */
+
+var createDictionary = require('./utils/createDictionary'),
+    transformConfig = require('./transform/config'),
+    cleanFiles = require('./cleanFiles'),
+    cleanDirs = require('./cleanDirs'),
+    cleanActions = require('./cleanActions');
+
+/**
+ * Takes a platform and performs all transforms to
+ * the tokens object (non-mutative) then
+ * cleans all the files and performs the undo method of any [actions](actions.md).
+ *
+ * @static
+ * @memberof module:style-dictionary
+ * @param {String} platform
+ * @returns {module:style-dictionary}
+ */
+function cleanPlatform(platform) {
+  console.log('\n' + platform);
+
+  if (!this.options || !(platform in (this.options.platforms || {}))) {
+    throw new Error('Platform ' + platform + ' doesn\'t exist');
+  }
+
+  var properties;
+  // We don't want to mutate the original object
+  var platformConfig = transformConfig(this.options.platforms[platform], this, platform);
+
+  // We need to transform the object before we resolve the
+  // variable names because if a value contains concatenated
+  // values like "1px solid {color.border.base}" we want to
+  // transform the original value (color.border.base) before
+  // replacing that value in the string.
+  properties = this.exportPlatform(platform);
+
+  // This is the dictionary object we pass to the file
+  // cleaning and action methods.
+  const dictionary = createDictionary({properties});
+
+  // We clean files first, then actions, ...and then directories?
+  cleanFiles(dictionary, platformConfig);
+  cleanActions(dictionary, platformConfig);
+  cleanDirs(dictionary, platformConfig);
+
+  // For chaining
+  return this;
+}
+
+
+module.exports = cleanPlatform;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/common/actions.js

@@ -0,0 +1,63 @@
+/*
+ * 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 fs = require('fs-extra');
+
+/**
+ * @namespace Actions
+ */
+module.exports = {
+  /**
+   * Action to copy images into appropriate android directories.
+   *
+   * @type {Action}
+   * @memberof Actions
+   */
+  'android/copyImages': {
+    do: function(dictionary, config) {
+      var imagesDir = config.buildPath + 'android/main/res/drawable-';
+      dictionary.allTokens.forEach(function(token) {
+        if (token.attributes.category === 'asset' && token.attributes.type === 'image') {
+          var name = token.path.slice(2,4).join('_');
+          fs.copySync(token.value, imagesDir + token.attributes.state + '/' + name + '.png');
+        }
+      });
+    },
+    undo: function(dictionary, config) {
+      var imagesDir = config.buildPath + 'android/main/res/drawable-';
+      dictionary.allTokens.forEach(function(token) {
+        if (token.attributes.category === 'asset' && token.attributes.type === 'image') {
+          var name = token.path.slice(2,4).join('_');
+          fs.removeSync(imagesDir + token.attributes.state + '/' + name + '.png');
+        }
+      });
+    }
+  },
+
+  /**
+   * Action that copies everything in the assets directory to a new assets directory in the build path of the platform.
+   *
+   * @type {Action}
+   * @memberof Actions
+   */
+  'copy_assets': {
+    do: function(dictionary, config) {
+      console.log('Copying assets directory to ' + config.buildPath + 'assets');
+      fs.copySync('assets', config.buildPath + 'assets');
+    },
+    undo: function(dictionary, config) {
+      console.log('Removing assets directory from ' + config.buildPath + 'assets');
+      fs.removeSync( config.buildPath + 'assets');
+    }
+  }
+};

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/common/filters.js

@@ -0,0 +1,30 @@
+/*
+ * 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.
+ */
+
+/**
+ * @namespace Filters
+ */
+
+module.exports = {
+  /**
+   * Remove a token from the ditribution output if it contains a key `private` set to true
+   *
+   * @memberof Filters
+   * 
+   * @param {Object} token
+   * @returns {Boolean} 
+   */
+  removePrivate: function(token) {
+    return (token && token.private) ? false : true
+  }
+}

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/common/formatHelpers/createPropertyFormatter.js

@@ -0,0 +1,152 @@
+/*
+ * 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 defaultFormatting = {
+  prefix: '',
+  commentStyle: 'long',
+  indentation: '',
+  separator: ' =',
+  suffix: ';'
+}
+
+/**
+ * Creates a function that can be used to format a property. This can be useful
+ * to use as the function on `dictionary.allTokens.map`. The formatting
+ * is configurable either by supplying a `format` option or a `formatting` object
+ * which uses: prefix, indentation, separator, suffix, and commentStyle.
+ * @memberof module:formatHelpers
+ * @example
+ * ```javascript
+ * StyleDictionary.registerFormat({
+ *   name: 'myCustomFormat',
+ *   formatter: function({ dictionary, options }) {
+ *     const { outputReferences } = options;
+ *     const formatProperty = createPropertyFormatter({
+ *       outputReferences,
+ *       dictionary,
+ *       format: 'css'
+ *     });
+ *     return dictionary.allTokens.map(formatProperty).join('\n');
+ *   }
+ * });
+ * ```
+ * @param {Object} options
+ * @param {Boolean} options.outputReferences - Whether or not to output references. You will want to pass this from the `options` object sent to the formatter function.
+ * @param {Boolean} options.outputReferenceFallbacks - Whether or not to output css variable fallback values when using output references. You will want to pass this from the `options` object sent to the formatter function.
+ * @param {Dictionary} options.dictionary - The dictionary object sent to the formatter function
+ * @param {String} options.format - Available formats are: 'css', 'sass', 'less', and 'stylus'. If you want to customize the format and can't use one of those predefined formats, use the `formatting` option
+ * @param {Object} options.formatting - Custom formatting properties that define parts of a declaration line in code. The configurable strings are: prefix, indentation, separator, suffix, and commentStyle. Those are used to generate a line like this: `${indentation}${prefix}${prop.name}${separator} ${prop.value}${suffix}`
+ * @param {Boolean} options.themeable [false] - Whether tokens should default to being themeable.
+ * @returns {Function}
+ */
+function createPropertyFormatter({
+  outputReferences = false,
+  outputReferenceFallbacks = false,
+  dictionary,
+  format,
+  formatting = {},
+  themeable = false
+}) {
+  let {prefix, commentStyle, indentation, separator, suffix} = Object.assign({}, defaultFormatting, formatting);
+
+  switch(format) {
+    case 'css':
+      prefix = '--';
+      indentation = '  ';
+      separator = ':';
+      break;
+    case 'sass':
+      prefix = '$';
+      commentStyle = 'short';
+      indentation = '';
+      separator = ':';
+      break;
+    case 'less':
+      prefix = '@';
+      commentStyle = 'short';
+      indentation = '';
+      separator = ':';
+      break;
+    case 'stylus':
+      prefix = '$';
+      commentStyle = 'short';
+      indentation = '';
+      separator = '=';
+      break;
+  }
+
+  return function(prop) {
+    let to_ret_prop = `${indentation}${prefix}${prop.name}${separator} `;
+    let value = prop.value;
+
+    /**
+     * A single value can have multiple references either by interpolation:
+     * "value": "{size.border.width.value} solid {color.border.primary.value}"
+     * or if the value is an object:
+     * "value": {
+     *    "size": "{size.border.width.value}",
+     *    "style": "solid",
+     *    "color": "{color.border.primary.value"}
+     * }
+     * This will see if there are references and if there are, replace
+     * the resolved value with the reference's name.
+     */
+    if (outputReferences && dictionary.usesReference(prop.original.value)) {
+      // Formats that use this function expect `value` to be a string
+      // or else you will get '[object Object]' in the output
+      if (typeof value === 'string') {
+        const refs = dictionary.getReferences(prop.original.value);
+        refs.forEach(ref => {
+          // value should be a string that contains the resolved reference
+          // because Style Dictionary resolved this in the resolution step.
+          // Here we are undoing that by replacing the value with
+          // the reference's name
+          if (ref.value && ref.name) {
+            value = value.replace(ref.value, function() {
+              if (format === 'css') {
+                if (outputReferenceFallbacks) {
+                  return `var(${prefix}${ref.name}, ${ref.value})`;
+                } else {
+                  return `var(${prefix}${ref.name})`;
+                }
+              } else {
+                return `${prefix}${ref.name}`;
+              }
+            });
+          }
+        });
+      }
+    }
+
+    to_ret_prop += prop.attributes.category === 'asset' ? `"${value}"` : value;
+
+    const themeable_prop = typeof prop.themeable === 'boolean' ? prop.themeable : themeable;
+    if (format === 'sass' && themeable_prop) {
+      to_ret_prop += ' !default';
+    }
+
+    to_ret_prop += suffix;
+
+    if (prop.comment && commentStyle !== 'none') {
+      if (commentStyle === 'short') {
+        to_ret_prop = to_ret_prop.concat(` // ${prop.comment}`);
+      } else {
+        to_ret_prop = to_ret_prop.concat(` /* ${prop.comment} */`);
+      }
+    }
+
+    return to_ret_prop;
+  }
+}
+
+module.exports = createPropertyFormatter;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/common/formatHelpers/fileHeader.js

@@ -0,0 +1,87 @@
+/*
+ * 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.
+ */
+
+// no-op default
+const defaultFileHeader = (arr) => arr
+
+const lineSeparator = `\n`;
+const defaultFormatting = {
+  lineSeparator,
+  prefix: ` * `,
+  header: `/**${lineSeparator}`,
+  footer: `${lineSeparator} */${lineSeparator}${lineSeparator}`
+}
+
+/**
+ *
+ * This is for creating the comment at the top of generated files with the generated at date.
+ * It will use the custom file header if defined on the configuration, or use the
+ * default file header.
+ * @memberof module:formatHelpers
+ * @param {Object} options
+ * @param {File} options.file - The file object that is passed to the formatter.
+ * @param {String} options.commentStyle - The only options are 'short' and 'xml', which will use the // or \<!-- --> style comments respectively. Anything else will use \/\* style comments.
+ * @param {Object} options.formatting - Custom formatting properties that define parts of a comment in code. The configurable strings are: prefix, lineSeparator, header, and footer.
+ * @returns {String}
+ * @example
+ * ```js
+ * StyleDictionary.registerFormat({
+ *   name: 'myCustomFormat',
+ *   formatter: function({ dictionary, file }) {
+ *     return fileHeader({file, commentStyle: 'short'}) +
+ *       dictionary.allTokens.map(token => `${token.name} = ${token.value}`)
+ *         .join('\n');
+ *   }
+ * });
+ * ```
+ */
+function fileHeader({file={}, commentStyle, formatting={}}) {
+  // showFileHeader is true by default
+  let showFileHeader = true;
+  if (file.options && typeof file.options.showFileHeader !== 'undefined') {
+    showFileHeader = file.options.showFileHeader;
+  }
+
+  // Return empty string if the showFileHeader is false
+  if (!showFileHeader) return '';
+
+  let fn = defaultFileHeader;
+  if (file.options && typeof file.options.fileHeader === 'function') {
+    fn = file.options.fileHeader;
+  }
+
+  // default header
+  const defaultHeader = [
+    `Do not edit directly`,
+    `Generated on ${new Date().toUTCString()}`
+  ];
+
+
+  let {prefix, lineSeparator, header, footer} = Object.assign({}, defaultFormatting, formatting);
+
+  if (commentStyle === 'short') {
+    prefix = `// `;
+    header = `${lineSeparator}`;
+    footer = `${lineSeparator}${lineSeparator}`;
+  } else if (commentStyle === 'xml') {
+    prefix = `  `;
+    header = `<!--${lineSeparator}`;
+    footer = `${lineSeparator}-->`;
+  }
+
+  return `${header}${fn(defaultHeader)
+    .map(line => `${prefix}${line}`)
+    .join(lineSeparator)}${footer}`;
+}
+
+module.exports = fileHeader;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/common/formatHelpers/formattedVariables.js

@@ -0,0 +1,69 @@
+/*
+ * 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 createPropertyFormatter = require('./createPropertyFormatter');
+const sortByReference = require('./sortByReference');
+
+const defaultFormatting = {
+  lineSeparator: '\n',
+}
+
+/**
+ *
+ * This is used to create lists of variables like Sass variables or CSS custom properties
+ * @memberof module:formatHelpers
+ * @param {Object} options
+ * @param {String} options.format - What type of variables to output. Options are: css, sass, less, and stylus
+ * @param {Object} options.dictionary - The dictionary object that gets passed to the formatter method.
+ * @param {Boolean} options.outputReferences - Whether or not to output references
+ * @param {Object} options.formatting - Custom formatting properties that define parts of a declaration line in code. This will get passed to `formatHelpers.createPropertyFormatter` and used for the `lineSeparator` between lines of code.
+ * @param {Boolean} options.themeable [false] - Whether tokens should default to being themeable.
+ * @returns {String}
+ * @example
+ * ```js
+ * StyleDictionary.registerFormat({
+ *   name: 'myCustomFormat',
+ *   formatter: function({ dictionary, options }) {
+ *     return formattedVariables({
+ *       format: 'less',
+ *       dictionary,
+ *       outputReferences: options.outputReferences
+ *     });
+ *   }
+ * });
+ * ```
+ */
+function formattedVariables({ format, dictionary, outputReferences = false, formatting = {}, themeable = false}) {
+  let {allTokens} = dictionary;
+
+  let {lineSeparator} = Object.assign({}, defaultFormatting, formatting);
+
+  // Some languages are imperative, meaning a variable has to be defined
+  // before it is used. If `outputReferences` is true, check if the token
+  // has a reference, and if it does send it to the end of the array.
+  // We also need to account for nested references, a -> b -> c. They
+  // need to be defined in reverse order: c, b, a so that the reference always
+  // comes after the definition
+  if (outputReferences) {
+    // note: using the spread operator here so we get a new array rather than
+    // mutating the original
+    allTokens = [...allTokens].sort(sortByReference(dictionary));
+  }
+
+  return allTokens
+    .map(createPropertyFormatter({ outputReferences, dictionary, format, formatting, themeable }))
+    .filter(function(strVal) { return !!strVal })
+    .join(lineSeparator);
+}
+
+module.exports = formattedVariables;

package/examples/advanced/custom-file-header/node_modules/style-dictionary/lib/common/formatHelpers/getTypeScriptType.js

@@ -0,0 +1,77 @@
+/*
+ * 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 { unique } = require('../../utils/es6_');
+
+/**
+ * Given some value, returns a basic valid TypeScript type for that value.
+ * Supports numbers, strings, booleans, arrays and objects of any of those types.
+ *
+ * @memberof module:formatHelpers
+ * @example
+ * ```javascript
+ * StyleDictionary.registerFormat({
+ *   name: 'myCustomFormat',
+ *   formatter: function({ dictionary, options }) {
+ *    return dictionary.allProperties.map(function(prop) {
+ *      var to_ret_prop = 'export const ' + prop.name + ' : ' + getTypeScriptType(prop.value) + ';';
+ *      if (prop.comment)
+ *        to_ret_prop = to_ret_prop.concat(' // ' + prop.comment);
+ *      return to_ret_prop;
+ *    }).join('\n');
+ *   }
+ * });
+ *``` 
+ * @param {*} value A value to check the type of.
+ * @return {String} A valid name for a TypeScript type.
+ *
+ */
+ function getTypeScriptType(value)  {
+  if (Array.isArray(value)) return getArrayType(value)
+  if (typeof value === 'object') return getObjectType(value)
+  if (['string', 'number', 'boolean'].includes(typeof value)) return typeof value
+
+  return 'any'
+}
+
+/**
+ * @param {Object} value An object with uknown type properties
+ * @returns {String} A representation of the type model for the passed object
+ */
+function getObjectType(value)  {
+  const entries = Object.entries(value)
+  return `{ ${entries.map(([key, property], index) => {
+    const isLast = entries.length === index + 1
+    return `${key}: ${getTypeScriptType(property)}${!isLast ? ', ' : ''}`
+  }).join('')} }`
+}
+
+/**
+ * @param {Array} value An array to check each property of
+ * @returns {String} A valid type for the passed array and it's items
+ */
+function getArrayType(passedArray)  {
+  if (passedArray.length > 0) {
+    const firstValueType = getTypeScriptType(passedArray[0]);
+    if (passedArray.every((v) => getTypeScriptType(v) === firstValueType)) {
+      return firstValueType + '[]';
+    } else {
+      return `(${unique(passedArray.map((item, index) => {
+        const isLast = passedArray.length === index + 1;
+        return `${getTypeScriptType(item)}${!isLast ? ' | ' : ''}`
+      })).join('')})[]`
+    }
+  }
+  return 'any[]';
+}
+
+module.exports = getTypeScriptType;