@mastergo/plugin-typings 1.20.0 → 2.0.0

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+# [2.0.0](https://github.com/mastergo-design/plugin-typings/compare/v1.21.0...v2.0.0) (2023-09-25)
+
+
+### Bug Fixes
+
+* 修改接口 ([50c9d6f](https://github.com/mastergo-design/plugin-typings/commit/50c9d6f1ad1f7290f62009f7c4f672b8f7f1ad81))
+
+
+### Features
+
+* 插件API支持SECTION类型 ([ae02af9](https://github.com/mastergo-design/plugin-typings/commit/ae02af932b90ca770e343a5f1bad7abb48fe90df))
+* 全局增加createSection的接口 ([da713b1](https://github.com/mastergo-design/plugin-typings/commit/da713b18c1994ecbe576c75a19e67ba7edda6e46))
+* 新增组件集属性别名相关方法/画布在整个窗口中的位置 ([5b212c9](https://github.com/mastergo-design/plugin-typings/commit/5b212c943c7d0c2afb92fcad1433e70733fa43d2))
+
+
+
+# [1.21.0](https://github.com/mastergo-design/plugin-typings/compare/v1.19.0...v1.21.0) (2023-07-06)
+
+
+### Bug Fixes
+
+* 补充paint的name字段 ([217c68e](https://github.com/mastergo-design/plugin-typings/commit/217c68efdcd1a3e6d0d0d07c3fd024794563751b))
+* opaque图层禁止修改相对矩阵 ([fb634b1](https://github.com/mastergo-design/plugin-typings/commit/fb634b1eb77d7df2f5d1eeb98bd53888586b0daa))
+
+
+### Features
+
+* 添加轮廓蒙层和是否可视属性，文本支持省略 ([89414ad](https://github.com/mastergo-design/plugin-typings/commit/89414ad67f398dd44055172b1d0f9ff47693b1d6))
+* 增加pluginId ([321db49](https://github.com/mastergo-design/plugin-typings/commit/321db497ff6da8f2802bab2f5ea1c5e3f3a1fc76))
+* document增加id ([d2bfdff](https://github.com/mastergo-design/plugin-typings/commit/d2bfdff8451eea4c09a757b6d01fec0c37f73e6f))
+
+
+
 # [1.20.0](https://github.com/mastergo-design/plugin-typings/compare/v1.19.0...v1.20.0) (2023-04-27)
 
 

package/dist/index.d.ts

@@ -25,7 +25,7 @@ declare global {
     getBytesAsync(): Promise<Uint8Array>
   }
 
-  type PluginEventType = 'selectionchange' | 'currentpagechange' | 'close' | 'themechange' | 'drop' | 'run'
+  type PluginEventType = 'selectionchange' | 'layoutchange' | 'currentpagechange' | 'close' | 'themechange' | 'drop' | 'run'
   type ThemeColor = 'dark' | 'light'
 
   interface PluginAPI {
@@ -63,7 +63,7 @@ declare global {
     showUI(html: string, options?: ShowUIOptions): void
 
     getNodeById(id: string): SceneNode | null
-    getNodeByPosition(position: {x: number, y: number}): SceneNode | null
+    getNodeByPosition(position: { x: number, y: number }): SceneNode | null
     createRectangle(): RectangleNode
     createLine(): LineNode
     createEllipse(): EllipseNode
@@ -73,6 +73,7 @@ declare global {
     createText(): TextNode
     createFrame(children?: SceneNode[]): FrameNode
     createComponent(children?: SceneNode[]): ComponentNode
+    createSection(): SectionNode
     createPage(): PageNode
     createSlice(): SliceNode
     createConnector(): ConnectorNode
@@ -100,7 +101,7 @@ declare global {
     notify(message: string, options?: NotifyOptions): NotificationHandler
 
     getStyleById(id: string): Style | null
-    getTitleByFontFamilyAndStyle(fontFamily: string, fontStyle: string) : FontAlias | null
+    getTitleByFontFamilyAndStyle(fontFamily: string, fontStyle: string): FontAlias | null
     createFillStyle(config: CreateStyleConfig): PaintStyle
     createStrokeStyle(config: CreateStyleConfig): PaintStyle
     createEffectStyle(config: CreateStyleConfig): EffectStyle
@@ -139,14 +140,33 @@ declare global {
     photoUrl: string | null
   }
 
-  interface Rect extends Readonly<Bound> {}
+  interface Rect extends Readonly<Bound> { }
   interface NotificationHandler {
     cancel: () => void
   }
+  interface Layout {
+    canvas: number
+    leftbar: number
+    rightbar: number
+    window: number
+  }
+
+  interface PositionOnDom {
+    width: number
+    height: number
+    x: number
+    y: number
+  }
+
   interface ViewportAPI {
     center: Vector
     zoom: number
     readonly bound: Rect
+    /**
+     * @deprecated
+     */
+    readonly layout: Layout
+    readonly positionOnDom: PositionOnDom
     rulerVisible: boolean
     layoutGridVisible: boolean
     scrollAndZoomIntoView(nodes: SceneNode[]): void
@@ -185,7 +205,7 @@ declare global {
     readonly isSuffix?: boolean
     readonly fileName?: string
   }
-  
+
   interface ExportSettingsPDF {
     readonly format: 'PDF'
     readonly isSuffix?: string
@@ -193,7 +213,7 @@ declare global {
     readonly useAbsoluteBounds?: boolean // defaults to true
     readonly useRenderBounds?: boolean // default to true
   }
-  
+
   type ExportSettings = ExportSettingsImage | ExportSettingsSVG | ExportSettingsPDF
 
 
@@ -214,7 +234,7 @@ declare global {
     readonly headerHeight: number
     readonly visible: boolean
   }
-  
+
   interface UIAPI {
     show(): void
     hide(): void
@@ -226,8 +246,12 @@ declare global {
     onmessage: ((pluginMessage: any, origin: string) => void) | undefined
   }
   type PublishStatus = 'UNPUBLISHED' | 'CURRENT' | 'CHANGED'
+  interface DocumentationLink {
+    readonly uri: string
+  }
   interface PublishableMixin {
     description: string
+    documentationLinks: ReadonlyArray<DocumentationLink>
     /**
      * 是否为团队库组件/样式
     */
@@ -241,7 +265,7 @@ declare global {
 
   type StyleType = 'PAINT' | 'TEXT' | 'EFFECT' | 'GRID'
 
-  interface BaseStyle extends PublishableMixin {
+  interface BaseStyle extends Omit<PublishableMixin, 'documentationLinks'> {
     readonly id: string
     readonly type: StyleType
     name: string
@@ -302,7 +326,7 @@ declare global {
     title: string
     subtitle: string
   }
-  
+
   interface GridStyle extends BaseStyle {
     type: 'GRID'
     layoutGrids: ReadonlyArray<LayoutGrid>
@@ -397,22 +421,36 @@ 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
     readonly name?: string
   }
 
+  interface ImageFilters {
+    exposure?: number
+    contrast?: number
+    saturation?: number
+    temperature?: number
+    tint?: number
+    highlights?: number
+    shadows?: number
+    hue?: number
+  }
+
   interface ImagePaint {
     readonly type: 'IMAGE'
     readonly imageRef: string
     readonly scaleMode?: 'FILL' | 'TILE' | 'STRETCH' | 'FIT' | 'CROP'
+    readonly filters?: ImageFilters
 
     readonly isVisible?: boolean
     readonly alpha?: number
     readonly blendMode?: BlendMode
     readonly name?: string
+    readonly ratio?: number
+    readonly rotation?: number
   }
 
   type Paint = SolidPaint | GradientPaint | ImagePaint
@@ -444,11 +482,11 @@ declare global {
   }
 
   type LineHeight =
-  | {
+    | {
       readonly value: number
       readonly unit: 'PIXELS' | 'PERCENT'
     }
-  | {
+    | {
       readonly unit: 'AUTO'
     }
 
@@ -506,7 +544,7 @@ declare global {
       isVisible?: string,
       characters?: string,
       mainComponent?: string
-    } | null   
+    } | null
   }
 
   interface ChildrenMixin<ChildrenNode = SceneNode> {
@@ -566,7 +604,7 @@ declare global {
     isMask: boolean
     isMaskOutline: boolean
     isMaskVisible: boolean
-    effects: ReadonlyArray<Effect>    
+    effects: ReadonlyArray<Effect>
     effectStyleId: string
   }
 
@@ -580,14 +618,14 @@ declare global {
   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
@@ -671,25 +709,25 @@ declare global {
     readonly count: number
     readonly sectionSize?: number | null
     readonly offset?: number
-  
+
     readonly isVisible?: boolean
     readonly color?: RGBA
     readonly id?: string
     readonly name?: string
   }
-  
+
   interface GridLayoutGrid {
     readonly gridType: "GRID"
 
     readonly sectionSize: number
-  
+
     readonly isVisible?: boolean
     readonly color?: RGBA
     readonly id?: string
     readonly name?: string
   }
-  
-  
+
+
   type LayoutGrid = RowsColsLayoutGrid | GridLayoutGrid
 
   interface FrameContainerMixin extends AutoLayout {
@@ -758,7 +796,7 @@ declare global {
     currentPage: PageNode
 
     readonly children: ReadonlyArray<PageNode>
-    
+
     findAll(callback?: (node: SceneNode) => boolean): ReadonlyArray<SceneNode>
     findOne(callback: (node: SceneNode) => boolean): SceneNode | null
     findAllWithCriteria<T extends NodeType[]>(criteria: { types: T }): Array<{ type: T[number] } & SceneNode>
@@ -780,7 +818,7 @@ declare global {
     /**
      * 选中所有图层
      */
-    selectAll() : void
+    selectAll(): void
     /**
      * 背景颜色
      */
@@ -792,7 +830,12 @@ declare global {
     /**
      * 标签,默认'NONE'
      */
-    label:'NONE' | 'BLUE' | 'GREEN' | 'RED' | 'YELLOW' | 'PURPLE' | 'GRAY'
+    label: 'NONE' | 'BLUE' | 'GREEN' | 'RED' | 'YELLOW' | 'PURPLE' | 'GRAY'
+  }
+
+  interface SectionNode extends Omit<DefaultContainerMixin, 'opacity' | 'blendMode' | 'isMask' | 'isMaskOutline' | 'isMaskVisible' | 'effects' | 'effectStyleId'>, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
+    readonly type: 'SECTION'
+    clone(): SectionNode
   }
 
   interface FrameNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
@@ -873,11 +916,11 @@ declare global {
   }
 
 
-  interface GroupNode 
-  extends DefaultShapeMixin,
-  ContainerMixin,
-  ChildrenMixin,  
-  CornerMixin {
+  interface GroupNode
+    extends DefaultShapeMixin,
+    ContainerMixin,
+    ChildrenMixin,
+    CornerMixin {
     readonly type: 'GROUP'
     clone(): GroupNode
   }
@@ -905,7 +948,7 @@ declare global {
     superlink: {
       layerId?: string
       link: string
-      linkFlag: LinkFlagEnum 
+      linkFlag: LinkFlagEnum
       pageId: string
     }
   }
@@ -979,12 +1022,6 @@ declare global {
     value: string
   }
 
-  /**
-   * @deprecated
-   * 
-   */
-  type ComponentPropertyDefinitions = Array<VariantMixin>
-
   interface ComponentPropertiesMixin {
     readonly componentPropertyValues: ComponentPropertyValues
     addComponentProperty(
@@ -1013,6 +1050,8 @@ declare global {
     id?: string
     variantOptions?: string[]
     preferredValues?: InstanceSwapPreferredValue[]
+    alias?: string
+    variantOptionsAlias?: string[]
   }
 
   type ComponentPropertyType = 'BOOLEAN' | 'TEXT' | 'INSTANCE_SWAP' | 'VARIANT'
@@ -1042,15 +1081,13 @@ declare global {
 
   interface ComponentSetNode extends Omit<DefaultContainerMixin, 'appendChild' | 'insertChild'>, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin, ComponentPropertiesMixin {
     readonly type: 'COMPONENT_SET'
-    /**
-     * @deprecated
-     */
-    readonly componentPropertyDefinitions: ComponentPropertyDefinitions
     clone(): ComponentSetNode
     createVariantComponent(): void
     createVariantProperties(properties: Array<string>): void
     editVariantProperties(properties: Record<string, string>): void
     editVariantPropertyValues(properties: Record<string, { oldValue: string, newValue: string }>): void
+    editVariantPropertiesAlias(properties: Record<string, string>): void
+    editVariantPropertyValuesAlias(properties: Record<string, { name: string, alias: string }>): void
     deleteVariantProperty(property: string): void
     resizeToFit(): void
   }
@@ -1058,14 +1095,14 @@ declare global {
   interface InstanceNode extends Omit<DefaultContainerMixin, 'appendChild' | 'insertChild'>, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'INSTANCE'
     readonly variantProperties: Array<VariantProperty> | undefined
-    
+
     setVariantPropertyValues(property: Record<string, string>): void
 
     readonly componentProperties: Array<ComponentProperties>
     setProperties(properties: { [propertyId: string]: string | boolean }): void
     readonly exposedInstances: InstanceNode[]
     isExposedInstance: boolean
-    
+
     resetOverrides(): void
 
     clone(): InstanceNode
@@ -1105,13 +1142,13 @@ declare global {
     readonly hyperlinks: Array<HyperlinkWithRange>
 
     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,
@@ -1144,7 +1181,7 @@ declare global {
     id: string;
     description?: string;
   }
-  
+
   interface FlowStartingPoint {
     name: string
     id: string
@@ -1164,22 +1201,22 @@ declare global {
     readonly scrollToXOffset?: number;
     readonly scrollToYOffset?: number;
   }
-  
-  type ActionType = 'BACK' | 'NODE'| 'URL'| 'CLOSE'| 'NONE';
-  
-  type  Navigation =  'NAVIGATE' | 'OVERLAY' | 'SWAP_OVERLAY' | 'SCROLL_TO';
-  
+
+  type ActionType = 'BACK' | 'NODE' | 'URL' | 'CLOSE' | 'NONE';
+
+  type Navigation = 'NAVIGATE' | 'OVERLAY' | 'SWAP_OVERLAY' | 'SCROLL_TO';
+
   interface Transition {
     readonly type: TransitionType;
     readonly duration: number;
     readonly direction: TransitionDirection;
     readonly easing: Easing;
   }
-  
+
   type TransitionType = 'TANS_NONE' | 'INSTANT' | 'DISSOLVE' | 'SMART_ANIMATE' | 'MOVE_IN' | 'MOVE_OUT' | 'PUSH' | 'SLIDE_IN' | 'SLIDE_OUT' | 'DISPLACE'
-  
+
   type TransitionDirection = 'LEFT' | 'RIGHT' | 'TOP' | 'BOTTOM'
-  interface Easing{
+  interface Easing {
     readonly type: EasingType;
     readonly easingFunctionCubicBezier: {
       x1: number;
@@ -1188,19 +1225,19 @@ declare global {
       y2: number;
     };
   }
-  
+
   type EasingType = 'LINEAR' | 'EASE_IN' | 'EASE_OUT' | 'EASE_IN_AND_OUT' | 'EASE_IN_BACK' | 'EASE_OUT_BACK' | 'EASE_IN_AND_OUT_BACK' | 'CUSTOM_CUBIC_BEZIER'
-  interface Trigger{
+  interface Trigger {
     readonly type: TriggerType;
     readonly delay: number;
   }
   type TriggerType = 'ON_CLICK' | 'ON_DRAG' | 'ON_HOVER' | 'ON_PRESS' | 'MOUSE_ENTER' | 'MOUSE_LEAVE' | 'MOUSE_DOWN' | 'MOUSE_UP' | 'AFTER_DELAY'
-  
+
   interface ArcData {
     /**
      * 起点弧度
      */
-    startingAngle: number 
+    startingAngle: number
     /**
      * 终点弧度
      */
@@ -1221,7 +1258,7 @@ declare global {
     x: number
     y: number
     absoluteX: number
-    absoluteY: number 
+    absoluteY: number
     dropMetadata?: any
   }
 
@@ -1274,6 +1311,7 @@ declare global {
     | BooleanOperationNode
     | SliceNode
     | ConnectorNode
+    | SectionNode
 
   type NodeType =
     | 'DOCUMENT'
@@ -1293,6 +1331,7 @@ declare global {
     | 'BOOLEAN_OPERATION'
     | 'SLICE'
     | 'CONNECTOR'
+    | 'SECTION'
 }
 
 export { }

package/package.json

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