Typings for JXA

This is a set of typings for AppleScript in JavaScript that works on macOS 10.10 and above.

To use this, add jxa-types to your project. You also need to add jxa-types to tsconfig.json under compilerOptions.types.

If you need to use dependencies from NPM you must use a method such as with Webpack to bundle your code into a single file.

Library

All types are exported globally to match Objective-C. Some are representations of types from AppleScript. Most are Objective-C Foundation types. In the $ namespace, many library functions are exported. These require calling ObjC.import with the appropriate libraries before calling them.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

[0.0.6] - 2025-07-08

Added

• FileTrack.()
• FileTrack.rating
• NSString.lastPathComponent

Fixed

• Fixed location of NSString static methods.

[0.0.4] - 2025-07-07

Added

• $.NSWorkspaceLaunchAndHide
• $.NSWorkspaceLaunchAsync

Removed

• Unnecessary ObjC.unwrap(x: NSString) signature.
• ObjC.unwrap(x: NSDate): Date for now (returns any).

[0.0.3] - 2025-07-07

Added

• $.NSAppleEventDescriptor.nullDescriptor
• $.NSString.stringWithContentsOfFileUsedEncodingError()
• $.NSWorkspace.launchAppWithBundleIdentifierOptionsAdditionalEventParamDescriptorLaunchIdentifier()
• Entries<T>
• FinderApplication.home()
• FinderFolderContentName
• FinderFolderItem
• FinderItem
• MenuBarItem
• MenuBar
• MenuItem
• Menu
• SystemEventsProcess

Changed

• Changed generic ObjC.unwrap() to return the correct value if unwrapping a value of type NSArray<V>.

[0.0.1] - 2025-07-06

First release.