ring-client-api 11.7.0-beta.5 → 11.7.0

package/lib/api.js

@@ -125,7 +125,9 @@ class RingApi extends subscribed_1.Subscribed {
         const pushReceiver = new push_receiver_1.default({
             logLevel: 'NONE',
             senderId: '876313859327', // for Ring android app.  703521446232 for ring-site
-        }), devicesById = {};
+        }), devicesById = {}, sendToDevice = (id, notification) => {
+            devicesById[id]?.processPushNotification(notification);
+        };
         for (const camera of cameras) {
             devicesById[camera.id] = camera;
         }
@@ -155,14 +157,15 @@ class RingApi extends subscribed_1.Subscribed {
         });
         pushReceiver.onNotification(({ message }) => {
             const dataJson = message.data?.gcmData;
-            (0, util_1.logInfo)(`Received push notification: ${dataJson}`);
             try {
                 const notification = JSON.parse(dataJson);
-                if (!notification.ding) {
-                    // We may get notification that are not for a ding/motion, which can be ignored
-                    return;
+                if ('ding' in notification) {
+                    sendToDevice(notification.ding.doorbot_id, notification);
+                }
+                else if ('alarm_meta' in notification) {
+                    // Alarm notification, such as intercom unlocked
+                    sendToDevice(notification.alarm_meta.device_zid, notification);
                 }
-                devicesById[notification.ding.doorbot_id]?.processPushNotification(notification);
             }
             catch (e) {
                 (0, util_1.logError)(e);

package/lib/ring-camera.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { CameraData, CameraDeviceSettingsData, CameraEventOptions, CameraEventResponse, CameraHealth, HistoryOptions, PeriodicFootageResponse, PushNotification, VideoSearchResponse, OnvifCameraData, RingCameraKind } from './ring-types';
+import { CameraData, CameraDeviceSettingsData, CameraEventOptions, CameraEventResponse, CameraHealth, HistoryOptions, PeriodicFootageResponse, PushNotification, PushNotificationDing, VideoSearchResponse, OnvifCameraData, RingCameraKind } from './ring-types';
 import { RingRestClient } from './rest-client';
 import { BehaviorSubject, Subject } from 'rxjs';
 import { DeepPartial } from './util';
@@ -26,9 +26,9 @@ export declare class RingCamera extends Subscribed {
     hasLight: boolean;
     hasSiren: boolean;
     onRequestUpdate: Subject<unknown>;
-    onNewNotification: Subject<PushNotification>;
-    onActiveNotifications: BehaviorSubject<PushNotification[]>;
-    onDoorbellPressed: import("rxjs").Observable<PushNotification>;
+    onNewNotification: Subject<PushNotificationDing>;
+    onActiveNotifications: BehaviorSubject<PushNotificationDing[]>;
+    onDoorbellPressed: import("rxjs").Observable<PushNotificationDing>;
     onMotionDetected: import("rxjs").Observable<boolean>;
     onMotionStarted: import("rxjs").Observable<null>;
     onBatteryLevel: import("rxjs").Observable<number | null>;
@@ -38,8 +38,8 @@ export declare class RingCamera extends Subscribed {
     requestUpdate(): void;
     get data(): AnyCameraData;
     get name(): string;
-    get activeNotifications(): PushNotification[];
-    get latestNotification(): PushNotification | undefined;
+    get activeNotifications(): PushNotificationDing[];
+    get latestNotification(): PushNotificationDing | undefined;
     get batteryLevel(): number | null;
     get hasBattery(): boolean;
     get hasLowBattery(): boolean;

package/lib/ring-camera.js

@@ -252,6 +252,10 @@ class RingCamera extends subscribed_1.Subscribed {
         this.onActiveNotifications.next(otherDings);
     }
     processPushNotification(notification) {
+        if (!('ding' in notification)) {
+            // only process ding/motion notifications
+            return;
+        }
         const activeDings = this.activeNotifications, dingId = notification.ding.id;
         this.onActiveNotifications.next(activeDings.filter((d) => d.ding.id !== dingId).concat([notification]));
         this.onNewNotification.next(notification);

package/lib/ring-intercom.d.ts

@@ -10,6 +10,7 @@ export declare class RingIntercom {
     onRequestUpdate: Subject<unknown>;
     onBatteryLevel: import("rxjs").Observable<number | null>;
     onDing: Subject<void>;
+    onUnlocked: Subject<void>;
     constructor(initialData: IntercomHandsetAudioData, restClient: RingRestClient);
     updateData(update: IntercomHandsetAudioData): void;
     requestUpdate(): void;

package/lib/ring-intercom.js

@@ -13,6 +13,7 @@ class RingIntercom {
         this.restClient = restClient;
         this.onRequestUpdate = new rxjs_1.Subject();
         this.onDing = new rxjs_1.Subject();
+        this.onUnlocked = new rxjs_1.Subject();
         this.id = this.initialData.id;
         this.deviceType = this.initialData.kind;
         this.onData = new rxjs_1.BehaviorSubject(this.initialData);
@@ -78,6 +79,9 @@ class RingIntercom {
         if (notification.action === ring_types_1.PushNotificationAction.Ding) {
             this.onDing.next();
         }
+        else if (notification.action === ring_types_1.PushNotificationAction.IntercomUnlock) {
+            this.onUnlocked.next();
+        }
     }
 }
 exports.RingIntercom = RingIntercom;

package/lib/ring-types.d.ts

@@ -868,7 +868,7 @@ export declare enum PushNotificationAction {
     LowBattery = "com.ring.push.LOW_BATTERY_ALERT",
     IntercomUnlock = "com.ring.push.INTERCOM_UNLOCK_FROM_APP"
 }
-export interface PushNotification {
+export interface PushNotificationDing {
     ding: {
         streaming_protocol: 'ring_media_server';
         location_id: string;
@@ -895,6 +895,30 @@ export interface PushNotification {
     subtype: 'motion' | 'ding' | 'human' | string;
     action: PushNotificationAction | string;
 }
+export interface PushNotificationAlarm {
+    aps: {
+        alert: string;
+    };
+    action: PushNotificationAction | string;
+    alarm_meta: {
+        device_zid: number;
+        location_id: string;
+    };
+}
+export interface PushNotificationLowBattery {
+    data: {
+        device_name: string;
+        doorbot_id: number;
+        battery_level: number;
+        device_kind: RingDeviceType;
+        timestamp_epoch_ms: number;
+    };
+    aps: {
+        title: string;
+    };
+    action: PushNotificationAction.LowBattery;
+}
+export declare type PushNotification = PushNotificationDing | PushNotificationAlarm | PushNotificationLowBattery;
 export interface LiveCallResponse {
     ding_id: string;
     ding_kind: DingKind;

package/package.json

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