feat: add TypeScript definitions

package.json

@@ -12,7 +12,7 @@
   "scripts": {
     "lint": "eslint src test bin",
     "mocha": "mocha",
-    "test": "npm run lint && npm run mocha"
+    "test": "npm run lint && npm run mocha && tsd src"
   },
   "bin": {
     "electron-installer-dmg": "bin/electron-installer-dmg.js"
@@ -31,12 +31,14 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@electron/get": "^1.1.0",
+    "@types/appdmg": "^0.5.1",
     "cross-zip": "^2.1.5",
     "eslint": "^5.16.0",
     "eslint-config-airbnb-base": "^13.0.0",
     "eslint-plugin-import": "^2.13.0",
     "mocha": "^6.1.4",
-    "rimraf": "^2.6.2"
+    "rimraf": "^2.6.2",
+    "tsd": "0.17.0"
   },
   "keywords": [
     "mongodb.js",

src/index.d.ts

@@ -0,0 +1,57 @@
+import appdmg = require('appdmg');
+
+declare namespace createDMG {
+  /**
+   * The content that will appear in the window when the user opens the .dmg file.
+   */
+  interface Content {
+    path: string;
+    type: 'link' | 'file';
+    x: number;
+    y: number;
+  }
+
+  interface DMGOptions {
+    /**
+     * Additional options to pass through to [`appdmg`](https://npm.im/appdmg).
+     * You can use this to set additional features like `background-color` and `code-sign`.
+     * See the docs of the `appdmg` module for all possible options.
+     */
+    additionalDMGOptions?: Partial<appdmg.Specification>;
+    /**
+     * The `.app` directory generated by
+     * [electron-packager](https://github.com/electron/electron-packager).
+     */
+    appPath: string;
+    /** Path to the background for the DMG window. Background image should be of size 658×498. */
+    background?: string;
+    /**
+     * The content that will appear in the window when user opens the .dmg file.
+     * [Default: Array of two icons, application and application destination folder].
+     */
+    contents?: Content[] | ((opts?: DMGOptions) => Content[]);
+    /** Enable debug message output. */
+    debug?: boolean;
+    /** Disk image format. [Default: `UDZO`]. */
+    format?: 'UDRW' | 'UDRO' | 'UDCO' | 'UDZO' | 'UDBZ' | 'ULFO';
+    /** Path to the icon to use for the app in the DMG window. */
+    icon?: string;
+    /** How big to make the icon for the app in the DMG. [Default: `80`]. */
+    iconSize?: number;
+    /** The application name. */
+    name: string;
+    /** The directory to put the DMG into. [Default: `process.cwd()`]. */
+    out?: string;
+    /** Overwrite an existing DMG file if if already exists. */
+    overwrite?: boolean;
+    /** The title of the produced DMG, which will be shown when mounted. */
+    title?: string;
+  }
+}
+
+/**
+ * Generate a DMG for a bundled & customized Electron app.
+ */
+declare function createDMG(createOptions: createDMG.DMGOptions): Promise<createDMG.DMGOptions>;
+
+export = createDMG;

src/index.test-d.ts

@@ -0,0 +1,40 @@
+import {expectType} from 'tsd';
+import createDMG = require('.');
+
+expectType<Promise<createDMG.DMGOptions>>(createDMG({
+  appPath: '',
+  name: 'my dmg',
+}));
+
+expectType<Promise<createDMG.DMGOptions>>(createDMG({
+  contents: [
+    { x: 448, y: 344, type: 'link', path: '/Applications' },
+    { x: 192, y: 344, type: 'file', path: '/path/to/application.app' },
+  ],
+  appPath: '',
+  name: 'my dmg',
+}));
+
+function getContents(): createDMG.Content[] {
+  return [
+    { x: 448, y: 344, type: 'link', path: '/Applications' },
+    { x: 192, y: 344, type: 'file', path: '/path/to/application.app' },
+  ];
+}
+
+expectType<Promise<createDMG.DMGOptions>>(createDMG({
+  contents: getContents,
+  appPath: '',
+  name: 'my dmg',
+}));
+
+expectType<Promise<createDMG.DMGOptions>>(createDMG({
+  appPath: '',
+  format: 'UDBZ',
+  additionalDMGOptions: {
+    window: {
+      position: { x: 100, y: 100 },
+    },
+  },
+  name: 'my dmg',
+}))