ring-client-api 10.0.0-beta.2 → 10.0.0-beta.5

package/lib/api/ring-types.d.ts

@@ -87,7 +87,6 @@ export declare enum RingCameraKind {
     cocoa_doorbell = "cocoa_doorbell",
     stickup_cam_mini = "stickup_cam_mini"
 }
-export declare function isBatteryCameraKind(kind: RingCameraKind): boolean;
 export declare const RingCameraModel: {
     readonly [P in RingCameraKind]: string;
 };
@@ -427,6 +426,44 @@ export interface CameraData {
         ends_at?: string;
         seconds_remaining: number;
     };
+    health: {
+        device_type: RingCameraKind;
+        last_update_time: number;
+        connected: boolean;
+        rss_connected: boolean;
+        vod_enabled: boolean;
+        sidewalk_connection: boolean;
+        floodlight_on: boolean;
+        siren_on?: boolean;
+        white_led_on: boolean;
+        night_mode_on: boolean;
+        hatch_open: boolean;
+        packet_loss: number;
+        packet_loss_category: 'good' | string;
+        rssi: number;
+        battery_voltage: number;
+        wifi_is_ring_network: boolean;
+        supported_rpc_commands: string[];
+        ota_status: 'successful' | string;
+        ext_power_state?: 0 | number;
+        pref_run_mode?: 'low_power' | string;
+        run_mode?: 'low_power' | 'full_power' | string;
+        network_connection_value: 'wifi' | string;
+        ac_power: number;
+        battery_present?: boolean;
+        external_connection: boolean;
+        battery_percentage?: number;
+        battery_percentage_category: 'very_good' | 'unknown' | string;
+        firmware_version: string;
+        rssi_category: 'good' | string;
+        battery_voltage_category: 'very_good' | string;
+        second_battery_voltage_category: 'unknown' | string;
+        second_battery_percentage_category: 'unknown' | string;
+        battery_save: boolean;
+        firmware_version_status: 'Up to Date';
+        tx_rate: number;
+        ptz_connected?: 'penguin';
+    };
 }
 export interface CvDetectionType {
     enabled: boolean;
@@ -670,31 +707,59 @@ export interface RingDeviceHistoryEvent {
     body: any;
 }
 export declare type DingState = 'ringing' | 'connected' | 'timed_out' | 'completed';
-export interface ActiveDing {
-    id: number;
-    id_str: string;
-    state: DingState;
-    protocol: 'sip';
-    doorbot_id: number;
-    doorbot_description: string;
+export declare enum NotificationDetectionType {
+    Human = "human",
+    Loitering = "loitering",
+    Motion = "motion",
+    OtherMotion = "other_motion",
+    NotAvailable = "null",
+    StreamBroken = "stream_broken"
+}
+export declare enum PushNotificationAction {
+    Ding = "com.ring.push.HANDLE_NEW_DING",
+    Motion = "com.ring.push.HANDLE_NEW_motion"
+}
+export interface PushNotification {
+    ding: {
+        streaming_protocol: 'ring_media_server';
+        location_id: string;
+        device_name: string;
+        doorbot_id: number;
+        e2ee_enabled: boolean;
+        streaming_data_hash: string;
+        device_kind: RingCameraKind;
+        detection_type: NotificationDetectionType;
+        human_detected?: boolean;
+        id: number;
+        pod_id: number;
+        request_id: string;
+        image_uuid: string;
+        properties: {
+            active_streaming_profile: 'rms';
+            is_sidewalk: boolean;
+        };
+    };
+    aps: {
+        alert: string;
+        sound: string;
+    };
+    subtype: 'motion' | 'ding' | 'human' | string;
+    action: PushNotificationAction | string;
+}
+export interface LiveCallResponse {
+    ding_id: string;
+    ding_kind: DingKind;
+    device_id: number;
     device_kind: RingCameraKind;
-    motion: boolean;
-    snapshot_url: '';
-    kind: DingKind;
-    sip_server_ip: string;
-    sip_server_port: number;
-    sip_server_tls: boolean;
-    sip_session_id: string;
-    sip_from: string;
-    sip_to: string;
-    audio_jitter_buffer_ms: number;
-    video_jitter_buffer_ms: number;
-    sip_endpoints: null;
-    expires_in: number;
+    device_description: string;
+    state: DingState;
+    protocol: 'ring_media_server' | unknown;
     now: number;
-    optimization_level: number;
-    sip_token: string;
-    sip_ding_id: string;
+    video_jitter_buffer_ms: number;
+    audio_jitter_buffer_ms: number;
+    data: {
+        session_id: string;
+    };
 }
 export interface AuthTokenResponse {
     access_token: string;

package/lib/api/ring-types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isWebSocketSupportedAsset = exports.disabledLocationModes = exports.DispatchSignalType = exports.DoorbellType = exports.ChimeModel = exports.deviceTypesWithVolume = exports.allAlarmStates = exports.RingCameraModel = exports.isBatteryCameraKind = exports.RingCameraKind = exports.RingDeviceCategory = exports.RingDeviceType = void 0;
+exports.isWebSocketSupportedAsset = exports.disabledLocationModes = exports.DispatchSignalType = exports.PushNotificationAction = exports.NotificationDetectionType = exports.DoorbellType = exports.ChimeModel = exports.deviceTypesWithVolume = exports.allAlarmStates = exports.RingCameraModel = exports.RingCameraKind = exports.RingDeviceCategory = exports.RingDeviceType = void 0;
 // eslint-disable-next-line no-shadow
 var RingDeviceType;
 (function (RingDeviceType) {
@@ -95,12 +95,6 @@ var RingCameraKind;
     RingCameraKind["cocoa_doorbell"] = "cocoa_doorbell";
     RingCameraKind["stickup_cam_mini"] = "stickup_cam_mini";
 })(RingCameraKind = exports.RingCameraKind || (exports.RingCameraKind = {}));
-// RegExp taken from ring.com app
-const isWiredCameraRegExp = new RegExp(/(^(lpd|jbox|stickup_cam_elite|stickup_cam_mini|hp_cam|spotlightw|floodlight|doorbell_graham_cracker))/);
-function isBatteryCameraKind(kind) {
-    return !kind.match(isWiredCameraRegExp);
-}
-exports.isBatteryCameraKind = isBatteryCameraKind;
 exports.RingCameraModel = {
     doorbot: 'Doorbell',
     doorbell: 'Doorbell',
@@ -158,6 +152,23 @@ var DoorbellType;
     DoorbellType[DoorbellType["None"] = 2] = "None";
 })(DoorbellType = exports.DoorbellType || (exports.DoorbellType = {}));
 // eslint-disable-next-line no-shadow
+var NotificationDetectionType;
+(function (NotificationDetectionType) {
+    // Note, this list may not be complete
+    NotificationDetectionType["Human"] = "human";
+    NotificationDetectionType["Loitering"] = "loitering";
+    NotificationDetectionType["Motion"] = "motion";
+    NotificationDetectionType["OtherMotion"] = "other_motion";
+    NotificationDetectionType["NotAvailable"] = "null";
+    NotificationDetectionType["StreamBroken"] = "stream_broken";
+})(NotificationDetectionType = exports.NotificationDetectionType || (exports.NotificationDetectionType = {}));
+// eslint-disable-next-line no-shadow
+var PushNotificationAction;
+(function (PushNotificationAction) {
+    PushNotificationAction["Ding"] = "com.ring.push.HANDLE_NEW_DING";
+    PushNotificationAction["Motion"] = "com.ring.push.HANDLE_NEW_motion";
+})(PushNotificationAction = exports.PushNotificationAction || (exports.PushNotificationAction = {}));
+// eslint-disable-next-line no-shadow
 var DispatchSignalType;
 (function (DispatchSignalType) {
     DispatchSignalType["Burglar"] = "user-verified-burglar-xa";

package/lib/api/util.js

@@ -18,7 +18,8 @@ const colors_1 = require("colors");
 const readline_1 = require("readline");
 const uuid_1 = require("uuid");
 const systeminformation_1 = require("systeminformation");
-const debugLogger = (0, debug_1.default)('ring'), uuidNamespace = 'e53ffdc0-e91d-4ce1-bec2-df939d94739c';
+const logger_1 = __importDefault(require("@eneris/push-receiver/dist/utils/logger"));
+const debugLogger = (0, debug_1.default)('ring'), uuidNamespace = 'e53ffdc0-e91d-4ce1-bec2-df939d94739d';
 let logger = {
     logInfo(message) {
         debugLogger(message);
@@ -120,3 +121,9 @@ function randomString(length) {
     return uuid.replace(/-/g, '').substring(0, length).toLowerCase();
 }
 exports.randomString = randomString;
+// Override push receiver logging to avoid ECONNRESET errors leaking
+function logPushReceiver(...args) {
+    logDebug('[Push Receiver]');
+    logDebug(args[0]);
+}
+logger_1.default.error = logPushReceiver;

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

@@ -4,7 +4,9 @@ const api_1 = require("../../api");
 describe('Ring Camera', () => {
     describe('battery level', () => {
         it('should handle string battery life', () => {
-            expect((0, api_1.getBatteryLevel)({ battery_life: '49' })).toEqual(49);
+            expect((0, api_1.getBatteryLevel)({
+                battery_life: '49',
+            })).toEqual(49);
         });
         it('should handle null battery life', () => {
             expect((0, api_1.getBatteryLevel)({ battery_life: null })).toEqual(null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "10.0.0-beta.2",
+  "version": "10.0.0-beta.5",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/api/index.js",
   "bin": {
@@ -55,44 +55,45 @@
   "author": "dgreif",
   "license": "MIT",
   "dependencies": {
+    "@eneris/push-receiver": "^3.0.1",
     "@homebridge/camera-utils": "2.1.0",
     "@homebridge/plugin-ui-utils": "0.0.19",
-    "@koush/werift": "0.14.5-beta7",
+    "@koush/werift": "0.14.5-beta9",
     "@types/socket.io-client": "1.4.36",
     "colors": "1.4.0",
-    "debug": "4.3.3",
+    "debug": "4.3.4",
     "got": "11.8.3",
-    "rxjs": "7.5.2",
+    "rxjs": "7.5.5",
     "socket.io-client": "2.4.0",
-    "systeminformation": "5.10.7",
+    "systeminformation": "5.11.9",
     "uuid": "8.3.2",
-    "ws": "8.4.2"
+    "ws": "8.5.0"
   },
   "devDependencies": {
     "@types/debug": "4.1.7",
-    "@types/jest": "27.4.0",
-    "@types/node": "17.0.10",
+    "@types/jest": "27.4.1",
+    "@types/node": "17.0.23",
     "@types/uuid": "8.3.4",
-    "@types/ws": "^8.2.2",
-    "@typescript-eslint/eslint-plugin": "5.10.0",
-    "@typescript-eslint/parser": "5.10.0",
-    "concurrently": "^7.0.0",
+    "@types/ws": "^8.5.3",
+    "@typescript-eslint/eslint-plugin": "5.18.0",
+    "@typescript-eslint/parser": "5.18.0",
+    "concurrently": "^7.1.0",
     "conventional-github-releaser": "3.1.5",
-    "dotenv": "14.2.0",
-    "esbuild": "^0.14.19",
-    "eslint": "8.7.0",
-    "eslint-config-prettier": "8.3.0",
-    "eslint-plugin-jest": "25.7.0",
+    "dotenv": "16.0.0",
+    "esbuild": "^0.14.34",
+    "eslint": "8.13.0",
+    "eslint-config-prettier": "8.5.0",
+    "eslint-plugin-jest": "26.1.4",
     "eslint-plugin-prettier": "4.0.0",
-    "express": "4.17.2",
+    "express": "4.17.3",
     "homebridge": "1.4.0",
-    "jest": "27.4.7",
-    "prettier": "2.5.1",
+    "jest": "27.5.1",
+    "prettier": "2.6.2",
     "reflect-metadata": "0.1.13",
     "rimraf": "3.0.2",
     "standard-version": "9.3.2",
-    "ts-jest": "27.1.3",
-    "typescript": "4.5.5"
+    "ts-jest": "27.1.4",
+    "typescript": "4.6.3"
   },
   "engines": {
     "node": "^12.20 || ^14 || ^16",