ring-client-api 10.0.0-beta.6 → 10.0.0

package/CHANGELOG.md

@@ -2,6 +2,40 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [10.0.0](https://github.com/dgreif/ring/compare/v10.0.0-beta.8...v10.0.0) (2022-05-08)
+
+
+### Bug Fixes
+
+* prevent push receiver ECONNRESET error from logging ([644e86d](https://github.com/dgreif/ring/commit/644e86d6517e73391139b12bac4dc048c8bedf13))
+
+## [10.0.0-beta.8](https://github.com/dgreif/ring/compare/v10.0.0-beta.7...v10.0.0-beta.8) (2022-05-07)
+
+
+### Bug Fixes
+
+* remove unnecessary dependencies ([0acf3c3](https://github.com/dgreif/ring/commit/0acf3c35ce2b62d98e3e50ba8489996400efb4e3))
+
+## [10.0.0-beta.7](https://github.com/dgreif/ring/compare/v10.0.0-beta.6...v10.0.0-beta.7) (2022-05-07)
+
+
+### ⚠ BREAKING CHANGES
+
+* The `sendDoorbellMotionNotificationsToTv` and `sendCameraMotionNotificationsToTv` options have been removed.  These options were originally inteded as a workaround for the fact that tvOS would only automatically start streaming for doorbell presses and not for motion events.  tvOS 15 now supports this features as an option in the UI, so we no longer need this option at the plugin level.
+
+### Features
+
+* add `cocoa_floodlight` ([c7a7e9c](https://github.com/dgreif/ring/commit/c7a7e9cabf45ec6579a7d9a1033fa01930923243)), closes [#893](https://github.com/dgreif/ring/issues/893)
+* **api:** simple webrtc session ([bac7a49](https://github.com/dgreif/ring/commit/bac7a49178bb5a22914e53fda91c0fdd522b4a74))
+
+
+### Bug Fixes
+
+* **homebridge:** add `name` option to schema so that it won't be removed by config-ui ([af6755a](https://github.com/dgreif/ring/commit/af6755aa09cf4aaad0963499ad0d1afd0beeab96)), closes [#870](https://github.com/dgreif/ring/issues/870)
+* include device name when setting push token ([2466a25](https://github.com/dgreif/ring/commit/2466a2519341771d8c79557b5a61c339f31eddf6)), closes [#920](https://github.com/dgreif/ring/issues/920)
+* npm audit fix ([c1fe605](https://github.com/dgreif/ring/commit/c1fe6051e46dac92b00bb2fd1202746fd576b15a))
+* remove doorbell press simulation options ([e1d1225](https://github.com/dgreif/ring/commit/e1d12257b2acbdafdc6995a53d9052822c8a3460))
+
 ## [10.0.0-beta.6](https://github.com/dgreif/ring/compare/v10.0.0-beta.5...v10.0.0-beta.6) (2022-05-06)
 
 

package/lib/api/api.js

@@ -112,9 +112,7 @@ class RingApi extends subscribed_1.Subscribed {
                         method: 'PATCH',
                         json: {
                             device: {
-                                metadata: {
-                                    pn_service: 'fcm',
-                                },
+                                metadata: Object.assign(Object.assign({}, this.restClient.baseSessionMetadata), { pn_service: 'fcm' }),
                                 os: 'android',
                                 push_notification_token: token,
                             },

package/lib/api/rest-client.d.ts

@@ -35,6 +35,10 @@ export declare class RingRestClient {
         oldRefreshToken?: string | undefined;
         newRefreshToken: string;
     }>;
+    readonly baseSessionMetadata: {
+        api_version: number;
+        device_model: string;
+    };
     constructor(authOptions: (EmailAuth | RefreshTokenAuth) & SessionOptions);
     private getGrantData;
     getAuth(twoFactorAuthCode?: string): Promise<AuthTokenResponse>;
@@ -44,6 +48,7 @@ export declare class RingRestClient {
     private refreshSession;
     request<T = void>(options: RequestOptions & {
         url: string;
+        allowNoResponse?: boolean;
     }): Promise<T & ExtendedResponse>;
     getCurrentAuth(): Promise<AuthTokenResponse>;
     clearTimeouts(): void;

package/lib/api/rest-client.js

@@ -55,7 +55,7 @@ function requestWithRetry(requestOptions) {
             return data;
         }
         catch (e) {
-            if (!e.response) {
+            if (!e.response && !requestOptions.allowNoResponse) {
                 (0, util_1.logError)(`Failed to reach Ring server at ${requestOptions.url}.  ${e.message}.  Trying again in 5 seconds...`);
                 if (e.message.includes('NGHTTP2_ENHANCE_YOUR_CALM')) {
                     (0, util_1.logError)(`There is a known issue with your current NodeJS version (${process.version}).  Please see https://github.com/dgreif/ring/wiki/NGHTTP2_ENHANCE_YOUR_CALM-Error for details`);
@@ -70,11 +70,16 @@ function requestWithRetry(requestOptions) {
 }
 class RingRestClient {
     constructor(authOptions) {
+        var _a;
         this.authOptions = authOptions;
         this.timeouts = [];
         this.sessionPromise = undefined;
         this.using2fa = false;
         this.onRefreshTokenUpdated = new rxjs_1.ReplaySubject(1);
+        this.baseSessionMetadata = {
+            api_version: apiVersion,
+            device_model: (_a = this.authOptions.controlCenterDisplayName) !== null && _a !== void 0 ? _a : 'ring-client-api',
+        };
         this.refreshToken =
             'refreshToken' in this.authOptions
                 ? this.authOptions.refreshToken
@@ -184,17 +189,13 @@ class RingRestClient {
         });
     }
     fetchNewSession(authToken) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             return requestWithRetry({
                 url: clientApi('session'),
                 json: {
                     device: {
                         hardware_id: yield this.hardwareIdPromise,
-                        metadata: {
-                            api_version: apiVersion,
-                            device_model: (_a = this.authOptions.controlCenterDisplayName) !== null && _a !== void 0 ? _a : 'ring-client-api',
-                        },
+                        metadata: this.baseSessionMetadata,
                         os: 'android', // can use android, ios, ring-site, windows for sure
                     },
                 },

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

@@ -6,6 +6,7 @@ import { DeepPartial } from './util';
 import { Subscribed } from './subscribed';
 import { FfmpegOptions, StreamingSession } from './streaming/streaming-session';
 import { StreamingConnectionOptions } from './streaming/streaming-connection-base';
+import { SimpleWebRtcSession } from './streaming/simple-webrtc-session';
 export declare function getBatteryLevel(data: Pick<CameraData, 'battery_life' | 'battery_life_2'> & {
     health?: Partial<CameraData['health']>;
 }): number | null;
@@ -95,6 +96,13 @@ export declare class RingCamera extends Subscribed {
     getSnapshotByUuid(uuid: string): Promise<Buffer & import("./rest-client").ExtendedResponse>;
     recordToFile(outputPath: string, duration?: number): Promise<void>;
     streamVideo(ffmpegOptions: FfmpegOptions): Promise<StreamingSession>;
+    /**
+     * Returns a SimpleWebRtcSession, which can be initiated with an sdp offer.
+     * This session has no backplane for trickle ICE, and is designed for use in a
+     * browser setting.  Note, cameras with Ring Edge enabled will stream with the speaker
+     * enabled as soon as the stream starts, which can drain the battery more quickly.
+     */
+    createSimpleWebRtcSession(): SimpleWebRtcSession;
     subscribeToDingEvents(): Promise<void & import("./rest-client").ExtendedResponse>;
     unsubscribeFromDingEvents(): Promise<void & import("./rest-client").ExtendedResponse>;
     subscribeToMotionEvents(): Promise<void & import("./rest-client").ExtendedResponse>;

package/lib/api/ring-camera.js

@@ -19,6 +19,7 @@ const subscribed_1 = require("./subscribed");
 const webrtc_connection_1 = require("./streaming/webrtc-connection");
 const ring_edge_connection_1 = require("./streaming/ring-edge-connection");
 const streaming_session_1 = require("./streaming/streaming-session");
+const simple_webrtc_session_1 = require("./streaming/simple-webrtc-session");
 const maxSnapshotRefreshSeconds = 15, fullDayMs = 24 * 60 * 60 * 1000;
 function parseBatteryLife(batteryLife) {
     if (batteryLife === null || batteryLife === undefined) {
@@ -416,6 +417,15 @@ class RingCamera extends subscribed_1.Subscribed {
             return liveCall;
         });
     }
+    /**
+     * Returns a SimpleWebRtcSession, which can be initiated with an sdp offer.
+     * This session has no backplane for trickle ICE, and is designed for use in a
+     * browser setting.  Note, cameras with Ring Edge enabled will stream with the speaker
+     * enabled as soon as the stream starts, which can drain the battery more quickly.
+     */
+    createSimpleWebRtcSession() {
+        return new simple_webrtc_session_1.SimpleWebRtcSession(this, this.restClient);
+    }
     subscribeToDingEvents() {
         return this.restClient.request({
             method: 'POST',

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

@@ -85,6 +85,7 @@ export declare enum RingCameraKind {
     floodlight_pro = "floodlight_pro",
     cocoa_camera = "cocoa_camera",
     cocoa_doorbell = "cocoa_doorbell",
+    cocoa_floodlight = "cocoa_floodlight",
     stickup_cam_mini = "stickup_cam_mini"
 }
 export declare const RingCameraModel: {

package/lib/api/ring-types.js

@@ -93,6 +93,7 @@ var RingCameraKind;
     RingCameraKind["floodlight_pro"] = "floodlight_pro";
     RingCameraKind["cocoa_camera"] = "cocoa_camera";
     RingCameraKind["cocoa_doorbell"] = "cocoa_doorbell";
+    RingCameraKind["cocoa_floodlight"] = "cocoa_floodlight";
     RingCameraKind["stickup_cam_mini"] = "stickup_cam_mini";
 })(RingCameraKind = exports.RingCameraKind || (exports.RingCameraKind = {}));
 exports.RingCameraModel = {
@@ -121,6 +122,7 @@ exports.RingCameraModel = {
     floodlight_pro: 'Floodlight Pro',
     cocoa_camera: 'Stick Up Cam',
     cocoa_doorbell: 'Doorbell Gen 2',
+    cocoa_floodlight: 'Floodlight Cam Plus',
     stickup_cam_mini: 'Indoor Cam',
 };
 exports.allAlarmStates = [

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

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

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

@@ -0,0 +1,63 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SimpleWebRtcSession = void 0;
+const util_1 = require("../util");
+function liveViewUrl(path) {
+    return `https://api.ring.com/integrations/v1/liveview/${path}`;
+}
+class SimpleWebRtcSession {
+    constructor(camera, restClient) {
+        this.camera = camera;
+        this.restClient = restClient;
+        this.sessionId = (0, util_1.generateUuid)();
+    }
+    start(sdp) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.restClient.request({
+                method: 'POST',
+                url: liveViewUrl('start'),
+                json: {
+                    session_id: this.sessionId,
+                    device_id: this.camera.id,
+                    sdp,
+                    protocol: 'webrtc',
+                },
+            });
+            return response.sdp;
+        });
+    }
+    end() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.restClient.request({
+                method: 'POST',
+                url: liveViewUrl('end'),
+                json: {
+                    session_id: this.sessionId,
+                },
+            });
+            return resp;
+        });
+    }
+    activateCameraSpeaker() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.restClient.request({
+                method: 'PATCH',
+                url: liveViewUrl('options'),
+                json: {
+                    session_id: this.sessionId,
+                    actions: ['turn_off_stealth_mode'],
+                },
+            });
+        });
+    }
+}
+exports.SimpleWebRtcSession = SimpleWebRtcSession;

package/lib/api/util.js

@@ -123,6 +123,15 @@ function randomString(length) {
 exports.randomString = randomString;
 // Override push receiver logging to avoid ECONNRESET errors leaking
 function logPushReceiver(...args) {
+    try {
+        if (args[0].toString().includes('ECONNRESET')) {
+            // don't log ECONNRESET errors
+            return;
+        }
+    }
+    catch (_) {
+        // proceed to log error
+    }
     logDebug('[Push Receiver]');
     logDebug(args[0]);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ring-client-api",
-  "version": "10.0.0-beta.6",
+  "version": "10.0.0",
   "description": "Unofficial API for Ring doorbells, cameras, security alarm system and smart lighting",
   "main": "lib/api/index.js",
   "bin": {
@@ -15,12 +15,12 @@
     "lint": "eslint '**/*.ts' --fix",
     "build": "rm -rf lib && tsc --declaration",
     "build-quick": "rm -rf lib && esbuild ./{api,examples,homebridge}/*.ts ./api/streaming/*.ts --target=es2017 --format=cjs --outdir=lib",
-    "example": "npm run build-quick && node ./lib/examples/example.js",
-    "api-example": "npm run build-quick && node ./lib/examples/api-example.js",
-    "record-example": "npm run build-quick && node ./lib/examples/record-example.js",
-    "return-audio-example": "npm run build-quick && node ./lib/examples/return-audio-example.js",
-    "stream-example": "npm run build-quick && node ./lib/examples/stream-example.js",
-    "browser-example": "npm run build-quick && node ./lib/examples/browser-example.js",
+    "example": "node -r @swc-node/register ./lib/examples/example.js",
+    "api-example": "node -r @swc-node/register ./lib/examples/api-example.js",
+    "record-example": "node -r @swc-node/register ./lib/examples/record-example.js",
+    "return-audio-example": "node -r @swc-node/register ./lib/examples/return-audio-example.js",
+    "stream-example": "node -r @swc-node/register ./lib/examples/stream-example.js",
+    "browser-example": "node -r @swc-node/register ./lib/examples/browser-example.js",
     "auth-cli": "npm run build-quick && ./ring-auth-cli.js",
     "device-data-cli": "npm run build-quick && ./ring-device-data-cli.js",
     "hb": "npm run build-quick && ./build/package-homebridge.sh && homebridge -P ./release-homebridge -U ./.homebridge",
@@ -70,6 +70,7 @@
     "ws": "^8.6.0"
   },
   "devDependencies": {
+    "@swc-node/register": "^1.5.1",
     "@types/debug": "4.1.7",
     "@types/jest": "27.5.0",
     "@types/node": "17.0.31",