@mastergo/plugin-typings 1.0.0 → 1.1.1

package/dist/index.d.ts

@@ -72,6 +72,7 @@ declare global {
     createComponent(): ComponentNode
     createPage(): PageNode
     createSlice(): SliceNode
+    createConnector(): ConnectorNode
     createNodeFromSvgAsync(svg: string): Promise<FrameNode>
 
     getHoverLayer(): PageNode | SceneNode
@@ -208,6 +209,7 @@ declare global {
       letterSpacing: LetterSpacing
       lineHeight: LineHeight
       textDecoration: TextDecoration
+      textCase: TextCase
     }
     fills: Paint[]
   }
@@ -225,6 +227,7 @@ declare global {
     isExternal: boolean
     letterSpacing: number
     letterSpacingUnit: NumValue['unit']
+    textCase: TextCase
   }
 
   interface FontAlias {
@@ -267,6 +270,8 @@ declare global {
     readonly style: string
   }
 
+  type TextCase = 'ORIGINAL' | 'UPPER' | 'LOWER' | 'TITLE';
+
   type TextDecoration = 'NONE' | 'UNDERLINE' | 'STRIKETHROUGH'
 
   interface ShadowEffect {
@@ -320,7 +325,7 @@ declare global {
     | 'GRADIENT_DIAMOND'
     readonly transform: Transform
     readonly gradientStops: ReadonlyArray<ColorStop>
-    readonly gradientHandlePositions: [{ x: number, y: number}, { x: number, y: number}];
+    readonly gradientHandlePositions?: [{ x: number, y: number}, { x: number, y: number}];
     readonly isVisible?: boolean
     readonly alpha?: number
     readonly blendMode?: BlendMode
@@ -406,7 +411,6 @@ declare global {
     readonly parent: (BaseNode & ChildrenMixin) | void
     name: string // Note: setting this also sets \`autoRename\` to false on TextNodes
     removed: boolean
-    reactions: Reaction[]
     remove(): void
     getPluginData(key: string): string
     setPluginData(key: string, value: string): void
@@ -471,11 +475,27 @@ declare global {
     effectStyleId: string
   }
 
-  type StrokeCap = 'NONE' | 'ROUND' | 'SQUARE' | 'LINE_ARROW' | 'TRIANGLE_ARROW'
+  type StrokeCap = 'NONE' | 'ROUND' | 'SQUARE' | 'LINE_ARROW' | 'TRIANGLE_ARROW' | 'ROUND_ARROW' | 'RING' | 'DIAMOND' | 'LINE'
   type StrokeJoin = 'MITER' | 'BEVEL' | 'ROUND'
   type StrokeAlign = 'CENTER' | 'INSIDE' | 'OUTSIDE'
   type DashCap = 'NONE' | 'ROUND' | 'SQUARE'
   type StrokeStyle = 'SOLID' | 'DASH' | 'CUSTOM'
+  type ConnectorStrokeCap = StrokeCap
+
+  interface ConnectorEndpointPosition {
+    readonly position: { x: number; y: number }
+  }
+  
+  interface ConnectorEndpointConnected {
+    readonly position: { x: number; y: number }
+    readonly endpointNodeId: string
+    readonly magnet: 'TOP' | 'LEFT' | 'BOTTOM' | 'RIGHT'
+  }
+  
+  
+  type ConnectorEndpoint =
+    | ConnectorEndpointPosition
+    | ConnectorEndpointConnected
 
   interface GeometryMixin {
     fills: ReadonlyArray<Paint>
@@ -486,7 +506,7 @@ declare global {
     strokeJoin: StrokeJoin
     strokeStyle: StrokeStyle
     dashCap: DashCap
-    strokeDashes: ReadonlyArray<[number, number]>
+    strokeDashes: ReadonlyArray<number>
     fillStyleId: string
     strokeStyleId: string
     /**
@@ -515,13 +535,14 @@ declare global {
     BlendMixin,
     GeometryMixin,
     LayoutMixin,
+    ReactionMixin,
     ExportMixin { }
 
   interface DefaultContainerMixin
     extends BaseNodeMixin,
+    ReactionMixin,
     SceneNodeMixin,
     ChildrenMixin,
-    RectangleStrokeWeightMixin,
     RectangleCornerMixin,
     BlendMixin,
     CornerMixin,
@@ -587,6 +608,41 @@ declare global {
     bottomRightRadius: number
   }
 
+  interface ReactionMixin {
+    reactions: ReadonlyArray<Reaction>
+  }
+
+  interface OpaqueNodeMixin extends BaseNodeMixin, SceneNodeMixin, ExportMixin {
+    readonly absoluteTransform: Transform
+    relativeTransform: Transform
+    x: number
+    y: number
+    readonly width: number
+    readonly height: number
+  }
+
+  interface MinimalBlendMixin {
+    opacity: number
+    blendMode: BlendMode
+  }
+
+  interface MinimalStrokesMixin {
+    strokes: ReadonlyArray<Paint>
+    strokeStyleId: string
+    strokeWeight: number
+    strokeJoin: StrokeJoin
+    strokeAlign: StrokeAlign
+    strokeStyle: StrokeStyle
+    strokeCap: StrokeCap
+    strokeDashes: ReadonlyArray<number>
+    dashCap: DashCap
+  }
+
+  interface MinimalFillsMixin {
+    fills: ReadonlyArray<Paint>
+    fillStyleId: string
+  }
+
   /// /////////////////////////////////////////////////////////////////////////////
   // Nodes
 
@@ -621,12 +677,12 @@ declare global {
     label:'NONE' | 'BLUE' | 'GREEN' | 'RED' | 'YELLOW' | 'PURPLE' | 'GRAY'
   }
 
-  interface FrameNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin {
+  interface FrameNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'FRAME'
     clone(): FrameNode
   }
 
-  interface ComponentSetNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin {
+  interface ComponentSetNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'COMPONENT_SET'
     readonly componentPropertyDefinitions: Array<Record<string, Array<string> | string>>
     clone(): ComponentSetNode
@@ -756,9 +812,10 @@ declare global {
     setRangeLineHeight(start: number, end: number, value: LineHeight): void
     setRangeFills(start: number, end: number, paints: Paint[]): void
     setRangeSuperLink(start: number, end: number, link: string | null): void
+    setRangeTextCase(start: number, end: number, textCase: TextCase): void
   }
 
-  interface ComponentNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin {
+  interface ComponentNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'COMPONENT'
     readonly variantProperties: Array<Record<string, string>>
     description: string
@@ -767,7 +824,7 @@ declare global {
     createInstance(): InstanceNode
   }
 
-  interface InstanceNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin {
+  interface InstanceNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'INSTANCE'
     readonly variantProperties: Array<Record<string, string>>
     setVariantPropertyValues(property: Record<string, string>): void
@@ -786,6 +843,51 @@ declare global {
     isPreserveRatio: boolean
   }
 
+  interface ConnectorNode extends OpaqueNodeMixin, Pick<MinimalBlendMixin, 'opacity'>, Omit<MinimalStrokesMixin, 'strokeAlign'> {
+    readonly type: 'CONNECTOR'
+    createText(): TextSublayerNode
+    readonly text: TextSublayerNode | null
+    cornerRadius?: number
+    connectorStart: ConnectorEndpoint
+    connectorEnd: ConnectorEndpoint
+    connectorStartStrokeCap: ConnectorStrokeCap
+    connectorEndStrokeCap: ConnectorStrokeCap
+    readonly strokeAlign: 'CENTER'
+    clone(): ConnectorNode
+  }
+
+  interface TextSublayerNode extends MinimalFillsMixin {
+    readonly id: string
+    readonly hasMissingFont: boolean
+    readonly textAlignHorizontal: 'CENTER'
+    readonly textAlignVertical: 'CENTER'
+    readonly textAutoResize: 'WIDTH_AND_HEIGHT'
+
+    readonly textStyles: ReadonlyArray<TextSegStyle>
+  
+    paragraphSpacing: number
+
+    characters: string
+    insertCharacters(start: number, characters: string): void
+    deleteCharacters(start: number, end: number): void
+  
+    setRangeFontSize(start: number, end: number, fontSize: number): void
+    setRangeTextDecoration(
+      start: number,
+      end: number,
+      decoration: TextDecoration
+    ): void
+    setRangeFontName(start: number, end: number, fontName: FontName): void
+    setRangeLetterSpacing(
+      start: number,
+      end: number,
+      value: LetterSpacing
+    ): void
+    setRangeLineHeight(start: number, end: number, value: LineHeight): void
+    setRangeFills(start: number, end: number, paints: Paint[]): void
+    setRangeTextCase(start: number, end: number, textCase: TextCase): void
+  }
+
   type BaseNode = DocumentNode | PageNode | SceneNode
 
   /**
@@ -802,9 +904,11 @@ declare global {
     | RectangleNode
     | TextNode
     | ComponentNode
+    | ComponentSetNode
     | InstanceNode
     | BooleanOperationNode
     | SliceNode
+    | ConnectorNode
 
   type NodeType =
     | 'DOCUMENT'
@@ -823,6 +927,7 @@ declare global {
     | 'INSTANCE'
     | 'BOOLEAN_OPERATION'
     | 'SLICE'
+    | 'CONNECTOR'
 }
 
 interface CreateStyleConfig {
@@ -976,6 +1081,7 @@ declare global {
     createComponent(): ComponentNode
     createPage(): PageNode
     createSlice(): SliceNode
+    createConnector(): ConnectorNode
     createNodeFromSvgAsync(svg: string): Promise<FrameNode>
 
     getHoverLayer(): PageNode | SceneNode
@@ -1112,6 +1218,7 @@ declare global {
       letterSpacing: LetterSpacing
       lineHeight: LineHeight
       textDecoration: TextDecoration
+      textCase: TextCase
     }
     fills: Paint[]
   }
@@ -1129,6 +1236,7 @@ declare global {
     isExternal: boolean
     letterSpacing: number
     letterSpacingUnit: NumValue['unit']
+    textCase: TextCase
   }
 
   interface FontAlias {
@@ -1171,6 +1279,8 @@ declare global {
     readonly style: string
   }
 
+  type TextCase = 'ORIGINAL' | 'UPPER' | 'LOWER' | 'TITLE';
+
   type TextDecoration = 'NONE' | 'UNDERLINE' | 'STRIKETHROUGH'
 
   interface ShadowEffect {
@@ -1224,7 +1334,7 @@ declare global {
     | 'GRADIENT_DIAMOND'
     readonly transform: Transform
     readonly gradientStops: ReadonlyArray<ColorStop>
-    readonly gradientHandlePositions: [{ x: number, y: number}, { x: number, y: number}];
+    readonly gradientHandlePositions?: [{ x: number, y: number}, { x: number, y: number}];
     readonly isVisible?: boolean
     readonly alpha?: number
     readonly blendMode?: BlendMode
@@ -1310,7 +1420,6 @@ declare global {
     readonly parent: (BaseNode & ChildrenMixin) | void
     name: string // Note: setting this also sets \`autoRename\` to false on TextNodes
     removed: boolean
-    reactions: Reaction[]
     remove(): void
     getPluginData(key: string): string
     setPluginData(key: string, value: string): void
@@ -1375,11 +1484,27 @@ declare global {
     effectStyleId: string
   }
 
-  type StrokeCap = 'NONE' | 'ROUND' | 'SQUARE' | 'LINE_ARROW' | 'TRIANGLE_ARROW'
+  type StrokeCap = 'NONE' | 'ROUND' | 'SQUARE' | 'LINE_ARROW' | 'TRIANGLE_ARROW' | 'ROUND_ARROW' | 'RING' | 'DIAMOND' | 'LINE'
   type StrokeJoin = 'MITER' | 'BEVEL' | 'ROUND'
   type StrokeAlign = 'CENTER' | 'INSIDE' | 'OUTSIDE'
   type DashCap = 'NONE' | 'ROUND' | 'SQUARE'
   type StrokeStyle = 'SOLID' | 'DASH' | 'CUSTOM'
+  type ConnectorStrokeCap = StrokeCap
+
+  interface ConnectorEndpointPosition {
+    readonly position: { x: number; y: number }
+  }
+  
+  interface ConnectorEndpointConnected {
+    readonly position: { x: number; y: number }
+    readonly endpointNodeId: string
+    readonly magnet: 'TOP' | 'LEFT' | 'BOTTOM' | 'RIGHT'
+  }
+  
+  
+  type ConnectorEndpoint =
+    | ConnectorEndpointPosition
+    | ConnectorEndpointConnected
 
   interface GeometryMixin {
     fills: ReadonlyArray<Paint>
@@ -1390,7 +1515,7 @@ declare global {
     strokeJoin: StrokeJoin
     strokeStyle: StrokeStyle
     dashCap: DashCap
-    strokeDashes: ReadonlyArray<[number, number]>
+    strokeDashes: ReadonlyArray<number>
     fillStyleId: string
     strokeStyleId: string
     /**
@@ -1419,13 +1544,14 @@ declare global {
     BlendMixin,
     GeometryMixin,
     LayoutMixin,
+    ReactionMixin,
     ExportMixin { }
 
   interface DefaultContainerMixin
     extends BaseNodeMixin,
+    ReactionMixin,
     SceneNodeMixin,
     ChildrenMixin,
-    RectangleStrokeWeightMixin,
     RectangleCornerMixin,
     BlendMixin,
     CornerMixin,
@@ -1491,6 +1617,41 @@ declare global {
     bottomRightRadius: number
   }
 
+  interface ReactionMixin {
+    reactions: ReadonlyArray<Reaction>
+  }
+
+  interface OpaqueNodeMixin extends BaseNodeMixin, SceneNodeMixin, ExportMixin {
+    readonly absoluteTransform: Transform
+    relativeTransform: Transform
+    x: number
+    y: number
+    readonly width: number
+    readonly height: number
+  }
+
+  interface MinimalBlendMixin {
+    opacity: number
+    blendMode: BlendMode
+  }
+
+  interface MinimalStrokesMixin {
+    strokes: ReadonlyArray<Paint>
+    strokeStyleId: string
+    strokeWeight: number
+    strokeJoin: StrokeJoin
+    strokeAlign: StrokeAlign
+    strokeStyle: StrokeStyle
+    strokeCap: StrokeCap
+    strokeDashes: ReadonlyArray<number>
+    dashCap: DashCap
+  }
+
+  interface MinimalFillsMixin {
+    fills: ReadonlyArray<Paint>
+    fillStyleId: string
+  }
+
   /// /////////////////////////////////////////////////////////////////////////////
   // Nodes
 
@@ -1525,12 +1686,12 @@ declare global {
     label:'NONE' | 'BLUE' | 'GREEN' | 'RED' | 'YELLOW' | 'PURPLE' | 'GRAY'
   }
 
-  interface FrameNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin {
+  interface FrameNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'FRAME'
     clone(): FrameNode
   }
 
-  interface ComponentSetNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin {
+  interface ComponentSetNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'COMPONENT_SET'
     readonly componentPropertyDefinitions: Array<Record<string, Array<string> | string>>
     clone(): ComponentSetNode
@@ -1660,9 +1821,10 @@ declare global {
     setRangeLineHeight(start: number, end: number, value: LineHeight): void
     setRangeFills(start: number, end: number, paints: Paint[]): void
     setRangeSuperLink(start: number, end: number, link: string | null): void
+    setRangeTextCase(start: number, end: number, textCase: TextCase): void
   }
 
-  interface ComponentNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin {
+  interface ComponentNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'COMPONENT'
     readonly variantProperties: Array<Record<string, string>>
     description: string
@@ -1671,7 +1833,7 @@ declare global {
     createInstance(): InstanceNode
   }
 
-  interface InstanceNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin {
+  interface InstanceNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'INSTANCE'
     readonly variantProperties: Array<Record<string, string>>
     setVariantPropertyValues(property: Record<string, string>): void
@@ -1690,6 +1852,51 @@ declare global {
     isPreserveRatio: boolean
   }
 
+  interface ConnectorNode extends OpaqueNodeMixin, Pick<MinimalBlendMixin, 'opacity'>, Omit<MinimalStrokesMixin, 'strokeAlign'> {
+    readonly type: 'CONNECTOR'
+    createText(): TextSublayerNode
+    readonly text: TextSublayerNode | null
+    cornerRadius?: number
+    connectorStart: ConnectorEndpoint
+    connectorEnd: ConnectorEndpoint
+    connectorStartStrokeCap: ConnectorStrokeCap
+    connectorEndStrokeCap: ConnectorStrokeCap
+    readonly strokeAlign: 'CENTER'
+    clone(): ConnectorNode
+  }
+
+  interface TextSublayerNode extends MinimalFillsMixin {
+    readonly id: string
+    readonly hasMissingFont: boolean
+    readonly textAlignHorizontal: 'CENTER'
+    readonly textAlignVertical: 'CENTER'
+    readonly textAutoResize: 'WIDTH_AND_HEIGHT'
+
+    readonly textStyles: ReadonlyArray<TextSegStyle>
+  
+    paragraphSpacing: number
+
+    characters: string
+    insertCharacters(start: number, characters: string): void
+    deleteCharacters(start: number, end: number): void
+  
+    setRangeFontSize(start: number, end: number, fontSize: number): void
+    setRangeTextDecoration(
+      start: number,
+      end: number,
+      decoration: TextDecoration
+    ): void
+    setRangeFontName(start: number, end: number, fontName: FontName): void
+    setRangeLetterSpacing(
+      start: number,
+      end: number,
+      value: LetterSpacing
+    ): void
+    setRangeLineHeight(start: number, end: number, value: LineHeight): void
+    setRangeFills(start: number, end: number, paints: Paint[]): void
+    setRangeTextCase(start: number, end: number, textCase: TextCase): void
+  }
+
   type BaseNode = DocumentNode | PageNode | SceneNode
 
   /**
@@ -1706,9 +1913,11 @@ declare global {
     | RectangleNode
     | TextNode
     | ComponentNode
+    | ComponentSetNode
     | InstanceNode
     | BooleanOperationNode
     | SliceNode
+    | ConnectorNode
 
   type NodeType =
     | 'DOCUMENT'
@@ -1727,6 +1936,7 @@ declare global {
     | 'INSTANCE'
     | 'BOOLEAN_OPERATION'
     | 'SLICE'
+    | 'CONNECTOR'
 }
 
 export interface CreateStyleConfig {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastergo/plugin-typings",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "MasterGo插件API声明文件",
   "main": "",
   "types": "dist/index.d.ts",