@bubblydoo/photoshop-mcp 0.0.2

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

@@ -0,0 +1,213 @@
+import type * as Constants from './Constants';
+import type { Layer } from './Layer';
+import type { CharacterStyle } from './text/CharacterStyle';
+import type { ParagraphStyle } from './text/ParagraphStyle';
+import type { TextWarpStyle } from './text/TextWarpStyle';
+/**
+ * The Class that groups all Type related properties of a Text Layer in Photoshop.
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/}
+ *
+ * @example
+ * ```javascript
+ * const app = require('photoshop').app;
+ * const textItem = app.activeDocument.activeLayers[0].textItem;
+ * ```
+ *
+ * Some properties and methods are available directly in the TextItem instance itself:
+ *
+ * @example
+ * ```javascript
+ * textItem.contents; // "Lorem Ipsum"
+ * textItem.contents = "Hello World";
+ * textItem.isPointText; // true
+ * await textItem.convertToParagraphText();
+ * ```
+ *
+ * Most properties and methods are grouped for convenience in
+ * the {@link characterStyle} and {@link paragraphStyle} properties of {@link TextItem}.
+ *
+ * ```javascript
+ * textItem.characterStyle.size; // 12
+ * textItem.characterStyle.size = 24;
+ * textItem.paragraphStyle.hyphenation; // true
+ * ```
+ *
+ * Finally, the {@link warpStyle} object contains all the properties related to the
+ * Warp effect applied to the text layer.
+ *
+ * ```javascript
+ * textItem.warpStyle.style; // "arcLower"
+ * ```
+ *
+ * Please note that for some properties that are expressed in pixels, the valid range
+ * of values might depend on the document's resolution. When this is the case, you'll find
+ * that in the documentation "for a 72ppi document" is specified.
+ *
+ * An example is the font size:
+ *
+ * ```javascript
+ * // Range: 0.01..1296—for a 72ppi document
+ * textItem.characterStyle.size = 1000;
+ * ```
+ *
+ * If you want to find the range for documents with a different resolution, please use
+ * the following conversion formula:
+ *
+ * ```javascript
+ * newVal = (documentResolution / 72) * referenceVal;
+ *
+ * // I.e., for a 300ppi document the maximum font size will be:
+ * // (300 / 72) * 1296 = 5400px
+ * ```
+ *
+ * Upon setting a value, validation will be performed internally.
+ * An invalid value will result in a Range Error.
+ *
+ * @minVersion 24.1
+ */
+export class TextItem {
+  /**
+   * The parent Layer
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#parent}
+   * @minVersion 24.1
+   */
+  get parent(): Layer;
+  /**
+   * The typename
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#typename}
+   * @minVersion 24.1
+   */
+  get typename(): 'TextItem';
+  /**
+   * The actual text of the Layer.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#contents}
+   * @minVersion 24.1
+   */
+  get contents(): string;
+  set contents(text: string);
+  /**
+   * The text insertion point in the document, as an `{x, y}` object
+   * where the coordinates are expressed in pixels.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#textclickpoint}
+   * @minVersion 24.1
+   */
+  get textClickPoint(): {
+    x: number;
+    y: number;
+  };
+  set textClickPoint(point: {
+    x: number;
+    y: number;
+  });
+  /**
+   * The text orientation.
+   *
+   * @default HORIZONTAL
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#orientation}
+   * @minVersion 24.1
+   */
+  get orientation(): Constants.Orientation;
+  set orientation(orientation: Constants.Orientation);
+  /**
+   * True if the Text Layer is a "Point Text": a horizontal or vertical line of text
+   * that begins where the user clicks in the image.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#ispointtext}
+   * @minVersion 24.1
+   */
+  get isPointText(): boolean;
+  /**
+   * True if the Text Layer is a "Paragraph Text": text that uses boundaries
+   * to control the flow of characters, either horizontally or vertically.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#isparagraphtext}
+   * @minVersion 24.1
+   */
+  get isParagraphText(): boolean;
+  /**
+   * Convert a Text Layer from Point Text to Paragraph Text
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#converttoparagraphtext}
+   *
+   * @example
+   * ```javascript
+   * const textLayer = app.activeDocument.activeLayers[0];
+   * if (textLayer.textItem.isPointText) {
+   *   await textLayer.textItem.convertToParagraphText();
+   * }
+   * ```
+   *
+   * @minVersion 24.1
+   */
+  convertToParagraphText(): Promise<TextItem>;
+  /**
+   * Convert a Text Layer from Paragraph Text to Point Text
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#converttopointtext}
+   *
+   * @example
+   * ```javascript
+   * const textLayer = app.activeDocument.activeLayers[0];
+   * if (textLayer.textItem.isParagraphText) {
+   *   await textLayer.textItem.convertToPointText();
+   * }
+   * ```
+   *
+   * @minVersion 24.1
+   */
+  convertToPointText(): Promise<TextItem>;
+  /**
+   * Convert the Text Layer into a Shape Layer
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#converttoshape}
+   *
+   * @example
+   * ```javascript
+   * const textLayer = app.activeDocument.activeLayers[0];
+   * await textLayer.textItem.convertToShape();
+   * ```
+   *
+   * @minVersion 24.1
+   */
+  convertToShape(): Promise<void>;
+  /**
+   * Create a Work Path from the Text Layer
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#createworkpath}
+   *
+   * @example
+   * ```javascript
+   * const textLayer = app.activeDocument.activeLayers[0];
+   * await textLayer.textItem.createWorkPath();
+   * ```
+   *
+   * @minVersion 24.1
+   */
+  createWorkPath(): Promise<void>;
+  /**
+   * The object that stores properties related to the Character panel in the Photoshop UI.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#characterstyle}
+   * @minVersion 24.1
+   */
+  characterStyle: CharacterStyle;
+  /**
+   * The object that stores properties related to the Paragraph panel in the Photoshop UI.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#paragraphstyle}
+   * @minVersion 24.1
+   */
+  paragraphStyle: ParagraphStyle;
+  /**
+   * The object that stores properties related to the Warp Text dialog.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#warpstyle}
+   * @minVersion 24.1
+   */
+  warpStyle: TextWarpStyle;
+}

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

@@ -0,0 +1,81 @@
+import type { Channel } from '../Channel';
+import type { Document } from '../Document';
+
+/**
+ * A collections class allowing for array access into a document's channels,
+ * while also providing familiar methods from ExtendScript, like `getByName`
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channels/}
+ *
+ * @example
+ * ```javascript
+ * // Iterate through all channels in the document
+ * app.activeDocument.channels.forEach(h => console.log(h.name));
+ * ```
+ *
+ * ***Fixes in Photoshop 24.6***
+ * - *Component channels should work now correctly in non-English localizations*
+ * - *Channel should be now returned correctly in Bitmap and Indexed Color modes*
+ * @minVersion 23.0
+ */
+export class Channels extends Array<Channel> {
+  /** @ignore */
+  readonly _docId: number;
+  /** @ignore */
+  private proxy;
+  /**
+   * Used to access the channels in the collection
+   */
+  [index: number]: Channel;
+  /** @ignore */
+  constructor(docId: number);
+  /** @ignore */
+  handler(): {
+    get: (obj: Channels, key: string | symbol) => any;
+  };
+  /**
+   * Create a new alpha channel in this document.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channels/#add}
+   * @minVersion 23.0
+   */
+  add(): Channel;
+  /**
+   * Find the first channel with the matching name.
+   *
+   * ***Fixes in Photoshop 24.6***
+   * - *Non-English locales return correctly for component channels.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channels/#getbyname}
+   * @minVersion 23.0
+   */
+  getByName(name: string): Channel;
+  /**
+   * Remove all Alpha channels in the parent document.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channels/#removeall}
+   * @minVersion 23.0
+   */
+  removeAll(): void;
+  /**
+   * Number of Channel elements in this collection.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channels/#length}
+   * @minVersion 23.0
+   */
+  get length(): number;
+  /**
+   * The owner document of this Channel collection.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channels/#parent}
+   * @minVersion 23.0
+   */
+  get parent(): Document;
+  /**
+   * The name for this object collection: Channels.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/channels/#typename}
+   * @minVersion 23.0
+   */
+  get typename(): 'Channels';
+}

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

@@ -0,0 +1,97 @@
+import type { ColorSampler } from '../ColorSampler';
+/**
+ * A collections class allowing for array access into a document's ColorSamplers
+ *
+ * Access this collection through the {@link Document.colorSamplers} property. For instance,
+ * the following adds a new colorSampler to the collection:
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/colorsamplers/}
+ *
+ * @example
+ * ```javascript
+ * const app = require("photoshop").app;
+ * app.activeDocument.colorSamplers.add({x: 20, y: 20});
+ * ```
+ *
+ * A colorSampler can be access through the collection's `[index]` property,
+ * and then queried for its properties.
+ * For example, the following gets the first colorSampler in the collection, and then
+ * unpacks its `color` and `position` properties via a destructuring assignment to get
+ * the sampled color as a {@link SolidColor} object and its current position as an `{x, y}` object:
+ *
+ * @example
+ * ```javascript
+ * const cs = app.activeDocument.colorSamplers[0];
+ * const { color, position } = cs; // destructuring assignment
+ * console.log(color.rgb); // returns a SolidColor object:
+ *                         // {red: 0, green: 255, blue: 0, model: ColorModel.RGB}
+ * console.log(position); // returns an object: {x: 20, y: 20}
+ *
+ * ```
+ *
+ * To empty the colorSamplers collection, use the `removeAll()` method.
+ *
+ * ```javascript
+ * app.activeDocument.colorSamplers.removeAll();
+ * app.activeDocument.colorSamplers.length; // returns 0
+ * ```
+ *
+ * @minVersion 24.0
+ */
+export class ColorSamplers extends Array<ColorSampler> {
+  /**
+   * @ignore
+   */
+  private readonly _docId;
+  /**
+   * @ignore
+   */
+  private proxy;
+  /**
+   * @ignore
+   */
+  constructor(docId: number);
+  /**
+   * @ignore
+   */
+  handler(): {
+    get: (obj: any, key: any) => any;
+  };
+  /**
+   * Number of {@link ColorSampler} elements in this collection.
+   * ```javascript
+   * // A new document starts with no colorSamplers
+   * app.activeDocument.colorSamplers.length; // returns 0
+   * ```
+   * @minVersion 24.0
+   */
+  get length(): number;
+  /**
+   * The owner {@link Document} of this ColorSamplers collection.
+   * @minVersion 24.0
+   */
+  get parent(): Document;
+  /**
+   * Adds a {@link ColorSampler} to the collection at the given `{x, y}` coordinates in pixels.
+   *
+   * ```javascript
+   * app.activeDocument.colorSamplers.add({x: 20, y: 20});
+   * app.activeDocument.colorSamplers.length; // returns 1
+   * ```
+   * @minVersion 24.0
+   */
+  add(position: {
+    x: number;
+    y: number;
+  }): ColorSampler;
+  /**
+   * Removes all ColorSampler instances from this collection.
+   *
+   * ```javascript
+   * app.activeDocument.colorSamplers.removeAll();
+   * app.activeDocument.colorSamplers.length; // returns 0
+   * ```
+   * @minVersion 24.0
+   */
+  removeAll(): void;
+}

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

@@ -0,0 +1,130 @@
+import type { CountItem } from '../CountItem';
+import type { Document } from '../Document';
+import type { SolidColor } from '../objects/SolidColor';
+/**
+ * A collections class allowing access to the document's CountItem.
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/countitems/}
+ */
+export class CountItems extends Array<CountItem> {
+  /**
+   * @ignore
+   */
+  private readonly _docId;
+  /**
+   * @ignore
+   */
+  private proxy;
+  /**
+   * @ignore
+     * Used to access the CountItems in the collection
+     */
+  [index: number]: CountItem;
+  /**
+   * @ignore
+   */
+  constructor(docId: number);
+  /**
+   * @ignore
+   */
+  handler(): {
+    get: (obj: any, key: any) => any;
+  };
+  /**
+   * The CountItems collection's typename.
+   * @minVersion 24.1
+   */
+  get typename(): 'CountItems';
+  /**
+   * Number of {@link CountItem} elements in this collection.
+   * @minVersion 24.1
+   */
+  get length(): number;
+  /**
+   * The owner {@link Document} of this CountItems collection.
+   * @minVersion 24.1
+   */
+  get parent(): Document;
+  /**
+   * Adds a new {@link CountItem} to the collection.
+   *
+   * ```javascript
+   * app.activeDocument.countItems.add({x: 20, y: 20});
+   * ```
+   *
+   * @param position: Object with x and y properties.
+   * @param position.x: The x coordinate of the new CountItem in pixels.
+   * @param position.y: The y coordinate of the new CountItem in pixels.
+   * @minVersion 24.1
+   */
+  add(position: {
+    x: number;
+    y: number;
+  }): CountItem;
+  /**
+   * Clears all {@link CountItem} objects from this collection.
+   *
+   * ```javascript
+   * app.activeDocument.countItems.removeAllFromActiveGroup();
+   * ```
+   * @minVersion 24.1
+   */
+  removeAllFromActiveGroup(): void;
+  /**
+   * Retrieves all {@link CountItem} objects from this collection.
+   *
+   * ```javascript
+   * app.activeDocument.countItems.getAll();
+   * ```
+   * @minVersion 24.1
+   */
+  getAll(): CountItem[];
+  /**
+   * Creates a new Count Item group.
+   * @param groupName: The name of the group to be created.
+   * @minVersion 24.1
+   */
+  createGroup(groupName: string): void;
+  /**
+   * Renames the currently active Count Item group.
+   * @param groupName: The new name of the group.
+   * @minVersion 24.1
+   */
+  renameActiveGroup(groupName: string): void;
+  /**
+   * Removes a Count Item group by its index.
+   * @param index: The index of the group to be removed.
+   * @minVersion 24.1
+   */
+  removeGroupByIndex(index: number): void;
+  /**
+   * Toggles the visibility of the currently selected Count Item group.
+   * @param isVisible: Whether the group should be visible or not.
+   * @minVersion 24.1
+   */
+  toggleActiveGroupVisibility(isVisible: boolean): void;
+  /**
+   * Activates a Count Item group by its index.
+   * @param index: The index of the group to be activated.
+   * @minVersion 24.1
+   */
+  activateGroupByIndex(index: number): void;
+  /**
+   * Sets the Count Item marker (the dot) size.
+   * @param size: The marker size @range 1..10 @default 2
+   * @minVersion 24.1
+   */
+  setActiveMarkerSize(size: number): void;
+  /**
+   * Sets the Count Item label (the number) size.
+   * @param size: The marker size @range 8..72 @default 8
+   * @minVersion 24.1
+   */
+  setActiveLabelSize(size: number): void;
+  /**
+   * Sets the Color of the Count Item marker and label.
+   * @param color: The color as a {@link SolidColor} object.
+   * @minVersion 24.1
+   */
+  setActiveColor(color: SolidColor): void;
+}

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

@@ -0,0 +1,95 @@
+import type { Document } from '../Document';
+import type { Photoshop } from '../Photoshop';
+import type { DocumentCreateOptions } from '../types/DocumentTypes';
+/**
+ * A collections class allowing for array access into the application's
+ * list of documents that are currently open,
+ * while also providing familiar methods from ExtendScript, like `getByName`.
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/documents/}
+ *
+ * @example
+ * ```javascript
+ * // Iterate through all the documents
+ * app.documents.forEach(h => console.log(h.title));
+ * ```
+ */
+export class Documents extends Array<Document> {
+  /** @ignore */
+  private proxy;
+  /** @ignore */
+  constructor();
+  /**
+   * Used to access the documents in the collection.
+   * @minVersion 22.5
+   */
+  [index: number]: Document;
+  /** @ignore */
+  handler(): {
+    get: (obj: any, key: any) => any;
+  };
+  /**
+   * Find the first document with the matching name.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/documents/#getbyname}
+   * @minVersion 22.5
+   */
+  getByName(name: string): Document;
+  /**
+   * Number of {@link Document} elements in this collection.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/documents/#length}
+   * @minVersion 22.5
+   */
+  get length(): number;
+  /**
+   * The owner application of this Documents collection.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/documents/#parent}
+   * @minVersion 22.5
+   */
+  get parent(): Photoshop;
+  /**
+   * The name for this object collection: Documents.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/documents/#typename}
+   * @minVersion 22.5
+   */
+  get typename(): 'Documents';
+  /**
+   * Create a new document.
+   *
+   * No options will create a document of 7 x 5 inches at 300 pixels per inch.
+   * This is the same as the "Default Photoshop Size" preset.
+   *
+   * An object with a 'preset' string parameter can be used to specify any of
+   * the other presets that come installed with Photoshop or created by users.
+   *
+   * An object with one or more parameters can also be supplied. Any parameter
+   * missing will be set to the default of: width 2100 pixels, height 1500 pixels,
+   * resolution 300 pixels per inch, mode: @RGBColorMode and a fill of white with
+   * no transparency.
+   *
+   * @param options @DocumentCreateOptions
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/documents/#add}
+   *
+   * @example
+   * ```javascript
+   * // "Default Photoshop Size" 7x5 inches at 300ppi
+   * let newDoc1 = await app.documents.add();
+   * let newDoc2 = await app.documents.add({
+   *    width: 800,
+   *    height: 600,
+   *    resolution: 300,
+   *    mode: "RGBColorMode",
+   *    fill: "transparent"
+   * });
+   * let newDoc3 = await app.documents.add({preset: "My Default Size 1"});
+   * ```
+   *
+   * @async
+   * @minVersion 22.5
+   */
+  add(options?: DocumentCreateOptions): Promise<Document | null>;
+}

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

@@ -0,0 +1,76 @@
+import type * as Constants from '../Constants';
+import type { Document } from '../Document';
+import type { Guide } from '../Guide';
+/**
+ * A collections class allowing for array access into a document's guides
+ *
+ * Access this collection through {@link Document.guides} property. For example,
+ * following adds a new guide to the collection:
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/guides/}
+ *
+ * @example
+ * ```javascript
+ * app.activeDocument.guides.add(Constants.Direction.HORIZONTAL, 20);
+ * ```
+ */
+export class Guides extends Array<Guide> {
+  /**
+   * @ignore
+   */
+  readonly _docId: number;
+  /**
+   * @ignore
+   */
+  private proxy;
+  /**
+   * Used to access the guides in the collection.
+   * @minVersion 23.0
+   */
+  [index: number]: Guide;
+  /**
+   * @ignore
+   */
+  constructor(docId: number);
+  /**
+   * @ignore
+   */
+  handler(): {
+    get: (obj: any, key: any) => any;
+  };
+  /**
+   * Number of {@link Guide} elements in this collection.
+   * @minVersion 23.0
+   */
+  get length(): number;
+  /**
+   * The owner document of this Guide collection.
+   * @minVersion 23.0
+   */
+  get parent(): Document;
+  /**
+   * Ruler origin defines where coordinates [0,0] are located.
+   * Point coordinates are calculated from left top corner of the canvas.
+   * @ignore
+   */
+  /**
+   * Adds a guide for the collection at the given coordinate and direction
+   *
+   * ***Fixes in Photoshop 24.0:***
+   * - *Correct coordinate when resolution is not 72 PPI*
+   * - *Returns valid instance of guide*
+   *
+   * @param direction Indicates whether the guide is vertical or horizontal
+   * @param coordinate Position of the guide measured from the ruler origin in pixels.
+   * The value can be a decimal.
+   *
+   * Note: the user can move the ruler origin which will affect the position value of the guides.
+   * @minVersion 23.0
+   */
+  add(direction: Constants.Direction, coordinate: number): Guide;
+  /**
+   * Clears all guides from this collection.
+   * @minVersion 23.0
+   */
+  removeAll(): void;
+}