ring-client-api 13.2.1 → 14.0.0-beta.0

package/lib/streaming/webrtc-connection.js

@@ -1,22 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebrtcConnection = void 0;
-const ws_1 = require("ws");
-const rxjs_1 = require("rxjs");
-const operators_1 = require("rxjs/operators");
-const util_1 = require("../util");
-const peer_connection_1 = require("./peer-connection");
-const subscribed_1 = require("../subscribed");
-class WebrtcConnection extends subscribed_1.Subscribed {
+import { WebSocket } from 'ws';
+import { firstValueFrom, fromEvent, interval, ReplaySubject, Subject, } from 'rxjs';
+import { concatMap, take } from 'rxjs/operators';
+import { generateUuid, logDebug, logError, logInfo } from "../util.js";
+import { WeriftPeerConnection, } from "./peer-connection.js";
+import { Subscribed } from "../subscribed.js";
+export class WebrtcConnection extends 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();
+    onSessionId = new ReplaySubject(1);
+    onOfferSent = new ReplaySubject(1);
+    dialogId = generateUuid();
+    onCameraConnected = new ReplaySubject(1);
+    onCallAnswered = new ReplaySubject(1);
+    onCallEnded = new ReplaySubject(1);
+    onError = new ReplaySubject(1);
+    onMessage = new ReplaySubject();
     onWsOpen;
     onAudioRtp;
     onVideoRtp;
@@ -25,7 +22,7 @@ class WebrtcConnection extends subscribed_1.Subscribed {
     constructor(ticket, camera, options) {
         super();
         this.camera = camera;
-        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}`, {
+        this.ws = new WebSocket(`wss://api.prod.signalling.ring.devices.a2z.com:443/ws?api_version=4.0&auth_type=ring_solutions&client_id=ring_site-${generateUuid()}&token=${ticket}`, {
             headers: {
                 // This must exist or the socket will close immediately but content does not seem to matter
                 'User-Agent': 'android:com.ringapp',
@@ -35,20 +32,20 @@ class WebrtcConnection extends subscribed_1.Subscribed {
             // we were passed a custom peer connection factory
             this.pc = options.createPeerConnection();
             // passing rtp packets is not supported for custom peer connections
-            this.onAudioRtp = new rxjs_1.Subject();
-            this.onVideoRtp = new rxjs_1.Subject();
+            this.onAudioRtp = new Subject();
+            this.onVideoRtp = new Subject();
         }
         else {
             // no custom peer connection factory, use the werift and pass along rtp packets
-            const pc = new peer_connection_1.WeriftPeerConnection();
+            const pc = new WeriftPeerConnection();
             this.pc = pc;
             this.onAudioRtp = pc.onAudioRtp;
             this.onVideoRtp = pc.onVideoRtp;
         }
-        this.onWsOpen = (0, rxjs_1.fromEvent)(this.ws, 'open');
-        const onMessage = (0, rxjs_1.fromEvent)(this.ws, 'message'), onError = (0, rxjs_1.fromEvent)(this.ws, 'error'), onClose = (0, rxjs_1.fromEvent)(this.ws, 'close');
+        this.onWsOpen = fromEvent(this.ws, 'open');
+        const onMessage = fromEvent(this.ws, 'message'), onError = fromEvent(this.ws, 'error'), onClose = fromEvent(this.ws, 'close');
         this.addSubscriptions(onMessage
-            .pipe((0, operators_1.concatMap)((event) => {
+            .pipe(concatMap((event) => {
             const message = JSON.parse(event.data);
             this.onMessage.next(message);
             return this.handleMessage(message).catch((e) => {
@@ -61,35 +58,35 @@ class WebrtcConnection extends subscribed_1.Subscribed {
             });
         }))
             .subscribe(), onError.subscribe((e) => {
-            (0, util_1.logError)(e);
+            logError(e);
             this.callEnded();
         }), onClose.subscribe(() => {
             this.callEnded();
         }), this.pc.onConnectionState.subscribe((state) => {
             if (state === 'failed') {
-                (0, util_1.logError)('Stream connection failed');
+                logError('Stream connection failed');
                 this.callEnded();
             }
             if (state === 'closed') {
-                (0, util_1.logDebug)('Stream connection closed');
+                logDebug('Stream connection closed');
                 this.callEnded();
             }
         }), this.onError.subscribe((e) => {
-            (0, util_1.logError)(e);
+            logError(e);
             this.callEnded();
         }), this.onWsOpen.subscribe(() => {
             const connectionType = camera.isRingEdgeEnabled ? 'Ring Edge' : 'Cloud';
-            (0, util_1.logDebug)(`WebSocket connected for ${camera.name} (${connectionType})`);
+            logDebug(`WebSocket connected for ${camera.name} (${connectionType})`);
             this.initiateCall().catch((e) => {
-                (0, util_1.logError)(e);
+                logError(e);
                 this.callEnded();
             });
         }), 
         // The ring-edge session needs a ping every 5 seconds to keep the connection alive
-        (0, rxjs_1.interval)(5000).subscribe(() => {
+        interval(5000).subscribe(() => {
             this.sendSessionMessage('ping');
         }), this.pc.onIceCandidate.subscribe(async (iceCandidate) => {
-            await (0, rxjs_1.firstValueFrom)(this.onOfferSent);
+            await firstValueFrom(this.onOfferSent);
             this.sendMessage({
                 method: 'ice',
                 dialog_id: this.dialogId,
@@ -161,8 +158,8 @@ class WebrtcConnection extends subscribed_1.Subscribed {
                 break;
             }
             case 'close':
-                (0, util_1.logError)('Video stream closed');
-                (0, util_1.logError)(message.body);
+                logError('Video stream closed');
+                logError(message.body);
                 this.callEnded();
                 return;
             case 'camera_started':
@@ -170,8 +167,8 @@ class WebrtcConnection extends subscribed_1.Subscribed {
                 // ignore these messages as we don't use them
                 return;
         }
-        (0, util_1.logError)('UNKNOWN MESSAGE');
-        (0, util_1.logError)(message);
+        logError('UNKNOWN MESSAGE');
+        logError(message);
     }
     sendSessionMessage(method, body = {}) {
         const sendSessionMessage = (sessionId) => {
@@ -193,7 +190,7 @@ class WebrtcConnection extends subscribed_1.Subscribed {
         }
         else {
             // Otherwise wait for the session id to be set and then send the message
-            this.addSubscriptions(this.onSessionId.pipe((0, operators_1.take)(1)).subscribe(sendSessionMessage));
+            this.addSubscriptions(this.onSessionId.pipe(take(1)).subscribe(sendSessionMessage));
         }
     }
     sendMessage(message) {
@@ -206,7 +203,7 @@ class WebrtcConnection extends subscribed_1.Subscribed {
         if (this.hasEnded) {
             return;
         }
-        if (this.pc instanceof peer_connection_1.WeriftPeerConnection) {
+        if (this.pc instanceof WeriftPeerConnection) {
             this.pc.returnAudioTrack.writeRtp(rtp);
         }
         else {
@@ -214,7 +211,7 @@ class WebrtcConnection extends subscribed_1.Subscribed {
         }
     }
     activate() {
-        (0, util_1.logInfo)('Activating Session');
+        logInfo('Activating Session');
         // the activate_session message is required to keep the stream alive longer than 70 seconds
         this.sendSessionMessage('activate_session');
         this.sendSessionMessage('stream_options', {
@@ -224,7 +221,7 @@ class WebrtcConnection extends subscribed_1.Subscribed {
     }
     activateCameraSpeaker() {
         // Fire and forget this call so that callers don't get hung up waiting for answer (which might not happen)
-        this.addSubscriptions(this.onCameraConnected.pipe((0, operators_1.take)(1)).subscribe(() => {
+        this.addSubscriptions(this.onCameraConnected.pipe(take(1)).subscribe(() => {
             this.sendSessionMessage('camera_options', {
                 stealth_mode: false,
             });
@@ -257,4 +254,3 @@ class WebrtcConnection extends subscribed_1.Subscribed {
         this.pc.requestKeyFrame?.();
     }
 }
-exports.WebrtcConnection = WebrtcConnection;

package/lib/subscribed.d.ts

@@ -1,4 +1,4 @@
-import { Subscription } from 'rxjs';
+import type { Subscription } from 'rxjs';
 export declare class Subscribed {
     private readonly subscriptions;
     addSubscriptions(...subscriptions: Subscription[]): void;

package/lib/subscribed.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Subscribed = void 0;
-class Subscribed {
+export class Subscribed {
     subscriptions = [];
     addSubscriptions(...subscriptions) {
         this.subscriptions.push(...subscriptions);
@@ -10,4 +7,3 @@ class Subscribed {
         this.subscriptions.forEach((subscription) => subscription.unsubscribe());
     }
 }
-exports.Subscribed = Subscribed;

package/lib/util.js

@@ -1,47 +1,25 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.clearTimeouts = clearTimeouts;
-exports.delay = delay;
-exports.logDebug = logDebug;
-exports.logInfo = logInfo;
-exports.logError = logError;
-exports.useLogger = useLogger;
-exports.enableDebug = enableDebug;
-exports.generateUuid = generateUuid;
-exports.getHardwareId = getHardwareId;
-exports.requestInput = requestInput;
-exports.stringify = stringify;
-exports.mapAsync = mapAsync;
-exports.randomInteger = randomInteger;
-exports.randomString = randomString;
-exports.fromBase64 = fromBase64;
-exports.toBase64 = toBase64;
-exports.buildSearchString = buildSearchString;
-const debug_1 = __importDefault(require("debug"));
-const colors_1 = require("colors");
-const readline_1 = require("readline");
-const uuid_1 = require("uuid");
-const systeminformation_1 = require("systeminformation");
-const logger_1 = __importDefault(require("@eneris/push-receiver/dist/utils/logger"));
-const debugLogger = (0, debug_1.default)('ring'), uuidNamespace = 'e53ffdc0-e91d-4ce1-bec2-df939d94739d';
+import debug from 'debug';
+import colors from 'colors';
+import { createInterface } from 'readline';
+import { v4 as generateRandomUuid, v5 as generateUuidFromNamespace } from 'uuid';
+import { uuid as getSystemUuid } from 'systeminformation';
+import pushReceiverLogger from '@eneris/push-receiver/dist/utils/logger.js';
+const debugLogger = debug('ring'), uuidNamespace = 'e53ffdc0-e91d-4ce1-bec2-df939d94739d';
 let logger = {
     logInfo(message) {
         debugLogger(message);
     },
     logError(message) {
-        debugLogger((0, colors_1.red)(message));
+        debugLogger(colors.red(message));
     },
 }, debugEnabled = false;
 const timeouts = new Set();
-function clearTimeouts() {
+export function clearTimeouts() {
     timeouts.forEach((timeout) => {
         clearTimeout(timeout);
     });
 }
-function delay(milliseconds) {
+export function delay(milliseconds) {
     return new Promise((resolve) => {
         const timeout = setTimeout(() => {
             timeouts.delete(timeout);
@@ -50,50 +28,50 @@ function delay(milliseconds) {
         timeouts.add(timeout);
     });
 }
-function logDebug(message) {
+export function logDebug(message) {
     if (debugEnabled) {
         logger.logInfo(message);
     }
 }
-function logInfo(...message) {
+export function logInfo(...message) {
     logger.logInfo(...message);
 }
-function logError(message) {
+export function logError(message) {
     logger.logError(message);
 }
-function useLogger(newLogger) {
+export function useLogger(newLogger) {
     logger = newLogger;
 }
-function enableDebug() {
+export function enableDebug() {
     debugEnabled = true;
 }
-function generateUuid(seed) {
+export function generateUuid(seed) {
     if (seed) {
-        return (0, uuid_1.v5)(seed, uuidNamespace);
+        return generateUuidFromNamespace(seed, uuidNamespace);
     }
-    return (0, uuid_1.v4)();
+    return generateRandomUuid();
 }
-async function getHardwareId(systemId) {
+export async function getHardwareId(systemId) {
     if (systemId) {
         return generateUuid(systemId);
     }
     const timeoutValue = '-1', { os: id } = await Promise.race([
-        (0, systeminformation_1.uuid)(),
+        getSystemUuid(),
         delay(5000).then(() => ({ os: timeoutValue })),
     ]);
     if (id === timeoutValue) {
         logError('Request for system uuid timed out.  Falling back to random session id');
-        return (0, uuid_1.v4)();
+        return generateRandomUuid();
     }
     if (id === '-') {
         // default value set by systeminformation if it can't find a real value
         logError('Unable to get system uuid.  Falling back to random session id');
-        return (0, uuid_1.v4)();
+        return generateRandomUuid();
     }
     return generateUuid(id);
 }
-async function requestInput(question) {
-    const lineReader = (0, readline_1.createInterface)({
+export async function requestInput(question) {
+    const lineReader = createInterface({
         input: process.stdin,
         output: process.stdout,
     }), answer = await new Promise((resolve) => {
@@ -102,7 +80,7 @@ async function requestInput(question) {
     lineReader.close();
     return answer.trim();
 }
-function stringify(data) {
+export function stringify(data) {
     if (typeof data === 'string') {
         return data;
     }
@@ -111,13 +89,13 @@ function stringify(data) {
     }
     return JSON.stringify(data) + '';
 }
-function mapAsync(records, asyncMapper) {
+export function mapAsync(records, asyncMapper) {
     return Promise.all(records.map((record) => asyncMapper(record)));
 }
-function randomInteger() {
+export function randomInteger() {
     return Math.floor(Math.random() * 99999999) + 100000;
 }
-function randomString(length) {
+export function randomString(length) {
     const uuid = generateUuid();
     return uuid.replace(/-/g, '').substring(0, length).toLowerCase();
 }
@@ -135,16 +113,17 @@ function logPushReceiver(...args) {
     logDebug('[Push Receiver]');
     logDebug(args[0]);
 }
-logger_1.default.error = logPushReceiver;
-function fromBase64(encodedInput) {
+const pushReceiverLoggerDefault = pushReceiverLogger.default || pushReceiverLogger; // fix for vitest
+pushReceiverLoggerDefault.error = logPushReceiver;
+export function fromBase64(encodedInput) {
     const buff = Buffer.from(encodedInput, 'base64');
     return buff.toString('ascii');
 }
-function toBase64(input) {
+export function toBase64(input) {
     const buff = Buffer.from(input);
     return buff.toString('base64');
 }
-function buildSearchString(search) {
+export function buildSearchString(search) {
     return ('?' +
         Object.entries(search)
             .filter(([, value]) => value !== undefined && value !== null)

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "ring-client-api",
-  "version": "13.2.1",
+  "version": "14.0.0-beta.0",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/index.js",
+  "type": "module",
   "exports": {
     ".": "./lib/index.js",
     "./ffmpeg": "./lib/ffmpeg.js",
@@ -11,40 +12,37 @@
     "./streaming/streaming-session": "./lib/streaming/streaming-session.js"
   },
   "scripts": {
-    "build": "rm -rf lib && tsc --declaration && chmod +x ./lib/ring-*-cli.js",
+    "build": "rm -rf lib && tsc --declaration && chmod +x ./lib/ring-*-cli.js && rm -rf ./lib/test",
     "dev": "tsc --declaration --watch --preserveWatchOutput",
     "lint": "eslint .",
-    "test": "jest",
-    "test:watch": "jest --watch"
+    "test": "vitest run"
   },
   "dependencies": {
     "@eneris/push-receiver": "4.3.0",
-    "@homebridge/camera-utils": "^2.2.7",
+    "@homebridge/camera-utils": "^3.0.0",
     "colors": "1.4.0",
-    "debug": "^4.3.7",
+    "debug": "^4.4.0",
     "json-bigint": "^1.0.0",
     "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",
+    "systeminformation": "^5.25.11",
+    "undici": "^7.2.1",
+    "uuid": "^11.0.5",
+    "werift": "0.21.6",
     "ws": "^8.18.0"
   },
   "devDependencies": {
     "@types/debug": "4.1.12",
-    "@types/jest": "29.5.14",
     "@types/json-bigint": "^1.0.4",
-    "@types/node": "22.9.3",
+    "@types/node": "22.10.5",
     "@types/socket.io-client": "1.4.36",
     "@types/uuid": "10.0.0",
     "@types/ws": "^8.5.13",
     "eslint-config-shared": "*",
-    "jest": "29.7.0",
-    "msw": "^2.6.4",
-    "ts-jest": "29.2.5",
+    "msw": "^2.7.0",
     "tsconfig": "*",
-    "typescript": "5.7.2"
+    "typescript": "5.7.3",
+    "vitest": "^2.1.8"
   },
   "engines": {
     "node": "^18 || ^20 || ^22"

package/lib/test/rest-client.spec.d.ts

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