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

Comparing version 2.0.0 to 3.0.0

CHANGELOG.md

@@ -5,2 +5,23 @@ # Changelog
 
+## [3.0.0](https://github.com/sketch-hq/sketch-file-format-ts/compare/v1.0.0...v3.0.0) (2019-11-15)
+
+
+### ⚠ BREAKING CHANGES
+
+* Code will have to use the new type name to avoid compilation errors
+
+### Features
+
+* add `AnyObject` type ([79be064](https://github.com/sketch-hq/sketch-file-format-ts/commit/79be06429f36228a0c3127f0f909b3fa08f8cff0))
+
+
+### Bug Fixes
+
+* upgrade to sketch-file-format@3.2.0 ([2b8eb4a](https://github.com/sketch-hq/sketch-file-format-ts/commit/2b8eb4ab3e883c5b9cafba9617ddeba579e95b24)), closes [#5](https://github.com/sketch-hq/sketch-file-format-ts/issues/5) [#4](https://github.com/sketch-hq/sketch-file-format-ts/issues/4) [#2](https://github.com/sketch-hq/sketch-file-format-ts/issues/2)
+
+
+### improvement
+
+* rename FileFormat type to Contents ([1ea31fc](https://github.com/sketch-hq/sketch-file-format-ts/commit/1ea31fccc9da92758af357b49c0b47bbd4a555fc))
+
 ## [2.0.0](https://github.com/sketch-hq/sketch-file-format-ts/compare/v1.1.0...v2.0.0) (2019-11-11)
@@ -7,0 +28,0 @@

dist/v3-types.d.ts

@@ -14,3 +14,3 @@ /**
     gradientAssets: GradientAsset[];
-    images: ImageFileRef[];
+    images: (ImageFileRef | ImageDataRef)[];
     colors: Color[];
@@ -98,2 +98,16 @@ gradients: Gradient[];
 /**
+ * Defines a reference to an image data within the document bundle
+ */
+export declare type ImageDataRef = {
+    _class: 'MSJSONOriginalDataReference';
+    _ref_class: 'MSImageData';
+    _ref: string;
+    data: {
+        _data: string;
+    };
+    sha1: {
+        _data: string;
+    };
+};
+/**
  * Enumeration of the color profiles Sketch can use to render a document
@@ -268,2 +282,3 @@ */
     gradient: Gradient;
+    image?: ImageFileRef | ImageDataRef;
 };
@@ -332,2 +347,3 @@ /**
     paragraphSpacing: number;
+    allowsDefaultTighteningForTruncation: number;
 };
@@ -389,3 +405,3 @@ /**
 export declare type InnerShadow = {
-    _class: 'shadow';
+    _class: 'innerShadow';
     isEnabled: boolean;
@@ -442,2 +458,3 @@ blurRadius: number;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -623,2 +640,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -666,2 +684,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -698,2 +717,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -763,2 +783,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -797,2 +818,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -833,2 +855,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -866,2 +889,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -901,2 +925,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -935,2 +960,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -947,3 +973,2 @@ hasClippingMask?: boolean;
     windingRule: WindingRule;
-    sharedStyleID?: Uuid;
 };
@@ -970,2 +995,3 @@ /**
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -1047,2 +1073,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -1090,2 +1117,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -1121,2 +1149,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -1150,2 +1179,3 @@ hasClippingMask?: boolean;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -1159,3 +1189,3 @@ hasClippingMask?: boolean;
     fillReplacesImage: boolean;
-    image: ImageFileRef;
+    image: ImageFileRef | ImageDataRef;
     intendedDPI: number;
@@ -1259,2 +1289,3 @@ clippingMask: PointListString;
     rotation: number;
+    sharedStyleID?: Uuid;
     shouldBreakMaskChain: boolean;
@@ -1390,2 +1421,2 @@ hasClippingMask?: boolean;
  */
-export declare type AnyObject = AssetCollection | ImageCollection | ColorAsset | Color | GradientAsset | Gradient | GradientStop | ImageFileRef | ForeignLayerStyle | SharedStyle | Style | Border | GraphicsContextSettings | BorderOptions | Blur | Fill | TextStyle | ParagraphStyle | FontDescriptor | Shadow | InnerShadow | ColorControls | ForeignSymbol | SymbolMaster | ExportOptions | ExportFormat | Rect | FlowConnection | FreeformGroupLayout | InferredGroupLayout | Artboard | Group | Oval | CurvePoint | Polygon | Rectangle | ShapePath | Star | Triangle | ShapeGroup | Text | AttributedString | StringAttribute | SymbolInstance | OverrideValue | Slice | Hotspot | Bitmap | RulerData | LayoutGrid | SimpleGrid | ForeignTextStyle | SharedStyleContainer | SharedTextStyleContainer | SymbolContainer | PageFileRef | Page;
+export declare type AnyObject = AssetCollection | ImageCollection | ColorAsset | Color | GradientAsset | Gradient | GradientStop | ImageFileRef | ImageDataRef | ForeignLayerStyle | SharedStyle | Style | Border | GraphicsContextSettings | BorderOptions | Blur | Fill | TextStyle | ParagraphStyle | FontDescriptor | Shadow | InnerShadow | ColorControls | ForeignSymbol | SymbolMaster | ExportOptions | ExportFormat | Rect | FlowConnection | FreeformGroupLayout | InferredGroupLayout | Artboard | Group | Oval | CurvePoint | Polygon | Rectangle | ShapePath | Star | Triangle | ShapeGroup | Text | AttributedString | StringAttribute | SymbolInstance | OverrideValue | Slice | Hotspot | Bitmap | RulerData | LayoutGrid | SimpleGrid | ForeignTextStyle | SharedStyleContainer | SharedTextStyleContainer | SymbolContainer | PageFileRef | Page;

package.json

 {
   "name": "@sketch-hq/sketch-file-format-ts",
   "description": "TypeScript types for the Sketch File Format",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "main": "dist/index",
@@ -25,3 +25,3 @@ "types": "dist/index",
     "@sketch-hq/sketch-file-format-2": "npm:@sketch-hq/sketch-file-format@2.*.*",
-    "@sketch-hq/sketch-file-format-3": "npm:@sketch-hq/sketch-file-format@3.*.*",
+    "@sketch-hq/sketch-file-format-3": "npm:@sketch-hq/sketch-file-format@3.2.0",
     "@types/humps": "1.1.2",
@@ -28,0 +28,0 @@ "@types/jest": "24.0.22",

No alert changes

Improved metrics

Total package byte prevSize

156894

increased by1.1%

Lines of code

4995

increased by0.62%

No dependency changes