@sketch-hq/sketch-file-format-ts - npm Package Compare versions

Comparing version 6.2.1 to 6.3.0

CHANGELOG.md

 # @sketch-hq/sketch-file-format-ts
 
+## 6.3.0
+
+### Minor Changes
+
+- 6a66fb9: Added `preservesSpaceWhenHidden` to SymbolInstance and updated dependencies
+- 582e216: - Add `isTemplate` attribute to Layer to mark it as template for
+  insertion of copies elsewhere.
+  - Artboards now contain a `prototypeViewport` attribute with a
+    `PrototypeViewport` object to describe the associated viewport for
+    prototypes, replacing the untyped presetDictionary attribute.
+  - FlowConnection now contains an automatic destination option.
+
 ## 6.2.1
@@ -4,0 +16,0 @@

dist/cjs/index.js

 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
@@ -6,0 +10,0 @@ if (k2 === undefined) k2 = k;

dist/cjs/types.d.ts

@@ -457,2 +457,3 @@ /**
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -567,3 +568,3 @@ layerListExpandedType: LayerListExpanded;
     _class: 'MSImmutableFlowConnection';
-    destinationArtboardID: Uuid | 'back';
+    destinationArtboardID: Uuid | 'back' | 'automatic';
     animationType: AnimationType;
@@ -690,2 +691,3 @@ maintainScrollPosition?: boolean;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -723,2 +725,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -799,2 +802,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -834,2 +838,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -871,2 +876,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -905,2 +911,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -941,2 +948,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -976,2 +984,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1010,2 +1019,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1089,2 +1099,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1110,2 +1121,3 @@ layerListExpandedType: LayerListExpanded;
     horizontalSpacing: number;
+    preservesSpaceWhenHidden?: boolean;
 };
@@ -1134,2 +1146,3 @@ /**
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1166,2 +1179,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1196,2 +1210,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1320,2 +1335,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1357,2 +1373,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1384,6 +1401,21 @@ layerListExpandedType: LayerListExpanded;
     resizesContent: boolean;
-    presetDictionary?: any;
+    prototypeViewport?: PrototypeViewport;
     layers: (Group | Oval | Polygon | Rectangle | ShapePath | Star | Triangle | ShapeGroup | Text | SymbolInstance | Slice | Hotspot | Bitmap)[];
 };
 /**
+ * Defines a prototype viewport with a reference to the original template layer that was used defining it.
+ */
+export declare type PrototypeViewport = {
+    _class: 'MSImmutablePrototypeViewport';
+    name: string;
+    size: SizeString;
+    templateID?: Uuid;
+    libraryID?: Uuid;
+};
+/**
+ * A formatted string representation of a rectangle size, e.g. {10.5, 10}.
+
+ */
+export declare type SizeString = string;
+/**
  * Contains metadata about the Sketch file - information about pages and artboards appearing in the file, fonts used, the version of Sketch used to save the file etc.
@@ -1520,3 +1552,3 @@ */
  */
-export declare type AnyObject = AssetCollection | ImageCollection | ColorAsset | Color | GradientAsset | Gradient | GradientStop | FileRef | DataRef | ForeignLayerStyle | SharedStyle | Style | Border | GraphicsContextSettings | BorderOptions | Blur | Fill | TextStyle | ParagraphStyle | FontDescriptor | Shadow | InnerShadow | ColorControls | ForeignSymbol | SymbolMaster | ExportOptions | ExportFormat | Rect | FlowConnection | RulerData | LayoutGrid | SimpleGrid | FreeformGroupLayout | InferredGroupLayout | OverrideProperty | Group | Oval | CurvePoint | Polygon | Rectangle | ShapePath | Star | Triangle | ShapeGroup | Text | AttributedString | StringAttribute | SymbolInstance | OverrideValue | Slice | Hotspot | Bitmap | ForeignTextStyle | ForeignSwatch | Swatch | SharedStyleContainer | SharedTextStyleContainer | SymbolContainer | SwatchContainer | FontRef | PatchInfo | Page | Artboard;
+export declare type AnyObject = AssetCollection | ImageCollection | ColorAsset | Color | GradientAsset | Gradient | GradientStop | FileRef | DataRef | ForeignLayerStyle | SharedStyle | Style | Border | GraphicsContextSettings | BorderOptions | Blur | Fill | TextStyle | ParagraphStyle | FontDescriptor | Shadow | InnerShadow | ColorControls | ForeignSymbol | SymbolMaster | ExportOptions | ExportFormat | Rect | FlowConnection | RulerData | LayoutGrid | SimpleGrid | FreeformGroupLayout | InferredGroupLayout | OverrideProperty | Group | Oval | CurvePoint | Polygon | Rectangle | ShapePath | Star | Triangle | ShapeGroup | Text | AttributedString | StringAttribute | SymbolInstance | OverrideValue | Slice | Hotspot | Bitmap | ForeignTextStyle | ForeignSwatch | Swatch | SharedStyleContainer | SharedTextStyleContainer | SymbolContainer | SwatchContainer | FontRef | PatchInfo | Page | Artboard | PrototypeViewport;
 /**
@@ -1538,2 +1570,3 @@ * Enum of all possible _class property values
     MSImmutablePatchInfo = "MSImmutablePatchInfo",
+    MSImmutablePrototypeViewport = "MSImmutablePrototypeViewport",
     MSJSONFileReference = "MSJSONFileReference",
@@ -1646,2 +1679,3 @@ MSJSONOriginalDataReference = "MSJSONOriginalDataReference",
     MSJSONFileReference: FileRef;
+    MSImmutablePrototypeViewport: PrototypeViewport;
     MSImmutablePatchInfo: PatchInfo;
@@ -1648,0 +1682,0 @@ MSImmutableOverrideProperty: OverrideProperty;

dist/cjs/types.js

@@ -344,2 +344,3 @@ "use strict";
     ClassValue["MSImmutablePatchInfo"] = "MSImmutablePatchInfo";
+    ClassValue["MSImmutablePrototypeViewport"] = "MSImmutablePrototypeViewport";
     ClassValue["MSJSONFileReference"] = "MSJSONFileReference";
@@ -346,0 +347,0 @@ ClassValue["MSJSONOriginalDataReference"] = "MSJSONOriginalDataReference";

dist/esm/types.d.ts

@@ -457,2 +457,3 @@ /**
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -567,3 +568,3 @@ layerListExpandedType: LayerListExpanded;
     _class: 'MSImmutableFlowConnection';
-    destinationArtboardID: Uuid | 'back';
+    destinationArtboardID: Uuid | 'back' | 'automatic';
     animationType: AnimationType;
@@ -690,2 +691,3 @@ maintainScrollPosition?: boolean;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -723,2 +725,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -799,2 +802,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -834,2 +838,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -871,2 +876,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -905,2 +911,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -941,2 +948,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -976,2 +984,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1010,2 +1019,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1089,2 +1099,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1110,2 +1121,3 @@ layerListExpandedType: LayerListExpanded;
     horizontalSpacing: number;
+    preservesSpaceWhenHidden?: boolean;
 };
@@ -1134,2 +1146,3 @@ /**
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1166,2 +1179,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1196,2 +1210,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1320,2 +1335,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1357,2 +1373,3 @@ layerListExpandedType: LayerListExpanded;
     isLocked: boolean;
+    isTemplate: boolean;
     isVisible: boolean;
@@ -1384,6 +1401,21 @@ layerListExpandedType: LayerListExpanded;
     resizesContent: boolean;
-    presetDictionary?: any;
+    prototypeViewport?: PrototypeViewport;
     layers: (Group | Oval | Polygon | Rectangle | ShapePath | Star | Triangle | ShapeGroup | Text | SymbolInstance | Slice | Hotspot | Bitmap)[];
 };
 /**
+ * Defines a prototype viewport with a reference to the original template layer that was used defining it.
+ */
+export declare type PrototypeViewport = {
+    _class: 'MSImmutablePrototypeViewport';
+    name: string;
+    size: SizeString;
+    templateID?: Uuid;
+    libraryID?: Uuid;
+};
+/**
+ * A formatted string representation of a rectangle size, e.g. {10.5, 10}.
+
+ */
+export declare type SizeString = string;
+/**
  * Contains metadata about the Sketch file - information about pages and artboards appearing in the file, fonts used, the version of Sketch used to save the file etc.
@@ -1520,3 +1552,3 @@ */
  */
-export declare type AnyObject = AssetCollection | ImageCollection | ColorAsset | Color | GradientAsset | Gradient | GradientStop | FileRef | DataRef | ForeignLayerStyle | SharedStyle | Style | Border | GraphicsContextSettings | BorderOptions | Blur | Fill | TextStyle | ParagraphStyle | FontDescriptor | Shadow | InnerShadow | ColorControls | ForeignSymbol | SymbolMaster | ExportOptions | ExportFormat | Rect | FlowConnection | RulerData | LayoutGrid | SimpleGrid | FreeformGroupLayout | InferredGroupLayout | OverrideProperty | Group | Oval | CurvePoint | Polygon | Rectangle | ShapePath | Star | Triangle | ShapeGroup | Text | AttributedString | StringAttribute | SymbolInstance | OverrideValue | Slice | Hotspot | Bitmap | ForeignTextStyle | ForeignSwatch | Swatch | SharedStyleContainer | SharedTextStyleContainer | SymbolContainer | SwatchContainer | FontRef | PatchInfo | Page | Artboard;
+export declare type AnyObject = AssetCollection | ImageCollection | ColorAsset | Color | GradientAsset | Gradient | GradientStop | FileRef | DataRef | ForeignLayerStyle | SharedStyle | Style | Border | GraphicsContextSettings | BorderOptions | Blur | Fill | TextStyle | ParagraphStyle | FontDescriptor | Shadow | InnerShadow | ColorControls | ForeignSymbol | SymbolMaster | ExportOptions | ExportFormat | Rect | FlowConnection | RulerData | LayoutGrid | SimpleGrid | FreeformGroupLayout | InferredGroupLayout | OverrideProperty | Group | Oval | CurvePoint | Polygon | Rectangle | ShapePath | Star | Triangle | ShapeGroup | Text | AttributedString | StringAttribute | SymbolInstance | OverrideValue | Slice | Hotspot | Bitmap | ForeignTextStyle | ForeignSwatch | Swatch | SharedStyleContainer | SharedTextStyleContainer | SymbolContainer | SwatchContainer | FontRef | PatchInfo | Page | Artboard | PrototypeViewport;
 /**
@@ -1538,2 +1570,3 @@ * Enum of all possible _class property values
     MSImmutablePatchInfo = "MSImmutablePatchInfo",
+    MSImmutablePrototypeViewport = "MSImmutablePrototypeViewport",
     MSJSONFileReference = "MSJSONFileReference",
@@ -1646,2 +1679,3 @@ MSJSONOriginalDataReference = "MSJSONOriginalDataReference",
     MSJSONFileReference: FileRef;
+    MSImmutablePrototypeViewport: PrototypeViewport;
     MSImmutablePatchInfo: PatchInfo;
@@ -1648,0 +1682,0 @@ MSImmutableOverrideProperty: OverrideProperty;

dist/esm/types.js

@@ -341,2 +341,3 @@ /**
     ClassValue["MSImmutablePatchInfo"] = "MSImmutablePatchInfo";
+    ClassValue["MSImmutablePrototypeViewport"] = "MSImmutablePrototypeViewport";
     ClassValue["MSJSONFileReference"] = "MSJSONFileReference";
@@ -343,0 +344,0 @@ ClassValue["MSJSONOriginalDataReference"] = "MSJSONOriginalDataReference";

package.json

 {
   "name": "@sketch-hq/sketch-file-format-ts",
   "description": "TypeScript types for the Sketch File Format",
-  "version": "6.2.1",
+  "version": "6.3.0",
   "main": "dist/cjs/index",
@@ -23,3 +23,3 @@ "types": "dist/cjs/index",
   "devDependencies": {
-    "@sketch-hq/sketch-file-format": "6.2.1",
+    "@sketch-hq/sketch-file-format": "6.3.0",
     "@types/humps": "2.0.1",
@@ -26,0 +26,0 @@ "humps": "2.0.1"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

139287

increased by2.1%

Lines of code

4209

increased by1.79%

No dependency changes