@figma/plugin-typings - npm Package Compare versions

Comparing version 1.53.0 to 1.54.0

package.json

 {
   "name": "@figma/plugin-typings",
-  "version": "1.53.0",
+  "version": "1.54.0",
   "description": "Typings for the Figma Plugin API",
@@ -5,0 +5,0 @@ "main": "",

plugin-api.d.ts

@@ -54,2 +54,3 @@ type ArgFreeEventType =
   on(type: 'drop', callback: (event: DropEvent) => boolean): void
+  on(type: 'documentchange', callback: (event: DocumentChangeEvent) => void): void
 
@@ -59,2 +60,3 @@ once(type: ArgFreeEventType, callback: () => void): void
   once(type: 'drop', callback: (event: DropEvent) => boolean): void
+  once(type: 'documentchange', callback: (event: DocumentChangeEvent) => void): void
 
@@ -64,2 +66,3 @@ off(type: ArgFreeEventType, callback: () => void): void
   off(type: 'drop', callback: (event: DropEvent) => boolean): void
+  off(type: 'documentchange', callback: (event: DocumentChangeEvent) => void): void
 
@@ -312,2 +315,191 @@ readonly mixed: unique symbol
 
+interface DocumentChangeEvent {
+  documentChanges: DocumentChange[]
+}
+
+interface BaseDocumentChange {
+  id: string
+  origin: 'LOCAL' | 'REMOTE'
+}
+
+interface BaseNodeChange extends BaseDocumentChange {
+  node: SceneNode | RemovedNode
+}
+
+interface RemovedNode {
+  readonly removed: true
+  readonly type: NodeType
+  readonly id: string
+}
+
+interface CreateChange extends BaseNodeChange {
+  type: 'CREATE'
+}
+
+interface DeleteChange extends BaseNodeChange {
+  type: 'DELETE'
+}
+
+interface PropertyChange extends BaseNodeChange {
+  type: 'PROPERTY_CHANGE'
+  properties: NodeChangeProperty[]
+}
+
+interface BaseStyleChange extends BaseDocumentChange {
+  style: PaintStyle | TextStyle | GridStyle | EffectStyle | null
+}
+
+interface StyleCreateChange extends BaseStyleChange {
+  type: 'STYLE_CREATE'
+}
+
+interface StyleDeleteChange extends BaseStyleChange {
+  type: 'STYLE_DELETE'
+  style: null
+}
+
+interface StylePropertyChange extends BaseStyleChange {
+  type: 'STYLE_PROPERTY_CHANGE'
+  properties: StyleChangeProperty[]
+}
+
+type DocumentChange =
+  | CreateChange
+  | DeleteChange
+  | PropertyChange
+  | StyleCreateChange
+  | StyleDeleteChange
+  | StylePropertyChange
+
+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'
+  | 'clipsContents'
+  | 'type'
+  | 'overlayPositionType'
+  | 'overlayInteraction'
+  | 'overlayBackground'
+  | 'prototypeStartNode'
+  | 'prototypeBackground'
+  | 'expanded'
+  | 'fillStyleId'
+  | 'strokeStyleId'
+  | 'backgroundStyleId'
+  | 'textStyleId'
+  | 'effectStyleId'
+  | 'gridStyleId'
+  | 'description'
+  | 'layoutMode'
+  | 'paddingLeft'
+  | 'paddingTop'
+  | 'paddingRight'
+  | 'paddingBottom'
+  | 'itemSpacing'
+  | 'layoutAlign'
+  | 'counterAxisSizingMode'
+  | 'primaryAxisSizingMode'
+  | 'primaryAlignItems'
+  | 'counterAxisAlignItems'
+  | 'layoutGrow'
+  | 'layoutPositioning'
+  | 'itemReverseZIndex'
+  | 'hyperlink'
+  | 'mediaData'
+  | 'stokeTopWeight'
+  | 'strokeBottomWeight'
+  | 'strokeLeftWeight'
+  | 'strokeRightWeight'
+  | 'prototypeInteractions'
+  | 'flowStartingPoints'
+  | 'shapeType'
+  | 'connectorStart'
+  | 'connectorEnd'
+  | 'connectorLineType'
+  | 'connectorStartStrokeCap'
+  | 'connectorEndStrokeCap'
+  | 'codeLanguage'
+  | 'widgetSyncedState'
+  | 'componentPropertyDefinitions'
+  | 'componentPropertyReferences'
+  | 'componentProperties'
+  | 'embedData'
+  | 'linkUnfurlData'
+  | 'text'
+  | 'authorVisible'
+  | 'authorName'
+  | 'code'
+  | 'textBackground'
+
+type StyleChangeProperty =
+  | 'name'
+  | 'pluginData'
+  | 'type'
+  | 'description'
+  | 'remote'
+  | 'documentationLinks'
+  | 'fontSize'
+  | 'textDecoration'
+  | 'letterSpacing'
+  | 'lineHeight'
+  | 'paragraphIndent'
+  | 'paragraphSpacing'
+  | 'textCase'
+  | 'paint'
+  | 'effects'
+  | 'layoutGrids'
+
 ////////////////////////////////////////////////////////////////////////////////
@@ -988,3 +1180,3 @@ // Datatypes
     propertyName: string,
-    type: ComponentPropertyType,
+    type: Exclude<ComponentPropertyType, 'VARIANT'>,
     defaultValue: string | boolean,
@@ -1235,2 +1427,4 @@ options?: ComponentPropertyOptions,
   isExposedInstance: boolean
+  readonly overrides: { id: string; overriddenFields: NodeChangeProperty[] }[]
+  resetOverrides(): void
 }
@@ -1237,0 +1431,0 @@

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

52200

increased by8.38%

Lines of code

1488

increased by13.76%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes