@figma/plugin-typings - npm Package Compare versions

Comparing version 1.5.0 to 1.7.0

index.d.ts

@@ -1,702 +0,762 @@
-// Figma Plugin API version 1, update 5
+// Figma Plugin API version 1, update 7
 
-// Global variable with Figma's plugin API.
-declare const figma: PluginAPI
-declare const __html__: string
+declare global {
+  // Global variable with Figma's plugin API.
+  const figma: PluginAPI
+  const __html__: string
 
-interface PluginAPI {
-  readonly apiVersion: "1.0.0"
-  readonly command: string
-  readonly viewport: ViewportAPI
-  closePlugin(message?: string): void
+  interface PluginAPI {
+    readonly apiVersion: "1.0.0"
+    readonly command: string
+    readonly viewport: ViewportAPI
+    closePlugin(message?: string): void
 
-  notify(message: string, options?: NotificationOptions): NotificationHandler
+    notify(message: string, options?: NotificationOptions): NotificationHandler
 
-  showUI(html: string, options?: ShowUIOptions): void
-  readonly ui: UIAPI
+    showUI(html: string, options?: ShowUIOptions): void
+    readonly ui: UIAPI
 
-  readonly clientStorage: ClientStorageAPI
+    readonly clientStorage: ClientStorageAPI
 
-  getNodeById(id: string): BaseNode | null
-  getStyleById(id: string): BaseStyle | null
+    getNodeById(id: string): BaseNode | null
+    getStyleById(id: string): BaseStyle | null
 
-  readonly root: DocumentNode
-  currentPage: PageNode
+    readonly root: DocumentNode
+    currentPage: PageNode
 
-  on(type: "selectionchange" | "currentpagechange" | "close", callback: () => void)
-  once(type: "selectionchange" | "currentpagechange" | "close", callback: () => void)
-  off(type: "selectionchange" | "currentpagechange" | "close", callback: () => void)
+    on(type: "selectionchange" | "currentpagechange" | "close", callback: () => void): void
+    once(type: "selectionchange" | "currentpagechange" | "close", callback: () => void): void
+    off(type: "selectionchange" | "currentpagechange" | "close", callback: () => void): void
 
-  readonly mixed: symbol
+    readonly mixed: unique symbol
 
-  createRectangle(): RectangleNode
-  createLine(): LineNode
-  createEllipse(): EllipseNode
-  createPolygon(): PolygonNode
-  createStar(): StarNode
-  createVector(): VectorNode
-  createText(): TextNode
-  createFrame(): FrameNode
-  createComponent(): ComponentNode
-  createPage(): PageNode
-  createSlice(): SliceNode
-  /**
-   * [DEPRECATED]: This API often fails to create a valid boolean operation. Use figma.union, figma.subtract, figma.intersect and figma.exclude instead.
-   */
-  createBooleanOperation(): BooleanOperationNode
+    createRectangle(): RectangleNode
+    createLine(): LineNode
+    createEllipse(): EllipseNode
+    createPolygon(): PolygonNode
+    createStar(): StarNode
+    createVector(): VectorNode
+    createText(): TextNode
+    createFrame(): FrameNode
+    createComponent(): ComponentNode
+    createPage(): PageNode
+    createSlice(): SliceNode
+    /**
+     * [DEPRECATED]: This API often fails to create a valid boolean operation. Use figma.union, figma.subtract, figma.intersect and figma.exclude instead.
+     */
+    createBooleanOperation(): BooleanOperationNode
 
-  createPaintStyle(): PaintStyle
-  createTextStyle(): TextStyle
-  createEffectStyle(): EffectStyle
-  createGridStyle(): GridStyle
+    createPaintStyle(): PaintStyle
+    createTextStyle(): TextStyle
+    createEffectStyle(): EffectStyle
+    createGridStyle(): GridStyle
 
-  // The styles are returned in the same order as displayed in the UI. Only
-  // local styles are returned. Never styles from team library.
-  getLocalPaintStyles(): PaintStyle[]
-  getLocalTextStyles(): TextStyle[]
-  getLocalEffectStyles(): EffectStyle[]
-  getLocalGridStyles(): GridStyle[]
+    // The styles are returned in the same order as displayed in the UI. Only
+    // local styles are returned. Never styles from team library.
+    getLocalPaintStyles(): PaintStyle[]
+    getLocalTextStyles(): TextStyle[]
+    getLocalEffectStyles(): EffectStyle[]
+    getLocalGridStyles(): GridStyle[]
 
-  importComponentByKeyAsync(key: string): Promise<ComponentNode>
-  importStyleByKeyAsync(key: string): Promise<BaseStyle>
+    importComponentByKeyAsync(key: string): Promise<ComponentNode>
+    importStyleByKeyAsync(key: string): Promise<BaseStyle>
 
-  listAvailableFontsAsync(): Promise<Font[]>
-  loadFontAsync(fontName: FontName): Promise<void>
-  readonly hasMissingFont: boolean
+    listAvailableFontsAsync(): Promise<Font[]>
+    loadFontAsync(fontName: FontName): Promise<void>
+    readonly hasMissingFont: boolean
 
-  createNodeFromSvg(svg: string): FrameNode
+    createNodeFromSvg(svg: string): FrameNode
 
-  createImage(data: Uint8Array): Image
-  getImageByHash(hash: string): Image
+    createImage(data: Uint8Array): Image
+    getImageByHash(hash: string): Image
 
-  group(nodes: ReadonlyArray<BaseNode>, parent: BaseNode & ChildrenMixin, index?: number): FrameNode
-  flatten(nodes: ReadonlyArray<BaseNode>, parent?: BaseNode & ChildrenMixin, index?: number): VectorNode
+    group(nodes: ReadonlyArray<BaseNode>, parent: BaseNode & ChildrenMixin, index?: number): FrameNode
+    flatten(nodes: ReadonlyArray<BaseNode>, parent?: BaseNode & ChildrenMixin, index?: number): VectorNode
 
-  union(nodes: ReadonlyArray<BaseNode>, parent: BaseNode & ChildrenMixin, index?: number): BooleanOperationNode
-  subtract(nodes: ReadonlyArray<BaseNode>, parent: BaseNode & ChildrenMixin, index?: number): BooleanOperationNode
-  intersect(nodes: ReadonlyArray<BaseNode>, parent: BaseNode & ChildrenMixin, index?: number): BooleanOperationNode
-  exclude(nodes: ReadonlyArray<BaseNode>, parent: BaseNode & ChildrenMixin, index?: number): BooleanOperationNode
-}
+    union(nodes: ReadonlyArray<BaseNode>, parent: BaseNode & ChildrenMixin, index?: number): BooleanOperationNode
+    subtract(nodes: ReadonlyArray<BaseNode>, parent: BaseNode & ChildrenMixin, index?: number): BooleanOperationNode
+    intersect(nodes: ReadonlyArray<BaseNode>, parent: BaseNode & ChildrenMixin, index?: number): BooleanOperationNode
+    exclude(nodes: ReadonlyArray<BaseNode>, parent: BaseNode & ChildrenMixin, index?: number): BooleanOperationNode
+  }
 
-interface ClientStorageAPI {
-  getAsync(key: string): Promise<any | undefined>
-  setAsync(key: string, value: any): Promise<void>
-}
+  interface ClientStorageAPI {
+    getAsync(key: string): Promise<any | undefined>
+    setAsync(key: string, value: any): Promise<void>
+  }
 
-interface NotificationOptions {
-  timeout?: number,
-}
+  interface NotificationOptions {
+    timeout?: number,
+  }
 
-interface NotificationHandler {
-  cancel: () => void,
-}
+  interface NotificationHandler {
+    cancel: () => void,
+  }
 
-interface ShowUIOptions {
-  visible?: boolean,
-  width?: number,
-  height?: number,
-  position?: 'default' | 'last' | 'auto' // PROPOSED API ONLY
-}
+  interface ShowUIOptions {
+    visible?: boolean,
+    width?: number,
+    height?: number,
+  }
 
-interface UIPostMessageOptions {
-  origin?: string,
-}
+  interface UIPostMessageOptions {
+    origin?: string,
+  }
 
-interface OnMessageProperties {
-  origin: string,
-}
+  interface OnMessageProperties {
+    origin: string,
+  }
 
-type MessageEventHandler = (pluginMessage: any, props: OnMessageProperties) => void
+  type MessageEventHandler = (pluginMessage: any, props: OnMessageProperties) => void
 
-interface UIAPI {
-  show(): void
-  hide(): void
-  resize(width: number, height: number): void
-  close(): void
+  interface UIAPI {
+    show(): void
+    hide(): void
+    resize(width: number, height: number): void
+    close(): void
 
-  postMessage(pluginMessage: any, options?: UIPostMessageOptions): void
-  onmessage: MessageEventHandler | undefined
-  on(type: "message", callback: MessageEventHandler)
-  once(type: "message", callback: MessageEventHandler)
-  off(type: "message", callback: MessageEventHandler)
-}
+    postMessage(pluginMessage: any, options?: UIPostMessageOptions): void
+    onmessage: MessageEventHandler | undefined
+    on(type: "message", callback: MessageEventHandler): void
+    once(type: "message", callback: MessageEventHandler): void
+    off(type: "message", callback: MessageEventHandler): void
+  }
 
-interface ViewportAPI {
-  center: { x: number, y: number }
-  zoom: number
-  scrollAndZoomIntoView(nodes: ReadonlyArray<BaseNode>)
-}
+  interface ViewportAPI {
+    center: { x: number, y: number }
+    zoom: number
+    scrollAndZoomIntoView(nodes: ReadonlyArray<BaseNode>): void
+  }
 
-////////////////////////////////////////////////////////////////////////////////
-// Datatypes
+  ////////////////////////////////////////////////////////////////////////////////
+  // Datatypes
 
-type Transform = [
-  [number, number, number],
-  [number, number, number]
-]
+  type Transform = [
+    [number, number, number],
+    [number, number, number]
+  ]
 
-interface Vector {
-  readonly x: number
-  readonly y: number
-}
+  interface Vector {
+    readonly x: number
+    readonly y: number
+  }
 
-interface RGB {
-  readonly r: number
-  readonly g: number
-  readonly b: number
-}
+  interface RGB {
+    readonly r: number
+    readonly g: number
+    readonly b: number
+  }
 
-interface RGBA {
-  readonly r: number
-  readonly g: number
-  readonly b: number
-  readonly a: number
-}
+  interface RGBA {
+    readonly r: number
+    readonly g: number
+    readonly b: number
+    readonly a: number
+  }
 
-interface FontName {
-  readonly family: string
-  readonly style: string
-}
+  interface FontName {
+    readonly family: string
+    readonly style: string
+  }
 
-type TextCase = "ORIGINAL" | "UPPER" | "LOWER" | "TITLE"
+  type TextCase = "ORIGINAL" | "UPPER" | "LOWER" | "TITLE"
 
-type TextDecoration = "NONE" | "UNDERLINE" | "STRIKETHROUGH"
+  type TextDecoration = "NONE" | "UNDERLINE" | "STRIKETHROUGH"
 
-interface ArcData {
-  readonly startingAngle: number
-  readonly endingAngle: number
-  readonly innerRadius: number
-}
+  interface ArcData {
+    readonly startingAngle: number
+    readonly endingAngle: number
+    readonly innerRadius: number
+  }
 
-interface ShadowEffect {
-  readonly type: "DROP_SHADOW" | "INNER_SHADOW"
-  readonly color: RGBA
-  readonly offset: Vector
-  readonly radius: number
-  readonly visible: boolean
-  readonly blendMode: BlendMode
-}
+  interface ShadowEffect {
+    readonly type: "DROP_SHADOW" | "INNER_SHADOW"
+    readonly color: RGBA
+    readonly offset: Vector
+    readonly radius: number
+    readonly visible: boolean
+    readonly blendMode: BlendMode
+  }
 
-interface BlurEffect {
-  readonly type: "LAYER_BLUR" | "BACKGROUND_BLUR"
-  readonly radius: number
-  readonly visible: boolean
-}
+  interface BlurEffect {
+    readonly type: "LAYER_BLUR" | "BACKGROUND_BLUR"
+    readonly radius: number
+    readonly visible: boolean
+  }
 
-type Effect = ShadowEffect | BlurEffect
+  type Effect = ShadowEffect | BlurEffect
 
-type ConstraintType = "MIN" | "CENTER" | "MAX" | "STRETCH" | "SCALE"
+  type ConstraintType = "MIN" | "CENTER" | "MAX" | "STRETCH" | "SCALE"
 
-interface Constraints {
-  readonly horizontal: ConstraintType
-  readonly vertical: ConstraintType
-}
+  interface Constraints {
+    readonly horizontal: ConstraintType
+    readonly vertical: ConstraintType
+  }
 
-interface ColorStop {
-  readonly position: number
-  readonly color: RGBA
-}
+  interface ColorStop {
+    readonly position: number
+    readonly color: RGBA
+  }
 
-interface ImageFilters {
-  readonly exposure?: number
-  readonly contrast?: number
-  readonly saturation?: number
-  readonly temperature?: number
-  readonly tint?: number
-  readonly highlights?: number
-  readonly shadows?: number
-}
+  interface ImageFilters {
+    readonly exposure?: number
+    readonly contrast?: number
+    readonly saturation?: number
+    readonly temperature?: number
+    readonly tint?: number
+    readonly highlights?: number
+    readonly shadows?: number
+  }
 
-interface SolidPaint {
-  readonly type: "SOLID"
-  readonly color: RGB
+  interface SolidPaint {
+    readonly type: "SOLID"
+    readonly color: RGB
 
-  readonly visible?: boolean
-  readonly opacity?: number
-  readonly blendMode?: BlendMode
-}
+    readonly visible?: boolean
+    readonly opacity?: number
+    readonly blendMode?: BlendMode
+  }
 
-interface GradientPaint {
-  readonly type: "GRADIENT_LINEAR" | "GRADIENT_RADIAL" | "GRADIENT_ANGULAR" | "GRADIENT_DIAMOND"
-  readonly gradientTransform: Transform
-  readonly gradientStops: ReadonlyArray<ColorStop>
+  interface GradientPaint {
+    readonly type: "GRADIENT_LINEAR" | "GRADIENT_RADIAL" | "GRADIENT_ANGULAR" | "GRADIENT_DIAMOND"
+    readonly gradientTransform: Transform
+    readonly gradientStops: ReadonlyArray<ColorStop>
 
-  readonly visible?: boolean
-  readonly opacity?: number
-  readonly blendMode?: BlendMode
-}
+    readonly visible?: boolean
+    readonly opacity?: number
+    readonly blendMode?: BlendMode
+  }
 
-interface ImagePaint {
-  readonly type: "IMAGE"
-  readonly scaleMode: "FILL" | "FIT" | "CROP" | "TILE"
-  readonly imageHash: string | null
-  readonly imageTransform?: Transform // setting for "CROP"
-  readonly scalingFactor?: number // setting for "TILE"
-  readonly filters?: ImageFilters
+  interface ImagePaint {
+    readonly type: "IMAGE"
+    readonly scaleMode: "FILL" | "FIT" | "CROP" | "TILE"
+    readonly imageHash: string | null
+    readonly imageTransform?: Transform // setting for "CROP"
+    readonly scalingFactor?: number // setting for "TILE"
+    readonly filters?: ImageFilters
 
-  readonly visible?: boolean
-  readonly opacity?: number
-  readonly blendMode?: BlendMode
-}
+    readonly visible?: boolean
+    readonly opacity?: number
+    readonly blendMode?: BlendMode
+  }
 
-type Paint = SolidPaint | GradientPaint | ImagePaint
+  type Paint = SolidPaint | GradientPaint | ImagePaint
 
-interface Guide {
-  readonly axis: "X" | "Y"
-  readonly offset: number
-}
+  interface Guide {
+    readonly axis: "X" | "Y"
+    readonly offset: number
+  }
 
-interface RowsColsLayoutGrid {
-  readonly pattern: "ROWS" | "COLUMNS"
-  readonly alignment: "MIN" | "MAX" | "STRETCH" | "CENTER"
-  readonly gutterSize: number
+  interface RowsColsLayoutGrid {
+    readonly pattern: "ROWS" | "COLUMNS"
+    readonly alignment: "MIN" | "MAX" | "STRETCH" | "CENTER"
+    readonly gutterSize: number
 
-  readonly count: number        // Infinity when "Auto" is set in the UI
-  readonly sectionSize?: number // Not set for alignment: "STRETCH"
-  readonly offset?: number      // Not set for alignment: "CENTER"
+    readonly count: number        // Infinity when "Auto" is set in the UI
+    readonly sectionSize?: number // Not set for alignment: "STRETCH"
+    readonly offset?: number      // Not set for alignment: "CENTER"
 
-  readonly visible?: boolean
-  readonly color?: RGBA
-}
+    readonly visible?: boolean
+    readonly color?: RGBA
+  }
 
-interface GridLayoutGrid {
-  readonly pattern: "GRID"
-  readonly sectionSize: number
+  interface GridLayoutGrid {
+    readonly pattern: "GRID"
+    readonly sectionSize: number
 
-  readonly visible?: boolean
-  readonly color?: RGBA
-}
+    readonly visible?: boolean
+    readonly color?: RGBA
+  }
 
-type LayoutGrid = RowsColsLayoutGrid | GridLayoutGrid
+  type LayoutGrid = RowsColsLayoutGrid | GridLayoutGrid
 
-interface ExportSettingsConstraints {
-  type: "SCALE" | "WIDTH" | "HEIGHT"
-  value: number
-}
+  interface ExportSettingsConstraints {
+    readonly type: "SCALE" | "WIDTH" | "HEIGHT"
+    readonly value: number
+  }
 
-interface ExportSettingsImage {
-  format: "JPG" | "PNG"
-  contentsOnly?: boolean    // defaults to true
-  suffix?: string
-  constraint?: ExportSettingsConstraints
-}
+  interface ExportSettingsImage {
+    readonly format: "JPG" | "PNG"
+    readonly contentsOnly?: boolean    // defaults to true
+    readonly suffix?: string
+    readonly constraint?: ExportSettingsConstraints
+  }
 
-interface ExportSettingsSVG {
-  format: "SVG"
-  contentsOnly?: boolean    // defaults to true
-  suffix?: string
-  svgOutlineText?: boolean  // defaults to true
-  svgIdAttribute?: boolean  // defaults to false
-  svgSimplifyStroke?: boolean // defaults to true
-}
+  interface ExportSettingsSVG {
+    readonly format: "SVG"
+    readonly contentsOnly?: boolean    // defaults to true
+    readonly suffix?: string
+    readonly svgOutlineText?: boolean  // defaults to true
+    readonly svgIdAttribute?: boolean  // defaults to false
+    readonly svgSimplifyStroke?: boolean // defaults to true
+  }
 
-interface ExportSettingsPDF {
-  format: "PDF"
-  contentsOnly?: boolean    // defaults to true
-  suffix?: string
-}
+  interface ExportSettingsPDF {
+    readonly format: "PDF"
+    readonly contentsOnly?: boolean    // defaults to true
+    readonly suffix?: string
+  }
 
-type ExportSettings = ExportSettingsImage | ExportSettingsSVG | ExportSettingsPDF
+  type ExportSettings = ExportSettingsImage | ExportSettingsSVG | ExportSettingsPDF
 
-type WindingRule = "NONZERO" | "EVENODD"
+  type WindingRule = "NONZERO" | "EVENODD"
 
-interface VectorVertex {
-  readonly x: number
-  readonly y: number
-  readonly strokeCap?: StrokeCap
-  readonly strokeJoin?: StrokeJoin
-  readonly cornerRadius?: number
-  readonly handleMirroring?: HandleMirroring
-}
+  interface VectorVertex {
+    readonly x: number
+    readonly y: number
+    readonly strokeCap?: StrokeCap
+    readonly strokeJoin?: StrokeJoin
+    readonly cornerRadius?: number
+    readonly handleMirroring?: HandleMirroring
+  }
 
-interface VectorSegment {
-  readonly start: number
-  readonly end: number
-  readonly tangentStart?: Vector  // Defaults to { x: 0, y: 0 }
-  readonly tangentEnd?: Vector  // Defaults to { x: 0, y: 0 }
-}
+  interface VectorSegment {
+    readonly start: number
+    readonly end: number
+    readonly tangentStart?: Vector  // Defaults to { x: 0, y: 0 }
+    readonly tangentEnd?: Vector  // Defaults to { x: 0, y: 0 }
+  }
 
-interface VectorRegion {
-  readonly windingRule: WindingRule
-  readonly loops: ReadonlyArray<ReadonlyArray<number>>
-}
+  interface VectorRegion {
+    readonly windingRule: WindingRule
+    readonly loops: ReadonlyArray<ReadonlyArray<number>>
+  }
 
-interface VectorNetwork {
-  readonly vertices: ReadonlyArray<VectorVertex>
-  readonly segments: ReadonlyArray<VectorSegment>
-  readonly regions?: ReadonlyArray<VectorRegion> // Defaults to []
-}
+  interface VectorNetwork {
+    readonly vertices: ReadonlyArray<VectorVertex>
+    readonly segments: ReadonlyArray<VectorSegment>
+    readonly regions?: ReadonlyArray<VectorRegion> // Defaults to []
+  }
 
-interface VectorPath {
-  readonly windingRule: WindingRule | "NONE"
-  readonly data: string
-}
+  interface VectorPath {
+    readonly windingRule: WindingRule | "NONE"
+    readonly data: string
+  }
 
-type VectorPaths = ReadonlyArray<VectorPath>
+  type VectorPaths = ReadonlyArray<VectorPath>
 
-interface LetterSpacing {
-  readonly value: number
-  readonly unit: "PIXELS" | "PERCENT"
-}
+  interface LetterSpacing {
+    readonly value: number
+    readonly unit: "PIXELS" | "PERCENT"
+  }
 
-type LineHeight = {
-  readonly value: number
-  readonly unit: "PIXELS" | "PERCENT"
-} | {
-  readonly unit: "AUTO"
-}
+  type LineHeight = {
+    readonly value: number
+    readonly unit: "PIXELS" | "PERCENT"
+  } | {
+    readonly unit: "AUTO"
+  }
 
-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"
+  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"
 
-interface Font {
-  fontName: FontName
-}
+  interface Font {
+    fontName: FontName
+  }
 
-////////////////////////////////////////////////////////////////////////////////
-// Mixins
+  type Reaction = { action: Action, trigger: Trigger }
 
-interface BaseNodeMixin {
-  readonly id: string
-  readonly parent: (BaseNode & ChildrenMixin) | null
-  name: string // Note: setting this also sets \`autoRename\` to false on TextNodes
-  readonly removed: boolean
-  toString(): string
-  remove(): void
+  type Action =
+    { readonly type: "BACK" | "CLOSE" } |
+    { readonly type: "URL", url: string } |
+    { readonly type: "NODE",
+      readonly destinationId: string | null,
+      readonly navigation: Navigation,
+      readonly transition: Transition | null,
+      readonly preserveScrollPosition: boolean,
 
-  getPluginData(key: string): string
-  setPluginData(key: string, value: string): void
+      // Only present if navigation == "OVERLAY" and the destination uses
+      // overlay position type "RELATIVE"
+      readonly overlayRelativePosition?: Vector,
+    }
 
-  // Namespace is a string that must be at least 3 alphanumeric characters, and should
-  // be a name related to your plugin. Other plugins will be able to read this data.
-  getSharedPluginData(namespace: string, key: string): string
-  setSharedPluginData(namespace: string, key: string, value: string): void
-}
+  interface SimpleTransition {
+    readonly type: "DISSOLVE" | "SMART_ANIMATE"
+    readonly easing: Easing
+    readonly duration: number
+  }
 
-interface SceneNodeMixin {
-  visible: boolean
-  locked: boolean
-}
+  interface DirectionalTransition {
+    readonly type: "MOVE_IN" | "MOVE_OUT" | "PUSH" | "SLIDE_IN" | "SLIDE_OUT"
+    readonly direction: "LEFT" | "RIGHT" | "TOP" | "BOTTOM"
+    readonly matchLayers: boolean
 
-interface ChildrenMixin {
-  readonly children: ReadonlyArray<SceneNode>
+    readonly easing: Easing
+    readonly duration: number
+  }
 
-  appendChild(child: SceneNode): void
-  insertChild(index: number, child: SceneNode): void
+  export type Transition = SimpleTransition | DirectionalTransition
 
-  findAll(callback?: (node: SceneNode) => boolean): SceneNode[]
-  findOne(callback: (node: SceneNode) => boolean): SceneNode | null
-}
+  type Trigger =
+    { readonly type: "ON_CLICK" | "ON_HOVER" | "ON_PRESS" | "ON_DRAG" } |
+    { readonly type: "AFTER_TIMEOUT", readonly timeout: number } |
+    { readonly type: "MOUSE_ENTER" | "MOUSE_LEAVE" | "MOUSE_UP" | "MOUSE_DOWN",
+      readonly delay: number,
+    }
 
-interface ConstraintMixin {
-  constraints: Constraints
-}
+  type Navigation = "NAVIGATE" | "SWAP" | "OVERLAY"
 
-interface LayoutMixin {
-  readonly absoluteTransform: Transform
-  relativeTransform: Transform
-  x: number
-  y: number
-  rotation: number // In degrees
+  interface Easing {
+    readonly type: "EASE_IN" | "EASE_OUT" | "EASE_IN_AND_OUT" | "LINEAR"
+  }
 
-  readonly width: number
-  readonly height: number
+  type OverflowDirection = "NONE" | "HORIZONTAL" | "VERTICAL" | "BOTH"
 
-  resize(width: number, height: number): void
-  resizeWithoutConstraints(width: number, height: number): void
-}
+  ////////////////////////////////////////////////////////////////////////////////
+  // Mixins
 
-interface BlendMixin {
-  opacity: number
-  blendMode: BlendMode
-  isMask: boolean
-  effects: ReadonlyArray<Effect>
-  effectStyleId: string
-}
+  interface BaseNodeMixin {
+    readonly id: string
+    readonly parent: (BaseNode & ChildrenMixin) | null
+    name: string // Note: setting this also sets \`autoRename\` to false on TextNodes
+    readonly removed: boolean
+    toString(): string
+    remove(): void
 
-interface FrameMixin {
-  backgrounds: ReadonlyArray<Paint>
-  layoutGrids: ReadonlyArray<LayoutGrid>
-  clipsContent: boolean
-  guides: ReadonlyArray<Guide>
-  gridStyleId: string
-  backgroundStyleId: string
-}
+    getPluginData(key: string): string
+    setPluginData(key: string, value: string): void
 
-type StrokeCap = "NONE" | "ROUND" | "SQUARE" | "ARROW_LINES" | "ARROW_EQUILATERAL"
-type StrokeJoin = "MITER" | "BEVEL" | "ROUND"
-type HandleMirroring = "NONE" | "ANGLE" | "ANGLE_AND_LENGTH"
+    // Namespace is a string that must be at least 3 alphanumeric characters, and should
+    // be a name related to your plugin. Other plugins will be able to read this data.
+    getSharedPluginData(namespace: string, key: string): string
+    setSharedPluginData(namespace: string, key: string, value: string): void
+  }
 
-interface GeometryMixin {
-  fills: ReadonlyArray<Paint> | symbol
-  strokes: ReadonlyArray<Paint>
-  strokeWeight: number
-  strokeAlign: "CENTER" | "INSIDE" | "OUTSIDE"
-  strokeCap: StrokeCap | symbol
-  strokeJoin: StrokeJoin | symbol
-  dashPattern: ReadonlyArray<number>
-  fillStyleId: string | symbol
-  strokeStyleId: string
-}
+  interface SceneNodeMixin {
+    visible: boolean
+    locked: boolean
+  }
 
-interface CornerMixin {
-  cornerRadius: number | symbol
-  cornerSmoothing: number
-}
+  interface ChildrenMixin {
+    readonly children: ReadonlyArray<SceneNode>
 
-interface ExportMixin {
-  exportSettings: ReadonlyArray<ExportSettings>
-  exportAsync(settings?: ExportSettings): Promise<Uint8Array> // Defaults to PNG format
-}
+    appendChild(child: SceneNode): void
+    insertChild(index: number, child: SceneNode): void
 
-interface DefaultShapeMixin extends
-  BaseNodeMixin, SceneNodeMixin,
-  BlendMixin, GeometryMixin, LayoutMixin, ExportMixin {
-}
+    findAll(callback?: (node: SceneNode) => boolean): SceneNode[]
+    findOne(callback: (node: SceneNode) => boolean): SceneNode | null
+  }
 
-interface DefaultContainerMixin extends
-  BaseNodeMixin, SceneNodeMixin,
-  ChildrenMixin, FrameMixin,
-  BlendMixin, ConstraintMixin, LayoutMixin, ExportMixin {
-}
+  interface ConstraintMixin {
+    constraints: Constraints
+  }
 
-////////////////////////////////////////////////////////////////////////////////
-// Nodes
+  interface LayoutMixin {
+    readonly absoluteTransform: Transform
+    relativeTransform: Transform
+    x: number
+    y: number
+    rotation: number // In degrees
 
-interface DocumentNode extends BaseNodeMixin {
-  readonly type: "DOCUMENT"
+    readonly width: number
+    readonly height: number
 
-  readonly children: ReadonlyArray<PageNode>
+    resize(width: number, height: number): void
+    resizeWithoutConstraints(width: number, height: number): void
+  }
 
-  appendChild(child: PageNode): void
-  insertChild(index: number, child: PageNode): void
+  interface BlendMixin {
+    opacity: number
+    blendMode: BlendMode
+    isMask: boolean
+    effects: ReadonlyArray<Effect>
+    effectStyleId: string
+  }
 
-  findAll(callback?: (node: (PageNode | SceneNode)) => boolean): Array<PageNode | SceneNode>
-  findOne(callback: (node: (PageNode | SceneNode)) => boolean): PageNode | SceneNode | null
-}
+  interface FrameMixin {
+    backgrounds: ReadonlyArray<Paint>
+    layoutGrids: ReadonlyArray<LayoutGrid>
+    clipsContent: boolean
+    guides: ReadonlyArray<Guide>
+    gridStyleId: string
+    backgroundStyleId: string
 
-interface PageNode extends BaseNodeMixin, ChildrenMixin, ExportMixin {
-  readonly type: "PAGE"
-  clone(): PageNode
+    overflowDirection: OverflowDirection // PROPOSED API ONLY
+    numberOfFixedChildren: number // PROPOSED API ONLY
+  }
 
-  guides: ReadonlyArray<Guide>
-  selection: ReadonlyArray<SceneNode>
+  type StrokeCap = "NONE" | "ROUND" | "SQUARE" | "ARROW_LINES" | "ARROW_EQUILATERAL"
+  type StrokeJoin = "MITER" | "BEVEL" | "ROUND"
+  type HandleMirroring = "NONE" | "ANGLE" | "ANGLE_AND_LENGTH"
 
-  backgrounds: ReadonlyArray<Paint>
-}
+  interface GeometryMixin {
+    fills: ReadonlyArray<Paint> | PluginAPI['mixed']
+    strokes: ReadonlyArray<Paint>
+    strokeWeight: number
+    strokeAlign: "CENTER" | "INSIDE" | "OUTSIDE"
+    strokeCap: StrokeCap | PluginAPI['mixed']
+    strokeJoin: StrokeJoin | PluginAPI['mixed']
+    dashPattern: ReadonlyArray<number>
+    fillStyleId: string | PluginAPI['mixed']
+    strokeStyleId: string
+  }
 
-interface FrameNode extends DefaultContainerMixin {
-  readonly type: "FRAME" | "GROUP"
-  clone(): FrameNode
-}
+  interface CornerMixin {
+    cornerRadius: number | PluginAPI['mixed']
+    cornerSmoothing: number
+  }
 
-interface SliceNode extends BaseNodeMixin, SceneNodeMixin, LayoutMixin, ExportMixin {
-  readonly type: "SLICE"
-  clone(): SliceNode
-}
+  interface ExportMixin {
+    exportSettings: ReadonlyArray<ExportSettings>
+    exportAsync(settings?: ExportSettings): Promise<Uint8Array> // Defaults to PNG format
+  }
 
-interface RectangleNode extends DefaultShapeMixin, ConstraintMixin, CornerMixin {
-  readonly type: "RECTANGLE"
-  clone(): RectangleNode
-  topLeftRadius: number
-  topRightRadius: number
-  bottomLeftRadius: number
-  bottomRightRadius: number
-}
+  interface ReactionMixin {
+    readonly reactions: ReadonlyArray<Reaction> // PROPOSED API ONLY
+  }
 
-interface LineNode extends DefaultShapeMixin, ConstraintMixin {
-  readonly type: "LINE"
-  clone(): LineNode
-}
+  interface DefaultShapeMixin extends
+    BaseNodeMixin, SceneNodeMixin, ReactionMixin,
+    BlendMixin, GeometryMixin, LayoutMixin, ExportMixin {
+  }
 
-interface EllipseNode extends DefaultShapeMixin, ConstraintMixin, CornerMixin {
-  readonly type: "ELLIPSE"
-  clone(): EllipseNode
-  arcData: ArcData
-}
+  interface DefaultContainerMixin extends
+    BaseNodeMixin, SceneNodeMixin, ReactionMixin,
+    ChildrenMixin, FrameMixin,
+    BlendMixin, ConstraintMixin, LayoutMixin, ExportMixin {
+  }
 
-interface PolygonNode extends DefaultShapeMixin, ConstraintMixin, CornerMixin {
-  readonly type: "POLYGON"
-  clone(): PolygonNode
-  pointCount: number
-}
+  ////////////////////////////////////////////////////////////////////////////////
+  // Nodes
 
-interface StarNode extends DefaultShapeMixin, ConstraintMixin, CornerMixin {
-  readonly type: "STAR"
-  clone(): StarNode
-  pointCount: number
-  innerRadius: number
-}
+  interface DocumentNode extends BaseNodeMixin {
+    readonly type: "DOCUMENT"
 
-interface VectorNode extends DefaultShapeMixin, ConstraintMixin, CornerMixin {
-  readonly type: "VECTOR"
-  clone(): VectorNode
-  vectorNetwork: VectorNetwork
-  vectorPaths: VectorPaths
-  handleMirroring: HandleMirroring | symbol
-}
+    readonly children: ReadonlyArray<PageNode>
 
-interface TextNode extends DefaultShapeMixin, ConstraintMixin {
-  readonly type: "TEXT"
-  clone(): TextNode
-  characters: string
-  readonly hasMissingFont: boolean
-  textAlignHorizontal: "LEFT" | "CENTER" | "RIGHT" | "JUSTIFIED"
-  textAlignVertical: "TOP" | "CENTER" | "BOTTOM"
-  textAutoResize: "NONE" | "WIDTH_AND_HEIGHT" | "HEIGHT"
-  paragraphIndent: number
-  paragraphSpacing: number
-  autoRename: boolean
+    appendChild(child: PageNode): void
+    insertChild(index: number, child: PageNode): void
 
-  textStyleId: string | symbol
-  fontSize: number | symbol
-  fontName: FontName | symbol
-  textCase: TextCase | symbol
-  textDecoration: TextDecoration | symbol
-  letterSpacing: LetterSpacing | symbol
-  lineHeight: LineHeight | symbol
+    findAll(callback?: (node: (PageNode | SceneNode)) => boolean): Array<PageNode | SceneNode>
+    findOne(callback: (node: (PageNode | SceneNode)) => boolean): PageNode | SceneNode | null
+  }
 
-  getRangeFontSize(start: number, end: number): number | symbol
-  setRangeFontSize(start: number, end: number, value: number): void
-  getRangeFontName(start: number, end: number): FontName | symbol
-  setRangeFontName(start: number, end: number, value: FontName): void
-  getRangeTextCase(start: number, end: number): TextCase | symbol
-  setRangeTextCase(start: number, end: number, value: TextCase): void
-  getRangeTextDecoration(start: number, end: number): TextDecoration | symbol
-  setRangeTextDecoration(start: number, end: number, value: TextDecoration): void
-  getRangeLetterSpacing(start: number, end: number): LetterSpacing | symbol
-  setRangeLetterSpacing(start: number, end: number, value: LetterSpacing): void
-  getRangeLineHeight(start: number, end: number): LineHeight | symbol
-  setRangeLineHeight(start: number, end: number, value: LineHeight): void
-  getRangeFills(start: number, end: number): Paint[] | symbol
-  setRangeFills(start: number, end: number, value: Paint[]): void
-  getRangeTextStyleId(start: number, end: number): string | symbol
-  setRangeTextStyleId(start: number, end: number, value: string): void
-  getRangeFillStyleId(start: number, end: number): string | symbol
-  setRangeFillStyleId(start: number, end: number, value: string): void
-}
+  interface PageNode extends BaseNodeMixin, ChildrenMixin, ExportMixin {
+    readonly type: "PAGE"
+    clone(): PageNode
 
-interface ComponentNode extends DefaultContainerMixin {
-  readonly type: "COMPONENT"
-  clone(): ComponentNode
+    guides: ReadonlyArray<Guide>
+    selection: ReadonlyArray<SceneNode>
 
-  createInstance(): InstanceNode
-  description: string
-  readonly remote: boolean
-  readonly key: string // The key to use with "importComponentByKeyAsync"
-}
+    backgrounds: ReadonlyArray<Paint>
 
-interface InstanceNode extends DefaultContainerMixin  {
-  readonly type: "INSTANCE"
-  clone(): InstanceNode
-  masterComponent: ComponentNode
-}
+    readonly prototypeStartNode: FrameNode | ComponentNode | InstanceNode | null // PROPOSED API ONLY
+  }
 
-interface BooleanOperationNode extends DefaultShapeMixin, ChildrenMixin, CornerMixin {
-  readonly type: "BOOLEAN_OPERATION"
-  clone(): BooleanOperationNode
-  booleanOperation: "UNION" | "INTERSECT" | "SUBTRACT" | "EXCLUDE"
-}
+  interface FrameNode extends DefaultContainerMixin {
+    readonly type: "FRAME" | "GROUP"
+    clone(): FrameNode
+  }
 
-type BaseNode =
-  DocumentNode |
-  PageNode |
-  SceneNode
+  interface SliceNode extends BaseNodeMixin, SceneNodeMixin, LayoutMixin, ExportMixin {
+    readonly type: "SLICE"
+    clone(): SliceNode
+  }
 
-type SceneNode =
-  SliceNode |
-  FrameNode |
-  ComponentNode |
-  InstanceNode |
-  BooleanOperationNode |
-  VectorNode |
-  StarNode |
-  LineNode |
-  EllipseNode |
-  PolygonNode |
-  RectangleNode |
-  TextNode
+  interface RectangleNode extends DefaultShapeMixin, ConstraintMixin, CornerMixin {
+    readonly type: "RECTANGLE"
+    clone(): RectangleNode
+    topLeftRadius: number
+    topRightRadius: number
+    bottomLeftRadius: number
+    bottomRightRadius: number
+  }
 
-type NodeType =
-  "DOCUMENT" |
-  "PAGE" |
-  "SLICE" |
-  "FRAME" |
-  "GROUP" |
-  "COMPONENT" |
-  "INSTANCE" |
-  "BOOLEAN_OPERATION" |
-  "VECTOR" |
-  "STAR" |
-  "LINE" |
-  "ELLIPSE" |
-  "POLYGON" |
-  "RECTANGLE" |
-  "TEXT"
+  interface LineNode extends DefaultShapeMixin, ConstraintMixin {
+    readonly type: "LINE"
+    clone(): LineNode
+  }
 
-////////////////////////////////////////////////////////////////////////////////
-// Styles
-type StyleType = "PAINT" | "TEXT" | "EFFECT" | "GRID"
+  interface EllipseNode extends DefaultShapeMixin, ConstraintMixin, CornerMixin {
+    readonly type: "ELLIPSE"
+    clone(): EllipseNode
+    arcData: ArcData
+  }
 
-interface BaseStyle {
-  readonly id: string
-  readonly type: StyleType
-  name: string
-  description: string
-  remote: boolean
-  readonly key: string // The key to use with "importStyleByKeyAsync"
-  remove(): void
-}
+  interface PolygonNode extends DefaultShapeMixin, ConstraintMixin, CornerMixin {
+    readonly type: "POLYGON"
+    clone(): PolygonNode
+    pointCount: number
+  }
 
-interface PaintStyle extends BaseStyle {
-  type: "PAINT"
-  paints: ReadonlyArray<Paint>
-}
+  interface StarNode extends DefaultShapeMixin, ConstraintMixin, CornerMixin {
+    readonly type: "STAR"
+    clone(): StarNode
+    pointCount: number
+    innerRadius: number
+  }
 
-interface TextStyle extends BaseStyle {
-  type: "TEXT"
-  fontSize: number
-  textDecoration: TextDecoration
-  fontName: FontName
-  letterSpacing: LetterSpacing
-  lineHeight: LineHeight
-  paragraphIndent: number
-  paragraphSpacing: number
-  textCase: TextCase
-}
+  interface VectorNode extends DefaultShapeMixin, ConstraintMixin, CornerMixin {
+    readonly type: "VECTOR"
+    clone(): VectorNode
+    vectorNetwork: VectorNetwork
+    vectorPaths: VectorPaths
+    handleMirroring: HandleMirroring | PluginAPI['mixed']
+  }
 
-interface EffectStyle extends BaseStyle {
-  type: "EFFECT"
-  effects: ReadonlyArray<Effect>
-}
+  interface TextNode extends DefaultShapeMixin, ConstraintMixin {
+    readonly type: "TEXT"
+    clone(): TextNode
+    characters: string
+    readonly hasMissingFont: boolean
+    textAlignHorizontal: "LEFT" | "CENTER" | "RIGHT" | "JUSTIFIED"
+    textAlignVertical: "TOP" | "CENTER" | "BOTTOM"
+    textAutoResize: "NONE" | "WIDTH_AND_HEIGHT" | "HEIGHT"
+    paragraphIndent: number
+    paragraphSpacing: number
+    autoRename: boolean
 
-interface GridStyle extends BaseStyle {
-  type: "GRID"
-  layoutGrids: ReadonlyArray<LayoutGrid>
-}
+    textStyleId: string | PluginAPI['mixed']
+    fontSize: number | PluginAPI['mixed']
+    fontName: FontName | PluginAPI['mixed']
+    textCase: TextCase | PluginAPI['mixed']
+    textDecoration: TextDecoration | PluginAPI['mixed']
+    letterSpacing: LetterSpacing | PluginAPI['mixed']
+    lineHeight: LineHeight | PluginAPI['mixed']
 
-////////////////////////////////////////////////////////////////////////////////
-// Other
+    getRangeFontSize(start: number, end: number): number | PluginAPI['mixed']
+    setRangeFontSize(start: number, end: number, value: number): void
+    getRangeFontName(start: number, end: number): FontName | PluginAPI['mixed']
+    setRangeFontName(start: number, end: number, value: FontName): void
+    getRangeTextCase(start: number, end: number): TextCase | PluginAPI['mixed']
+    setRangeTextCase(start: number, end: number, value: TextCase): void
+    getRangeTextDecoration(start: number, end: number): TextDecoration | PluginAPI['mixed']
+    setRangeTextDecoration(start: number, end: number, value: TextDecoration): void
+    getRangeLetterSpacing(start: number, end: number): LetterSpacing | PluginAPI['mixed']
+    setRangeLetterSpacing(start: number, end: number, value: LetterSpacing): void
+    getRangeLineHeight(start: number, end: number): LineHeight | PluginAPI['mixed']
+    setRangeLineHeight(start: number, end: number, value: LineHeight): void
+    getRangeFills(start: number, end: number): Paint[] | PluginAPI['mixed']
+    setRangeFills(start: number, end: number, value: Paint[]): void
+    getRangeTextStyleId(start: number, end: number): string | PluginAPI['mixed']
+    setRangeTextStyleId(start: number, end: number, value: string): void
+    getRangeFillStyleId(start: number, end: number): string | PluginAPI['mixed']
+    setRangeFillStyleId(start: number, end: number, value: string): void
+  }
 
-interface Image {
-  readonly hash: string
-  getBytesAsync(): Promise<Uint8Array>
-}
+  interface ComponentNode extends DefaultContainerMixin {
+    readonly type: "COMPONENT"
+    clone(): ComponentNode
+
+    createInstance(): InstanceNode
+    description: string
+    readonly remote: boolean
+    readonly key: string // The key to use with "importComponentByKeyAsync"
+  }
+
+  interface InstanceNode extends DefaultContainerMixin  {
+    readonly type: "INSTANCE"
+    clone(): InstanceNode
+    masterComponent: ComponentNode
+  }
+
+  interface BooleanOperationNode extends DefaultShapeMixin, ChildrenMixin, CornerMixin {
+    readonly type: "BOOLEAN_OPERATION"
+    clone(): BooleanOperationNode
+    booleanOperation: "UNION" | "INTERSECT" | "SUBTRACT" | "EXCLUDE"
+  }
+
+  type BaseNode =
+    DocumentNode |
+    PageNode |
+    SceneNode
+
+  type SceneNode =
+    SliceNode |
+    FrameNode |
+    ComponentNode |
+    InstanceNode |
+    BooleanOperationNode |
+    VectorNode |
+    StarNode |
+    LineNode |
+    EllipseNode |
+    PolygonNode |
+    RectangleNode |
+    TextNode
+
+  type NodeType =
+    "DOCUMENT" |
+    "PAGE" |
+    "SLICE" |
+    "FRAME" |
+    "GROUP" |
+    "COMPONENT" |
+    "INSTANCE" |
+    "BOOLEAN_OPERATION" |
+    "VECTOR" |
+    "STAR" |
+    "LINE" |
+    "ELLIPSE" |
+    "POLYGON" |
+    "RECTANGLE" |
+    "TEXT"
+
+  ////////////////////////////////////////////////////////////////////////////////
+  // Styles
+  type StyleType = "PAINT" | "TEXT" | "EFFECT" | "GRID"
+
+  interface BaseStyle {
+    readonly id: string
+    readonly type: StyleType
+    name: string
+    description: string
+    remote: boolean
+    readonly key: string // The key to use with "importStyleByKeyAsync"
+    remove(): void
+  }
+
+  interface PaintStyle extends BaseStyle {
+    type: "PAINT"
+    paints: ReadonlyArray<Paint>
+  }
+
+  interface TextStyle extends BaseStyle {
+    type: "TEXT"
+    fontSize: number
+    textDecoration: TextDecoration
+    fontName: FontName
+    letterSpacing: LetterSpacing
+    lineHeight: LineHeight
+    paragraphIndent: number
+    paragraphSpacing: number
+    textCase: TextCase
+  }
+
+  interface EffectStyle extends BaseStyle {
+    type: "EFFECT"
+    effects: ReadonlyArray<Effect>
+  }
+
+  interface GridStyle extends BaseStyle {
+    type: "GRID"
+    layoutGrids: ReadonlyArray<LayoutGrid>
+  }
+
+  ////////////////////////////////////////////////////////////////////////////////
+  // Other
+
+  interface Image {
+    readonly hash: string
+    getBytesAsync(): Promise<Uint8Array>
+  }
+  } // declare global
+
+  export {}

package.json

 {
   "name": "@figma/plugin-typings",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "Typings for the Figma Plugin API",
   "main": "",
   "scripts": {
-    "test": "tsc --noEmit --typeRoots '[]' index.d.ts"
+    "test": "tsc --noEmit --strict --typeRoots '[]' index.d.ts"
   },
@@ -9,0 +9,0 @@ "repository": {

No alert changes

Improved metrics

Total package byte prevSize

23283

increased by17.38%

Lines of code

618

increased by7.85%

No dependency changes