{"id":13579959,"url":"https://github.com/docsforadobe/Types-for-Adobe","last_synced_at":"2025-04-06T00:30:33.167Z","repository":{"id":37963733,"uuid":"101342293","full_name":"docsforadobe/Types-for-Adobe","owner":"docsforadobe","description":"TypeScript types for Adobe: AfterEffects, Animate, Audition, Illustrator, InDesign, Photoshop, Premiere, ScriptUI.","archived":false,"fork":false,"pushed_at":"2024-07-15T09:59:03.000Z","size":10936,"stargazers_count":507,"open_issues_count":29,"forks_count":122,"subscribers_count":21,"default_branch":"master","last_synced_at":"2024-08-04T09:09:18.418Z","etag":null,"topics":["adobe","extendscript","typescript"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docsforadobe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":"Audition/2015.2/index.d.ts","citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-24T22:21:49.000Z","updated_at":"2024-07-31T07:19:12.000Z","dependencies_parsed_at":"2024-01-21T21:46:18.958Z","dependency_job_id":"c8ac4aa1-f664-489f-9dba-33a5804c8926","html_url":"https://github.com/docsforadobe/Types-for-Adobe","commit_stats":{"total_commits":558,"total_committers":17,"mean_commits":32.8235294117647,"dds":"0.20250896057347667","last_synced_commit":"e5b482f30ef55a6800e038c6d1467c111a0a68f9"},"previous_names":["bbb999/types-for-adobe","docsforadobe/types-for-adobe","aenhancers/types-for-adobe","pravdomil/types-for-adobe"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docsforadobe%2FTypes-for-Adobe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docsforadobe%2FTypes-for-Adobe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docsforadobe%2FTypes-for-Adobe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docsforadobe%2FTypes-for-Adobe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docsforadobe","download_url":"https://codeload.github.com/docsforadobe/Types-for-Adobe/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247419597,"owners_count":20936009,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["adobe","extendscript","typescript"],"created_at":"2024-08-01T15:01:45.276Z","updated_at":"2025-04-06T00:30:33.161Z","avatar_url":"https://github.com/docsforadobe.png","language":"Shell","readme":"\u003cdiv align=\"center\"\u003e\n\n# TypeScript types for Adobe Products\n\nRepository for typedef files for various Adobe Creative Cloud products.\n\n[\u003cimg src=\"https://i.imgur.com/VMx9MeE.jpg\" width=\"560\" height=\"315\" /\u003e](http://youtu.be/h-c7A8pQzx8)\n\n![gif](_resources/gif.gif)\n\n\u003c/div\u003e\n\n---\n\n## Prerequisites\n\n* [Node.js](https://nodejs.org/en/download/)\n* [TypeScript](https://typescriptlang.org/#download-links)\n* [git](https://git-scm.com/)\n\n---\n\n## Your first script for eg. Adobe Illustrator\n\n```bash\n# create new folder\nmkdir my-script\ncd my-script\n\n# install types-for-adobe\nnpm init -y\nnpm i types-for-adobe\n\n# create tsconfig.json\nprintf '{\"compilerOptions\":{\"module\":\"none\",\"noLib\":true}}' \u003e tsconfig.json\n\n# create index.ts and change reference types to Adobe product you're targeting\nprintf '/// \u003creference types=\"types-for-adobe/Illustrator/2015.3\"/\u003e\\nalert(String(app));\\n' \u003e index.ts\n\n# compile typescript files\ntsc\n\n# open Adobe Illustrator -\u003e File -\u003e Scripts -\u003e Other Script -\u003e and open index.js\n```\n\n---\n\n## FAQ\n\n### Where do these typedefs come from?\n\nEverything in this project was generated through one of the following methods:\n\n1. Using this [extendscript-xml-to-typescript converter](https://github.com/aenhancers/extendscript-xml-to-typescript) tool to convert scripting dictionaries to typedef format\n   - *note that this only works for a few select apps, and has been found to generate incorrect data in some cases*\n2. By hand, through referencing Adobe's official release announcements \u0026 developer exploration through the API.\n\n### Why are there different versions of docs per version of each host app?\n\nThis repo aims to maintain a history of typedefs _for each given version of each hostapp_.\n\nThis way, if you're developing a tool aimed at, say, Adobe After Effects v18.0, you can have your tool specifically use _those_ typedefs, and know that you're not using features that were introduced in a later version.\n\n#### Why does this matter?\n\n**For public, commercial tools:** with some hostapps, it's generally accepted that the app's user base will be spread out among multiple versions of the software. Targeting a slightly older version ensures wider adoption than focusing solely on the latest version.\n\n**For internal, proprietary tools:** some companies mandate that all artists use a specific (older) version; having separate definitions for that version allows for this specific targeting.\n\n### Which should I use?\n\nThis really depends on your needs; if you're hoping to release a commercial tool and assume that all users are using a specific version or newer, use that! If you need to leverage a feature added at a specific point, use those typedefs instead \u0026 let your users know this is the minimum supported version.\n\n### Why are some release versions missing?\n\nTwo possible answers! Either\n\n1. There haven't been any API changes for that given version, or\n2. Nobody's taken the time to add typedefs for that version; feel free to [open a PR](https://github.com/aenhancers/Types-for-Adobe/pulls)!\n\n---\n\n## Contributors\n\nThanks to [all of our contributors](https://github.com/aenhancers/Types-for-Adobe/graphs/contributors) for helping make this project succeed!\n\nHave something to add? Please [open a PR](https://github.com/aenhancers/Types-for-Adobe/pulls)!\n\n---\n\n## More typings\n\n- [Adobe's offical typings](https://github.com/Adobe-CEP/Samples/tree/master/TypeScript/typings)\n- [BrightShadow/CSInterface-TS](https://github.com/BrightShadow/CSInterface-TS)\n","funding_links":[],"categories":["Shell"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocsforadobe%2FTypes-for-Adobe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocsforadobe%2FTypes-for-Adobe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocsforadobe%2FTypes-for-Adobe/lists"}