Support complete dingId (dgreif#1222)

Darrilla · May 23, 2023 · af7f44e · af7f44e
1 parent 96a073b
commit af7f44e
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 3 deletions.
diff --git a/.changeset/real-onions-tickle.md b/.changeset/real-onions-tickle.md
@@ -0,0 +1,5 @@
+---
+'ring-client-api': patch
+---
+
+Update push notifications to include a full and accurate ding `id`. Note, this is technically a breaking change because the `id` was previously a `number` instead of a `string`, but the last few digits were truncated due to number rounding. We are releasing this as a patch because the `number` version was unusable for fetching additional information about the ding.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/ring-client-api/api.ts b/packages/ring-client-api/api.ts
@@ -29,6 +29,7 @@ import { setFfmpegPath } from './ffmpeg'
 import { Subscribed } from './subscribed'
 import PushReceiver from '@eneris/push-receiver'
 import { RingIntercom } from './ring-intercom'
+import JSONbig from 'json-bigint'
 
 export interface RingApiOptions extends SessionOptions {
   locationIds?: string[]
@@ -270,7 +271,9 @@ export class RingApi extends Subscribed {
       const dataJson = message.data?.gcmData as string
 
       try {
-        const notification = JSON.parse(dataJson) as PushNotification
+        const notification = JSONbig({ storeAsString: true }).parse(
+          dataJson
+        ) as PushNotification
 
         if ('ding' in notification) {
           sendToDevice(notification.ding.doorbot_id, notification)

diff --git a/packages/ring-client-api/package.json b/packages/ring-client-api/package.json
@@ -25,6 +25,7 @@
     "colors": "1.4.0",
     "debug": "^4.3.4",
     "got": "^11.8.5",
+    "json-bigint": "^1.0.0",
     "msw": "^1.2.1",
     "rxjs": "^7.8.0",
     "socket.io-client": "^2.5.0",
@@ -37,6 +38,7 @@
   "devDependencies": {
     "@types/debug": "4.1.7",
     "@types/jest": "29.5.0",
+    "@types/json-bigint": "^1.0.1",
     "@types/node": "18.15.9",
     "@types/uuid": "9.0.1",
     "@types/ws": "^8.5.4",

diff --git a/packages/ring-client-api/ring-camera.ts b/packages/ring-client-api/ring-camera.ts
@@ -398,7 +398,7 @@ export class RingCamera extends Subscribed {
     return new StreamingSession(this, connection)
   }
 
-  private removeDingById(idToRemove: number) {
+  private removeDingById(idToRemove: string) {
     const allActiveDings = this.activeNotifications,
       otherDings = allActiveDings.filter(({ ding }) => ding.id !== idToRemove)
 

diff --git a/packages/ring-client-api/ring-types.ts b/packages/ring-client-api/ring-types.ts
@@ -1016,7 +1016,7 @@ export interface PushNotificationDing {
     device_kind: RingCameraKind
     detection_type: NotificationDetectionType
     human_detected?: boolean
-    id: number
+    id: string
     pod_id: number
     request_id: string
     image_uuid: string