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

package/lib/api.d.ts

@@ -18,12 +18,12 @@ export interface RingApiOptions extends SessionOptions {
     };
 }
 export declare class RingApi extends Subscribed {
-    readonly options: RingApiOptions & RefreshTokenAuth;
     readonly restClient: RingRestClient;
     readonly onRefreshTokenUpdated: import("rxjs").Observable<{
         oldRefreshToken?: string;
         newRefreshToken: string;
     }>;
+    readonly options: RingApiOptions & RefreshTokenAuth;
     constructor(options: RingApiOptions & RefreshTokenAuth);
     fetchRingDevices(): Promise<{
         doorbots: CameraData[];

package/lib/api.js

@@ -12,9 +12,9 @@ import { PushReceiver } from '@eneris/push-receiver';
 import { RingIntercom } from "./ring-intercom.js";
 import JSONbig from 'json-bigint';
 export class RingApi extends Subscribed {
-    options;
     restClient;
     onRefreshTokenUpdated;
+    options;
     constructor(options) {
         super();
         this.options = options;

package/lib/location.d.ts

@@ -1,5 +1,5 @@
-import type { Socket as SocketIOSocket } from 'socket.io-client';
 import type { Observable } from 'rxjs';
+import { WebSocket } from 'undici';
 import { BehaviorSubject, ReplaySubject, Subject } from 'rxjs';
 import type { AccountMonitoringStatus, AlarmMode, AssetSession, MessageDataType, MessageType, RingDeviceData, SocketIoMessage, TicketAsset, UserLocation, CameraEventResponse, CameraEventOptions, HistoryOptions, RingDeviceHistoryEvent, LocationModeResponse, LocationModeSettings, LocationMode, LocationModeSharing, LocationModeSettingsResponse, LocationModeInput } from './ring-types.ts';
 import type { RingRestClient } from './rest-client.ts';
@@ -9,16 +9,6 @@ import { RingDevice } from './ring-device.ts';
 import type { RingIntercom } from './ring-intercom.ts';
 import { Subscribed } from './subscribed.ts';
 export declare class Location extends Subscribed {
-    readonly locationDetails: UserLocation;
-    readonly cameras: RingCamera[];
-    readonly chimes: RingChime[];
-    readonly intercoms: RingIntercom[];
-    readonly options: {
-        hasHubs: boolean;
-        hasAlarmBaseStation: boolean;
-        locationModePollingSeconds?: number;
-    };
-    private restClient;
     private seq;
     onMessage: Subject<SocketIoMessage>;
     onDataUpdate: Subject<SocketIoMessage>;
@@ -31,13 +21,23 @@ export declare class Location extends Subscribed {
     private onLocationModeRequested;
     reconnecting: boolean;
     private disconnected;
-    connectionPromise?: Promise<typeof SocketIOSocket>;
+    connectionPromise?: Promise<WebSocket>;
     securityPanel?: RingDevice;
     assets?: TicketAsset[];
     receivedAssetDeviceLists: string[];
     offlineAssets: string[];
     hasHubs: boolean;
     hasAlarmBaseStation: boolean;
+    readonly locationDetails: UserLocation;
+    readonly cameras: RingCamera[];
+    readonly chimes: RingChime[];
+    readonly intercoms: RingIntercom[];
+    readonly options: {
+        hasHubs: boolean;
+        hasAlarmBaseStation: boolean;
+        locationModePollingSeconds?: number;
+    };
+    private restClient;
     constructor(locationDetails: UserLocation, cameras: RingCamera[], chimes: RingChime[], intercoms: RingIntercom[], options: {
         hasHubs: boolean;
         hasAlarmBaseStation: boolean;
@@ -46,8 +46,8 @@ export declare class Location extends Subscribed {
     get id(): string;
     get locationId(): string;
     get name(): string;
-    createConnection(): Promise<typeof SocketIOSocket>;
-    getConnection(): Promise<SocketIOClient.Socket>;
+    createConnection(): Promise<WebSocket>;
+    getConnection(): Promise<WebSocket>;
     sendMessage(message: {
         msg: MessageType;
         datatype?: MessageDataType;

package/lib/location.js

@@ -1,4 +1,4 @@
-import { connect as connectSocketIo } from 'socket.io-client';
+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";
@@ -12,12 +12,6 @@ function flattenDeviceData(data) {
     return Object.assign({}, data.general && data.general.v2, data.device && data.device.v1);
 }
 export class Location extends Subscribed {
-    locationDetails;
-    cameras;
-    chimes;
-    intercoms;
-    options;
-    restClient;
     seq = 1;
     onMessage = new Subject();
     onDataUpdate = new Subject();
@@ -57,6 +51,12 @@ export class Location extends Subscribed {
     offlineAssets = [];
     hasHubs;
     hasAlarmBaseStation;
+    locationDetails;
+    cameras;
+    chimes;
+    intercoms;
+    options;
+    restClient;
     constructor(locationDetails, cameras, chimes, intercoms, options, restClient) {
         super();
         this.locationDetails = locationDetails;
@@ -80,7 +80,6 @@ export class Location extends Subscribed {
                 }
                 if (connectionStatus === 'online') {
                     if (assetWasOffline) {
-                        // eslint-disable-next-line @typescript-eslint/no-empty-function
                         this.requestList(deviceListMessageType, assetUuid).catch(() => { });
                         this.offlineAssets = this.offlineAssets.filter((id) => id !== assetUuid);
                         logInfo(`Ring ${asset.kind} ${assetUuid} has come back online`);
@@ -117,7 +116,7 @@ export class Location extends Subscribed {
             logError('Node 15 is not currently supported by the Ring client. Please install the latest Node 14 instead. May not be able to fetch devices from Ring Alarm and Smart Lighting Hubs on this version of node.');
         }
         const { assets, ticket, host } = await this.restClient.request({
-            url: appApi('clap/tickets?locationID=' + this.id),
+            url: appApi(`clap/tickets?locationID=${this.id}&enableExtendedEmergencyCellUsage=true&requestedTransport=ws`),
         }), supportedAssets = assets.filter(isWebSocketSupportedAsset);
         this.assets = supportedAssets;
         this.receivedAssetDeviceLists.length = 0;
@@ -127,7 +126,7 @@ export class Location extends Subscribed {
             logError(errorMessage);
             throw new Error(errorMessage);
         }
-        const connection = connectSocketIo(`wss://${host}/?authcode=${ticket}&ack=false&EIO=3`, { transports: ['websocket'] }), reconnect = () => {
+        const url = `wss://${host}/ws?authcode=${ticket}&ack=false`, socket = new WebSocket(url), reconnect = () => {
             if (this.reconnecting && this.connectionPromise) {
                 return this.connectionPromise;
             }
@@ -136,30 +135,44 @@ export class Location extends Subscribed {
                 logInfo('Reconnecting location socket.io connection');
             }
             this.reconnecting = true;
-            connection.close();
+            socket.close();
             return (this.connectionPromise = delay(1000).then(() => {
                 return this.createConnection();
             }));
         };
-        this.reconnecting = false;
-        connection.on('DataUpdate', (message) => {
-            if (message.datatype === 'HubDisconnectionEventType') {
-                logInfo('Location connection told to reconnect');
-                return reconnect();
+        socket.addEventListener('message', (event) => {
+            try {
+                const { msg: message, channel } = JSON.parse(event.data);
+                this.onMessage.next(message);
+                if (message.datatype === 'HubDisconnectionEventType') {
+                    logInfo('Location connection told to reconnect');
+                    return reconnect();
+                }
+                if (channel === 'DataUpdate') {
+                    this.onDataUpdate.next(message);
+                }
+            }
+            catch (e) {
+                logError('Error parsing message from server: ' + event.data);
             }
-            this.onDataUpdate.next(message);
         });
-        connection.on('message', (message) => this.onMessage.next(message));
-        connection.on('error', reconnect);
-        connection.on('disconnect', reconnect);
+        socket.addEventListener('error', (error) => {
+            logDebug('WebSocket error: ' + error);
+            return reconnect();
+        });
+        socket.addEventListener('close', (event) => {
+            logDebug(`WebSocket connection closed: ${event.code}, ${event.reason}`);
+            return reconnect();
+        });
+        this.reconnecting = false;
         return new Promise((resolve, reject) => {
-            connection.once('connect', () => {
-                resolve(connection);
+            socket.addEventListener('open', () => {
+                resolve(socket);
                 this.onConnected.next(true);
                 logInfo('Ring connected to socket.io server');
                 assets.forEach((asset) => this.requestList(deviceListMessageType, asset.uuid));
-            });
-            connection.once('error', reject);
+            }, { once: true });
+            socket.addEventListener('error', reject, { once: true });
         }).catch(reconnect);
     }
     getConnection() {
@@ -174,7 +187,10 @@ export class Location extends Subscribed {
     async sendMessage(message) {
         const connection = await this.getConnection();
         message.seq = this.seq++;
-        connection.emit('message', message);
+        connection.send(JSON.stringify({
+            channel: 'message',
+            msg: message,
+        }));
     }
     async sendCommandToSecurityPanel(commandType, data) {
         const securityPanel = await this.getSecurityPanel();

package/lib/refresh-token.js

@@ -27,5 +27,4 @@ export async function logRefreshToken() {
     console.log('\nSuccessfully logged in to Ring. Please add the following to your config:\n');
     console.log(`"refreshToken": "${refreshToken}"`);
 }
-// eslint-disable-next-line @typescript-eslint/no-empty-function
 process.on('unhandledRejection', () => { });

package/lib/rest-client.d.ts

@@ -29,7 +29,6 @@ export interface SessionOptions {
     controlCenterDisplayName?: string;
 }
 export declare class RingRestClient {
-    private authOptions;
     refreshToken: string | undefined;
     private authConfig;
     private hardwareIdPromise;
@@ -49,6 +48,7 @@ export declare class RingRestClient {
         api_version: number;
         device_model: string;
     };
+    private authOptions;
     constructor(authOptions: (EmailAuth | RefreshTokenAuth) & SessionOptions);
     private getGrantData;
     getAuth(twoFactorAuthCode?: string): Promise<AuthTokenResponse>;

package/lib/rest-client.js

@@ -142,7 +142,6 @@ function parseAuthConfig(rawRefreshToken) {
     }
 }
 export class RingRestClient {
-    authOptions;
     refreshToken;
     authConfig;
     hardwareIdPromise;
@@ -177,6 +176,7 @@ export class RingRestClient {
     onRefreshTokenUpdated = new ReplaySubject(1);
     onSession = new ReplaySubject(1);
     baseSessionMetadata;
+    authOptions;
     constructor(authOptions) {
         this.authOptions = authOptions;
         this.refreshToken =

package/lib/ring-camera.d.ts

@@ -17,12 +17,8 @@ export declare function getSearchQueryString(options: CameraEventOptions | (Hist
 })): string;
 export declare function cleanSnapshotUuid(uuid?: string | null): string | null | undefined;
 export declare class RingCamera extends Subscribed {
-    private initialData;
-    isDoorbot: boolean;
-    private restClient;
-    private avoidSnapshotBatteryDrain;
     id: number;
-    deviceType: RingCameraKind.onvif_camera | Omit<RingCameraKind, RingCameraKind.onvif_camera>;
+    deviceType: "onvif_camera" | Omit<RingCameraKind, "onvif_camera">;
     model: string;
     onData: BehaviorSubject<AnyCameraData>;
     hasLight: boolean;
@@ -35,6 +31,10 @@ export declare class RingCamera extends Subscribed {
     onMotionStarted: import("rxjs").Observable<null>;
     onBatteryLevel: import("rxjs").Observable<number | null>;
     onInHomeDoorbellStatus: import("rxjs").Observable<boolean>;
+    private initialData;
+    isDoorbot: boolean;
+    private restClient;
+    private avoidSnapshotBatteryDrain;
     constructor(initialData: AnyCameraData, isDoorbot: boolean, restClient: RingRestClient, avoidSnapshotBatteryDrain: boolean);
     updateData(update: AnyCameraData): void;
     requestUpdate(): void;

package/lib/ring-camera.js

@@ -64,12 +64,11 @@ export function cleanSnapshotUuid(uuid) {
 }
 const wiredModelsWithNoSnapshotDuringRecording = new Set([
     RingCameraKind.doorbell_graham_cracker,
+]), enabledDoorbellTypes = new Set([
+    DoorbellType.Mechanical,
+    DoorbellType.Digital,
 ]);
 export class RingCamera extends Subscribed {
-    initialData;
-    isDoorbot;
-    restClient;
-    avoidSnapshotBatteryDrain;
     id;
     deviceType;
     model;
@@ -91,6 +90,10 @@ export class RingCamera extends Subscribed {
     share());
     onBatteryLevel;
     onInHomeDoorbellStatus;
+    initialData;
+    isDoorbot;
+    restClient;
+    avoidSnapshotBatteryDrain;
     constructor(initialData, isDoorbot, restClient, avoidSnapshotBatteryDrain) {
         super();
         this.initialData = initialData;
@@ -188,8 +191,7 @@ export class RingCamera extends Subscribed {
     get hasInHomeDoorbell() {
         const { chime_settings } = this.data.settings;
         return (this.isDoorbot &&
-            Boolean(chime_settings &&
-                [DoorbellType.Mechanical, DoorbellType.Digital].includes(chime_settings.type)));
+            Boolean(chime_settings && enabledDoorbellTypes.has(chime_settings.type)));
     }
     doorbotUrl(path = '') {
         return clientApi(`doorbots/${this.id}/${path}`);

package/lib/ring-chime.d.ts

@@ -2,13 +2,13 @@ import type { ChimeData, ChimeUpdate, ChimeSoundKind, RingtoneOptions, ChimeHeal
 import type { RingRestClient } from './rest-client.ts';
 import { BehaviorSubject, Subject } from 'rxjs';
 export declare class RingChime {
-    private initialData;
-    private restClient;
     id: number;
     deviceType: import("./ring-types.ts").ChimeKind;
     model: string;
     onData: BehaviorSubject<ChimeData>;
     onRequestUpdate: Subject<unknown>;
+    private initialData;
+    private restClient;
     constructor(initialData: ChimeData, restClient: RingRestClient);
     updateData(update: ChimeData): void;
     requestUpdate(): void;

package/lib/ring-chime.js

@@ -8,18 +8,18 @@ const settingsWhichRequireReboot = [
     'motion_audio_user_id',
 ];
 export class RingChime {
-    initialData;
-    restClient;
     id;
     deviceType;
     model;
     onData;
     onRequestUpdate = new Subject();
+    initialData;
+    restClient;
     constructor(initialData, restClient) {
         this.initialData = initialData;
         this.restClient = restClient;
-        this.id = this.initialData.id;
-        this.deviceType = this.initialData.kind;
+        this.id = initialData.id;
+        this.deviceType = initialData.kind;
         this.model = ChimeModel[this.deviceType] || 'Chime';
         this.onData = new BehaviorSubject(this.initialData);
     }

package/lib/ring-device.d.ts

@@ -3,15 +3,15 @@ import type { RingDeviceData } from './ring-types.ts';
 import type { Location } from './location.ts';
 import { Subscribed } from './subscribed.ts';
 export declare class RingDevice extends Subscribed {
-    private initialData;
-    location: Location;
-    assetId: string;
     onData: BehaviorSubject<RingDeviceData>;
     zid: string;
     id: string;
     deviceType: import("./ring-types.ts").RingDeviceType;
     categoryId: number;
     onComponentDevices: import("rxjs").Observable<RingDevice[]>;
+    private initialData;
+    location: Location;
+    assetId: string;
     constructor(initialData: RingDeviceData, location: Location, assetId: string);
     updateData(update: Partial<RingDeviceData>): void;
     get data(): RingDeviceData;

package/lib/ring-device.js

@@ -4,22 +4,22 @@ import { filter, map } from 'rxjs/operators';
 import { Subscribed } from "./subscribed.js";
 import { logError } from "./util.js";
 export class RingDevice extends Subscribed {
-    initialData;
-    location;
-    assetId;
     onData;
     zid;
     id;
     deviceType;
     categoryId;
     onComponentDevices;
+    initialData;
+    location;
+    assetId;
     constructor(initialData, location, assetId) {
         super();
         this.initialData = initialData;
         this.location = location;
         this.assetId = assetId;
-        this.onData = new BehaviorSubject(this.initialData);
-        this.zid = this.initialData.zid;
+        this.onData = new BehaviorSubject(initialData);
+        this.zid = initialData.zid;
         this.id = this.zid;
         this.deviceType = this.initialData.deviceType;
         this.categoryId = this.initialData.categoryId;

package/lib/ring-intercom.d.ts

@@ -2,15 +2,15 @@ import type { IntercomHandsetAudioData, PushNotification } from './ring-types.ts
 import type { RingRestClient } from './rest-client.ts';
 import { BehaviorSubject, Subject } from 'rxjs';
 export declare class RingIntercom {
-    private initialData;
-    private restClient;
     id: number;
-    deviceType: import("./ring-types.ts").RingDeviceType.IntercomHandsetAudio;
+    deviceType: "intercom_handset_audio";
     onData: BehaviorSubject<IntercomHandsetAudioData>;
     onRequestUpdate: Subject<unknown>;
     onBatteryLevel: import("rxjs").Observable<number | null>;
     onDing: Subject<void>;
     onUnlocked: Subject<void>;
+    private initialData;
+    private restClient;
     constructor(initialData: IntercomHandsetAudioData, restClient: RingRestClient);
     updateData(update: IntercomHandsetAudioData): void;
     requestUpdate(): void;

package/lib/ring-intercom.js

@@ -5,8 +5,6 @@ import { distinctUntilChanged, map } from 'rxjs/operators';
 import { getBatteryLevel } from "./ring-camera.js";
 import { logError } from "./util.js";
 export class RingIntercom {
-    initialData;
-    restClient;
     id;
     deviceType;
     onData;
@@ -14,11 +12,13 @@ export class RingIntercom {
     onBatteryLevel;
     onDing = new Subject();
     onUnlocked = new Subject();
+    initialData;
+    restClient;
     constructor(initialData, restClient) {
         this.initialData = initialData;
         this.restClient = restClient;
-        this.id = this.initialData.id;
-        this.deviceType = this.initialData.kind;
+        this.id = initialData.id;
+        this.deviceType = initialData.kind;
         this.onData = new BehaviorSubject(this.initialData);
         this.onBatteryLevel = this.onData.pipe(map((data) => getBatteryLevel(data)), distinctUntilChanged());
         if (!initialData.subscribed) {