ring-client-api 13.2.0 → 13.2.1-beta.1

package/lib/api.js

@@ -176,6 +176,13 @@ class RingApi extends subscribed_1.Subscribed {
                 (0, util_1.logError)(e);
             }
         }));
+        pushReceiver.on('ON_DISCONNECT', () => {
+            pushReceiver.whenReady.catch((e) => {
+                (0, util_1.logError)('Connection to the push notification server has failed unexpectedly');
+                (0, util_1.logError)('If this happens repeatedly, verify connections to TCP/5228 are allowed and that DNS Adblock rules allow gtalk.google.com');
+                (0, util_1.logError)(e.message);
+            });
+        });
         try {
             await pushReceiver.connect();
         }

package/lib/rest-client.d.ts

@@ -1,10 +1,12 @@
 import { AuthTokenResponse, SessionResponse } from './ring-types';
 import { ReplaySubject } from 'rxjs';
 import type { Credentials } from '@eneris/push-receiver/dist/types';
+import { Agent } from 'undici';
 interface RequestOptions extends RequestInit {
     responseType?: 'json' | 'buffer';
     timeout?: number;
     json?: object;
+    dispatcher?: Agent;
 }
 export declare function clientApi(path: string): string;
 export declare function deviceApi(path: string): string;
@@ -42,7 +44,7 @@ export declare class RingRestClient {
         oldRefreshToken?: string;
         newRefreshToken: string;
     }>;
-    onSession: ReplaySubject<SessionResponse>;
+    onSession: ReplaySubject<import("./ring-types").ProfileResponse>;
     readonly baseSessionMetadata: {
         api_version: number;
         device_model: string;

package/lib/rest-client.js

@@ -11,7 +11,12 @@ exports.appApi = appApi;
 const util_1 = require("./util");
 const rxjs_1 = require("rxjs");
 const assert_1 = __importDefault(require("assert"));
-const defaultRequestOptions = {
+const undici_1 = require("undici");
+const fetchAgent = new undici_1.Agent({
+    connections: 6,
+    pipelining: 1,
+    keepAliveTimeout: 115000,
+}), defaultRequestOptions = {
     responseType: 'json',
     method: 'GET',
     timeout: 20000,
@@ -46,11 +51,11 @@ async function responseToError(response) {
         try {
             error.response.body = JSON.parse(bodyText);
         }
-        catch (_) {
+        catch {
             error.response.body = bodyText;
         }
     }
-    catch (_) {
+    catch {
         // ignore
     }
     return error;
@@ -74,6 +79,7 @@ async function requestWithRetry(requestOptions, retryCount = 0) {
         const options = {
             ...defaultRequestOptions,
             ...requestOptions,
+            dispatcher: fetchAgent,
         };
         // If a timeout is provided, create an AbortSignal for it
         if (options.timeout && !options.signal) {
@@ -95,7 +101,7 @@ async function requestWithRetry(requestOptions, retryCount = 0) {
             try {
                 data = JSON.parse(text);
             }
-            catch (_) {
+            catch {
                 data = text;
             }
         }
@@ -139,7 +145,7 @@ function parseAuthConfig(rawRefreshToken) {
         (0, assert_1.default)(config.rt);
         return config;
     }
-    catch (_) {
+    catch {
         return {
             rt: rawRefreshToken,
         };
@@ -363,7 +369,6 @@ class RingRestClient {
                     authorization: `Bearer ${authTokenResponse.access_token}`,
                     hardware_id: hardwareId,
                     'User-Agent': 'android:com.ringapp',
-                    Connection: 'close',
                 },
             });
         }

package/lib/ring-camera.d.ts

@@ -88,14 +88,14 @@ export declare class RingCamera extends Subscribed {
     private fetchingSnapshot;
     getSnapshot({ uuid }?: {
         uuid?: string;
-    }): Promise<Buffer>;
+    }): Promise<Buffer<ArrayBufferLike>>;
     getNextSnapshot({ afterMs, maxWaitMs, force, uuid, }: {
         afterMs?: number;
         maxWaitMs?: number;
         force?: boolean;
         uuid?: string;
-    }): Promise<Buffer & import("./rest-client").ExtendedResponse>;
-    getSnapshotByUuid(uuid: string): Promise<Buffer & import("./rest-client").ExtendedResponse>;
+    }): Promise<Buffer<ArrayBufferLike> & import("./rest-client").ExtendedResponse>;
+    getSnapshotByUuid(uuid: string): Promise<Buffer<ArrayBufferLike> & import("./rest-client").ExtendedResponse>;
     recordToFile(outputPath: string, duration?: number): Promise<void>;
     streamVideo(ffmpegOptions: FfmpegOptions): Promise<StreamingSession>;
     /**

package/lib/ring-camera.js

@@ -281,7 +281,7 @@ class RingCamera extends subscribed_1.Subscribed {
     processPushNotification(notification) {
         if (!('android_config' in notification) ||
             !('event' in notification.data) ||
-            !('ding' in notification.data?.event)) {
+            !('ding' in (notification.data?.event ?? {}))) {
             // only process ding/motion notifications
             return;
         }

package/lib/ring-types.d.ts

@@ -1006,8 +1006,7 @@ export interface ProfileResponse {
         account_type: 'ring' | string;
     };
 }
-export interface SessionResponse extends ProfileResponse {
-}
+export type SessionResponse = ProfileResponse;
 export interface AccountMonitoringStatus {
     accountUuid: string;
     externalServiceConfigType: 'rrms' | string;

package/lib/ring-types.js

@@ -25,7 +25,6 @@ var RingDeviceType;
     RingDeviceType["CoAlarm"] = "alarm.co";
     RingDeviceType["SmokeCoListener"] = "listener.smoke-co";
     RingDeviceType["MultiLevelSwitch"] = "switch.multilevel";
-    // eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
     RingDeviceType["Fan"] = "switch.multilevel";
     RingDeviceType["MultiLevelBulb"] = "switch.multilevel.bulb";
     RingDeviceType["Switch"] = "switch";
@@ -40,12 +39,9 @@ var RingDeviceType;
     RingDeviceType["Thermostat"] = "temperature-control.thermostat";
     RingDeviceType["Sensor"] = "sensor";
     RingDeviceType["RingNetAdapter"] = "adapter.ringnet";
-    // eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
     RingDeviceType["CodeVault"] = "access-code.vault";
-    // eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
     RingDeviceType["SecurityAccessCode"] = "access-code";
     RingDeviceType["ZWaveAdapter"] = "adapter.zwave";
-    // eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
     RingDeviceType["ZWaveExtender"] = "range-extender.zwave";
     RingDeviceType["PanicButton"] = "security-panic";
     RingDeviceType["UnknownZWave"] = "unknown.zwave";

package/lib/streaming/webrtc-connection.js

@@ -148,7 +148,7 @@ class WebrtcConnection extends subscribed_1.Subscribed {
                 return;
             case 'pong':
                 return;
-            case 'notification':
+            case 'notification': {
                 const { text } = message.body;
                 if (text === 'camera_connected') {
                     this.onCameraConnected.next();
@@ -159,6 +159,7 @@ class WebrtcConnection extends subscribed_1.Subscribed {
                     return;
                 }
                 break;
+            }
             case 'close':
                 (0, util_1.logError)('Video stream closed');
                 (0, util_1.logError)(message.body);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "13.2.0",
+  "version": "13.2.1-beta.1",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
   "exports": {
@@ -13,7 +13,7 @@
   "scripts": {
     "build": "rm -rf lib && tsc --declaration && chmod +x ./lib/ring-*-cli.js",
     "dev": "tsc --declaration --watch --preserveWatchOutput",
-    "lint": "eslint . --ext .ts",
+    "lint": "eslint .",
     "test": "jest",
     "test:watch": "jest --watch"
   },
@@ -26,6 +26,7 @@
     "rxjs": "^7.8.1",
     "socket.io-client": "^2.5.0",
     "systeminformation": "^5.23.5",
+    "undici": "^6.21.0",
     "uuid": "^11.0.3",
     "werift": "0.20.1",
     "ws": "^8.18.0"
@@ -34,7 +35,7 @@
     "@types/debug": "4.1.12",
     "@types/jest": "29.5.14",
     "@types/json-bigint": "^1.0.4",
-    "@types/node": "22.9.0",
+    "@types/node": "22.9.3",
     "@types/socket.io-client": "1.4.36",
     "@types/uuid": "10.0.0",
     "@types/ws": "^8.5.13",
@@ -43,7 +44,7 @@
     "msw": "^2.6.4",
     "ts-jest": "29.2.5",
     "tsconfig": "*",
-    "typescript": "5.6.3"
+    "typescript": "5.7.2"
   },
   "engines": {
     "node": "^18 || ^20 || ^22"