@mastergo/plugin-typings 1.8.0 → 1.9.0

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+# [1.9.0](https://github.com/mastergo-design/plugin-typings/compare/v1.8.0...v1.9.0) (2022-11-24)
+
+
+### Bug Fixes
+
+* 修复ComponentPropertyDefinitions类型不清晰的问题 ([dd8ad00](https://github.com/mastergo-design/plugin-typings/commit/dd8ad0049e2edfe48c18118991f15f0f97b90f87))
+* 修复variantProperties类型不清晰问题 ([1da5b1d](https://github.com/mastergo-design/plugin-typings/commit/1da5b1dc57f3ad8b2116523e03e62165084d0453))
+* 移除BooleanOperationNode, ComponentSetNode, InstanceNode无效的appendChild, insertChild方法 ([c3da0cd](https://github.com/mastergo-design/plugin-typings/commit/c3da0cdc00eb37728f816a05dbcd81fb4dd256b6))
+
+
+### Features
+
+* 添加flatten和rescale接口 ([dc87721](https://github.com/mastergo-design/plugin-typings/commit/dc87721478c725285e3e903beab045c6f175360c))
+* 图层新增翻转接口/新增findAllWithCriteria接口/全局创建组件和创建容器方法新增可选参数 ([a318458](https://github.com/mastergo-design/plugin-typings/commit/a318458714cadf0e1c16613c73b3d77f866a3b70))
+* 新增setRangeTextStyleId设置分段文字样式 ([7cd5e9c](https://github.com/mastergo-design/plugin-typings/commit/7cd5e9c59cc54a63f2c0a22cf992dcce5b2184ea))
+* 与group等接口统一类型 ([4107784](https://github.com/mastergo-design/plugin-typings/commit/410778431defb243d3cc3a191d5fb9790f5ea26e))
+* textNode增加setRangeFillStyleId ([f03314b](https://github.com/mastergo-design/plugin-typings/commit/f03314b1e32eb9c327b31ac487dbcb3148781da4))
+
+
+
 # [1.8.0](https://github.com/mastergo-design/plugin-typings/compare/v1.7.1...v1.8.0) (2022-11-18)
 
 

package/dist/index.d.ts

@@ -64,8 +64,8 @@ declare global {
     createStar(): StarNode
     createPen(): PenNode
     createText(): TextNode
-    createFrame(): FrameNode
-    createComponent(): ComponentNode
+    createFrame(children?: SceneNode[]): FrameNode
+    createComponent(children?: SceneNode[]): ComponentNode
     createPage(): PageNode
     createSlice(): SliceNode
     createConnector(): ConnectorNode
@@ -73,13 +73,18 @@ declare global {
 
     getHoverLayer(): PageNode | SceneNode
 
+    /**
+     * @deprecated
+     * This function is deprecated, please use viewport.layoutGridVisible instead.
+     */
     showGrid(show: boolean): void
 
-    group(children: ReadonlyArray<SceneNode>): GroupNode
-    union(children: ReadonlyArray<SceneNode>): BooleanOperationNode
-    subtract(children: ReadonlyArray<SceneNode>): BooleanOperationNode
-    intersect(children: ReadonlyArray<SceneNode>): BooleanOperationNode
-    exclude(children: ReadonlyArray<SceneNode>): BooleanOperationNode
+    group(children: SceneNode[]): GroupNode
+    union(children: SceneNode[]): BooleanOperationNode
+    subtract(children: SceneNode[]): BooleanOperationNode
+    intersect(children: SceneNode[]): BooleanOperationNode
+    exclude(children: SceneNode[]): BooleanOperationNode
+    flatten(nodes: SceneNode[]): PenNode
 
     saveVersionHistoryAsync(desc: string): Promise<void>
 
@@ -109,7 +114,7 @@ declare global {
     teamLibrary: TeamLibrary,
     importComponentByKeyAsync(ukey: string): Promise<ComponentNode>,
     importComponentSetByKeyAsync(ukey: string): Promise<ComponentSetNode>,
-    importStyleByKeyAsync(ukey: string): Promise<BaseStyle>,
+    importStyleByKeyAsync(ukey: string): Promise<Style>,
 
     hexToRGBA(hex: string): RGBA
     RGBAToHex(rgba: RGBA): string
@@ -128,7 +133,7 @@ declare global {
     readonly bound: Rect
     rulerVisible: boolean
     layoutGridVisible: boolean
-    scrollAndZoomIntoView(nodes: ReadonlyArray<BaseNode>): void
+    scrollAndZoomIntoView(nodes: SceneNode[]): void
   }
 
   interface ClientStorageAPI {
@@ -462,6 +467,7 @@ declare global {
 
     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>
   }
 
   interface ConstraintMixin {
@@ -475,6 +481,12 @@ declare global {
     height: number
   }
 
+  type ScaleCenter = 'TOPLEFT' | 'TOP' | 'TOPRIGHT' | 'LEFT' | 'CENTER' | 'RIGHT' | 'BOTTOMLEFT' | 'BOTTOM' | 'BOTTOMRIGHT'
+
+  interface ScaleOption {
+    scaleCenter?: ScaleCenter
+  }
+
   interface LayoutMixin {
     absoluteTransform: Transform
     relativeTransform: Transform
@@ -488,6 +500,8 @@ declare global {
     layoutPositioning: 'AUTO' | 'ABSOLUTE' // applicable only inside auto-layout frames
     alignSelf: 'STRETCH' | 'INHERIT' // applicable only inside auto-layout frames
     flexGrow: 0 | 1 // applicable only inside auto-layout frames
+    rescale(scale: number, scaleOption?: ScaleOption): void
+    flip(direction: 'VERTICAL' | 'HORIZONTAL'): void
   }
 
   interface BlendMixin {
@@ -682,6 +696,7 @@ declare global {
     
     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>
   }
 
   interface PageNode
@@ -795,7 +810,7 @@ declare global {
   interface BooleanOperationNode
     extends DefaultShapeMixin,
     FrameContainerMixin,
-    ChildrenMixin,
+    Omit<ChildrenMixin, 'appendChild' | 'insertChild'>,
     CornerMixin {
     readonly type: 'BOOLEAN_OPERATION'
     booleanOperation: 'UNION' | 'INTERSECT' | 'SUBTRACT' | 'EXCLUDE'
@@ -846,7 +861,7 @@ declare global {
     readonly hasMissingFont: boolean
     /**
      * @deprecated
-     * This attribute is deprecared, please use hyperlinks instead.
+     * This attribute is deprecated, please use hyperlinks instead.
      */
     readonly superlinks: Array<Superlink>
     readonly hyperlinks: Array<HyperlinkWithRange>
@@ -877,26 +892,43 @@ declare global {
     setRangeFills(start: number, end: number, paints: Paint[]): void
     /**
      * @deprecated
-     * This function is deprecared, please use setRangeHyperlink instead.
+     * This function is deprecated, please use setRangeHyperlink instead.
      */
     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
+
+    setRangeFillStyleId(start: number, end: number, fillStyleId: string): void
+    setRangeTextStyleId(start: number, end: number, textStyleId: string): void
   }
 
   interface ComponentNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin {
     readonly type: 'COMPONENT'
-    readonly variantProperties: Array<Record<string, string>>
+    readonly variantProperties: Array<VariantProperty> | undefined
     setVariantPropertyValues(property: Record<string, string>): void
     clone(): ComponentNode
     createInstance(): InstanceNode
     resizeToFit(): void
   }
 
-  interface ComponentSetNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin {
+
+  type VariantMixin = {
+    property: string
+    type: 'variant'
+    values: string[]
+  }
+
+  interface VariantProperty {
+    property: string
+    value: string
+  }
+
+  type ComponentPropertyDefinitions = Array<VariantMixin>
+
+  interface ComponentSetNode extends Omit<DefaultContainerMixin, 'appendChild' | 'insertChild'>, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin {
     readonly type: 'COMPONENT_SET'
-    readonly componentPropertyDefinitions: Array<Record<string, Array<string> | string>>
+    readonly componentPropertyDefinitions: ComponentPropertyDefinitions
     clone(): ComponentSetNode
     createVariantComponent(): void
     createVariantProperties(properties: Array<string>): void
@@ -906,9 +938,9 @@ declare global {
     resizeToFit(): void
   }
 
-  interface InstanceNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
+  interface InstanceNode extends Omit<DefaultContainerMixin, 'appendChild' | 'insertChild'>, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin {
     readonly type: 'INSTANCE'
-    readonly variantProperties: Array<Record<string, string>>
+    readonly variantProperties: Array<VariantProperty> | undefined
     setVariantPropertyValues(property: Record<string, string>): void
     clone(): InstanceNode
     /**
@@ -970,6 +1002,11 @@ declare global {
     setRangeFills(start: number, end: number, paints: Paint[]): 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
+
+    setRangeFillStyleId(start: number, end: number, fillStyleId: string): void
+    setRangeTextStyleId(start: number, end: number, textStyleId: string): void
   }
 
 

package/package.json

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