Merge SketchAPI changes from Sketch repo to SketchAPI public repo for Sketch 95.2

Author: SheffieldKevin

Source/dom/layers/SymbolInstance.js

@@ -70,8 +70,8 @@ export class SymbolInstance extends StyledLayer {
     if (this.isImmutable()) {
       return this
     }
-		this._object.ensureDetachHasUpdated()
-    this._object.resizeToFitContentsIfNeededNoCache()
+    this._object.ensureDetachHasUpdated()
+    this._object.resizeToFitContentsIfNeeded()
     return this
   }
 }

Source/dom/layers/SymbolMaster.js

@@ -142,53 +142,41 @@ SymbolMaster.define('symbolId', {
 
 SymbolMaster.define('overrides', {
   get() {
-    const method = (function (sketchVersion) {
-      if (sketchVersion < 65) {
-        return 'overrideProperies'
-      }
-      if (sketchVersion < 71) {
-        return 'overrideProperties'
-      }
-      return 'overridePropertyDict'
-    })(BCSketchInfo.shared().metadata().appVersion)
-
-    // undefined when immutable
-    if (!this._object[method] || !this._object.availableOverrides) {
-      return undefined
-    }
-    const overrideProperties = this._object[method]()
-    const overrides = toArray(
+  if (!this._object.availableOverrides) {
+    return undefined
+  }
+  
+  const overrides = toArray(
       MSAvailableOverride.flattenAvailableOverrides(
         this._object.availableOverrides()
       )
     )
 
     return overrides.map((o) => {
       const wrapped = Override.fromNative(o)
-      const property = overrideProperties[o.overridePoint().name()]
       Object.defineProperty(wrapped, '__symbolMaster', {
         writable: false,
         enumerable: false,
         value: this,
       })
-      if (property && !o.isVisible) {
-        Object.defineProperty(wrapped, '__editable', {
-          writable: true,
-          enumerable: false,
-          value: property.canOverride,
-        })
-      }
       return wrapped
     })
   },
   set(overrides) {
     if (this.isImmutable()) {
       return
     }
+
+    var dict = {}
+    this._object.overridePoints().forEach((o) => {
+      dict[o.name()] = o
+    })
+  
     overrides.forEach((o) => {
-      const overridePoint = MSOverridePoint.alloc().init()
-      overridePoint.name = o.id
-      this._object.setOverridePoint_editable(overridePoint, o.editable)
+      const overridePoint = dict[o.id]
+      if (overridePoint) {
+        this._object.setOverridePoint_editable(overridePoint, o.editable)
+      }
     })
   },
 })

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

@@ -32,6 +32,7 @@ test('should have overrides', (_context, document) => {
   const { master, text } = createSymbolMaster(document)
   const instance = master.createNewInstance()
   document.selectedPage.layers = document.selectedPage.layers.concat(instance)
+  instance.sketchObject.ensureDetachHasUpdated()
 
   expect(instance.overrides.length).toBe(6)
   const override = instance.overrides[0]
@@ -77,19 +78,19 @@ test('should detach an instance recursively', (_context, document) => {
   expect(group.type).toBe('Group')
 })
 
-// test('should resize in response to smart layout changes', (_context, document) => {
-//   const { master } = createSymbolMaster(document)
-//   master.smartLayout = SmartLayout.LeftToRight
-//   const instance = new SymbolInstance({
-//     symbolId: master.symbolId,
-//     parent: document.selectedPage,
-//   })
-//   const initialWidth = instance.frame.width
-//   instance.overrides[0].value = '0'.repeat(1000)
-//   instance.resizeWithSmartLayout()
-//   const widthAfterSmartLayout = instance.frame.width
-//   expect(widthAfterSmartLayout).toBeGreaterThan(initialWidth)
-// })
+test('should resize in response to smart layout changes', (_context, document) => {
+  const { master } = createSymbolMaster(document)
+  master.smartLayout = SmartLayout.LeftToRight
+  const instance = new SymbolInstance({
+    symbolId: master.symbolId,
+    parent: document.selectedPage,
+  })
+  const initialWidth = instance.frame.width
+  instance.overrides[0].value = 'A string that is long enough to cause a size change, hopefully in the positive direction'
+  instance.resizeWithSmartLayout()
+  const widthAfterSmartLayout = instance.frame.width
+  expect(widthAfterSmartLayout).toBeGreaterThan(initialWidth)
+})
 
 // test('should change an override value', (_context, document) => {
 //   const { master } = createSymbolMaster(document)

Source/dom/models/Override.js

@@ -14,10 +14,10 @@ export class Override extends WrappedObject {
     if (!this.__symbolInstance) {
       return undefined
     }
-		this.__symbolInstance.sketchObject.ensureDetachHasUpdated()
+    this.__symbolInstance.sketchObject.ensureDetachHasUpdated()
     return toArray(
       this.__symbolInstance.sketchObject.overrideContainer().flattenedChildren()
-    ).find((x) => x.availableOverride().overridePoint().name().isEqual(this.sketchObject.overridePoint().name()))
+    ).find((x) => x.availableOverride().overridePoint().fullPath().isEqual(this.sketchObject.overridePoint().fullPath()))
   }
 
   getFrame() {
@@ -42,7 +42,7 @@ Override.define('path', {
 
 Override.define('property', {
   get() {
-    return String(this._object.overridePoint().property())
+    return String(this._object.overridePoint().attributeName())
   },
 })
 
@@ -72,6 +72,14 @@ Override.define('value', {
     if (this.property === 'image') {
       return ImageData.fromNative(value)
     }
+    if (value !== null && value.isKindOfClass_(NSDictionary.class())) {
+      // Map dictionary overrides into a javascript dictionary
+      var map = {}
+      Object.keys(value).forEach((name) => {
+        map[name] = value[name]
+      })
+	  return map
+    }
     return String(this._object.currentValue())
   },
   set(value) {
@@ -91,17 +99,49 @@ Override.define('isDefault', {
 
 Override.define('editable', {
   get() {
-    if (typeof this.__editable !== 'undefined') {
-      return this.__editable
+    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()) {
+      return true
+    } else {
+      return false
     }
-    return Boolean(Number(this._object.isEditable()))
   },
   set(editable) {
     // __symbolInstance is set when building the Override
-    if (!this.__symbolMaster) {
+    if (typeof this.__symbolMaster == 'undefined') {
       throw new Error('Can only set `editable` for a symbol master')
     }
-    this.__editable = editable
     this.__symbolMaster.sketchObject.setOverridePoint_editable(
       this._object.overridePoint(),
       editable
@@ -143,20 +183,20 @@ Override.define('selected', {
       return
     }
 
-		var selectionItem = representation.selectionItem()
-		if (!selectionItem) {
-			return
-		}
-		
-		var page = this.__symbolInstance.sketchObject.parentPage()
-		if (!page) {
-			return
-		}
-
-		if (selected) {
-  		page.changeSelectionByAddingItems_extendExisting([selectionItem], true)
-		} else {
-  		page.changeSelectionByRemovingItems([selectionItem])
-		}
+    var selectionItem = representation.selectionItem()
+    if (!selectionItem) {
+      return
+    }
+    
+    var page = this.__symbolInstance.sketchObject.parentPage()
+    if (!page) {
+      return
+    }
+
+    if (selected) {
+      page.changeSelectionByAddingItems_extendExisting([selectionItem], true)
+    } else {
+      page.changeSelectionByRemovingItems([selectionItem])
+    }
   },
 })

Source/test-utils.js

@@ -21,8 +21,11 @@ export function createSymbolMaster(document) {
   })
 
   // build the symbol master
+  const master = SymbolMaster.fromArtboard(artboard)
+  master.sketchObject.ensureDetachHasUpdated()
+
   return {
-    master: SymbolMaster.fromArtboard(artboard),
+    master: master,
     text,
     artboard,
   }