v45

README.md

@@ -1,37 +1,39 @@
 # Adobe XD Plugin API typings
-Typings for Adobe XD API Surfaces
-![typings-supported autocompletion features in JetBrains WebStorm](image.png)
-
-Detailed instructions for using these type declarations to get autocompletion features in editors and IDEs can be found in the [repository's wiki](https://github.com/AdobeXD/typings/wiki/Autocompletion-in-editors-and-IDEs).
+Typings for [Adobe XD](https://www.adobe.io/xd/uxp/develop/reference/xd-index/) and (UXP)[https://www.adobe.io/xd/uxp/uxp/] Plugin Development 
 
-## Download
-The best option to download the typings is to download the latest release from <https://github.com/AdobeXD/typings/releases>.
+![typings-supported autocompletion features in JetBrains WebStorm](image.png)
 
 ## Getting started
-These Type Declaration files provide your IDE (e.g. Visual Studio Code or WebStorm) with information about the XD API surface, enabling type checking, autocomplete suggestions, and more. To get started, simply copy the following resources from this repo into your project's main directory:
-
-- The `jsconfig.json` file.
-- The `types` directory.
-
-Your IDE may require further setup to take full advantage of the types. Please see this [wiki page](https://github.com/AdobeXD/typings/wiki/Autocompletion-in-editors-and-IDEs#editor--ide-specific-instructions) for more.
-
-The Type Declaration files also allow you to use TypeScript instead of JavaScript for your plugin development. For that, you'll have to copy the `types` folder to your project and include it in the `paths` of your `tsconfig.json`:
-```json
-{
-  "paths": {
-    "*": [
-      "types/*"
-    ]
+These Type Declaration files provide your IDE (e.g. Visual Studio Code or WebStorm) with information about the XD API surface, enabling type checking, autocomplete suggestions, and more. 
+
+To get started
+- install the package via npm: 
+  ```
+  npm i @adobexd/typings`
+  ```
+- add the typings file to `"typeRoots"` your `jsconfig.json` or `tsconfig.json`:
+  ```json
+  {
+    "compilerOptions": {
+      "typeRoots": ["node_modules/@adobexd/typings"]
+    },
   }
-}
-```
-
-You may also take a look at the `tsconfig.json` file contained in this repository for reference.
-
-## One last thing
+  ```
+- (optional) add the [UXP WebComponents](https://www.adobe.io/xd/uxp/uxp/reference-spectrum/) to the `JSX.IntrinsicElements` namespace by adding a reference to a `types.d.ts` file
+  ```ts
+  /// <reference path="./node_modules/@adobexd/typings/uxp/jsxWebComponents.d.ts" />
+  ```
+
+
+## About these type files
 These type declarations track the contents of the official documentation. If an issue with the type declarations stems from an issue with the official documentation, then the type declaration files will be fixed once the issue is addressed in the documentation. This is intentional so as to keep the type declarations both maintainable and in sync with the documentation.
 
 A few notable exceptions include:
-- `scenegraph.SceneNode` and `scenegraph.RootNode`, are documented as classes, but implemented as interfaces (in the TypeScript-sense, i.e., without a constructor), which is how they get declared in the typings
-- To avoid ambiguity with the *DOM* `Selection` type, the interface [`Selection`](https://adobexdplatform.com/plugin-docs/reference/selection.html) is implemented under the name `XDSelection` (in the global namespace), here.
-- The `LinearGradient` type is incorrectly documented as [`LinearGradientFill`](https://adobexdplatform.com/plugin-docs/reference/LinearGradientFill.html). This is implemented "the right way" in the typings.
+- The [`application.import()`](https://www.adobe.io/xd/uxp/develop/reference/application/#import) function cannot be declared because `import` is a reserved TypeScript keyword (not sure if this can be fixed). It is declared as `application.importFiles()` instead.
+- To avoid ambiguity with the *DOM* `Selection` type, the interface [`Selection`](https://www.adobe.io/xd/uxp/develop/reference/selection/) is also provided as an alias `XDSelection` and exported from the `'scenegraph'` module
+
+## Original Documentation Links
+- [New Adobe.io XD Docs](https://www.adobe.io/xd/uxp/develop/reference/xd-index/)
+- [New Adobe.io XD Docs GitHub Repo](https://github.com/AdobeDocs/uxp-xd/tree/main/src/pages/develop/reference)
+- [Adobe XD API Updates and Changelog](https://www.adobe.io/xd/uxp/develop/changelog/)
+- [Original Adobe XD Platform Docs](https://adobexdplatform.com/plugin-docs/reference/xd-index.html)

index.d.ts

@@ -0,0 +1,11 @@
+// Type definitions for Adobe XD and UXP v45.0.0
+// Project: https://www.adobe.io/xd/uxp/develop/reference/xd-index/
+// Definitions by: James Bradford <https://github.com/arniebradfo/>
+//                 Pablo Klaschka <https://github.com/pklaschka/>
+//                 Eric Robinson <https://github.com/ericdrobinson/>
+//                 Kerri Shotts <https://github.com/kerrishotts/>
+//                 Jonathan Fontanez <https://github.com/tato123/>
+// Definitions: https://github.com/AdobeXD/typings
+
+import './xd'
+import './uxp'

package.json

@@ -1,27 +1,40 @@
 {
   "name": "@adobexd/typings",
-  "version": "25.0.0",
-  "types": "./types/index.d.ts",
+  "version": "45.0.0",
+  "main": "",
+  "types": "index.d.ts",
   "description": "Typings for Adobe XD CC",
+  "license": "MIT",
+  "homepage": "https://github.com/AdobeXD/typings#readme",
   "repository": {
     "type": "git",
     "url": "[email protected]:AdobeXD/typings.git"
   },
+  "bugs": {
+    "url": "https://github.com/AdobeXD/typings/issues"
+  },
+  "files": [
+    "index.d.ts",
+    "xd",
+    "uxp"
+  ],
   "keywords": [
-    "typescript",
     "adobe-xd",
     "xd",
     "adobexd",
     "plugins",
+    "types",
+    "@types",
     "typings",
-    "typescript definitions"
+    "typescript definitions",
+    "typescript"
   ],
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/AdobeXD/typings/issues"
-  },
-  "homepage": "https://github.com/AdobeXD/typings#readme",
   "contributors": [
+    {
+      "name": "James Bradford",
+      "email": "[email protected]",
+      "url": "https://github.com/arniebradfo"
+    },
     {
       "name": "Pablo Klaschka",
       "email": "[email protected]",
@@ -43,4 +56,4 @@
       "url": "https://github.com/tato123"
     }
   ]
-}
+}

sample.js

@@ -1,32 +1,32 @@
-const {Text, Ellipse, Color} = require("scenegraph");
-const clipboard = require("clipboard");
-const shell = require("uxp").shell;
-const fs = require("uxp").storage.localFileSystem;
+const { Text, Ellipse, Color } = require('scenegraph');
+const clipboard = require('clipboard');
+const shell = require('uxp').shell;
+const fs = require('uxp').storage.localFileSystem;
 const assets = require('assets');
 const uxp = require('uxp');
 
 /**
- * @param {XDSelection} selection
+ * @param {import('scenegraph').Selection} selection
  * @param {import('scenegraph').RootNode} documentRoot
  */
 async function test(selection, documentRoot) {
     for (const node of selection.items) {
-        console.log("Hello world: ", node);
+        console.log('Hello world: ', node);
         if (node instanceof Text) {
             clipboard.copyText(node.text);
         } else if (node instanceof Ellipse) {
-            node.fill = new Color("#ffaaee");
+            node.fill = new Color('#ffaaee');
             await shell.openExternal('https://adobe-xd.gitbook.io/plugin-api-reference/uxp-api-reference/network-apis/shell');
         }
     }
     const tempFolder = await fs.getTemporaryFolder();
-    const newFile = await tempFolder.createFile("tempfile.txt", {overwrite: true});
-    await newFile.write("Hello, world!");
-    await newFile.moveTo(tempFolder, {overwrite: true});
+    const newFile = await tempFolder.createFile('tempfile.txt', { overwrite: true });
+    await newFile.write('Hello, world!');
+    await newFile.moveTo(tempFolder, { overwrite: true });
 
     const anotherFile = await tempFolder.getEntry('tempfile.txt');
     if (anotherFile.isFile) {
-        anotherFile.write("Good day");
+        anotherFile.write('Good day');
     } else if (anotherFile.isFolder) {
         console.log("That's a folder. It shouldn't be a folder. What have you done?")
     }
@@ -40,3 +40,4 @@ module.exports = {
         test: test
     }
 };
+

tsconfig.json

@@ -1,18 +1,25 @@
 {
-  "compilerOptions": {
-    "strict": true,
-    "target": "es2015",
-    "baseUrl": "./",
-    "allowJs": true,
-    "checkJs": true,
-    "lib": [
-      "es2015",
-      "dom"
-    ],
-    "typeRoots": [
-      "./types/index.d.ts",
-      "node_modules/@types"
-    ],
-    "types": ["./types", "node_modules/types"]
-  }
-}
+    "compilerOptions": {
+        "target": "es2015",
+        "module": "commonjs",
+        "baseUrl": "./",
+        "typeRoots": [
+            "./"
+        ],
+        "types": [],
+        "lib": [
+            "es2015",
+            "dom"
+        ],
+        "checkJs": true,
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "forceConsistentCasingInFileNames": true,
+        "noEmit": true
+    },
+    "files": [
+        "index.d.ts"
+    ]
+}

tslint.json

@@ -0,0 +1,3 @@
+{
+    "extends": "@definitelytyped/dtslint/dt.json"
+}