sketch-constructor/models/Document/Document.js

Read/write/manipulate Sketch files in Node without Sketch plugins!

/*
 * 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 uuid = require('uuid-v4');
const SharedStyle = require('../SharedStyle');

/**
 * A Document is a sketch file
 */
class Document {
  static get Model() {
    return {
      _class: 'document',
      do_objectID: '',
      assets: {
        _class: 'assetCollection',
        colors: [],
        gradients: [],
        imageCollection: {
          _class: 'imageCollection',
          images: {},
        },
        images: [],
      },
      colorSpace: 0,
      currentPageIndex: 1,
      foreignLayerStyles: [],
      foreignSymbols: [],
      foreignTextStyles: [],
      layerStyles: {
        _class: 'sharedStyleContainer',
        objects: [],
      },
      layerSymbols: {
        _class: 'symbolContainer',
        objects: [],
      },
      layerTextStyles: {
        _class: 'sharedTextStyleContainer',
        objects: [],
      },
      sharedSwatches: {
        _class: 'swatchContainer',
        objects: [],
      },
      pages: [],
    };
  }

  /**
   *
   * @param {Object} args
   * @param {Document.Model} json
   */
  constructor(args = {}, json) {
    if (json) {
      Object.assign(this, json);
      // Create nested classes
      this.layerTextStyles.objects = this.layerTextStyles.objects.map(
        (sharedStyle) => new SharedStyle(null, sharedStyle)
      );
      this.layerStyles.objects = this.layerStyles.objects.map((sharedStyle) => new SharedStyle(null, sharedStyle));
    } else {
      const id = args.id || uuid().toUpperCase();

      Object.assign(this, Document.Model, {
        do_objectID: id,
      });
    }
    return this;
  }

  /**
   * @returns {SharedStyle[]} An array of layer styles as SharedStyle classes
   */
  getLayerStyles() {
    return this.layerStyles.objects;
  }

  /**
   *
   * @param {String} name
   * @returns {SharedStyle}
   */
  getLayerStyle(name) {
    return this.layerStyles.objects.find((style) => style.name === name);
  }

  /**
   *
   * @param {SharedStyle} style
   * @returns {this}
   */
  addLayerStyle(style) {
    this.layerStyles.objects = this.layerStyles.objects.concat(style);
    return this;
  }

  /**
   * @returns {SharedStyle[]} An array of SharedStyles
   */
  getTextStyles() {
    return this.layerTextStyles.objects;
  }

  /**
   *
   * @param {SharedStyle} style
   * @returns {this}
   */
  addTextStyle(style) {
    this.layerTextStyles.objects = this.layerTextStyles.objects.concat(style);
    return this;
  }

  /**
   * @returns {Swatch[]} An array of Swatches
   */
  getSwatches() {
    return this.sharedSwatches.objects;
  }

  /**
   *
   * @param {Swatch} swatch
   * @returns {this}
   */
  addSwatch(swatch) {
    this.sharedSwatches.objects = this.sharedSwatches.objects.concat(swatch);
    return this;
  }

  /**
   *
   * @param {String} pageID
   * @returns {this}
   */
  addPage(pageID) {
    this.pages = this.pages.concat({
      _class: 'MSJSONFileReference',
      _ref_class: 'MSImmutablePage',
      _ref: `pages/${pageID}`,
    });
    return this;
  }
}

module.exports = Document;