Documented gatewaysand fixed bugs

### FIXED
- `removePersonalIdentifiableInformation` did not properly remove information in arrays nested inside objects.

### ADDED
- Documented a collection of security buttons
- Documented a collection of force arm buttons.
- Safewatch Pro Security Panel (with 3 emergency key buttons)

Author: mrjackyliang

package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-adt-pulse",
   "displayName": "Homebridge ADT Pulse",
-  "version": "3.1.3",
+  "version": "3.1.4",
   "description": "Homebridge security system platform for ADT Pulse",
   "main": "./build/index.js",
   "exports": "./build/index.js",

src/lib/items.ts

@@ -35,14 +35,51 @@ import type {
  *
  * @since 1.0.0
  */
-export const collectionDoSubmitHandlers: CollectionDoSubmitHandlers = [];
+export const collectionDoSubmitHandlers: CollectionDoSubmitHandlers = [
+  [],
+  [
+    {
+      href: 'rest/adt/ui/client/security/setForceArm',
+    },
+    {
+      href: 'rest/adt/ui/client/security/setCancelProtest',
+    },
+  ],
+];
 
 /**
  * Collection orb security buttons.
  *
  * @since 1.0.0
  */
-export const collectionOrbSecurityButtons: CollectionOrbSecurityButtons = [];
+export const collectionOrbSecurityButtons: CollectionOrbSecurityButtons = [
+  [
+    {
+      buttonDisabled: false,
+      buttonText: 'Arm Away',
+      loadingText: 'Arming Away',
+    },
+    {
+      buttonDisabled: false,
+      buttonText: 'Arm Stay',
+      loadingText: 'Arming Stay',
+    },
+  ],
+  [
+    {
+      buttonDisabled: false,
+      buttonText: 'Disarm',
+      loadingText: 'Disarming',
+    },
+  ],
+  [
+    {
+      buttonDisabled: true,
+      buttonText: 'Arming Night',
+      loadingText: null,
+    },
+  ],
+];
 
 /**
  * Collection sensor actions.
@@ -246,6 +283,11 @@ export const deviceSecurityPanels: DeviceSecurityPanels = [
     manufacturerProvider: 'ADT',
     typeModel: 'Security Panel - Safewatch Pro 3000/3000CN',
   },
+  {
+    emergencyKeys: 'Button: Fire Alarm (Zone 95) Button: Personal Emergency (Zone 96) Button: Audible Panic Alarm (Zone 99)',
+    manufacturerProvider: 'ADT',
+    typeModel: 'Security Panel - Safewatch Pro 3000/3000CN',
+  },
 ];
 
 /**

src/lib/utility.ts

@@ -1417,6 +1417,8 @@ export function removePersonalIdentifiableInformation(data: RemovePersonalIdenti
 
       if (_.isPlainObject(value)) {
         modifiedObject[key] = replaceValue(value as RemovePersonalIdentifiableInformationModifiedObject);
+      } else if (Array.isArray(value)) {
+        modifiedObject[key] = value.map(replaceValue);
       } else if (redactedKeys.includes(key)) {
         modifiedObject[key] = '*** REDACTED FOR PRIVACY ***';
       } else {

src/types/index.d.ts

@@ -1109,7 +1109,7 @@ export type CollectionOrbSecurityButtonButtonButtonDisabled = boolean;
 
 export type CollectionOrbSecurityButtonButtonButtonText = PortalPanelArmButtonText | PortalPanelArmButtonLoadingText;
 
-export type CollectionOrbSecurityButtonButtonLoadingText = PortalPanelArmButtonLoadingText;
+export type CollectionOrbSecurityButtonButtonLoadingText = PortalPanelArmButtonLoadingText | null;
 
 export type CollectionOrbSecurityButtonButton = {
   buttonDisabled: CollectionOrbSecurityButtonButtonButtonDisabled;