@mastergo/plugin-typings 1.5.0 → 1.7.0

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

@@ -25,36 +25,6 @@ declare global {
     getBytesAsync(): Promise<Uint8Array>
   }
 
-  enum LinkFlagEnum {
-    CURRPAGE = 'currPage',
-    OTHERPAGE = 'otherPage',
-    PROTOTYPE = 'prototype',
-    OUTFILE = 'outFile',
-    OWNWEBSITE = 'ownWebsite',
-    OTHERLINK = 'otherLink',
-  }
-
-  interface Superlink {
-    start: number
-    end: number
-    superlink: {
-      layerId?: string
-      link: string
-      linkFlag: LinkFlagEnum 
-      pageId: string
-    }
-  }
-
-  interface Hyperlink {
-    type: 'PAGE' | 'NODE' | 'URL',
-    value: string
-  }
-  interface HyperlinkWithRange {
-    start: number
-    end: number
-    hyperlink: Hyperlink
-  }
-
   type PluginEventType = 'selectionchange' | 'currentpagechange' | 'close' | 'themechange' | 'drop' | 'run'
   type ThemeColor = 'dark' | 'light'
 
@@ -133,6 +103,14 @@ declare global {
     createImage(imageData: Uint8Array): Promise<Image>
     getImageByHref(href: string): Image
 
+    /**
+     * 订阅团队库数据
+     */
+    teamLibrary: TeamLibrary,
+    importComponentByKeyAsync(ukey: string): Promise<ComponentNode>,
+    importComponentSetByKeyAsync(ukey: string): Promise<ComponentSetNode>,
+    importStyleByKeyAsync(ukey: string): Promise<BaseStyle>,
+
     hexToRGBA(hex: string): RGBA
     RGBAToHex(rgba: RGBA): string
   }
@@ -148,6 +126,8 @@ declare global {
     center: Vector
     zoom: number
     readonly bound: Rect
+    rulerVisible: boolean
+    layoutGridVisible: boolean
     scrollAndZoomIntoView(nodes: ReadonlyArray<BaseNode>): void
   }
 
@@ -160,6 +140,8 @@ declare global {
     width?: number
     height?: number
     visible?: boolean
+    x?: number | string
+    y?: number | string
   }
 
   interface ExportSettingsConstraints {
@@ -177,7 +159,7 @@ declare global {
 
   interface ExportMixin {
     exportSettings: ReadonlyArray<ExportSettings>
-    export(settings?: ExportSettings): Promise<Uint8Array | string> // Defaults to PNG format
+    export(settings?: ExportSettings): Uint8Array | string // Defaults to PNG format
   }
 
   interface NotifyOptions {
@@ -194,18 +176,20 @@ declare global {
     postMessage(pluginMessage: any, origin?: string): void
     onmessage: ((pluginMessage: any, origin: string) => void) | undefined
   }
-
-  /// /////////////////////////////////////////////////////////////////////////////
-  // Styles
+  type PublishStatus = 'UNPUBLISHED' | 'CURRENT' | 'CHANGED'
   interface PublishableMixin {
     description: string
     /**
-     * 是否为团队库样式
+     * 是否为团队库组件/样式
     */
     readonly isExternal: boolean
     readonly ukey: string
+    readonly publishStatus: PublishStatus
   }
 
+  /// /////////////////////////////////////////////////////////////////////////////
+  // Styles
+
   type StyleType = 'PAINT' | 'TEXT' | 'EFFECT' | 'GRID'
 
   interface BaseStyle extends PublishableMixin {
@@ -240,6 +224,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>
@@ -248,12 +239,11 @@ declare global {
   interface TextStyle extends BaseStyle {
     type: 'TEXT'
     decoration: TextDecoration
-    description: string
     fontSize: number
-    isExternal: boolean
     letterSpacing: number
     letterSpacingUnit: NumValue['unit']
     textCase: TextCase
+    lineHeight: LineHeight
   }
 
   interface FontAlias {
@@ -439,7 +429,7 @@ declare global {
   interface BaseNodeMixin {
     readonly id: string
     readonly parent: (BaseNode & ChildrenMixin) | void
-    name: string // Note: setting this also sets \`autoRename\` to false on TextNodes
+    name: string
     removed: boolean
     remove(): void
     getPluginData(key: string): string
@@ -681,17 +671,29 @@ declare global {
   /// /////////////////////////////////////////////////////////////////////////////
   // Nodes
 
-  interface DocumentNode extends ChildrenMixin<PageNode> {
+  interface DocumentNode {
     readonly type: 'DOCUMENT'
-    currentPage: PageNode
     name: string
+
+    currentPage: PageNode
+
+    readonly children: ReadonlyArray<PageNode>
+    
+    findAll(callback?: (node: SceneNode) => boolean): ReadonlyArray<SceneNode>
+    findOne(callback: (node: SceneNode) => boolean): SceneNode | null
   }
 
   interface PageNode
-    extends BaseNodeMixin,
+    extends
     ChildrenMixin<SceneNode> {
     readonly type: 'PAGE'
 
+    readonly id: string
+    readonly parent: DocumentNode
+    name: string
+    removed: boolean
+    remove(): void
+
     selection: ReadonlyArray<SceneNode>
     clone(): PageNode
     /**
@@ -715,6 +717,7 @@ declare global {
   interface FrameNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'FRAME'
     clone(): FrameNode
+    resizeToFit(): void
   }
 
   interface GroupNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin {
@@ -806,6 +809,36 @@ declare global {
     letterSpacing: LetterSpacing
   }
 
+  enum LinkFlagEnum {
+    CURRPAGE = 'currPage',
+    OTHERPAGE = 'otherPage',
+    PROTOTYPE = 'prototype',
+    OUTFILE = 'outFile',
+    OWNWEBSITE = 'ownWebsite',
+    OTHERLINK = 'otherLink',
+  }
+
+  interface Superlink {
+    start: number
+    end: number
+    superlink: {
+      layerId?: string
+      link: string
+      linkFlag: LinkFlagEnum 
+      pageId: string
+    }
+  }
+
+  interface Hyperlink {
+    type: 'PAGE' | 'NODE' | 'URL',
+    value: string
+  }
+  interface HyperlinkWithRange {
+    start: number
+    end: number
+    hyperlink: Hyperlink
+  }
+
   interface TextNode extends DefaultShapeMixin, ConstraintMixin {
     readonly type: 'TEXT'
     characters: string
@@ -821,6 +854,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
@@ -847,18 +881,19 @@ 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 {
+  interface ComponentNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin {
     readonly type: 'COMPONENT'
     readonly variantProperties: Array<Record<string, string>>
-    description: string
     setVariantPropertyValues(property: Record<string, string>): void
     clone(): ComponentNode
     createInstance(): InstanceNode
+    resizeToFit(): void
   }
 
-  interface ComponentSetNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
+  interface ComponentSetNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin {
     readonly type: 'COMPONENT_SET'
     readonly componentPropertyDefinitions: Array<Record<string, Array<string> | string>>
     clone(): ComponentSetNode
@@ -867,6 +902,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 {
@@ -1025,6 +1061,34 @@ declare global {
     dropMetadata?: any
   }
 
+  interface TeamLibraryComponent {
+    readonly id: string;
+    readonly name: string;
+    readonly ukey: string;
+    readonly description: string;
+    readonly type: "COMPONENT" | 'COMPONENT_SET'
+  }
+
+  interface TeamLibraryStyle {
+    readonly id: string;
+    readonly name: string;
+    readonly ukey: string;
+    readonly description: string;
+    readonly type: StyleType;
+  }
+
+  type TeamLibrary = ReadonlyArray<{
+    readonly name: string;
+    readonly id: string;
+    readonly componentList: TeamLibraryComponent[]
+    readonly style: {
+      paints: ReadonlyArray<TeamLibraryStyle>
+      effects: ReadonlyArray<TeamLibraryStyle>
+      texts: ReadonlyArray<TeamLibraryStyle>
+      grids: ReadonlyArray<TeamLibraryStyle>
+    }
+  }>
+
   type BaseNode = DocumentNode | PageNode | SceneNode
 
   /**
@@ -1094,36 +1158,6 @@ declare global {
     getBytesAsync(): Promise<Uint8Array>
   }
 
-  enum LinkFlagEnum {
-    CURRPAGE = 'currPage',
-    OTHERPAGE = 'otherPage',
-    PROTOTYPE = 'prototype',
-    OUTFILE = 'outFile',
-    OWNWEBSITE = 'ownWebsite',
-    OTHERLINK = 'otherLink',
-  }
-
-  interface Superlink {
-    start: number
-    end: number
-    superlink: {
-      layerId?: string
-      link: string
-      linkFlag: LinkFlagEnum 
-      pageId: string
-    }
-  }
-
-  interface Hyperlink {
-    type: 'PAGE' | 'NODE' | 'URL',
-    value: string
-  }
-  interface HyperlinkWithRange {
-    start: number
-    end: number
-    hyperlink: Hyperlink
-  }
-
   type PluginEventType = 'selectionchange' | 'currentpagechange' | 'close' | 'themechange' | 'drop' | 'run'
   type ThemeColor = 'dark' | 'light'
 
@@ -1202,6 +1236,14 @@ declare global {
     createImage(imageData: Uint8Array): Promise<Image>
     getImageByHref(href: string): Image
 
+    /**
+     * 订阅团队库数据
+     */
+    teamLibrary: TeamLibrary,
+    importComponentByKeyAsync(ukey: string): Promise<ComponentNode>,
+    importComponentSetByKeyAsync(ukey: string): Promise<ComponentSetNode>,
+    importStyleByKeyAsync(ukey: string): Promise<BaseStyle>,
+
     hexToRGBA(hex: string): RGBA
     RGBAToHex(rgba: RGBA): string
   }
@@ -1217,6 +1259,8 @@ declare global {
     center: Vector
     zoom: number
     readonly bound: Rect
+    rulerVisible: boolean
+    layoutGridVisible: boolean
     scrollAndZoomIntoView(nodes: ReadonlyArray<BaseNode>): void
   }
 
@@ -1229,6 +1273,8 @@ declare global {
     width?: number
     height?: number
     visible?: boolean
+    x?: number | string
+    y?: number | string
   }
 
   interface ExportSettingsConstraints {
@@ -1246,7 +1292,7 @@ declare global {
 
   interface ExportMixin {
     exportSettings: ReadonlyArray<ExportSettings>
-    export(settings?: ExportSettings): Promise<Uint8Array | string> // Defaults to PNG format
+    export(settings?: ExportSettings): Uint8Array | string // Defaults to PNG format
   }
 
   interface NotifyOptions {
@@ -1263,18 +1309,20 @@ declare global {
     postMessage(pluginMessage: any, origin?: string): void
     onmessage: ((pluginMessage: any, origin: string) => void) | undefined
   }
-
-  /// /////////////////////////////////////////////////////////////////////////////
-  // Styles
+  type PublishStatus = 'UNPUBLISHED' | 'CURRENT' | 'CHANGED'
   interface PublishableMixin {
     description: string
     /**
-     * 是否为团队库样式
+     * 是否为团队库组件/样式
     */
     readonly isExternal: boolean
     readonly ukey: string
+    readonly publishStatus: PublishStatus
   }
 
+  /// /////////////////////////////////////////////////////////////////////////////
+  // Styles
+
   type StyleType = 'PAINT' | 'TEXT' | 'EFFECT' | 'GRID'
 
   interface BaseStyle extends PublishableMixin {
@@ -1309,6 +1357,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>
@@ -1317,12 +1372,11 @@ declare global {
   interface TextStyle extends BaseStyle {
     type: 'TEXT'
     decoration: TextDecoration
-    description: string
     fontSize: number
-    isExternal: boolean
     letterSpacing: number
     letterSpacingUnit: NumValue['unit']
     textCase: TextCase
+    lineHeight: LineHeight
   }
 
   interface FontAlias {
@@ -1508,7 +1562,7 @@ declare global {
   interface BaseNodeMixin {
     readonly id: string
     readonly parent: (BaseNode & ChildrenMixin) | void
-    name: string // Note: setting this also sets \`autoRename\` to false on TextNodes
+    name: string
     removed: boolean
     remove(): void
     getPluginData(key: string): string
@@ -1750,17 +1804,29 @@ declare global {
   /// /////////////////////////////////////////////////////////////////////////////
   // Nodes
 
-  interface DocumentNode extends ChildrenMixin<PageNode> {
+  interface DocumentNode {
     readonly type: 'DOCUMENT'
-    currentPage: PageNode
     name: string
+
+    currentPage: PageNode
+
+    readonly children: ReadonlyArray<PageNode>
+    
+    findAll(callback?: (node: SceneNode) => boolean): ReadonlyArray<SceneNode>
+    findOne(callback: (node: SceneNode) => boolean): SceneNode | null
   }
 
   interface PageNode
-    extends BaseNodeMixin,
+    extends
     ChildrenMixin<SceneNode> {
     readonly type: 'PAGE'
 
+    readonly id: string
+    readonly parent: DocumentNode
+    name: string
+    removed: boolean
+    remove(): void
+
     selection: ReadonlyArray<SceneNode>
     clone(): PageNode
     /**
@@ -1784,6 +1850,7 @@ declare global {
   interface FrameNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'FRAME'
     clone(): FrameNode
+    resizeToFit(): void
   }
 
   interface GroupNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin {
@@ -1875,6 +1942,36 @@ declare global {
     letterSpacing: LetterSpacing
   }
 
+  enum LinkFlagEnum {
+    CURRPAGE = 'currPage',
+    OTHERPAGE = 'otherPage',
+    PROTOTYPE = 'prototype',
+    OUTFILE = 'outFile',
+    OWNWEBSITE = 'ownWebsite',
+    OTHERLINK = 'otherLink',
+  }
+
+  interface Superlink {
+    start: number
+    end: number
+    superlink: {
+      layerId?: string
+      link: string
+      linkFlag: LinkFlagEnum 
+      pageId: string
+    }
+  }
+
+  interface Hyperlink {
+    type: 'PAGE' | 'NODE' | 'URL',
+    value: string
+  }
+  interface HyperlinkWithRange {
+    start: number
+    end: number
+    hyperlink: Hyperlink
+  }
+
   interface TextNode extends DefaultShapeMixin, ConstraintMixin {
     readonly type: 'TEXT'
     characters: string
@@ -1890,6 +1987,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
@@ -1916,18 +2014,19 @@ 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 {
+  interface ComponentNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin {
     readonly type: 'COMPONENT'
     readonly variantProperties: Array<Record<string, string>>
-    description: string
     setVariantPropertyValues(property: Record<string, string>): void
     clone(): ComponentNode
     createInstance(): InstanceNode
+    resizeToFit(): void
   }
 
-  interface ComponentSetNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
+  interface ComponentSetNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin {
     readonly type: 'COMPONENT_SET'
     readonly componentPropertyDefinitions: Array<Record<string, Array<string> | string>>
     clone(): ComponentSetNode
@@ -1936,6 +2035,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 {
@@ -2094,6 +2194,34 @@ declare global {
     dropMetadata?: any
   }
 
+  interface TeamLibraryComponent {
+    readonly id: string;
+    readonly name: string;
+    readonly ukey: string;
+    readonly description: string;
+    readonly type: "COMPONENT" | 'COMPONENT_SET'
+  }
+
+  interface TeamLibraryStyle {
+    readonly id: string;
+    readonly name: string;
+    readonly ukey: string;
+    readonly description: string;
+    readonly type: StyleType;
+  }
+
+  type TeamLibrary = ReadonlyArray<{
+    readonly name: string;
+    readonly id: string;
+    readonly componentList: TeamLibraryComponent[]
+    readonly style: {
+      paints: ReadonlyArray<TeamLibraryStyle>
+      effects: ReadonlyArray<TeamLibraryStyle>
+      texts: ReadonlyArray<TeamLibraryStyle>
+      grids: ReadonlyArray<TeamLibraryStyle>
+    }
+  }>
+
   type BaseNode = DocumentNode | PageNode | SceneNode
 
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastergo/plugin-typings",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "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"
   },