@mastergo/plugin-typings 2.15.1 → 2.16.0

package/dist/index.d.ts

@@ -1095,231 +1095,6 @@ declare global {
 
   type PluginEventType = keyof MGEventCallbackMap
 
-  interface VariableAPI {
-    // --- Collection ---
-    createCollection(name?: string): Promise<Collection | null>
-    getCollections(includeExternal?: boolean): Collection[]
-    getCollectionById(id?: string): Collection | null
-    deleteCollection(collectionId: string): void
-    renameCollection(collectionId: string, name: string): void
-    moveCollection(
-      collectionId: string,
-      options?: { afterId?: string; index?: number }
-    ): void
-
-    // --- Mode ---
-    getModes(collectionId?: string): CollectionMode[]
-    getModeById(
-      collectionId?: string,
-      modeId?: string
-    ): CollectionMode | null
-    addMode(
-      collectionId: string,
-      name?: string
-    ): Promise<CollectionMode | null>
-    renameMode(collectionId: string, modeId: string, name: string): void
-    deleteMode(collectionId: string, modeId: string): void
-    setVariableMode(collectionId: string, modeId: string): void
-    setPageVariableMode(
-      collectionId: string,
-      modeId: string,
-      pageId?: string
-    ): void
-
-    // --- Group ---
-    getGroupList(collectionId?: string): GroupNode[]
-    createGroup(
-      collectionId: string,
-      variableIds: string[],
-      groupName?: string
-    ): void
-    addVariablesToGroup(
-      collectionId: string,
-      groupPath: string,
-      variableIds: string[]
-    ): void
-    removeVariablesFromGroup(
-      collectionId: string,
-      groupPath: string,
-      variableIds: string[]
-    ): void
-    disbandGroup(
-      collectionId: string,
-      groupPath?: string,
-      variableIds?: string[]
-    ): void
-    renameGroup(
-      collectionId: string,
-      newName: string,
-      groupPath?: string,
-      variableIds?: string[]
-    ): void
-    deleteGroup(
-      collectionId: string,
-      groupPath?: string,
-      variableIds?: string[]
-    ): void
-
-    // --- Variable ---
-    createVariable(options: {
-      name: string
-      type: VariableType
-      value?: any
-      description?: string
-      collectionId?: string
-    }): Promise<Variable | null>
-    getVariableById(id: string): Variable | null
-    getVariables(options?: {
-      collectionId?: string
-      groupPath?: string
-      type?: VariableType
-      scopeType?: string
-    }): Variable[]
-    setVariableReference(options: {
-      id: string
-      reference: string | object
-      modeId?: string
-      index?: string
-      textProperty?: string
-      strokeProperty?: string
-      radiusProperty?: string
-      paddingProperty?: string
-      gridProperty?: string
-      effectProperty?: string
-    }): void
-    unlinkVariable(options: {
-      id: string
-      modeId?: string
-    }): Promise<void>
-    renameVariable(variableId: string, name: string): void
-    setVariableValue(options: {
-      id: string
-      value: any
-      modeId: string
-    }): Variable | null
-    addVariableValue(options: {
-      id: string
-      value?: any
-      modeId: string
-    }): Variable | null
-    deleteVariableValue(options: {
-      id: string
-      index: string | string[]
-      modeId: string
-    }): Variable | null
-    deleteVariable(variableId: string): void
-    moveVariable(
-      variableId: string,
-      options?: { afterId?: string; index?: number }
-    ): Promise<void>
-
-    // --- Variable Description / Alias ---
-    getVariableDescription(variableId: string): string | null
-    setVariableDescription(
-      variableId: string,
-      value: string
-    ): Promise<Variable | null>
-    resetVariableDescription(
-      variableId: string
-    ): Promise<Variable | null>
-    getVariableAlias(variableId: string): string | null
-    setVariableAlias(
-      variableId: string,
-      value: string
-    ): Promise<Variable | null>
-    resetVariableAlias(variableId: string): Promise<Variable | null>
-
-    // --- Component Property Variable ---
-    setVariableInComponent(options: {
-      id: string
-      propertyId: string
-      type: 'BOOLEAN' | 'CONTENT'
-    }): void
-    unlinkVariableInComponent(options: {
-      propertyId: string
-      type: 'BOOLEAN' | 'CONTENT'
-    }): void
-    createVariableInComponent(options: {
-      name: string
-      description?: string
-      collectionId?: string
-      layerId: string
-      type: 'BOOLEAN' | 'CONTENT'
-      value?: any
-    }): Promise<string | null>
-
-    // --- Layer Property Variable ---
-    createVariableInLayer(options: {
-      name: string
-      description?: string
-      collectionId?: string
-      layerId: string
-      value?: any
-      strokeProperty?: string
-      radiusProperty?: string
-      paddingProperty?: string
-      dimensionProperty?: string
-      baseProperty?: string
-      effectProperty?: string
-      gridProperty?: string
-      textProperty?: string
-      index?: number
-    }): Promise<Variable | null>
-    setVariableReferenceInLayer(options: {
-      id: string
-      layerId: string
-      strokeProperty?: string
-      radiusProperty?: string
-      paddingProperty?: string
-      dimensionProperty?: string
-      baseProperty?: string
-      effectProperty?: string
-      gridProperty?: string
-      textProperty?: string
-      index?: number
-    }): Promise<void>
-    unlinkVariableReferenceInLayer(options: {
-      layerId: string
-      strokeProperty?: string
-      radiusProperty?: string
-      paddingProperty?: string
-      dimensionProperty?: string
-      baseProperty?: string
-      effectProperty?: string
-      gridProperty?: string
-      textProperty?: string
-      index?: number
-    }): Promise<void>
-
-    // --- Variable Code Syntax ---
-    getCodeSyntax(variableId: string): VariableCodeSyntax | null
-    setCodeSyntax(
-      variableId: string,
-      codeSyntax: { web?: string; android?: string; ios?: string }
-    ): Promise<Variable | null>
-    resetCodeSyntax(
-      variableId: string,
-      platform?: string
-    ): Promise<Variable | null>
-
-    // --- Variable Scopes ---
-    getVariableScopes(variableId: string): ScopeName[]
-    setVariableScopes(
-      variableId: string,
-      scopes: ScopeName[]
-    ): Promise<Variable | null>
-
-    // --- Variable Indexes ---
-    getVariableIndexes(
-      variableId: string,
-      modeId?: string
-    ): string[]
-
-    // --- Font ---
-    getFontFamilies(): FontFamilyInfo[]
-    getFontWeights(fontFamily: string): FontWeightInfo[]
-  }
-
   interface PluginAPI {
     readonly document: DocumentNode
 
@@ -1450,14 +1225,12 @@ declare global {
      * @param type NodeStyleType
      * @param styleName
      * @param description optional
-     * @param collectionId optional
      */
     createStyleByLayer<T extends NodeStyleType>(
       layerId: string,
       type: T,
       styleName: string,
-      description?: string,
-      collectionId?: string
+      description?: string
     ): NodeStyleReturnType<T>
 
     /**
@@ -1466,13 +1239,11 @@ declare global {
      * @param type styleType
      * @param styleName
      * @param description optional
-     * @param collectionId optional
      */
     createStyle<T extends StyleType>(
       type: T,
       styleName: string,
-      description?: string,
-      collectionId?: string
+      description?: string
     ): StyleReturnType<T>
     /**
      * 创建某一个样式的副本
@@ -1496,21 +1267,10 @@ declare global {
     getLocalPaddingStyles(): PaddingStyle[]
     getLocalSpacingStyles(): SpacingStyle[]
 
-    readonly variables: VariableAPI
-
     listAvailableFontsAsync(): Promise<Font[]>
     loadFontAsync(fontName: FontName): Promise<boolean>
     createImage(imageData: Uint8Array, isSync?: boolean): Promise<Image>
     getImageByHref(href: string): Image
-    /**
-     * 导出多个图层组成的png图片, 可过滤图层id，设置导出图片的缩放倍率
-     */
-    exportPng(params: GlobalExportPngSetting): string;
-    /**
-     * 导出多个图层组成的svg图片
-     * @param layerIds 图层id数组
-     */
-    exportSvgByLayerIds(layerIds: string[]): string
 
     getTeamLibraryAsync(): Promise<TeamLibrary>
     importComponentByKeyAsync(ukey: string): Promise<ComponentNode>
@@ -1537,12 +1297,6 @@ declare global {
     ) => void
   }
 
-  interface GlobalExportPngSetting { 
-    ids?: string[];
-    filterIds?: string[];
-    scale?: number;
-  }
-
   interface User {
     id: string | null
     name: string | 'Anonymous'
@@ -1632,7 +1386,6 @@ declare global {
     exportSettings: ReadonlyArray<ExportSettings>
     export(settings?: ExportSettings): Uint8Array | string // Defaults to PNG format
     exportAsync(settings?: ExportSettings): Promise<Uint8Array | string>
-    exportPng(settings?: Omit<GlobalExportPngSetting, 'ids'>): string
   }
 
   interface NotifyOptions {
@@ -1731,10 +1484,6 @@ declare global {
     | 'CORNER_RADIUS'
     | 'PADDING'
     | 'SPACING'
-    | 'NUMBER'
-    | 'STRING'
-    | 'BOOLEAN'
-    | 'COLOR'
   type NodeStyleType =
     | 'fill'
     | 'strokeFill'
@@ -1742,106 +1491,6 @@ declare global {
     | 'cornerRadius'
     | 'padding'
     | 'spacing'
-    | 'effect'
-    | 'text'
-    | 'grid'
-
-  // #region Variable / Collection / Mode / Group types
-
-  type VariableType =
-    | 'STRING'
-    | 'BOOLEAN'
-    | 'COLOR'
-    | 'NUMBER'
-    | 'PAINT'
-    | 'TEXT'
-    | 'EFFECT'
-    | 'GRID'
-    | 'STROKE_WIDTH'
-    | 'CORNER_RADIUS'
-    | 'PADDING'
-    | 'SPACING'
-
-  type ScopeName =
-    | 'all'
-    | 'fill'
-    | 'fillAll'
-    | 'shapeFill'
-    | 'textFill'
-    | 'stroke'
-    | 'effect'
-    | 'grid'
-    | 'widthHeight'
-    | 'cornerRadius'
-    | 'opacity'
-    | 'layoutSpacing'
-    | 'layoutPadding'
-    | 'fontSize'
-    | 'fontWeight'
-    | 'textLineHeight'
-    | 'textLetterSpacing'
-    | 'textParagraphSpacing'
-    | 'fontFamily'
-    | 'textContent'
-
-  interface VariableCodeSyntax {
-    readonly web?: string
-    readonly android?: string
-    readonly ios?: string
-  }
-
-  interface Variable {
-    readonly id: string
-    readonly name: string
-    readonly description: string
-    readonly alias: string
-    readonly type: VariableType
-    readonly collectionId: string
-    readonly isExternal: boolean
-    readonly supportScope: boolean
-    readonly codeSyntax?: VariableCodeSyntax
-    readonly scopes?: ReadonlyArray<ScopeName>
-    readonly modes: Record<string, ReadonlyArray<any>>
-  }
-
-  interface Collection {
-    readonly id: string
-    readonly name: string
-    readonly isExternal: boolean
-    readonly modes: ReadonlyArray<CollectionMode>
-  }
-
-  interface CollectionMode {
-    readonly id: string
-    readonly name: string
-    readonly collectionId: string
-  }
-
-  interface GroupNode {
-    readonly id: string
-    readonly name: string
-    readonly currentPath?: string
-    readonly level: number
-    readonly isLeaf: boolean
-    readonly children?: ReadonlyArray<GroupNode>
-  }
-
-  interface FontFamilyInfo {
-    readonly family: string
-    readonly label: string
-    readonly lang: string
-    readonly isVariable: boolean
-  }
-
-  interface FontWeightInfo {
-    readonly postscriptName: string
-    readonly label: string
-    readonly style: string
-    readonly weight: number
-    readonly slant: number
-  }
-
-  // #endregion
 
   interface BaseStyle extends Omit<PublishableMixin, 'documentationLinks'> {
     readonly id: string
@@ -1942,7 +1591,6 @@ declare global {
     | CornerRadiusStyle
     | PaddingStyle
     | SpacingStyle
-    | Variable
 
   /// /////////////////////////////////////////////////////////////////////////////
   // Datatypes
@@ -2956,7 +2604,6 @@ declare global {
      */
     id: string
     description?: string
-    collectionId?: string
   }
 
   interface FlowStartingPoint {
@@ -3100,10 +2747,6 @@ declare global {
       cornerRadiuses: ReadonlyArray<TeamLibraryStyle>
       paddings: ReadonlyArray<TeamLibraryStyle>
       spacings: ReadonlyArray<TeamLibraryStyle>
-      numbers: ReadonlyArray<TeamLibraryStyle>
-      strings: ReadonlyArray<TeamLibraryStyle>
-      bools: ReadonlyArray<TeamLibraryStyle>
-      colors: ReadonlyArray<TeamLibraryStyle>
     }
   }>
 
@@ -3296,8 +2939,6 @@ declare global {
     ? PaddingStyle
     : T extends 'SPACING'
     ? SpacingStyle
-    : T extends 'NUMBER' | 'STRING' | 'BOOLEAN' | 'COLOR'
-    ? Variable
     : never
 
   type NodeStyleReturnType<T extends NodeStyleType> = T extends 'fill'
@@ -3312,11 +2953,5 @@ declare global {
     ? PaddingStyle
     : T extends 'spacing'
     ? SpacingStyle
-    : T extends 'effect'
-    ? EffectStyle
-    : T extends 'text'
-    ? TextStyle
-    : T extends 'grid'
-    ? GridStyle
     : never
 }

package/package.json

@@ -1,15 +1,14 @@
 {
   "name": "@mastergo/plugin-typings",
-  "version": "2.15.1",
+  "version": "2.16.0",
   "description": "MasterGo插件API声明文件",
-  "type": "module",
   "main": "",
   "types": "dist/index.d.ts",
   "scripts": {
     "prepare": "husky install",
     "dev": "rollup -c --environment NODE_ENV=development",
     "build": "rollup -c --environment NODE_ENV=production",
-    "release": "node scripts/release.cjs",
+    "release": "node scripts/release.js",
     "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
     "commit": "git-cz"
   },
@@ -27,34 +26,35 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/mastergo-design/plugin-typings.git"
+    "url": "https://github.com/mastergo-design/plugin-typings"
   },
   "directories": {
     "lib": "lib"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.0.0",
-    "@commitlint/config-conventional": "^17.0.0",
-    "@rollup/plugin-commonjs": "^29.0.2",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^15.2.0",
+    "@rollup/plugin-commonjs": "^20.0.0",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.0.4",
     "chalk": "^4.1.2",
-    "commitizen": "^4.2.4",
-    "conventional-changelog-cli": "^3.0.0",
-    "csstype": "^3.1.3",
-    "cz-conventional-changelog": "^3.3.0",
+    "conventional-changelog-cli": "^2.1.1",
     "execa": "^5.1.1",
     "husky": "^7.0.2",
     "inquirer": "^8.0.0",
     "inquirer-autocomplete-prompt": "^2.0.0",
     "lint-staged": "^11.1.2",
     "prettier": "^2.4.1",
-    "rollup": "^4.59.0",
-    "rollup-plugin-dts": "^6.4.0",
-    "rollup-plugin-typescript2": "^0.36.0",
+    "rollup": "^2.56.3",
+    "rollup-plugin-dts": "^4.0.0",
+    "rollup-plugin-polyfill-node": "^0.7.0",
+    "rollup-plugin-typescript2": "^0.30.0",
     "semver": "^7.3.5",
     "shelljs": "^0.8.5",
-    "typescript": "^5.9.3"
+    "typescript": "^4.4.3",
+    "@commitlint/cli": "^17.0.0",
+    "@commitlint/config-conventional": "^17.0.0",
+    "commitizen": "^4.2.4",
+    "cz-conventional-changelog": "^3.3.0",
+    "csstype": "^3.1.3"
   },
   "lint-staged": {
     "*.js": [
@@ -68,6 +68,5 @@
     "commitizen": {
       "path": "cz-conventional-changelog"
     }
-  },
-  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+  }
 }