v4.19.0.

docs/Changelog.md

@@ -2,33 +2,38 @@
 
 All notable changes to this project will be documented in this file. This project uses [semantic versioning](https://semver.org/).
 
+## 4.19.0 (2024-12-27)
+  * Improvement: refinements to Protect controller connectivity and recovery.
+  * Improvement: minor updates to the Protect JSON descriptions.
+  * Housekeeping.
+
 ## 4.18.0 (2024-12-22)
   * Breaking change: the minimum supported node version is now node 20.
-  * Improvement: we've changed strategies to deal with Protect controller quirkiness/bugginess that results in network disconnects from the controller, while ensuring we have reasonable backpressure measures.
+  * Improvement: we've adjusted strategies to deal with Protect controller quirkiness/bugginess that results in network disconnects from the controller, while ensuring we have reasonable backpressure measures.
   * Housekeeping.
 
 ## 4.17.0 (2024-12-08)
-  * Minor updates to the Protect JSON descriptions.
+  * Improvement: minor updates to the Protect JSON descriptions.
   * Housekeeping.
 
 ## 4.16.0 (2024-10-05)
   * New feature: ufp - a command line utility to query and execute some utility commands using the Protect API. You'll need to create either ~/.ufp.json or ufp.json in your current directory with the properties `controller`, `username`, `password` all defined in a valid JSON.
   * Housekeeping.
 
 ## 4.15.1 (2024-09-29)
-  * Minor updates to the Protect JSON descriptions.
+  * Improvement: minor updates to the Protect JSON descriptions.
   * Housekeeping.
 
 ## 4.15.0 (2024-09-26)
   * New feature: added the `isThrottled` as a publicly accessible readonly property that returns whether the API connection is currently throttled due to connectivity issues.
   * Housekeeping.
 
 ## 4.14.0 (2024-09-22)
-  * Updates to the Protect JSON descriptions.
+  * Improvement: minor updates to the Protect JSON descriptions.
   * Housekeeping.
 
 ## 4.13.0 (2024-09-15)
-  * Updates to the Protect JSON descriptions.
+  * Improvement: minor updates to the Protect JSON descriptions.
   * Housekeeping.
 
 ## 4.12.0 (2024-09-14)
@@ -43,13 +48,13 @@ All notable changes to this project will be documented in this file. This projec
   * Performance improvements and housekeeping.
 
 ## 4.10.0 (2024-06-01)
-  * Device JSON updates for Protect 4.0.
+  * Improvement: device JSON updates for Protect 4.0.
   * Improvement: added the codec event to the livestream API so you can retrieve the codec information associated with a particular livestream.
   * Documentation updates.
   * Housekeeping.
 
 ## 4.9.0 (2024-04-20)
-  * Minor updates to the Protect JSON descriptions.
+  * Improvement: minor updates to the Protect JSON descriptions.
   * Housekeeping.
 
 ## 4.8.2 (2024-03-17)

docs/ProtectApi.md

@@ -206,7 +206,7 @@ process.stdout.write(util.inspect(ufp.bootstrap, { colors: true, depth: null, so
 ##### getSnapshot()
 
 ```ts
-getSnapshot(device, options): Promise<Nullable<Buffer<ArrayBufferLike>>>
+getSnapshot(device, options): Promise<Nullable<Buffer>>
 ```
 
 Retrieve a snapshot image from a Protect camera.
@@ -220,7 +220,7 @@ Retrieve a snapshot image from a Protect camera.
 
 ###### Returns
 
-`Promise`\<`Nullable`\<`Buffer`\<`ArrayBufferLike`\>\>\>
+`Promise`\<`Nullable`\<`Buffer`\>\>
 
 Returns a promise that will resolve to a Buffer containing the JPEG image snapshot if successful, and `null` otherwise.
 

docs/ProtectApiEvents.md

@@ -84,7 +84,7 @@ Decode a UniFi Protect event packet.
 | Parameter | Type | Description |
 | ------ | ------ | ------ |
 | `log` | [`ProtectLogging`](ProtectLogging.md#protectlogging) | Logging functions to use. |
-| `packet` | `Buffer`\<`ArrayBufferLike`\> | Input packet to decode. |
+| `packet` | `Buffer` | Input packet to decode. |
 
 ###### Returns
 

docs/ProtectLivestream.md

@@ -118,14 +118,14 @@ Returns a string containing the codec information,if it exists, or `null` otherw
 ###### Get Signature
 
 ```ts
-get initSegment(): Nullable<Buffer<ArrayBufferLike>>
+get initSegment(): Nullable<Buffer>
 ```
 
 The initialization segment that must be at the start of every fMP4 stream.
 
 ###### Returns
 
-`Nullable`\<`Buffer`\<`ArrayBufferLike`\>\>
+`Nullable`\<`Buffer`\>
 
 Returns the initialization segment if it exists, or `null` otherwise.
 
@@ -134,14 +134,14 @@ Returns the initialization segment if it exists, or `null` otherwise.
 ##### getInitSegment()
 
 ```ts
-getInitSegment(): Promise<Buffer<ArrayBufferLike>>
+getInitSegment(): Promise<Buffer>
 ```
 
 Retrieve the initialization segment that must be at the start of every fMP4 stream.
 
 ###### Returns
 
-`Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
+`Promise`\<`Buffer`\>
 
 Returns a promise that resolves once the initialization segment has been seen, or returning it immediately if it already has been.