ring-client-api 13.1.0 → 13.2.0-beta.0

package/lib/api.js

@@ -18,6 +18,9 @@ const push_receiver_1 = __importDefault(require("@eneris/push-receiver"));
 const ring_intercom_1 = require("./ring-intercom");
 const json_bigint_1 = __importDefault(require("json-bigint"));
 class RingApi extends subscribed_1.Subscribed {
+    options;
+    restClient;
+    onRefreshTokenUpdated;
     constructor(options) {
         super();
         this.options = options;
@@ -273,6 +276,7 @@ class RingApi extends subscribed_1.Subscribed {
         });
         return locations;
     }
+    locationsPromise;
     getLocations() {
         if (!this.locationsPromise) {
             this.locationsPromise = this.fetchAndBuildLocations();

package/lib/location.js

@@ -15,6 +15,51 @@ function flattenDeviceData(data) {
     return Object.assign({}, data.general && data.general.v2, data.device && data.device.v1);
 }
 class Location extends subscribed_1.Subscribed {
+    locationDetails;
+    cameras;
+    chimes;
+    intercoms;
+    options;
+    restClient;
+    seq = 1;
+    onMessage = new rxjs_1.Subject();
+    onDataUpdate = new rxjs_1.Subject();
+    onDeviceDataUpdate = this.onDataUpdate.pipe((0, operators_1.filter)((message) => {
+        return message.datatype === 'DeviceInfoDocType' && Boolean(message.body);
+    }), (0, operators_1.concatMap)((message) => message.body), (0, operators_1.map)(flattenDeviceData));
+    onDeviceList = this.onMessage.pipe((0, operators_1.filter)((m) => m.msg === deviceListMessageType));
+    onDevices = this.onDeviceList.pipe((0, operators_1.scan)((devices, { body: deviceList, src }) => {
+        if (!deviceList) {
+            return devices;
+        }
+        if (!this.receivedAssetDeviceLists.includes(src)) {
+            this.receivedAssetDeviceLists.push(src);
+        }
+        return deviceList.reduce((updatedDevices, data) => {
+            const flatData = flattenDeviceData(data), existingDevice = updatedDevices.find((x) => x.zid === flatData.zid);
+            if (existingDevice) {
+                existingDevice.updateData(flatData);
+                return updatedDevices;
+            }
+            return [...updatedDevices, new ring_device_1.RingDevice(flatData, this, src)];
+        }, devices);
+    }, []), (0, operators_1.distinctUntilChanged)((a, b) => a.length === b.length), (0, operators_1.filter)(() => {
+        return Boolean(this.assets &&
+            this.assets.every((asset) => this.receivedAssetDeviceLists.includes(asset.uuid)));
+    }), (0, operators_1.shareReplay)(1));
+    onSessionInfo = this.onDataUpdate.pipe((0, operators_1.filter)((m) => m.msg === 'SessionInfo'), (0, operators_1.map)((m) => m.body));
+    onConnected = new rxjs_1.BehaviorSubject(false);
+    onLocationMode = new rxjs_1.ReplaySubject(1);
+    onLocationModeRequested = new rxjs_1.Subject();
+    reconnecting = false;
+    disconnected = false;
+    connectionPromise;
+    securityPanel;
+    assets;
+    receivedAssetDeviceLists = [];
+    offlineAssets = [];
+    hasHubs;
+    hasAlarmBaseStation;
     constructor(locationDetails, cameras, chimes, intercoms, options, restClient) {
         super();
         this.locationDetails = locationDetails;
@@ -23,40 +68,6 @@ class Location extends subscribed_1.Subscribed {
         this.intercoms = intercoms;
         this.options = options;
         this.restClient = restClient;
-        this.seq = 1;
-        this.onMessage = new rxjs_1.Subject();
-        this.onDataUpdate = new rxjs_1.Subject();
-        this.onDeviceDataUpdate = this.onDataUpdate.pipe((0, operators_1.filter)((message) => {
-            return message.datatype === 'DeviceInfoDocType' && Boolean(message.body);
-        }), (0, operators_1.concatMap)((message) => message.body), (0, operators_1.map)(flattenDeviceData));
-        this.onDeviceList = this.onMessage.pipe((0, operators_1.filter)((m) => m.msg === deviceListMessageType));
-        this.onDevices = this.onDeviceList.pipe((0, operators_1.scan)((devices, { body: deviceList, src }) => {
-            if (!deviceList) {
-                return devices;
-            }
-            if (!this.receivedAssetDeviceLists.includes(src)) {
-                this.receivedAssetDeviceLists.push(src);
-            }
-            return deviceList.reduce((updatedDevices, data) => {
-                const flatData = flattenDeviceData(data), existingDevice = updatedDevices.find((x) => x.zid === flatData.zid);
-                if (existingDevice) {
-                    existingDevice.updateData(flatData);
-                    return updatedDevices;
-                }
-                return [...updatedDevices, new ring_device_1.RingDevice(flatData, this, src)];
-            }, devices);
-        }, []), (0, operators_1.distinctUntilChanged)((a, b) => a.length === b.length), (0, operators_1.filter)(() => {
-            return Boolean(this.assets &&
-                this.assets.every((asset) => this.receivedAssetDeviceLists.includes(asset.uuid)));
-        }), (0, operators_1.shareReplay)(1));
-        this.onSessionInfo = this.onDataUpdate.pipe((0, operators_1.filter)((m) => m.msg === 'SessionInfo'), (0, operators_1.map)((m) => m.body));
-        this.onConnected = new rxjs_1.BehaviorSubject(false);
-        this.onLocationMode = new rxjs_1.ReplaySubject(1);
-        this.onLocationModeRequested = new rxjs_1.Subject();
-        this.reconnecting = false;
-        this.disconnected = false;
-        this.receivedAssetDeviceLists = [];
-        this.offlineAssets = [];
         this.hasHubs = this.options.hasHubs;
         this.hasAlarmBaseStation = this.options.hasAlarmBaseStation;
         this.addSubscriptions(

package/lib/rest-client.js

@@ -138,6 +138,12 @@ function parseAuthConfig(rawRefreshToken) {
     }
 }
 class RingRestClient {
+    authOptions;
+    refreshToken;
+    authConfig;
+    hardwareIdPromise;
+    _authPromise;
+    timeouts = [];
     clearPreviousAuth() {
         this._authPromise = undefined;
     }
@@ -161,21 +167,22 @@ class RingRestClient {
         }
         return this._authPromise;
     }
+    sessionPromise = undefined;
+    using2fa = false;
+    promptFor2fa;
+    onRefreshTokenUpdated = new rxjs_1.ReplaySubject(1);
+    onSession = new rxjs_1.ReplaySubject(1);
+    baseSessionMetadata;
     constructor(authOptions) {
         this.authOptions = authOptions;
-        this.refreshToken = 'refreshToken' in this.authOptions
-            ? this.authOptions.refreshToken
-            : undefined;
+        this.refreshToken =
+            'refreshToken' in authOptions ? 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;
-        this.onRefreshTokenUpdated = new rxjs_1.ReplaySubject(1);
-        this.onSession = new rxjs_1.ReplaySubject(1);
+        this.hardwareIdPromise =
+            this.authConfig?.hid || (0, util_1.getHardwareId)(authOptions.systemId);
         this.baseSessionMetadata = {
             api_version: apiVersion,
-            device_model: this.authOptions.controlCenterDisplayName ?? 'ring-client-api',
+            device_model: authOptions.controlCenterDisplayName ?? 'ring-client-api',
         };
     }
     getGrantData(twoFactorAuthCode) {

package/lib/ring-camera.js

@@ -68,28 +68,37 @@ function cleanSnapshotUuid(uuid) {
     return uuid.replace(/:.*$/, '');
 }
 class RingCamera extends subscribed_1.Subscribed {
+    initialData;
+    isDoorbot;
+    restClient;
+    avoidSnapshotBatteryDrain;
+    id;
+    deviceType;
+    model;
+    onData;
+    hasLight;
+    hasSiren;
+    onRequestUpdate = new rxjs_1.Subject();
+    onNewNotification = new rxjs_1.Subject();
+    onActiveNotifications = new rxjs_1.BehaviorSubject([]);
+    onDoorbellPressed = this.onNewNotification.pipe((0, operators_1.filter)((notification) => notification.android_config.category === ring_types_1.PushNotificationAction.Ding), (0, operators_1.share)());
+    onMotionDetected = this.onActiveNotifications.pipe((0, operators_1.map)((notifications) => notifications.some((notification) => notification.android_config.category ===
+        ring_types_1.PushNotificationAction.Motion)), (0, operators_1.distinctUntilChanged)(), (0, operators_1.share)({
+        connector: () => new rxjs_1.ReplaySubject(1),
+        resetOnError: false,
+        resetOnComplete: false,
+        resetOnRefCountZero: false,
+    }));
+    onMotionStarted = this.onMotionDetected.pipe((0, operators_1.filter)((currentlyDetected) => currentlyDetected), (0, operators_1.map)(() => null), // no value needed, event is what matters
+    (0, operators_1.share)());
+    onBatteryLevel;
+    onInHomeDoorbellStatus;
     constructor(initialData, isDoorbot, restClient, avoidSnapshotBatteryDrain) {
         super();
         this.initialData = initialData;
         this.isDoorbot = isDoorbot;
         this.restClient = restClient;
         this.avoidSnapshotBatteryDrain = avoidSnapshotBatteryDrain;
-        this.onRequestUpdate = new rxjs_1.Subject();
-        this.onNewNotification = new rxjs_1.Subject();
-        this.onActiveNotifications = new rxjs_1.BehaviorSubject([]);
-        this.onDoorbellPressed = this.onNewNotification.pipe((0, operators_1.filter)((notification) => notification.android_config.category === ring_types_1.PushNotificationAction.Ding), (0, operators_1.share)());
-        this.onMotionDetected = this.onActiveNotifications.pipe((0, operators_1.map)((notifications) => notifications.some((notification) => notification.android_config.category ===
-            ring_types_1.PushNotificationAction.Motion)), (0, operators_1.distinctUntilChanged)(), (0, operators_1.share)({
-            connector: () => new rxjs_1.ReplaySubject(1),
-            resetOnError: false,
-            resetOnComplete: false,
-            resetOnRefCountZero: false,
-        }));
-        this.onMotionStarted = this.onMotionDetected.pipe((0, operators_1.filter)((currentlyDetected) => currentlyDetected), (0, operators_1.map)(() => null), // no value needed, event is what matters
-        (0, operators_1.share)());
-        this.lastSnapshotTimestamp = 0;
-        this.lastSnapshotTimestampLocal = 0;
-        this.fetchingSnapshot = false;
         this.id = this.initialData.id;
         this.deviceType = this.initialData.kind;
         this.model =
@@ -324,6 +333,9 @@ class RingCamera extends subscribed_1.Subscribed {
             ? 600 * 1000 // battery cams only refresh timestamp every 10 minutes
             : 10 * 1000; // snapshot updates will be forced.  Limit to 10s lifetime
     }
+    lastSnapshotTimestamp = 0;
+    lastSnapshotTimestampLocal = 0;
+    lastSnapshotPromise;
     get currentTimestampAge() {
         return Date.now() - this.lastSnapshotTimestampLocal;
     }
@@ -352,6 +364,7 @@ class RingCamera extends subscribed_1.Subscribed {
             return false;
         }
     }
+    fetchingSnapshot = false;
     async getSnapshot({ uuid } = {}) {
         if (this.lastSnapshotPromise && this.shouldUseExistingSnapshotPromise()) {
             return this.lastSnapshotPromise;

package/lib/ring-chime.js

@@ -11,10 +11,16 @@ const settingsWhichRequireReboot = [
     'motion_audio_user_id',
 ];
 class RingChime {
+    initialData;
+    restClient;
+    id;
+    deviceType;
+    model;
+    onData;
+    onRequestUpdate = new rxjs_1.Subject();
     constructor(initialData, restClient) {
         this.initialData = initialData;
         this.restClient = restClient;
-        this.onRequestUpdate = new rxjs_1.Subject();
         this.id = this.initialData.id;
         this.deviceType = this.initialData.kind;
         this.model = ring_types_1.ChimeModel[this.deviceType] || 'Chime';

package/lib/ring-device.js

@@ -7,6 +7,15 @@ const operators_1 = require("rxjs/operators");
 const subscribed_1 = require("./subscribed");
 const util_1 = require("./util");
 class RingDevice extends subscribed_1.Subscribed {
+    initialData;
+    location;
+    assetId;
+    onData;
+    zid;
+    id;
+    deviceType;
+    categoryId;
+    onComponentDevices;
     constructor(initialData, location, assetId) {
         super();
         this.initialData = initialData;

package/lib/ring-intercom.js

@@ -8,12 +8,18 @@ const operators_1 = require("rxjs/operators");
 const ring_camera_1 = require("./ring-camera");
 const util_1 = require("./util");
 class RingIntercom {
+    initialData;
+    restClient;
+    id;
+    deviceType;
+    onData;
+    onRequestUpdate = new rxjs_1.Subject();
+    onBatteryLevel;
+    onDing = new rxjs_1.Subject();
+    onUnlocked = new rxjs_1.Subject();
     constructor(initialData, restClient) {
         this.initialData = initialData;
         this.restClient = restClient;
-        this.onRequestUpdate = new rxjs_1.Subject();
-        this.onDing = new rxjs_1.Subject();
-        this.onUnlocked = new rxjs_1.Subject();
         this.id = this.initialData.id;
         this.deviceType = this.initialData.kind;
         this.onData = new rxjs_1.BehaviorSubject(this.initialData);

package/lib/streaming/peer-connection.js

@@ -17,16 +17,17 @@ const ringIceServers = [
     'stun:stun4.l.google.com:19302',
 ];
 class WeriftPeerConnection extends subscribed_1.Subscribed {
+    pc;
+    onAudioRtp = new rxjs_1.Subject();
+    onAudioRtcp = new rxjs_1.Subject();
+    onVideoRtp = new rxjs_1.Subject();
+    onVideoRtcp = new rxjs_1.Subject();
+    onIceCandidate = new rxjs_1.Subject();
+    onConnectionState = new rxjs_1.ReplaySubject(1);
+    returnAudioTrack = new werift_1.MediaStreamTrack({ kind: 'audio' });
+    onRequestKeyFrame = new rxjs_1.Subject();
     constructor() {
         super();
-        this.onAudioRtp = new rxjs_1.Subject();
-        this.onAudioRtcp = new rxjs_1.Subject();
-        this.onVideoRtp = new rxjs_1.Subject();
-        this.onVideoRtcp = new rxjs_1.Subject();
-        this.onIceCandidate = new rxjs_1.Subject();
-        this.onConnectionState = new rxjs_1.ReplaySubject(1);
-        this.returnAudioTrack = new werift_1.MediaStreamTrack({ kind: 'audio' });
-        this.onRequestKeyFrame = new rxjs_1.Subject();
         const pc = (this.pc = new werift_1.RTCPeerConnection({
             codecs: {
                 audio: [

package/lib/streaming/simple-webrtc-session.js

@@ -6,10 +6,12 @@ function liveViewUrl(path) {
     return `https://api.ring.com/integrations/v1/liveview/${path}`;
 }
 class SimpleWebRtcSession {
+    camera;
+    restClient;
+    sessionId = (0, util_1.generateUuid)();
     constructor(camera, restClient) {
         this.camera = camera;
         this.restClient = restClient;
-        this.sessionId = (0, util_1.generateUuid)();
     }
     async start(sdp) {
         const response = await this.restClient.request({

package/lib/streaming/streaming-session.js

@@ -17,19 +17,19 @@ function getCleanSdp(sdp, includeVideo) {
         .join('\n');
 }
 class StreamingSession extends subscribed_1.Subscribed {
+    camera;
+    connection;
+    onCallEnded = new rxjs_1.ReplaySubject(1);
+    onUsingOpus = new rxjs_1.ReplaySubject(1);
+    onVideoRtp = new rxjs_1.Subject();
+    onAudioRtp = new rxjs_1.Subject();
+    audioSplitter = new camera_utils_1.RtpSplitter();
+    videoSplitter = new camera_utils_1.RtpSplitter();
+    returnAudioSplitter = new camera_utils_1.RtpSplitter();
     constructor(camera, connection) {
         super();
         this.camera = camera;
         this.connection = connection;
-        this.onCallEnded = new rxjs_1.ReplaySubject(1);
-        this.onUsingOpus = new rxjs_1.ReplaySubject(1);
-        this.onVideoRtp = new rxjs_1.Subject();
-        this.onAudioRtp = new rxjs_1.Subject();
-        this.audioSplitter = new camera_utils_1.RtpSplitter();
-        this.videoSplitter = new camera_utils_1.RtpSplitter();
-        this.returnAudioSplitter = new camera_utils_1.RtpSplitter();
-        this.cameraSpeakerActivated = false;
-        this.hasEnded = false;
         this.bindToConnection(connection);
     }
     bindToConnection(connection) {
@@ -44,6 +44,7 @@ class StreamingSession extends subscribed_1.Subscribed {
     activate() {
         this.requestKeyFrame();
     }
+    cameraSpeakerActivated = false;
     activateCameraSpeaker() {
         if (this.cameraSpeakerActivated || this.hasEnded) {
             return;
@@ -155,6 +156,7 @@ class StreamingSession extends subscribed_1.Subscribed {
         });
         this.onCallEnded.pipe((0, operators_1.take)(1)).subscribe(() => ff.stop());
     }
+    hasEnded = false;
     callEnded() {
         if (this.hasEnded) {
             return;

package/lib/streaming/webrtc-connection.js

@@ -8,19 +8,23 @@ const util_1 = require("../util");
 const peer_connection_1 = require("./peer-connection");
 const subscribed_1 = require("../subscribed");
 class WebrtcConnection extends subscribed_1.Subscribed {
+    camera;
+    onSessionId = new rxjs_1.ReplaySubject(1);
+    onOfferSent = new rxjs_1.ReplaySubject(1);
+    dialogId = (0, util_1.generateUuid)();
+    onCameraConnected = new rxjs_1.ReplaySubject(1);
+    onCallAnswered = new rxjs_1.ReplaySubject(1);
+    onCallEnded = new rxjs_1.ReplaySubject(1);
+    onError = new rxjs_1.ReplaySubject(1);
+    onMessage = new rxjs_1.ReplaySubject();
+    onWsOpen;
+    onAudioRtp;
+    onVideoRtp;
+    pc;
+    ws;
     constructor(ticket, camera, options) {
         super();
         this.camera = camera;
-        this.onSessionId = new rxjs_1.ReplaySubject(1);
-        this.onOfferSent = new rxjs_1.ReplaySubject(1);
-        this.dialogId = (0, util_1.generateUuid)();
-        this.onCameraConnected = new rxjs_1.ReplaySubject(1);
-        this.onCallAnswered = new rxjs_1.ReplaySubject(1);
-        this.onCallEnded = new rxjs_1.ReplaySubject(1);
-        this.onError = new rxjs_1.ReplaySubject(1);
-        this.onMessage = new rxjs_1.ReplaySubject();
-        this.sessionId = null;
-        this.hasEnded = false;
         this.ws = new ws_1.WebSocket(`wss://api.prod.signalling.ring.devices.a2z.com:443/ws?api_version=4.0&auth_type=ring_solutions&client_id=ring_site-${(0, util_1.generateUuid)()}&token=${ticket}`, {
             headers: {
                 // This must exist or the socket will close immediately but content does not seem to matter
@@ -110,6 +114,7 @@ class WebrtcConnection extends subscribed_1.Subscribed {
         });
         this.onOfferSent.next();
     }
+    sessionId = null;
     async handleMessage(message) {
         if (message.body.doorbot_id !== this.camera.id) {
             // ignore messages for other cameras
@@ -220,6 +225,7 @@ class WebrtcConnection extends subscribed_1.Subscribed {
             });
         }));
     }
+    hasEnded = false;
     callEnded() {
         if (this.hasEnded) {
             return;

package/lib/subscribed.js

@@ -2,9 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Subscribed = void 0;
 class Subscribed {
-    constructor() {
-        this.subscriptions = [];
-    }
+    subscriptions = [];
     addSubscriptions(...subscriptions) {
         this.subscriptions.push(...subscriptions);
     }

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "ring-client-api",
-  "version": "13.1.0",
+  "version": "13.2.0-beta.0",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
   "exports": {
     ".": "./lib/index.js",
     "./ffmpeg": "./lib/ffmpeg.js",
     "./util": "./lib/util.js",
-    "./rest-client": "./lib/rest-client.js"
+    "./rest-client": "./lib/rest-client.js",
+    "./streaming/streaming-session": "./lib/streaming/streaming-session.js"
   },
   "scripts": {
     "build": "rm -rf lib && tsc --declaration && chmod +x ./lib/ring-*-cli.js",
@@ -17,35 +18,35 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@eneris/push-receiver": "4.1.6",
+    "@eneris/push-receiver": "4.2.0",
     "@homebridge/camera-utils": "^2.2.6",
-    "@types/socket.io-client": "1.4.36",
     "colors": "1.4.0",
-    "debug": "^4.3.6",
+    "debug": "^4.3.7",
     "json-bigint": "^1.0.0",
     "rxjs": "^7.8.1",
     "socket.io-client": "^2.5.0",
-    "systeminformation": "^5.23.4",
+    "systeminformation": "^5.23.5",
     "uuid": "^10.0.0",
     "werift": "0.19.4",
     "ws": "^8.18.0"
   },
   "devDependencies": {
     "@types/debug": "4.1.12",
-    "@types/jest": "29.5.12",
+    "@types/jest": "29.5.13",
     "@types/json-bigint": "^1.0.4",
-    "@types/node": "22.1.0",
+    "@types/node": "22.7.5",
+    "@types/socket.io-client": "1.4.36",
     "@types/uuid": "10.0.0",
     "@types/ws": "^8.5.12",
     "eslint-config-shared": "*",
     "jest": "29.7.0",
-    "msw": "^2.3.5",
-    "ts-jest": "29.2.4",
+    "msw": "^2.4.10",
+    "ts-jest": "29.2.5",
     "tsconfig": "*",
-    "typescript": "5.5.4"
+    "typescript": "5.6.3"
   },
   "engines": {
-    "node": "^18 || ^20"
+    "node": "^18 || ^20 || ^22"
   },
   "repository": {
     "type": "git",