ableton-js 3.0.0 → 3.0.1

package/CHANGELOG.md

@@ -4,7 +4,14 @@ 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.0.0](https://github.com/leolabs/ableton.js/compare/v2.9.1...v3.0.0)
+#### [v3.0.1](https://github.com/leolabs/ableton.js/compare/v3.0.0...v3.0.1)
+
+- :memo: Add breaking change reminder to the changelog [`3158328`](https://github.com/leolabs/ableton.js/commit/31583280950ac4c9a4d8d425592c05481ee7b3e7)
+- :sparkles: Don't allow starting the server multiple times [`83a42b1`](https://github.com/leolabs/ableton.js/commit/83a42b1186ede6820efa13c6cec7b599693a1bb5)
+
+### [v3.0.0](https://github.com/leolabs/ableton.js/compare/v2.9.1...v3.0.0)
+
+> 25 February 2023
 
 - :sparkles: Don't rely on fixed ports, make server and client bind to a random free one [`54f7737`](https://github.com/leolabs/ableton.js/commit/54f773758ec359ab9b5bc3f5fd3e7c96cae4e8b8)
 - :sparkles: Add a timeout param to the start method [`600e752`](https://github.com/leolabs/ableton.js/commit/600e752c5f7c0e349b0cb69aaf4b8f6238f6a1d4)

package/index.d.ts

@@ -62,6 +62,7 @@ export declare class Ableton extends EventEmitter implements ConnectionEventEmit
     private clientPortFile;
     private serverPortFile;
     private logger;
+    private clientState;
     constructor(options?: AbletonOptions | undefined);
     /**
      * Starts the server and waits for a connection with Live to be established.
@@ -72,7 +73,7 @@ export declare class Ableton extends EventEmitter implements ConnectionEventEmit
      */
     start(timeoutMs?: number): Promise<void>;
     /** Closes the client */
-    close(): Promise<unknown>;
+    close(): Promise<void>;
     /**
      * Returns the latency between the last command and its response.
      * This is a rough measurement, so don't rely too much on it.

package/index.js

@@ -132,6 +132,7 @@ var Ableton = /** @class */ (function (_super) {
         _this.application = new application_1.Application(_this);
         _this.internal = new internal_1.Internal(_this);
         _this.midi = new midi_1.Midi(_this);
+        _this.clientState = "closed";
         _this.logger = options === null || options === void 0 ? void 0 : options.logger;
         _this.cache = new lru_cache_1.default(__assign({ max: 500, ttl: 1000 * 60 * 10 }, options === null || options === void 0 ? void 0 : options.cacheOptions));
         _this.clientPortFile = path_1.default.join(os_1.default.tmpdir(), (_b = (_a = _this.options) === null || _a === void 0 ? void 0 : _a.clientPortFile) !== null && _b !== void 0 ? _b : CLIENT_PORT_FILE);
@@ -146,13 +147,18 @@ var Ableton = /** @class */ (function (_super) {
      * in the given time. Should be higher than 2000ms to avoid false positives.
      */
     Ableton.prototype.start = function (timeoutMs) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         return __awaiter(this, void 0, void 0, function () {
             var connection, timeout, heartbeat;
             var _this = this;
-            return __generator(this, function (_e) {
-                switch (_e.label) {
+            return __generator(this, function (_f) {
+                switch (_f.label) {
                     case 0:
+                        if (this.clientState !== "closed") {
+                            (_a = this.logger) === null || _a === void 0 ? void 0 : _a.warn("Tried call start, but client is already " + this.clientState);
+                            return [2 /*return*/];
+                        }
+                        this.clientState = "starting";
                         this.client = dgram_1.default.createSocket({ type: "udp4" });
                         this.client.addListener("message", this.handleIncoming.bind(this));
                         this.client.addListener("listening", function () { return __awaiter(_this, void 0, void 0, function () {
@@ -221,8 +227,8 @@ var Ableton = /** @class */ (function (_super) {
                             }); })];
                     case 1:
                         // Wait for the server port file to exist
-                        _e.sent();
-                        (_a = this.logger) === null || _a === void 0 ? void 0 : _a.info("Checking connection...");
+                        _f.sent();
+                        (_b = this.logger) === null || _b === void 0 ? void 0 : _b.info("Checking connection...");
                         connection = new Promise(function (res) { return _this.once("connect", res); });
                         if (!timeoutMs) return [3 /*break*/, 3];
                         timeout = new Promise(function (_, rej) {
@@ -230,14 +236,15 @@ var Ableton = /** @class */ (function (_super) {
                         });
                         return [4 /*yield*/, Promise.race([connection, timeout])];
                     case 2:
-                        _e.sent();
+                        _f.sent();
                         return [3 /*break*/, 5];
                     case 3: return [4 /*yield*/, connection];
                     case 4:
-                        _e.sent();
-                        _e.label = 5;
+                        _f.sent();
+                        _f.label = 5;
                     case 5:
-                        (_b = this.logger) === null || _b === void 0 ? void 0 : _b.info("Got connection!");
+                        (_c = this.logger) === null || _c === void 0 ? void 0 : _c.info("Got connection!");
+                        this.clientState = "started";
                         heartbeat = function () { return __awaiter(_this, void 0, void 0, function () {
                             var e_2;
                             return __generator(this, function (_a) {
@@ -269,14 +276,15 @@ var Ableton = /** @class */ (function (_super) {
                                 }
                             });
                         }); };
-                        this.heartbeatInterval = setInterval(heartbeat, (_d = (_c = this.options) === null || _c === void 0 ? void 0 : _c.heartbeatInterval) !== null && _d !== void 0 ? _d : 2000);
+                        this.heartbeatInterval = setInterval(heartbeat, (_e = (_d = this.options) === null || _d === void 0 ? void 0 : _d.heartbeatInterval) !== null && _e !== void 0 ? _e : 2000);
                         heartbeat();
                         this.internal
                             .get("version")
                             .then(function (v) {
+                            var _a;
                             var jsVersion = package_version_1.getPackageVersion();
                             if (semver_1.default.lt(v, jsVersion)) {
-                                console.warn("The installed version of your AbletonJS plugin (" + v + ") is lower than the JS library (" + jsVersion + ").", "Please update your AbletonJS plugin to the latest version: https://git.io/JvaOu");
+                                (_a = _this.logger) === null || _a === void 0 ? void 0 : _a.warn("The installed version of your AbletonJS plugin (" + v + ") is lower than the JS library (" + jsVersion + ").", "Please update your AbletonJS plugin to the latest version: https://git.io/JvaOu");
                             }
                         })
                             .catch(function () { });
@@ -291,17 +299,24 @@ var Ableton = /** @class */ (function (_super) {
             var closePromise;
             var _this = this;
             return __generator(this, function (_a) {
-                this.cancelConnectionEvent = true;
-                fs_1.unwatchFile(this.serverPortFile);
-                if (this.heartbeatInterval) {
-                    clearInterval(this.heartbeatInterval);
-                }
-                if (this.client) {
-                    closePromise = new Promise(function (res) { var _a; return (_a = _this.client) === null || _a === void 0 ? void 0 : _a.once("close", res); });
-                    this.client.close();
-                    return [2 /*return*/, closePromise];
+                switch (_a.label) {
+                    case 0:
+                        this.cancelConnectionEvent = true;
+                        fs_1.unwatchFile(this.serverPortFile);
+                        if (this.heartbeatInterval) {
+                            clearInterval(this.heartbeatInterval);
+                        }
+                        if (!this.client) return [3 /*break*/, 2];
+                        closePromise = new Promise(function (res) { var _a; return (_a = _this.client) === null || _a === void 0 ? void 0 : _a.once("close", res); });
+                        this.client.close();
+                        return [4 /*yield*/, closePromise];
+                    case 1:
+                        _a.sent();
+                        _a.label = 2;
+                    case 2:
+                        this.clientState = "closed";
+                        return [2 /*return*/];
                 }
-                return [2 /*return*/];
             });
         });
     };

package/midi-script/Internal.py

@@ -13,4 +13,4 @@ class Internal(Interface):
         return True
 
     def get_version(self, ns):
-        return "3.0.0"
+        return "3.0.1"

package/package.json

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