@bubblydoo/photoshop-mcp 0.0.2

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

@@ -0,0 +1,80 @@
+import type * as Constants from '../Constants';
+import type { SolidColor } from '../objects/SolidColor';
+/**
+ * An object literal can be constructed with any of the following properties
+ * and passed to {@link Photoshop.createDocument}.
+ * As a type, `DocumentCreateOptions` can be used in Typescript development.
+ *
+ * ```javascript
+ * const options = { name: "Web mockup", preset: "Web Large" };
+ * require('photoshop').app.createDocument(options);
+ * ```
+ *
+ * @targetfolder objects/createoptions
+ * @optionobject
+ * @minVersion 22.5
+ */
+export interface DocumentCreateOptions {
+  /**
+   * The name to give the new document.
+   * @minVersion 22.5
+   */
+  name?: string;
+  /**
+   * Preset.
+   * @minVersion 22.5
+   */
+  preset?: string;
+  /**
+   * JSON Preset, requires JSONified string.
+   * @minVersion 22.5
+   */
+  presetJSON?: string;
+  /**
+   * ImageMode class.
+   * @minVersion 22.5
+   */
+  mode?: Constants.NewDocumentMode;
+  /**
+   * Width of image in pixels.
+   * @minVersion 22.5
+   */
+  width?: number;
+  /**
+   * Height of image in pixels.
+   * @minVersion 22.5
+   */
+  height?: number;
+  /**
+   * Resolution of image.
+   * @minVersion 22.5
+   */
+  resolution?: number;
+  /**
+   * Fill color of the document.
+   * @minVersion 22.5
+   */
+  fill?: Constants.DocumentFill;
+  /**
+   * Custom fill color of the document.
+   * @minVersion 23.0
+   */
+  fillColor?: SolidColor;
+  /**
+   * Bit depth
+   * @minVersion 22.5
+   * @default 8
+   * @range [8,16,32]
+   */
+  depth?: number;
+  /**
+   * Pixel Scale Factor.
+   * @minVersion 22.5
+   */
+  pixelScaleFactor?: number;
+  /**
+   * Color Profile using profile name.
+   * @minVersion 22.5
+   */
+  profile?: string;
+}

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

@@ -0,0 +1,91 @@
+/**
+ * An object literal can be constructed with any of the following properties and passed to {@link LayerComps.add}.
+ * As a type, `LayerCompCreateOptions` can be used in Typescript development.
+ *
+ * ```javascript
+ * const options = { name: "mockup", comment: "First attempt", visibility: true };
+ * await require('photoshop').app.activeDocument.layerComps.add(options);
+ * ```
+ *
+ * @targetfolder objects/createoptions
+ * @optionobject
+ * @minVersion
+ */
+export interface LayerCompCreateOptions {
+  /**
+   * The name shown in the Layer Comps panel. If no value is provided,
+   * then a name will be generated following the template, "Layer Comp #".
+   * @default -
+   * @minVersion 24.0
+   */
+  name?: string;
+  /**
+   * The comment appears in the Layer Comp Options dialog.
+   * @default null
+   * @minVersion 24.0
+   */
+  comment?: string;
+  /**
+   * Record the state of the layers' visibility.
+   * @default false
+   * @minVersion 24.0
+   */
+  visibility?: boolean;
+  /**
+   * Record the state of the layers' position.
+   * @default true
+   * @minVersion 24.0
+   */
+  position?: boolean;
+  /**
+   * Record the state of the layers' effects.
+   * @default false
+   * @minVersion 24.0
+   */
+  appearance?: boolean;
+  /**
+   * Record the state of any Layer Comps contained in the recorded layers' Smart Objects.
+   * @default false
+   * @minVersion 24.0
+   */
+  childComp?: boolean;
+}
+/**
+ * An object literal can be constructed with any of the following properties and passed to {@link LayerComp.recapture}.
+ * As a type, `LayerCompRecaptureOptions` can be used in Typescript development.
+ *
+ * ```javascript
+ * const options = { visibility: true, position: true };
+ * await require('photoshop').app.activeDocument.layerComps.add(options);
+ * ```
+ *
+ * @targetfolder objects/options
+ * @optionobject
+ * @minVersion 24.0
+ */
+export interface LayerCompRecaptureOptions {
+  /**
+   * Update the recorded state of the layers' visibility.
+   * @default false
+   * @minVersion 24.0
+   */
+  visibility?: boolean;
+  /**
+   * Update the recorded state of the layers' position.
+   * @default false
+   * @minVersion 24.0
+   */
+  position?: boolean;
+  /**
+   * Update the recorded state of the layers' effects.
+   * @default false
+   * @minVersion 24.0
+   */
+  appearance?: boolean;
+  /**
+   * Update the recorded state of any Layer Comps contained in the recorded layers' Smart Objects.
+   * @default false
+   * @minVersion 24.0
+   */
+  childComp?: boolean;
+}

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

@@ -0,0 +1,153 @@
+import type * as Constants from '../Constants';
+import type { Layer } from '../Layer';
+import type { SolidColor } from '../objects/SolidColor';
+
+interface LayerCreateOptionsBase {
+  /**
+   * Name of the newly created layer. If no value is provided,
+   * then a name will be generated following the template, "Layer #".
+   * @default -
+   * @minVersion 22.5
+   */
+  name?: string;
+  /**
+   * Whether to use previous layer to create clipping mask.
+   *
+   * @default false
+   * @minVersion 22.5
+   */
+  group?: boolean;
+  /**
+   * Label color of the newly created layer or group.
+   * @default NONE
+   * @minVersion 22.5
+   */
+  color?: Constants.LabelColors;
+  /**
+   * Opacity of the newly created layer or group.
+   *
+   * @default 100
+   * @minVersion 22.5
+   */
+  opacity?: number;
+  /**
+   * Deprecated, please use `blendMode` above as it will override this value.
+   *
+   * @default NORMAL
+   * @minVersion 22.5
+   * @deprecated
+   */
+  mode?: Constants.BlendMode;
+  /**
+   * Blend mode of the newly created layer or group.
+   * @default NORMAL
+   * @minVersion 22.5
+   */
+  blendMode?: Constants.BlendMode;
+}
+/**
+ * An object literal can be constructed with any of the following properties and passed to {@link Document.createLayer}.
+ * As a type, `PixelLayerCreateOptions` can be used in Typescript development.
+ *
+ * ```javascript
+ * const options = { name: "myLayer", opacity: 80, blendMode: constants.BlendMode.COLORDODGE };
+ * await require('photoshop').app.activeDocument.createLayer(options);
+ * ```
+ *
+ * @targetfolder objects/createoptions
+ * @optionobject
+ * @minVersion 22.5
+ */
+export interface PixelLayerCreateOptions extends LayerCreateOptionsBase {
+  /**
+   * Whether to fill the layer with a neutral color when applying Blend Mode.
+   *
+   * @default false
+   * @minVersion 22.5
+   */
+  fillNeutral?: boolean;
+}
+/**
+ * An object literal can be constructed with any of the following properties
+ * and passed to {@link Document.createLayer}.
+ * As a type, `TextLayerCreateOptions` can be used in Typescript development.
+ *
+ * ```javascript
+ * const options = { name: "myTextLayer", contents: "Hello, World!", fontSize: 24, position: {x: 200, y: 300} };
+ * await require('photoshop').app.activeDocument.createLayer(options);
+ * ```
+ *
+ * @targetfolder objects/createoptions
+ * @optionobject
+ * @minVersion 24.2
+ */
+export interface TextLayerCreateOptions extends LayerCreateOptionsBase {
+  /**
+   * Text content of the newly created text layer.
+   * @default "Lorem Ipsum"
+   * @minVersion 24.2
+   */
+  contents?: string;
+  /**
+   * Insertion coordinates of the newly created text layer, in pixels
+   * @default document center.
+   * @minVersion 24.2
+   */
+  position?: {
+    x: number;
+    y: number;
+  };
+  /**
+   * Text color of the newly created text layer.
+   * @default black
+   * @minVersion 24.2
+   */
+  textColor?: SolidColor;
+  /**
+   * Font size of the newly created text layer in pixels.
+   * @default 12px
+   * @minVersion 24.2
+   */
+  fontSize?: number;
+  /**
+   * Font PostScript name of the newly created text layer.
+   * @default "MyriadPro-Regular"
+   * @minVersion 24.2
+   */
+  fontName?: string;
+}
+/**
+ * An object literal can be constructed with any of the following properties
+ * and passed to {@link Document.createLayerGroup}.
+ * As a type, `GroupLayerCreateOptions` can be used in Typescript development.
+ *
+ * ```javascript
+ * const options = { name: "myGroup", opacity: 50 };
+ * await require('photoshop').app.activeDocument.createLayerGroup(options);
+ * ```
+ *
+ * @targetfolder objects/createoptions
+ * @optionobject
+ * @minVersion 22.5
+ */
+export interface GroupLayerCreateOptions extends LayerCreateOptionsBase {
+  /**
+   * Name of the newly created layer group. If no value is provided,
+   * then a name will be generated following the template, "Group #".
+   * @minVersion 22.5
+   */
+  name?: string;
+  /**
+   * Layer(s) to populate the newly created group.
+   * @minVersion 22.5
+   */
+  fromLayers?: Layer | Layer[];
+}
+/**
+ * The options passed to {@link Document.createLayer} may take any of the following forms:
+ * - PixelLayerCreateOptions
+ * - GroupLayerCreateOptions
+ * @minVersion 22.5
+ */
+export type LayerCreateOptions = PixelLayerCreateOptions | GroupLayerCreateOptions;
+export {};

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

@@ -0,0 +1,6 @@
+export interface Bounds {
+  left: number;
+  right: number;
+  top: number;
+  bottom: number;
+}

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

@@ -0,0 +1,218 @@
+/**
+ * These property values are used to apply justification to paragraph text.
+ *
+ * These justification features can be seen in the dialog
+ * in the Paragraph panel's flyout menu item labeled "Justification...".
+ * They are expressed with an object literal with the following properties (values are percentages):
+ *
+ * ```javascript
+ * {
+ *      // Minimum, Desired and Maximum percentage of normal word spacing
+ *      wordSpacingMinimum:   number,
+ *      wordSpacingDesired:   number,
+ *      wordSpacingMaximum:   number,
+ *      // Minimum, Desired and Maximum percentage of normal letter spacing
+ *      letterSpacingMinimum: number,
+ *      letterSpacingDesired: number,
+ *      letterSpacingMaximum: number,
+ *      // Minimum, Desired and Maximum percentage of normal glyph scaling
+ *      glyphScalingMinimum:  number,
+ *      glyphScalingDesired:  number,
+ *      glyphScalingMaximum:  number
+ *      // Percentage of type size to use for auto leading
+ *      autoLeadingAmount:    number
+ * }
+ * ```
+ *
+ * Unless it's been set, the justificationFeatures value is `null`.
+ * The setter allows you to set individual properties: the missing ones will be
+ * either filled with the default values or left untouched.
+ *
+ * @optionobject
+ * @targetfolder objects/options
+ * @minVersion 24.1
+ */
+export interface JustificationProperties {
+  /**
+   * Auto leading amount
+   * @default 120
+   * @range 0..500
+   * @minVersion 24.1
+   */
+  autoLeadingAmount?: number;
+  /**
+   * Minimum word spacing - Must be less than or equal to Maximum.
+   * @default 80
+   * @range 0..1000
+   * @minVersion 24.1
+   */
+  wordSpacingMinimum?: number;
+  /**
+   * Desired word spacing - Must be between Minimum and Maximum or equal.
+   * @default 100
+   * @range 0..1000
+   * @minVersion 24.1
+   */
+  wordSpacingDesired?: number;
+  /**
+   * Maximum word spacing - Must be greater than or equal to Minimum.
+   * @default 133
+   * @range 0..1000
+   * @minVersion 24.1
+   */
+  wordSpacingMaximum?: number;
+  /**
+   * Minimum letter spacing - Must be less than or equal to Maximum.
+   * @default 0
+   * @range 0..500
+   * @minVersion 24.1
+   */
+  letterSpacingMinimum?: number;
+  /**
+   * Desired letter spacing - Must be between Minimum and Maximum or equal.
+   * @default 0
+   * @range 0..500
+   * @minVersion 24.1
+   */
+  letterSpacingDesired?: number;
+  /**
+   * Maximum letter spacing - Must be greater than or equal to Minimum.
+   * @default 0
+   * @range 0..500
+   * @minVersion 24.1
+   */
+  letterSpacingMaximum?: number;
+  /**
+   * Minimum glyph scaling - Must be less than or equal to Maximum.
+   * @default 100
+   * @range 50..200
+   * @minVersion 24.1
+   */
+  glyphScalingMinimum?: number;
+  /**
+   * Desired glyph scaling - Must be between Minimum and Maximum or equal
+   * @default 100
+   * @range 50..200
+   * @minVersion 24.1
+   */
+  glyphScalingDesired?: number;
+  /**
+   * Maximum glyph scaling - Must be greater than or equal to Minimum.
+   * @default 100
+   * @range 50..200
+   * @minVersion 24.1
+   */
+  glyphScalingMaximum?: number;
+}
+/**
+ * These property values are used to apply hyphenation to paragraph text.
+ *
+ * These hyphenation features can be seen in the dialog
+ * in the Paragraph panel's flyout menu item labeled "Hyphenation...".
+ * They are expressed with an object literal with the following properties (values are in pixels):
+ *
+ * ```javascript
+ * {
+ *      // The minimum number of letters a word must have in order for hyphenation
+ *      // in word wrap to be allowed. In the range [2, 25], default 5.
+ *      wordsLongerThan: number,
+ *      // The minimum number of letters after which hyphenation
+ *      // in word wrap is allowed. In the range [1, 15], default 2.
+ *      afterFirst: number,
+ *      // The minimum number of letters before which hyphenation
+ *      // in word wrap is allowed. In the range [1, 15], default 2.
+ *      beforeLast: number,
+ *      // The maximum number of consecutive lines that can end with a hyphenated word.
+ *      // In the range [2, 25], default 2.
+ *      limit: number,
+ *      // The distance in pixels at the end of a line that will cause a word
+ *      // to break in unjustified type. In the range of [0, 8640] pixels for a 72PPI document.
+ *      // If the document resolution is different, the max. value is scaled accordingly.
+ *      // Default: 36px (72PPI)
+ *      zone: number,
+ *     // True to allow hyphenation in word wrap of capitalized words. Default true.
+ *      capitalWords: boolean
+ * }
+ * ```
+ *
+ * The hyphenationFeatures getter returns an object with all the features:
+ *
+ * ```javascript
+ * const textItem = app.activeDocument.activeLayers[0].textItem;
+ * textItem.paragraphStyle.hyphenationFeatures;
+ * // {
+ * //       wordsLongerThan: 5,
+ * //       afterFirst: 2,
+ * //       beforeLast: 2,
+ * //       limit: 2,
+ * //       zone: 36,
+ * //       capitalWords: true
+ * // }
+ * ```
+ *
+ * In the object that is passed to the setter, all the properties are optional;
+ * the ones that are not specified will be assigned the default values.
+ *
+ * ```javascript
+ * textItem.paragraphStyle.hyphenationFeatures = { wordsLongerThan: 10, afterFirst: 3 };
+ * // {
+ * //       wordsLongerThan: 10,
+ * //       afterFirst: 3,
+ * //       beforeLast: 2,
+ * //       limit: 2,
+ * //       zone: 36,
+ * //       capitalWords: true
+ * // }
+ * ```
+ *
+ * @optionobject
+ * @targetfolder objects/options
+ * @minVersion 24.1
+ */
+export interface HyphenationProperties {
+  /**
+   * The minimum number of letters a word must have in order for hyphenation
+   * in word wrap to be allowed.
+   * @range 2..25
+   * @default 5
+   * @minVersion 24.1
+   */
+  wordsLongerThan?: number;
+  /**
+   * The minimum number of letters after which hyphenation
+   * in word wrap is allowed.
+   * @range 1..15
+   * @default 2
+   * @minVersion 24.1
+   */
+  afterFirst?: number;
+  /**
+   * The minimum number of letters before which hyphenation
+   * in word wrap is allowed.
+   * @range 1..15
+   * @default 2
+   * @minVersion 24.1
+   */
+  beforeLast?: number;
+  /**
+   * The maximum number of consecutive lines that can end with a hyphenated word.
+   * @range 2..25
+   * @default 2
+   * @minVersion 24.1
+   */
+  limit?: number;
+  /**
+   * The distance in pixels at the end of a line that will cause a word
+   * to break in unjustified type.
+   * @range 0..8640 for a 72PPI document
+   * @default 36
+   * @minVersion 24.1
+   */
+  zone?: number;
+  /**
+   * True to allow hyphenation in word wrap of capitalized words.
+   * @default true
+   * @minVersion 24.1
+   */
+  capitalWords?: boolean;
+}

package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/util/colorTypes.d.ts

@@ -0,0 +1,61 @@
+/**
+ * These types define color objects that Photoshop accepts, particularly [[PhotoshopCore.convertColor]] API
+ *
+ * On DOM level, [[SolidColor]] is used for all representations of a color.
+ */
+export type ColorDescriptor
+  = | RGBColorDescriptor
+    | HSBColorDescriptor
+    | CMYKColorDescriptor
+    | LabColorDescriptor
+    | GrayscaleColorDescriptor
+    | RGB32ColorDescriptor;
+export interface RGBColorDescriptor {
+  _obj: 'RGBColor';
+  red: number;
+  green: number;
+  blue: number;
+}
+export interface RGB32ColorDescriptor {
+  _obj: 'RGBColor';
+  greenFloat: number;
+  redFloat: number;
+  blueFloat: number;
+}
+export interface HSBColorDescriptor {
+  _obj: 'HSBColorClass';
+  hue: {
+    _unit: 'angleUnit';
+    _value: number;
+  };
+  saturation: number;
+  brightness: number;
+}
+export interface CMYKColorDescriptor {
+  _obj: 'CMYKColorClass';
+  cyan: number;
+  magenta: number;
+  yellowColor: number;
+  black: number;
+}
+export interface LabColorDescriptor {
+  _obj: 'labColor';
+  luminance: number;
+  a: number;
+  b: number;
+}
+export interface GrayscaleColorDescriptor {
+  _obj: 'grayscale';
+  gray: number;
+}
+/**
+ * These internal numbers are used by Photoshop as target color spaces during [[photoshopCore.convertColor]] calls.
+ * @ignore
+ */
+export enum ColorConversionModel {
+  HSB = 4,
+  CMYK = 5,
+  Lab = 6,
+  RGB = 15,
+  Gray = 16,
+}

package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/util/unit.d.ts

@@ -0,0 +1,45 @@
+export type UnitTypeEnum
+  = | 'angleUnit'
+    | 'densityUnit'
+    | 'distanceUnit'
+    | 'percentUnit'
+    | 'pixelsUnit'
+    | 'pointsUnit'
+    | 'millimetersUnit'
+    | 'centimetersUnit'
+    | 'inchesUnit'
+    | 'picasUnit';
+export interface UnitValue {
+  _unit: UnitTypeEnum;
+  _value: number;
+}
+export interface AngleValue extends UnitValue {
+  _unit: 'angleUnit';
+}
+export interface DensityValue extends UnitValue {
+  _unit: 'densityUnit';
+}
+export interface DistanceValue extends UnitValue {
+  _unit: 'distanceUnit';
+}
+export interface PercentValue extends UnitValue {
+  _unit: 'percentUnit';
+}
+export interface PixelValue extends UnitValue {
+  _unit: 'pixelsUnit';
+}
+export interface PointValue extends UnitValue {
+  _unit: 'pointsUnit';
+}
+export interface MillimeterValue extends UnitValue {
+  _unit: 'millimetersUnit';
+}
+export interface CentimeterValue extends UnitValue {
+  _unit: 'centimetersUnit';
+}
+export interface InchValue extends UnitValue {
+  _unit: 'inchesUnit';
+}
+export interface PicaValue extends UnitValue {
+  _unit: 'picasUnit';
+}

package/dist-schemas/@adobe-uxp-types/uxp/src/index.d.ts

@@ -0,0 +1,21 @@
+import { dialog } from './internal/dialog';
+import { entrypoints } from './internal/entrypoints';
+import { host } from './internal/host';
+import { os } from './internal/os';
+import { shell } from './internal/shell';
+import { storage } from './internal/storage';
+import { versions } from './internal/versions';
+
+export type * from './internal/all-types';
+export { dialog, entrypoints, host, os, shell, storage, versions };
+
+const _default: {
+  dialog: typeof dialog;
+  entrypoints: typeof entrypoints;
+  host: typeof host;
+  os: typeof os;
+  shell: typeof shell;
+  storage: typeof storage;
+  versions: typeof versions;
+};
+export default _default;

package/dist-schemas/@adobe-uxp-types/uxp/src/internal/all-types.d.ts

@@ -0,0 +1,3 @@
+export type * from './entrypoints';
+export type * from './other';
+export type * from './storage';