Mac Automation – Javascript (JSX) Hotkey helpers

hotkey_helpers.js

// How to use:
//   1. Open "Script Editor" (requires OS X 10.10 Yosemite)
//   2. Change the language from "AppleScript" to "JavaScript"
//   3. Paste the code below and replace the safari example.
//
// More info:
// https://developer.apple.com/library/mac/releasenotes/InterapplicationCommunication/RN-JavaScriptForAutomation/index.html

var sys_events = Application("System Events");

// More keycodes can be added. Keycode reference:
// http://www.codemacs.com/coding/applescript/applescript-key-codes-reference.8288271.htm
var key_codes = {
	"→": 124,
	"←": 123,
	"↑": 126,
	"↓": 125,
	"⏎": 36,  // Return
	"⇥": 48,  // Tab
	"⌫": 51,  // Delete
	"⎋": 53   // Escape
};
var modifiers = {
	"⌘": "command down",
	"^": "control down",
	"⌥": "option down",
	"⇧": "shift down"
};

function press(hotkey) {
	var using = [];
	
	while (hotkey.length > 1) {
		if (modifiers[hotkey[0]] == undefined) {
			throw new Error(hotkey[0] + " is not a recognized modifier key");
		}
		
		using.push(modifiers[hotkey[0]]);
		hotkey = hotkey.slice(1);
	}
	
	if (key_codes[hotkey] != undefined) {
		sys_events.keyCode(key_codes[hotkey], {using: using});
	}
	else {
		sys_events.keystroke(hotkey.toLowerCase(), {using: using});
	}
}
function type(text) {
	for (var i=0; i < text.length; i++) {
		sys_events.keystroke(text[i]);
	}
}
function menu_item() {
	if (!arguments.length) return;
  
	var process = sys_events.processes.whose({"frontmost": true})[0];
	var menu_bar = process.menuBars[0].menuBarItems[arguments[0]];
	
	var menu_item = menu_bar;
	for (var i=1; i < arguments.length; i++) {
		menu_item = menu_item.menus[0].menuItems[arguments[i]];
	}
	menu_item.click();
}


////////////////////////////////////////////////////////////
//  Example use: Safari
////////////////////////////////////////////////////////////

var Safari = Application("Safari");

// Give Safari the focus
Safari.activate();

// Give it a second, it's practically magic (literally waits 1 second)
delay(0.5)

// New window:
press("⌘N")

// Another new Window
menu_item("File", "New Window")

// select address bar
press("⌘L")

// enter a url
type("http://www.google.com")

// press enter and wait for the page to load before doing more stuff
press("⏎")
delay(1.5)

// open your favorite blog in a new tab
press("⌘T")
delay(1.0) // wait for new tab animation so we can start typing
type("http://jiaaro.com")
press("⏎")

You can run system automation scripts at the command line as well like so:

Osascript -l JavaScript hotkey_helpers.js

You'll need to give your terminal of choice the correct permissions:

1. Open "System Preferences"
2. Click "Security & Privacy"
3. Select the "Privacy" tab
4. Scroll to the bottom of the list (on the left side) and pick "Accessibility"
5. Grant access to the application you are launching the script from. You may have to click the lock at the bottom of the screen where it says "Click the lock to make changes"

Thanks for the snippet @jiaaro. Can you point me to some documentation on the Apple API. For example is there documentation of the Application("System Events").

Could it be that they are planning on dropping support for JavaScript? The RN-JavaScriptForAutomation link above has a disclaimer: "This document is no longer being updated."