ableton-js 3.4.4 → 3.4.6

package/CHANGELOG.md

@@ -4,8 +4,20 @@ 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.4.6](https://github.com/leolabs/ableton.js/compare/v3.4.5...v3.4.6)
+
+- Get `song.view.get('detail_clip')` working [`#118`](https://github.com/leolabs/ableton.js/pull/118)
+
+#### [v3.4.5](https://github.com/leolabs/ableton.js/compare/v3.4.4...v3.4.5)
+
+> 3 May 2024
+
+- :bug: Fix some pending requests never resolving when Live disconnects, immediately reject pending requests when Live sends a realtime disconnect event [`4c1a3fe`](https://github.com/leolabs/ableton.js/commit/4c1a3fe9465c0b690aa3ae29f79a39fbaa991a61)
+
 #### [v3.4.4](https://github.com/leolabs/ableton.js/compare/v3.4.3...v3.4.4)
 
+> 1 May 2024
+
 - :sparkles: Add the `tempo_follower_enabled` property [`8cf68c8`](https://github.com/leolabs/ableton.js/commit/8cf68c8e2a261cea6f8ebab8ec9e5db8a8c39195)
 
 #### [v3.4.3](https://github.com/leolabs/ableton.js/compare/v3.4.2...v3.4.3)

package/index.d.ts

@@ -37,6 +37,11 @@ export declare class TimeoutError extends Error {
     payload: Command;
     constructor(message: string, payload: Command);
 }
+export declare class DisconnectError extends Error {
+    message: string;
+    payload: Command;
+    constructor(message: string, payload: Command);
+}
 export interface AbletonOptions {
     /**
      * Name of the file containing the port of the Remote Script. This

package/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPackageVersion = exports.Ableton = exports.TimeoutError = void 0;
+exports.getPackageVersion = exports.Ableton = exports.DisconnectError = exports.TimeoutError = void 0;
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
 const dgram_1 = __importDefault(require("dgram"));
@@ -33,6 +33,16 @@ class TimeoutError extends Error {
     }
 }
 exports.TimeoutError = TimeoutError;
+class DisconnectError extends Error {
+    message;
+    payload;
+    constructor(message, payload) {
+        super(message);
+        this.message = message;
+        this.payload = payload;
+    }
+}
+exports.DisconnectError = DisconnectError;
 class Ableton extends events_1.EventEmitter {
     options;
     client;
@@ -76,8 +86,12 @@ class Ableton extends events_1.EventEmitter {
         if (this._isConnected) {
             this._isConnected = false;
             this.eventListeners.clear();
-            this.msgMap.forEach((msg) => msg.clearTimeout());
-            this.msgMap.clear();
+            // If the disconnect is caused by missed heartbeats, keep
+            // pending requests. Live might just be temporarily hanging.
+            if (type === "realtime") {
+                this.msgMap.forEach((msg) => msg.clearTimeout());
+                this.msgMap.clear();
+            }
             this.logger?.info("Live disconnected", { type });
             this.emit("disconnect", type);
         }
@@ -308,16 +322,10 @@ class Ableton extends events_1.EventEmitter {
             };
             const msg = JSON.stringify(payload);
             const timeout = this.options?.commandTimeoutMs ?? 2000;
+            const arg = (0, lodash_1.truncate)(JSON.stringify(command.args), { length: 100 });
+            const cls = command.nsid ? `${command.ns}(${command.nsid})` : command.ns;
             const timeoutId = setTimeout(() => {
-                const arg = (0, lodash_1.truncate)(JSON.stringify(command.args), { length: 100 });
-                const cls = command.nsid
-                    ? `${command.ns}(${command.nsid})`
-                    : command.ns;
-                rej(new TimeoutError([
-                    `The command ${cls}.${command.name}(${arg}) timed out after ${timeout} ms.`,
-                    `Please make sure that Ableton is running and that you have the latest`,
-                    `version of AbletonJS' MIDI script installed and renamed to "AbletonJS".`,
-                ].join(" "), payload));
+                rej(new TimeoutError(`The command ${cls}.${command.name}(${arg}) timed out after ${timeout} ms.`, payload));
             }, timeout);
             const currentTimestamp = Date.now();
             this.msgMap.set(msgId, {
@@ -336,6 +344,7 @@ class Ableton extends events_1.EventEmitter {
                 rej,
                 clearTimeout: () => {
                     clearTimeout(timeoutId);
+                    rej(new DisconnectError(`Live disconnected before being able to respond to ${cls}.${command.name}(${arg})`, payload));
                 },
             });
             this.sendRaw(msg);

package/midi-script/SongView.py

@@ -3,6 +3,7 @@ from .Interface import Interface
 from .DeviceParameter import DeviceParameter
 from .Scene import Scene
 from .Track import Track
+from .Clip import Clip
 from .ClipSlot import ClipSlot
 
 
@@ -13,6 +14,12 @@ class SongView(Interface):
     def get_ns(self, nsid):
         return self.ableton.song().view
 
+    def get_detail_clip(self, ns):
+        return Clip.serialize_clip(ns.detail_clip)
+
+    def set_detail_clip(self, ns, clip_id):
+        ns.detail_clip = Interface.get_obj(clip_id)
+
     def select_device(self, ns, device_id):
         return ns.select_device(Interface.get_obj(device_id))
 

package/midi-script/version.py

@@ -1 +1 @@
-version = "3.4.4"
+version = "3.4.6"

package/ns/song-view.d.ts

@@ -1,12 +1,13 @@
-import { Ableton } from "..";
 import { Namespace } from ".";
-import { Device } from "./device";
-import { Track, RawTrack } from "./track";
-import { Scene, RawScene } from "./scene";
-import { RawDeviceParameter, DeviceParameter } from "./device-parameter";
+import { Ableton } from "..";
+import { Clip, RawClip } from "./clip";
 import { ClipSlot, RawClipSlot } from "./clip-slot";
+import { Device } from "./device";
+import { DeviceParameter, RawDeviceParameter } from "./device-parameter";
+import { RawScene, Scene } from "./scene";
+import { RawTrack, Track } from "./track";
 export interface GettableProperties {
-    detail_clip: any;
+    detail_clip: RawClip;
     draw_mode: boolean;
     follow_song: boolean;
     highlighted_clip_slot: RawClipSlot;
@@ -16,21 +17,22 @@ export interface GettableProperties {
     selected_track: RawTrack;
 }
 export interface TransformedProperties {
+    detail_clip: Clip;
     selected_parameter: DeviceParameter;
     selected_scene: Scene;
     selected_track: Track;
     highlighted_clip_slot: ClipSlot;
 }
 export interface SettableProperties {
-    detail_clip: any;
+    detail_clip: RawClip["id"];
     draw_mode: boolean;
     follow_song: boolean;
     highlighted_clip_slot: number;
-    selected_scene: RawScene['id'];
-    selected_track: RawTrack['id'];
+    selected_scene: RawScene["id"];
+    selected_track: RawTrack["id"];
 }
 export interface ObservableProperties {
-    detail_clip: any;
+    detail_clip: RawClip | null;
     draw_mode: any;
     follow_song: any;
     highlighted_clip_slot: any;

package/ns/song-view.js

@@ -2,10 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SongView = void 0;
 const _1 = require(".");
-const track_1 = require("./track");
-const scene_1 = require("./scene");
-const device_parameter_1 = require("./device-parameter");
+const clip_1 = require("./clip");
 const clip_slot_1 = require("./clip-slot");
+const device_parameter_1 = require("./device-parameter");
+const scene_1 = require("./scene");
+const track_1 = require("./track");
 class SongView extends _1.Namespace {
     constructor(ableton) {
         super(ableton, "song-view");
@@ -14,8 +15,10 @@ class SongView extends _1.Namespace {
             selected_track: (track) => new track_1.Track(ableton, track),
             selected_scene: (scene) => new scene_1.Scene(ableton, scene),
             highlighted_clip_slot: (slot) => new clip_slot_1.ClipSlot(ableton, slot),
+            detail_clip: (clip) => new clip_1.Clip(ableton, clip),
         };
         this.cachedProps = {
+            detail_clip: true,
             selected_parameter: true,
             selected_track: true,
             selected_scene: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ableton-js",
-  "version": "3.4.4",
+  "version": "3.4.6",
   "description": "Control Ableton Live from Node",
   "main": "index.js",
   "author": "Leo Bernard <admin@leolabs.org>",