@bubblydoo/photoshop-mcp 0.0.2

package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/SaveOptions.d.ts

@@ -0,0 +1,376 @@
+import type * as Constants from '../Constants';
+import type { SolidColor } from './SolidColor';
+/**
+ * Options for saving a document in BMP format using the {@link Document.saveAs} method
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/document/#saveas}
+ *
+ * @example
+ * ```javascript
+ * const doc = app.activeDocument;
+ * const saveFile = await require('uxp').storage.localFileSystem.getFileForSaving("image.bmp");
+ * const saveOptions = new BMPSaveOptions();
+ * saveOptions.depth = constants.BMPDepthType.BMP_24BITS;
+ * saveOptions.osType = constants.OperatingSystem.WINDOWS;
+ * await doc.saveAs.bmp(saveFile, saveOptions);
+ * ```
+ *
+ * @targetfolder objects/saveoptions
+ * @minVersion 22.5
+ */
+export class BMPSaveOptions {
+  private _alphaChannels;
+  private _depth;
+  private _flipRowOrder;
+  private _osType;
+  private _rleCompression;
+  /**
+   * True to save the alpha channels.
+   * @minVersion 22.5
+   */
+  get alphaChannels(): boolean;
+  set alphaChannels(value: boolean);
+  /**
+   * The number of bits per channel.
+   * @minVersion 22.5
+   */
+  get depth(): Constants.BMPDepthType;
+  set depth(value: Constants.BMPDepthType);
+  /**
+   * True to write the image from top to bottom,
+   * available only when osType is OperatingSystem.WINDOWS
+   * @minVersion 22.5
+   */
+  get flipRowOrder(): boolean;
+  set flipRowOrder(value: boolean);
+  /**
+   * The target OS.
+   * @minVersion 22.5
+   */
+  get osType(): Constants.OperatingSystem;
+  set osType(value: Constants.OperatingSystem);
+  /**
+   * True to use RLE compression
+   * @minVersion 22.5
+   */
+  get rleCompression(): boolean;
+  set rleCompression(value: boolean);
+  /**
+   * The class name of the referenced object: *"BMPSaveOptions"*.
+   * @minVersion 22.5
+   */
+  get typename(): 'BMPSaveOptions';
+  /** @ignore */
+  constructor();
+}
+/**
+ * Options for saving a document in JPEG format using the {@link Document.saveAs} method
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/document/#saveas}
+ *
+ * @example
+ * ```javascript
+ * const doc = app.activeDocument;
+ * const saveFile = await require('uxp').storage.localFileSystem.getFileForSaving("image.jpg");
+ * const saveOptions = new JPEGSaveOptions();
+ * saveOptions.quality = 10;
+ * saveOptions.embedColorProfile = true;
+ * await doc.saveAs.jpg(saveFile, saveOptions);
+ * ```
+ *
+ * @targetfolder objects/saveoptions
+ * @optionobject
+ * @minVersion 22.5
+ */
+export class JPEGSaveOptions {
+  private _quality;
+  private _formatOptions;
+  private _scans;
+  private _color;
+  private _matteColor;
+  private _customMatte;
+  private _embedColorProfile;
+  /**
+   * The image quality setting to use; affects file size and compression.
+   *
+   * @default 8
+   * @range 0...12
+   * @minVersion 22.5
+   */
+  get quality(): number;
+  set quality(value: number);
+  /**
+   * The JPEG format option to use.
+   * @default STANDARDBASELINE
+   * @minVersion 22.5
+   */
+  get formatOptions(): Constants.JPEGFormatOptions;
+  set formatOptions(value: Constants.JPEGFormatOptions);
+  /**
+   * The number of scans to incrementally display the image on the page.
+   * formatOptions must be JPEGFormatOptions.PROGRESSIVE.
+   * @default 3
+   * @range 3...5
+   * @minVersion 22.5
+   */
+  get scans(): number;
+  set scans(value: number);
+  /**
+   * A custom color to use to fill anti-aliased edges adjacent to transparent areas of the image.
+   * Mutually exclusive with 'matteColor'.
+   * @minVersion 22.5
+   */
+  get color(): SolidColor;
+  set color(value: SolidColor);
+  /**
+   * The color to use to fill anti-aliased edges adjacent to transparent areas of the image.
+   * Mutually exclusive with 'color'.
+   * @minVersion 22.5
+   */
+  get matteColor(): Constants.MatteColor;
+  set matteColor(value: Constants.MatteColor);
+  /**
+   * Custom matting color; overrides matteColor
+   * @minVersion 22.5
+   */
+  get customMatte(): SolidColor;
+  set customMatte(value: SolidColor);
+  /**
+   * False to skip embedding the color profile in the document
+   * @minVersion 22.5
+   */
+  get embedColorProfile(): boolean;
+  set embedColorProfile(value: boolean);
+  /**
+   * The class name of the referenced object: *"JPEGSaveOptions"*.
+   * @minVersion 22.5
+   */
+  get typename(): 'JPEGSaveOptions';
+  /** @ignore */
+  constructor();
+}
+/**
+ * Options for saving a document in GIF format using the {@link Document.saveAs} method
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/document/#saveas}
+ *
+ * @example
+ * ```javascript
+ * const doc = app.activeDocument;
+ * const saveFile = await require('uxp').storage.localFileSystem.getFileForSaving("image.gif");
+ * const saveOptions = new GIFSaveOptions();
+ * saveOptions.colors = 256;
+ * saveOptions.transparency = true;
+ * saveOptions.interlaced = false;
+ * await doc.saveAs.gif(saveFile, saveOptions);
+ * ```
+ *
+ * @targetfolder objects/saveoptions
+ * @optionobject
+ * @minVersion 22.5
+ */
+export class GIFSaveOptions {
+  private _colors;
+  private _dither;
+  private _ditherAmount;
+  private _forced;
+  private _interlaced;
+  private _matte;
+  private _palette;
+  private _preserveExactColors;
+  private _transparency;
+  /**
+   * The number of palette colors. Valid only when palette is:
+   *
+   * Palette.LOCALADAPTIVE, LOCALPERCEPTUAL, LOCALSELECTIVE, MACOSPALETTE, UNIFORM, WEBPALETTE; or WINDOWSPALETTE
+   * @minVersion 22.5
+   */
+  get colors(): number;
+  set colors(value: number);
+  /**
+   * The dither type.
+   * @minVersion 22.5
+   */
+  get dither(): Constants.Dither;
+  set dither(value: Constants.Dither);
+  /**
+   * The amount of dither.
+   *
+   * Valid only when dither = Dither.DIFFUSION.
+   * @minVersion 22.5
+   */
+  get ditherAmount(): number;
+  set ditherAmount(value: number);
+  /**
+   * The type of colors to force into the color palette.
+   * @minVersion 22.5
+   */
+  get forced(): Constants.ForcedColors;
+  set forced(value: Constants.ForcedColors);
+  /**
+   * True if rows should be interlaced.
+   * @minVersion 22.5
+   */
+  get interlaced(): boolean;
+  set interlaced(value: boolean);
+  /**
+   * The color to use to fill anti-aliased edges adjacent to transparent  areas of the image.
+   *
+   * When transparency is turned off for an image, the matte color is applied to transparent areas.
+   * @minVersion 22.5
+   */
+  get matte(): Constants.MatteColor;
+  set matte(value: Constants.MatteColor);
+  /**
+   * The type of palette to use.
+   * @minVersion 22.5
+   */
+  get palette(): Constants.Palette;
+  set palette(value: Constants.Palette);
+  /**
+   * True to protect colors in the image that contain entries in the color table from being dithered.
+   *
+   * Valid only when dither = DITHER.DIFFUSION
+   * @minVersion 22.5
+   */
+  get preserveExactColors(): boolean;
+  set preserveExactColors(value: boolean);
+  /**
+   * True to preserve transparent areas of the image during conversion to GIF format.
+   * @minVersion 22.5
+   */
+  get transparency(): boolean;
+  set transparency(value: boolean);
+  /**
+   * The class name of the referenced object: *"GIFSaveOptions"*.
+   * @minVersion 22.5
+   */
+  get typename(): 'GIFSaveOptions';
+  /** @ignore */
+  constructor();
+}
+/**
+ * Options for saving a document in PNG format using the {@link Document.saveAs} method
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/document/#saveas}
+ *
+ * @example
+ * ```javascript
+ * const doc = app.activeDocument;
+ * const saveFile = await require('uxp').storage.localFileSystem.getFileForSaving("image.png");
+ * const saveOptions = new PNGSaveOptions();
+ * saveOptions.compression = 6;
+ * saveOptions.interlaced = false;
+ * await doc.saveAs.png(saveFile, saveOptions);
+ * ```
+ *
+ * @targetfolder objects/saveoptions
+ * @optionobject
+ * @minVersion 22.5
+ */
+export class PNGSaveOptions {
+  private _method;
+  private _compression;
+  private _interlaced;
+  /** @ignore */
+  constructor();
+  /**
+   * PNG File Size optimization method.
+   * @minVersion 22.5
+   */
+  get method(): Constants.PNGMethod;
+  set method(value: Constants.PNGMethod);
+  /**
+   * The compression value to be used when method = PNGMethod.QUICK
+   *
+   * @range 0...9
+   * @default 6
+   * @minVersion 22.5
+   */
+  get compression(): number;
+  set compression(value: number);
+  /**
+   * True to interlace rows when method = PNGMethod.QUICK
+   *
+   * @default false
+   * @minVersion 22.5
+   */
+  get interlaced(): boolean;
+  set interlaced(value: boolean);
+  /**
+   * The class name of the referenced object: *"PNGSaveOptions"*.
+   * @minVersion 22.5
+   */
+  get typename(): 'PNGSaveOptions';
+}
+/**
+ * Options for saving a document in Photoshop (PSD) format using the {@link Document.saveAs} method
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/document/#saveas}
+ *
+ * @example
+ * ```javascript
+ * const doc = app.activeDocument;
+ * const saveFile = await require('uxp').storage.localFileSystem.getFileForSaving("document.psd");
+ * const saveOptions = new PhotoshopSaveOptions();
+ * saveOptions.layers = true;
+ * saveOptions.embedColorProfile = true;
+ * saveOptions.maximizeCompatibility = true;
+ * await doc.saveAs.psd(saveFile, saveOptions);
+ * ```
+ *
+ * @targetfolder objects/saveoptions
+ * @optionobject
+ * @minVersion 22.5
+ */
+export class PhotoshopSaveOptions {
+  private _alphaChannels;
+  private _annotations;
+  private _embedColorProfile;
+  private _layers;
+  private _spotColor;
+  private _maximizeCompatibility;
+  /**
+   * True to save the alpha channels.
+   * @minVersion 22.5
+   */
+  get alphaChannels(): boolean;
+  set alphaChannels(value: boolean);
+  /**
+   * True to save the annotations.
+   * @minVersion 22.5
+   */
+  get annotations(): boolean;
+  set annotations(value: boolean);
+  /**
+   * True to embed the color profiles in the document.
+   * @minVersion 22.5
+   */
+  get embedColorProfile(): boolean;
+  set embedColorProfile(value: boolean);
+  /**
+   * True to preserve the layers.
+   * @minVersion 22.5
+   */
+  get layers(): boolean;
+  set layers(value: boolean);
+  /**
+   * True to save the spot colors.
+   * @minVersion 22.5
+   */
+  get spotColor(): boolean;
+  set spotColor(value: boolean);
+  /**
+   * Maximize Compatibility with older versions
+   * @minVersion 22.5
+   */
+  get maximizeCompatibility(): boolean;
+  set maximizeCompatibility(value: boolean);
+  /**
+   * The class name of the referenced object: *"PhotoshopSaveOptions"*.
+   * @minVersion 22.5
+   */
+  get typename(): 'PhotoshopSaveOptions';
+  /** @ignore */
+  constructor();
+}

package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/SolidColor.d.ts

@@ -0,0 +1,118 @@
+import type { ColorModel } from '../Constants';
+import type * as Colors from './Colors';
+/**
+ * Represents a color, and allows for mapping into all available Photoshop color models.
+ * Import SolidColor from the Photoshop's app object:
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/objects/solidcolor/}
+ *
+ * @example
+ * ```javascript
+ * const SolidColor = require("photoshop").app.SolidColor;
+ * ```
+ *
+ * When a property is accessed (either via read or write), the current color model
+ * of the SolidColor objects gets set to the space of the accessor. Photoshop internally
+ * converts the color across these color spaces using the Color Settings set by the user.
+ *
+ * For example, to set the foreground color to red:
+ *
+ * @example
+ * ```javascript
+ * const SolidColor = require("photoshop").app.SolidColor;
+ * const red = new SolidColor();
+ * red.rgb.red = 255;
+ * red.rgb.green = 0;
+ * red.rgb.blue = 0;
+ *
+ * app.foregroundColor = red;
+ * ```
+ *
+ * To understand how color models change as you interact with a SolidColor object,
+ * please see example below:
+ *
+ * ```javascript
+ * const SolidColor = require("photoshop").app.SolidColor;
+ * const c = new SolidColor();
+ * console.log(c.base.typename); // By default, this will be "RGBColor"
+ *
+ * c.cmyk.cyan = 50; // Photoshop will convert the color to CMYK using Edit > Color Settings data
+ * console.log(c.base.typename); // Now, the typename will be "CMYKColor"
+ *
+ * c.rgb.green = 128; // Typename will change back to "RGBColor"
+ *
+ * ```
+ *
+ * ***Fixes in Photoshop 24.2:***
+ * - *Adds range validation for all color modes and its components so it should not be possible to enter invalid value.*
+ *
+ * @minVersion 23.0
+ */
+export class SolidColor {
+  /**
+   * The class name of the referenced object: *"SolidColor"*.
+   * @minVersion 24.2
+   */
+  get typename(): 'SolidColor';
+  /**
+   * The color's representation in RGB color space.
+   *
+   * @minVersion 23.0
+   */
+  get rgb(): Colors.RGBColor;
+  set rgb(c: Colors.RGBColor);
+  /**
+   * The color's representation in CMYK color space.
+   * @minVersion 23.0
+   */
+  get cmyk(): Colors.CMYKColor;
+  set cmyk(c: Colors.CMYKColor);
+  /**
+   * The color's representation in HSB color space.
+   * @minVersion 23.0
+   */
+  get hsb(): Colors.HSBColor;
+  set hsb(c: Colors.HSBColor);
+  /**
+   * The color's representation in LAB color space.
+   * @minVersion 23.0
+   */
+  get lab(): Colors.LabColor;
+  set lab(c: Colors.LabColor);
+  /**
+   * The color's representation in grayscale.
+   * @minVersion 23.0
+   */
+  get gray(): Colors.GrayColor;
+  set gray(c: Colors.GrayColor);
+  /**
+   * The color's nearest match within the 216 web-safe colors.
+   * @minVersion 23.0
+   */
+  get nearestWebColor(): Colors.RGBColor;
+  /**
+   * True if the SolidColor object is visually equivalent to the specified color.
+   *
+   * Both colors are converted to Lab colorspace,
+   * and the sum of their normalized squared Euclidian
+   * distance in each space is averaged across the three
+   * then compared to a small constant (3.5e-6).
+   *
+   * Due to differences in coverage by various color spaces and clamping,
+   * a color that is converted from RGB to CMYK and back may not be visually equal.
+   * @minVersion 23.0
+   */
+  isEqual(color: SolidColor): boolean;
+  /**
+   * All colors default to pure white.
+   *
+   * ```
+   * const SolidColor = require("photoshop").app.SolidColor;
+   * const color = new SolidColor();
+   * ```
+   *
+   * @param model Color model to start.
+   * @minVersion 23.0
+   */
+  constructor(model?: ColorModel);
+}

package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/SubPathInfo.d.ts

@@ -0,0 +1,47 @@
+import type * as Constants from '../Constants';
+import type { PathPointInfo } from './PathPointInfo';
+/**
+ * An array of {@link PathPointInfo} objects that describes a straight or curved segment of a path, used to create
+ * a {@link SubPathItem}.
+ *
+ * Pass an array of these objects to the {@link PathItems.add}() method. This method creates a {@link SubPathItem} object
+ * for each `SubPathInfo` object, and creates and returns a new {@link PathItem} object for the path represented by
+ * all of the subpaths.
+ *
+ *  - Use `SubPathInfo` to create subpaths; the properties are read-write.
+ *
+ *  - Use the {@link SubPathItem} object to retrieve information about existing subpaths. The properties are read-only.
+ * @minVersion 23.3
+ */
+export class SubPathInfo {
+  private _closed;
+  private _entireSubPath;
+  private _operation;
+  /**
+   * True if the path describes an enclosed area.
+   * @minVersion 23.3
+   */
+  get closed(): boolean;
+  set closed(value: boolean);
+  /**
+   * An array composed of the sub-path's {@link PathPoint} objects.
+   *
+   * @minVersion 23.3
+   */
+  get entireSubPath(): PathPointInfo[];
+  set entireSubPath(value: PathPointInfo[]);
+  /**
+   * The subpath's operation on other subpaths. Specifies how to combine the shapes if
+   * the destination path already has a selection.
+   * @minVersion 23.3
+   */
+  get operation(): Constants.ShapeOperation;
+  set operation(value: Constants.ShapeOperation);
+  /**
+   * The class name of the referenced object: *"SubPathInfo"*.
+   * @minVersion 23.3
+   */
+  get typename(): 'SubPathInfo';
+  /** @ignore */
+  constructor();
+}

package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/TextFont.d.ts

@@ -0,0 +1,49 @@
+import type { Photoshop } from '../Photoshop';
+/**
+ * Describes a font that is available to the application. Access this object in the {@link Photoshop.fonts} collection.
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/objects/textfont/}
+ *
+ * @example
+ * ```javascript
+ * const arialMTFont = require('photoshop').app.fonts.getByName("ArialMT");
+ * ```
+ * @minVersion 23.0
+ */
+export class TextFont {
+  private _family;
+  private _name;
+  private _parent;
+  private _postScriptName;
+  private _style;
+  /**
+   * The font family.
+   * @minVersion 23.0
+   */
+  get family(): string;
+  /**
+   * The name of the font.
+   * @minVersion 23.0
+   */
+  get name(): string;
+  /**
+   * The containing application.
+   * @minVersion 23.0
+   */
+  get parent(): Photoshop;
+  /**
+   * The PostScript name of the font.
+   * @minVersion 23.0
+   */
+  get postScriptName(): string;
+  /**
+   * The font style.
+   * @minVersion 23.0
+   */
+  get style(): string;
+  /**
+   * The class name of the referenced object: *"TextFont"*.
+   * @minVersion 23.0
+   */
+  get typename(): 'TextFont';
+}

package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/Tool.d.ts

@@ -0,0 +1,23 @@
+/**
+ * WIP. For now, only contains an id field. In the future, this may become a class.
+ *
+ * @targetfolder objects
+ * @optionobject
+ * @minVersion 23.0
+ */
+export class Tool {
+  private _id;
+  /**
+   * Name of the tool.
+   * @minVersion 23.0
+   */
+  get id(): string;
+  set id(name: string);
+  /**
+   * The class name of the referenced object: *"Tool"*.
+   * @minVersion 23.0
+   */
+  get typename(): 'Tool';
+  /** @ignore */
+  constructor();
+}