ableton-js 3.1.8 → 3.2.0

package/CHANGELOG.md

@@ -4,8 +4,24 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v3.2.0](https://github.com/leolabs/ableton.js/compare/v3.1.9...v3.2.0)
+
+- :package: Upgrade TypeScript and related deps [`f1c3479`](https://github.com/leolabs/ableton.js/commit/f1c34791deaf6ea6f3040d957741756be0cb454c)
+- :sparkles: Allow changing the timeout for commands [`d216432`](https://github.com/leolabs/ableton.js/commit/d21643289b53cb727bd438a1a0aebb3f275bcad7)
+- :memo: Document class options [`b6c8b7c`](https://github.com/leolabs/ableton.js/commit/b6c8b7c2ed6242f78dd3b5d7343f98c984b1f59c)
+
+#### [v3.1.9](https://github.com/leolabs/ableton.js/compare/v3.1.8...v3.1.9)
+
+> 8 June 2023
+
+- :bug: Fix issue that could block the main thread in Live sometimes when no client port file exists [`8990a5d`](https://github.com/leolabs/ableton.js/commit/8990a5d00e0ae3a314a385f6748be39dd87cde90)
+- :memo: Update the link to unofficial API docs [`7a32f90`](https://github.com/leolabs/ableton.js/commit/7a32f90d273a3ef05aac22105e253235b66a6c97)
+- :bug: Fix copying the scripts not working if the Remote Scripts folder doesn't exist yet [`71ecf44`](https://github.com/leolabs/ableton.js/commit/71ecf44aadb843509c4ad92b27ddd0b27badfda1)
+
 #### [v3.1.8](https://github.com/leolabs/ableton.js/compare/v3.1.7...v3.1.8)
 
+> 10 May 2023
+
 - :fire: Remove the postinstall hook [`d55efec`](https://github.com/leolabs/ableton.js/commit/d55efec00110398610d9f62457f5daa86293d985)
 - :bug: Fix type annotations which are unsupported in Live 10 [`b396684`](https://github.com/leolabs/ableton.js/commit/b3966844d1bf5f4d0f4c0d3b789b9386f82d7e72)
 

package/README.md

@@ -6,7 +6,7 @@ Ableton.js lets you control your instance or instances of Ableton using Node.js.
 It tries to cover as many functions as possible.
 
 This package is still a work-in-progress. My goal is to expose all of
-[Ableton's MIDI Remote Script](https://julienbayle.studio/PythonLiveAPI_documentation/Live10.0.2.xml)
+[Ableton's MIDI Remote Script](https://nsuspray.github.io/Live_API_Doc/11.0.0.xml)
 functions to TypeScript. If you'd like to contribute, please feel free to do so.
 
 ## Sponsored Message
@@ -23,11 +23,8 @@ get an overview of the current state of your set.
 To use this library, you'll need to install and activate the MIDI Remote Script
 in Ableton.js. To do that, copy the `midi-script` folder of this repo to
 Ableton's Remote Scripts folder and rename it to `AbletonJS`. The MIDI Remote
-Scripts folder is usually located at:
-
-- **Windows:** {path to Ableton}\Resources\MIDI\Remote Scripts
-- **macOS:** /Applications/Ableton Live {version}/Contents/App-Resources/MIDI
-  Remote Scripts
+Scripts folder is usually located at
+`~/Music/Ableton/User Library/Remote Scripts`
 
 After starting Ableton Live, add the script to your list of control surfaces:
 

package/index.d.ts

@@ -18,8 +18,8 @@ interface Command {
         [k: string]: any;
     };
 }
-declare type DisconnectEventType = "realtime" | "heartbeat";
-declare type ConnectEventType = DisconnectEventType | "start";
+type DisconnectEventType = "realtime" | "heartbeat";
+type ConnectEventType = DisconnectEventType | "start";
 interface ConnectionEventEmitter {
     on(e: "connect", l: (t: ConnectEventType) => void): this;
     on(e: "disconnect", l: (t: DisconnectEventType) => void): this;
@@ -38,10 +38,42 @@ export declare class TimeoutError extends Error {
     constructor(message: string, payload: Command);
 }
 export interface AbletonOptions {
+    /**
+     * Name of the file containing the port of the Remote Script. This
+     * file is expected to be in the OS' tmp directory.
+     *
+     * @default ableton-js-server.port
+     */
     serverPortFile?: string;
+    /**
+     * Name of the file containing the port of the client. This file
+     * is created in the OS' tmp directory if it doesn't exist yet.
+     *
+     * @default ableton-js-client.port
+     */
     clientPortFile?: string;
+    /**
+     * Defines how regularly ableton-js should ping the Remote Script
+     * to check if it's still reachable, in milliseconds.
+     *
+     * @default 2000
+     */
     heartbeatInterval?: number;
+    /**
+     * Defines how long ableton-js waits for an answer from the Remote
+     * Script after sending a command before throwing a timeout error.
+     *
+     * @default 2000
+     */
+    commandTimeoutMs?: number;
+    /**
+     * Options for the response cache.
+     */
     cacheOptions?: LruCache.Options<string, any>;
+    /**
+     * Set this to allow ableton-js to log messages. If you set this to
+     * `console`, log messages are printed to the standard output.
+     */
     logger?: Logger;
 }
 export declare class Ableton extends EventEmitter implements ConnectionEventEmitter {
@@ -94,8 +126,8 @@ export declare class Ableton extends EventEmitter implements ConnectionEventEmit
      * Sends a raw command to Ableton. Usually, you won't need this.
      * A good starting point in general is the `song` prop.
      */
-    sendCommand(command: Omit<Command, "uuid">, timeout?: number): Promise<any>;
-    sendCachedCommand(command: Omit<Command, "uuid" | "cache">, timeout?: number): Promise<any>;
+    sendCommand(command: Omit<Command, "uuid">): Promise<any>;
+    sendCachedCommand(command: Omit<Command, "uuid" | "cache">): Promise<any>;
     getProp(ns: string, nsid: string | undefined, prop: string, cache?: boolean): Promise<any>;
     setProp(ns: string, nsid: string | undefined, prop: string, value: any): Promise<any>;
     addPropListener(ns: string, nsid: string | undefined, prop: string, listener: (data: any) => any): Promise<() => Promise<boolean | undefined>>;