ring-client-api 11.7.0 → 11.7.2

package/lib/api.js

@@ -88,7 +88,7 @@ class RingApi extends subscribed_1.Subscribed {
             byId[intercom.id] = intercom;
             return byId;
         }, {});
-        if (!cameras.length && !chimes.length) {
+        if (!cameras.length && !chimes.length && !intercoms.length) {
             return;
         }
         this.addSubscriptions((0, rxjs_1.merge)(onDeviceRequestUpdate, onPollForStatusUpdate)

package/lib/device-data.js

@@ -61,6 +61,7 @@ async function logDeviceData() {
             name: location.name,
             cameras: location.cameras.map((camera) => camera.data),
             chimes: location.chimes.map((chime) => chime.data),
+            intercoms: location.intercoms.map((intercom) => intercom.data),
             devices: devices.map((device) => device.data),
         };
     }), results = {

package/lib/rest-client.js

@@ -65,22 +65,6 @@ async function requestWithRetry(requestOptions) {
     }
 }
 class RingRestClient {
-    constructor(authOptions) {
-        this.authOptions = authOptions;
-        this.timeouts = [];
-        this.sessionPromise = undefined;
-        this.using2fa = false;
-        this.onRefreshTokenUpdated = new rxjs_1.ReplaySubject(1);
-        this.baseSessionMetadata = {
-            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);
-    }
     clearPreviousAuth() {
         this._authPromise = undefined;
     }
@@ -104,6 +88,22 @@ class RingRestClient {
         }
         return this._authPromise;
     }
+    constructor(authOptions) {
+        this.authOptions = authOptions;
+        this.timeouts = [];
+        this.sessionPromise = undefined;
+        this.using2fa = false;
+        this.onRefreshTokenUpdated = new rxjs_1.ReplaySubject(1);
+        this.baseSessionMetadata = {
+            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) {
             return {

package/lib/ring-camera.d.ts

@@ -7,7 +7,7 @@ import { Subscribed } from './subscribed';
 import { FfmpegOptions, StreamingSession } from './streaming/streaming-session';
 import { StreamingConnectionOptions } from './streaming/streaming-connection-base';
 import { SimpleWebRtcSession } from './streaming/simple-webrtc-session';
-export declare type AnyCameraData = CameraData | OnvifCameraData;
+export type AnyCameraData = CameraData | OnvifCameraData;
 export declare function getBatteryLevel(data: Pick<CameraData, 'battery_life' | 'battery_life_2'> & {
     health?: Partial<CameraData['health']>;
 }): number | null;

package/lib/ring-types.d.ts

@@ -1,4 +1,4 @@
-declare type Firmware = string | 'Up To Date';
+type Firmware = string | 'Up To Date';
 export declare enum RingDeviceType {
     BaseStation = "hub.redsky",
     BaseStationPro = "hub.kili",
@@ -98,17 +98,17 @@ export declare enum RingCameraKind {
 export declare const RingCameraModel: {
     readonly [P in RingCameraKind]: string;
 };
-export declare type AlarmMode = 'all' | 'some' | 'none';
-export declare type ThermostatMode = 'heat' | 'cool' | 'off' | 'aux';
-export declare type MessageType = 'RoomGetList' | 'SessionInfo' | 'DeviceInfoDocGetList' | 'DeviceInfoSet';
-export declare type MessageDataType = 'RoomListV2Type' | 'SessionInfoType' | 'DeviceInfoDocType' | 'DeviceInfoSetType' | 'HubDisconnectionEventType';
+export type AlarmMode = 'all' | 'some' | 'none';
+export type ThermostatMode = 'heat' | 'cool' | 'off' | 'aux';
+export type MessageType = 'RoomGetList' | 'SessionInfo' | 'DeviceInfoDocGetList' | 'DeviceInfoSet';
+export type MessageDataType = 'RoomListV2Type' | 'SessionInfoType' | 'DeviceInfoDocType' | 'DeviceInfoSetType' | 'HubDisconnectionEventType';
 export interface SocketIoMessage {
     msg: MessageType;
     datatype: MessageDataType;
     src: string;
     body: any[];
 }
-export declare type AssetKind = 'base_station_v1' | 'beams_bridge_v1' | 'floodlight_v2' | string;
+export type AssetKind = 'base_station_v1' | 'beams_bridge_v1' | 'floodlight_v2' | string;
 export interface AssetSession {
     assetUuid: string;
     connectionStatus: 'unknown' | 'cell-backup' | 'online';
@@ -116,7 +116,7 @@ export interface AssetSession {
     kind: AssetKind;
     sessionId: number;
 }
-export declare type AlarmState = 'burglar-alarm' | 'entry-delay' | 'fire-alarm' | 'co-alarm' | 'panic' | 'user-verified-burglar-alarm' | 'user-verified-co-or-fire-alarm' | 'burglar-accelerated-alarm' | 'fire-accelerated-alarm';
+export type AlarmState = 'burglar-alarm' | 'entry-delay' | 'fire-alarm' | 'co-alarm' | 'panic' | 'user-verified-burglar-alarm' | 'user-verified-co-or-fire-alarm' | 'burglar-accelerated-alarm' | 'fire-accelerated-alarm';
 export declare const allAlarmStates: AlarmState[];
 export interface RingDeviceData {
     zid: string;
@@ -226,7 +226,7 @@ export interface BeamBridge {
     role: string;
     updated_at: string;
 }
-export declare type ChimeKind = 'chime' | 'chime_pro' | 'chime_v2' | 'chime_pro_v2';
+export type ChimeKind = 'chime' | 'chime_pro' | 'chime_v2' | 'chime_pro_v2';
 export declare const ChimeModel: {
     readonly [P in ChimeKind]: string;
 };
@@ -268,7 +268,7 @@ export interface ChimeData {
         email: string;
     };
 }
-export declare type ChimeSoundKind = 'motion' | 'ding';
+export type ChimeSoundKind = 'motion' | 'ding';
 export interface ChimeUpdate {
     description?: string;
     latitude?: number;
@@ -749,7 +749,7 @@ export interface CameraDeviceSettingsData {
         mode?: string;
     };
 }
-declare type HealthCategory = 'very_poor' | 'poor' | 'good' | 'very_good' | 'unknown' | 'NA' | string | null;
+type HealthCategory = 'very_poor' | 'poor' | 'good' | 'very_good' | 'unknown' | 'NA' | string | null;
 export interface ChimeHealth {
     id: number;
     wifi_name: string;
@@ -772,7 +772,7 @@ export interface CameraHealth extends ChimeHealth {
     transformer_voltage_category?: 'good';
     ext_power_state?: number;
 }
-export declare type DingKind = 'motion' | 'ding' | 'on_demand' | 'alarm' | 'on_demand_link' | 'door_activity' | 'key_access' | 'DELETED_FOOTAGE' | 'OFFLINE_FOOTAGE' | 'OFFLINE_MOTION';
+export type DingKind = 'motion' | 'ding' | 'on_demand' | 'alarm' | 'on_demand_link' | 'door_activity' | 'key_access' | 'DELETED_FOOTAGE' | 'OFFLINE_FOOTAGE' | 'OFFLINE_MOTION';
 export interface CameraEvent {
     created_at: string;
     cv_properties: {
@@ -853,7 +853,7 @@ export interface RingDeviceHistoryEvent {
     datatype: MessageDataType;
     body: any;
 }
-export declare type DingState = 'ringing' | 'connected' | 'timed_out' | 'completed';
+export type DingState = 'ringing' | 'connected' | 'timed_out' | 'completed';
 export declare enum NotificationDetectionType {
     Human = "human",
     Loitering = "loitering",
@@ -918,7 +918,7 @@ export interface PushNotificationLowBattery {
     };
     action: PushNotificationAction.LowBattery;
 }
-export declare type PushNotification = PushNotificationDing | PushNotificationAlarm | PushNotificationLowBattery;
+export type PushNotification = PushNotificationDing | PushNotificationAlarm | PushNotificationLowBattery;
 export interface LiveCallResponse {
     ding_id: string;
     ding_kind: DingKind;
@@ -941,8 +941,8 @@ export interface AuthTokenResponse {
     scope: 'client';
     token_type: 'Bearer';
 }
-export declare type TwoStageVerificationState = 'sms' | 'email' | 'totp';
-export declare type Auth2faResponse = {
+export type TwoStageVerificationState = 'sms' | 'email' | 'totp';
+export type Auth2faResponse = {
     error?: string | unknown;
     error_description?: string;
 } | {
@@ -1001,8 +1001,8 @@ export declare enum DispatchSignalType {
     Burglar = "user-verified-burglar-xa",
     Fire = "user-verified-fire-xa"
 }
-export declare type LocationModeInput = 'home' | 'away' | 'disarmed';
-export declare type LocationMode = LocationModeInput | 'disabled' | 'unset';
+export type LocationModeInput = 'home' | 'away' | 'disarmed';
+export type LocationMode = LocationModeInput | 'disabled' | 'unset';
 export declare const disabledLocationModes: LocationMode[];
 export interface LocationModeResponse {
     mode: LocationMode;
@@ -1018,7 +1018,7 @@ export interface LocationModeResponse {
         deviceIdType: 'doorbot' | string;
     }[];
 }
-export declare type LocationModeAction = 'disableMotionDetection' | 'enableMotionDetection' | 'blockLiveViewLocally' | 'allowLiveViewLocally';
+export type LocationModeAction = 'disableMotionDetection' | 'enableMotionDetection' | 'blockLiveViewLocally' | 'allowLiveViewLocally';
 export interface LocationModeSetting {
     deviceId: string;
     deviceIdType: 'doorbot' | string;

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

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

package/lib/streaming/peer-connection.js

@@ -55,6 +55,10 @@ class WeriftPeerConnection extends subscribed_1.Subscribed {
                         ],
                         parameters: 'packetization-mode=1;profile-level-id=640029;level-asymmetry-allowed=1',
                     }),
+                    new werift_1.RTCRtpCodecParameters({
+                        mimeType: 'video/rtx',
+                        clockRate: 90000,
+                    }),
                 ],
             },
             iceServers: ringIceServers.map((server) => ({ urls: server })),

package/lib/streaming/ring-edge-connection.d.ts

@@ -51,7 +51,7 @@ interface CloseMessage {
         };
     } & SessionBody;
 }
-declare type IncomingMessage = AnswerMessage | IceCandidateMessage | SessionCreatedMessage | SessionStartedMessage | PongMessage | CloseMessage | NotificationMessage;
+type IncomingMessage = AnswerMessage | IceCandidateMessage | SessionCreatedMessage | SessionStartedMessage | PongMessage | CloseMessage | NotificationMessage;
 export declare class RingEdgeConnection extends StreamingConnectionBase {
     private camera;
     private readonly onSessionId;

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

@@ -11,6 +11,7 @@ export declare abstract class StreamingConnectionBase extends Subscribed {
     protected options: StreamingConnectionOptions;
     readonly onCallAnswered: ReplaySubject<string>;
     readonly onCallEnded: ReplaySubject<void>;
+    readonly onError: ReplaySubject<void>;
     readonly onMessage: ReplaySubject<{
         method: string;
     }>;

package/lib/streaming/streaming-connection-base.js

@@ -13,6 +13,7 @@ class StreamingConnectionBase extends subscribed_1.Subscribed {
         this.options = options;
         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.hasEnded = false;
         if (options.createPeerConnection) {
@@ -35,7 +36,14 @@ class StreamingConnectionBase extends subscribed_1.Subscribed {
             .pipe((0, operators_1.concatMap)((event) => {
             const message = JSON.parse(event.data);
             this.onMessage.next(message);
-            return this.handleMessage(message);
+            return this.handleMessage(message).catch((e) => {
+                if (e instanceof Error &&
+                    e.message.includes('negotiate codecs failed')) {
+                    e = new Error('Failed to negotiate codecs.  This is a known issue with Ring cameras.  Please see https://github.com/dgreif/ring/wiki/Streaming-Legacy-Mode');
+                }
+                this.onError.next(e);
+                throw e;
+            });
         }))
             .subscribe(), onError.subscribe((e) => {
             (0, util_1.logError)(e);
@@ -51,6 +59,9 @@ class StreamingConnectionBase extends subscribed_1.Subscribed {
                 (0, util_1.logDebug)('Stream connection closed');
                 this.callEnded();
             }
+        }), this.onError.subscribe((e) => {
+            (0, util_1.logError)(e);
+            this.callEnded();
         }));
     }
     activate() {

package/lib/streaming/streaming-session.d.ts

@@ -4,7 +4,7 @@ import { RingEdgeConnection } from './ring-edge-connection';
 import { WebrtcConnection } from './webrtc-connection';
 import { RingCamera } from '../ring-camera';
 import { Subscribed } from '../subscribed';
-declare type SpawnInput = string | number;
+type SpawnInput = string | number;
 export interface FfmpegOptions {
     input?: SpawnInput[];
     video?: SpawnInput[] | false;

package/lib/streaming/streaming-session.js

@@ -56,7 +56,9 @@ class StreamingSession extends subscribed_1.Subscribed {
         return ports[0];
     }
     get isUsingOpus() {
-        return (0, rxjs_1.firstValueFrom)(this.onUsingOpus);
+        return (0, rxjs_1.firstValueFrom)(this.onUsingOpus.pipe((0, operators_1.mergeWith)(this.connection.onError.pipe((0, operators_1.map)((e) => {
+            throw e;
+        })))));
     }
     async startTranscoding(ffmpegOptions) {
         if (this.hasEnded) {

package/lib/test/ring-camera.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/test/ring-camera.spec.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("../index");
+describe('Ring Camera', () => {
+    describe('battery level', () => {
+        it('should handle string battery life', () => {
+            expect((0, index_1.getBatteryLevel)({
+                battery_life: '49',
+            })).toEqual(49);
+        });
+        it('should handle null battery life', () => {
+            expect((0, index_1.getBatteryLevel)({ battery_life: null })).toEqual(null);
+        });
+        it('should handle right battery only', () => {
+            expect((0, index_1.getBatteryLevel)({ battery_life: null, battery_life_2: 24 })).toEqual(24);
+        });
+        it('should handle left battery only', () => {
+            expect((0, index_1.getBatteryLevel)({ battery_life: 76, battery_life_2: null })).toEqual(76);
+        });
+        it('should handle dual batteries', () => {
+            expect((0, index_1.getBatteryLevel)({ battery_life: '92', battery_life_2: 84 })).toEqual(84);
+            expect((0, index_1.getBatteryLevel)({ battery_life: '92', battery_life_2: 100 })).toEqual(92);
+        });
+    });
+});

package/lib/util.d.ts

@@ -15,7 +15,7 @@ export declare function stringify(data: any): string;
 export declare function mapAsync<T, U>(records: T[], asyncMapper: (record: T) => Promise<U>): Promise<U[]>;
 export declare function randomInteger(): number;
 export declare function randomString(length: number): string;
-export declare type DeepPartial<T> = {
+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 {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "11.7.0",
+  "version": "11.7.2",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
   "exports": {
@@ -17,30 +17,30 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@eneris/push-receiver": "^3.1.2",
+    "@eneris/push-receiver": "^3.1.4",
     "@homebridge/camera-utils": "^2.2.0",
-    "werift": "0.17.0",
+    "werift": "0.18.1",
     "@types/socket.io-client": "1.4.36",
     "colors": "1.4.0",
     "debug": "^4.3.4",
     "got": "^11.8.5",
-    "rxjs": "^7.5.7",
+    "rxjs": "^7.8.0",
     "socket.io-client": "^2.5.0",
-    "systeminformation": "^5.12.14",
+    "systeminformation": "^5.17.10",
     "uuid": "^9.0.0",
-    "ws": "^8.11.0"
+    "ws": "^8.12.1"
   },
   "devDependencies": {
     "@types/debug": "4.1.7",
-    "@types/jest": "29.2.2",
-    "@types/node": "18.11.9",
-    "@types/uuid": "8.3.4",
-    "@types/ws": "^8.5.3",
+    "@types/jest": "29.4.0",
+    "@types/node": "18.14.1",
+    "@types/uuid": "9.0.1",
+    "@types/ws": "^8.5.4",
     "eslint-config-shared": "0.0.0",
-    "jest": "29.3.1",
-    "ts-jest": "29.0.3",
+    "jest": "29.4.3",
+    "ts-jest": "29.0.5",
     "tsconfig": "0.0.0",
-    "typescript": "4.8.4"
+    "typescript": "4.9.5"
   },
   "engines": {
     "node": "^16 || ^18"