@bubblydoo/photoshop-mcp 0.0.2

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

@@ -0,0 +1,557 @@
+import type { Channel } from './Channel';
+import type * as Constants from './Constants';
+import type { Document } from './Document';
+import type { Layer } from './Layer';
+import type { ImagingBounds } from './objects/ImagingBounds';
+import type { PathItem } from './PathItem';
+import type { Bounds as SelectionBounds } from './types/SharedTypes';
+/**
+ * Represents a selected area or areas in the document.  If there is no active selection,
+ * the `bounds` will return `null`.  The selection is pixel-based, though 8-bit transparency is possible.
+ *
+ * Pixel selection targets where pixel filters are applied, or from where the histogram measurement is sourced.
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/}
+ *
+ * @example
+ * ```javascript
+ * const { app, constants } = require("photoshop");
+ * const doc = app.activeDocument;
+ *
+ * await doc.selection.selectRectangle(
+ *     {top: 50, left: 50, bottom: 100, right: 100},
+ *     constants.SelectionType.REPLACE
+ * );
+ * doc.selection.bounds; // {{top: 50, left: 50, bottom: 100, right: 100}
+ * doc.selection.solid;  // true
+ *
+ * await doc.selection.selectEllipse(
+ *     {top: 50, left: 70, bottom: 140, right: 100},
+ *     constants.SelectionType.EXTEND
+ * );
+ * doc.selection.bounds; // {{top: 50, left: 50, bottom: 140, right: 100}
+ * doc.selection.solid;  // false
+ *
+ * ```
+ *
+ * **Pixel selection while in Quick Mask Mode**:
+ * When a user switches into Quick Mask Mode, the selection is temporarily shown as a channel
+ * instead of the "marching ants" border.
+ * While in Quick Mask Mode, new pixel selections can be made via Scripting. However, upon exiting
+ * Quick Mask Mode, the Quick Mask Channel will become the active selection.
+ *
+ * @minVersion 25.0
+ */
+export class Selection {
+  /**
+   * @ignore
+   */
+  constructor(docId: number);
+  /**
+   * The class name of the referenced object: *"Selection"*.
+   *
+   * @minVersion 25.0
+   */
+  get typename(): 'Selection';
+  /**
+   * The ID of the document of this Selection.
+   *
+   * @minVersion 25.0
+   */
+  get docId(): number;
+  /**
+   * Owner document of this Selection.
+   *
+   * @minVersion 25.0
+   */
+  get parent(): Document;
+  /**
+   * The bounding rectangle of the entire selection. It can exceed the bounds of the canvas.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#bounds}
+   * @minVersion 25.0
+   */
+  get bounds(): ImagingBounds | null;
+  /**
+   * True if the selection itself is a rectangle with all fully selected pixels.
+   * Viewed as a channel, for example via Quick Mask Mode, the selection will
+   * appear as a completely white rectangle.  In that way, it is solid within its bounds.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#solid}
+   * @minVersion 25.0
+   */
+  get solid(): boolean;
+  /**
+   * Contract (shrink) the selection by the specified amount.
+   *
+   * If the contraction amount is greater than the selected area radius, the
+   * selected area will disappear entirely.  If there are no other active selected areas,
+   * then there will be no active selection altogether.
+   *
+   * UI Location: Select > Modify > Contract
+   *
+   * @param by The amount to contract the selection (integer in the range 1..500).
+   * @param applyEffectAtCanvasBounds By default this is false, meaning that any part of the selection
+   * that touches the bounds of the canvas will not be affected by the contraction.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#contract}
+   *
+   * @example
+   * ```js
+   * await doc.selection.contract(8);
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  contract(by: number, applyEffectAtCanvasBounds?: boolean): Promise<void>;
+  /**
+   * Cancel the current selection. The `bounds` value will then be `null`.
+   *
+   * UI Location: Select > Deselect
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#deselect}
+   *
+   * @example
+   * ```js
+   * await doc.selection.deselect();
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  deselect(): Promise<void>;
+  /**
+   * Expand the selection outward by the specified number of pixels.
+   *
+   * UI Location: Select > Modify > Expand
+   *
+   * @param by The amount to expand the selection (integer in the range 1..500).
+   * @param applyEffectAtCanvasBounds By default this is false, meaning that any part of the selection
+   * that touches the bounds of the canvas will not be affected by the expansion.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#expand}
+   *
+   * @example
+   * ```js
+   * await doc.selection.expand(42);
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  expand(by: number, applyEffectAtCanvasBounds?: boolean): Promise<void>;
+  /**
+   * Feather the edges of the selection by the specified amount.  This softening
+   * of the selection strength is best viewed as a channel via Quick Mask Mode.
+   * Large values might make the selection disappear entirely (`.bounds` would return `null`).
+   *
+   * UI Location: Select > Modify > Feather
+   *
+   * @param by The amount to feather the selection with (decimal in the range 0.1..1000).
+   * @param applyEffectAtCanvasBounds By default this is false, meaning that any part of the selection
+   * that touches the bounds of the canvas will not be affected by the feathering.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#feather}
+   *
+   * @example
+   * ```js
+   * await doc.selection.feather(16);
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  feather(by: number, applyEffectAtCanvasBounds?: boolean): Promise<void>;
+  /**
+   * Grow the selection to include all adjacent pixels falling
+   * within the specified tolerance range.
+   *
+   * Unsupported modes: Bitmap, RGB 32 bits, Grayscale 32 bits
+   *
+   * UI Location: Select > Grow
+   *
+   * @param tolerance The tolerance range (integer in the range 0..255)
+   * @param antiAlias Whether to use anti-aliasing (default: true)
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#grow}
+   *
+   * @example
+   * ```js
+   * await doc.selection.grow(32);
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  grow(tolerance: number, antiAlias?: boolean): Promise<void>;
+  /**
+   * Set the active selection to the inverse of the current selection.
+   * The new active selection will be cropped to the canvas bounds.
+   * If the canvas area is fully selected, `inverse` will result in no active selection.
+   * Note also that Artboard bounds are not respected.
+   *
+   * UI Location: Select > Inverse
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#inverse}
+   *
+   * @example
+   * ```js
+   * await doc.selection.inverse();
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  inverse(): Promise<void>;
+  /**
+   * Load the selection from the specified {@link Channel} or {@link Layer}.  A Layer's pixels' transparency
+   * will be used as the selection values.  Full opaque pixels yield fully selected pixels.
+   *
+   * UI Locations:
+   * - Select > Load Selection...
+   * - control/command + click on layer thumbnail
+   * - control/command + click on channel thumbnail
+   *
+   * For selecting a path please use {@link PathItem.makeSelection}
+   *
+   * @param from The Channel or Layer to load the selection from. Can be located in different document.
+   * @param mode The selection behavior when a selection already exists. Default: SelectionType.REPLACE
+   * @param invert True to invert the selection (default: false)
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#load}
+   *
+   * @example
+   * ```js
+   * // Load from first alpha channel in RGB document
+   * await doc.selection.load(doc.channels[3]);
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  load(from: Channel | Layer, mode?: Constants.SelectionType, invert?: boolean): Promise<void>;
+  /**
+   * Create a work path from the active selection.
+   *
+   * UI Location: Paths panel > Make work path icon
+   *
+   * @param tolerance The tolerance (lower values, higher precision), decimal in the range 0.5..10 (default: 2)
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#makeworkpath}
+   *
+   * @example
+   * ```js
+   * await doc.selection.makeWorkPath();
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  makeWorkPath(tolerance?: number): Promise<PathItem>;
+  /**
+   * Select the entire canvas.
+   *
+   * If the document has artboards, all the pixels of the artboard that contain the active layer
+   * will be selected.
+   *
+   * If layers across multiple artboards are active, a single rectangular selection will be made,
+   * with bounds wrapping them.
+   *
+   * If no artboard is active, all artboards will be selected in the same manner.
+   * (The resulting selection might be smaller than the canvas bounds.)
+   *
+   * UI Location: Select > All
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectall}
+   *
+   * @example
+   * ```js
+   * await doc.selection.selectAll();
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  selectAll(): Promise<void>;
+  /**
+   * Make a rectangular selection.
+   *
+   * UI Location: Toolbar > Rectangular Marquee Tool
+   *
+   * @param bounds The bounds of the selection, as an object with {top, left, bottom, right} properties.
+   * @param mode The selection behavior when a selection already exists. Default: SelectionType.REPLACE
+   * @param feather The amount of feathering in pixels to apply to the selection (decimal in the range 0..1000, default: 0)
+   * @param antiAlias If true, anti-aliasing is applied to the selection (default: true)
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectrectangle}
+   *
+   * @example
+   * ```js
+   * await doc.selection.selectRectangle(
+   *     {top: 0, left: 0, bottom: 100, right: 100},
+   *     Constants.SelectionType.REPLACE,
+   *     10
+   * );
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  selectRectangle(
+    bounds: SelectionBounds,
+    mode?: Constants.SelectionType,
+    feather?: number,
+    antiAlias?: boolean,
+  ): Promise<void>;
+  /**
+   * Make an elliptical selection.
+   *
+   * UI Location: Toolbar > Elliptical Marquee Tool
+   *
+   * @param bounds The bounds of the selection, as an object with {top, left, bottom, right} properties.
+   * @param mode The selection behavior when a selection already exists. Default: SelectionType.REPLACE
+   * @param feather The amount of feathering in pixels to apply to the selection (decimal in the range 0..1000, default: 0)
+   * @param antiAlias If true, anti-aliasing is applied to the selection (default: true)
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectellipse}
+   *
+   * @example
+   * ```js
+   * await doc.selection.selectEllipse({top: 0, left: 0, bottom: 100, right: 100});
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  selectEllipse(
+    bounds: SelectionBounds,
+    mode?: Constants.SelectionType,
+    feather?: number,
+    antiAlias?: boolean,
+  ): Promise<void>;
+  /**
+   * Make a polygonal selection.
+   *
+   * UI Location: Toolbar > Polygonal Lasso Tool
+   *
+   * @param points The points to select as an array of objects with {x, y} properties.
+   * @param mode The selection behavior when a selection already exists. Default: SelectionType.REPLACE
+   * @param feather The amount of feathering in pixels to apply to the selection (decimal in the range 0..1000, default: 0)
+   * @param antiAlias If true, anti-aliasing is applied to the selection (default: true)
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectpolygon}
+   *
+   * @example
+   * ```js
+   * await doc.selection.selectPolygon([
+   *     {x: 50, y: 10},
+   *     {x: 100, y: 90},
+   *     {x: 10, y: 40}
+   * ]);
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  selectPolygon(
+    points: Array<{
+      x: number;
+      y: number;
+    }>,
+    mode?: Constants.SelectionType,
+    feather?: number,
+    antiAlias?: boolean,
+  ): Promise<void>;
+  /**
+   * Select a single row of pixels.
+   *
+   * UI Location: Toolbar > Single Row Marquee Tool
+   *
+   * @param y The y coordinate in pixels of the row to select (integer).
+   * The range should be within the document height.
+   * @param mode The selection behavior when a selection already exists. Default: SelectionType.REPLACE
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectrow}
+   *
+   * @example
+   * ```js
+   * await doc.selection.selectRow(10);
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  selectRow(y: number, mode?: Constants.SelectionType): Promise<void>;
+  /**
+   * Select a single column of pixels.
+   *
+   * UI Location: Toolbar > Single Column Marquee Tool
+   *
+   * @param x The x coordinate in pixels of the column to select (integer).
+   * The range should be within the document width.
+   * @param mode The selection behavior when a selection already exists. Default: SelectionType.REPLACE
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectcolumn}
+   *
+   * @example
+   * ```js
+   * await doc.selection.selectColumn(90);
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  selectColumn(x: number, mode?: Constants.SelectionType): Promise<void>;
+  /**
+   * Save the selection in a new Alpha Channel.
+   *
+   * UI Location: Select > Save Selection...
+   *
+   * @param channelName The name of the new channel to create (Default: "Alpha 1", "Alpha 2", etc.)
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#save}
+   *
+   * @example
+   * ```js
+   * await doc.selection.save("My Selection");
+   * ```
+   *
+   * @async
+   * @minVersion 25.0
+   */
+  save(channelName?: string): Promise<void>;
+  /**
+   * Save the selection in an existing Alpha Channel (Component Channels are not supported targets).
+   *
+   * @param channel The targeted Alpha channel for the save operation.
+   * @param mode The selection behavior when a selection already exists. Default: SelectionType.REPLACE
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#saveto}
+   *
+   * @example
+   * ```js
+   * // Stores the current selection into an existing alpha channel in RGB document
+   * await doc.selection.saveTo(doc.channels[3]);
+   *
+   * // Performing an intersection operation on an alpha channel
+   * await doc.selection.saveTo(doc.channels[3], SelectionType.INTERSECT);
+   * ```
+   *
+   * @minVersion 25.0
+   */
+  saveTo(channel: Channel, mode?: Constants.SelectionType): Promise<void>;
+  /**
+   * Create a new selection based on the border of the active selection. The new selection will be an area
+   * equivalent to a stroke of that border by the given width in pixels.
+   * The result is not limited by canvas bounds.
+   *
+   * UI Location: Select > Modify > Border...
+   *
+   * @param width The width of the border selection (integer in the range 1..200)
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectborder}
+   *
+   * @example
+   * ```js
+   * await doc.selection.selectBorder(10);
+   * ```
+   *
+   * @minVersion 25.0
+   * @async
+   */
+  selectBorder(width: number): Promise<void>;
+  /**
+   * Reduce patchiness and smooth sharp corners and jagged lines in the selection. Smooth will also remove
+   * isolated groups of pixels that are smaller than the given radius. This effect is useful for cleaning up
+   * stray pixels from color-based selections.
+   *
+   * Large values might make the selection disappear entirely (`.bounds` would return `null`).
+   *
+   * UI Location: Select > Modify > Smooth...
+   *
+   * @param radius The sample radius in pixels (integer in the range 1..500)
+   * @param applyEffectAtCanvasBounds By default this is false, meaning that any part of the selection
+   * that touches the bounds of the canvas will not be affected by the smoothing.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#smooth}
+   *
+   * @example
+   * ```js
+   * await doc.selection.smooth(32);
+   * ```
+   *
+   * @minVersion 25.0
+   * @async
+   */
+  smooth(radius: number, applyEffectAtCanvasBounds?: boolean): Promise<void>;
+  /**
+   * Move the selection itself relative to its current position. Does not affect the active layer.
+   *
+   * UI Location: Select > Transform Selection
+   *
+   * @param deltaX The amount to move the selection horizontally (decimal).
+   * @param deltaY The amount to move the selection vertically (decimal).
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#translateboundary}
+   *
+   * @example
+   * ```js
+   * await doc.selection.translateBoundary(100, 600);
+   * ```
+   *
+   * @minVersion 25.0
+   * @async
+   */
+  translateBoundary(deltaX: number, deltaY: number): Promise<void>;
+  /**
+   * Scale the selection itself in percent. Does not affect the active layer.
+   *
+   * UI Location: Select > Transform Selection
+   *
+   * @param horizontal The amount to scale selection horizontally (decimal, default: 100)
+   * @param vertical The amount to scale selection vertically (decimal, default: 100)
+   * @param anchor The anchor position to scale around. Default: AnchorPosition.MIDDLECENTER
+   * @param interpolation The resampling algorithm to use. Default: InterpolationMethod.BICUBIC
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#resizeboundary}
+   *
+   * @example
+   * ```js
+   * await doc.selection.resizeBoundary(50, 50);
+   * ```
+   *
+   * @minVersion 25.0
+   * @async
+   */
+  resizeBoundary(
+    horizontal?: number,
+    vertical?: number,
+    anchor?: Constants.AnchorPosition,
+    interpolation?: Constants.InterpolationMethod,
+  ): Promise<void>;
+  /**
+   * Rotate the selection itself clockwise around the given anchor position. Does not affect the active layer.
+   *
+   * UI Location: Select > Transform Selection
+   *
+   * @param angle Angle to rotate the selection by in degrees (decimal in the range -180..180)
+   * @param anchor Anchor position to rotate around. Default: AnchorPosition.MIDDLECENTER
+   * @param interpolation The resampling algorithm to use. Default: InterpolationMethod.BICUBIC
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#rotateboundary}
+   *
+   * @example
+   * ```js
+   * await doc.selection.rotateBoundary(90, constants.AnchorPosition.MIDDLECENTER);
+   * ```
+   *
+   * @minVersion 25.0
+   * @async
+   */
+  rotateBoundary(
+    angle: number,
+    anchor?: Constants.AnchorPosition,
+    interpolation?: Constants.InterpolationMethod,
+  ): Promise<void>;
+}

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

@@ -0,0 +1,69 @@
+import type { PathPoints } from './collections/PathPoints';
+import type * as Constants from './Constants';
+import type { PathItem } from './PathItem';
+/**
+ * Represents a subpath; a collection of subpaths make up a {@link PathItem}.
+ *
+ * Create these objects by passing {@link SubPathInfo} objects to {@link PathItems.add}() method. This method creates a
+ * `SubPathItem` object for each {@link SubPathInfo} object, and creates and then returns a new {@link PathItem} object for the
+ * path represented by all of the subpaths. Access these objects in the {@link PathItem.subPathItems} collection.
+ *
+ *  - Use the {@link SubPathItem} object to retrieve information about existing subpaths. The properties are read-only.
+ *  - Use {@link SubPathInfo} to create subpaths; the properties are read-write.
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/subpathitem/}
+ *
+ * @example
+ * ```javascript
+ * // Access subpaths from a path
+ * const path = app.activeDocument.pathItems[0];
+ * path.subPathItems.forEach(subPath => {
+ *   console.log(`SubPath closed: ${subPath.closed}, operation: ${subPath.operation}`);
+ *   console.log(`Points count: ${subPath.pathPoints.length}`);
+ * });
+ * ```
+ *
+ * Added in Photoshop 23.3*
+ */
+export class SubPathItem {
+  /**
+   * @ignore
+   */
+  constructor(index: number, pathId: number, docId: number);
+  /**
+   * The class name of the referenced object: *"SubPathItem"*.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/subpathitem/#typename}
+   * @minVersion 23.3
+   */
+  get typename(): 'SubPathItem';
+  /**
+   * The path that contains this subpath.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/subpathitem/#parent}
+   * @minVersion 23.3
+   */
+  get parent(): PathItem;
+  /**
+   * How this `SubPathItem` behaves when it intersects another. Specifies how to combine the shapes
+   * if the destination path already has a selection.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/subpathitem/#operation}
+   * @minVersion 23.3
+   */
+  get operation(): Constants.ShapeOperation;
+  /**
+   * True if the path is closed.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/subpathitem/#closed}
+   * @minVersion 23.3
+   */
+  get closed(): boolean;
+  /**
+   * The collection of the {@link PathPoint}s on this `SubPathItem`.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/subpathitem/#pathpoints}
+   * @minVersion 23.3
+   */
+  get pathPoints(): PathPoints;
+}