ring-client-api 11.7.0-beta.2 → 11.7.0-beta.4

package/lib/api.d.ts

@@ -37,7 +37,7 @@ export declare class RingApi extends Subscribed {
         unknownDevices: UnknownDevice[];
     }>;
     private listenForDeviceUpdates;
-    registerPushReceiver(cameras: RingCamera[]): Promise<void>;
+    private registerPushReceiver;
     fetchRawLocations(): Promise<UserLocation[]>;
     fetchAmazonKeyLocks(): Promise<any[] & import("./rest-client").ExtendedResponse>;
     fetchAndBuildLocations(): Promise<Location[]>;

package/lib/api.js

@@ -121,14 +121,17 @@ class RingApi extends subscribed_1.Subscribed {
             onUpdateReceived.next(null); // kick off polling
         }
     }
-    async registerPushReceiver(cameras) {
+    async registerPushReceiver(cameras, intercoms) {
         const pushReceiver = new push_receiver_1.default({
             logLevel: 'NONE',
             senderId: '876313859327', // for Ring android app.  703521446232 for ring-site
-        }), camerasById = cameras.reduce((byId, camera) => {
-            byId[camera.id] = camera;
-            return byId;
-        }, {});
+        }), devicesById = {};
+        for (const camera of cameras) {
+            devicesById[camera.id] = camera;
+        }
+        for (const intercom of intercoms) {
+            devicesById[intercom.id] = intercom;
+        }
         pushReceiver.onCredentialsChanged(async ({ newCredentials: { fcm: { token }, }, }) => {
             try {
                 await this.restClient.request({
@@ -159,7 +162,7 @@ class RingApi extends subscribed_1.Subscribed {
                     // We may get notification that are not for a ding/motion, which can be ignored
                     return;
                 }
-                camerasById[notification.ding.doorbot_id]?.processPushNotification(notification);
+                devicesById[notification.ding.doorbot_id]?.processPushNotification(notification);
             }
             catch (e) {
                 (0, util_1.logError)(e);
@@ -199,7 +202,7 @@ class RingApi extends subscribed_1.Subscribed {
             locationModePollingSeconds: this.options.locationModePollingSeconds,
         }, this.restClient));
         this.listenForDeviceUpdates(cameras, ringChimes, ringIntercoms);
-        this.registerPushReceiver(cameras).catch((e) => {
+        this.registerPushReceiver(cameras, ringIntercoms).catch((e) => {
             (0, util_1.logError)(e);
         });
         return locations;

package/lib/ring-camera.js

@@ -84,7 +84,7 @@ class RingCamera extends subscribed_1.Subscribed {
         this.hasLight = this.initialData.led_status !== undefined;
         this.hasSiren = this.initialData.siren_status !== undefined;
         this.onBatteryLevel = this.onData.pipe((0, operators_1.map)((data) => {
-            if (!('battery_level' in data)) {
+            if (!('battery_life' in data)) {
                 return null;
             }
             return getBatteryLevel(data);
@@ -125,7 +125,7 @@ class RingCamera extends subscribed_1.Subscribed {
         return notifications[notifications.length - 1];
     }
     get batteryLevel() {
-        if (!('battery_level' in this.data)) {
+        if (!('battery_life' in this.data)) {
             return null;
         }
         return getBatteryLevel(this.data);

package/lib/ring-intercom.d.ts

@@ -1,4 +1,4 @@
-import { IntercomHandsetAudioData } from './ring-types';
+import { IntercomHandsetAudioData, PushNotification } from './ring-types';
 import { RingRestClient } from './rest-client';
 import { BehaviorSubject, Subject } from 'rxjs';
 export declare class RingIntercom {
@@ -9,6 +9,7 @@ export declare class RingIntercom {
     onData: BehaviorSubject<IntercomHandsetAudioData>;
     onRequestUpdate: Subject<unknown>;
     onBatteryLevel: import("rxjs").Observable<number | null>;
+    onDing: Subject<void>;
     constructor(initialData: IntercomHandsetAudioData, restClient: RingRestClient);
     updateData(update: IntercomHandsetAudioData): void;
     requestUpdate(): void;
@@ -17,4 +18,8 @@ export declare class RingIntercom {
     get isOffline(): boolean;
     get batteryLevel(): number | null;
     unlock(): Promise<import("./rest-client").ExtendedResponse>;
+    private doorbotUrl;
+    subscribeToDingEvents(): Promise<void & import("./rest-client").ExtendedResponse>;
+    unsubscribeFromDingEvents(): Promise<void & import("./rest-client").ExtendedResponse>;
+    processPushNotification(notification: PushNotification): void;
 }

package/lib/ring-intercom.js

@@ -1,19 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RingIntercom = void 0;
+const ring_types_1 = require("./ring-types");
 const rest_client_1 = require("./rest-client");
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const ring_camera_1 = require("./ring-camera");
+const util_1 = require("./util");
 class RingIntercom {
     constructor(initialData, restClient) {
         this.initialData = initialData;
         this.restClient = restClient;
         this.onRequestUpdate = new rxjs_1.Subject();
+        this.onDing = new rxjs_1.Subject();
         this.id = this.initialData.id;
         this.deviceType = this.initialData.kind;
         this.onData = new rxjs_1.BehaviorSubject(this.initialData);
         this.onBatteryLevel = this.onData.pipe((0, operators_1.map)((data) => (0, ring_camera_1.getBatteryLevel)(data)), (0, operators_1.distinctUntilChanged)());
+        if (!initialData.subscribed) {
+            this.subscribeToDingEvents().catch((e) => {
+                (0, util_1.logError)('Failed to subscribe ' + initialData.description + ' to ding events');
+                (0, util_1.logError)(e);
+            });
+        }
     }
     updateData(update) {
         this.onData.next(update);
@@ -50,5 +59,25 @@ class RingIntercom {
             },
         });
     }
+    doorbotUrl(path = '') {
+        return (0, rest_client_1.clientApi)(`doorbots/${this.id}/${path}`);
+    }
+    subscribeToDingEvents() {
+        return this.restClient.request({
+            method: 'POST',
+            url: this.doorbotUrl('subscribe'),
+        });
+    }
+    unsubscribeFromDingEvents() {
+        return this.restClient.request({
+            method: 'POST',
+            url: this.doorbotUrl('unsubscribe'),
+        });
+    }
+    processPushNotification(notification) {
+        if (notification.action === ring_types_1.PushNotificationAction.Ding) {
+            this.onDing.next();
+        }
+    }
 }
 exports.RingIntercom = RingIntercom;

package/lib/ring-types.d.ts

@@ -864,7 +864,9 @@ export declare enum NotificationDetectionType {
 }
 export declare enum PushNotificationAction {
     Ding = "com.ring.push.HANDLE_NEW_DING",
-    Motion = "com.ring.push.HANDLE_NEW_motion"
+    Motion = "com.ring.push.HANDLE_NEW_motion",
+    LowBattery = "com.ring.push.LOW_BATTERY_ALERT",
+    IntercomUnlock = "com.ring.push.INTERCOM_UNLOCK_FROM_APP"
 }
 export interface PushNotification {
     ding: {

package/lib/ring-types.js

@@ -179,6 +179,8 @@ var PushNotificationAction;
 (function (PushNotificationAction) {
     PushNotificationAction["Ding"] = "com.ring.push.HANDLE_NEW_DING";
     PushNotificationAction["Motion"] = "com.ring.push.HANDLE_NEW_motion";
+    PushNotificationAction["LowBattery"] = "com.ring.push.LOW_BATTERY_ALERT";
+    PushNotificationAction["IntercomUnlock"] = "com.ring.push.INTERCOM_UNLOCK_FROM_APP";
 })(PushNotificationAction = exports.PushNotificationAction || (exports.PushNotificationAction = {}));
 // eslint-disable-next-line no-shadow
 var DispatchSignalType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "11.7.0-beta.2",
+  "version": "11.7.0-beta.4",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
   "exports": {