ring-client-api 10.0.0 → 11.0.2-beta.0

package/lib/api/location.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Location = void 0;
 const socket_io_client_1 = require("socket.io-client");
@@ -108,61 +99,59 @@ class Location extends subscribed_1.Subscribed {
     get name() {
         return this.locationDetails.name;
     }
-    createConnection() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.disconnected) {
-                return Promise.resolve({ disconnected: true });
+    async createConnection() {
+        if (this.disconnected) {
+            return Promise.resolve({ disconnected: true });
+        }
+        (0, util_1.logInfo)('Creating location socket.io connection - ' + this.name);
+        if (process.version.startsWith('v15.')) {
+            (0, util_1.logError)('Node 15 is not currently supported by the Ring client. Please install the latest Node 14 instead. May not be able to fetch devices from Ring Alarm and Smart Lighting Hubs on this version of node.');
+        }
+        const { assets, ticket, host } = await this.restClient.request({
+            url: (0, rest_client_1.appApi)('clap/tickets?locationID=' + this.id),
+        }), supportedAssets = assets.filter(ring_types_1.isWebSocketSupportedAsset);
+        this.assets = supportedAssets;
+        this.receivedAssetDeviceLists.length = 0;
+        this.offlineAssets.length = 0;
+        if (!supportedAssets.length) {
+            const errorMessage = `No assets (alarm hubs or beam bridges) found for location ${this.name} - ${this.id}`;
+            (0, util_1.logError)(errorMessage);
+            throw new Error(errorMessage);
+        }
+        const connection = (0, socket_io_client_1.connect)(`wss://${host}/?authcode=${ticket}&ack=false&EIO=3`, { transports: ['websocket'] }), reconnect = () => {
+            if (this.reconnecting && this.connectionPromise) {
+                return this.connectionPromise;
             }
-            (0, util_1.logInfo)('Creating location socket.io connection - ' + this.name);
-            if (process.version.startsWith('v15.')) {
-                (0, util_1.logError)('Node 15 is not currently supported by the Ring client. Please install the latest Node 14 instead. May not be able to fetch devices from Ring Alarm and Smart Lighting Hubs on this version of node.');
+            this.onConnected.next(false);
+            if (!this.disconnected) {
+                (0, util_1.logInfo)('Reconnecting location socket.io connection');
             }
-            const { assets, ticket, host } = yield this.restClient.request({
-                url: (0, rest_client_1.appApi)('clap/tickets?locationID=' + this.id),
-            }), supportedAssets = assets.filter(ring_types_1.isWebSocketSupportedAsset);
-            this.assets = supportedAssets;
-            this.receivedAssetDeviceLists.length = 0;
-            this.offlineAssets.length = 0;
-            if (!supportedAssets.length) {
-                const errorMessage = `No assets (alarm hubs or beam bridges) found for location ${this.name} - ${this.id}`;
-                (0, util_1.logError)(errorMessage);
-                throw new Error(errorMessage);
+            this.reconnecting = true;
+            connection.close();
+            return (this.connectionPromise = (0, util_1.delay)(1000).then(() => {
+                return this.createConnection();
+            }));
+        };
+        this.reconnecting = false;
+        connection.on('DataUpdate', (message) => {
+            if (message.datatype === 'HubDisconnectionEventType') {
+                (0, util_1.logInfo)('Location connection told to reconnect');
+                return reconnect();
             }
-            const connection = (0, socket_io_client_1.connect)(`wss://${host}/?authcode=${ticket}&ack=false&EIO=3`, { transports: ['websocket'] }), reconnect = () => {
-                if (this.reconnecting && this.connectionPromise) {
-                    return this.connectionPromise;
-                }
-                this.onConnected.next(false);
-                if (!this.disconnected) {
-                    (0, util_1.logInfo)('Reconnecting location socket.io connection');
-                }
-                this.reconnecting = true;
-                connection.close();
-                return (this.connectionPromise = (0, util_1.delay)(1000).then(() => {
-                    return this.createConnection();
-                }));
-            };
-            this.reconnecting = false;
-            connection.on('DataUpdate', (message) => {
-                if (message.datatype === 'HubDisconnectionEventType') {
-                    (0, util_1.logInfo)('Location connection told to reconnect');
-                    return reconnect();
-                }
-                this.onDataUpdate.next(message);
-            });
-            connection.on('message', (message) => this.onMessage.next(message));
-            connection.on('error', reconnect);
-            connection.on('disconnect', reconnect);
-            return new Promise((resolve, reject) => {
-                connection.once('connect', () => {
-                    resolve(connection);
-                    this.onConnected.next(true);
-                    (0, util_1.logInfo)('Ring connected to socket.io server');
-                    assets.forEach((asset) => this.requestList(deviceListMessageType, asset.uuid));
-                });
-                connection.once('error', reject);
-            }).catch(reconnect);
+            this.onDataUpdate.next(message);
         });
+        connection.on('message', (message) => this.onMessage.next(message));
+        connection.on('error', reconnect);
+        connection.on('disconnect', reconnect);
+        return new Promise((resolve, reject) => {
+            connection.once('connect', () => {
+                resolve(connection);
+                this.onConnected.next(true);
+                (0, util_1.logInfo)('Ring connected to socket.io server');
+                assets.forEach((asset) => this.requestList(deviceListMessageType, asset.uuid));
+            });
+            connection.once('error', reject);
+        }).catch(reconnect);
     }
     getConnection() {
         if (!this.hasHubs) {
@@ -173,37 +162,29 @@ class Location extends subscribed_1.Subscribed {
         }
         return (this.connectionPromise = this.createConnection());
     }
-    sendMessage(message) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const connection = yield this.getConnection();
-            message.seq = this.seq++;
-            connection.emit('message', message);
-        });
+    async sendMessage(message) {
+        const connection = await this.getConnection();
+        message.seq = this.seq++;
+        connection.emit('message', message);
     }
-    sendCommandToSecurityPanel(commandType, data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const securityPanel = yield this.getSecurityPanel();
-            securityPanel.sendCommand(commandType, data);
-        });
+    async sendCommandToSecurityPanel(commandType, data) {
+        const securityPanel = await this.getSecurityPanel();
+        securityPanel.sendCommand(commandType, data);
     }
-    setAlarmMode(alarmMode, bypassSensorZids) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const securityPanel = yield this.getSecurityPanel(), updatedDataPromise = (0, rxjs_1.firstValueFrom)(securityPanel.onData.pipe((0, operators_1.skip)(1)));
-            yield this.sendCommandToSecurityPanel('security-panel.switch-mode', {
-                mode: alarmMode,
-                bypass: bypassSensorZids,
-            });
-            const updatedData = yield updatedDataPromise;
-            if (updatedData.mode !== alarmMode) {
-                throw new Error(`Failed to set alarm mode to "${alarmMode}".  Sensors may require bypass, which can only be done in the Ring app.`);
-            }
+    async setAlarmMode(alarmMode, bypassSensorZids) {
+        const securityPanel = await this.getSecurityPanel(), updatedDataPromise = (0, rxjs_1.firstValueFrom)(securityPanel.onData.pipe((0, operators_1.skip)(1)));
+        await this.sendCommandToSecurityPanel('security-panel.switch-mode', {
+            mode: alarmMode,
+            bypass: bypassSensorZids,
         });
+        const updatedData = await updatedDataPromise;
+        if (updatedData.mode !== alarmMode) {
+            throw new Error(`Failed to set alarm mode to "${alarmMode}".  Sensors may require bypass, which can only be done in the Ring app.`);
+        }
     }
-    getAlarmMode() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const securityPanel = yield this.getSecurityPanel();
-            return securityPanel.data.mode;
-        });
+    async getAlarmMode() {
+        const securityPanel = await this.getSecurityPanel();
+        return securityPanel.data.mode;
     }
     soundSiren() {
         return this.sendCommandToSecurityPanel('security-panel.sound-siren');
@@ -229,39 +210,33 @@ class Location extends subscribed_1.Subscribed {
     requestList(listType, assetId) {
         return this.sendMessage({ msg: listType, dst: assetId });
     }
-    getList(listType, assetId) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.requestList(listType, assetId);
-            return this.getNextMessageOfType(listType, assetId);
-        });
+    async getList(listType, assetId) {
+        await this.requestList(listType, assetId);
+        return this.getNextMessageOfType(listType, assetId);
     }
-    getDevices() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.hasHubs) {
-                return Promise.resolve([]);
-            }
-            if (!this.connectionPromise) {
-                yield this.getConnection();
-            }
-            return (0, rxjs_1.firstValueFrom)(this.onDevices);
-        });
+    async getDevices() {
+        if (!this.hasHubs) {
+            return Promise.resolve([]);
+        }
+        if (!this.connectionPromise) {
+            await this.getConnection();
+        }
+        return (0, rxjs_1.firstValueFrom)(this.onDevices);
     }
     getRoomList(assetId) {
         return this.getList('RoomGetList', assetId);
     }
-    getSecurityPanel() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.securityPanel) {
-                return this.securityPanel;
-            }
-            const devices = yield this.getDevices(), securityPanel = devices.find((device) => {
-                return device.data.deviceType === ring_types_1.RingDeviceType.SecurityPanel;
-            });
-            if (!securityPanel) {
-                throw new Error(`Could not find a security panel for location ${this.name} - ${this.id}`);
-            }
-            return (this.securityPanel = securityPanel);
+    async getSecurityPanel() {
+        if (this.securityPanel) {
+            return this.securityPanel;
+        }
+        const devices = await this.getDevices(), securityPanel = devices.find((device) => {
+            return device.data.deviceType === ring_types_1.RingDeviceType.SecurityPanel;
         });
+        if (!securityPanel) {
+            throw new Error(`Could not find a security panel for location ${this.name} - ${this.id}`);
+        }
+        return (this.securityPanel = securityPanel);
     }
     disarm() {
         return this.setAlarmMode('none');
@@ -275,7 +250,10 @@ class Location extends subscribed_1.Subscribed {
     getHistory(options = {}) {
         options.maxLevel = options.maxLevel || 50;
         return this.restClient.request({
-            url: (0, rest_client_1.appApi)(`rs/history${(0, ring_camera_1.getSearchQueryString)(Object.assign({ accountId: this.id }, options))}`),
+            url: (0, rest_client_1.appApi)(`rs/history${(0, ring_camera_1.getSearchQueryString)({
+                accountId: this.id,
+                ...options,
+            })}`),
         });
     }
     getCameraEvents(options = {}) {
@@ -310,46 +288,38 @@ class Location extends subscribed_1.Subscribed {
     triggerFireAlarm() {
         return this.triggerAlarm(ring_types_1.DispatchSignalType.Fire);
     }
-    getLocationMode() {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.onLocationModeRequested.next(null);
-            const response = yield this.restClient.request({
-                method: 'GET',
-                url: (0, rest_client_1.appApi)(`mode/location/${this.id}`),
-            });
-            this.onLocationMode.next(response.mode);
-            return response;
+    async getLocationMode() {
+        this.onLocationModeRequested.next(null);
+        const response = await this.restClient.request({
+            method: 'GET',
+            url: (0, rest_client_1.appApi)(`mode/location/${this.id}`),
         });
+        this.onLocationMode.next(response.mode);
+        return response;
     }
-    setLocationMode(mode) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.restClient.request({
-                method: 'POST',
-                url: (0, rest_client_1.appApi)(`mode/location/${this.id}`),
-                json: { mode },
-            });
-            this.onLocationMode.next(response.mode);
-            return response;
+    async setLocationMode(mode) {
+        const response = await this.restClient.request({
+            method: 'POST',
+            url: (0, rest_client_1.appApi)(`mode/location/${this.id}`),
+            json: { mode },
         });
+        this.onLocationMode.next(response.mode);
+        return response;
     }
-    disableLocationModes() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.restClient.request({
-                method: 'DELETE',
-                url: (0, rest_client_1.appApi)(`mode/location/${this.id}/settings`),
-            });
-            this.onLocationMode.next('disabled');
+    async disableLocationModes() {
+        await this.restClient.request({
+            method: 'DELETE',
+            url: (0, rest_client_1.appApi)(`mode/location/${this.id}/settings`),
         });
+        this.onLocationMode.next('disabled');
     }
-    enableLocationModes() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.restClient.request({
-                method: 'POST',
-                url: (0, rest_client_1.appApi)(`mode/location/${this.id}/settings/setup`),
-            });
-            yield this.getLocationMode();
-            return response;
+    async enableLocationModes() {
+        const response = await this.restClient.request({
+            method: 'POST',
+            url: (0, rest_client_1.appApi)(`mode/location/${this.id}/settings/setup`),
         });
+        await this.getLocationMode();
+        return response;
     }
     getLocationModeSettings() {
         return this.restClient.request({
@@ -377,15 +347,13 @@ class Location extends subscribed_1.Subscribed {
             json: { sharedUsersEnabled },
         });
     }
-    supportsLocationModeSwitching() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (this.hasAlarmBaseStation || !this.cameras.length) {
-                return false;
-            }
-            const modeResponse = yield this.getLocationMode(), { mode, readOnly } = modeResponse;
-            (0, util_1.logDebug)('Location Mode: ' + JSON.stringify(modeResponse));
-            return !readOnly && !ring_types_1.disabledLocationModes.includes(mode);
-        });
+    async supportsLocationModeSwitching() {
+        if (this.hasAlarmBaseStation || !this.cameras.length) {
+            return false;
+        }
+        const modeResponse = await this.getLocationMode(), { mode, readOnly } = modeResponse;
+        (0, util_1.logDebug)('Location Mode: ' + JSON.stringify(modeResponse));
+        return !readOnly && !ring_types_1.disabledLocationModes.includes(mode);
     }
     disconnect() {
         this.disconnected = true;

package/lib/api/refresh-token.js

@@ -1,48 +1,35 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logRefreshToken = exports.acquireRefreshToken = void 0;
 /* eslint-disable no-console */
 const rest_client_1 = require("./rest-client");
 const util_1 = require("./util");
-function acquireRefreshToken() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const email = yield (0, util_1.requestInput)('Email: '), password = yield (0, util_1.requestInput)('Password: '), restClient = new rest_client_1.RingRestClient({ email, password }), getAuthWith2fa = () => __awaiter(this, void 0, void 0, function* () {
-            const code = yield (0, util_1.requestInput)('2fa Code: ');
-            try {
-                return yield restClient.getAuth(code);
-            }
-            catch (_) {
-                console.log('Incorrect 2fa code. Please try again.');
-                return getAuthWith2fa();
-            }
-        }), auth = yield restClient.getCurrentAuth().catch((e) => {
-            if (restClient.promptFor2fa) {
-                console.log(restClient.promptFor2fa);
-                return getAuthWith2fa();
-            }
-            console.error(e);
-            process.exit(1);
-        });
-        return auth.refresh_token;
+async function acquireRefreshToken() {
+    const email = await (0, util_1.requestInput)('Email: '), password = await (0, util_1.requestInput)('Password: '), restClient = new rest_client_1.RingRestClient({ email, password }), getAuthWith2fa = async () => {
+        const code = await (0, util_1.requestInput)('2fa Code: ');
+        try {
+            return await restClient.getAuth(code);
+        }
+        catch (_) {
+            console.log('Incorrect 2fa code. Please try again.');
+            return getAuthWith2fa();
+        }
+    }, auth = await restClient.getCurrentAuth().catch((e) => {
+        if (restClient.promptFor2fa) {
+            console.log(restClient.promptFor2fa);
+            return getAuthWith2fa();
+        }
+        console.error(e);
+        process.exit(1);
     });
+    return auth.refresh_token;
 }
 exports.acquireRefreshToken = acquireRefreshToken;
-function logRefreshToken() {
-    return __awaiter(this, void 0, void 0, function* () {
-        console.log('This CLI will provide you with a refresh token which you can use to configure ring-client-api and homebridge-ring.');
-        const refreshToken = yield acquireRefreshToken();
-        console.log('\nSuccessfully logged in to Ring. Please add the following to your config:\n');
-        console.log(`"refreshToken": "${refreshToken}"`);
-    });
+async function logRefreshToken() {
+    console.log('This CLI will provide you with a refresh token which you can use to configure ring-client-api and homebridge-ring.');
+    const refreshToken = await acquireRefreshToken();
+    console.log('\nSuccessfully logged in to Ring. Please add the following to your config:\n');
+    console.log(`"refreshToken": "${refreshToken}"`);
 }
 exports.logRefreshToken = logRefreshToken;
 // eslint-disable-next-line @typescript-eslint/no-empty-function