ring-client-api 13.0.1 → 13.1.0

package/lib/ring-types.d.ts

@@ -42,7 +42,8 @@ export declare enum RingDeviceType {
     UnknownZWave = "unknown.zwave",
     OnvifCamera = "onvif_camera",
     ThirdPartyGarageDoorOpener = "third_party_gdo",
-    IntercomHandsetAudio = "intercom_handset_audio"
+    IntercomHandsetAudio = "intercom_handset_audio",
+    WaterValve = "valve.water"
 }
 export declare enum RingDeviceCategory {
     Outlets = 1,
@@ -61,7 +62,8 @@ export declare enum RingDeviceCategory {
     RangeExtenders = 32,
     Keypads = 33,
     Sirens = 34,
-    PanicButtons = 35
+    PanicButtons = 35,
+    WaterValves = 37
 }
 export declare enum RingCameraKind {
     doorbot = "doorbot",
@@ -187,6 +189,7 @@ export interface RingDeviceData {
     }[];
     motionSensorEnabled?: boolean;
     brightness?: number;
+    valveState?: 'open' | 'closed';
 }
 export declare const deviceTypesWithVolume: RingDeviceType[];
 export interface BaseStation {

package/lib/ring-types.js

@@ -52,6 +52,7 @@ var RingDeviceType;
     RingDeviceType["OnvifCamera"] = "onvif_camera";
     RingDeviceType["ThirdPartyGarageDoorOpener"] = "third_party_gdo";
     RingDeviceType["IntercomHandsetAudio"] = "intercom_handset_audio";
+    RingDeviceType["WaterValve"] = "valve.water";
 })(RingDeviceType || (exports.RingDeviceType = RingDeviceType = {}));
 // eslint-disable-next-line no-shadow
 var RingDeviceCategory;
@@ -73,6 +74,7 @@ var RingDeviceCategory;
     RingDeviceCategory[RingDeviceCategory["Keypads"] = 33] = "Keypads";
     RingDeviceCategory[RingDeviceCategory["Sirens"] = 34] = "Sirens";
     RingDeviceCategory[RingDeviceCategory["PanicButtons"] = 35] = "PanicButtons";
+    RingDeviceCategory[RingDeviceCategory["WaterValves"] = 37] = "WaterValves";
 })(RingDeviceCategory || (exports.RingDeviceCategory = RingDeviceCategory = {}));
 // eslint-disable-next-line no-shadow
 var RingCameraKind;
@@ -110,6 +112,7 @@ var RingCameraKind;
     RingCameraKind["stickup_cam_mini"] = "stickup_cam_mini";
     RingCameraKind["onvif_camera"] = "onvif_camera";
 })(RingCameraKind || (exports.RingCameraKind = RingCameraKind = {}));
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 exports.RingCameraModel = {
     doorbot: 'Doorbell',
     doorbell: 'Doorbell',
@@ -159,6 +162,7 @@ exports.deviceTypesWithVolume = [
     RingDeviceType.BaseStation,
     RingDeviceType.Keypad,
 ];
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 exports.ChimeModel = {
     chime: 'Chime',
     chime_pro: 'Chime Pro',

package/lib/streaming/peer-connection.d.ts

@@ -22,7 +22,7 @@ export declare class WeriftPeerConnection extends Subscribed implements BasicPee
     onVideoRtp: Subject<RtpPacket>;
     onVideoRtcp: Subject<RtcpPacket>;
     onIceCandidate: Subject<RTCIceCandidate>;
-    onConnectionState: ReplaySubject<"connected" | "closed" | "failed" | "disconnected" | "new" | "connecting">;
+    onConnectionState: ReplaySubject<"closed" | "connected" | "failed" | "disconnected" | "new" | "connecting">;
     returnAudioTrack: MediaStreamTrack;
     private onRequestKeyFrame;
     constructor();

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

@@ -6,105 +6,104 @@ const rest_client_1 = require("../rest-client");
 const util_1 = require("../util");
 const rxjs_1 = require("rxjs");
 let sessionCreatedCount = 0, client;
-const email = 'some@one.com', password = 'abc123!', phone = '+1xxxxxxxx89', twoFactorAuthCode = '123456', hardwareIdPromise = (0, util_1.getHardwareId)(), accessToken = 'ey__accees_token', secondAccessToken = 'ey__second_accees_token', refreshToken = 'ey__refresh_token', secondRefreshToken = 'ey__second_refresh_token', thirdRefreshToken = 'ey__third_refresh_token', server = (0, node_1.setupServer)(msw_1.rest.post('https://oauth.ring.com/oauth/token', async (req, res, ctx) => {
+const email = 'some@one.com', password = 'abc123!', phone = '+1xxxxxxxx89', twoFactorAuthCode = '123456', hardwareIdPromise = (0, util_1.getHardwareId)(), accessToken = 'ey__accees_token', secondAccessToken = 'ey__second_accees_token', refreshToken = 'ey__refresh_token', secondRefreshToken = 'ey__second_refresh_token', thirdRefreshToken = 'ey__third_refresh_token', server = (0, node_1.setupServer)(msw_1.http.post('https://oauth.ring.com/oauth/token', async ({ request: req }) => {
     const body = await req.json();
     if (req.headers.get('2fa-support') !== 'true' ||
         req.headers.get('User-Agent') !== 'android:com.ringapp' ||
         req.headers.get('hardware_id') !== (await hardwareIdPromise)) {
-        return res(ctx.status(400), ctx.json({
+        return msw_1.HttpResponse.json({
             code: 1,
-            error: 'Invalid auth headers: ' +
-                JSON.stringify(req.headers.raw(), null, 2),
-        }));
+            error: 'Invalid auth headers: ' + JSON.stringify(req.headers, null, 2),
+        }, { status: 400 });
     }
     if (body.grant_type === 'refresh_token') {
         if (body.refresh_token === refreshToken) {
             // Valid refresh token
-            return res(ctx.status(200), ctx.json({
+            return msw_1.HttpResponse.json({
                 access_token: accessToken,
                 expires_in: 3600,
                 refresh_token: secondRefreshToken,
                 scope: 'client',
                 token_type: 'Bearer',
-            }));
+            }, { status: 200 });
         }
         if (body.refresh_token === secondRefreshToken) {
             // Valid refresh token
-            return res(ctx.status(200), ctx.json({
+            return msw_1.HttpResponse.json({
                 access_token: secondAccessToken,
                 expires_in: 3600,
                 refresh_token: thirdRefreshToken,
                 scope: 'client',
                 token_type: 'Bearer',
-            }));
+            }, { status: 200 });
         }
         // Invalid refresh token
-        return res(ctx.status(401), ctx.json({
+        return msw_1.HttpResponse.json({
             error: 'invalid_grant',
             error_description: 'token is invalid or does not exists',
-        }));
+        }, { status: 401 });
     }
     if (body.grant_type !== 'password' ||
         body.client_id !== 'ring_official_android' ||
         body.scope !== 'client') {
-        return res(ctx.status(400), ctx.json({
+        return msw_1.HttpResponse.json({
             code: 1,
             error: 'Invalid auth request: ' + JSON.stringify(body),
-        }));
+        }, { status: 400 });
     }
     if (body.username !== email || body.password !== password) {
         // Wrong username or password
-        return res(ctx.status(401), ctx.json({
+        return msw_1.HttpResponse.json({
             error: 'access_denied',
             error_description: 'invalid user credentials',
-        }));
+        }, { status: 401 });
     }
     if (req.headers.get('2fa-code') &&
         req.headers.get('2fa-code') !== twoFactorAuthCode) {
         // Wrong 2fa code
-        return res(ctx.status(400), ctx.json({
+        return msw_1.HttpResponse.json({
             err_msg: 'bad request response from dependency service',
             error: 'Verification Code is invalid or expired',
-        }));
+        }, { status: 400 });
     }
     if (req.headers.get('2fa-code') === twoFactorAuthCode) {
         // Successfull login with correct 2fa code
-        return res(ctx.json({
+        return msw_1.HttpResponse.json({
             access_token: accessToken,
             expires_in: 3600,
             refresh_token: refreshToken,
             scope: 'client',
             token_type: 'Bearer',
             responseTimestamp: Date.now(),
-        }));
+        });
     }
     // 2fa code not provided, so return the 2fa prompt
-    return res(ctx.status(412), ctx.json({
+    return msw_1.HttpResponse.json({
         next_time_in_secs: 60,
         phone,
         tsv_state: 'sms',
-    }));
-}), msw_1.rest.post('https://api.ring.com/clients_api/session', async (req, res, ctx) => {
+    }, { status: 412 });
+}), msw_1.http.post('https://api.ring.com/clients_api/session', async ({ request: req }) => {
     const authHeader = req.headers.get('Authorization');
     if (authHeader !== `Bearer ${accessToken}` &&
         authHeader !== `Bearer ${secondAccessToken}`) {
         // Invalid access token used
-        return res(ctx.status(401));
+        return msw_1.HttpResponse.json({}, { status: 401 });
     }
     const body = await req.json();
     if (body.device.hardware_id !== (await (0, util_1.getHardwareId)()) ||
         body.device.metadata.api_version !== 11 ||
         body.device.metadata.device_model !== 'ring-client-api' ||
         body.device.os !== 'android') {
-        return res(ctx.status(400), ctx.body('Bad session request: ' + JSON.stringify(body, null, 2)));
+        return msw_1.HttpResponse.text('Bad session request: ' + JSON.stringify(body, null, 2), { status: 400 });
     }
     // Fake a response from the session endpoint, incrementing the sessionCreatedCount
     sessionCreatedCount++;
-    return res(ctx.json({
+    return msw_1.HttpResponse.json({
         profile: {
             id: 1234,
         },
-    }));
+    });
 }));
 async function wrapRefreshToken(rt) {
     return (0, util_1.toBase64)(JSON.stringify({
@@ -200,25 +199,25 @@ describe('fetch', () => {
     let invalidateFirstAccessToken = false;
     beforeEach(() => {
         invalidateFirstAccessToken = false;
-        server.use(msw_1.rest.get('https://api.ring.com/clients_api/some_endpoint', (req, res, ctx) => {
+        server.use(msw_1.http.get('https://api.ring.com/clients_api/some_endpoint', ({ request: req }) => {
             const authHeader = req.headers.get('Authorization');
             if (invalidateFirstAccessToken &&
                 authHeader === `Bearer ${accessToken}`) {
                 // Original access token used, but no longer valid
-                return res(ctx.status(401));
+                return msw_1.HttpResponse.json({}, { status: 401 });
             }
             if (authHeader !== `Bearer ${accessToken}` &&
                 authHeader !== `Bearer ${secondAccessToken}`) {
                 // Invalid access token used
-                return res(ctx.status(401));
+                return msw_1.HttpResponse.json({}, { status: 401 });
             }
             if (sessionCreatedCount === 0) {
                 // Session not created yet
-                return res(ctx.status(404), ctx.json({
+                return msw_1.HttpResponse.json({
                     error: 'Session not found for ' + req.headers.get('hardware_id'),
-                }));
+                }, { status: 404 });
             }
-            return res(ctx.json([]));
+            return msw_1.HttpResponse.json([]);
         }));
     });
     it('should include the auth token as a header', async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "13.0.1",
+  "version": "13.1.0",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
   "exports": {
@@ -21,11 +21,11 @@
     "@homebridge/camera-utils": "^2.2.6",
     "@types/socket.io-client": "1.4.36",
     "colors": "1.4.0",
-    "debug": "^4.3.5",
+    "debug": "^4.3.6",
     "json-bigint": "^1.0.0",
     "rxjs": "^7.8.1",
     "socket.io-client": "^2.5.0",
-    "systeminformation": "^5.22.11",
+    "systeminformation": "^5.23.4",
     "uuid": "^10.0.0",
     "werift": "0.19.4",
     "ws": "^8.18.0"
@@ -34,15 +34,15 @@
     "@types/debug": "4.1.12",
     "@types/jest": "29.5.12",
     "@types/json-bigint": "^1.0.4",
-    "@types/node": "20.14.11",
+    "@types/node": "22.1.0",
     "@types/uuid": "10.0.0",
-    "@types/ws": "^8.5.11",
+    "@types/ws": "^8.5.12",
     "eslint-config-shared": "*",
     "jest": "29.7.0",
-    "msw": "^1.3.3",
-    "ts-jest": "29.2.3",
+    "msw": "^2.3.5",
+    "ts-jest": "29.2.4",
     "tsconfig": "*",
-    "typescript": "5.5.3"
+    "typescript": "5.5.4"
   },
   "engines": {
     "node": "^18 || ^20"