@bubblydoo/photoshop-mcp 0.0.2

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

@@ -0,0 +1,219 @@
+import type { Document } from './Document';
+import type { Layer } from './Layer';
+import type { LayerCompRecaptureOptions } from './types/LayerCompTypes';
+/**
+ * Represents a single layer comp in the document.
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/}
+ *
+ * @example
+ * ```javascript
+ * // Access layer comps
+ * const doc = app.activeDocument;
+ * const layerComp = doc.layerComps[0];
+ * console.log(`Layer comp: ${layerComp.name}`);
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Create and apply a layer comp
+ * const doc = app.activeDocument;
+ * const comp = await doc.layerComps.add("My Design", "A great design", true, true, true);
+ * await comp.apply();
+ * ```
+ *
+ * @minVersion 24.0
+ */
+export class LayerComp {
+  /**
+   * @ignore
+   */
+  constructor(id: number, docId: number);
+  /**
+   * @ignore
+   */
+  private get _directRef();
+  /**
+   * The class name of the referenced LayerComp object
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#typename}
+   * @minVersion 24.0
+   */
+  get typename(): 'LayerComp';
+  /**
+   * For use with batchPlay operations. This layer comp ID, along with its document ID
+   * can be used to represent this layer comp for the lifetime of this document or the layer comp.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#id}
+   * @minVersion 24.0
+   */
+  get id(): number;
+  /**
+   * The ID of the document of this layer comp.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#docid}
+   * @minVersion 24.0
+   */
+  get docId(): number;
+  /**
+   * Owner document of this layer comp
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#parent}
+   * @minVersion 24.0
+   */
+  get parent(): Document;
+  /**
+   * The name of the layer comp.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#name}
+   * @minVersion 24.0
+   */
+  get name(): string;
+  set name(name: string);
+  /**
+   * The description of the layer comp.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#comment}
+   * @minVersion 24.0
+   */
+  get comment(): string | null;
+  set comment(comment: string | null);
+  /**
+   * If true, the layer comp is currently selected in the Layer Comps panel.
+   *
+   * Note: selected does not mean that this layer comp is applied to document.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#selected}
+   * @minVersion 24.0
+   */
+  get selected(): boolean;
+  /**
+   * If true, the layer comp will remember the layers' appearance (layer style) settings.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#appearance}
+   * @minVersion 24.0
+   */
+  get appearance(): boolean;
+  set appearance(value: boolean);
+  /**
+   * If true, the layer comp will remember layers' positions.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#position}
+   * @minVersion 24.0
+   */
+  get position(): boolean;
+  set position(value: boolean);
+  /**
+   * If true, the layer comp will remember layers' visibilities.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#visibility}
+   * @minVersion 24.0
+   */
+  get visibility(): boolean;
+  set visibility(value: boolean);
+  /**
+   * If true, the layer comp will remember which of the Smart Object's layer comps are set in the Properties panel.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#childcomp}
+   * @minVersion 24.0
+   */
+  get childComp(): boolean;
+  set childComp(value: boolean);
+  /**
+   * Applies the layer comp to the document.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#apply}
+   *
+   * @example
+   * ```javascript
+   * // Apply the first layer comp
+   * await app.activeDocument.layerComps[0].apply();
+   * ```
+   *
+   * @async
+   * @minVersion 24.0
+   */
+  apply(): Promise<void>;
+  /**
+   * Updates the recorded states of the layers for this layer comp.
+   *
+   * Applies to all layers and all properties supported by this layer comp.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#recapture}
+   *
+   * @example
+   * ```javascript
+   * // Recapture all properties for all layers
+   * await app.activeDocument.layerComps[0].recapture();
+   * ```
+   *
+   * @async
+   * @minVersion 24.0
+   */
+  recapture(): Promise<void>;
+  /**
+   * Updates the recorded states of the layers for this layer comp.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#recapture}
+   *
+   * @example
+   * ```javascript
+   * // Recapture only visibility for specific layers
+   * const layers = [app.activeDocument.layers[0], app.activeDocument.layers[1]];
+   * await app.activeDocument.layerComps[0].recapture({ visibility: true }, layers);
+   * ```
+   *
+   * @async
+   * @param argument what properties to recapture.
+   * @param layers if this argument is passed then only specified layers will be recaptured.
+   */
+  recapture(arg: LayerCompRecaptureOptions, layers?: Layer[]): Promise<void>;
+  /**
+   * Deletes this object from document.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#remove}
+   *
+   * @example
+   * ```javascript
+   * // Delete a layer comp
+   * await app.activeDocument.layerComps[0].remove();
+   * ```
+   *
+   * @async
+   * @minVersion 24.0
+   */
+  remove(): Promise<void>;
+  /**
+   * Resets the layer comp state to the document state.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#resetlayercomp}
+   *
+   * @example
+   * ```javascript
+   * // Reset layer comp to current document state
+   * await app.activeDocument.layerComps[0].resetLayerComp();
+   * ```
+   *
+   * @async
+   * @minVersion 24.0
+   */
+  resetLayerComp(): Promise<void>;
+  /**
+   * Duplicates this layer comp
+   *
+   * @returns newly created layer comp
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/layercomp/#duplicate}
+   *
+   * @example
+   * ```javascript
+   * // Duplicate a layer comp
+   * const newComp = await app.activeDocument.layerComps[0].duplicate();
+   * newComp.name = "Copy of " + app.activeDocument.layerComps[0].name;
+   * ```
+   *
+   * @async
+   * @minVersion 24.0
+   */
+  duplicate(): Promise<LayerComp>;
+}

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

@@ -0,0 +1,7 @@
+export {
+  BMPSaveOptions,
+  GIFSaveOptions,
+  JPEGSaveOptions,
+  PhotoshopSaveOptions,
+  PNGSaveOptions,
+} from './objects/SaveOptions';

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

@@ -0,0 +1,243 @@
+import type { SubPathItems } from './collections/SubPathItems';
+import type * as Constants from './Constants';
+import type { Document } from './Document';
+import type { Layer } from './Layer';
+import type { SolidColor } from './objects/SolidColor';
+/**
+ * A path or drawing object, such as the outline of a shape or a straight or curved line,
+ * which contains sub paths defining its geometry.
+ *
+ * Access through the collection in the {@link Document.pathItems} property. For example, this selects a named path item:
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/}
+ *
+ * @example
+ * ```javascript
+ * const currentPathItem = app.activeDocument.pathItems.getByName("myPath");
+ * currentPathItem.select()
+ * ```
+ *
+ * Create these objects by passing a set of SubPathInfo objects to the {@link PathItems.add}() method. This method creates
+ * a {@link SubPathItem} object for each {@link SubPathInfo} object, and creates and returns a new {@link PathItem} object for the
+ * path represented by all of the subpaths.
+ *
+ * @minVersion 23.3
+ */
+export class PathItem {
+  /**
+   * @ignore
+   */
+  constructor(id: number, docId: number);
+  /**
+   * The class name of the referenced object: *"PathItem"*.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#typename}
+   * @minVersion 23.3
+   */
+  get typename(): 'PathItem';
+  /**
+   * For use with batchPlay operations. This pathItem ID, along with its document ID
+   * can be used to represent this pathItem for the lifetime of this document.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#id}
+   * @minVersion 23.3
+   */
+  get id(): number;
+  /**
+   * The ID of the document of this pathItem.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#docid}
+   * @minVersion 23.3
+   */
+  get docId(): number;
+  /**
+   * The document in which the path resides.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#parent}
+   * @minVersion 23.3
+   */
+  get parent(): Document;
+  /**
+   * The specific kind of path.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#kind}
+   * @minVersion 23.3
+   */
+  get kind(): Constants.PathKind;
+  set kind(kind: Constants.PathKind);
+  /**
+   * Name of this path
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#name}
+   * @minVersion 23.3
+   */
+  get name(): string;
+  set name(name: string);
+  /**
+   * The contained {@link SubPathItem}s in this path.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#subpathitems}
+   * @minVersion 23.3
+   */
+  get subPathItems(): SubPathItems;
+  /**
+   * Deselects this `pathItem` object.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#deselect}
+   *
+   * @example
+   * ```javascript
+   * const path = app.activeDocument.pathItems[0];
+   * await path.deselect();
+   * ```
+   *
+   * @minVersion 23.3
+   */
+  deselect(): Promise<void>;
+  /**
+   * Duplicates the `pathItem` object with the new name, returning the duplicate.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#duplicate}
+   *
+   * @example
+   * ```javascript
+   * const originalPath = app.activeDocument.pathItems[0];
+   * const duplicatePath = await originalPath.duplicate("Copy of " + originalPath.name);
+   * ```
+   *
+   * @minVersion 23.3
+   */
+  duplicate(name?: string): Promise<PathItem>;
+  /**
+   * Fills the area enclosed by this path.
+   *
+   * `opacity` is a percentage, in the `[0.0 ... 100.0]` range.
+   *
+   * `feather` is in pixels, in the `[0.0 ... 250.0]` range.
+   *
+   * If `wholePath` is true, all subpaths are used when doing the fill.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#fillpath}
+   *
+   * @example
+   * ```javascript
+   * const path = app.activeDocument.pathItems[0];
+   * const fillColor = new SolidColor();
+   * fillColor.rgb.red = 255;
+   * fillColor.rgb.green = 0;
+   * fillColor.rgb.blue = 0;
+   * await path.fillPath(fillColor, constants.ColorBlendMode.NORMAL, 100, false, 0, true, true);
+   * ```
+   *
+   * @minVersion 23.3
+   */
+  fillPath(
+    fillColor?: SolidColor,
+    mode?: Constants.ColorBlendMode,
+    opacity?: number,
+    preserveTransparency?: boolean,
+    feather?: number,
+    wholePath?: boolean,
+    antiAlias?: boolean,
+  ): Promise<void>;
+  /**
+   * Makes this the clipping path for this document.
+   *
+   * `flatness` tells the PostScript printer how to approximate curves in the path.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#makeclippingpath}
+   *
+   * @example
+   * ```javascript
+   * const path = app.activeDocument.pathItems.getByName("ClipPath");
+   * await path.makeClippingPath(2);
+   * ```
+   *
+   * @minVersion 23.3
+   */
+  makeClippingPath(flatness?: number): Promise<void>;
+  /**
+   * Makes a selection object whose border is this path.
+   *
+   * `feather` is in pixels, in the range [0.0...250.0]
+   *
+   * `operation`, by default, is `SelectionType.REPLACE`
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#makeselection}
+   *
+   * @example
+   * ```javascript
+   * const path = app.activeDocument.pathItems[0];
+   * await path.makeSelection(5, true, constants.SelectionType.REPLACE);
+   * ```
+   *
+   * @minVersion 23.3
+   */
+  makeSelection(feather?: number, antiAlias?: boolean, operation?: Constants.SelectionType): Promise<void>;
+  /**
+   * Deletes this object.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#remove}
+   *
+   * @example
+   * ```javascript
+   * const path = app.activeDocument.pathItems[0];
+   * await path.remove();
+   * ```
+   *
+   * @minVersion 23.3
+   */
+  remove(): Promise<void>;
+  /**
+   * Makes this the active or selected `PathItem` object.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#select}
+   *
+   * @example
+   * ```javascript
+   * const path = app.activeDocument.pathItems.getByName("myPath");
+   * await path.select();
+   * ```
+   *
+   * @minVersion 23.3
+   */
+  select(): Promise<void>;
+  /**
+   * Strokes the path with the specified tool
+   *
+   * `tool` is optional, and by default will use `ToolType.PENCIL`
+   *
+   * `simulatePressure` is false by default.
+   *
+   * If the tool is `ToolType.CLONESTAMP` or `ToolType.HEALINGBRUSH`, `sourceOrigin` must be provided as a
+   * an object with x and y properties (in pixels) to indicate the location of the stroke source. `sourceLayer`
+   * is optional, and by default will use the active layer in the document.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#strokepath}
+   *
+   * @example
+   * ```javascript
+   * // Stroke a path with the brush tool
+   * const path = app.activeDocument.pathItems[0];
+   * await path.strokePath(constants.ToolType.BRUSH, false);
+   * ```
+   *
+   * @example
+   * ```javascript
+   * // Stroke with clone stamp tool
+   * const path = app.activeDocument.pathItems[0];
+   * await path.strokePath(
+   *   constants.ToolType.CLONESTAMP,
+   *   false,
+   *   {x: 100, y: 100},
+   *   app.activeDocument.layers[0]
+   * );
+   * ```
+   *
+   * @minVersion 23.3
+   */
+  strokePath(tool?: Constants.ToolType, simulatePressure?: boolean, sourceOrigin?: {
+    x: number;
+    y: number;
+  }, sourceLayer?: Layer): Promise<void>;
+}

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

@@ -0,0 +1,78 @@
+import type * as Constants from './Constants';
+import type { SubPathItem } from './SubPathItem';
+/**
+ * Represents the anchor and control-handle endpoints for a path segment. Each point (the anchor point, left-direction
+ *  point, and right-direction point) is an array containing X and Y position coordinates.
+ *
+ *  - Use the `PathPoint` object to retrieve information about the points that describe existing path segments. The
+ * properties are read-only. Access {@link PathPoint} objects through the {@link SubPathItem.pathPoints} property.
+ *
+ *  - Use {@link PathPointInfo} with {@link PathItems.add}() to create path points. The properties are writeable.
+ *
+ * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathpoint/}
+ *
+ * For paths that are straight segments (not curved), the coordinates of all three points are the same. For curved
+ * segments, the coordinates are different. The difference between the anchor point and the left or right
+ * direction points determines the arc of the curve. Use the left direction point to bend the curve "outward" or
+ * make it convex; or use the right direction point to bend the curve "inward" or make it concave.
+ *
+ * @example
+ * ```javascript
+ * // Access path points from a path
+ * const path = app.activeDocument.pathItems[0];
+ * const subPath = path.subPathItems[0];
+ * subPath.pathPoints.forEach(point => {
+ *   console.log(`Anchor: ${point.anchor}, Kind: ${point.kind}`);
+ * });
+ * ```
+ *
+ * Added in Photoshop 23.3*
+ */
+export class PathPoint {
+  /**
+   * @ignore
+   */
+  constructor(index: number, subPathIndex: number, pathId: number, docId: number);
+  /**
+   * The class name of the referenced object: *"PathPoint"*.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathpoint/#typename}
+   * @minVersion 23.3
+   */
+  get typename(): 'PathPoint';
+  /**
+   * The containing SubPath object.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathpoint/#parent}
+   * @minVersion 23.3
+   */
+  get parent(): SubPathItem;
+  /**
+   * The coordinates of the anchor point of the curve, in `[horizontal, vertical]` format.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathpoint/#anchor}
+   * @minVersion 23.3
+   */
+  get anchor(): number[];
+  /**
+   * The role (corner or smooth) this point plays in the containing path segment.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathpoint/#kind}
+   * @minVersion 23.3
+   */
+  get kind(): Constants.PointKind;
+  /**
+   * The location of the left-direction endpoint ('in' position), in `[horizontal, vertical]` format.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathpoint/#leftdirection}
+   * @minVersion 23.3
+   */
+  get leftDirection(): number[];
+  /**
+   * The location of the right-direction endpoint ('out' position), in `[horizontal, vertical]` format.
+   *
+   * @see {@link https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathpoint/#rightdirection}
+   * @minVersion 23.3
+   */
+  get rightDirection(): number[];
+}