@mastergo/plugin-typings 1.16.2 → 1.17.1

package/CHANGELOG.md

@@ -1,11 +1,32 @@
-## [1.16.2](https://github.com/mastergo-design/plugin-typings/compare/v1.16.1...v1.16.2) (2023-03-23)
+## [1.17.1](https://github.com/mastergo-design/plugin-typings/compare/v1.17.0...v1.17.1) (2023-03-30)
+
+
+### Bug Fixes
+
+* getSharedPluginDataKeys返回错误 ([cb9c3cd](https://github.com/mastergo-design/plugin-typings/commit/cb9c3cd15fede7584fe1b253b91fbc67bd1ed993))
+
+
+
+# [1.17.0](https://github.com/mastergo-design/plugin-typings/compare/v1.16.1...v1.17.0) (2023-03-30)
 
 
 ### Bug Fixes
 
+* 完善flatten返回值类型 ([687ff5d](https://github.com/mastergo-design/plugin-typings/commit/687ff5de547be6f6ccc6d2f9b5c50dcbb1c014c0))
+* 修复布尔组的childrenMixin的错误 ([25c6588](https://github.com/mastergo-design/plugin-typings/commit/25c6588c0a774733770a4eced4887a6f55024832))
 * 修复instance的swapComponent和detachInstance类型错误 ([c8aa208](https://github.com/mastergo-design/plugin-typings/commit/c8aa208700fc4f5323bffc41737199360ee13f6b))
+* userenderBounds注释错误 ([caae3fb](https://github.com/mastergo-design/plugin-typings/commit/caae3fbd654bfc970cedabc62bc1b548a78419f5))
 
 
+### Features
+
+* 实例切换首选项和公开嵌套实例 ([a821c55](https://github.com/mastergo-design/plugin-typings/commit/a821c55e7388286f9673da006659e51ea052883d))
+* 移除group和布尔组的约束属性 ([a636dd4](https://github.com/mastergo-design/plugin-typings/commit/a636dd4d7fc2bb9ba1dff8550e5acef9401c4605))
+
+## [1.16.2](https://github.com/mastergo-design/plugin-typings/compare/v1.16.1...v1.16.2) (2023-03-23)
+### Bug Fixes
+
+* 修复instance的swapComponent和detachInstance类型错误 ([c8aa208](https://github.com/mastergo-design/plugin-typings/commit/c8aa208700fc4f5323bffc41737199360ee13f6b))
 
 ## [1.16.1](https://github.com/mastergo-design/plugin-typings/compare/v1.16.0...v1.16.1) (2023-03-22)
 

package/dist/index.d.ts

@@ -89,7 +89,7 @@ declare global {
     subtract(children: SceneNode[]): BooleanOperationNode
     intersect(children: SceneNode[]): BooleanOperationNode
     exclude(children: SceneNode[]): BooleanOperationNode
-    flatten(nodes: SceneNode[]): PenNode
+    flatten(nodes: SceneNode[]): PenNode | null
 
     saveVersionHistoryAsync(desc: string): Promise<void>
 
@@ -167,7 +167,7 @@ declare global {
     readonly isSuffix?: boolean
     readonly fileName?: string
     readonly constraint?: ExportSettingsConstraints
-    readonly useAbsoluteBounds?: boolean  // defaults to false
+    readonly useAbsoluteBounds?: boolean  // defaults to true
     readonly useRenderBounds?: boolean // default to true
   }
   interface ExportSettingsSVG {
@@ -180,7 +180,7 @@ declare global {
     readonly format: 'PDF'
     readonly isSuffix?: string
     readonly fileName?: string
-    readonly useAbsoluteBounds?: boolean // defaults to false
+    readonly useAbsoluteBounds?: boolean // defaults to true
     readonly useRenderBounds?: boolean // default to true
   }
   
@@ -480,7 +480,7 @@ declare global {
     clearPluginData(): void
     getSharedPluginData(namespace: string, key: string): string
     setSharedPluginData(namespace: string, key: string, value: string): void
-    getSharedPluginDataKeys(namespace: string): void
+    getSharedPluginDataKeys(namespace: string): string[]
     removeSharedPluginData(namespace: string, key: string): void
     clearSharedPluginData(namespace: string): void
   }
@@ -781,11 +781,6 @@ declare global {
     resizeToFit(): void
   }
 
-  interface GroupNode extends DefaultContainerMixin, GeometryMixin {
-    readonly type: 'GROUP'
-    clone(): GroupNode
-  }
-
   interface RectangleNode
     extends DefaultShapeMixin,
     ConstraintMixin,
@@ -849,13 +844,22 @@ declare global {
 
   interface BooleanOperationNode
     extends DefaultShapeMixin,
-    Omit<ChildrenMixin, 'appendChild' | 'insertChild'>,
+    ChildrenMixin,
     CornerMixin {
     readonly type: 'BOOLEAN_OPERATION'
     booleanOperation: 'UNION' | 'INTERSECT' | 'SUBTRACT' | 'EXCLUDE'
     clone(): BooleanOperationNode
   }
 
+
+  interface GroupNode 
+  extends DefaultShapeMixin,
+  ChildrenMixin,  
+  CornerMixin {
+    readonly type: 'GROUP'
+    clone(): GroupNode
+  }
+
   interface TextRangeStyle {
     fontName: FontName
     fontSize: number
@@ -965,12 +969,14 @@ declare global {
       propertyName: string,
       type: Exclude<ComponentPropertyType, 'VARIANT'>,
       defaultValue: string | boolean,
+      options?: ComponentPropertyOptions,
     ): string
     editComponentProperty(
       propertyId: string,
       newValue: {
         name?: string
         defaultValue?: string | boolean
+        preferredValues?: InstanceSwapPreferredValue[]
       },
     ): string
     deleteComponentProperty(propertyId: string): void
@@ -984,15 +990,23 @@ declare global {
     defaultValue: string | boolean
     id?: string
     variantOptions?: string[]
+    preferredValues?: InstanceSwapPreferredValue[]
   }
 
   type ComponentPropertyType = 'BOOLEAN' | 'TEXT' | 'INSTANCE_SWAP' | 'VARIANT'
-
+  type InstanceSwapPreferredValue = {
+    type: 'COMPONENT' | 'COMPONENT_SET'
+    key: string
+  }
+  type ComponentPropertyOptions = {
+    preferredValues?: InstanceSwapPreferredValue[]
+  }
   type ComponentProperties = {
     name: string
     id?: string
     type: ComponentPropertyType
     value: boolean | string
+    preferredValues?: InstanceSwapPreferredValue[]
   }
 
   interface ComponentNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin, ComponentPropertiesMixin {
@@ -1022,11 +1036,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
+    
     clone(): InstanceNode
     /**
      * this is an async func

package/package.json

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