ring-client-api 14.3.0 → 15.0.0-beta.0

package/lib/api.js

@@ -1,15 +1,15 @@
-import { clientApi, deviceApi, RingRestClient } from "./rest-client.js";
-import { Location } from "./location.js";
-import { PushNotificationAction, RingDeviceType } from "./ring-types.js";
-import { RingCamera } from "./ring-camera.js";
-import { RingChime } from "./ring-chime.js";
+import { clientApi, deviceApi, RingRestClient } from './rest-client.js';
+import { Location } from './location.js';
+import { PushNotificationAction, RingDeviceType } from './ring-types.js';
+import { RingCamera } from './ring-camera.js';
+import { RingChime } from './ring-chime.js';
 import { combineLatest, EMPTY, merge, Subject } from 'rxjs';
 import { debounceTime, startWith, switchMap, throttleTime, } from 'rxjs/operators';
-import { clearTimeouts, enableDebug, logDebug, logError, logInfo, } from "./util.js";
-import { setFfmpegPath } from "./ffmpeg.js";
-import { Subscribed } from "./subscribed.js";
+import { clearTimeouts, enableDebug, logDebug, logError, logInfo, } from './util.js';
+import { setFfmpegPath } from './ffmpeg.js';
+import { Subscribed } from './subscribed.js';
 import { PushReceiver } from '@eneris/push-receiver';
-import { RingIntercom } from "./ring-intercom.js";
+import { RingIntercom } from './ring-intercom.js';
 import JSONbig from 'json-bigint';
 export class RingApi extends Subscribed {
     restClient;

package/lib/device-data.d.ts

@@ -1 +1,3 @@
+export declare const redactedUuid = "[uuid]";
+export declare function stripSensitiveFields(input: unknown): void;
 export declare function logDeviceData(): Promise<void>;

package/lib/device-data.js

@@ -1,50 +1,100 @@
 /* eslint-disable no-console */
-import { RingApi } from "./api.js";
-import { acquireRefreshToken } from "./refresh-token.js";
-import { mapAsync } from "./util.js";
+import { RingApi } from './api.js';
+import { acquireRefreshToken } from './refresh-token.js';
+import { mapAsync } from './util.js';
 const sensitiveFields = [
     'id',
     'device_id',
     'latitude',
     'longitude',
     'address',
+    'address1',
+    'address2',
     'email',
     'time_zone',
+    'timezone',
     'location_id',
-    'serialNumber',
-    'catalogId',
-    'adapterZid',
+    'serialnumber',
+    'serial_number',
+    'catalogid',
+    'adapterzid',
     'fingerprint',
     'owner',
     'ssid',
+    'wifi_name',
     'ap_address',
+    'mac_address',
+    'macaddress',
     'codes',
-    'groupId',
+    'groupid',
     'group',
-    'groupMembers',
-];
-function stripSensitiveFields(input) {
-    if (typeof input === 'object') {
-        if (Array.isArray(input)) {
-            input.forEach((value) => stripSensitiveFields(value));
-            return;
-        }
-        for (const key in input) {
-            if (sensitiveFields.includes(key) || key.endsWith('_id')) {
-                delete input[key];
+    'groupmembers',
+    'first_name',
+    'last_name',
+    'phone',
+    'phone_number',
+    'third_party_dsn',
+    'amzn_dsn',
+    'refresh_token',
+    'access_token',
+    'password',
+    'token',
+    'cookie',
+    'city',
+    'zip_code',
+    'cross_street',
+], sensitiveFieldSet = new Set(sensitiveFields), uuidPattern = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
+export const redactedUuid = '[uuid]';
+function isUuid(value) {
+    return value.length === 36 && uuidPattern.test(value);
+}
+function isSensitiveKey(key) {
+    const lower = key.toLowerCase();
+    return (sensitiveFieldSet.has(lower) ||
+        lower.endsWith('_id') ||
+        // camelCase ids such as roomId / doorbotId (but not zid — keep key, redact value)
+        (key.endsWith('Id') && key !== 'Id'));
+}
+export function stripSensitiveFields(input) {
+    if (input === null || typeof input !== 'object') {
+        return;
+    }
+    if (Array.isArray(input)) {
+        for (let i = 0; i < input.length; i++) {
+            const value = input[i];
+            if (typeof value === 'string' && isUuid(value)) {
+                input[i] = redactedUuid;
             }
             else {
-                const data = input[key];
-                if (key.length === 36) {
-                    input[key.slice(0, 13) + '-uuid'] = data;
-                    delete input[key];
-                }
-                if (typeof data === 'string' && data.length === 36) {
-                    input[key] = data.slice(0, 13) + '-uuid';
-                }
-                stripSensitiveFields(data);
+                stripSensitiveFields(value);
             }
         }
+        return;
+    }
+    const record = input;
+    let uuidKeyIndex = 0;
+    // Snapshot keys so renames during iteration cannot re-introduce originals.
+    for (const key of Object.keys(record)) {
+        if (isSensitiveKey(key)) {
+            delete record[key];
+            continue;
+        }
+        let data = record[key];
+        if (isUuid(key)) {
+            delete record[key];
+            if (typeof data === 'string' && isUuid(data)) {
+                data = redactedUuid;
+            }
+            // Unique placeholder per key so sibling uuid keys do not clobber each other.
+            record[`${redactedUuid}:${uuidKeyIndex++}`] = data;
+            stripSensitiveFields(data);
+            continue;
+        }
+        if (typeof data === 'string' && isUuid(data)) {
+            record[key] = redactedUuid;
+            continue;
+        }
+        stripSensitiveFields(data);
     }
 }
 export async function logDeviceData() {
@@ -61,10 +111,12 @@ export async function logDeviceData() {
             intercoms: location.intercoms.map((intercom) => intercom.data),
             devices: devices.map((device) => device.data),
         };
-    }), results = {
+    }), 
+    // Clone so redaction does not mutate live RingApi device objects.
+    results = structuredClone({
         locations: locationsWithDevices,
         amazonKeyLocks,
-    };
+    });
     stripSensitiveFields(results);
     console.log('\nPlease copy and paste everything AFTER THIS LINE:\n\n');
     console.log(JSON.stringify(results));

package/lib/index.js

@@ -1,7 +1,7 @@
-export * from "./api.js";
-export * from "./location.js";
-export * from "./ring-camera.js";
-export * from "./ring-chime.js";
-export * from "./ring-device.js";
-export * from "./ring-intercom.js";
-export * from "./ring-types.js";
+export * from './api.js';
+export * from './location.js';
+export * from './ring-camera.js';
+export * from './ring-chime.js';
+export * from './ring-device.js';
+export * from './ring-intercom.js';
+export * from './ring-types.js';

package/lib/location.js

@@ -1,12 +1,12 @@
 import { WebSocket } from 'undici';
 import { BehaviorSubject, firstValueFrom, merge, ReplaySubject, Subject, } from 'rxjs';
 import { concatMap, debounceTime, distinctUntilChanged, filter, map, scan, shareReplay, skip, } from 'rxjs/operators';
-import { delay, generateUuid, logDebug, logError, logInfo } from "./util.js";
-import { DispatchSignalType, RingDeviceType, disabledLocationModes, isWebSocketSupportedAsset, } from "./ring-types.js";
-import { appApi, clientApi } from "./rest-client.js";
-import { getSearchQueryString } from "./ring-camera.js";
-import { RingDevice } from "./ring-device.js";
-import { Subscribed } from "./subscribed.js";
+import { delay, generateUuid, logDebug, logError, logInfo } from './util.js';
+import { DispatchSignalType, RingDeviceType, disabledLocationModes, isWebSocketSupportedAsset, } from './ring-types.js';
+import { appApi, clientApi } from './rest-client.js';
+import { getSearchQueryString } from './ring-camera.js';
+import { RingDevice } from './ring-device.js';
+import { Subscribed } from './subscribed.js';
 const deviceListMessageType = 'DeviceInfoDocGetList';
 function flattenDeviceData(data) {
     return Object.assign({}, data.general && data.general.v2, data.device && data.device.v1);
@@ -152,7 +152,7 @@ export class Location extends Subscribed {
                     this.onDataUpdate.next(message);
                 }
             }
-            catch (e) {
+            catch {
                 logError('Error parsing message from server: ' + event.data);
             }
         });

package/lib/refresh-token.js

@@ -1,13 +1,13 @@
 /* eslint-disable no-console */
-import { RingRestClient } from "./rest-client.js";
-import { requestInput } from "./util.js";
+import { RingRestClient } from './rest-client.js';
+import { requestHiddenInput, requestInput } from './util.js';
 export async function acquireRefreshToken() {
-    const email = await requestInput('Email: '), password = await requestInput('Password: '), restClient = new RingRestClient({ email, password }), getAuthWith2fa = async () => {
+    const email = await requestInput('Email: '), password = await requestHiddenInput('Password: '), restClient = new RingRestClient({ email, password }), getAuthWith2fa = async () => {
         const code = await requestInput('2fa Code: ');
         try {
             return await restClient.getAuth(code);
         }
-        catch (_) {
+        catch {
             console.log('Incorrect 2fa code. Please try again.');
             return getAuthWith2fa();
         }

package/lib/rest-client.d.ts

@@ -2,7 +2,7 @@ import type { AuthTokenResponse, SessionResponse } from './ring-types.ts';
 import { ReplaySubject } from 'rxjs';
 import type { Credentials } from '@eneris/push-receiver/dist/types.d.js';
 import { Agent } from 'undici';
-interface RequestOptions extends RequestInit {
+interface RequestOptions extends Omit<RequestInit, 'dispatcher'> {
     responseType?: 'json' | 'buffer';
     timeout?: number;
     json?: object;
@@ -16,6 +16,9 @@ export interface ExtendedResponse {
     responseTimestamp: number;
     timeMillis: number;
 }
+export declare class InvalidAuthResponseError extends Error {
+    name: string;
+}
 export interface EmailAuth {
     email: string;
     password: string;

package/lib/rest-client.js

@@ -1,7 +1,11 @@
-import { delay, fromBase64, getHardwareId, logDebug, logError, logInfo, stringify, toBase64, } from "./util.js";
+import { delay, fromBase64, getHardwareId, logDebug, logError, logInfo, stringify, toBase64, } from './util.js';
 import { ReplaySubject } from 'rxjs';
 import assert from 'assert';
-import { Agent } from 'undici';
+// Import fetch from the same undici package as Agent. Node's global fetch is
+// backed by a bundled undici that can be a different major than the npm
+// dependency; passing an undici@8 Agent into global fetch then fails with
+// UND_ERR_INVALID_ARG ("invalid onRequestStart method") on Node 22/24.
+import { Agent, fetch as undiciFetch, } from 'undici';
 const fetchAgent = new Agent({
     connections: 6,
     pipelining: 1,
@@ -29,6 +33,9 @@ export function commandsApi(path) {
 export function appApi(path) {
     return appApiBaseUrl + path;
 }
+export class InvalidAuthResponseError extends Error {
+    name = 'InvalidAuthResponseError';
+}
 async function responseToError(response) {
     const error = new Error();
     error.response = {
@@ -51,9 +58,6 @@ async function responseToError(response) {
     return error;
 }
 async function requestWithRetry(requestOptions, retryCount = 0) {
-    if (typeof fetch !== 'function') {
-        throw new Error(`Your current NodeJS version (${process.version}) is too old to support this plugin.  Please upgrade to the latest LTS version of NodeJS.`);
-    }
     try {
         if (requestOptions.json || requestOptions.responseType === 'json') {
             requestOptions.headers = {
@@ -75,8 +79,8 @@ async function requestWithRetry(requestOptions, retryCount = 0) {
         if (options.timeout && !options.signal) {
             options.signal = AbortSignal.timeout(options.timeout);
         }
-        // make the fetch request
-        const response = await fetch(options.url, options), headers = response.headers;
+        // undici fetch + undici Agent must stay paired (see import comment)
+        const response = await undiciFetch(options.url, options), headers = response.headers;
         if (!response.ok) {
             const error = await responseToError(response);
             throw error;
@@ -223,7 +227,12 @@ export class RingRestClient {
                     hardware_id: hardwareId,
                     'User-Agent': 'android:com.ringapp',
                 },
-            }), oldRefreshToken = this.refreshToken;
+            }), oldRefreshToken = this.refreshToken, newRefreshToken = response?.refresh_token;
+            // Never replace the stored refresh token with one missing `rt` (e.g. an undecodable response body).
+            // Persisting it would guarantee `invalid_grant` on the next start, while the old token may still work.
+            if (typeof newRefreshToken !== 'string' || !newRefreshToken) {
+                throw new InvalidAuthResponseError('Received an oauth response from Ring without a refresh token. The existing refresh token has been kept. If this persists, make sure ring-client-api/homebridge-ring is up to date for your Node.js version.');
+            }
             // Store the new refresh token and auth config
             this.authConfig = {
                 ...this.authConfig,
@@ -243,6 +252,10 @@ export class RingRestClient {
             };
         }
         catch (requestError) {
+            if (requestError instanceof InvalidAuthResponseError) {
+                // Ring did not reject the credentials, so keep them in memory rather than clearing and retrying
+                throw requestError;
+            }
             if (grantData.refresh_token) {
                 // failed request with refresh token
                 this.refreshToken = undefined;
@@ -250,9 +263,13 @@ export class RingRestClient {
                 logError(requestError);
                 return this.getAuth();
             }
-            const response = requestError.response || {}, responseData = response.body || {}, responseError = 'error' in responseData && typeof responseData.error === 'string'
+            const response = requestError.response || {}, responseData = typeof response.body === 'object' && response.body !== null
+                ? response.body
+                : {}, responseError = 'error' in responseData && typeof responseData.error === 'string'
                 ? responseData.error
-                : '';
+                : response.status
+                    ? `HTTP ${response.status}`
+                    : '';
             if (response.status === 412 || // need 2fa code
                 (response.status === 400 &&
                     responseError.startsWith('Verification Code')) // invalid 2fa code entered
@@ -260,7 +277,7 @@ export class RingRestClient {
                 this.using2fa = true;
                 if (response.status === 400) {
                     this.promptFor2fa = 'Invalid 2fa code entered.  Please try again.';
-                    throw new Error(responseError);
+                    throw new Error(responseError, { cause: requestError });
                 }
                 if ('tsv_state' in responseData) {
                     const { tsv_state, phone } = responseData, prompt = tsv_state === 'totp'
@@ -271,7 +288,7 @@ export class RingRestClient {
                 else {
                     this.promptFor2fa = 'Please enter the code sent to your text/email';
                 }
-                throw new Error('Your Ring account is configured to use 2-factor authentication (2fa).  See https://github.com/dgreif/ring/wiki/Refresh-Tokens for details.');
+                throw new Error('Your Ring account is configured to use 2-factor authentication (2fa).  See https://github.com/dgreif/ring/wiki/Refresh-Tokens for details.', { cause: requestError });
             }
             const authTypeMessage = 'refreshToken' in this.authOptions
                 ? 'refresh token is'
@@ -284,7 +301,7 @@ export class RingRestClient {
                 ` (error: ${responseError})`;
             logError(requestError.response || requestError);
             logError(errorMessage);
-            throw new Error(errorMessage);
+            throw new Error(errorMessage, { cause: requestError });
         }
     }
     async fetchNewSession(authToken) {
@@ -396,7 +413,9 @@ export class RingRestClient {
                     }
                     return this.request(options);
                 }
-                throw new Error('Not found with response: ' + stringify(response.body));
+                throw new Error('Not found with response: ' + stringify(response.body), {
+                    cause: e,
+                });
             }
             if (response.status) {
                 logError(`Request to ${url} failed with status ${response.status}. Response body: ${stringify(response.body)}`);

package/lib/ring-auth-cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { logRefreshToken } from "./refresh-token.js";
+import { logRefreshToken } from './refresh-token.js';
 logRefreshToken().catch((e) => {
     // eslint-disable-next-line no-console
     console.error(e);

package/lib/ring-camera.js

@@ -1,13 +1,13 @@
-import { RingCameraKind } from "./ring-types.js";
-import { DoorbellType, PushNotificationAction, RingCameraModel, } from "./ring-types.js";
-import { appApi, clientApi, deviceApi } from "./rest-client.js";
+import { RingCameraKind } from './ring-types.js';
+import { DoorbellType, PushNotificationAction, RingCameraModel, } from './ring-types.js';
+import { appApi, clientApi, deviceApi } from './rest-client.js';
 import { BehaviorSubject, firstValueFrom, ReplaySubject, Subject } from 'rxjs';
 import { distinctUntilChanged, filter, map, share, startWith, throttleTime, } from 'rxjs/operators';
-import { buildSearchString, delay, logDebug, logError, } from "./util.js";
-import { Subscribed } from "./subscribed.js";
-import { WebrtcConnection } from "./streaming/webrtc-connection.js";
-import { StreamingSession } from "./streaming/streaming-session.js";
-import { SimpleWebRtcSession } from "./streaming/simple-webrtc-session.js";
+import { buildSearchString, delay, logDebug, logError, } from './util.js';
+import { Subscribed } from './subscribed.js';
+import { WebrtcConnection } from './streaming/webrtc-connection.js';
+import { StreamingSession } from './streaming/streaming-session.js';
+import { SimpleWebRtcSession } from './streaming/simple-webrtc-session.js';
 const maxSnapshotRefreshSeconds = 15, fullDayMs = 24 * 60 * 60 * 1000;
 function parseBatteryLife(batteryLife) {
     if (batteryLife === null || batteryLife === undefined) {

package/lib/ring-chime.js

@@ -1,5 +1,5 @@
-import { ChimeModel } from "./ring-types.js";
-import { clientApi, deviceApi } from "./rest-client.js";
+import { ChimeModel } from './ring-types.js';
+import { clientApi, deviceApi } from './rest-client.js';
 import { BehaviorSubject, Subject } from 'rxjs';
 const settingsWhichRequireReboot = [
     'ding_audio_id',

package/lib/ring-device-data-cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { logDeviceData } from "./device-data.js";
+import { logDeviceData } from './device-data.js';
 logDeviceData().catch((e) => {
     // eslint-disable-next-line no-console
     console.error(e);

package/lib/ring-device.js

@@ -1,8 +1,8 @@
 import { BehaviorSubject } from 'rxjs';
-import { deviceTypesWithVolume } from "./ring-types.js";
+import { deviceTypesWithVolume } from './ring-types.js';
 import { filter, map } from 'rxjs/operators';
-import { Subscribed } from "./subscribed.js";
-import { logError } from "./util.js";
+import { Subscribed } from './subscribed.js';
+import { logError } from './util.js';
 export class RingDevice extends Subscribed {
     onData;
     zid;

package/lib/ring-intercom.js

@@ -1,9 +1,9 @@
-import { PushNotificationAction } from "./ring-types.js";
-import { clientApi, commandsApi } from "./rest-client.js";
+import { PushNotificationAction } from './ring-types.js';
+import { clientApi, commandsApi } from './rest-client.js';
 import { BehaviorSubject, Subject } from 'rxjs';
 import { distinctUntilChanged, map } from 'rxjs/operators';
-import { getBatteryLevel } from "./ring-camera.js";
-import { logError } from "./util.js";
+import { getBatteryLevel } from './ring-camera.js';
+import { logError } from './util.js';
 export class RingIntercom {
     id;
     deviceType;

package/lib/ring-types.d.ts

@@ -1,51 +1,51 @@
 type Firmware = string | 'Up To Date';
 export declare const RingDeviceType: {
-    readonly BaseStation: "hub.redsky";
-    readonly BaseStationPro: "hub.kili";
-    readonly Keypad: "security-keypad";
-    readonly SecurityPanel: "security-panel";
-    readonly ContactSensor: "sensor.contact";
-    readonly MotionSensor: "sensor.motion";
-    readonly FloodFreezeSensor: "sensor.flood-freeze";
-    readonly FreezeSensor: "sensor.freeze";
-    readonly TemperatureSensor: "sensor.temperature";
-    readonly WaterSensor: "sensor.water";
-    readonly TiltSensor: "sensor.tilt";
-    readonly GlassbreakSensor: "sensor.glassbreak";
-    readonly RangeExtender: "range-extender.zwave";
-    readonly ZigbeeAdapter: "adapter.zigbee";
-    readonly AccessCodeVault: "access-code.vault";
-    readonly AccessCode: "access-code";
-    readonly SmokeAlarm: "alarm.smoke";
-    readonly CoAlarm: "alarm.co";
-    readonly SmokeCoListener: "listener.smoke-co";
-    readonly MultiLevelSwitch: "switch.multilevel";
-    readonly Fan: "switch.multilevel";
-    readonly MultiLevelBulb: "switch.multilevel.bulb";
-    readonly Switch: "switch";
-    readonly BeamsMotionSensor: "motion-sensor.beams";
-    readonly BeamsSwitch: "switch.beams";
-    readonly BeamsMultiLevelSwitch: "switch.multilevel.beams";
-    readonly BeamsLightGroupSwitch: "group.light-group.beams";
-    readonly BeamsTransformerSwitch: "switch.transformer.beams";
-    readonly BeamsDevice: "device.beams";
-    readonly RetrofitBridge: "bridge.flatline";
-    readonly RetrofitZone: "sensor.zone";
-    readonly Thermostat: "temperature-control.thermostat";
-    readonly Sensor: "sensor";
-    readonly RingNetAdapter: "adapter.ringnet";
-    readonly CodeVault: "access-code.vault";
-    readonly SecurityAccessCode: "access-code";
-    readonly ZWaveAdapter: "adapter.zwave";
-    readonly ZWaveExtender: "range-extender.zwave";
-    readonly PanicButton: "security-panic";
-    readonly UnknownZWave: "unknown.zwave";
-    readonly OnvifCamera: "onvif_camera";
-    readonly ThirdPartyGarageDoorOpener: "third_party_gdo";
-    readonly IntercomHandsetAudio: "intercom_handset_audio";
-    readonly IntercomHandsetVideo: "intercom_handset_video";
-    readonly WaterValve: "valve.water";
-    readonly KiddeSmokeCoAlarm: "comp.bluejay.sensor_bluejay_wsc";
+    readonly BaseStation: 'hub.redsky';
+    readonly BaseStationPro: 'hub.kili';
+    readonly Keypad: 'security-keypad';
+    readonly SecurityPanel: 'security-panel';
+    readonly ContactSensor: 'sensor.contact';
+    readonly MotionSensor: 'sensor.motion';
+    readonly FloodFreezeSensor: 'sensor.flood-freeze';
+    readonly FreezeSensor: 'sensor.freeze';
+    readonly TemperatureSensor: 'sensor.temperature';
+    readonly WaterSensor: 'sensor.water';
+    readonly TiltSensor: 'sensor.tilt';
+    readonly GlassbreakSensor: 'sensor.glassbreak';
+    readonly RangeExtender: 'range-extender.zwave';
+    readonly ZigbeeAdapter: 'adapter.zigbee';
+    readonly AccessCodeVault: 'access-code.vault';
+    readonly AccessCode: 'access-code';
+    readonly SmokeAlarm: 'alarm.smoke';
+    readonly CoAlarm: 'alarm.co';
+    readonly SmokeCoListener: 'listener.smoke-co';
+    readonly MultiLevelSwitch: 'switch.multilevel';
+    readonly Fan: 'switch.multilevel';
+    readonly MultiLevelBulb: 'switch.multilevel.bulb';
+    readonly Switch: 'switch';
+    readonly BeamsMotionSensor: 'motion-sensor.beams';
+    readonly BeamsSwitch: 'switch.beams';
+    readonly BeamsMultiLevelSwitch: 'switch.multilevel.beams';
+    readonly BeamsLightGroupSwitch: 'group.light-group.beams';
+    readonly BeamsTransformerSwitch: 'switch.transformer.beams';
+    readonly BeamsDevice: 'device.beams';
+    readonly RetrofitBridge: 'bridge.flatline';
+    readonly RetrofitZone: 'sensor.zone';
+    readonly Thermostat: 'temperature-control.thermostat';
+    readonly Sensor: 'sensor';
+    readonly RingNetAdapter: 'adapter.ringnet';
+    readonly CodeVault: 'access-code.vault';
+    readonly SecurityAccessCode: 'access-code';
+    readonly ZWaveAdapter: 'adapter.zwave';
+    readonly ZWaveExtender: 'range-extender.zwave';
+    readonly PanicButton: 'security-panic';
+    readonly UnknownZWave: 'unknown.zwave';
+    readonly OnvifCamera: 'onvif_camera';
+    readonly ThirdPartyGarageDoorOpener: 'third_party_gdo';
+    readonly IntercomHandsetAudio: 'intercom_handset_audio';
+    readonly IntercomHandsetVideo: 'intercom_handset_video';
+    readonly WaterValve: 'valve.water';
+    readonly KiddeSmokeCoAlarm: 'comp.bluejay.sensor_bluejay_wsc';
 };
 export type RingDeviceType = (typeof RingDeviceType)[keyof typeof RingDeviceType];
 export declare const RingDeviceCategory: {
@@ -70,40 +70,40 @@ export declare const RingDeviceCategory: {
 };
 export type RingDeviceCategory = (typeof RingDeviceCategory)[keyof typeof RingDeviceCategory];
 export declare const RingCameraKind: {
-    readonly doorbot: "doorbot";
-    readonly doorbell: "doorbell";
-    readonly doorbell_v3: "doorbell_v3";
-    readonly doorbell_v4: "doorbell_v4";
-    readonly doorbell_v5: "doorbell_v5";
-    readonly doorbell_oyster: "doorbell_oyster";
-    readonly doorbell_portal: "doorbell_portal";
-    readonly doorbell_scallop: "doorbell_scallop";
-    readonly doorbell_scallop_lite: "doorbell_scallop_lite";
-    readonly doorbell_graham_cracker: "doorbell_graham_cracker";
-    readonly lpd_v1: "lpd_v1";
-    readonly lpd_v2: "lpd_v2";
-    readonly lpd_v4: "lpd_v4";
-    readonly jbox_v1: "jbox_v1";
-    readonly stickup_cam: "stickup_cam";
-    readonly stickup_cam_v3: "stickup_cam_v3";
-    readonly stickup_cam_elite: "stickup_cam_elite";
-    readonly stickup_cam_longfin: "stickup_cam_longfin";
-    readonly stickup_cam_lunar: "stickup_cam_lunar";
-    readonly spotlightw_v2: "spotlightw_v2";
-    readonly hp_cam_v1: "hp_cam_v1";
-    readonly hp_cam_v2: "hp_cam_v2";
-    readonly stickup_cam_v4: "stickup_cam_v4";
-    readonly floodlight_v1: "floodlight_v1";
-    readonly floodlight_v2: "floodlight_v2";
-    readonly floodlight_pro: "floodlight_pro";
-    readonly cocoa_camera: "cocoa_camera";
-    readonly cocoa_doorbell: "cocoa_doorbell";
-    readonly cocoa_doorbell_v2: "cocoa_doorbell_v2";
-    readonly cocoa_doorbell_v3: "cocoa_doorbell_v3";
-    readonly cocoa_floodlight: "cocoa_floodlight";
-    readonly cocoa_spotlight: "cocoa_spotlight";
-    readonly stickup_cam_mini: "stickup_cam_mini";
-    readonly onvif_camera: "onvif_camera";
+    readonly doorbot: 'doorbot';
+    readonly doorbell: 'doorbell';
+    readonly doorbell_v3: 'doorbell_v3';
+    readonly doorbell_v4: 'doorbell_v4';
+    readonly doorbell_v5: 'doorbell_v5';
+    readonly doorbell_oyster: 'doorbell_oyster';
+    readonly doorbell_portal: 'doorbell_portal';
+    readonly doorbell_scallop: 'doorbell_scallop';
+    readonly doorbell_scallop_lite: 'doorbell_scallop_lite';
+    readonly doorbell_graham_cracker: 'doorbell_graham_cracker';
+    readonly lpd_v1: 'lpd_v1';
+    readonly lpd_v2: 'lpd_v2';
+    readonly lpd_v4: 'lpd_v4';
+    readonly jbox_v1: 'jbox_v1';
+    readonly stickup_cam: 'stickup_cam';
+    readonly stickup_cam_v3: 'stickup_cam_v3';
+    readonly stickup_cam_elite: 'stickup_cam_elite';
+    readonly stickup_cam_longfin: 'stickup_cam_longfin';
+    readonly stickup_cam_lunar: 'stickup_cam_lunar';
+    readonly spotlightw_v2: 'spotlightw_v2';
+    readonly hp_cam_v1: 'hp_cam_v1';
+    readonly hp_cam_v2: 'hp_cam_v2';
+    readonly stickup_cam_v4: 'stickup_cam_v4';
+    readonly floodlight_v1: 'floodlight_v1';
+    readonly floodlight_v2: 'floodlight_v2';
+    readonly floodlight_pro: 'floodlight_pro';
+    readonly cocoa_camera: 'cocoa_camera';
+    readonly cocoa_doorbell: 'cocoa_doorbell';
+    readonly cocoa_doorbell_v2: 'cocoa_doorbell_v2';
+    readonly cocoa_doorbell_v3: 'cocoa_doorbell_v3';
+    readonly cocoa_floodlight: 'cocoa_floodlight';
+    readonly cocoa_spotlight: 'cocoa_spotlight';
+    readonly stickup_cam_mini: 'stickup_cam_mini';
+    readonly onvif_camera: 'onvif_camera';
 };
 export type RingCameraKind = (typeof RingCameraKind)[keyof typeof RingCameraKind];
 export declare const RingCameraModel: {
@@ -884,23 +884,23 @@ export interface RingDeviceHistoryEvent {
 }
 export type DingState = 'ringing' | 'connected' | 'timed_out' | 'completed';
 export declare const NotificationDetectionType: {
-    readonly Human: "human";
-    readonly Loitering: "loitering";
-    readonly Motion: "motion";
-    readonly OtherMotion: "other_motion";
-    readonly NotAvailable: "null";
-    readonly StreamBroken: "stream_broken";
+    readonly Human: 'human';
+    readonly Loitering: 'loitering';
+    readonly Motion: 'motion';
+    readonly OtherMotion: 'other_motion';
+    readonly NotAvailable: 'null';
+    readonly StreamBroken: 'stream_broken';
 };
 export type NotificationDetectionType = (typeof NotificationDetectionType)[keyof typeof NotificationDetectionType];
 export declare const PushNotificationAction: {
-    readonly Ding: "com.ring.pn.live-event.ding";
-    readonly Motion: "com.ring.pn.live-event.motion";
-    readonly IntercomDing: "com.ring.pn.live-event.intercom";
-    readonly IntercomUnlock: "com.ring.push.INTERCOM_UNLOCK_FROM_APP";
-    readonly AlarmModeNone: "com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_NONE_NOTICE";
-    readonly AlarmModeSome: "com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_SOME_NOTICE";
-    readonly AlarmSoundSiren: "com.ring.push.HANDLE_NEW_USER_SOUND_SIREN";
-    readonly AlarmSilenceSiren: "com.ring.push.HANDLE_NEW_NON_ALARM_SIREN_SILENCED";
+    readonly Ding: 'com.ring.pn.live-event.ding';
+    readonly Motion: 'com.ring.pn.live-event.motion';
+    readonly IntercomDing: 'com.ring.pn.live-event.intercom';
+    readonly IntercomUnlock: 'com.ring.push.INTERCOM_UNLOCK_FROM_APP';
+    readonly AlarmModeNone: 'com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_NONE_NOTICE';
+    readonly AlarmModeSome: 'com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_SOME_NOTICE';
+    readonly AlarmSoundSiren: 'com.ring.push.HANDLE_NEW_USER_SOUND_SIREN';
+    readonly AlarmSilenceSiren: 'com.ring.push.HANDLE_NEW_NON_ALARM_SIREN_SILENCED';
 };
 export type PushNotificationAction = (typeof PushNotificationAction)[keyof typeof PushNotificationAction];
 export interface PushNotificationDingV2 {
@@ -1051,8 +1051,8 @@ export interface AccountMonitoringStatus {
     dispatchSetupComplete: boolean;
 }
 export declare const DispatchSignalType: {
-    readonly Burglar: "user-verified-burglar-xa";
-    readonly Fire: "user-verified-fire-xa";
+    readonly Burglar: 'user-verified-burglar-xa';
+    readonly Fire: 'user-verified-fire-xa';
 };
 export type DispatchSignalType = (typeof DispatchSignalType)[keyof typeof DispatchSignalType];
 export type LocationModeInput = 'home' | 'away' | 'disarmed';

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

@@ -24,7 +24,7 @@ export declare class WeriftPeerConnection extends Subscribed implements BasicPee
     onVideoRtp: Subject<RtpPacket>;
     onVideoRtcp: Subject<RtcpPacket>;
     onIceCandidate: Subject<RTCIceCandidate>;
-    onConnectionState: ReplaySubject<"closed" | "connected" | "failed" | "disconnected" | "new" | "connecting">;
+    onConnectionState: ReplaySubject<"closed" | "connected" | "connecting" | "disconnected" | "failed" | "new">;
     returnAudioTrack: MediaStreamTrack;
     private onRequestKeyFrame;
     constructor();
@@ -33,7 +33,7 @@ export declare class WeriftPeerConnection extends Subscribed implements BasicPee
         type: 'answer';
         sdp: string;
     }): Promise<void>;
-    addIceCandidate(candidate: RTCIceCandidate): Promise<void>;
+    addIceCandidate(candidate: Partial<RTCIceCandidate>): Promise<void>;
     requestKeyFrame(): void;
     close(): void;
 }

package/lib/streaming/peer-connection.js

@@ -1,7 +1,7 @@
 import { MediaStreamTrack, RTCPeerConnection, RTCRtpCodecParameters, } from 'werift';
 import { interval, merge, ReplaySubject, Subject } from 'rxjs';
-import { logDebug, logError, logInfo } from "../util.js";
-import { Subscribed } from "../subscribed.js";
+import { logDebug, logError, logInfo } from '../util.js';
+import { Subscribed } from '../subscribed.js';
 const ringIceServers = [
     'stun:stun.kinesisvideo.us-east-1.amazonaws.com:443',
     'stun:stun.kinesisvideo.us-east-2.amazonaws.com:443',

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

@@ -1,4 +1,4 @@
-import { generateUuid } from "../util.js";
+import { generateUuid } from '../util.js';
 function liveViewUrl(path) {
     return `https://api.ring.com/integrations/v1/liveview/${path}`;
 }

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

@@ -24,6 +24,10 @@ interface SessionStartedMessage {
     method: 'session_started';
     body: SessionBody;
 }
+interface PingMessage {
+    method: 'ping';
+    body: SessionBody;
+}
 interface PongMessage {
     method: 'pong';
     body: SessionBody;
@@ -46,12 +50,12 @@ interface StreamInfoMessage {
         transcoding_reason: 'codec_mismatch' | string;
     };
 }
-declare const CloseReasonCode: {
-    readonly NormalClose: 0;
-    readonly AuthenticationFailed: 5;
-    readonly Timeout: 6;
-};
-type CloseReasonCode = (typeof CloseReasonCode)[keyof typeof CloseReasonCode];
+interface CloseReasonCodes {
+    NormalClose: 0;
+    AuthenticationFailed: 5;
+    Timeout: 6;
+}
+type CloseReasonCode = CloseReasonCodes[keyof CloseReasonCodes];
 interface CloseMessage {
     method: 'close';
     body: {
@@ -61,5 +65,5 @@ interface CloseMessage {
         };
     } & SessionBody;
 }
-export type IncomingMessage = AnswerMessage | IceCandidateMessage | SessionCreatedMessage | SessionStartedMessage | PongMessage | CloseMessage | NotificationMessage | CameraStartedMessage | StreamInfoMessage;
+export type IncomingMessage = AnswerMessage | IceCandidateMessage | SessionCreatedMessage | SessionStartedMessage | PingMessage | PongMessage | CloseMessage | NotificationMessage | CameraStartedMessage | StreamInfoMessage;
 export {};

package/lib/streaming/streaming-messages.js

@@ -1,10 +1 @@
-const CloseReasonCode = {
-    NormalClose: 0,
-    // reason: { code: 5, text: '[rsl-apps/webrtc-liveview-server/Session.cpp:429] [Auth] [0xd540]: [rsl-apps/session-manager/Manager.cpp:227] [AppAuth] Unauthorized: invalid or expired token' }
-    // reason: { code: 5, text: 'Authentication failed: -1' }
-    // reason: { code: 5, text: 'Sessions with the provided ID not found' }
-    AuthenticationFailed: 5,
-    // reason: { code: 6, text: 'Timeout waiting for ping' }
-    Timeout: 6,
-};
 export {};

package/lib/streaming/streaming-session.js

@@ -1,10 +1,10 @@
 import { RtpPacket } from 'werift';
 import { FfmpegProcess, reservePorts, RtpSplitter, } from '@homebridge/camera-utils';
 import { firstValueFrom, ReplaySubject, Subject } from 'rxjs';
-import { getFfmpegPath } from "../ffmpeg.js";
-import { logDebug, logError } from "../util.js";
+import { getFfmpegPath } from '../ffmpeg.js';
+import { logDebug, logError } from '../util.js';
 import { concatMap, map, mergeWith, take } from 'rxjs/operators';
-import { Subscribed } from "../subscribed.js";
+import { Subscribed } from '../subscribed.js';
 function getCleanSdp(sdp, includeVideo) {
     return sdp
         .split('\nm=')

package/lib/streaming/webrtc-connection.js

@@ -1,9 +1,9 @@
 import { WebSocket } from 'undici';
 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";
+import { generateUuid, logDebug, logError, logInfo } from '../util.js';
+import { WeriftPeerConnection, } from './peer-connection.js';
+import { Subscribed } from '../subscribed.js';
 export class WebrtcConnection extends Subscribed {
     onSessionId = new ReplaySubject(1);
     onOfferSent = new ReplaySubject(1);
@@ -143,6 +143,9 @@ export class WebrtcConnection extends Subscribed {
                     sdpMLineIndex: message.body.mlineindex,
                 });
                 return;
+            case 'ping':
+                this.sendSessionMessage('pong');
+                return;
             case 'pong':
                 return;
             case 'notification': {
@@ -239,7 +242,7 @@ export class WebrtcConnection extends Subscribed {
             });
             this.ws.close();
         }
-        catch (_) {
+        catch {
             // ignore any errors since we are stopping the call
         }
         this.hasEnded = true;

package/lib/util.d.ts

@@ -12,6 +12,7 @@ export declare function enableDebug(): void;
 export declare function generateUuid(seed?: string): string;
 export declare function getHardwareId(systemId?: string): Promise<string>;
 export declare function requestInput(question: string): Promise<string>;
+export declare function requestHiddenInput(question: string): Promise<string>;
 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;

package/lib/util.js

@@ -1,6 +1,7 @@
 import debug from 'debug';
 import colors from 'colors';
 import { createInterface } from 'readline';
+import { Writable } from 'stream';
 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';
@@ -80,6 +81,27 @@ export async function requestInput(question) {
     lineReader.close();
     return answer.trim();
 }
+export async function requestHiddenInput(question) {
+    const lineReader = createInterface({
+        input: process.stdin,
+        // Discard readline's echo of each keystroke so the input stays hidden
+        output: new Writable({
+            write(_chunk, _encoding, callback) {
+                callback();
+            },
+        }),
+        // Puts a TTY stdin in raw mode so the terminal doesn't echo the input either
+        terminal: true,
+    });
+    process.stdout.write(question);
+    const answer = await new Promise((resolve) => {
+        lineReader.question('', resolve);
+    });
+    lineReader.close();
+    // The newline readline writes when enter is pressed was discarded with the echo
+    process.stdout.write('\n');
+    return answer.trim();
+}
 export function stringify(data) {
     if (typeof data === 'string') {
         return data;
@@ -107,7 +129,7 @@ function logPushReceiver(...args) {
             return;
         }
     }
-    catch (_) {
+    catch {
         // proceed to log error
     }
     logDebug('[Push Receiver]');

package/package.json

@@ -1,48 +1,68 @@
 {
   "name": "ring-client-api",
-  "version": "14.3.0",
+  "version": "15.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",
-    "./util": "./lib/util.js",
-    "./rest-client": "./lib/rest-client.js",
-    "./streaming/streaming-session": "./lib/streaming/streaming-session.js"
+    ".": {
+      "types": "./lib/index.d.ts",
+      "ring-dev": "./index.ts",
+      "default": "./lib/index.js"
+    },
+    "./ffmpeg": {
+      "types": "./lib/ffmpeg.d.ts",
+      "ring-dev": "./ffmpeg.ts",
+      "default": "./lib/ffmpeg.js"
+    },
+    "./util": {
+      "types": "./lib/util.d.ts",
+      "ring-dev": "./util.ts",
+      "default": "./lib/util.js"
+    },
+    "./rest-client": {
+      "types": "./lib/rest-client.d.ts",
+      "ring-dev": "./rest-client.ts",
+      "default": "./lib/rest-client.js"
+    },
+    "./streaming/streaming-session": {
+      "types": "./lib/streaming/streaming-session.d.ts",
+      "ring-dev": "./streaming/streaming-session.ts",
+      "default": "./lib/streaming/streaming-session.js"
+    }
   },
   "scripts": {
     "build": "rm -rf lib && tsc --declaration && chmod +x ./lib/ring-*-cli.js && rm -rf ./lib/test",
-    "dev": "tsc --declaration --watch --preserveWatchOutput",
+    "auth-cli": "node --conditions=ring-dev --env-file-if-exists=../../.env ./ring-auth-cli.ts",
+    "device-data-cli": "node --conditions=ring-dev --env-file-if-exists=../../.env ./ring-device-data-cli.ts",
     "lint": "eslint .",
     "test": "vitest run"
   },
   "dependencies": {
-    "@eneris/push-receiver": "4.3.0",
+    "@eneris/push-receiver": "4.4.0",
     "@homebridge/camera-utils": "^3.0.0",
     "colors": "1.4.0",
     "debug": "^4.4.3",
     "json-bigint": "^1.0.0",
     "rxjs": "^7.8.2",
-    "systeminformation": "^5.30.7",
-    "undici": "^7.19.2",
-    "uuid": "^13.0.0",
-    "werift": "0.22.4"
+    "systeminformation": "^5.33.19",
+    "undici": "^8.12.3",
+    "uuid": "^14.0.3",
+    "werift": "0.26.0"
   },
   "devDependencies": {
-    "@types/debug": "4.1.12",
+    "@types/debug": "4.1.13",
     "@types/json-bigint": "^1.0.4",
-    "@types/node": "25.1.0",
-    "@types/uuid": "11.0.0",
-    "@types/ws": "^8.18.1",
+    "@types/node": "26.6.6",
+    "@types/ws": "^8.18.2",
     "eslint-config-shared": "*",
-    "msw": "^2.12.7",
+    "msw": "^3.0.3",
     "tsconfig": "*",
-    "typescript": "5.9.3",
-    "vitest": "^4.0.18"
+    "typescript": "7.0.2",
+    "vitest": "^5.1.0"
   },
   "engines": {
-    "node": "^20 || ^22 || ^24"
+    "node": "^22.19.0 || ^24 || ^26"
   },
   "repository": {
     "type": "git",