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

package/lib/api.js

@@ -123,14 +123,15 @@ class RingApi extends subscribed_1.Subscribed {
         }
     }
     async registerPushReceiver(cameras, intercoms) {
-        const credentials = this.restClient._internalOnly_pushNotificationCredentials, pushReceiver = new push_receiver_1.default({
+        const credentials = this.restClient._internalOnly_pushNotificationCredentials?.config &&
+            this.restClient._internalOnly_pushNotificationCredentials, pushReceiver = new push_receiver_1.default({
             firebase: {
                 apiKey: 'AIzaSyCv-hdFBmmdBBJadNy-TFwB-xN_H5m3Bk8',
                 projectId: 'ring-17770',
                 messagingSenderId: '876313859327', // for Ring android app.  703521446232 for ring-site
                 appId: '1:876313859327:android:e10ec6ddb3c81f39',
             },
-            credentials: credentials?.config ? credentials : undefined,
+            credentials,
             debug: false,
         }), devicesById = {}, sendToDevice = (id, notification) => {
             devicesById[id]?.processPushNotification(notification);
@@ -213,7 +214,8 @@ class RingApi extends subscribed_1.Subscribed {
                 }
                 const eventCategory = notification.android_config.category;
                 if (eventCategory !== ring_types_1.PushNotificationAction.Ding &&
-                    eventCategory !== ring_types_1.PushNotificationAction.Motion) {
+                    eventCategory !== ring_types_1.PushNotificationAction.Motion &&
+                    eventCategory !== ring_types_1.PushNotificationAction.IntercomDing) {
                     (0, util_1.logInfo)('Received push notification with unknown category: ' +
                         eventCategory);
                     (0, util_1.logInfo)(JSON.stringify(message));
@@ -223,8 +225,10 @@ class RingApi extends subscribed_1.Subscribed {
                 (0, util_1.logError)(e);
             }
         });
-        // If we already have credentials, use them immediately
-        if (credentials) {
+        // If we already have credentials and they haven't been changed during registration, use them immediately
+        if (credentials &&
+            credentials?.fcm?.token ===
+                this.restClient._internalOnly_pushNotificationCredentials?.fcm?.token) {
             onPushNotificationToken.next(credentials.fcm.token);
         }
     }

package/lib/ring-camera.js

@@ -38,7 +38,10 @@ function getBatteryLevel(data) {
         parseBatteryLife(data.battery_life_2),
     ].filter((level) => level !== null), { health } = data;
     if (!levels.length ||
-        (health && !health.battery_percentage && !health.battery_present)) {
+        (health &&
+            !health.battery_percentage &&
+            !health.battery_present &&
+            !health.second_battery_percentage)) {
         return null;
     }
     return Math.min(...levels);

package/lib/ring-intercom.d.ts

@@ -1,4 +1,4 @@
-import { IntercomHandsetAudioData, PushNotificationDingV2 } from './ring-types';
+import { IntercomHandsetAudioData, PushNotificationDingV2, PushNotificationIntercomUnlockV2 } from './ring-types';
 import { RingRestClient } from './rest-client';
 import { BehaviorSubject, Subject } from 'rxjs';
 export declare class RingIntercom {
@@ -22,5 +22,5 @@ export declare class RingIntercom {
     private doorbotUrl;
     subscribeToDingEvents(): Promise<void & import("./rest-client").ExtendedResponse>;
     unsubscribeFromDingEvents(): Promise<void & import("./rest-client").ExtendedResponse>;
-    processPushNotification(notification: PushNotificationDingV2): void;
+    processPushNotification(notification: PushNotificationDingV2 | PushNotificationIntercomUnlockV2): void;
 }

package/lib/ring-intercom.js

@@ -76,11 +76,13 @@ class RingIntercom {
         });
     }
     processPushNotification(notification) {
-        if (notification.android_config.category === ring_types_1.PushNotificationAction.Ding) {
+        if ('android_config' in notification &&
+            notification.android_config.category ===
+                ring_types_1.PushNotificationAction.IntercomDing) {
             this.onDing.next();
         }
-        else if (notification.android_config.category ===
-            ring_types_1.PushNotificationAction.IntercomUnlock) {
+        else if ('gcmData' in notification.data &&
+            notification.data.gcmData.action === ring_types_1.PushNotificationAction.IntercomUnlock) {
             this.onUnlocked.next();
         }
     }

package/lib/ring-types.d.ts

@@ -469,6 +469,7 @@ export interface BaseCameraData {
         rssi_category: 'good' | string;
         battery_voltage_category: 'very_good' | string;
         second_battery_voltage_category: 'unknown' | string;
+        second_battery_percentage?: number;
         second_battery_percentage_category: 'unknown' | string;
         battery_save: boolean;
         firmware_version_status: 'Up to Date';
@@ -867,7 +868,8 @@ export declare enum NotificationDetectionType {
 export declare enum PushNotificationAction {
     Ding = "com.ring.pn.live-event.ding",
     Motion = "com.ring.pn.live-event.motion",
-    IntercomUnlock = "com.ring.pn.intercom.virtual.unlock",
+    IntercomDing = "com.ring.pn.live-event.intercom",
+    IntercomUnlock = "com.ring.push.INTERCOM_UNLOCK_FROM_APP",
     AlarmModeNone = "com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_NONE_NOTICE",
     AlarmModeSome = "com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_SOME_NOTICE",
     AlarmSoundSiren = "com.ring.push.HANDLE_NEW_USER_SOUND_SIREN",
@@ -892,7 +894,7 @@ export interface PushNotificationDingV2 {
         device: {
             e2ee_enabled: boolean;
             id: number;
-            kind: RingCameraKind;
+            kind: RingCameraKind | RingDeviceType.IntercomHandsetAudio;
             name: string;
         };
         event: {
@@ -900,7 +902,7 @@ export interface PushNotificationDingV2 {
                 id: string;
                 created_at: string;
                 subtype: 'other_motion' | 'motion' | 'ding' | 'human' | string;
-                detection_type: NotificationDetectionType;
+                detection_type?: NotificationDetectionType;
             };
             eventito: {
                 type: NotificationDetectionType;
@@ -923,7 +925,7 @@ export interface PushNotificationDingV2 {
         snapshot_uuid: string;
     };
 }
-export interface PushNotificationAlarm {
+interface PushNotificationAlarm {
     aps: {
         alert: string;
     };
@@ -938,7 +940,22 @@ export interface PushNotificationAlarmV2 {
         gcmData: PushNotificationAlarm;
     };
 }
-export type PushNotification = PushNotificationDingV2 | PushNotificationAlarmV2;
+interface PushNotificationIntercomUnlock {
+    aps: {
+        alert: string;
+    };
+    action: PushNotificationAction.IntercomUnlock;
+    alarm_meta: {
+        device_zid: number;
+        location_id: string;
+    };
+}
+export interface PushNotificationIntercomUnlockV2 {
+    data: {
+        gcmData: PushNotificationIntercomUnlock;
+    };
+}
+export type PushNotification = PushNotificationDingV2 | PushNotificationAlarmV2 | PushNotificationIntercomUnlockV2;
 export interface SocketTicketResponse {
     ticket: string;
     responseTimestampe: number;

package/lib/ring-types.js

@@ -188,7 +188,8 @@ var PushNotificationAction;
 (function (PushNotificationAction) {
     PushNotificationAction["Ding"] = "com.ring.pn.live-event.ding";
     PushNotificationAction["Motion"] = "com.ring.pn.live-event.motion";
-    PushNotificationAction["IntercomUnlock"] = "com.ring.pn.intercom.virtual.unlock";
+    PushNotificationAction["IntercomDing"] = "com.ring.pn.live-event.intercom";
+    PushNotificationAction["IntercomUnlock"] = "com.ring.push.INTERCOM_UNLOCK_FROM_APP";
     PushNotificationAction["AlarmModeNone"] = "com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_NONE_NOTICE";
     PushNotificationAction["AlarmModeSome"] = "com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_SOME_NOTICE";
     PushNotificationAction["AlarmSoundSiren"] = "com.ring.push.HANDLE_NEW_USER_SOUND_SIREN";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "13.0.0-beta.2",
+  "version": "13.0.0-beta.4",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
   "exports": {
@@ -17,7 +17,7 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@eneris/push-receiver": "^4.1.2",
+    "@eneris/push-receiver": "^4.1.4",
     "@homebridge/camera-utils": "^2.2.6",
     "@types/socket.io-client": "1.4.36",
     "colors": "1.4.0",
@@ -27,22 +27,22 @@
     "socket.io-client": "^2.5.0",
     "systeminformation": "^5.22.11",
     "uuid": "^10.0.0",
-    "werift": "0.19.3",
-    "ws": "^8.17.1"
+    "werift": "0.19.4",
+    "ws": "^8.18.0"
   },
   "devDependencies": {
     "@types/debug": "4.1.12",
     "@types/jest": "29.5.12",
     "@types/json-bigint": "^1.0.4",
-    "@types/node": "20.14.7",
+    "@types/node": "20.14.11",
     "@types/uuid": "10.0.0",
-    "@types/ws": "^8.5.10",
+    "@types/ws": "^8.5.11",
     "eslint-config-shared": "*",
     "jest": "29.7.0",
     "msw": "^1.3.3",
-    "ts-jest": "29.1.5",
+    "ts-jest": "29.2.3",
     "tsconfig": "*",
-    "typescript": "5.5.2"
+    "typescript": "5.5.3"
   },
   "engines": {
     "node": "^18 || ^20"