@mastergo/plugin-typings 1.12.0 → 1.14.0

package/CHANGELOG.md

@@ -1,3 +1,37 @@
+# [1.14.0](https://github.com/mastergo-design/plugin-typings/compare/v1.13.0...v1.14.0) (2023-02-07)
+
+
+### Features
+
+* 增加异步导出接口exportAsync ([5327398](https://github.com/mastergo-design/plugin-typings/commit/532739851e5e0cc82ac0acbdc7195f7a780b354e))
+
+
+
+# [1.13.0](https://github.com/mastergo-design/plugin-typings/compare/v1.12.0...v1.13.0) (2023-01-12)
+
+
+### Bug Fixes
+
+* 修复组件图层clone方法返回值类型错误问题 ([3558202](https://github.com/mastergo-design/plugin-typings/commit/35582022c3f5d201559efbbeb1e452d5838eef15))
+* 修改错误componentPropertyReferences类型 ([dcdb0b8](https://github.com/mastergo-design/plugin-typings/commit/dcdb0b8a1fc22785c8bbf9add75b1a7b46215178))
+
+
+### Features
+
+* 补充组件属性类型 ([a58b2da](https://github.com/mastergo-design/plugin-typings/commit/a58b2da55d45c202ab4a593aa0aeb6d7e7feb844))
+* 导出设置增加useRenderBounds, 增加不同类型区分导出数据 ([852044d](https://github.com/mastergo-design/plugin-typings/commit/852044dfd9047cec5f9e2414b0bf2455728b439f))
+* 更改componentPropertyReferences类型 ([3e67ca1](https://github.com/mastergo-design/plugin-typings/commit/3e67ca1214cfee6838ab7188d40729d1154dbc46))
+* 更换子组件props命名 ([76a1b75](https://github.com/mastergo-design/plugin-typings/commit/76a1b75469cb769fe86638f7d412442f23423849))
+* 合并webp为image ([e4d1c13](https://github.com/mastergo-design/plugin-typings/commit/e4d1c133c566a2481799802cfb6991481e639cfa))
+* 合并webp为image ([627bfa0](https://github.com/mastergo-design/plugin-typings/commit/627bfa04da410b661936c115b210a6431528cd77))
+* 添加absoluteRenderBounds和absoluteBoundingBox接口 ([924b83a](https://github.com/mastergo-design/plugin-typings/commit/924b83a0d84896c05046bc83386570c039e502cc))
+* 文字样式增加fontName ([8d72a18](https://github.com/mastergo-design/plugin-typings/commit/8d72a1849ef6666622a6efb403f4648ccaaa8c2a))
+* 新增组件属性相关types ([a7f4e67](https://github.com/mastergo-design/plugin-typings/commit/a7f4e676f04f504d172402d74ccc8d5111867142))
+* 修改absoluteRenderBounds和absoluteBoundingBox返回类型 ([b90dd96](https://github.com/mastergo-design/plugin-typings/commit/b90dd96c99e392ba9bbdb54260c13573dd02ba28))
+* absoluteBoundingBox去除null返回值 ([7e903ef](https://github.com/mastergo-design/plugin-typings/commit/7e903ef72d059d0822ac6f1a6ad035e84392327d))
+
+
+
 # [1.12.0](https://github.com/mastergo-design/plugin-typings/compare/v1.11.0...v1.12.0) (2022-12-20)
 
 

package/dist/index.d.ts

@@ -157,18 +157,36 @@ declare global {
     type: 'SCALE' | 'WIDTH' | 'HEIGHT'
     value: number
   }
-  type ExportFileFormat = 'PNG' | 'JPG' | 'SVG' | 'PDF' | 'WEBP'
-  type ExportSettings = {
-    format: ExportFileFormat
-    constraint?: ExportSettingsConstraints
-    isSuffix?: boolean
-    fileName?: string
-    readonly useAbsoluteBounds?: boolean
+
+  interface ExportSettingsImage {
+    readonly format: 'JPG' | 'PNG' | 'WEBP'
+    readonly isSuffix?: boolean
+    readonly fileName?: string
+    readonly constraint?: ExportSettingsConstraints
+    readonly useAbsoluteBounds?: boolean  // defaults to false
+    readonly useRenderBounds?: boolean // default to true
+  }
+  interface ExportSettingsSVG {
+    readonly format: 'SVG'
+    readonly isSuffix?: boolean
+    readonly fileName?: string
   }
+  
+  interface ExportSettingsPDF {
+    readonly format: 'PDF'
+    readonly isSuffix?: string
+    readonly fileName?: string
+    readonly useAbsoluteBounds?: boolean // defaults to false
+    readonly useRenderBounds?: boolean // default to true
+  }
+  
+  type ExportSettings = ExportSettingsImage | ExportSettingsSVG | ExportSettingsPDF
+
 
   interface ExportMixin {
     exportSettings: ReadonlyArray<ExportSettings>
     export(settings?: ExportSettings): Uint8Array | string // Defaults to PNG format
+    exportAsync(settings?: ExportSettings): Promise<Uint8Array | string>
   }
 
   interface NotifyOptions {
@@ -177,8 +195,8 @@ declare global {
   }
 
   interface UIViewport extends Bound {
-    headerHeight: number
-    visible: boolean
+    readonly headerHeight: number
+    readonly visible: boolean
   }
   
   interface UIAPI {
@@ -261,6 +279,7 @@ declare global {
     letterSpacingUnit: NumValue['unit']
     textCase: TextCase
     lineHeight: LineHeight
+    fontName: FontName
   }
 
   interface FontAlias {
@@ -467,6 +486,11 @@ declare global {
   interface SceneNodeMixin {
     isVisible: boolean
     isLocked: boolean
+    componentPropertyReferences: {
+      isVisible?: string,
+      characters?: string,
+      mainComponent?: string
+    } | null   
   }
 
   interface ChildrenMixin<ChildrenNode = SceneNode> {
@@ -504,6 +528,8 @@ declare global {
   interface LayoutMixin {
     absoluteTransform: Transform
     relativeTransform: Transform
+    readonly absoluteRenderBounds: Bound | null
+    readonly absoluteBoundingBox: Bound
     bound: Bound
     x: number
     y: number
@@ -668,6 +694,8 @@ declare global {
   interface OpaqueNodeMixin extends BaseNodeMixin, SceneNodeMixin, ExportMixin {
     readonly absoluteTransform: Transform
     relativeTransform: Transform
+    readonly absoluteRenderBounds: Bound | null
+    readonly absoluteBoundingBox: Bound
     x: number
     y: number
     readonly width: number
@@ -917,16 +945,6 @@ declare global {
     setRangeTextStyleId(start: number, end: number, textStyleId: string): void
   }
 
-  interface ComponentNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin {
-    readonly type: 'COMPONENT'
-    readonly variantProperties: Array<VariantProperty> | undefined
-    setVariantPropertyValues(property: Record<string, string>): void
-    clone(): ComponentNode
-    createInstance(): InstanceNode
-    resizeToFit(): void
-  }
-
-
   type VariantMixin = {
     property: string
     type: 'variant'
@@ -938,10 +956,62 @@ declare global {
     value: string
   }
 
+  /**
+   * @deprecated
+   * 
+   */
   type ComponentPropertyDefinitions = Array<VariantMixin>
 
-  interface ComponentSetNode extends Omit<DefaultContainerMixin, 'appendChild' | 'insertChild'>, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin {
+  interface ComponentPropertiesMixin {
+    readonly componentPropertyValues: ComponentPropertyValues
+    addComponentProperty(
+      propertyName: string,
+      type: Exclude<ComponentPropertyType, 'VARIANT'>,
+      defaultValue: string | boolean,
+    ): string
+    editComponentProperty(
+      propertyId: string,
+      newValue: {
+        name?: string
+        defaultValue?: string | boolean
+      },
+    ): string
+    deleteComponentProperty(propertyId: string): void
+  }
+
+  type ComponentPropertyValues = Array<ComponentPropertyValue>
+
+  type ComponentPropertyValue = {
+    name: string
+    type: ComponentPropertyType
+    defaultValue: string | boolean
+    id?: string
+    variantOptions?: string[]
+  }
+
+  type ComponentPropertyType = 'BOOLEAN' | 'TEXT' | 'INSTANCE_SWAP' | 'VARIANT'
+
+  type ComponentProperties = {
+    name: string
+    id?: string
+    type: ComponentPropertyType
+    value: boolean | string
+  }
+
+  interface ComponentNode extends DefaultContainerMixin, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin, ComponentPropertiesMixin {
+    readonly type: 'COMPONENT'
+    readonly variantProperties: Array<VariantProperty> | undefined
+    setVariantPropertyValues(property: Record<string, string>): void
+    clone(): InstanceNode
+    createInstance(): InstanceNode
+    resizeToFit(): void
+  }
+
+  interface ComponentSetNode extends Omit<DefaultContainerMixin, 'appendChild' | 'insertChild'>, GeometryMixin, FrameContainerMixin, RectangleStrokeWeightMixin, PublishableMixin, ComponentPropertiesMixin {
     readonly type: 'COMPONENT_SET'
+    /**
+     * @deprecated
+     */
     readonly componentPropertyDefinitions: ComponentPropertyDefinitions
     clone(): ComponentSetNode
     createVariantComponent(): void
@@ -956,6 +1026,10 @@ declare global {
     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
+
     clone(): InstanceNode
     /**
      * this is an async func

package/package.json

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