sketch-constructor/models/Layer/Layer.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 ExportOptions = require('../ExportOptions');
const Rect = require('../Rect');
const Style = require('../Style');
const { resizingConstraintsMap } = require('../../utils/maps.js');

/**
 * Base layer class
 *
 * This is an abstract class and should not be directly instantiated.
 */
class Layer {
  /**
   * @property {String} do_objectID
   * @property {integer} booleanOperation
   * @property {ExportOptions.Model} exportOptions
   * @property {Rect.Model} frame
   * @property {boolean} isFixedToViewport
   * @property {boolean} isFlippedHorizontal
   * @property {boolean} isFlippedVertical
   * @property {boolean} isLocked
   * @property {boolean} isVisible
   * @property {String} name
   * @property {boolean} nameIsFixed
   */
  static get Model() {
    return {
      _class: '',
      do_objectID: '',
      booleanOperation: -1,
      exportOptions: ExportOptions.Model,
      frame: Rect.Model,
      isFixedToViewport: false,
      isFlippedHorizontal: false,
      isFlippedVertical: false,
      isLocked: false,
      isVisible: true,
      layerListExpandedType: 0,
      name: '',
      nameIsFixed: false,
      resizingConstraint: resizingConstraintsMap.none,
      resizingType: 0,
      rotation: 0,
      shouldBreakMaskChain: false,
      style: Style.Model,
    };
  }

  constructor(args, json) {
    // If we are building a layer from raw JSON
    // go over the child layers and try to map them to
    // classes.
    if (json) {
      Object.assign(this, json);
      if (json.layers) {
        this.layers = json.layers.map(require('../../utils/layerToClass'));
      }
    }
  }

  addLayer(layer) {
    // Create a new Layer class unless it is already one
    // layer = layer instanceof Base ? layer : new Layer(layer);
    this.layers = this.layers.concat(layer);
    return this;
  }

  setSharedStyle(style) {
    this.style = style.value;
    this.sharedStyleID = style.do_objectID;
  }

  // getGroup(id) {}

  getGroups() {
    return this.layers.filter((layer) => layer._class === 'group');
  }

  /**
   * Get all direct child layers, and optionally filter them by a predicate function.
   * @param {function} [predicate] - Filter function if you want to only return certain layers
   * @returns {Layer[]} An array of layers. Will only be the direct children layers.
   */
  getLayers(predicate) {
    if (predicate) {
      return this.layers.filter(predicate);
    }
    return this.layers;
  }

  /**
   * Get all child, grandchild, etc layers, and optionally filter them by a predicate function.
   * @param {function} [predicate] - Filter function if you want to only return certain layers
   * @returns {Layer[]} An array of all layers. Will return all direct children, grandchildren, etc.
   */
  getAllLayers(predicate) {
    function getRecursiveLayers(current, list) {
      if (current === null || current === undefined) {
        return list;
      }
      const childLayers = current.getLayers();
      if (childLayers !== undefined) {
        childLayers.forEach((layer) => {
          list.push(layer);
          getRecursiveLayers(layer, list);
        });
      }
      return list;
    }

    const allLayers = getRecursiveLayers(this, []);

    if (predicate) {
      return allLayers.filter(predicate);
    }

    return allLayers;
  }

  getID() {
    return this.do_objectID;
  }
}

module.exports = Layer;