ring-client-api 11.7.7 → 11.8.0

package/lib/api.js

@@ -123,7 +123,8 @@ class RingApi extends subscribed_1.Subscribed {
         }
     }
     async registerPushReceiver(cameras, intercoms) {
-        const pushReceiver = new push_receiver_1.default({
+        const credentials = this.restClient._internalOnly_pushNotificationCredentials, pushReceiver = new push_receiver_1.default({
+            credentials,
             logLevel: 'NONE',
             senderId: '876313859327', // for Ring android app.  703521446232 for ring-site
         }), devicesById = {}, sendToDevice = (id, notification) => {
@@ -135,10 +136,15 @@ class RingApi extends subscribed_1.Subscribed {
         for (const intercom of intercoms) {
             devicesById[intercom.id] = intercom;
         }
-        pushReceiver.onCredentialsChanged(({ newCredentials: { fcm: { token }, }, }) => onPushNotificationToken.next(token));
+        pushReceiver.onCredentialsChanged(({ newCredentials }) => {
+            // Store the new credentials in the rest client so that it can be used for subsequent restarts
+            this.restClient._internalOnly_pushNotificationCredentials = newCredentials;
+            // Send the new credentials to the server
+            onPushNotificationToken.next(newCredentials.fcm.token);
+        });
         this.addSubscriptions((0, rxjs_1.combineLatest)([
             onPushNotificationToken,
-            this.restClient.onSession, // combined but not used here, just to trigger another request when session is updated
+            this.restClient.onSession.pipe((0, operators_1.startWith)(undefined)), // combined but not used here, just to trigger another request when session is updated
         ]).subscribe(async ([token]) => {
             try {
                 await this.restClient.request({
@@ -160,7 +166,21 @@ class RingApi extends subscribed_1.Subscribed {
                 (0, util_1.logError)(e);
             }
         }));
+        try {
+            await pushReceiver.connect();
+        }
+        catch (e) {
+            (0, util_1.logError)('Failed to connect push notification receiver');
+            (0, util_1.logError)(e);
+        }
+        const startTime = Date.now();
         pushReceiver.onNotification(({ message }) => {
+            // Ignore messages received in the first two seconds after connecting
+            // These are likely duplicates, and we aren't currently storying persistent ids anywhere to avoid re-processing them
+            if (Date.now() - startTime < 2000) {
+                (0, util_1.logInfo)('Ignoring push notification received in first two seconds after starting up');
+                return;
+            }
             const dataJson = message.data?.gcmData;
             try {
                 const notification = (0, json_bigint_1.default)({ storeAsString: true }).parse(dataJson);
@@ -176,12 +196,9 @@ class RingApi extends subscribed_1.Subscribed {
                 (0, util_1.logError)(e);
             }
         });
-        try {
-            await pushReceiver.connect();
-        }
-        catch (e) {
-            (0, util_1.logError)('Failed to connect push notification receiver');
-            (0, util_1.logError)(e);
+        // If we already have credentials, use them immediately
+        if (credentials) {
+            onPushNotificationToken.next(credentials.fcm.token);
         }
     }
     async fetchRawLocations() {

package/lib/rest-client.d.ts

@@ -1,6 +1,7 @@
 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';
 export declare function clientApi(path: string): string;
 export declare function deviceApi(path: string): string;
 export declare function commandsApi(path: string): string;
@@ -24,6 +25,7 @@ export interface SessionOptions {
 export declare class RingRestClient {
     private authOptions;
     refreshToken: string | undefined;
+    private authConfig;
     private hardwareIdPromise;
     private _authPromise;
     private timeouts;
@@ -54,4 +56,6 @@ export declare class RingRestClient {
     }): Promise<T & ExtendedResponse>;
     getCurrentAuth(): Promise<AuthTokenResponse>;
     clearTimeouts(): void;
+    get _internalOnly_pushNotificationCredentials(): Credentials | undefined;
+    set _internalOnly_pushNotificationCredentials(credentials: Credentials | undefined);
 }

package/lib/rest-client.js

@@ -7,6 +7,7 @@ exports.RingRestClient = exports.appApi = exports.commandsApi = exports.deviceAp
 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',
@@ -64,6 +65,22 @@ async function requestWithRetry(requestOptions) {
         throw e;
     }
 }
+function parseAuthConfig(rawRefreshToken) {
+    if (!rawRefreshToken) {
+        return;
+    }
+    try {
+        const config = JSON.parse((0, util_1.fromBase64)(rawRefreshToken));
+        (0, assert_1.default)(config);
+        (0, assert_1.default)(config.rt);
+        return config;
+    }
+    catch (_) {
+        return {
+            rt: rawRefreshToken,
+        };
+    }
+}
 class RingRestClient {
     clearPreviousAuth() {
         this._authPromise = undefined;
@@ -90,6 +107,11 @@ class RingRestClient {
     }
     constructor(authOptions) {
         this.authOptions = authOptions;
+        this.refreshToken = 'refreshToken' in this.authOptions
+            ? this.authOptions.refreshToken
+            : undefined;
+        this.authConfig = parseAuthConfig(this.refreshToken);
+        this.hardwareIdPromise = this.authConfig?.hid || (0, util_1.getHardwareId)(this.authOptions.systemId);
         this.timeouts = [];
         this.sessionPromise = undefined;
         this.using2fa = false;
@@ -99,17 +121,12 @@ class RingRestClient {
             api_version: apiVersion,
             device_model: this.authOptions.controlCenterDisplayName ?? 'ring-client-api',
         };
-        this.refreshToken =
-            'refreshToken' in this.authOptions
-                ? this.authOptions.refreshToken
-                : undefined;
-        this.hardwareIdPromise = (0, util_1.getHardwareId)(this.authOptions.systemId);
     }
     getGrantData(twoFactorAuthCode) {
-        if (this.refreshToken && !twoFactorAuthCode) {
+        if (this.authConfig?.rt && !twoFactorAuthCode) {
             return {
                 grant_type: 'refresh_token',
-                refresh_token: this.refreshToken,
+                refresh_token: this.authConfig.rt,
             };
         }
         const { authOptions } = this;
@@ -125,7 +142,7 @@ class RingRestClient {
     async getAuth(twoFactorAuthCode) {
         const grantData = this.getGrantData(twoFactorAuthCode);
         try {
-            const response = await requestWithRetry({
+            const hardwareId = await this.hardwareIdPromise, response = await requestWithRetry({
                 url: 'https://oauth.ring.com/oauth/token',
                 json: {
                     client_id: 'ring_official_android',
@@ -136,21 +153,33 @@ class RingRestClient {
                 headers: {
                     '2fa-support': 'true',
                     '2fa-code': twoFactorAuthCode || '',
-                    hardware_id: await this.hardwareIdPromise,
+                    hardware_id: hardwareId,
                     'User-Agent': 'android:com.ringapp',
                 },
-            });
+            }), oldRefreshToken = this.refreshToken;
+            // Store the new refresh token and auth config
+            this.authConfig = {
+                ...this.authConfig,
+                rt: response.refresh_token,
+                hid: hardwareId,
+            };
+            this.refreshToken = (0, util_1.toBase64)(JSON.stringify(this.authConfig));
+            // Emit an event with the new token
             this.onRefreshTokenUpdated.next({
-                oldRefreshToken: this.refreshToken,
-                newRefreshToken: response.refresh_token,
+                oldRefreshToken,
+                newRefreshToken: this.refreshToken,
             });
-            this.refreshToken = response.refresh_token;
-            return response;
+            return {
+                ...response,
+                // Override the refresh token in the response so that consumers of this data get the wrapped version
+                refresh_token: this.refreshToken,
+            };
         }
         catch (requestError) {
             if (grantData.refresh_token) {
                 // failed request with refresh token
                 this.refreshToken = undefined;
+                this.authConfig = undefined;
                 (0, util_1.logError)(requestError);
                 return this.getAuth();
             }
@@ -250,9 +279,6 @@ class RingRestClient {
         });
     }
     async request(options) {
-        if (!this.sessionPromise) {
-            this.refreshSession();
-        }
         const hardwareId = await this.hardwareIdPromise, url = options.url, initialSessionPromise = this.sessionPromise;
         try {
             await initialSessionPromise;
@@ -319,5 +345,30 @@ class RingRestClient {
     clearTimeouts() {
         this.timeouts.forEach(clearTimeout);
     }
+    get _internalOnly_pushNotificationCredentials() {
+        return this.authConfig?.pnc;
+    }
+    set _internalOnly_pushNotificationCredentials(credentials) {
+        if (!this.refreshToken || !this.authConfig) {
+            throw new Error('Cannot set push notification credentials without a refresh token');
+        }
+        const oldRefreshToken = this.refreshToken;
+        this.authConfig = {
+            ...this.authConfig,
+            pnc: credentials,
+        };
+        // SOMEDAY: refactor the conversion from auth config to refresh token - DRY from above
+        const newRefreshToken = (0, util_1.toBase64)(JSON.stringify(this.authConfig));
+        if (newRefreshToken === oldRefreshToken) {
+            // No change, so we don't need to emit an updated refresh token
+            return;
+        }
+        // Save and emit the updated refresh token
+        this.refreshToken = newRefreshToken;
+        this.onRefreshTokenUpdated.next({
+            oldRefreshToken,
+            newRefreshToken,
+        });
+    }
 }
 exports.RingRestClient = RingRestClient;

package/lib/ring-camera.js

@@ -99,9 +99,13 @@ class RingCamera extends subscribed_1.Subscribed {
         this.onInHomeDoorbellStatus = this.onData.pipe((0, operators_1.map)(({ settings: { chime_settings } }) => {
             return Boolean(chime_settings?.enable);
         }), (0, operators_1.distinctUntilChanged)());
-        this.addSubscriptions(this.restClient.onSession.subscribe(() => {
+        this.addSubscriptions(this.restClient.onSession
+            .pipe((0, operators_1.startWith)(undefined), (0, operators_1.throttleTime)(1000)) // Force this to run immediately, but don't double run if a session is created due to these api calls
+            .subscribe(() => {
             this.subscribeToDingEvents().catch((e) => {
-                (0, util_1.logError)('Failed to subscribe ' + initialData.description + ' to ding events');
+                (0, util_1.logError)('Failed to subscribe ' +
+                    initialData.description +
+                    ' to ding events');
                 (0, util_1.logError)(e);
             });
             this.subscribeToMotionEvents().catch((e) => {

package/lib/ring-types.js

@@ -47,7 +47,7 @@ var RingDeviceType;
     RingDeviceType["OnvifCamera"] = "onvif_camera";
     RingDeviceType["ThirdPartyGarageDoorOpener"] = "third_party_gdo";
     RingDeviceType["IntercomHandsetAudio"] = "intercom_handset_audio";
-})(RingDeviceType = exports.RingDeviceType || (exports.RingDeviceType = {}));
+})(RingDeviceType || (exports.RingDeviceType = RingDeviceType = {}));
 // eslint-disable-next-line no-shadow
 var RingDeviceCategory;
 (function (RingDeviceCategory) {
@@ -68,7 +68,7 @@ var RingDeviceCategory;
     RingDeviceCategory[RingDeviceCategory["Keypads"] = 33] = "Keypads";
     RingDeviceCategory[RingDeviceCategory["Sirens"] = 34] = "Sirens";
     RingDeviceCategory[RingDeviceCategory["PanicButtons"] = 35] = "PanicButtons";
-})(RingDeviceCategory = exports.RingDeviceCategory || (exports.RingDeviceCategory = {}));
+})(RingDeviceCategory || (exports.RingDeviceCategory = RingDeviceCategory = {}));
 // eslint-disable-next-line no-shadow
 var RingCameraKind;
 (function (RingCameraKind) {
@@ -102,7 +102,7 @@ var RingCameraKind;
     RingCameraKind["cocoa_floodlight"] = "cocoa_floodlight";
     RingCameraKind["stickup_cam_mini"] = "stickup_cam_mini";
     RingCameraKind["onvif_camera"] = "onvif_camera";
-})(RingCameraKind = exports.RingCameraKind || (exports.RingCameraKind = {}));
+})(RingCameraKind || (exports.RingCameraKind = RingCameraKind = {}));
 exports.RingCameraModel = {
     doorbot: 'Doorbell',
     doorbell: 'Doorbell',
@@ -162,7 +162,7 @@ var DoorbellType;
     DoorbellType[DoorbellType["Mechanical"] = 0] = "Mechanical";
     DoorbellType[DoorbellType["Digital"] = 1] = "Digital";
     DoorbellType[DoorbellType["None"] = 2] = "None";
-})(DoorbellType = exports.DoorbellType || (exports.DoorbellType = {}));
+})(DoorbellType || (exports.DoorbellType = DoorbellType = {}));
 // eslint-disable-next-line no-shadow
 var NotificationDetectionType;
 (function (NotificationDetectionType) {
@@ -173,7 +173,7 @@ var NotificationDetectionType;
     NotificationDetectionType["OtherMotion"] = "other_motion";
     NotificationDetectionType["NotAvailable"] = "null";
     NotificationDetectionType["StreamBroken"] = "stream_broken";
-})(NotificationDetectionType = exports.NotificationDetectionType || (exports.NotificationDetectionType = {}));
+})(NotificationDetectionType || (exports.NotificationDetectionType = NotificationDetectionType = {}));
 // eslint-disable-next-line no-shadow
 var PushNotificationAction;
 (function (PushNotificationAction) {
@@ -181,13 +181,13 @@ var PushNotificationAction;
     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 = {}));
+})(PushNotificationAction || (exports.PushNotificationAction = PushNotificationAction = {}));
 // eslint-disable-next-line no-shadow
 var DispatchSignalType;
 (function (DispatchSignalType) {
     DispatchSignalType["Burglar"] = "user-verified-burglar-xa";
     DispatchSignalType["Fire"] = "user-verified-fire-xa";
-})(DispatchSignalType = exports.DispatchSignalType || (exports.DispatchSignalType = {}));
+})(DispatchSignalType || (exports.DispatchSignalType = DispatchSignalType = {}));
 exports.disabledLocationModes = ['disabled', 'unset'];
 function isWebSocketSupportedAsset({ kind }) {
     return kind.startsWith('base_station') || kind.startsWith('beams_bridge');

package/lib/streaming/webrtc-connection.js

@@ -5,7 +5,7 @@ const ws_1 = require("ws");
 const streaming_connection_base_1 = require("./streaming-connection-base");
 const util_1 = require("../util");
 function parseLiveCallSession(sessionId) {
-    const encodedSession = sessionId.split('.')[1], buff = Buffer.from(encodedSession, 'base64'), text = buff.toString('ascii');
+    const encodedSession = sessionId.split('.')[1], text = (0, util_1.fromBase64)(encodedSession);
     return JSON.parse(text);
 }
 class WebrtcConnection extends streaming_connection_base_1.StreamingConnectionBase {

package/lib/test/rest-client.spec.js

@@ -106,6 +106,12 @@ const email = 'some@one.com', password = 'abc123!', phone = '+1xxxxxxxx89', twoF
         },
     }));
 }));
+async function wrapRefreshToken(rt) {
+    return (0, util_1.toBase64)(JSON.stringify({
+        rt,
+        hid: await hardwareIdPromise,
+    }));
+}
 beforeEach(() => {
     sessionCreatedCount = 0;
 });
@@ -143,9 +149,9 @@ describe('getAuth', () => {
         const auth = await client.getAuth(twoFactorAuthCode);
         expect(auth).toMatchObject({
             access_token: accessToken,
-            refresh_token: refreshToken,
+            refresh_token: await wrapRefreshToken(refreshToken),
         });
-        expect(client.refreshToken).toEqual(refreshToken);
+        expect(client.refreshToken).toEqual(await wrapRefreshToken(refreshToken));
     });
     test('it should handle invalid credentials', async () => {
         client = new rest_client_1.RingRestClient({
@@ -171,9 +177,9 @@ describe('getAuth', () => {
         });
         expect(await client.getCurrentAuth()).toMatchObject({
             access_token: accessToken,
-            refresh_token: secondRefreshToken,
+            refresh_token: await wrapRefreshToken(secondRefreshToken),
         });
-        expect(client.refreshToken).toEqual(secondRefreshToken);
+        expect(client.refreshToken).toEqual(await wrapRefreshToken(secondRefreshToken));
     });
     test('it should emit an event when a new refresh token is created', async () => {
         client = new rest_client_1.RingRestClient({
@@ -182,11 +188,11 @@ describe('getAuth', () => {
         const refreshedPromise = (0, rxjs_1.firstValueFrom)(client.onRefreshTokenUpdated), auth = await client.getAuth();
         expect(auth).toMatchObject({
             access_token: accessToken,
-            refresh_token: secondRefreshToken,
+            refresh_token: await wrapRefreshToken(secondRefreshToken),
         });
         expect(await refreshedPromise).toEqual({
             oldRefreshToken: refreshToken,
-            newRefreshToken: secondRefreshToken,
+            newRefreshToken: await wrapRefreshToken(secondRefreshToken),
         });
     });
 });
@@ -194,7 +200,7 @@ describe('fetch', () => {
     let invalidateFirstAccessToken = false;
     beforeEach(() => {
         invalidateFirstAccessToken = false;
-        server.use(msw_1.rest.get('https://api.ring.com/devices/v1/locations', (req, res, ctx) => {
+        server.use(msw_1.rest.get('https://api.ring.com/clients_api/some_endpoint', (req, res, ctx) => {
             const authHeader = req.headers.get('Authorization');
             if (invalidateFirstAccessToken &&
                 authHeader === `Bearer ${accessToken}`) {
@@ -207,10 +213,10 @@ describe('fetch', () => {
                 return res(ctx.status(401));
             }
             if (sessionCreatedCount === 0) {
-                // eslint-disable-next-line no-console
-                console.error('Request received before session was created');
                 // Session not created yet
-                return res(ctx.status(404), ctx.text('Session not created yet'));
+                return res(ctx.status(404), ctx.json({
+                    error: 'Session not found for ' + req.headers.get('hardware_id'),
+                }));
             }
             return res(ctx.json([]));
         }));
@@ -220,7 +226,7 @@ describe('fetch', () => {
             refreshToken,
         });
         const response = await client.request({
-            url: 'https://api.ring.com/devices/v1/locations',
+            url: 'https://api.ring.com/clients_api/some_endpoint',
         });
         expect(response).toEqual([]);
     });
@@ -230,7 +236,7 @@ describe('fetch', () => {
         });
         invalidateFirstAccessToken = true;
         const response = await client.request({
-            url: 'https://api.ring.com/devices/v1/locations',
+            url: 'https://api.ring.com/clients_api/some_endpoint',
         });
         expect(response).toEqual([]);
     });

package/lib/util.d.ts

@@ -19,4 +19,6 @@ export declare function randomString(length: number): string;
 export type DeepPartial<T> = {
     [K in keyof T]?: T[K] extends Array<infer U> ? Array<DeepPartial<U>> : T[K] extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : DeepPartial<T[K]>;
 };
+export declare function fromBase64(encodedInput: string): string;
+export declare function toBase64(input: string): string;
 export {};

package/lib/util.js

@@ -3,7 +3,7 @@ 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 = exports.clearTimeouts = void 0;
+exports.toBase64 = exports.fromBase64 = 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 = exports.clearTimeouts = void 0;
 const debug_1 = __importDefault(require("debug"));
 const colors_1 = require("colors");
 const readline_1 = require("readline");
@@ -134,3 +134,13 @@ function logPushReceiver(...args) {
     logDebug(args[0]);
 }
 logger_1.default.error = logPushReceiver;
+function fromBase64(encodedInput) {
+    const buff = Buffer.from(encodedInput, 'base64');
+    return buff.toString('ascii');
+}
+exports.fromBase64 = fromBase64;
+function toBase64(input) {
+    const buff = Buffer.from(input);
+    return buff.toString('base64');
+}
+exports.toBase64 = toBase64;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "11.7.7",
+  "version": "11.8.0",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
   "exports": {
@@ -27,29 +27,29 @@
     "got": "^11.8.5",
     "json-bigint": "^1.0.0",
     "msw": "^1.2.1",
-    "rxjs": "^7.8.0",
+    "rxjs": "^7.8.1",
     "socket.io-client": "^2.5.0",
-    "systeminformation": "^5.17.12",
+    "systeminformation": "^5.18.2",
     "uuid": "^9.0.0",
     "webcrypto-core": "^1.7.7",
-    "werift": "0.18.2",
+    "werift": "0.18.3",
     "ws": "^8.13.0"
   },
   "devDependencies": {
-    "@types/debug": "4.1.7",
-    "@types/jest": "29.5.0",
+    "@types/debug": "4.1.8",
+    "@types/jest": "29.5.2",
     "@types/json-bigint": "^1.0.1",
-    "@types/node": "18.15.9",
-    "@types/uuid": "9.0.1",
-    "@types/ws": "^8.5.4",
+    "@types/node": "20.2.5",
+    "@types/uuid": "9.0.2",
+    "@types/ws": "^8.5.5",
     "eslint-config-shared": "*",
     "jest": "29.5.0",
-    "ts-jest": "29.0.5",
+    "ts-jest": "29.1.0",
     "tsconfig": "*",
-    "typescript": "5.0.2"
+    "typescript": "5.1.3"
   },
   "engines": {
-    "node": "^16 || ^18"
+    "node": "^16 || ^18 || ^20"
   },
   "repository": {
     "type": "git",