node-appdmg

The JSON input defines the appearance and contents of the DMG. All paths within the JSON are relative to the location of the JSON file itself.

Root Properties

• title (string, required): The title of the produced DMG shown when mounted.
• icon (string, optional): Path to the icon shown when mounted.
• background (string, optional): Path to the background image.
• background-color (string, optional): Background color (accepts CSS colors).
• icon-size (number, optional): Size of all icons inside the DMG.
• format (enum[string], optional): Disk image format (e.g., UDRW, UDRO, UDZO, ULFO).
• filesystem (enum[string], optional): Disk image filesystem (HFS+ or APFS).
• window (object, optional): Window positioning and size.
• code-sign (object, optional): Options for code signing.
• contents (array[object], required): The files or links to include in the DMG.

Window Configuration

• window.position: { x: number, y: number } (x is relative to left of screen, y is relative to bottom).
• window.size: { width: number, height: number }.

Contents Configuration

Each object in the contents array requires:

• x (number, required): X position relative to icon center.
• y (number, required): Y position relative to icon center.
• type (enum[string], required): link (creates a link), file (adds a file), or position (positions a present file).
• path (string, required): Path to the file or target.
• name (string, optional): Name of the file within the DMG.

Code Signing

• code-sign.signing-identity (string, required): The identity used to sign the DMG.
• code-sign.identifier (string, optional): Explicit unique identifier string.

{
  "title": "Test Application",
  "icon": "test-app.icns",
  "background": "test-background.png",
  "contents": [
    { "x": 448, "y": 344, "type": "link", "path": "/Applications" },
    { "x": 192, "y": 344, "type": "file", "path": "TestApp.app" }
  ]
}

You can integrate appdmg into your JavaScript applications. The API accepts either a source file path or a specification object directly.

If using a specification object, provide a basepath to resolve relative paths.

The function returns an EventEmitter that emits several events:

• progress: Emits { current, total, type, title, status }. type is step-begin or step-end. status is ok, skip, or fail.
• finish: Emitted when the DMG is successfully created.
• error: Emitted when an error occurs.

const appdmg = require('appdmg');

// Using a source file
const ee = appdmg({ source: 'test/appdmg.json', target: 'test.dmg' });

// OR using a specification object directly
const ee = appdmg({
  target: 'test.dmg',
  basepath: __dirname,
  specification: {
    "title": "Test Title"
  }
});

ee.on('progress', function (info) {
  // info.current, info.total, info.type, info.title, info.status
});

ee.on('finish', function () {
  // DMG is ready
});

ee.on('error', function (err) {
  // Handle error
});

The appdmg function consumes a specification object (or a JSON file) to define the DMG's contents and appearance. Based on the source code, the following top-level keys are used to configure the image:

Window Configuration Object:

• window.size: { width: number, height: number }
• window.position: { x: number, y: number }