ring-client-api 13.0.0-beta.1 → 13.0.0-beta.3

package/lib/api.js

@@ -200,13 +200,21 @@ class RingApi extends subscribed_1.Subscribed {
                         messageData[p] = message.data[p];
                     }
                 }
-                const notification = messageData, deviceId = notification.data?.device?.id;
+                const notification = messageData;
+                if (!('android_config' in notification)) {
+                    // This is not a v2 ding style notification, so we can't process it
+                    (0, util_1.logInfo)('Received push notification in unknown format');
+                    (0, util_1.logInfo)(JSON.stringify(message));
+                    return;
+                }
+                const deviceId = notification.data?.device?.id;
                 if (deviceId) {
                     sendToDevice(deviceId, notification);
                 }
                 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));

package/lib/rest-client.d.ts

@@ -1,7 +1,11 @@
-import { Options as RequestOptions } from 'got';
 import { AuthTokenResponse, SessionResponse } from './ring-types';
 import { ReplaySubject } from 'rxjs';
 import type { Credentials } from '@eneris/push-receiver/dist/types';
+interface RequestOptions extends RequestInit {
+    responseType?: 'json' | 'buffer';
+    timeout?: number;
+    json?: object;
+}
 export declare function clientApi(path: string): string;
 export declare function deviceApi(path: string): string;
 export declare function commandsApi(path: string): string;
@@ -59,3 +63,4 @@ export declare class RingRestClient {
     get _internalOnly_pushNotificationCredentials(): Credentials | undefined;
     set _internalOnly_pushNotificationCredentials(credentials: Credentials | undefined);
 }
+export {};

package/lib/rest-client.js

@@ -8,14 +8,12 @@ exports.clientApi = clientApi;
 exports.deviceApi = deviceApi;
 exports.commandsApi = commandsApi;
 exports.appApi = appApi;
-const got_1 = __importDefault(require("got"));
 const util_1 = require("./util");
 const rxjs_1 = require("rxjs");
 const assert_1 = __importDefault(require("assert"));
 const defaultRequestOptions = {
     responseType: 'json',
     method: 'GET',
-    retry: 0,
     timeout: 20000,
 }, ringErrorCodes = {
     7050: 'NO_ASSET',
@@ -36,18 +34,76 @@ function commandsApi(path) {
 function appApi(path) {
     return appApiBaseUrl + path;
 }
+async function responseToError(response) {
+    const error = new Error();
+    error.response = {
+        headers: response.headers,
+        status: response.status,
+        body: null,
+    };
+    try {
+        const bodyText = await response.text();
+        try {
+            error.response.body = JSON.parse(bodyText);
+        }
+        catch (_) {
+            error.response.body = bodyText;
+        }
+    }
+    catch (_) {
+        // ignore
+    }
+    return error;
+}
 async function requestWithRetry(requestOptions) {
     try {
+        if (requestOptions.json || requestOptions.responseType === 'json') {
+            requestOptions.headers = {
+                ...requestOptions.headers,
+                'Content-Type': 'application/json',
+                Accept: 'application/json',
+            };
+            if (requestOptions.json) {
+                requestOptions.body = JSON.stringify(requestOptions.json);
+            }
+            delete requestOptions.json;
+        }
         const options = {
             ...defaultRequestOptions,
             ...requestOptions,
-        }, { headers, body } = (await (0, got_1.default)(options)), data = body;
+        };
+        // If a timeout is provided, create an AbortSignal for it
+        if (options.timeout && !options.signal) {
+            options.signal = AbortSignal.timeout(options.timeout);
+        }
+        // make the fetch request
+        const response = await fetch(options.url, options), headers = response.headers;
+        if (!response.ok) {
+            const error = await responseToError(response);
+            throw error;
+        }
+        let data;
+        if (options.responseType === 'buffer') {
+            const arrayBuffer = await response.arrayBuffer();
+            data = Buffer.from(arrayBuffer);
+        }
+        else {
+            const text = await response.text();
+            try {
+                data = JSON.parse(text);
+            }
+            catch (_) {
+                data = text;
+            }
+        }
         if (data !== null && typeof data === 'object') {
-            if (headers.date) {
-                data.responseTimestamp = new Date(headers.date).getTime();
+            const date = headers.get('date');
+            if (date) {
+                data.responseTimestamp = new Date(date).getTime();
             }
-            if (headers['x-time-millis']) {
-                data.timeMillis = Number(headers['x-time-millis']);
+            const xTime = headers.get('x-time-millis');
+            if (xTime) {
+                data.timeMillis = Number(xTime);
             }
         }
         return data;
@@ -186,12 +242,12 @@ class RingRestClient {
             const response = requestError.response || {}, responseData = response.body || {}, responseError = 'error' in responseData && typeof responseData.error === 'string'
                 ? responseData.error
                 : '';
-            if (response.statusCode === 412 || // need 2fa code
-                (response.statusCode === 400 &&
+            if (response.status === 412 || // need 2fa code
+                (response.status === 400 &&
                     responseError.startsWith('Verification Code')) // invalid 2fa code entered
             ) {
                 this.using2fa = true;
-                if (response.statusCode === 400) {
+                if (response.status === 400) {
                     this.promptFor2fa = 'Invalid 2fa code entered.  Please try again.';
                     throw new Error(responseError);
                 }
@@ -245,12 +301,12 @@ class RingRestClient {
             }
             catch (e) {
                 const response = e.response || {};
-                if (response.statusCode === 401) {
+                if (response.status === 401) {
                     await this.refreshAuth();
                     return this.getSession();
                 }
-                if (response.statusCode === 429) {
-                    const retryAfter = e.response.headers['retry-after'], waitSeconds = isNaN(retryAfter)
+                if (response.status === 429) {
+                    const retryAfter = e.response.headers.get('retry-after'), waitSeconds = isNaN(retryAfter)
                         ? 200
                         : Number.parseInt(retryAfter, 10);
                     (0, util_1.logError)(`Session response rate limited. Waiting to retry after ${waitSeconds} seconds`);
@@ -297,16 +353,16 @@ class RingRestClient {
         }
         catch (e) {
             const response = e.response || {};
-            if (response.statusCode === 401) {
+            if (response.status === 401) {
                 await this.refreshAuth();
                 return this.request(options);
             }
-            if (response.statusCode === 504) {
+            if (response.status === 504) {
                 // Gateway Timeout.  These should be recoverable, but wait a few seconds just to be on the safe side
                 await (0, util_1.delay)(5000);
                 return this.request(options);
             }
-            if (response.statusCode === 404 &&
+            if (response.status === 404 &&
                 response.body &&
                 Array.isArray(response.body.errors)) {
                 const errors = response.body.errors, errorText = errors
@@ -320,7 +376,7 @@ class RingRestClient {
                 }
                 (0, util_1.logError)(`http request failed.  ${url} returned unknown errors: (${(0, util_1.stringify)(errors)}).`);
             }
-            if (response.statusCode === 404 && url.startsWith(clientApiBaseUrl)) {
+            if (response.status === 404 && url.startsWith(clientApiBaseUrl)) {
                 (0, util_1.logError)('404 from endpoint ' + url);
                 if (response.body?.error?.includes(hardwareId)) {
                     (0, util_1.logError)('Session hardware_id not found.  Creating a new session and trying again.');
@@ -331,8 +387,8 @@ class RingRestClient {
                 }
                 throw new Error('Not found with response: ' + (0, util_1.stringify)(response.body));
             }
-            if (response.statusCode) {
-                (0, util_1.logError)(`Request to ${url} failed with status ${response.statusCode}. Response body: ${(0, util_1.stringify)(response.body)}`);
+            if (response.status) {
+                (0, util_1.logError)(`Request to ${url} failed with status ${response.status}. Response body: ${(0, util_1.stringify)(response.body)}`);
             }
             else if (!options.allowNoResponse) {
                 (0, util_1.logError)(`Request to ${url} failed:`);

package/lib/ring-camera.d.ts

@@ -1,4 +1,4 @@
-import { CameraData, CameraDeviceSettingsData, CameraEventOptions, CameraEventResponse, CameraHealth, HistoryOptions, PeriodicFootageResponse, PushNotification, PushNotificationDingV2, VideoSearchResponse, OnvifCameraData, RingCameraKind } from './ring-types';
+import { CameraData, CameraDeviceSettingsData, CameraEventOptions, CameraEventResponse, CameraHealth, HistoryOptions, PeriodicFootageResponse, PushNotificationDingV2, VideoSearchResponse, OnvifCameraData, RingCameraKind } from './ring-types';
 import { RingRestClient } from './rest-client';
 import { BehaviorSubject, Subject } from 'rxjs';
 import { DeepPartial } from './util';
@@ -61,7 +61,7 @@ export declare class RingCamera extends Subscribed {
     private createStreamingConnection;
     startLiveCall(options?: StreamingConnectionOptions): Promise<StreamingSession>;
     private removeDingById;
-    processPushNotification(notification: PushNotification): void;
+    processPushNotification(notification: PushNotificationDingV2): void;
     getEvents(options?: CameraEventOptions): Promise<CameraEventResponse & import("./rest-client").ExtendedResponse>;
     videoSearch({ dateFrom, dateTo, order }?: {
         dateFrom: number;

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);
@@ -374,14 +377,13 @@ class RingCamera extends subscribed_1.Subscribed {
     }
     async getNextSnapshot({ afterMs, maxWaitMs, force, uuid, }) {
         const response = await this.restClient.request({
-            url: `https://app-snaps.ring.com/snapshots/next/${this.id}`,
-            responseType: 'buffer',
-            searchParams: {
+            url: `https://app-snaps.ring.com/snapshots/next/${this.id}${(0, util_1.buildSearchString)({
                 'after-ms': afterMs,
                 'max-wait-ms': maxWaitMs,
                 extras: force ? 'force' : undefined,
                 uuid: cleanSnapshotUuid(uuid),
-            },
+            })}`,
+            responseType: 'buffer',
             headers: {
                 accept: 'image/jpeg',
             },

package/lib/ring-intercom.d.ts

@@ -1,4 +1,4 @@
-import { IntercomHandsetAudioData, PushNotification } 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: PushNotification): 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,12 @@ 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",
+    AlarmSilenceSiren = "com.ring.push.HANDLE_NEW_NON_ALARM_SIREN_SILENCED"
 }
 export interface PushNotificationDingV2 {
     version: '2.0.0' | string;
@@ -888,7 +894,7 @@ export interface PushNotificationDingV2 {
         device: {
             e2ee_enabled: boolean;
             id: number;
-            kind: RingCameraKind;
+            kind: RingCameraKind | RingDeviceType.IntercomHandsetAudio;
             name: string;
         };
         event: {
@@ -896,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;
@@ -919,7 +925,7 @@ export interface PushNotificationDingV2 {
         snapshot_uuid: string;
     };
 }
-export interface PushNotificationAlarm {
+interface PushNotificationAlarm {
     aps: {
         alert: string;
     };
@@ -929,7 +935,27 @@ export interface PushNotificationAlarm {
         location_id: string;
     };
 }
-export type PushNotification = PushNotificationDingV2;
+export interface PushNotificationAlarmV2 {
+    data: {
+        gcmData: PushNotificationAlarm;
+    };
+}
+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,12 @@ 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";
+    PushNotificationAction["AlarmSilenceSiren"] = "com.ring.push.HANDLE_NEW_NON_ALARM_SIREN_SILENCED";
 })(PushNotificationAction || (exports.PushNotificationAction = PushNotificationAction = {}));
 // eslint-disable-next-line no-shadow
 var DispatchSignalType;

package/lib/util.d.ts

@@ -21,4 +21,5 @@ export type DeepPartial<T> = {
 };
 export declare function fromBase64(encodedInput: string): string;
 export declare function toBase64(input: string): string;
+export declare function buildSearchString(search: Record<string, any>): string;
 export {};

package/lib/util.js

@@ -19,6 +19,7 @@ exports.randomInteger = randomInteger;
 exports.randomString = randomString;
 exports.fromBase64 = fromBase64;
 exports.toBase64 = toBase64;
+exports.buildSearchString = buildSearchString;
 const debug_1 = __importDefault(require("debug"));
 const colors_1 = require("colors");
 const readline_1 = require("readline");
@@ -143,3 +144,10 @@ function toBase64(input) {
     const buff = Buffer.from(input);
     return buff.toString('base64');
 }
+function buildSearchString(search) {
+    return ('?' +
+        Object.entries(search)
+            .filter(([, value]) => value !== undefined && value !== null)
+            .map(([key, value]) => `${key}=${value}`)
+            .join('&'));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "13.0.0-beta.1",
+  "version": "13.0.0-beta.3",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
   "exports": {
@@ -17,36 +17,32 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@eneris/push-receiver": "^4.1.2",
+    "@eneris/push-receiver": "^4.1.4",
     "@homebridge/camera-utils": "^2.2.6",
-    "@peculiar/asn1-schema": "^2.3.8",
     "@types/socket.io-client": "1.4.36",
     "colors": "1.4.0",
     "debug": "^4.3.5",
-    "got": "^11.8.5",
     "json-bigint": "^1.0.0",
-    "msw": "^1.3.3",
-    "pvtsutils": "^1.3.5",
     "rxjs": "^7.8.1",
     "socket.io-client": "^2.5.0",
     "systeminformation": "^5.22.11",
     "uuid": "^10.0.0",
-    "webcrypto-core": "^1.8.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",
-    "ts-jest": "29.1.5",
+    "msw": "^1.3.3",
+    "ts-jest": "29.2.3",
     "tsconfig": "*",
-    "typescript": "5.5.2"
+    "typescript": "5.5.3"
   },
   "engines": {
     "node": "^18 || ^20"