ring-client-api 9.23.0 → 9.24.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [9.24.0](https://github.com/dgreif/ring/compare/v9.23.0...v9.24.0) (2022-01-22)
+
+
+### Features
+
+* support glassbreak sensor ([98271f9](https://github.com/dgreif/ring/commit/98271f91f13aaae051fccaab7165cd17f2a2377c))
+
+
+### Bug Fixes
+
+* allow process to exit when RingApi.disconnect() is called ([#851](https://github.com/dgreif/ring/issues/851)) ([8ef25ac](https://github.com/dgreif/ring/commit/8ef25acca66c533873b7fd43c7c899e34b4a7617))
+* avoid error when ring terminates video stream ([7717d5e](https://github.com/dgreif/ring/commit/7717d5eaa40afed3d34f0e8e6eea1402e21afef7)), closes [#853](https://github.com/dgreif/ring/issues/853)
+* update dependencies ([c80d052](https://github.com/dgreif/ring/commit/c80d052f9eaf4c0a50a495166177daa40299ffa7))
+
 ## [9.23.0](https://github.com/dgreif/ring/compare/v9.22.1...v9.23.0) (2021-10-17)
 
 

package/README.md

@@ -109,7 +109,7 @@ Camera also includes the following observables:
 * `onDoorbellPressed`: emits a ding every time the doorbell is pressed
 * `onMotionDetected`: `true` or `false` based on `onActiveDings` containing a motion ding
 
-Some other useful propeties
+Some other useful properties
 * `id`
 * `name`: same as `description` from `data`
 * `hasLight`: does this camera have a light

package/lib/api/api.js

@@ -24,7 +24,8 @@ class RingApi extends subscribed_1.Subscribed {
         super();
         this.options = options;
         this.restClient = new rest_client_1.RingRestClient(this.options);
-        this.onRefreshTokenUpdated = this.restClient.onRefreshTokenUpdated.asObservable();
+        this.onRefreshTokenUpdated =
+            this.restClient.onRefreshTokenUpdated.asObservable();
         if (options.debug) {
             (0, util_1.enableDebug)();
         }
@@ -169,6 +170,7 @@ class RingApi extends subscribed_1.Subscribed {
             .catch((e) => {
             (0, util_1.logError)(e);
         });
+        this.restClient.clearTimeouts();
     }
 }
 exports.RingApi = RingApi;

package/lib/api/rest-client.d.ts

@@ -24,6 +24,7 @@ export declare class RingRestClient {
     refreshToken: string | undefined;
     private hardwareIdPromise;
     private _authPromise;
+    private timeouts;
     private clearPreviousAuth;
     private get authPromise();
     private sessionPromise?;
@@ -44,4 +45,5 @@ export declare class RingRestClient {
         url: string;
     }): Promise<T & ExtendedResponse>;
     getCurrentAuth(): Promise<AuthTokenResponse>;
+    clearTimeouts(): void;
 }

package/lib/api/rest-client.js

@@ -66,12 +66,15 @@ function requestWithRetry(requestOptions) {
 class RingRestClient {
     constructor(authOptions) {
         this.authOptions = authOptions;
-        // prettier-ignore
-        this.refreshToken = ('refreshToken' in this.authOptions ? this.authOptions.refreshToken : undefined);
-        this.hardwareIdPromise = (0, util_1.getHardwareId)(this.authOptions.systemId);
+        this.timeouts = [];
         this.sessionPromise = undefined;
         this.using2fa = false;
         this.onRefreshTokenUpdated = new rxjs_1.ReplaySubject(1);
+        this.refreshToken =
+            'refreshToken' in this.authOptions
+                ? this.authOptions.refreshToken
+                : undefined;
+        this.hardwareIdPromise = (0, util_1.getHardwareId)(this.authOptions.systemId);
     }
     clearPreviousAuth() {
         this._authPromise = undefined;
@@ -83,11 +86,12 @@ class RingRestClient {
             authPromise
                 .then(({ expires_in }) => {
                 // clear the existing auth promise 1 minute before it expires
-                setTimeout(() => {
+                const timeout = setTimeout(() => {
                     if (this._authPromise === authPromise) {
                         this.clearPreviousAuth();
                     }
                 }, ((expires_in || 3600) - 60) * 1000);
+                this.timeouts.push(timeout);
             })
                 .catch(() => {
                 // ignore these errors here, they should be handled by the function making a rest request
@@ -288,5 +292,8 @@ class RingRestClient {
     getCurrentAuth() {
         return this.authPromise;
     }
+    clearTimeouts() {
+        this.timeouts.forEach(clearTimeout);
+    }
 }
 exports.RingRestClient = RingRestClient;

package/lib/api/ring-camera.js

@@ -73,17 +73,6 @@ class RingCamera extends subscribed_1.Subscribed {
         this.restClient = restClient;
         this.avoidSnapshotBatteryDrain = avoidSnapshotBatteryDrain;
         this.treatKnockAsDing = treatKnockAsDing;
-        this.id = this.initialData.id;
-        this.deviceType = this.initialData.kind;
-        this.model = ring_types_1.RingCameraModel[this.initialData.kind] || 'Unknown Model';
-        this.onData = new rxjs_1.BehaviorSubject(this.initialData);
-        this.hasLight = this.initialData.led_status !== undefined;
-        this.hasSiren = this.initialData.siren_status !== undefined;
-        this.hasBattery = (0, ring_types_1.isBatteryCameraKind)(this.deviceType) ||
-            (typeof this.initialData.battery_life === 'string' &&
-                this.batteryLevel !== null &&
-                this.batteryLevel < 100 &&
-                this.batteryLevel >= 0);
         this.onRequestUpdate = new rxjs_1.Subject();
         this.onRequestActiveDings = new rxjs_1.Subject();
         this.onNewDing = new rxjs_1.Subject();
@@ -93,12 +82,24 @@ class RingCamera extends subscribed_1.Subscribed {
         this.onMotionDetected = this.onActiveDings.pipe((0, operators_1.map)((dings) => dings.some((ding) => ding.motion || ding.kind === 'motion')), (0, operators_1.distinctUntilChanged)(), (0, operators_1.publishReplay)(1), (0, operators_1.refCount)());
         this.onMotionStarted = this.onMotionDetected.pipe((0, operators_1.filter)((currentlyDetected) => currentlyDetected), (0, operators_1.mapTo)(null), // no value needed, event is what matters
         (0, operators_1.share)());
+        this.expiredDingIds = [];
+        this.lastSnapshotTimestampLocal = 0;
+        this.id = this.initialData.id;
+        this.deviceType = this.initialData.kind;
+        this.model = ring_types_1.RingCameraModel[this.initialData.kind] || 'Unknown Model';
+        this.onData = new rxjs_1.BehaviorSubject(this.initialData);
+        this.hasLight = this.initialData.led_status !== undefined;
+        this.hasSiren = this.initialData.siren_status !== undefined;
+        this.hasBattery =
+            (0, ring_types_1.isBatteryCameraKind)(this.deviceType) ||
+                (typeof this.initialData.battery_life === 'string' &&
+                    this.batteryLevel !== null &&
+                    this.batteryLevel < 100 &&
+                    this.batteryLevel >= 0);
         this.onBatteryLevel = this.onData.pipe((0, operators_1.map)(getBatteryLevel), (0, operators_1.distinctUntilChanged)());
         this.onInHomeDoorbellStatus = this.onData.pipe((0, operators_1.map)(({ settings: { chime_settings } }) => {
             return Boolean(chime_settings === null || chime_settings === void 0 ? void 0 : chime_settings.enable);
         }), (0, operators_1.distinctUntilChanged)());
-        this.expiredDingIds = [];
-        this.lastSnapshotTimestampLocal = 0;
         if (!initialData.subscribed) {
             this.subscribeToDingEvents().catch((e) => {
                 (0, util_1.logError)('Failed to subscribe ' + initialData.description + ' to ding events');

package/lib/api/ring-chime.d.ts

@@ -5,7 +5,7 @@ export declare class RingChime {
     private initialData;
     private restClient;
     id: number;
-    deviceType: "chime" | "chime_pro" | "chime_v2" | "chime_pro_v2";
+    deviceType: import("./ring-types").ChimeKind;
     model: string;
     onData: BehaviorSubject<ChimeData>;
     onRequestUpdate: Subject<unknown>;

package/lib/api/ring-chime.js

@@ -23,11 +23,11 @@ class RingChime {
     constructor(initialData, restClient) {
         this.initialData = initialData;
         this.restClient = restClient;
+        this.onRequestUpdate = new rxjs_1.Subject();
         this.id = this.initialData.id;
         this.deviceType = this.initialData.kind;
         this.model = ring_types_1.ChimeModel[this.deviceType] || 'Chime';
         this.onData = new rxjs_1.BehaviorSubject(this.initialData);
-        this.onRequestUpdate = new rxjs_1.Subject();
     }
     updateData(update) {
         this.onData.next(update);

package/lib/api/ring-types.d.ts

@@ -10,6 +10,7 @@ export declare enum RingDeviceType {
     TemperatureSensor = "sensor.temperature",
     WaterSensor = "sensor.water",
     TiltSensor = "sensor.tilt",
+    GlassbreakSensor = "sensor.glassbreak",
     RangeExtender = "range-extender.zwave",
     ZigbeeAdapter = "adapter.zigbee",
     AccessCodeVault = "access-code.vault",
@@ -214,7 +215,7 @@ export interface BeamBridge {
     role: string;
     updated_at: string;
 }
-declare type ChimeKind = 'chime' | 'chime_pro' | 'chime_v2' | 'chime_pro_v2';
+export declare type ChimeKind = 'chime' | 'chime_pro' | 'chime_v2' | 'chime_pro_v2';
 export declare const ChimeModel: {
     readonly [P in ChimeKind]: string;
 };

package/lib/api/ring-types.js

@@ -14,6 +14,7 @@ var RingDeviceType;
     RingDeviceType["TemperatureSensor"] = "sensor.temperature";
     RingDeviceType["WaterSensor"] = "sensor.water";
     RingDeviceType["TiltSensor"] = "sensor.tilt";
+    RingDeviceType["GlassbreakSensor"] = "sensor.glassbreak";
     RingDeviceType["RangeExtender"] = "range-extender.zwave";
     RingDeviceType["ZigbeeAdapter"] = "adapter.zigbee";
     RingDeviceType["AccessCodeVault"] = "access-code.vault";

package/lib/api/sip-session.js

@@ -32,8 +32,8 @@ class SipSession extends subscribed_1.Subscribed {
         this.hasStarted = false;
         this.hasCallEnded = false;
         this.onCallEndedSubject = new rxjs_1.ReplaySubject(1);
-        this.sipCall = this.createSipCall(this.sipOptions);
         this.onCallEnded = this.onCallEndedSubject.asObservable();
+        this.sipCall = this.createSipCall(this.sipOptions);
     }
     createSipCall(sipOptions) {
         if (this.sipCall) {

package/lib/api/sip.d.ts

@@ -19,6 +19,7 @@ export function create(options: any, callback: any): {
     isFlowUri: (uri: any) => boolean;
     hostname: () => any;
     destroy: () => void;
+    makeResponse: typeof makeResponse;
 };
 export function start(options: any, callback: any): void;
 export function parseAOR(data: any): any;

package/lib/api/sip.js

@@ -1300,6 +1300,7 @@ exports.create = function (options, callback) {
             transaction.destroy();
             transport.destroy();
         },
+        makeResponse,
     };
 };
 exports.start = function (options, callback) {

package/lib/api/util.js

@@ -8,14 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.randomString = exports.randomInteger = exports.mapAsync = exports.stringify = exports.requestInput = exports.getHardwareId = exports.generateUuid = exports.enableDebug = exports.useLogger = exports.logError = exports.logInfo = exports.logDebug = exports.delay = void 0;
-const debug = require("debug");
+const debug_1 = __importDefault(require("debug"));
 const colors_1 = require("colors");
 const readline_1 = require("readline");
 const uuid_1 = require("uuid");
 const systeminformation_1 = require("systeminformation");
-const debugLogger = debug('ring'), uuidNamespace = 'e53ffdc0-e91d-4ce1-bec2-df939d94739c';
+const debugLogger = (0, debug_1.default)('ring'), uuidNamespace = 'e53ffdc0-e91d-4ce1-bec2-df939d94739c';
 let logger = {
     logInfo(message) {
         debugLogger(message);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "9.23.0",
+  "version": "9.24.0",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/api/index.js",
   "bin": {
@@ -57,38 +57,38 @@
     "@homebridge/plugin-ui-utils": "0.0.19",
     "@types/socket.io-client": "1.4.36",
     "colors": "1.4.0",
-    "debug": "4.3.2",
-    "got": "11.8.2",
-    "rxjs": "7.4.0",
+    "debug": "4.3.3",
+    "got": "11.8.3",
+    "rxjs": "7.5.2",
     "sdp": "3.0.3",
     "socket.io-client": "2.4.0",
     "stun": "2.1.0",
-    "systeminformation": "5.9.7",
+    "systeminformation": "5.10.7",
     "uuid": "8.3.2"
   },
   "devDependencies": {
     "@types/debug": "4.1.7",
-    "@types/jest": "27.0.2",
-    "@types/node": "16.11.1",
-    "@types/uuid": "8.3.1",
-    "@typescript-eslint/eslint-plugin": "5.0.0",
-    "@typescript-eslint/parser": "5.0.0",
-    "concurrently": "^6.3.0",
+    "@types/jest": "27.4.0",
+    "@types/node": "17.0.10",
+    "@types/uuid": "8.3.4",
+    "@typescript-eslint/eslint-plugin": "5.10.0",
+    "@typescript-eslint/parser": "5.10.0",
+    "concurrently": "^7.0.0",
     "conventional-github-releaser": "3.1.5",
-    "dotenv": "10.0.0",
-    "eslint": "8.0.1",
+    "dotenv": "14.2.0",
+    "eslint": "8.7.0",
     "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-jest": "25.2.2",
+    "eslint-plugin-jest": "25.7.0",
     "eslint-plugin-prettier": "4.0.0",
-    "express": "4.17.1",
-    "homebridge": "1.3.5",
-    "jest": "27.3.0",
-    "prettier": "2.4.1",
+    "express": "4.17.2",
+    "homebridge": "1.4.0",
+    "jest": "27.4.7",
+    "prettier": "2.5.1",
     "reflect-metadata": "0.1.13",
     "rimraf": "3.0.2",
     "standard-version": "9.3.2",
-    "ts-jest": "27.0.7",
-    "typescript": "4.4.4"
+    "ts-jest": "27.1.3",
+    "typescript": "4.5.5"
   },
   "engines": {
     "node": "^10 || ^12.20 || ^14 || ^16",