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

package/lib/ring-types.js

@@ -1,112 +1,105 @@
-// eslint-disable-next-line no-shadow
-export var RingDeviceType;
-(function (RingDeviceType) {
-    RingDeviceType["BaseStation"] = "hub.redsky";
-    RingDeviceType["BaseStationPro"] = "hub.kili";
-    RingDeviceType["Keypad"] = "security-keypad";
-    RingDeviceType["SecurityPanel"] = "security-panel";
-    RingDeviceType["ContactSensor"] = "sensor.contact";
-    RingDeviceType["MotionSensor"] = "sensor.motion";
-    RingDeviceType["FloodFreezeSensor"] = "sensor.flood-freeze";
-    RingDeviceType["FreezeSensor"] = "sensor.freeze";
-    RingDeviceType["TemperatureSensor"] = "sensor.temperature";
-    RingDeviceType["WaterSensor"] = "sensor.water";
-    RingDeviceType["TiltSensor"] = "sensor.tilt";
-    RingDeviceType["GlassbreakSensor"] = "sensor.glassbreak";
-    RingDeviceType["RangeExtender"] = "range-extender.zwave";
-    RingDeviceType["ZigbeeAdapter"] = "adapter.zigbee";
-    RingDeviceType["AccessCodeVault"] = "access-code.vault";
-    RingDeviceType["AccessCode"] = "access-code";
-    RingDeviceType["SmokeAlarm"] = "alarm.smoke";
-    RingDeviceType["CoAlarm"] = "alarm.co";
-    RingDeviceType["SmokeCoListener"] = "listener.smoke-co";
-    RingDeviceType["MultiLevelSwitch"] = "switch.multilevel";
-    RingDeviceType["Fan"] = "switch.multilevel";
-    RingDeviceType["MultiLevelBulb"] = "switch.multilevel.bulb";
-    RingDeviceType["Switch"] = "switch";
-    RingDeviceType["BeamsMotionSensor"] = "motion-sensor.beams";
-    RingDeviceType["BeamsSwitch"] = "switch.beams";
-    RingDeviceType["BeamsMultiLevelSwitch"] = "switch.multilevel.beams";
-    RingDeviceType["BeamsLightGroupSwitch"] = "group.light-group.beams";
-    RingDeviceType["BeamsTransformerSwitch"] = "switch.transformer.beams";
-    RingDeviceType["BeamsDevice"] = "device.beams";
-    RingDeviceType["RetrofitBridge"] = "bridge.flatline";
-    RingDeviceType["RetrofitZone"] = "sensor.zone";
-    RingDeviceType["Thermostat"] = "temperature-control.thermostat";
-    RingDeviceType["Sensor"] = "sensor";
-    RingDeviceType["RingNetAdapter"] = "adapter.ringnet";
-    RingDeviceType["CodeVault"] = "access-code.vault";
-    RingDeviceType["SecurityAccessCode"] = "access-code";
-    RingDeviceType["ZWaveAdapter"] = "adapter.zwave";
-    RingDeviceType["ZWaveExtender"] = "range-extender.zwave";
-    RingDeviceType["PanicButton"] = "security-panic";
-    RingDeviceType["UnknownZWave"] = "unknown.zwave";
-    RingDeviceType["OnvifCamera"] = "onvif_camera";
-    RingDeviceType["ThirdPartyGarageDoorOpener"] = "third_party_gdo";
-    RingDeviceType["IntercomHandsetAudio"] = "intercom_handset_audio";
-    RingDeviceType["WaterValve"] = "valve.water";
-})(RingDeviceType || (RingDeviceType = {}));
-// eslint-disable-next-line no-shadow
-export var RingDeviceCategory;
-(function (RingDeviceCategory) {
-    RingDeviceCategory[RingDeviceCategory["Outlets"] = 1] = "Outlets";
-    RingDeviceCategory[RingDeviceCategory["Lights"] = 2] = "Lights";
-    RingDeviceCategory[RingDeviceCategory["Sensors"] = 5] = "Sensors";
-    RingDeviceCategory[RingDeviceCategory["Appliances"] = 7] = "Appliances";
-    RingDeviceCategory[RingDeviceCategory["Locks"] = 10] = "Locks";
-    RingDeviceCategory[RingDeviceCategory["Thermostats"] = 11] = "Thermostats";
-    RingDeviceCategory[RingDeviceCategory["Cameras"] = 12] = "Cameras";
-    RingDeviceCategory[RingDeviceCategory["Alarms"] = 15] = "Alarms";
-    RingDeviceCategory[RingDeviceCategory["Fans"] = 17] = "Fans";
-    RingDeviceCategory[RingDeviceCategory["Security"] = 22] = "Security";
-    RingDeviceCategory[RingDeviceCategory["Unknown"] = 29] = "Unknown";
-    RingDeviceCategory[RingDeviceCategory["SensorsMotion"] = 30] = "SensorsMotion";
-    RingDeviceCategory[RingDeviceCategory["Controller"] = 31] = "Controller";
-    RingDeviceCategory[RingDeviceCategory["RangeExtenders"] = 32] = "RangeExtenders";
-    RingDeviceCategory[RingDeviceCategory["Keypads"] = 33] = "Keypads";
-    RingDeviceCategory[RingDeviceCategory["Sirens"] = 34] = "Sirens";
-    RingDeviceCategory[RingDeviceCategory["PanicButtons"] = 35] = "PanicButtons";
-    RingDeviceCategory[RingDeviceCategory["WaterValves"] = 37] = "WaterValves";
-})(RingDeviceCategory || (RingDeviceCategory = {}));
-// eslint-disable-next-line no-shadow
-export var RingCameraKind;
-(function (RingCameraKind) {
-    RingCameraKind["doorbot"] = "doorbot";
-    RingCameraKind["doorbell"] = "doorbell";
-    RingCameraKind["doorbell_v3"] = "doorbell_v3";
-    RingCameraKind["doorbell_v4"] = "doorbell_v4";
-    RingCameraKind["doorbell_v5"] = "doorbell_v5";
-    RingCameraKind["doorbell_oyster"] = "doorbell_oyster";
-    RingCameraKind["doorbell_portal"] = "doorbell_portal";
-    RingCameraKind["doorbell_scallop"] = "doorbell_scallop";
-    RingCameraKind["doorbell_scallop_lite"] = "doorbell_scallop_lite";
-    RingCameraKind["doorbell_graham_cracker"] = "doorbell_graham_cracker";
-    RingCameraKind["lpd_v1"] = "lpd_v1";
-    RingCameraKind["lpd_v2"] = "lpd_v2";
-    RingCameraKind["lpd_v4"] = "lpd_v4";
-    RingCameraKind["jbox_v1"] = "jbox_v1";
-    RingCameraKind["stickup_cam"] = "stickup_cam";
-    RingCameraKind["stickup_cam_v3"] = "stickup_cam_v3";
-    RingCameraKind["stickup_cam_elite"] = "stickup_cam_elite";
-    RingCameraKind["stickup_cam_longfin"] = "stickup_cam_longfin";
-    RingCameraKind["stickup_cam_lunar"] = "stickup_cam_lunar";
-    RingCameraKind["spotlightw_v2"] = "spotlightw_v2";
-    RingCameraKind["hp_cam_v1"] = "hp_cam_v1";
-    RingCameraKind["hp_cam_v2"] = "hp_cam_v2";
-    RingCameraKind["stickup_cam_v4"] = "stickup_cam_v4";
-    RingCameraKind["floodlight_v1"] = "floodlight_v1";
-    RingCameraKind["floodlight_v2"] = "floodlight_v2";
-    RingCameraKind["floodlight_pro"] = "floodlight_pro";
-    RingCameraKind["cocoa_camera"] = "cocoa_camera";
-    RingCameraKind["cocoa_doorbell"] = "cocoa_doorbell";
-    RingCameraKind["cocoa_doorbell_v2"] = "cocoa_doorbell_v2";
-    RingCameraKind["cocoa_doorbell_v3"] = "cocoa_doorbell_v3";
-    RingCameraKind["cocoa_floodlight"] = "cocoa_floodlight";
-    RingCameraKind["cocoa_spotlight"] = "cocoa_spotlight";
-    RingCameraKind["stickup_cam_mini"] = "stickup_cam_mini";
-    RingCameraKind["onvif_camera"] = "onvif_camera";
-})(RingCameraKind || (RingCameraKind = {}));
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export const RingDeviceType = {
+    BaseStation: 'hub.redsky',
+    BaseStationPro: 'hub.kili',
+    Keypad: 'security-keypad',
+    SecurityPanel: 'security-panel',
+    ContactSensor: 'sensor.contact',
+    MotionSensor: 'sensor.motion',
+    FloodFreezeSensor: 'sensor.flood-freeze',
+    FreezeSensor: 'sensor.freeze',
+    TemperatureSensor: 'sensor.temperature',
+    WaterSensor: 'sensor.water',
+    TiltSensor: 'sensor.tilt',
+    GlassbreakSensor: 'sensor.glassbreak',
+    RangeExtender: 'range-extender.zwave',
+    ZigbeeAdapter: 'adapter.zigbee',
+    AccessCodeVault: 'access-code.vault',
+    AccessCode: 'access-code',
+    SmokeAlarm: 'alarm.smoke',
+    CoAlarm: 'alarm.co',
+    SmokeCoListener: 'listener.smoke-co',
+    MultiLevelSwitch: 'switch.multilevel',
+    Fan: 'switch.multilevel',
+    MultiLevelBulb: 'switch.multilevel.bulb',
+    Switch: 'switch',
+    BeamsMotionSensor: 'motion-sensor.beams',
+    BeamsSwitch: 'switch.beams',
+    BeamsMultiLevelSwitch: 'switch.multilevel.beams',
+    BeamsLightGroupSwitch: 'group.light-group.beams',
+    BeamsTransformerSwitch: 'switch.transformer.beams',
+    BeamsDevice: 'device.beams',
+    RetrofitBridge: 'bridge.flatline',
+    RetrofitZone: 'sensor.zone',
+    Thermostat: 'temperature-control.thermostat',
+    Sensor: 'sensor',
+    RingNetAdapter: 'adapter.ringnet',
+    CodeVault: 'access-code.vault',
+    SecurityAccessCode: 'access-code',
+    ZWaveAdapter: 'adapter.zwave',
+    ZWaveExtender: 'range-extender.zwave',
+    PanicButton: 'security-panic',
+    UnknownZWave: 'unknown.zwave',
+    OnvifCamera: 'onvif_camera',
+    ThirdPartyGarageDoorOpener: 'third_party_gdo',
+    IntercomHandsetAudio: 'intercom_handset_audio',
+    WaterValve: 'valve.water',
+};
+export const RingDeviceCategory = {
+    Outlets: 1,
+    Lights: 2,
+    Sensors: 5,
+    Appliances: 7,
+    Locks: 10,
+    Thermostats: 11,
+    Cameras: 12,
+    Alarms: 15,
+    Fans: 17,
+    Security: 22,
+    Unknown: 29,
+    SensorsMotion: 30,
+    Controller: 31,
+    RangeExtenders: 32,
+    Keypads: 33,
+    Sirens: 34,
+    PanicButtons: 35,
+    WaterValves: 37,
+};
+export const RingCameraKind = {
+    doorbot: 'doorbot',
+    doorbell: 'doorbell',
+    doorbell_v3: 'doorbell_v3',
+    doorbell_v4: 'doorbell_v4',
+    doorbell_v5: 'doorbell_v5',
+    doorbell_oyster: 'doorbell_oyster', // used for the Ring Video Doorbell 4
+    doorbell_portal: 'doorbell_portal',
+    doorbell_scallop: 'doorbell_scallop',
+    doorbell_scallop_lite: 'doorbell_scallop_lite',
+    doorbell_graham_cracker: 'doorbell_graham_cracker',
+    lpd_v1: 'lpd_v1',
+    lpd_v2: 'lpd_v2',
+    lpd_v4: 'lpd_v4',
+    jbox_v1: 'jbox_v1',
+    stickup_cam: 'stickup_cam',
+    stickup_cam_v3: 'stickup_cam_v3',
+    stickup_cam_elite: 'stickup_cam_elite',
+    stickup_cam_longfin: 'stickup_cam_longfin',
+    stickup_cam_lunar: 'stickup_cam_lunar',
+    spotlightw_v2: 'spotlightw_v2',
+    hp_cam_v1: 'hp_cam_v1',
+    hp_cam_v2: 'hp_cam_v2',
+    stickup_cam_v4: 'stickup_cam_v4',
+    floodlight_v1: 'floodlight_v1',
+    floodlight_v2: 'floodlight_v2',
+    floodlight_pro: 'floodlight_pro',
+    cocoa_camera: 'cocoa_camera', // appears to be used for all next gen stickup cams (wired/battery/solar)
+    cocoa_doorbell: 'cocoa_doorbell',
+    cocoa_doorbell_v2: 'cocoa_doorbell_v2',
+    cocoa_doorbell_v3: 'cocoa_doorbell_v3',
+    cocoa_floodlight: 'cocoa_floodlight',
+    cocoa_spotlight: 'cocoa_spotlight', // used for the Spotlight Cam Plus (potentially other Spotlight models)
+    stickup_cam_mini: 'stickup_cam_mini',
+    onvif_camera: 'onvif_camera',
+};
 export const RingCameraModel = {
     doorbot: 'Doorbell',
     doorbell: 'Doorbell',
@@ -158,49 +151,40 @@ export const deviceTypesWithVolume = [
     RingDeviceType.BaseStation,
     RingDeviceType.Keypad,
 ];
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
 export const ChimeModel = {
     chime: 'Chime',
     chime_pro: 'Chime Pro',
     chime_v2: 'Chime v2',
     chime_pro_v2: 'Chime Pro v2',
 };
-// eslint-disable-next-line no-shadow
-export var DoorbellType;
-(function (DoorbellType) {
-    DoorbellType[DoorbellType["Mechanical"] = 0] = "Mechanical";
-    DoorbellType[DoorbellType["Digital"] = 1] = "Digital";
-    DoorbellType[DoorbellType["None"] = 2] = "None";
-})(DoorbellType || (DoorbellType = {}));
-// eslint-disable-next-line no-shadow
-export var NotificationDetectionType;
-(function (NotificationDetectionType) {
+export const DoorbellType = {
+    Mechanical: 0,
+    Digital: 1,
+    None: 2,
+};
+export const 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 || (NotificationDetectionType = {}));
-// eslint-disable-next-line no-shadow
-export var PushNotificationAction;
-(function (PushNotificationAction) {
-    PushNotificationAction["Ding"] = "com.ring.pn.live-event.ding";
-    PushNotificationAction["Motion"] = "com.ring.pn.live-event.motion";
-    PushNotificationAction["IntercomDing"] = "com.ring.pn.live-event.intercom";
-    PushNotificationAction["IntercomUnlock"] = "com.ring.push.INTERCOM_UNLOCK_FROM_APP";
-    PushNotificationAction["AlarmModeNone"] = "com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_NONE_NOTICE";
-    PushNotificationAction["AlarmModeSome"] = "com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_SOME_NOTICE";
-    PushNotificationAction["AlarmSoundSiren"] = "com.ring.push.HANDLE_NEW_USER_SOUND_SIREN";
-    PushNotificationAction["AlarmSilenceSiren"] = "com.ring.push.HANDLE_NEW_NON_ALARM_SIREN_SILENCED";
-})(PushNotificationAction || (PushNotificationAction = {}));
-// eslint-disable-next-line no-shadow
-export var DispatchSignalType;
-(function (DispatchSignalType) {
-    DispatchSignalType["Burglar"] = "user-verified-burglar-xa";
-    DispatchSignalType["Fire"] = "user-verified-fire-xa";
-})(DispatchSignalType || (DispatchSignalType = {}));
+    Human: 'human',
+    Loitering: 'loitering',
+    Motion: 'motion',
+    OtherMotion: 'other_motion',
+    NotAvailable: 'null',
+    StreamBroken: 'stream_broken',
+};
+export const PushNotificationAction = {
+    Ding: 'com.ring.pn.live-event.ding',
+    Motion: 'com.ring.pn.live-event.motion',
+    IntercomDing: 'com.ring.pn.live-event.intercom',
+    IntercomUnlock: 'com.ring.push.INTERCOM_UNLOCK_FROM_APP',
+    AlarmModeNone: 'com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_NONE_NOTICE',
+    AlarmModeSome: 'com.ring.push.HANDLE_NEW_SECURITY_PANEL_MODE_SOME_NOTICE',
+    AlarmSoundSiren: 'com.ring.push.HANDLE_NEW_USER_SOUND_SIREN',
+    AlarmSilenceSiren: 'com.ring.push.HANDLE_NEW_NON_ALARM_SIREN_SILENCED',
+};
+export const DispatchSignalType = {
+    Burglar: 'user-verified-burglar-xa',
+    Fire: 'user-verified-fire-xa',
+};
 export const disabledLocationModes = ['disabled', 'unset'];
 export function isWebSocketSupportedAsset({ kind }) {
     return kind.startsWith('base_station') || kind.startsWith('beams_bridge');

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

@@ -1,9 +1,9 @@
 import type { RingCamera } from '../ring-camera.ts';
 import type { RingRestClient } from '../rest-client.ts';
 export declare class SimpleWebRtcSession {
+    readonly sessionId: string;
     private readonly camera;
     private restClient;
-    readonly sessionId: string;
     constructor(camera: RingCamera, restClient: RingRestClient);
     start(sdp: string): Promise<string>;
     end(): Promise<any>;

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

@@ -3,9 +3,9 @@ function liveViewUrl(path) {
     return `https://api.ring.com/integrations/v1/liveview/${path}`;
 }
 export class SimpleWebRtcSession {
+    sessionId = generateUuid();
     camera;
     restClient;
-    sessionId = generateUuid();
     constructor(camera, restClient) {
         this.camera = camera;
         this.restClient = restClient;

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

@@ -46,11 +46,12 @@ interface StreamInfoMessage {
         transcoding_reason: 'codec_mismatch' | string;
     };
 }
-declare enum CloseReasonCode {
-    NormalClose = 0,
-    AuthenticationFailed = 5,
-    Timeout = 6
-}
+declare const CloseReasonCode: {
+    readonly NormalClose: 0;
+    readonly AuthenticationFailed: 5;
+    readonly Timeout: 6;
+};
+type CloseReasonCode = (typeof CloseReasonCode)[keyof typeof CloseReasonCode];
 interface CloseMessage {
     method: 'close';
     body: {

package/lib/streaming/streaming-messages.js

@@ -1,12 +1,10 @@
-// eslint-disable-next-line no-shadow
-var CloseReasonCode;
-(function (CloseReasonCode) {
-    CloseReasonCode[CloseReasonCode["NormalClose"] = 0] = "NormalClose";
+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' }
-    CloseReasonCode[CloseReasonCode["AuthenticationFailed"] = 5] = "AuthenticationFailed";
+    AuthenticationFailed: 5,
     // reason: { code: 6, text: 'Timeout waiting for ping' }
-    CloseReasonCode[CloseReasonCode["Timeout"] = 6] = "Timeout";
-})(CloseReasonCode || (CloseReasonCode = {}));
+    Timeout: 6,
+};
 export {};

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

@@ -12,8 +12,6 @@ export interface FfmpegOptions {
     output: SpawnInput[];
 }
 export declare class StreamingSession extends Subscribed {
-    private readonly camera;
-    private connection;
     readonly onCallEnded: ReplaySubject<void>;
     private readonly onUsingOpus;
     readonly onVideoRtp: Subject<RtpPacket>;
@@ -21,6 +19,8 @@ export declare class StreamingSession extends Subscribed {
     private readonly audioSplitter;
     private readonly videoSplitter;
     private readonly returnAudioSplitter;
+    private readonly camera;
+    private connection;
     constructor(camera: RingCamera, connection: WebrtcConnection);
     private bindToConnection;
     /**

package/lib/streaming/streaming-session.js

@@ -14,8 +14,6 @@ function getCleanSdp(sdp, includeVideo) {
         .join('\n');
 }
 export class StreamingSession extends Subscribed {
-    camera;
-    connection;
     onCallEnded = new ReplaySubject(1);
     onUsingOpus = new ReplaySubject(1);
     onVideoRtp = new Subject();
@@ -23,6 +21,8 @@ export class StreamingSession extends Subscribed {
     audioSplitter = new RtpSplitter();
     videoSplitter = new RtpSplitter();
     returnAudioSplitter = new RtpSplitter();
+    camera;
+    connection;
     constructor(camera, connection) {
         super();
         this.camera = camera;

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

@@ -7,7 +7,6 @@ export interface StreamingConnectionOptions {
     createPeerConnection?: () => BasicPeerConnection;
 }
 export declare class WebrtcConnection extends Subscribed {
-    private camera;
     private readonly onSessionId;
     private readonly onOfferSent;
     private readonly dialogId;
@@ -23,6 +22,7 @@ export declare class WebrtcConnection extends Subscribed {
     readonly onVideoRtp: Subject<RtpPacket>;
     private readonly pc;
     private readonly ws;
+    private camera;
     constructor(ticket: string, camera: RingCamera, options: StreamingConnectionOptions);
     private initiateCall;
     private sessionId;

package/lib/streaming/webrtc-connection.js

@@ -5,7 +5,6 @@ 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 ReplaySubject(1);
     onOfferSent = new ReplaySubject(1);
     dialogId = generateUuid();
@@ -19,6 +18,7 @@ export class WebrtcConnection extends Subscribed {
     onVideoRtp;
     pc;
     ws;
+    camera;
     constructor(ticket, camera, options) {
         super();
         this.camera = camera;

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

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