Merge pull request #914 from sketch-hq/feature/50732

merging SketchAPI from Sketch repo

Author: Ana-ilundain-areso

Source/dom/layers/SymbolInstance.js

@@ -52,7 +52,7 @@ export class SymbolInstance extends StyledLayer {
       return this
     }
     const wrappedOverride = wrapObject(override)
-    const overridePoint = wrappedOverride.sketchObject.overridePoint()
+    const overridePoint = wrappedOverride.sketchObject
     if (wrappedOverride.property === 'image') {
       this._object.setValue_forOverridePoint(
         ImageData.from(value).sketchObject,
@@ -148,15 +148,13 @@ SymbolInstance.define('master', {
 SymbolInstance.define('overrides', {
   get() {
     // undefined when immutable
-    if (!this._object.availableOverrides) {
+    if (!this._object.overridePoints) {
       return undefined
     }
-    const overrides = toArray(
-      MSAvailableOverride.flattenAvailableOverrides(
-        this._object.availableOverrides()
-      )
-    )
 
+    this._object.ensureDetachHasUpdated()
+
+    const overrides = toArray(this._object.overridePoints())
     return overrides.map((o) => {
       const wrapped = Override.fromNative(o)
       Object.defineProperty(wrapped, '__symbolInstance', {

Source/dom/layers/SymbolMaster.js

@@ -142,15 +142,12 @@ SymbolMaster.define('symbolId', {
 
 SymbolMaster.define('overrides', {
   get() {
-  if (!this._object.availableOverrides) {
-    return undefined
-  }
-  
-  const overrides = toArray(
-      MSAvailableOverride.flattenAvailableOverrides(
-        this._object.availableOverrides()
-      )
-    )
+    if (!this._object.overridePoints) {
+      return undefined
+    }
+
+    this._object.ensureDetachHasUpdated()
+    const overrides = toArray(this._object.overridePoints())
 
     return overrides.map((o) => {
       const wrapped = Override.fromNative(o)

Source/dom/layers/__tests__/SymbolInstance.test.js

@@ -59,6 +59,7 @@ test('should detach an instance', (_context, document) => {
     symbolId: master.symbolId,
     parent: document.selectedPage,
   })
+  instance.sketchObject.ensureDetachHasUpdated()
   expect(instance.type).toBe('SymbolInstance')
 
   const group = instance.detach()
@@ -72,6 +73,7 @@ test('should detach an instance recursively', (_context, document) => {
     symbolId: master.symbolId,
     parent: document.selectedPage,
   })
+  instance.sketchObject.ensureDetachHasUpdated()
   expect(instance.type).toBe('SymbolInstance')
 
   const group = instance.detach({ recursively: true })

Source/dom/layers/__tests__/SymbolMaster.test.js

@@ -1,6 +1,6 @@
 /* globals expect, test */
 /* eslint-disable no-param-reassign */
-import { SymbolMaster, Text, Artboard } from '../..'
+import { SymbolInstance, SymbolMaster, Text, Artboard } from '../..'
 import { createSymbolMaster, canBeLogged } from '../../../test-utils'
 
 test('should create a symbol master from an artboard', (_context, document) => {
@@ -66,7 +66,8 @@ test('should create a symbol master with a nested symbol', (_context, document)
 
   // add the instance to the page
   document.selectedPage.layers = document.selectedPage.layers.concat(instance)
-  expect(instance.overrides.length).toBe(13)
+  expect(instance.overrides.length).toBe(14)
+  canBeLogged(instance, SymbolInstance)
   const result0 = {
     type: 'Override',
     id: `${text2.id}_stringValue`,
@@ -96,7 +97,7 @@ test('should create a symbol master with a nested symbol', (_context, document)
   }
   delete result1.affectedLayer.overrides
   delete result1.affectedLayer.selected
-  result1.affectedLayer.style = instance.overrides[6].affectedLayer.style.toJSON()
+  result1.affectedLayer.style = instance.overrides[7].affectedLayer.style.toJSON()
   const result2 = {
     type: 'Override',
     id: `${nestedInstance.id}/${text.id}_stringValue`,
@@ -110,10 +111,10 @@ test('should create a symbol master with a nested symbol', (_context, document)
     selected: false,
   }
   delete result2.affectedLayer.selected
-  result2.affectedLayer.style = instance.overrides[7].affectedLayer.style.toJSON()
+  result2.affectedLayer.style = instance.overrides[8].affectedLayer.style.toJSON()
   expect(instance.overrides[0].toJSON()).toEqual(result0)
-  expect(instance.overrides[6].toJSON()).toEqual(result1)
-  expect(instance.overrides[7].toJSON()).toEqual(result2)
+  expect(instance.overrides[7].toJSON()).toEqual(result1)
+  expect(instance.overrides[8].toJSON()).toEqual(result2)
 })
 
 test('should have overrides', (_context, document) => {
@@ -131,6 +132,7 @@ test('should have overrides', (_context, document) => {
     isDefault: true,
     editable: true,
     affectedLayer: text.toJSON(),
+    selected: false,
   }
   delete result.affectedLayer.selected
   result.affectedLayer.style = master.overrides[0].affectedLayer.style.toJSON()

Source/dom/models/Override.js

@@ -1,74 +1,120 @@
-import { toArray } from 'util'
 import { DefinedPropertiesKey, WrappedObject } from '../WrappedObject'
 import { Types } from '../enums'
 import { Factory } from '../Factory'
 import { ImageData } from './ImageData'
 import { wrapNativeObject } from '../wrapNativeObject'
 import { Rectangle } from './Rectangle'
 
-/**
- * An MSAvailableOverride. This is not exposed, only used by SymbolInstance
- */
 export class Override extends WrappedObject {
-  _findRepresentation() {
+  // Returns any override directly set on the symbol instance or null if none is set or this is an override point on a symbol source
+  getValueSetOnInstance() {
     if (!this.__symbolInstance) {
-      return undefined
+      return null
+    }
+    var overrideValues = this.__symbolInstance.sketchObject.overrideValues()
+    for (var i = 0; i < overrideValues.length; i++) {
+      if (
+        overrideValues[i].overridePath().isEqual(this._object.overridePath())
+      ) {
+        return overrideValues[i].value()
+      }
     }
-    this.__symbolInstance.sketchObject.ensureDetachHasUpdated()
-    return toArray(
-      this.__symbolInstance.sketchObject.overrideContainer().flattenedChildren()
-    ).find((x) => x.availableOverride().overridePoint().fullPath().isEqual(this.sketchObject.overridePoint().fullPath()))
+    return null
   }
 
-  getFrame() {
-    const representation = this._findRepresentation()
-    if (!representation) {
-      return undefined
+  // Returns the current value of the override point. This is the value set on the layer in the detached version of the symbol. It may be
+  // out-of-date if the detached symbol hasn't yet updated.
+  getResolvedValueOnDetachedSymbol() {
+    return this.affectedLayer.sketchObject.valueForOverrideAttribute(
+      this.property
+    )
+  }
+
+  // Returns the value the override point will have if there is no override set on this instance.
+  getDefaultValue() {
+    if (!this.__symbolInstance) {
+      return this.getResolvedValueOnDetachedSymbol()
     }
-    const path = representation.pathInInstance()
-    return new Rectangle(CGPathGetBoundingBox(path))
+    return this.__symbolInstance.sketchObject.defaultValueForOverridePoint(
+      this._object
+    )
+  }
+
+  // Returns a SelectionItem representing this override point
+  selectionItem() {
+    if (this.__symbolInstance) {
+      return this.__symbolInstance.sketchObject.selectionItemForOverridePoint(
+        this.sketchObject
+      )
+    }
+    if (this.__symbolMaster) {
+      return this.__symbolMaster.sketchObject.selectionItemForOverridePoint(
+        this.sketchObject
+      )
+    }
+    return null
   }
-}
 
+  getOwningPage() {
+    if (this.__symbolInstance) {
+      return this.__symbolInstance.sketchObject.parentPage()
+    }
+    if (this.__symbolMaster) {
+      return this.__symbolMaster.sketchObject.parentPage()
+    }
+    return null
+  }
+
+  getFrame() {
+    return new Rectangle(this._object.layer().frame().rect())
+  }
+}
 Override.type = Types.Override
 Override[DefinedPropertiesKey] = { ...WrappedObject[DefinedPropertiesKey] }
-Factory.registerClass(Override, MSAvailableOverride)
+Factory.registerClass(Override, MSOverridePoint)
 
 Override.define('path', {
   get() {
-    return String(this._object.overridePoint().path())
+    return String(this._object.path())
   },
 })
 
 Override.define('property', {
   get() {
-    return String(this._object.overridePoint().attributeName())
+    return String(this._object.attributeName())
   },
 })
 
 Override.define('affectedLayer', {
   get() {
-    return wrapNativeObject(this._object.affectedLayer())
+    var layer = this._object.layer()
+    if (layer.instance) {
+      layer = layer.instance()
+    }
+    return wrapNativeObject(layer)
   },
 })
 
 Override.define('id', {
   exportable: true,
   importable: false,
   get() {
-    return String(this._object.overridePoint().name())
+    return String(this._object.name())
   },
 })
 
 Override.define('symbolOverride', {
   get() {
-    return Boolean(this._object.overridePoint().isSymbolOverride())
+    return Boolean(this._object.isSymbolOverride())
   },
 })
 
 Override.define('value', {
   get() {
-    const value = this._object.currentValue()
+    var value = this.getValueSetOnInstance()
+    if (!value) {
+      value = this.getResolvedValueOnDetachedSymbol()
+    }
     if (this.property === 'image') {
       return ImageData.fromNative(value)
     }
@@ -78,9 +124,9 @@ Override.define('value', {
       Object.keys(value).forEach((name) => {
         map[name] = value[name]
       })
-	  return map
+      return map
     }
-    return String(this._object.currentValue())
+    return String(value)
   },
   set(value) {
     // __symbolInstance is set when building the Override
@@ -93,45 +139,30 @@ Override.define('value', {
 
 Override.define('isDefault', {
   get() {
-    return !this._object.hasOverride()
+    return this.getValueSetOnInstance() == null
   },
 })
 
 Override.define('editable', {
   get() {
-    var overrides
     var master
     if (typeof this.__symbolMaster !== 'undefined') {
       master = this.__symbolMaster.sketchObject
-      overrides = master.overridePoints
     } else if (typeof this.__symbolInstance !== 'undefined') {
       var masterGetter = this.__symbolInstance.sketchObject.symbolMaster
       if (masterGetter !== 'undefined') {
         master = masterGetter()
       }
-      overrides = this.__symbolInstance.sketchObject.overridePoints
-    }
-  
-    if (typeof overrides == 'undefined') {
-      // Can't get the override points - maybe this is an immutable?
-      return false
     }
+
     if (typeof master == 'undefined') {
       throw new Error('Unable to find the symbol source for this override')
     }
-
-    var point
-    overrides().forEach((o) => {
-      if (o.fullPath().isEqual(this._object.overridePoint().fullPath())) {
-        point = o
-      }
-    })
-  
-    if (typeof point == 'undefined') {
-      return false
-    }
-
-    if (master.allowsOverrides() && master.isOverridePointEditable(point) && point.isConfigurable()) {
+    if (
+      master.allowsOverrides() &&
+      master.isOverridePointEditable(this._object) &&
+      this._object.isConfigurable()
+    ) {
       return true
     } else {
       return false
@@ -143,60 +174,33 @@ Override.define('editable', {
       throw new Error('Can only set `editable` for a symbol master')
     }
     this.__symbolMaster.sketchObject.setOverridePoint_editable(
-      this._object.overridePoint(),
+      this._object,
       editable
     )
   },
 })
 
 Override.define('selected', {
   get() {
-    // __symbolInstance is set when building the Override
-    if (!this.__symbolInstance) {
-      return undefined
-    }
-
-    const representation = this._findRepresentation()
-
-    if (!representation) {
-      return false
+    let item = this.selectionItem()
+    if (this.getOwningPage().selection().isItemSelected(item)) {
+      return true
     }
-
-    return Boolean(Number(representation.isSelected()))
+    return false
   },
   set(selected) {
-    // __symbolInstance is set when building the Override
-    if (!this.__symbolInstance) {
-      throw new Error('Can only set `selected` for a symbol instance')
-    }
-
-    const documentData =
-      this.__symbolInstance.sketchObject.documentData &&
-      this.__symbolInstance.sketchObject.documentData()
-    if (!documentData) {
-      return
-    }
-
-    const representation = this._findRepresentation()
-
-    if (!representation) {
-      return
-    }
-
-    var selectionItem = representation.selectionItem()
-    if (!selectionItem) {
+    let item = this.selectionItem()
+    if (!item) {
       return
     }
-    
-    var page = this.__symbolInstance.sketchObject.parentPage()
+    let page = this.getOwningPage()
     if (!page) {
       return
     }
-
     if (selected) {
-      page.changeSelectionByAddingItems_extendExisting([selectionItem], true)
+      page.changeSelectionByAddingItems_extendExisting([item], true)
     } else {
-      page.changeSelectionByRemovingItems([selectionItem])
+      page.changeSelectionByRemovingItems([item])
     }
   },
 })