@bubblydoo/photoshop-mcp 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. package/README.md +138 -0
  2. package/dist/index.d.ts +1 -0
  3. package/dist/index.js +7049 -0
  4. package/dist/index.js.map +1 -0
  5. package/dist-readmes/README.md +383 -0
  6. package/dist-runtime/runtime-code.cjs +17124 -0
  7. package/dist-runtime/runtime-code.d.cts +9 -0
  8. package/dist-schemas/@adobe-uxp-types/photoshop/src/index.d.ts +16 -0
  9. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/all-types.d.ts +65 -0
  10. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Actions.d.ts +230 -0
  11. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Channel.d.ts +120 -0
  12. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/ColorSampler.d.ts +105 -0
  13. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Constants.d.ts +1648 -0
  14. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/CoreModules.d.ts +922 -0
  15. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/CountItem.d.ts +86 -0
  16. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Document.d.ts +931 -0
  17. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Guide.d.ts +105 -0
  18. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/HistoryState.d.ts +74 -0
  19. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/ImagingModule.d.ts +559 -0
  20. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Layer.d.ts +1073 -0
  21. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/LayerComp.d.ts +219 -0
  22. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Objects.d.ts +7 -0
  23. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/PathItem.d.ts +243 -0
  24. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/PathPoint.d.ts +78 -0
  25. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Photoshop.d.ts +317 -0
  26. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/Selection.d.ts +557 -0
  27. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/SubPathItem.d.ts +69 -0
  28. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/TextItem.d.ts +213 -0
  29. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/Channels.d.ts +81 -0
  30. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/ColorSamplers.d.ts +97 -0
  31. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/CountItems.d.ts +130 -0
  32. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/Documents.d.ts +95 -0
  33. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/Guides.d.ts +76 -0
  34. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/HistoryStates.d.ts +56 -0
  35. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/LayerComps.d.ts +92 -0
  36. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/Layers.d.ts +68 -0
  37. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/PathItems.d.ts +65 -0
  38. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/PathPoints.d.ts +50 -0
  39. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/SubPathItems.d.ts +50 -0
  40. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/collections/TextFonts.d.ts +43 -0
  41. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/Colors.d.ts +225 -0
  42. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/ConversionOptions.d.ts +213 -0
  43. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/ImagingBounds.d.ts +53 -0
  44. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/PathPointInfo.d.ts +84 -0
  45. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/SaveOptions.d.ts +376 -0
  46. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/SolidColor.d.ts +118 -0
  47. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/SubPathInfo.d.ts +47 -0
  48. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/TextFont.d.ts +49 -0
  49. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/objects/Tool.d.ts +23 -0
  50. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/Preferences.d.ts +121 -0
  51. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesBase.d.ts +9 -0
  52. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesCursors.d.ts +37 -0
  53. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesFileHandling.d.ts +58 -0
  54. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesGeneral.d.ts +77 -0
  55. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesGuidesGridsAndSlices.d.ts +51 -0
  56. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesHistory.d.ts +69 -0
  57. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesInterface.d.ts +46 -0
  58. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesPerformance.d.ts +42 -0
  59. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesTools.d.ts +44 -0
  60. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesTransparencyAndGamut.d.ts +38 -0
  61. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesType.d.ts +44 -0
  62. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/preferences/PreferencesUnitsAndRulers.d.ts +44 -0
  63. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/text/CharacterStyle.d.ts +254 -0
  64. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/text/ParagraphStyle.d.ts +114 -0
  65. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/text/TextWarpStyle.d.ts +48 -0
  66. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/ApplyImageTypes.d.ts +107 -0
  67. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/CalculationsTypes.d.ts +119 -0
  68. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/DocumentTypes.d.ts +80 -0
  69. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/LayerCompTypes.d.ts +91 -0
  70. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/LayerTypes.d.ts +153 -0
  71. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/SharedTypes.d.ts +6 -0
  72. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/dom/types/TextTypes.d.ts +218 -0
  73. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/util/colorTypes.d.ts +61 -0
  74. package/dist-schemas/@adobe-uxp-types/photoshop/src/internal/util/unit.d.ts +45 -0
  75. package/dist-schemas/@adobe-uxp-types/uxp/src/index.d.ts +21 -0
  76. package/dist-schemas/@adobe-uxp-types/uxp/src/internal/all-types.d.ts +3 -0
  77. package/dist-schemas/@adobe-uxp-types/uxp/src/internal/dialog.d.ts +26 -0
  78. package/dist-schemas/@adobe-uxp-types/uxp/src/internal/entrypoints.d.ts +385 -0
  79. package/dist-schemas/@adobe-uxp-types/uxp/src/internal/host.d.ts +28 -0
  80. package/dist-schemas/@adobe-uxp-types/uxp/src/internal/os.d.ts +56 -0
  81. package/dist-schemas/@adobe-uxp-types/uxp/src/internal/other.d.ts +7 -0
  82. package/dist-schemas/@adobe-uxp-types/uxp/src/internal/shell.d.ts +54 -0
  83. package/dist-schemas/@adobe-uxp-types/uxp/src/internal/storage.d.ts +1216 -0
  84. package/dist-schemas/@adobe-uxp-types/uxp/src/internal/versions.d.ts +18 -0
  85. package/dist-schemas/@bubblydoo/uxp-toolkit/dist/commands-library/index.d.ts +109 -0
  86. package/dist-schemas/@bubblydoo/uxp-toolkit/dist/index.d.ts +153 -0
  87. package/dist-schemas/@bubblydoo/uxp-toolkit/dist/psLayerRef-BJKcxKbm.d.ts +66 -0
  88. package/package.json +51 -0
@@ -0,0 +1,254 @@
1
+ import type * as Constants from '../Constants';
2
+ import type { SolidColor } from '../objects/SolidColor';
3
+ /**
4
+ * The Class that stores properties related to the Character panel in the Photoshop UI.
5
+ * @minVersion 24.1
6
+ */
7
+ export class CharacterStyle {
8
+ /**
9
+ * The text face of the character, using the PostScript name of the font.
10
+ * See {@link TextFont} and use the `postScriptName` property.
11
+ * @minVersion 24.1
12
+ */
13
+ get font(): string;
14
+ set font(font: string);
15
+ /**
16
+ * The font size in pixels for a 72ppi document.
17
+ * @range 0.01..1296
18
+ * @minVersion 24.1
19
+ */
20
+ get size(): number;
21
+ set size(size: number);
22
+ /**
23
+ * Character scaling (horizontal) in proportion to verticalScale,
24
+ * as a percentage value.
25
+ * @range 0..1000
26
+ * @minVersion 24.1
27
+ */
28
+ get horizontalScale(): number;
29
+ set horizontalScale(horizontalScale: number);
30
+ /**
31
+ * Character scaling (vertical) in proportion to horizontalScale,
32
+ * as a percentage value.
33
+ * @range 0..1000
34
+ * @minVersion 24.1
35
+ */
36
+ get verticalScale(): number;
37
+ set verticalScale(verticalScale: number);
38
+ /**
39
+ * True to use Faux Bold.
40
+ * Setting this to true is equivalent to selecting text and
41
+ * clicking Faux Bold in the Character panel.
42
+ * @default false
43
+ * @minVersion 24.1
44
+ */
45
+ get fauxBold(): boolean;
46
+ set fauxBold(fauxBold: boolean);
47
+ /**
48
+ * True to use Faux Italic.
49
+ * Setting this to true is equivalent to selecting text and
50
+ * clicking Faux Italic in the Character panel.
51
+ * @default false
52
+ * @minVersion 24.1
53
+ */
54
+ get fauxItalic(): boolean;
55
+ set fauxItalic(fauxItalic: boolean);
56
+ /**
57
+ * True to use a font's built-in leading information.
58
+ * @minVersion 24.1
59
+ */
60
+ get useAutoLeading(): boolean;
61
+ set useAutoLeading(useAutoLeading: boolean);
62
+ /**
63
+ * The leading amount in pixels for a 72ppi document.
64
+ * @default null
65
+ * @range 0..4999.99
66
+ * @minVersion 24.1
67
+ */
68
+ get leading(): number;
69
+ set leading(leading: number);
70
+ /**
71
+ * The amount of uniform spacing between multiple characters.
72
+ * Tracking units are 1/1000 of an em space. The width of an em space is relative
73
+ * to the current type size. In a 1-point font, 1 em equals 1 point; in a 10-point font,
74
+ * 1 em equals 10 points. So for example, 100 tracking units in a 10-point font are equivalent to 1 point
75
+ * @range -1000..1000
76
+ * @minVersion 24.1
77
+ */
78
+ get tracking(): number;
79
+ set tracking(tracking: number);
80
+ /**
81
+ * The value in pixels to use in the baseline offset of text for a 72ppi document.
82
+ * @range -1296..1296
83
+ * @minVersion 24.1
84
+ */
85
+ get baselineShift(): number;
86
+ set baselineShift(baselineShift: number);
87
+ /**
88
+ * Adjust the horizontal diacritic position for Middle Eastern languages.
89
+ * @range -1000..1000
90
+ * @minVersion 24.1
91
+ */
92
+ get horizontalDiacriticPosition(): number;
93
+ set horizontalDiacriticPosition(horizontalDiacriticPosition: number);
94
+ /**
95
+ * Adjust the vertical diacritic position for Middle Eastern languages.
96
+ * @range -1000..1000
97
+ * @minVersion 24.1
98
+ */
99
+ get verticalDiacriticPosition(): number;
100
+ set verticalDiacriticPosition(verticalDiacriticPosition: number);
101
+ /**
102
+ * The auto kerning option to use.
103
+ * @default METRICS
104
+ * @minVersion 24.1
105
+ */
106
+ get autoKerning(): Constants.AutoKernType;
107
+ set autoKerning(autoKerning: Constants.AutoKernType);
108
+ /**
109
+ * The text case.
110
+ * @default NORMAL
111
+ * @minVersion 24.1
112
+ */
113
+ get capitalization(): Constants.TextCase;
114
+ set capitalization(capitalization: Constants.TextCase);
115
+ /**
116
+ * The text baseline.
117
+ * @default NORMAL
118
+ * @minVersion 24.1
119
+ */
120
+ get baseline(): Constants.Baseline;
121
+ set baseline(baseline: Constants.Baseline);
122
+ /**
123
+ * Whether the text is strikethrough or not.
124
+ * @default STRIKEOFF
125
+ * @minVersion 24.1
126
+ */
127
+ get strikeThrough(): Constants.StrikeThrough;
128
+ set strikeThrough(strikeThrough: Constants.StrikeThrough);
129
+ /**
130
+ * The underline style to use.
131
+ * @default NONE
132
+ * @minVersion 24.1
133
+ */
134
+ get underline(): Constants.Underline;
135
+ set underline(underline: Constants.Underline);
136
+ /**
137
+ * Standard ligatures (default: true).
138
+ * @default true
139
+ * @minVersion 24.1
140
+ */
141
+ get ligatures(): boolean;
142
+ set ligatures(ligatures: boolean);
143
+ /**
144
+ * Discretionary ligatures.
145
+ * @default false
146
+ * @minVersion 24.1
147
+ */
148
+ get alternateLigatures(): boolean;
149
+ set alternateLigatures(alternateLigatures: boolean);
150
+ /**
151
+ * Fractions.
152
+ * @default false
153
+ * @minVersion 24.1
154
+ */
155
+ get fractions(): boolean;
156
+ set fractions(fractions: boolean);
157
+ /**
158
+ * Ordinals.
159
+ * @default false
160
+ * @minVersion 24.1
161
+ */
162
+ get ordinals(): boolean;
163
+ set ordinals(ordinals: boolean);
164
+ /**
165
+ * Swash.
166
+ * @default false
167
+ * @minVersion 24.1
168
+ */
169
+ get swash(): boolean;
170
+ set swash(swash: boolean);
171
+ /**
172
+ * Titling alternates.
173
+ * @default false
174
+ * @minVersion 24.1
175
+ */
176
+ get titlingAlternates(): boolean;
177
+ set titlingAlternates(titlingAlternates: boolean);
178
+ /**
179
+ * Stylistic Alternates
180
+ * @default false
181
+ * @minVersion 24.1
182
+ */
183
+ get stylisticAlternates(): boolean;
184
+ set stylisticAlternates(stylisticAlternates: boolean);
185
+ /**
186
+ * Language used as a basis for hyphenation rules and spelling.
187
+ * @minVersion 24.1
188
+ */
189
+ get language(): Constants.Language;
190
+ set language(language: Constants.Language);
191
+ /**
192
+ * Character alignment.
193
+ * When a line of text contains different sizes of characters,
194
+ * you can specify how to align text to the largest characters in the line.
195
+ * @default ROMAN
196
+ * @minVersion 24.1
197
+ */
198
+ get characterAlignment(): Constants.CharacterAlignment;
199
+ set characterAlignment(characterAlignment: Constants.CharacterAlignment);
200
+ /**
201
+ * True to disallow line breaks in this text.
202
+ * @default false
203
+ * @minVersion 24.1
204
+ */
205
+ get noBreak(): boolean;
206
+ set noBreak(noBreak: boolean);
207
+ /**
208
+ * The text color as a {@link SolidColor} instance.
209
+ * @minVersion 24.1
210
+ */
211
+ get color(): SolidColor;
212
+ set color(color: SolidColor);
213
+ /**
214
+ * Toggles kashidas in Middle Eastern languages.
215
+ * @default true
216
+ * @minVersion 24.1
217
+ */
218
+ get kashidas(): boolean;
219
+ set kashidas(kashidas: boolean);
220
+ /**
221
+ * The text direction (Middle Eastern features)
222
+ * @default DEFAULT
223
+ * @minVersion 24.1
224
+ */
225
+ get middleEasternTextDirection(): Constants.MiddleEasternTextDirection;
226
+ set middleEasternTextDirection(middleEasternTextDirection: Constants.MiddleEasternTextDirection);
227
+ /**
228
+ * The text digits type to use (Middle Eastern features)
229
+ * @default LTRARABIC
230
+ * @minVersion 24.1
231
+ */
232
+ get middleEasternDigitsType(): Constants.MiddleEasternDigitsType;
233
+ set middleEasternDigitsType(middleEasternDigitsType: Constants.MiddleEasternDigitsType);
234
+ /**
235
+ * Use fractional widths for the text.
236
+ * @default false
237
+ * @minVersion 24.1
238
+ */
239
+ get fractionalWidths(): boolean;
240
+ set fractionalWidths(value: boolean);
241
+ /**
242
+ * The text anti-aliasing
243
+ * @default SHARP
244
+ * @minVersion 24.1
245
+ */
246
+ get antiAliasMethod(): Constants.AntiAlias;
247
+ set antiAliasMethod(antiAliasMethod: Constants.AntiAlias);
248
+ /**
249
+ * Resets the text styles of the Character panel to their default values.
250
+ * @async
251
+ * @minVersion 24.1
252
+ */
253
+ reset(): Promise<void>;
254
+ }
@@ -0,0 +1,114 @@
1
+ import type * as Constants from '../Constants';
2
+ import type { HyphenationProperties, JustificationProperties } from '../types/TextTypes';
3
+ /**
4
+ * The Class that stores properties related to the Paragraph panel in the Photoshop UI.
5
+ * @minVersion 24.1
6
+ */
7
+ export class ParagraphStyle {
8
+ /**
9
+ * The paragraph justification.
10
+ * @default [LEFT](Constants.Justification)
11
+ * @minVersion 24.1
12
+ */
13
+ get justification(): Constants.Justification;
14
+ set justification(justification: Constants.Justification);
15
+ /**
16
+ * The property values used to calculate justification.
17
+ *
18
+ * @minVersion 24.1
19
+ */
20
+ get justificationFeatures(): JustificationProperties;
21
+ set justificationFeatures(features: JustificationProperties);
22
+ /**
23
+ * The amount of space in pixels to indent text from the left for a 72ppi document.
24
+ * @range -1296..1296
25
+ * @minVersion 24.1
26
+ */
27
+ get leftIndent(): number;
28
+ set leftIndent(leftIndent: number);
29
+ /**
30
+ * The amount of space in pixels to indent text from the right for a 72ppi document.
31
+ * @range -1296..1296
32
+ * @minVersion 24.1
33
+ */
34
+ get rightIndent(): number;
35
+ set rightIndent(rightIndent: number);
36
+ /**
37
+ * The amount of space in pixels to indent the first line of paragraphs for a 72ppi document.
38
+ * @range -1296..1296
39
+ * @minVersion 24.1
40
+ */
41
+ get firstLineIndent(): number;
42
+ set firstLineIndent(firstLineIndent: number);
43
+ /**
44
+ * The amount of space in pixels to use before each paragraph for a 72ppi document.
45
+ * @range -1296..1296
46
+ * @minVersion 24.1
47
+ */
48
+ get spaceBefore(): number;
49
+ set spaceBefore(spaceBefore: number);
50
+ /**
51
+ * The width of kashida (tatweel) character
52
+ * @default [MEDIUM](Constants.KashidaWidthType)
53
+ * @minVersion 24.1
54
+ */
55
+ get kashidaWidth(): Constants.KashidaWidthType;
56
+ set kashidaWidth(kashidaWidth: Constants.KashidaWidthType);
57
+ /**
58
+ * Line breaking rules in Japanese text (Kinsoku Shori)
59
+ * @default [NONE](Constants.Kinsoku)
60
+ * @minVersion 24.1
61
+ */
62
+ get kinsoku(): Constants.Kinsoku;
63
+ set kinsoku(kinsoku: Constants.Kinsoku);
64
+ /**
65
+ * Spacing between punctuation, symbols, numbers, and other character classes
66
+ * in Japanese text.
67
+ * @default [NONE](Constants.Mojikumi)
68
+ * @minVersion 24.1
69
+ */
70
+ get mojikumi(): Constants.Mojikumi;
71
+ set mojikumi(mojikumi: Constants.Mojikumi);
72
+ /**
73
+ * The amount of space in pixels to use after each paragraph for a 72ppi document.
74
+ * @range -1296..1296
75
+ * @minVersion 24.1
76
+ */
77
+ get spaceAfter(): number;
78
+ set spaceAfter(spaceAfter: number);
79
+ /**
80
+ * True to use hyphenation in word wrap.
81
+ * Use hyphenationFeatures for maximum control.
82
+ * @default false
83
+ * @minVersion 24.1
84
+ */
85
+ get hyphenation(): boolean;
86
+ set hyphenation(hyphenation: boolean);
87
+ /**
88
+ * The property values used to calculate hyphenation.
89
+ *
90
+ * @minVersion 24.1
91
+ */
92
+ get hyphenationFeatures(): HyphenationProperties;
93
+ set hyphenationFeatures(features: HyphenationProperties);
94
+ /**
95
+ * The paragraph layout mode.
96
+ * @default [WORLD](Constants.ParagraphLayout)
97
+ * @minVersion 24.1
98
+ */
99
+ get layoutMode(): Constants.ParagraphLayout;
100
+ set layoutMode(paragraphLayout: Constants.ParagraphLayout);
101
+ /**
102
+ * The paragraph UI features to display.
103
+ * @default [DEFAULT](Constants.TypeInterfaceFeatures)
104
+ * @minVersion 24.1
105
+ */
106
+ get features(): Constants.TypeInterfaceFeatures;
107
+ set features(features: Constants.TypeInterfaceFeatures);
108
+ /**
109
+ * Resets the paragraph style to its default values.
110
+ * @async
111
+ * @minVersion 24.1
112
+ */
113
+ reset(): Promise<void>;
114
+ }
@@ -0,0 +1,48 @@
1
+ import type * as Constants from '../Constants';
2
+ /**
3
+ * The Class that stores properties related to the Warp Text dialog.
4
+ * @minVersion 24.1
5
+ */
6
+ export class TextWarpStyle {
7
+ /**
8
+ * he style of warp to apply to the text.
9
+ * @default NONE
10
+ * @minVersion 24.1
11
+ */
12
+ get style(): Constants.WarpStyle;
13
+ set style(style: Constants.WarpStyle);
14
+ /**
15
+ * The warp direction
16
+ * @default HORIZONTAL
17
+ * @minVersion 24.1
18
+ */
19
+ get direction(): Constants.Direction;
20
+ set direction(direction: Constants.Direction);
21
+ /**
22
+ * The warp bend as a percentage.
23
+ * @range -100..100
24
+ * @minVersion 24.1
25
+ */
26
+ get bend(): number;
27
+ set bend(bend: number);
28
+ /**
29
+ * The horizontal distortion of the warp as a percentage.
30
+ * @range -100..100
31
+ * @minVersion 24.1
32
+ */
33
+ get horizontalDistortion(): number;
34
+ set horizontalDistortion(horizontalDistortion: number);
35
+ /**
36
+ * The vertical distortion of the warp as a percentage.
37
+ * @range -100..100
38
+ * @minVersion 24.1
39
+ */
40
+ get verticalDistortion(): number;
41
+ set verticalDistortion(verticalDistortion: number);
42
+ /**
43
+ * Reset the WarpStyle to its default values.
44
+ * @async
45
+ * @minVersion 24.1
46
+ */
47
+ reset(): Promise<void>;
48
+ }
@@ -0,0 +1,107 @@
1
+ import type { Channel } from '../Channel';
2
+ import type { ApplyImageBlendMode, ApplyImageChannel, ApplyImageLayer } from '../Constants';
3
+ import type { Document } from '../Document';
4
+ import type { Layer } from '../Layer';
5
+ /**
6
+ * Type for the Layer choice in {@link ApplyImageSource}.
7
+ * Select [ApplyImageLayer.MERGED](../constants/#applyimagelayer) to use the pixels from a merged
8
+ * or flattened version of the document.
9
+ * @targetfolder objects/options
10
+ * @optionobject
11
+ * @minVersion 24.5
12
+ */
13
+ export type ApplyImageLayerType = Layer | ApplyImageLayer.MERGED;
14
+ /**
15
+ * Type for the Channel choice in {@link ApplyImageSource}
16
+ * @targetfolder objects/options
17
+ * @optionobject
18
+ * @minVersion 24.5
19
+ */
20
+ export type ApplyImageChannelType
21
+ = | Channel
22
+ | ApplyImageChannel.RGB
23
+ | ApplyImageChannel.CMYK
24
+ | ApplyImageChannel.LAB
25
+ | ApplyImageChannel.SELECTION
26
+ | ApplyImageChannel.TRANSPARENCY;
27
+ /**
28
+ * Reference for sources to be used in Apply Image operations
29
+ * @targetfolder objects/options
30
+ * @optionobject
31
+ * @minVersion 24.5
32
+ */
33
+ export interface ApplyImageSource {
34
+ /**
35
+ * The document used as a source
36
+ * @minVersion 24.5
37
+ */
38
+ document: Document;
39
+ /**
40
+ * The layer used as a source
41
+ * @minVersion 24.5
42
+ */
43
+ layer: ApplyImageLayerType;
44
+ /**
45
+ * The channel used as a source
46
+ * @minVersion 24.5
47
+ */
48
+ channel: ApplyImageChannelType;
49
+ /**
50
+ * Whether to invert the source or not
51
+ * @minVersion 24.5
52
+ * @default false
53
+ */
54
+ invert?: boolean;
55
+ }
56
+ /**
57
+ * An object literal can be constructed with the following properties
58
+ * and passed to [Layer.applyImage](/ps_reference/classes/layer/#applyimage).
59
+ * As a type, `ApplyImageOptions` can be used in Typescript development.
60
+ *
61
+ * ```javascript
62
+ * const options = {
63
+ * source: {
64
+ * document: require('photoshop').app.documents[0],
65
+ * layer: require('photoshop').app.documents[0].layers[1],
66
+ * channel: require('photoshop').app.documents[0].channels[2],
67
+ * },
68
+ * blending: require('photoshop').constants.ApplyImageBlendMode.SCREEN,
69
+ * };
70
+ * await require('photoshop').app.activeDocument.layers[0].applyImage(options);
71
+ * ```
72
+ *
73
+ * @targetfolder objects/options
74
+ * @optionobject
75
+ * @minVersion 24.5
76
+ */
77
+ export interface ApplyImageOptions {
78
+ /**
79
+ * The source reference to be used in the Apply Image operation.
80
+ * @minVersion 24.5
81
+ */
82
+ source: ApplyImageSource;
83
+ /**
84
+ * The blend mode used to apply the source to the active layer.
85
+ * @default MULTIPLY
86
+ * @minVersion 24.5
87
+ */
88
+ blending?: ApplyImageBlendMode;
89
+ /**
90
+ * The opacity used while applying the source to the active layer.
91
+ * @range 0..100
92
+ * @default 100
93
+ * @minVersion 24.5
94
+ */
95
+ opacity?: number;
96
+ /**
97
+ * Whether to preserve the original transparency of the active layer.
98
+ * @default false
99
+ * @minVersion 24.5
100
+ */
101
+ preserveTransparency?: boolean;
102
+ /**
103
+ * The Mask reference to be used in the Apply Image operation.
104
+ * @minVersion 24.5
105
+ */
106
+ mask?: ApplyImageSource;
107
+ }
@@ -0,0 +1,119 @@
1
+ import type { Channel } from '../Channel';
2
+ import type { CalculationsBlendMode, CalculationsChannel, CalculationsLayer, CalculationsResult } from '../Constants';
3
+ import type { Document } from '../Document';
4
+ import type { Layer } from '../Layer';
5
+ /**
6
+ * Type for the Layer choice in {@link CalculationsSource}
7
+ * @targetfolder objects/options
8
+ * @optionobject
9
+ * @minVersion 24.5
10
+ */
11
+ declare type CalculationsLayerType = Layer | CalculationsLayer.MERGED;
12
+ /**
13
+ * Type for the Channel choice in {@link CalculationsSource}
14
+ * @targetfolder objects/options
15
+ * @optionobject
16
+ * @minVersion 24.5
17
+ */
18
+ export type CalculationsChannelType
19
+ = | Channel
20
+ | CalculationsChannel.GRAY
21
+ | CalculationsChannel.TRANSPARENCY
22
+ | CalculationsChannel.SELECTION;
23
+ /**
24
+ * Reference for sources (source1, source2, mask) to be used in {@link CalculationsOptions}.
25
+ * @targetfolder objects/options
26
+ * @optionobject
27
+ * @minVersion 24.5
28
+ */
29
+ export interface CalculationsSource {
30
+ /**
31
+ * The document used as a source
32
+ * @minVersion 24.5
33
+ */
34
+ document: Document;
35
+ /**
36
+ * Either a layer or the pseudo-layer that represents the merged result of all layers,
37
+ * the constant Constants.CalculationsLayer.MERGED.
38
+ * @minVersion 24.5
39
+ */
40
+ layer: CalculationsLayerType;
41
+ /**
42
+ * The channel used as a source: either a Channel instance or
43
+ * one of the Constants.CalculationsChannel values.
44
+ * @minVersion 24.5
45
+ */
46
+ channel: CalculationsChannelType;
47
+ /**
48
+ * Whether to invert the source or not
49
+ * @default false
50
+ * @minVersion 24.5
51
+ */
52
+ invert?: boolean;
53
+ }
54
+ /**
55
+ * An object literal can be constructed with the following properties
56
+ * and passed to {@link Document.calculations}.
57
+ * As a type, `CalculationsOptions` can be used in Typescript development.
58
+ *
59
+ * ```javascript
60
+ * const options = {
61
+ * source1: {
62
+ * document: doc,
63
+ * layer: doc.layers[0],
64
+ * channel: CalculationsChannel.GRAY
65
+ * invert: true
66
+ * },
67
+ * source2: {
68
+ * document: doc,
69
+ * layer: CalculationsLayer.MERGED,
70
+ * channel: doc.channels[2]
71
+ * },
72
+ * blending: CalculationsBlendMode.DARKEN,
73
+ * opacity: 50,
74
+ * result: CalculationsResult.NEWCHANNEL
75
+ * };
76
+ * await require('photoshop').app.activeDocument.calculations(options);
77
+ *
78
+ * ```
79
+ *
80
+ * @targetfolder objects/options
81
+ * @optionobject
82
+ * @minVersion 24.5
83
+ */
84
+ export interface CalculationsOptions {
85
+ /**
86
+ * The "Source 1" reference to be used in the Calculations operation. "Source 1" will be rendered above "Source 2"
87
+ * @minVersion 24.5
88
+ */
89
+ source1: CalculationsSource;
90
+ /**
91
+ * The "Source 2" reference to be used in the Calculations operation
92
+ * @minVersion 24.5
93
+ */
94
+ source2: CalculationsSource;
95
+ /**
96
+ * The blend mode used to merge "Source 1" and "Source 2" together. "Source 1" will be rendered above "Source 2"
97
+ * @default MULTIPLY
98
+ * @minVersion 24.5
99
+ */
100
+ blending?: CalculationsBlendMode;
101
+ /**
102
+ * The opacity used for "Source 1" when merged with "Source 2".
103
+ * @range 0..100
104
+ * @default 100
105
+ * @minVersion 24.5
106
+ */
107
+ opacity?: number;
108
+ /**
109
+ * The Mask reference to be used in the Calculations operation
110
+ * @minVersion 24.5
111
+ */
112
+ mask?: CalculationsSource;
113
+ /**
114
+ * Where to output the result of the Calculations operation
115
+ * @minVersion 24.5
116
+ */
117
+ result: CalculationsResult;
118
+ }
119
+ export {};