@mastergo/plugin-typings 1.4.0 → 1.6.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 MasterGo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,5 @@
+**中文** | [English](./README-en.md)
+
 # MasterGo插件API声明文件
 本项目为MasterGo插件API的ts声明文件。
 
@@ -10,7 +12,7 @@
     yarn add -D @mastergo/plugin-typings
     ```
 
-2. 配置 _tsconfig.json_
+2. 配置 `tsconfig.json`
     ```js
     {
         "compilerOptions": {

package/dist/index.d.ts

@@ -55,7 +55,7 @@ declare global {
     hyperlink: Hyperlink
   }
 
-  type PluginEventType = 'selectionchange' | 'currentpagechange' | 'close' | 'themechange' | 'drop'
+  type PluginEventType = 'selectionchange' | 'currentpagechange' | 'close' | 'themechange' | 'drop' | 'run'
   type ThemeColor = 'dark' | 'light'
 
   interface PluginAPI {
@@ -69,6 +69,8 @@ declare global {
 
     readonly documentId: number
 
+    readonly command: string
+
     readonly clientStorage: ClientStorageAPI
 
     readonly viewport: ViewportAPI
@@ -146,6 +148,8 @@ declare global {
     center: Vector
     zoom: number
     readonly bound: Rect
+    rulerVisible: boolean
+    layoutGridVisible: boolean
     scrollAndZoomIntoView(nodes: ReadonlyArray<BaseNode>): void
   }
 
@@ -238,6 +242,13 @@ declare global {
     fills: Paint[]
   }
 
+  interface ListStyle {
+    start: number
+    end: number
+    level: number
+    type: 'ORDERED' | 'BULLETED' | 'NONE'
+  }
+
   interface EffectStyle extends BaseStyle {
     type: 'EFFECT'
     effects: ReadonlyArray<Effect>
@@ -713,6 +724,7 @@ declare global {
   interface FrameNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'FRAME'
     clone(): FrameNode
+    resizeToFit(): void
   }
 
   interface GroupNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin {
@@ -819,6 +831,7 @@ declare global {
     textAutoResize: 'NONE' | 'WIDTH_AND_HEIGHT' | 'HEIGHT'
     paragraphSpacing: number
     readonly textStyles: ReadonlyArray<TextSegStyle>
+    readonly listStyles: ReadonlyArray<ListStyle>
     clone(): TextNode
 
     insertCharacters(start: number, characters: string): void
@@ -845,6 +858,7 @@ declare global {
     setRangeSuperLink(start: number, end: number, link: string | null): void
     setRangeHyperLink(start: number, end: number, hyperlink: Hyperlink | null): void
     setRangeTextCase(start: number, end: number, textCase: TextCase): void
+    setRangeListStyle(start: number, end: number, type: 'ORDERED' | 'BULLETED' | 'NONE'): void
   }
 
   interface ComponentNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
@@ -854,6 +868,7 @@ declare global {
     setVariantPropertyValues(property: Record<string, string>): void
     clone(): ComponentNode
     createInstance(): InstanceNode
+    resizeToFit(): void
   }
 
   interface ComponentSetNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
@@ -865,6 +880,7 @@ declare global {
     editVariantProperties(properties: Record<string, string>): void
     editVariantPropertyValues(properties: Record<string, { oldValue: string, newValue: string }>): void
     deleteVariantProperty(property: string): void
+    resizeToFit(): void
   }
 
   interface InstanceNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
@@ -1122,7 +1138,7 @@ declare global {
     hyperlink: Hyperlink
   }
 
-  type PluginEventType = 'selectionchange' | 'currentpagechange' | 'close' | 'themechange' | 'drop'
+  type PluginEventType = 'selectionchange' | 'currentpagechange' | 'close' | 'themechange' | 'drop' | 'run'
   type ThemeColor = 'dark' | 'light'
 
   interface PluginAPI {
@@ -1136,6 +1152,8 @@ declare global {
 
     readonly documentId: number
 
+    readonly command: string
+
     readonly clientStorage: ClientStorageAPI
 
     readonly viewport: ViewportAPI
@@ -1213,6 +1231,8 @@ declare global {
     center: Vector
     zoom: number
     readonly bound: Rect
+    rulerVisible: boolean
+    layoutGridVisible: boolean
     scrollAndZoomIntoView(nodes: ReadonlyArray<BaseNode>): void
   }
 
@@ -1305,6 +1325,13 @@ declare global {
     fills: Paint[]
   }
 
+  interface ListStyle {
+    start: number
+    end: number
+    level: number
+    type: 'ORDERED' | 'BULLETED' | 'NONE'
+  }
+
   interface EffectStyle extends BaseStyle {
     type: 'EFFECT'
     effects: ReadonlyArray<Effect>
@@ -1780,6 +1807,7 @@ declare global {
   interface FrameNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'FRAME'
     clone(): FrameNode
+    resizeToFit(): void
   }
 
   interface GroupNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin {
@@ -1886,6 +1914,7 @@ declare global {
     textAutoResize: 'NONE' | 'WIDTH_AND_HEIGHT' | 'HEIGHT'
     paragraphSpacing: number
     readonly textStyles: ReadonlyArray<TextSegStyle>
+    readonly listStyles: ReadonlyArray<ListStyle>
     clone(): TextNode
 
     insertCharacters(start: number, characters: string): void
@@ -1912,6 +1941,7 @@ declare global {
     setRangeSuperLink(start: number, end: number, link: string | null): void
     setRangeHyperLink(start: number, end: number, hyperlink: Hyperlink | null): void
     setRangeTextCase(start: number, end: number, textCase: TextCase): void
+    setRangeListStyle(start: number, end: number, type: 'ORDERED' | 'BULLETED' | 'NONE'): void
   }
 
   interface ComponentNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
@@ -1921,6 +1951,7 @@ declare global {
     setVariantPropertyValues(property: Record<string, string>): void
     clone(): ComponentNode
     createInstance(): InstanceNode
+    resizeToFit(): void
   }
 
   interface ComponentSetNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
@@ -1932,6 +1963,7 @@ declare global {
     editVariantProperties(properties: Record<string, string>): void
     editVariantPropertyValues(properties: Record<string, { oldValue: string, newValue: string }>): void
     deleteVariantProperty(property: string): void
+    resizeToFit(): void
   }
 
   interface InstanceNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastergo/plugin-typings",
-  "version": "1.4.0",
+  "version": "1.6.1",
   "description": "MasterGo插件API声明文件",
   "main": "",
   "types": "dist/index.d.ts",
@@ -24,6 +24,10 @@
   ],
   "author": "MasterGo",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mastergo-design/plugin-typings"
+  },
   "directories": {
     "lib": "lib"
   },