thanks for this repo, I was wondering why there's have types for illustrator 2022 and 2015.3， what about other versions ? which one should i use then ?

Hi,

I have setup my project according to the Readme file and video instructions for an Indesign script.

As I understand, Adobe Creative Cloud apps support a subset of the standard Javascript classes e.g. JSON. Inside my script I have to read a JSON file.

How do I have to update the generated Typescript project (package.json, tsconfig.json), so that I can use the support classes like JSON.

Thanks
Patrick

In some of the issues, I've seen that you'd love if people send you fresh definitions of XML files for various Adobe products. First I wanted to present theses as processed ts definitions, but then after I realized that there might be some manual changes required for each of the fields, I decided to just send you the XML files and see if that helps.

• Indesign.zip (a whole bunch of those, the 14 version is latest one)
• Illustrator 2019.zip (23 is the latest version)

The JS API doc of Illustrator (2017) contains typename fields for almost (if not all) classes.
Theses are missing from the .d.ts. I guess they're missing from the .xml definitions too? Should I open a PR for this?

I'm trying to figure out the best way to switch based on the subclass. I noticed instance.prototype returns undefined so I figured typename would be the second best. I guess I could do a big if ... else if .... using a bunch of instanceofs, but this doesn't seem very clean nor efficient.

https://github.com/pravdomil/types-for-adobe/blob/master/Photoshop/2015.5

Is there a reason for the duplicate declarations in the SolidColor class?

declare class SolidColor {
	/**
	 * The CMYK color model.
	 */
	static cmyk: CMYKColor;

	/**
	 * The CMYK color model.
	 */
	cmyk: CMYKColor;

	/**
	 * The grayscale color model.
	 */
	static gray: GrayColor;

	/**
	 * The grayscale color model.
	 */
	gray: GrayColor;

The Layer type is undefined under adobe after effects

InDesign: Types for InDesign 2021
reference to "shared/ScriptUI.d.ts" removed

The last version release was over a year ago and is pretty outdated now; can you tag a new release?

Has anyone noticed an issue using composition.markerProperty.setValueAtTime(...)? This was working until one of the latest updates (22.1). The call is failing with After Effects error: CSelectronASSERT fail: CSelectron: layer is null. Wanted to see if this was just an issue on my end, or a potential bug in the latest release?

I'm working on an Illustrator script

I usually use #import 'json2.js' at the begining of my files, but with typescript, there's a compile error. If I try to just remove the #import at the top, then I get a compile error stating "Cannot find name 'JSON'"

How can I import and get rid or these errors?

There’s no type for Premiere AudioChannelMapping: https://ppro-scripting.docsforadobe.dev/other/audiochannelmapping.html

ProjectItem.getAudioChannelMapping is missing too.
Example usage: https://github.com/Adobe-CEP/Samples/blob/e60d6a22ef44d8eb4cca3904c35a0c050576b697/PProPanel/jsx/PPRO/Premiere.jsx#L2340C30-L2340C30

OS: Debian 11
TypeScript: Version 4.7.3

The Readme file suggests to use the triple-slash directive for including type definitions. For example

/// <reference types="types-for-adobe/Premiere/14.0""/>

This doesn't work for me: I get "Cannot find type definition file for 'types-for-adobe/Premiere/14.0"'.

The only way to specify type definitions is via the tsconfig.json file, like so:

{
    [...]
    "compilerOptions": {
        [...]
        "types": [
            "types-for-adobe/Premiere/14.0"
        ]
    }
}

This API is missing from the type definitions.

http://estk.aenhancers.com/10%20-%20Scripting%20Access%20to%20XMP%20Metadata/accessing-the-xmp-scripting-api.html

I'm not sure if you have a fancy way of generating these type files. If not, I can try to make a file for this.

Is there a reason for arrow heads types missing for illustrator where as they are available for indesign types

would be great if someone can help us with this. meanwhile, is there a solution for finding a property even though a type is missing

That way people don't necessarily have to install git

Its a straight forward issue this, just need to remove readonly for TrackItem.start as per the documentation which says its read/write. I can raise a PR if you like, thanks

Extendscript allows you to multiply an array of numbers by a scalar. Typescript doesn't allow this.

var v = [0,.5,1] * 255;
v == [0,127.5, 255];

Request for additional feature - retrieving file extension, inpointTime, outPointTime in Adobe Audition's multitrack

Currently Sequence.clone() is typed to return a Sequence when it actually returns a boolean

The current type definitions incorrectly indicate that Sequence.clone() returns a Sequence object.

the ppro scripting documentation has the correct type: Sequence.clone() documentation

The @types namespace has become the canonical place for external typings. Have you considered migrating this project to https://github.com/DefinitelyTyped/DefinitelyTyped?

cc @atarabi

Hi, I am new to adobe AE script developing. The reason i raise this issue is that it's hard for me to find any official API doc for AE scripting, and thats why this repo is so useful for me.
I found some knowledge in https://helpx.adobe.com/after-effects/using/expression-language.html but most of them are deprecated.
I am sorry that probably it is not a good place to raise this question, but i am really curious how you guys find the AE API. Is there any useful suggestions for developing / debugging AE scripts?

Hey

Any idea where I can get declaration/info on
stringIDToTypeID
charIDToTypeID
executeAction
etc?

Current typing is:
findItemsMatchingMediaPath(matchString: string, ignoreSubclips?: number): void

However according to the official documentation it returns "an array of project items, or 0 if no project items matching the matchPath were found".

I noticed a error where the numItems and length properties are undefined in ComponentPropertiesCollection.
For example the followng code functions as expected during runtime, but the lack of type definitions for these properties causes linting warnings.
Property 'numItems' does not exist on type 'ComponentParamCollection'.ts(2339)

const seq = app.project.activeSequence;
  const tracks = seq.getSelection();
  for (let track of tracks) {
      let components: ComponentCollection = track.components;
      for (let i = 0; i < components.numItems; i++) {
          const comp = components[i];
          comp.properties[0]
          for (let j = 0; j < comp.properties.numItems; j++) { // !THE ISSUE
              // numItems and length is not defined in ComponentPropertiesCollection, but this exists

Argument of type '"tab"' is not assignable to parameter of type '"treeview"'
video: https://streamable.com/odl8mk

Sorry I keep making all these issues. I'm trying to convert a ton of old scripts to Typescript and finding all kinds of fun things.

One is that in the AE api, there is a kindof shorthand when dealing with Properties.

For example, you can create a "Checkbox Control" property:

var p = layer.effect.addProperty("Checkbox Control");

And you can manipulate its sub-property "checkbox" like this (which doesn't work with current typings):

p.checkbox

or, you can do it like this:

p.getProperty("checkbox")

To get this to work in Typescript, you'd need all of AE's effects in your typings, which is a heavy order considering that none of this is documented.

https://github.com/pravdomil/types-for-adobe/tree/master/Photoshop/2015.5

SaveOptionsType is undefined
ColorProfileType is undefined
PaletteType is undefined
Case is undefined
Documents is undefined
Layers is undefined
LayerSets is undefined
ArtLayers is undefined
Channels is undefined
Guides is undefined
HistoryStates is undefined
LayerComps is undefined
TextFonts is undefined
PathItems is undefined
SubPathItems is undefined
PathPoints is undefined
Notifiers is undefined
CountItems is undefined
ColorSamplers is undefined
OpenOptions is undefined
GenericPDFOpenOptions is undefined
GenericEPSOpenOptions is undefined
ExportOptions is undefined
DocumentConversionOptions is undefined
Color is undefined
Application is undefined
Document is undefined
DocumentInfo is undefined
Preferences is undefined
DocumentPrintSettings is undefined
Selection is undefined
LayerSet is undefined
ArtLayer is undefined
Layer is undefined
Channel is undefined
Guide is undefined
HistoryState is undefined
TextFont is undefined
TextItem is undefined
LayerComp is undefined
PathItem is undefined
SubPathItem is undefined
PathPoint is undefined
MeasurementLog is undefined
MeasurementScale is undefined
Notifier is undefined
CountItem is undefined
ColorSampler is undefined
XMPMetadata is undefined
Point is undefined
Rectangle is undefined

const objects = ["OpenDocumentType", "SaveDocumentType", "SaveOptionsType", "DialogModes", "DocPositionStyle", "PrintColorHandling", "DocumentMode", "ChangeMode", "ColorProfileType", "DocumentFill", "Urgency", "Orientation", "Intent", "Direction", "PurgeTarget", "AnchorPosition", "ResampleMethod", "OperatingSystem", "ForcedColors", "PaletteType", "Dither", "Preview", "SaveEncoding", "FormatOptions", "PDFEncoding", "PDFStandard", "PDFCompatibility", "PDFResample", "PICTCompression", "Extension", "TIFFEncoding", "LayerCompression", "ByteOrder", "DCSType", "TrimType", "ColorPicker", "ResetTarget", "SaveBehavior", "PaintingCursors", "OtherPaintingCursors", "GridSize", "Units", "TypeUnits", "PointType", "GridLineStyle", "GuideLineStyle", "BlendMode", "ColorBlendMode", "RasterizeType", "Justification", "AntiAlias", "Case", "Language", "TextType", "WarpStyle", "TextComposer", "AutoKernType", "StrikeThruType", "UnderlineType", "SelectionType", "ExportType", "IllustratorPathType", "ChannelType", "RadialBlurMethod", "RadialBlurQuality", "SmartBlurQuality", "SmartBlurMode", "TextureType", "PolarConversionType", "RippleSize", "UndefinedAreas", "OffsetUndefinedAreas", "SpherizeMode", "DisplacementMapType", "WaveType", "ZigZagType", "NoiseDistribution", "LensType", "EliminateFields", "CreateFields", "PhotoCDSize", "BitsPerChannelType", "PICTBitsPerPixels", "TargaBitsPerPixels", "DescValueType", "ReferenceFormType", "BMPDepthType", "CopyrightedType", "BitmapConversionType", "BitmapHalfToneType", "MatteType", "AdjustmentReference", "OpenDocumentMode", "NewDocumentMode", "PhotoCDColorSpace", "StrokeLocation", "ColorModel", "JavaScriptExecutionMode", "SourceSpaceType", "LayerKind", "TransitionType", "GalleryFontType", "GalleryConstrainType", "GalleryThumbSizeType", "GallerySecurityType", "PicturePackageTextType", "GallerySecurityTextColorType", "GallerySecurityTextPositionType", "GallerySecurityTextRotateType", "QueryStateType", "SaveLogItemsType", "EditLogItemsType", "PathKind", "ShapeOperation", "PointKind", "ToolType", "BatchDestinationType", "FileNamingType", "DepthMapSource", "Geometry", "ColorReductionType", "CameraRAWSettingsType", "WhiteBalanceType", "ColorSpaceType", "CameraRAWSize", "MagnificationType", "CropToType", "FontPreviewType", "FontSize", "MeasurementSource", "MeasurementRange", "Documents", "Layers", "LayerSets", "ArtLayers", "Channels", "Guides", "HistoryStates", "LayerComps", "TextFonts", "PathItems", "SubPathItems", "PathPoints", "Notifiers", "CountItems", "ColorSamplers", "OpenOptions", "PhotoCDOpenOptions", "RawFormatOpenOptions", "GenericPDFOpenOptions", "GenericEPSOpenOptions", "DICOMOpenOptions", "CameraRAWOpenOptions", "SaveOptions", "PhotoshopSaveOptions", "BMPSaveOptions", "GIFSaveOptions", "EPSSaveOptions", "JPEGSaveOptions", "PDFSaveOptions", "PICTFileSaveOptions", "PICTResourceSaveOptions", "PixarSaveOptions", "PNGSaveOptions", "RawSaveOptions", "SGIRGBSaveOptions", "TargaSaveOptions", "TiffSaveOptions", "DCS1_SaveOptions", "DCS2_SaveOptions", "ExportOptions", "ExportOptionsIllustrator", "ExportOptionsSaveForWeb", "DocumentConversionOptions", "BitmapConversionOptions", "IndexedConversionOptions", "Color", "SolidColor", "GrayColor", "RGBColor", "CMYKColor", "LabColor", "HSBColor", "NoColor", "PresentationOptions", "GalleryOptions", "GalleryBannerOptions", "GalleryImagesOptions", "GalleryThumbnailOptions", "GalleryCustomColorOptions", "GallerySecurityOptions", "ContactSheetOptions", "PicturePackageOptions", "BatchOptions", "SubPathInfo", "PathPointInfo", "ActionDescriptor", "ActionList", "ActionReference", "Application", "Document", "DocumentInfo", "Preferences", "DocumentPrintSettings", "Selection", "LayerSet", "ArtLayer", "Layer", "Channel", "Guide", "HistoryState", "TextFont", "TextItem", "LayerComp", "PathItem", "SubPathItem", "PathPoint", "MeasurementLog", "MeasurementScale", "Notifier", "CountItem", "ColorSampler", "XMPMetadata", "Point", "Rectangle", "ElementPlacement"];

main();

function main() {
    let mutableOut = "";
    
    for (const object of objects) {
        const result = check(object);
        mutableOut += (result === true ? "" : result + "\n");
    }
    
    alert("Result\n" + mutableOut);
}

function check(object: string) {
    try {
        eval(object);
        
        return true;
        
    } catch (e) {
        return e;
    }
}

Properties (mValueA, mValueB, ...) in Matrix should not be static.

When I found this repository, I thought that you can generate the same but up-to-date TS definitions with this script: https://github.com/pravdomil/ExtendScript-XML-to-TypeScript

However, by doing so and comparing results, I noticed that resulting files differ. For example, the general/JavaScript.d.ts definition contains interfaces for all standard stuff, whereas if you generate the same file with the abovementioned script, you'll get standard stuff declared as classes.

Apparently, the generator script is either outdated or some files, such as javascript.xml, are supposed to be manually fixed to be compatible with other definitions in this repository.

Could you please clarify this? Is there a newer version of the generator script?

Hello!
Great package! But in my angular application, I get lots of 'Duplicate' errors. Example:

In my angular service, I do
import 'types-for-adobe/Illustrator/2015.3/index.d';

Then I can use 'app.activeDocument', but the Document members (like 'name') are not accessible.

Additionally, I get duplicate errors on transpile:

node_modules/typescript/lib/lib.dom.d.ts (3470,13): Duplicate identifier 'Document'.
node_modules/types-for-adobe/Illustrator/2015.3/index.d.ts (8453,15): Duplicate identifier 'Document'.

What am I doing wrong?
Thanks
Stefa

Is Acrobat Pro DC going to have the same scripting ability(Type Def.)?

I use it to create individual lesson plans for my students. Currently, file changes are done manually. The ability to call insert, replace and delete API routines would greatly help the process. It would also give me information on the current student documents so I can automate this task. Less time scripting; more time teaching!

I'm learning Java Script for this!

Hi,

Thanks for making those type definitions, this is really helpful to be able to use TypeScript for Adobe products!

This is a sample config for tsconfig.json and package.json:

// tsconfig.json
{
  "compilerOptions": {
    "module": "none",
    "noLib": true,
    "types": ["types-for-adobe/Photoshop/2015.5"],
    "strict": true,
    "target": "ES3",
    "downlevelIteration": true
  },
  "include": ["src/**/*"]
}

// package.json
{
  // ...
  "dependencies": {
    "types-for-adobe": "^7.0.12",
    "typescript": "^4.9.5"
  }
}

I found that this minimal example compiles but raise a TypeScript error during compilation:

// error TS2318: Cannot find global type 'Extract'.
function fn<T>(object: T) {
  for (const key in object) {}
}

// Note that this works:
function fn(object: any) {
  for (const key in object) {}
}

I don't know the internals of how the for ... in gets compiled using generics but it made me realize that I can't use any of the utility types when using "noLib": true in tsconfig.json:

// error TS2304: Cannot find name 'Extract'.
type T0 = Extract<"a" | "b" | "c", "a" | "f">;

This is because utility types are located in lib.es5.d.ts therefore not included with noLib.

I can still copy the Extract type definition in my project but maybe we can include them in the repository?

// Compiles fine
type Extract<T, U> = T extends U ? T : never;

function fn<T>(object: T) {
  for (const key in object) {}
}

Thanks!

Is there a reason the After Effects AnyProperty type does not include TwoDProperty or ThreeDProperty? If not, happy to make a PR, just not sure if there is something I'm missing!

https://github.com/aenhancers/Types-for-Adobe/blob/1f034bc39513e9a5d7a386a233e98b6a38b0f00d/AfterEffects/22.0/index.d.ts#L1933-L1950

• Objects ExportOptions* (ExportOptionsSVG, ExportOptionsPDF, ...) have all properties public and instance, not static.
• Type TextFrame is TextFrameItem by Adobe documentation.

In all SaveOptions the static objects are not accessible when instantiating a SaveOptions object

Example:

let saveOpts = new TiffSaveOptions();
saveOpts.alphaChannels = false;  // ts error: Property 'alphaChannels' does not exist on type 'TiffSaveOptions'.

Should update to:

declare class TiffSaveOptions {
	/**
	 * If true, the alpha channels are saved.
	 */
	static alphaChannels: boolean;
        alphaChannels: boolean;

	/**
	 * If true, the annotations are saved.
	 */
	static annotations: boolean;
	annotations: boolean;

        ...

Using the library types for an After Effects script, TypeScript will produce an error for array arguments to Property.setValue().
For example:

layer.position.setValue([100, 100]);

results in the error for each element in the array:

Type 'number' is not assignable to type 'never'.ts(2322)

This occurs when attempting to pass both [number, number] as well as [number, number, number]. Erroneously passing a string to setValue() in these cases actually gives a more insightful error:

Argument of type 'string' is not assignable to parameter of type 'never'.
  The intersection 'TwoDPoint & ThreeDPoint' was reduced to 'never' because property 'length' has conflicting types in some constituents.ts(2345)

Thus, somewhere the union type TwoDProperty | ThreeDProperty results in an intersection with conflicting values for the property value type tuple length and cannot be satisfied.

This probably could be resolved with generics or type narrowing, if we were writing in TypeScript rather than ExtendScript.

Environment

[email protected]
Types: types-for-adobe/AfterEffects/18.0
TypeScript: 4.7.3

Workaround

Add /* @ts-ignore */ before any line calling setValue() on a tuple Property. Ignoring type checking defeats the purpose of using types. Note: // @ts-ignore does not work, because the AfterEffects script engine will complain.

Please add types for the new functionality introduced for After Effects 24.0

Hi @pravdomil!

I just discovered this repo on Adobe Dev's Slack, this is really cool 👍

1. We can now use TypeScript for .jsx if I understand it right?
2. Do you know if someone did the declaration file for "CSInterface.js" for HTML5 panels?
3. How much work do you think is needed approximately to support CC2017?

Thanks for this library, it is making me not as sad to get back into writing some scripts for AE.

Do you know a way to get Typescript to understand the Extendscript File object -- essentially overriding the default Javascript File object?

For now I am just adding @ts-ignore before all references to the File object...

I guess we will have to include ScriptUI by default in the Photoshop definition and remove the Point type from it?

Since AI 24.0 a UUID property has been added to the PageItem object, and a related getPageItemFromUuid() method has been added to the document object.

Document.getPageItemFromUuid (uuid: string) : PageItem
--
  | Adobe Illustrator 24 Type Library
  | Retrieves the pageitem using Uuid.
  | uuid: Data Type: string
  | Uuid of pageitem.

PageItem.uuid  (Read Only)
--
  | Data Type: string
  | Adobe Illustrator 24 Type Library
  | The item's unique identifier.

I've tested this in AU 24.1.3 and works as described, see https://community.adobe.com/t5/illustrator/what-s-new-in-illustrator-scripting-cc2020/td-p/10772375?page=1

Tested with Group.alignChildren for InDesign CC 2018. I assume this issue affects the _Control alignment definition as well as other alignChildren definitions.

http://jongware.mit.edu/idcs6js/pc_Group%20(SUI).html according to this(as well as testing in InDesign CC 2018) alignment can take an argument of the form [horizontal: string, vertical: string]. By extension(and testing) alignChildren can as well.

The doc comment in ScriptUI.d.ts for alignment mentions that but alignChildren does not.

Created new index.d.ts for Adobe InDesign 2021 from omv$indesign-16.064$16.1.xml and fixed manually some issues.
Pull request #78 + #79

So we can extend them?

Something like:

interface PropertyGroup {
    // ...
}

declare var PropertyGroup: {
    prototype: PropertyGroup;
}

I am making a package with helpers for AE that patch some prototypes, like:

PropertyGroup.prototype.forEach = function (cb) {
  for (var i = this.numProperties; i > 0; i -= 1) {
    cb(this.property(i), i - 1, this)
  }
}

PropertyGroup.prototype.map = function (cb) {
  const result = []
  for (var i = this.numProperties; i > 0; i -= 1) {
    result.push(cb(this.property(i), i - 1, this))
  }
  return result
}

To add types for this, I would need the PropertyGroup to be an interface so I can "re-open" it and add my new methods to it.

Version used

InDesign 2018 index.d.ts with InDesign Creative Cloud 2018.

I'm using my fork of the repo. All I've really changed is made InDesign 2018 request ScriptUI automatically and deleted various conflicts from InDesign2018/index.d.ts.

I don't think that has anything to do with the bug.

TLDR

app.books.everyItem() claims to return Book[] actually returns Book.

The madness

app.books returns a Books object. app.books.everyItem() claims(at http://jongware.mit.edu/idcs6js/pc_Books.html and in the type defs in index.d.ts) that it returns Book[]. In fact, it returns Book. But a weird Book that sort of proxies messages to the underlying Book objects. This link explains what they are actually doing: http://www.indiscripts.com/post/2010/06/on-everyitem-part-1.

So, for instance, app.books.everyItem() instanceof Book === true. Mad.

Potential fix(es)

Getting an array of Books

If you actually want an array of Books you need to call app.books.everyItem().getElements(). You can't call app.books.getElements(). getElements() will return an array when called on a normal single book as well as the object reference book returned by everyItem(). An extremely wat moment if I ever saw one.

Fixing the type signatures

The method signature for everyItem should be Book. Plus maybe some sort of documentation warning explaining that crazy things are going on when you call that. Maybe even mention needing to chain with getElements to get an array.

edit. Thank you very much for this project, by the way. I'm just getting started with ID scripting and it would be a lot more hellish without it.

The correct value is 2035.

https://github.com/pravdomil/Types-for-Adobe/blob/a7a1ea8db7bf6848ee4b8abcb57004eba62c9863/AfterEffects/2018/index.d.ts#L106

https://help.github.com/articles/adding-a-license-to-a-repository/

I would like to contribute, but am unsure if this is a possibility since there is no license

Right now ScriptUI.d.ts contains declarations such as:

declare type Point = _Point | [number, number]
declare class _Point { ...

https://github.com/pravdomil/Types-for-Adobe/blob/master/shared/ScriptUI.d.ts#L2030

The problem with this is that it prevents one from writing:

const p = new Point(1, 2);

The compiler will yell when you do this:

error TS2693: 'Point' only refers to a type, but is being used as a value here.

Point is actually a class, so I think it should be declared as one.

Does it make sense to change it to:

declare type _Point = Point | [number, number]
declare class Point { ...

cc @vespakoen