figma-json-plugin - npm Package Compare versions

Comparing version 0.0.5-alpha.4 to 0.0.5-alpha.5

dist/figma-json.d.ts

@@ -8,2 +8,3 @@ export declare type Base64String = string;
 }
+export declare type NodeChangeProperty = "pointCount" | "name" | "width" | "height" | "parent" | "pluginData" | "constraints" | "locked" | "visible" | "opacity" | "blendMode" | "layoutGrids" | "guides" | "characters" | "styledTextSegments" | "vectorNetwork" | "effects" | "exportSettings" | "arcData" | "autoRename" | "fontName" | "innerRadius" | "fontSize" | "lineHeight" | "paragraphIndent" | "paragraphSpacing" | "letterSpacing" | "textAlignHorizontal" | "textAlignVertical" | "textCase" | "textDecoration" | "textAutoResize" | "fills" | "topLeftRadius" | "topRightRadius" | "bottomLeftRadius" | "bottomRightRadius" | "constrainProportions" | "strokes" | "strokeWeight" | "strokeAlign" | "strokeCap" | "strokeJoin" | "strokeMiterLimit" | "booleanOperation" | "overflowDirection" | "dashPattern" | "backgrounds" | "handleMirroring" | "cornerRadius" | "cornerSmoothing" | "relativeTransform" | "x" | "y" | "rotation" | "isMask" | "clipsContent" | "type" | "overlayPositionType" | "overlayBackgroundInteraction" | "overlayBackground" | "prototypeStartNode" | "prototypeBackgrounds" | "expanded" | "fillStyleId" | "strokeStyleId" | "backgroundStyleId" | "textStyleId" | "effectStyleId" | "gridStyleId" | "description" | "layoutMode" | "paddingLeft" | "paddingTop" | "paddingRight" | "paddingBottom" | "itemSpacing" | "layoutAlign" | "counterAxisSizingMode" | "primaryAxisSizingMode" | "primaryAxisAlignItems" | "counterAxisAlignItems" | "layoutGrow" | "layoutPositioning" | "itemReverseZIndex" | "hyperlink" | "mediaData" | "stokeTopWeight" | "strokeBottomWeight" | "strokeLeftWeight" | "strokeRightWeight" | "reactions" | "flowStartingPoints" | "shapeType" | "connectorStart" | "connectorEnd" | "connectorLineType" | "connectorStartStrokeCap" | "connectorEndStrokeCap" | "codeLanguage" | "widgetSyncedState" | "componentPropertyDefinitions" | "componentPropertyReferences" | "componentProperties" | "embedData" | "linkUnfurlData" | "text" | "authorVisible" | "authorName" | "code" | "textBackground";
 export declare const MixedValue = "__Symbol(figma.mixed)__";
@@ -115,3 +116,15 @@ export declare type Mixed = typeof MixedValue;
 }
-export declare type Paint = SolidPaint | GradientPaint | ImagePaint;
+export interface VideoPaint {
+    readonly type: "VIDEO";
+    readonly scaleMode: "FILL" | "FIT" | "CROP" | "TILE";
+    readonly videoHash: string | null;
+    readonly videoTransform?: Transform;
+    readonly scalingFactor?: number;
+    readonly rotation?: number;
+    readonly filters?: ImageFilters;
+    readonly visible?: boolean;
+    readonly opacity?: number;
+    readonly blendMode?: BlendMode;
+}
+export declare type Paint = SolidPaint | GradientPaint | ImagePaint | VideoPaint;
 export interface Guide {
@@ -213,3 +226,3 @@ readonly axis: "X" | "Y";
 };
-export declare type BlendMode = "NORMAL" | "DARKEN" | "MULTIPLY" | "LINEAR_BURN" | "COLOR_BURN" | "LIGHTEN" | "SCREEN" | "LINEAR_DODGE" | "COLOR_DODGE" | "OVERLAY" | "SOFT_LIGHT" | "HARD_LIGHT" | "DIFFERENCE" | "EXCLUSION" | "HUE" | "SATURATION" | "COLOR" | "LUMINOSITY";
+export declare type BlendMode = "PASS_THROUGH" | "NORMAL" | "DARKEN" | "MULTIPLY" | "LINEAR_BURN" | "COLOR_BURN" | "LIGHTEN" | "SCREEN" | "LINEAR_DODGE" | "COLOR_DODGE" | "OVERLAY" | "SOFT_LIGHT" | "HARD_LIGHT" | "DIFFERENCE" | "EXCLUSION" | "HUE" | "SATURATION" | "COLOR" | "LUMINOSITY";
 export interface Font {
@@ -224,2 +237,3 @@ fontName: FontName;
     fontName: FontName;
+    fontWeight: number;
     textDecoration: TextDecoration;
@@ -246,2 +260,5 @@ textCase: TextCase;
 } | {
+    readonly type: "UPDATE_MEDIA_RUNTIME";
+    readonly mediaAction: "PLAY" | "PAUSE" | "TOGGLE_PLAY_PAUSE";
+} | {
     readonly type: "NODE";
@@ -253,2 +270,3 @@ readonly destinationId: string | null;
     readonly overlayRelativePosition?: Vector;
+    readonly resetVideoPosition?: boolean;
 };
@@ -339,2 +357,5 @@ export interface SimpleTransition {
     locked: boolean;
+    componentPropertyReferences: {
+        [nodeProperty in "visible" | "characters" | "mainComponent"]: string;
+    } | null;
 }
@@ -360,6 +381,5 @@ export interface StickableMixin {
     layoutGrow: number;
+    layoutPositioning: "AUTO" | "ABSOLUTE";
 }
-export interface BlendMixin {
-    opacity: number;
-    blendMode: "PASS_THROUGH" | BlendMode;
+export interface BlendMixin extends MinimalBlendMixin {
     isMask: boolean;
@@ -380,3 +400,3 @@ effects: ReadonlyArray<Effect>;
     strokeStyleId: string;
-    strokeWeight: number;
+    strokeWeight: number | Mixed;
     strokeJoin: StrokeJoin | Mixed;
@@ -387,6 +407,11 @@ strokeAlign: "CENTER" | "INSIDE" | "OUTSIDE";
 }
+export interface IndividualStrokesMixin {
+    strokeTopWeight: number;
+    strokeBottomWeight: number;
+    strokeLeftWeight: number;
+    strokeRightWeight: number;
+}
 export interface MinimalFillsMixin {
     fills: ReadonlyArray<Paint> | Mixed;
     fillStyleId: string | Mixed;
-    fillGeometry: VectorPaths;
 }
@@ -396,2 +421,3 @@ export interface GeometryMixin extends MinimalStrokesMixin, MinimalFillsMixin {
     strokeMiterLimit: number;
+    fillGeometry: VectorPaths;
 }
@@ -437,3 +463,3 @@ export interface CornerMixin {
 }
-export interface BaseFrameMixin extends BaseNodeMixin, SceneNodeMixin, ChildrenMixin, ContainerMixin, GeometryMixin, CornerMixin, RectangleCornerMixin, BlendMixin, ConstraintMixin, LayoutMixin, ExportMixin {
+export interface BaseFrameMixin extends BaseNodeMixin, SceneNodeMixin, ChildrenMixin, ContainerMixin, GeometryMixin, CornerMixin, RectangleCornerMixin, BlendMixin, ConstraintMixin, LayoutMixin, ExportMixin, IndividualStrokesMixin {
     layoutMode: "NONE" | "HORIZONTAL" | "VERTICAL";
@@ -443,3 +469,3 @@ primaryAxisSizingMode: "FIXED" | "AUTO";
     primaryAxisAlignItems: "MIN" | "MAX" | "CENTER" | "SPACE_BETWEEN";
-    counterAxisAlignItems: "MIN" | "MAX" | "CENTER";
+    counterAxisAlignItems: "MIN" | "MAX" | "CENTER" | "BASELINE";
     paddingLeft: number;
@@ -450,2 +476,4 @@ paddingRight: number;
     itemSpacing: number;
+    itemReverseZIndex: boolean;
+    strokesIncludedInLayout: boolean;
     horizontalPadding: number;
@@ -461,3 +489,2 @@ verticalPadding: number;
 export interface OpaqueNodeMixin extends BaseNodeMixin, SceneNodeMixin, ExportMixin {
-    readonly absoluteTransform: Transform;
     relativeTransform: Transform;
@@ -470,4 +497,4 @@ x: number;
 export interface MinimalBlendMixin {
-    readonly opacity?: number;
-    readonly blendMode?: BlendMode;
+    opacity: number;
+    blendMode: BlendMode;
 }
@@ -479,4 +506,5 @@ export interface VariantMixin {
 }
-export interface TextSublayerNode {
-    readonly hasMissingFont: boolean;
+interface ComponentPropertiesMixin {
+}
+export interface TextSublayerNode extends MinimalFillsMixin {
     paragraphIndent: number;
@@ -486,2 +514,3 @@ paragraphSpacing: number;
     fontName: FontName | Mixed;
+    readonly fontWeight: number | Mixed;
     textCase: TextCase | Mixed;
@@ -525,3 +554,3 @@ textDecoration: TextDecoration | Mixed;
 }
-export interface RectangleNode extends DefaultShapeMixin, ConstraintMixin, CornerMixin, RectangleCornerMixin {
+export interface RectangleNode extends DefaultShapeMixin, ConstraintMixin, CornerMixin, RectangleCornerMixin, IndividualStrokesMixin {
     readonly type: "RECTANGLE";
@@ -552,7 +581,23 @@ }
     textAlignVertical: "TOP" | "CENTER" | "BOTTOM";
-    textAutoResize: "NONE" | "WIDTH_AND_HEIGHT" | "HEIGHT";
+    textAutoResize: "NONE" | "WIDTH_AND_HEIGHT" | "HEIGHT" | "TRUNCATE";
     autoRename: boolean;
     textStyleId: string | Mixed;
 }
-export interface ComponentSetNode extends BaseFrameMixin, PublishableMixin {
+export declare type ComponentPropertyType = "BOOLEAN" | "TEXT" | "INSTANCE_SWAP" | "VARIANT";
+export declare type InstanceSwapPreferredValue = {
+    type: "COMPONENT" | "COMPONENT_SET";
+    key: string;
+};
+export declare type ComponentPropertyOptions = {
+    preferredValues?: InstanceSwapPreferredValue[];
+};
+export declare type ComponentPropertyDefinitions = {
+    [propertyName: string]: {
+        type: ComponentPropertyType;
+        defaultValue: string | boolean;
+        preferredValues?: InstanceSwapPreferredValue[];
+        variantOptions?: string[];
+    };
+};
+export interface ComponentSetNode extends BaseFrameMixin, PublishableMixin, ComponentPropertiesMixin {
     readonly type: "COMPONENT_SET";
@@ -566,9 +611,22 @@ readonly defaultVariant: ComponentNode;
 }
-export interface ComponentNode extends DefaultFrameMixin, PublishableMixin, VariantMixin {
+export interface ComponentNode extends DefaultFrameMixin, PublishableMixin, VariantMixin, ComponentPropertiesMixin {
     readonly type: "COMPONENT";
 }
+export interface ComponentProperties {
+    [propertyName: string]: {
+        type: ComponentPropertyType;
+        value: string | boolean;
+        preferredValues?: InstanceSwapPreferredValue[];
+    };
+}
 export interface InstanceNode extends DefaultFrameMixin, VariantMixin {
     readonly type: "INSTANCE";
     mainComponent: ComponentNode | null;
+    readonly componentProperties: ComponentProperties;
     scaleFactor: number;
+    isExposedInstance: boolean;
+    readonly overrides: {
+        id: string;
+        overriddenFields: NodeChangeProperty[];
+    }[];
 }
@@ -600,2 +658,3 @@ export interface BooleanOperationNode extends DefaultShapeMixin, ChildrenMixin, CornerMixin {
     readonly cornerRadius?: number;
+    rotation: number;
 }
@@ -605,3 +664,3 @@ export interface CodeBlockNode extends OpaqueNodeMixin, MinimalBlendMixin {
     code: string;
-    codeLanguage: "TYPESCRIPT" | "CPP" | "RUBY" | "CSS" | "JAVASCRIPT" | "HTML" | "JSON" | "GRAPHQL" | "PYTHON" | "GO" | "SQL" | "SWIFT" | "KOTLIN" | "RUST";
+    codeLanguage: "TYPESCRIPT" | "CPP" | "RUBY" | "CSS" | "JAVASCRIPT" | "HTML" | "JSON" | "GRAPHQL" | "PYTHON" | "GO" | "SQL" | "SWIFT" | "KOTLIN" | "RUST" | "BASH";
 }
@@ -621,2 +680,3 @@ export interface LayerSublayerNode {
     connectorEndStrokeCap: ConnectorStrokeCap;
+    rotation: number;
 }
@@ -626,3 +686,3 @@ export interface WidgetNode extends OpaqueNodeMixin, StickableMixin {
     readonly widgetId: string;
-    widgetSyncedState: {
+    readonly widgetSyncedState: {
         [key: string]: any;
@@ -666,2 +726,7 @@ };
 export declare type StyleType = "PAINT" | "TEXT" | "EFFECT" | "GRID";
+export declare type InheritedStyleField = "fillStyleId" | "strokeStyleId" | "backgroundStyleId" | "textStyleId" | "effectStyleId" | "gridStyleId" | "strokeStyleId";
+export interface StyleConsumers {
+    node: SceneNode;
+    fields: InheritedStyleField[];
+}
 export interface BaseStyle extends PublishableMixin, PluginDataMixin {
@@ -697,2 +762,8 @@ readonly id: string;
     readonly hash: string;
+    readonly width: number;
+    readonly height: number;
 }
+export interface Video {
+    readonly hash: string;
+}
+export {};

dist/index.js

@@ -120,11 +120,16 @@ "use strict";
   "parent",
-  "removed",
   "stuckNodes",
   "__proto__",
-  "id",
-  "remote",
+  "instances",
+  "exposedInstances",
+  "attachedConnectors",
+  "consumers",
+  "componentPropertyDefinitions",
   "hasMissingFont",
   "absoluteTransform",
   "absoluteRenderBounds",
-  "vectorNetwork"
+  "absoluteBoundingBox",
+  "vectorNetwork",
+  "playbackSettings",
+  "horizontalPadding"
 ]);
@@ -134,4 +139,3 @@ var writeBlacklist = /* @__PURE__ */ new Set([
   "componentPropertyReferences",
-  "variantProperties",
-  "vectorNetwork"
+  "variantProperties"
 ]);
@@ -138,0 +142,0 @@ function notUndefined(x) {

package.json

 {
   "name": "figma-json-plugin",
-  "version": "0.0.5-alpha.4",
+  "version": "0.0.5-alpha.5",
   "description": "Dump a hierarchy to JSON within a Figma document, or insert a dumped JSON hierarchy. Intended for use within Figma plugins.",
@@ -30,3 +30,3 @@ "main": "dist/index.js",
   "devDependencies": {
-    "@figma/plugin-typings": "^1.49.0",
+    "@figma/plugin-typings": "^1.58.0",
     "@types/base64-js": "^1.2.5",
@@ -33,0 +33,0 @@ "@types/jest": "^28.1.6",

No alert changes

Improved metrics

Total package byte prevSize

56757

9.21%

Lines of code

1657

5.41%

No dependency changes