@ps-generator-bridge/generator 0.1.0

package/jsx/types/extendscript/misc.d.ts

@@ -0,0 +1,274 @@
+/**
+ * Photoshop 杂项类型声明
+ * 来源: https://theiviaxx.github.io/photoshop-docs/Photoshop/
+ */
+
+declare class UnitValue {
+  value: number;
+  type: string;
+  as(unit: string): number;
+  convert(unit: string): boolean;
+}
+
+type Rectangle = [number, number, number, number];
+
+declare class Preferences {
+  additionalPluginFolder: File;
+  appendExtension: MacExtensionType;
+  askBeforeSavingLayeredTIFF: boolean;
+  autoUpdateOpenDocuments: boolean;
+  exportClipboard: boolean;
+  imagePreviews: SaveBehavior;
+  macOSThumbnail: boolean;
+  maxRAMuse: number;
+  maximizeCompatibility: QueryStateType;
+  saveLogItems: SaveLogItemsType;
+  saveLogItemsFile: File;
+  useAdditionalPluginFolder: boolean;
+  useDiffusionDither: boolean;
+  useHistoryLog: boolean;
+  useLowerCaseExtension: boolean;
+  windowsThumbnail: boolean;
+  beepWhenDone: boolean;
+  colorChannelsInColor: boolean;
+  colorPicker: ColorPicker;
+  dynamicColorSliders: boolean;
+  fontPreviewSize: FontPreviewType;
+  fullSizePreview: boolean;
+  gamutWarningOpacity: number;
+  iconPreview: boolean;
+  imageCacheForHistograms: boolean;
+  keyboardZoomResizesWindows: boolean;
+  otherCursors: OtherPaintingCursors;
+  paintingCursors: PaintingCursors;
+  pixelDoubling: boolean;
+  savePaletteLocations: boolean;
+  showAsianTextOptions: boolean;
+  showEnglishFontNames: boolean;
+  showSliceNumber: boolean;
+  showToolTips: boolean;
+  smartQuotes: boolean;
+  textFontSize: FontSize;
+  useShiftKeyForToolSwitch: boolean;
+  useVideoAlpha: boolean;
+  columnGutter: number;
+  columnWidth: number;
+  gridSize: GridSize;
+  gridStyle: GridLineStyle;
+  gridSubDivisions: number;
+  guideStyle: GuideLineStyle;
+  interpolation: ResampleMethod;
+  pointSize: PointType;
+  rulerUnits: Units;
+  typeUnits: TypeUnits;
+  createFirstSnapshot: boolean;
+  editLogItems: EditLogItemsType;
+  imageCacheLevels: number;
+  nonLinearHistory: boolean;
+  numberOfHistoryStates: number;
+  recentFileListLength: number;
+  readonly parent: Application;
+  readonly typename: string;
+}
+
+declare class Guide {
+  direction: Direction;
+  coordinate: number;
+  readonly parent: Document;
+  readonly typename: string;
+  remove(): void;
+}
+
+declare class Guides {
+  readonly length: number;
+  readonly parent: Document;
+  readonly typename: string;
+  [index: number]: Guide;
+  add(direction: Direction, coordinate: number): Guide;
+  removeAll(): void;
+}
+
+declare class HistoryState {
+  readonly name: string;
+  readonly snapshot: boolean;
+  readonly parent: Document;
+  readonly typename: string;
+}
+
+declare class HistoryStates {
+  readonly length: number;
+  readonly parent: Document;
+  readonly typename: string;
+  [index: number]: HistoryState;
+  getByName(name: string): HistoryState;
+}
+
+declare class Notifier {
+  readonly event: string;
+  readonly eventClass: string;
+  readonly eventFile: File;
+  readonly parent: Application;
+  readonly typename: string;
+  remove(): void;
+}
+
+declare class Notifiers {
+  readonly length: number;
+  readonly parent: Application;
+  readonly typename: string;
+  [index: number]: Notifier;
+  add(event: string, eventFile: File, eventClass?: string): Notifier;
+  removeAll(): void;
+}
+
+declare class ColorSampler {
+  readonly color: SolidColor;
+  readonly position: [number, number];
+  readonly parent: Document;
+  readonly typename: string;
+  move(position: [number, number]): void;
+  remove(): void;
+}
+
+declare class ColorSamplers {
+  readonly length: number;
+  readonly parent: Document;
+  readonly typename: string;
+  [index: number]: ColorSampler;
+  add(position: [number, number]): ColorSampler;
+  removeAll(): void;
+}
+
+declare class CountItem {
+  readonly position: [number, number];
+  readonly parent: Document;
+  readonly typename: string;
+  remove(): void;
+}
+
+declare class CountItems {
+  readonly length: number;
+  readonly parent: Document;
+  readonly typename: string;
+  [index: number]: CountItem;
+  add(position: [number, number]): CountItem;
+  removeAll(): void;
+}
+
+declare class XMPMetadata {
+  readonly author: string;
+  readonly caption: string;
+  readonly copyrightNotice: string;
+  copyrightStatus: CopyrightedType;
+  copyrightInfoURL: string;
+  readonly creationDate: string;
+  city: string;
+  country: string;
+  credit: string;
+  exif: any;
+  headline: string;
+  instructions: string;
+  ISOCountryCode: string;
+  keywords: string[];
+  provinceState: string;
+  source: string;
+  title: string;
+  readonly parent: Document;
+  readonly typename: string;
+  rawData: string;
+}
+
+declare class DocumentInfo {
+  author: string;
+  authorPosition: string;
+  caption: string;
+  captionWriter: string;
+  city: string;
+  copyrightNotice: string;
+  copyrightStatus: CopyrightedType;
+  copyrightInfoURL: string;
+  country: string;
+  readonly creationDate: string;
+  credit: string;
+  headline: string;
+  instructions: string;
+  ISOCountryCode: string;
+  keywords: string[];
+  ownerUrl: string;
+  provinceState: string;
+  source: string;
+  supplementalCategories: string[];
+  title: string;
+  urgency: Urgency;
+  readonly parent: Document;
+  readonly typename: string;
+}
+
+declare class DocumentPrintSettings {
+  background: SolidColor;
+  bleedWidth: number;
+  caption: boolean;
+  colorBars: boolean;
+  colorHandling: PrintColorHandling;
+  copies: number;
+  cropMarks: boolean;
+  hardProof: boolean;
+  flip: boolean;
+  registrationMarks: boolean;
+  printerName: string;
+  negative: boolean;
+  labels: boolean;
+  readonly parent: Document;
+  readonly typename: string;
+}
+
+declare class MeasurementScale {
+  name: string;
+  pixelLength: number;
+  logicalLength: number;
+  logicalUnit: string;
+  readonly parent: Document;
+  readonly typename: string;
+}
+
+declare class MeasurementLog {
+  readonly parent: Application;
+  readonly typename: string;
+  exportMeasurements(file: File, range?: MeasurementRange, dataPoints?: string[]): void;
+  deleteMeasurements(range?: MeasurementRange): void;
+}
+
+declare class BatchOptions {
+  destinationFolder: Folder;
+  destination: BatchDestinationType;
+  errorFile: File;
+  fileNaming: FileNamingType[];
+  macintoshCompatible: boolean;
+  overrideOpen: boolean;
+  overrideSave: boolean;
+  startingSerial: number;
+  suppressOpen: boolean;
+  suppressProfile: boolean;
+  unixCompatible: boolean;
+  windowsCompatible: boolean;
+}
+
+declare class ExportOptions {}
+
+declare class ExportOptionsIllustrator extends ExportOptions {
+  path: IllustratorPathType;
+  pathName: string;
+}
+
+declare class ExportOptionsSaveForWeb extends ExportOptions {
+  includeProfile: boolean;
+  dither: number;
+  ditherType: DitherType;
+  format: SaveDocumentType;
+  interlaced: boolean;
+  colors: number;
+  quality: number;
+  optimized: boolean;
+  transparency: boolean;
+  webSnap: number;
+}

package/jsx/types/extendscript/open-options.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Photoshop 打开选项类型声明
+ * 来源: https://theiviaxx.github.io/photoshop-docs/Photoshop/
+ */
+
+/** Camera RAW 打开选项 */
+declare class CameraRAWOpenOptions {
+  blueSaturation: number;
+  brightness: number;
+  chromaticAberrationBY: number;
+  chromaticAberrationRC: number;
+  colorNoiseReduction: number;
+  colorSpace: ColorSpaceType;
+  contrast: number;
+  exposure: number;
+  greenSaturation: number;
+  highBitDepth: boolean;
+  lensVignettingAmount: number;
+  lensVignettingMidpoint: number;
+  luminanceSmoothing: number;
+  redSaturation: number;
+  saturation: number;
+  shadowTint: number;
+  sharpness: number;
+  size: CameraRAWSize;
+  tint: number;
+  settings: CameraRAWSettingsType;
+  whiteBalance: WhiteBalanceType;
+}
+
+/** DICOM 打开选项 */
+declare class DICOMOpenOptions {
+  anonymize: boolean;
+  columns: number;
+  reverseImage: boolean;
+  rows: number;
+  showOverlays: boolean;
+  windowLevel: number;
+  windowWidth: number;
+}
+
+/** 通用 EPS 打开选项 */
+declare class GenericEPSOpenOptions {
+  antiAlias: boolean;
+  constrainProportions: boolean;
+  height: number;
+  mode: OpenDocumentMode;
+  resolution: number;
+  width: number;
+}
+
+/** 通用 PDF 打开选项 */
+declare class GenericPDFOpenOptions {
+  antiAlias: boolean;
+  bitsPerChannel: BitsPerChannelType;
+  cropPage: CropToType;
+  constrainProportions: boolean;
+  height: number;
+  image: number;
+  mode: OpenDocumentMode;
+  page: number;
+  resolution: number;
+  suppressWarnings: boolean;
+  usePageNumber: boolean;
+  width: number;
+}
+
+/** PhotoCD 打开选项 */
+declare class PhotoCDOpenOptions {
+  colorProfileName: string;
+  colorSpace: ColorSpaceType;
+  orientation: Orientation;
+  pixelSize: PhotoCDColorSpace;
+  resolution: number;
+}
+
+/** Raw 格式打开选项 */
+declare class RawFormatOpenOptions {
+  bitsPerChannel: number;
+  byteOrder: ByteOrderType;
+  channelNumber: number;
+  headerSize: number;
+  height: number;
+  retainHeader: boolean;
+  width: number;
+}

package/jsx/types/extendscript/path.d.ts

@@ -0,0 +1,196 @@
+/**
+ * Photoshop 路径类型声明
+ * 来源: https://theiviaxx.github.io/photoshop-docs/Photoshop/
+ */
+
+// ============================================================
+// 路径点相关
+// ============================================================
+
+/** 路径点（PathPoints 集合中的元素）*/
+declare class PathPoint {
+  /** 前向控制点（贝塞尔曲线的方向锚点）[x, y] */
+  leftDirection: [number, number];
+  /** 路径点的坐标 [x, y] */
+  anchor: [number, number];
+  /** 后向控制点（贝塞尔曲线的方向锚点）[x, y] */
+  rightDirection: [number, number];
+  /** 点类型（角点或平滑点）*/
+  kind: PointKind;
+  /** 对象的容器（只读）*/
+  readonly parent: SubPathItem;
+  /** 对象的类名（只读）*/
+  readonly typename: string;
+}
+
+/** 路径点集合 */
+declare class PathPoints {
+  /** 路径点数量（只读）*/
+  readonly length: number;
+  /** 对象的容器（只读）*/
+  readonly parent: SubPathItem;
+  /** 对象的类名（只读）*/
+  readonly typename: string;
+  /** 通过索引访问路径点 */
+  [index: number]: PathPoint;
+}
+
+/** 路径点信息（用于创建路径时）*/
+declare class PathPointInfo {
+  /** 前向控制点 [x, y] */
+  leftDirection: [number, number];
+  /** 路径点的坐标 [x, y] */
+  anchor: [number, number];
+  /** 后向控制点 [x, y] */
+  rightDirection: [number, number];
+  /** 点类型 */
+  kind: PointKind;
+
+  constructor();
+}
+
+// ============================================================
+// 子路径相关
+// ============================================================
+
+/** 子路径项 */
+declare class SubPathItem {
+  /** 如果为 true，则子路径是封闭的（只读）*/
+  readonly closed: boolean;
+  /** 子路径中的路径点（只读）*/
+  readonly pathPoints: PathPoints;
+  /** 对象的容器（只读）*/
+  readonly parent: PathItem;
+  /** 对象的类名（只读）*/
+  readonly typename: string;
+}
+
+/** 子路径集合 */
+declare class SubPathItems {
+  /** 子路径数量（只读）*/
+  readonly length: number;
+  /** 对象的容器（只读）*/
+  readonly parent: PathItem;
+  /** 对象的类名（只读）*/
+  readonly typename: string;
+  /** 通过索引访问子路径 */
+  [index: number]: SubPathItem;
+}
+
+/** 子路径信息（用于创建路径时）*/
+declare class SubPathInfo {
+  /** 是否封闭 */
+  closed: boolean;
+  /** 路径点信息数组 */
+  entireSubPath: PathPointInfo[];
+  /** 路径操作类型 */
+  operation: ShapeOperation;
+
+  constructor();
+}
+
+// ============================================================
+// 路径项
+// ============================================================
+
+/**
+ * 表示一个路径或绘制对象（例如形状的轮廓或直线/曲线），
+ * 其中包含构成其几何结构的子路径。
+ */
+declare class PathItem {
+  /** 路径的类型（只读）*/
+  readonly kind: PathKind;
+  /** 路径项的名称 */
+  name: string;
+  /** 对象的容器（只读）*/
+  readonly parent: Document;
+  /** 此路径项的子路径对象（只读）*/
+  readonly subPathItems: SubPathItems;
+  /** 对象的类名（只读）*/
+  readonly typename: string;
+
+  /** 取消选中路径 */
+  deselect(): void;
+
+  /**
+   * 复制此路径项。
+   * @param targetDocument 目标文档（可选）
+   * @param placement 放置位置（可选）
+   */
+  duplicate(targetDocument?: Document, placement?: ElementPlacement): PathItem;
+
+  /**
+   * 填充路径所包围的区域。
+   * @param fillColor 填充颜色（可选）
+   * @param mode 混合模式（可选）
+   * @param opacity 不透明度（可选）
+   * @param preserveTransparency 是否保留透明度（可选）
+   * @param feather 羽化量（可选）
+   * @param antiAlias 是否消除锯齿（可选）
+   * @param wholePath 是否填充整个路径（可选）
+   */
+  fillPath(
+    fillColor?: SolidColor,
+    mode?: BlendMode,
+    opacity?: number,
+    preserveTransparency?: boolean,
+    feather?: number,
+    antiAlias?: boolean,
+    wholePath?: boolean
+  ): void;
+
+  /**
+   * 将此路径项设为此文档的剪切路径。
+   * @param flatness 平坦度（可选）
+   */
+  makeClippingPath(flatness?: number): void;
+
+  /**
+   * 从此路径项对象创建一个选定对象。
+   * @param feather 羽化量（可选）
+   * @param antiAlias 是否消除锯齿（可选）
+   * @param operation 选区操作类型（可选）
+   */
+  makeSelection(feather?: number, antiAlias?: boolean, operation?: SelectionType): void;
+
+  /** 删除此路径 */
+  remove(): void;
+
+  /** 将此路径项设为活动或选定路径项 */
+  select(): void;
+
+  /**
+   * 描边路径。
+   * @param tool 描边使用的工具（可选）
+   * @param simulatePressure 是否模拟压力（可选）
+   */
+  strokePath(tool?: ToolType, simulatePressure?: boolean): void;
+}
+
+/** 路径集合 */
+declare class PathItems {
+  /** 路径数量（只读）*/
+  readonly length: number;
+  /** 对象的容器（只读）*/
+  readonly parent: Document;
+  /** 对象的类名（只读）*/
+  readonly typename: string;
+  /** 通过索引访问路径项 */
+  [index: number]: PathItem;
+
+  /**
+   * 新建路径。
+   * @param name 路径名称
+   * @param entirePath 路径信息数组
+   */
+  add(name: string, entirePath: SubPathInfo[]): PathItem;
+
+  /**
+   * 通过名称获取路径。
+   * @param name 路径名称
+   */
+  getByName(name: string): PathItem;
+
+  /** 删除所有路径 */
+  removeAll(): void;
+}

package/jsx/types/extendscript/save-options.d.ts

@@ -0,0 +1,144 @@
+/**
+ * Photoshop 保存选项类型声明
+ * 来源: https://theiviaxx.github.io/photoshop-docs/Photoshop/
+ */
+
+/** 用于将文档保存为 JPEG 格式的选项 */
+declare class JPEGSaveOptions {
+  embedColorProfile: boolean;
+  formatOptions: FormatOptionsType;
+  matte: MatteType;
+  quality: number;
+  scans: number;
+}
+
+/** 用于将文档保存为 PNG 格式的选项 */
+declare class PNGSaveOptions {
+  compression: number;
+  interlaced: boolean;
+}
+
+/** 用于保存 Photoshop 文档（PSD 格式）的选项 */
+declare class PhotoshopSaveOptions {
+  alphaChannels: boolean;
+  annotations: boolean;
+  embedColorProfile: boolean;
+  layers: boolean;
+  spotColors: boolean;
+}
+
+/** 用于以 TIFF 格式保存文档的选项 */
+declare class TiffSaveOptions {
+  alphaChannels: boolean;
+  annotations: boolean;
+  byteOrder: ByteOrderType;
+  embedColorProfile: boolean;
+  imageCompression: TiffEncodingType;
+  interleaveChannels: boolean;
+  jpegQuality: number;
+  layerCompression: LayerCompressionType;
+  layers: boolean;
+  saveImagePyramid: boolean;
+  spotColors: boolean;
+  transparency: boolean;
+}
+
+/** 用于将文档保存为 BMP 格式的选项 */
+declare class BMPSaveOptions {
+  flipRowOrder: boolean;
+  osType: OperatingSystem;
+  rleCompression: boolean;
+}
+
+/** 用于将文档保存为 CompuServe GIF 格式的选项 */
+declare class GIFSaveOptions {
+  colors: number;
+  dither: DitherType;
+  ditherAmount: number;
+  palette: PaletteType;
+  preserveExactColors: boolean;
+  transparency: boolean;
+}
+
+/** 用于将文档保存为 EPS 格式的选项 */
+declare class EPSSaveOptions {
+  embedColorProfile: boolean;
+  encoding: SaveEncoding;
+  halftoneScreen: boolean;
+  interpolation: boolean;
+  preview: MacPreviewType;
+  psColorManagement: boolean;
+  transparentWhites: boolean;
+  vectorData: boolean;
+}
+
+/** 用于将文档保存为 Photoshop PDF 格式的选项 */
+declare class PDFSaveOptions {
+  alphaChannels: boolean;
+  annotations: boolean;
+  colorConversion: boolean;
+  colorProfile: string;
+  compatibility: PDFCompatibilityType;
+  convertDotsToHyphens: boolean;
+  description: string;
+  downSample: PDFResampleType;
+  downSampleSize: number;
+  downSampleSizeLimit: number;
+  embedColorProfile: boolean;
+  embedFonts: boolean;
+  encoding: PDFEncodingType;
+  interpolation: boolean;
+  jpegQuality: number;
+  layers: boolean;
+  optimizeForWeb: boolean;
+  password: string;
+  pDFStandard: PDFStandardType;
+  preserveEditing: boolean;
+  spotColors: boolean;
+  tiles: boolean;
+  transparency: boolean;
+  view: boolean;
+}
+
+/** 用于将文档保存为 Targa 格式的选项 */
+declare class TargaSaveOptions {
+  resolution: TargaBitsPerPixels;
+  rleCompression: boolean;
+  transparency: boolean;
+}
+
+/** 用于将文档保存为 DCS 1.0 格式的选项 */
+declare class DCS1_SaveOptions {
+  embedColorProfile: boolean;
+  encoding: SaveEncoding;
+  halftoneScreen: boolean;
+  interpolation: boolean;
+  preview: MacPreviewType;
+  dCS: DCSType;
+  vectorData: boolean;
+}
+
+/** 用于将文档保存为 DCS 2.0 格式的选项 */
+declare class DCS2_SaveOptions {
+  embedColorProfile: boolean;
+  encoding: SaveEncoding;
+  halftoneScreen: boolean;
+  interpolation: boolean;
+  multiFileDCS: boolean;
+  preview: MacPreviewType;
+  spotColors: boolean;
+  dCS: DCSType;
+  vectorData: boolean;
+}
+
+/** 用于将文档保存为 SGI RGB 格式的选项 */
+declare class SGIRGBSaveOptions {
+  alphaChannels: boolean;
+  spotColors: boolean;
+}
+
+/** 用于将文档保存为 Raw 格式的选项 */
+declare class RawSaveOptions {
+  alphaChannels: boolean;
+  interleavedChannels: boolean;
+}