Improved "test-api" script

### UPDATED
- The "test-api" script will now show errors from `zod` if your configuration failed to parse.
- Clarify the error message better if plugin detects an invalid configuration.

v3.1.8

Author: mrjackyliang

package.json

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

src/lib/platform.ts

@@ -234,7 +234,8 @@ export class ADTPulsePlatform implements ADTPulsePlatformPlugin {
     // Check for a valid platform configuration before initializing.
     if (!parsedConfig.success) {
       this.#log.error('Plugin is unable to initialize due to an invalid platform configuration.');
-      this.#log.warn('If you just upgraded from v2 to v3 / v3.1, please update your configuration structure.');
+      this.#log.warn('If you just upgraded from "v2 to v3" or from "v3 to v3.1", please update your configuration.');
+      this.#log.warn('Carefully observe the error below. The answer you are looking for is there.');
       stackTracer('zod-error', parsedConfig.error.errors);
 
       return;

src/scripts/test-api.ts

@@ -8,7 +8,7 @@ import util from 'node:util';
 
 import { ADTPulse } from '@/lib/api.js';
 import { platformConfig } from '@/lib/schema.js';
-import { debugLog, isForwardSlashOS } from '@/lib/utility.js';
+import { debugLog, isForwardSlashOS, stackTracer } from '@/lib/utility.js';
 import type {
   ADTPulseTestAskQuestionMode,
   ADTPulseTestAskQuestionReturns,
@@ -20,6 +20,7 @@ import type {
   ADTPulseTestSelectedConfigLocation,
   ADTPulseTestSelectedPlatform,
   ADTPulseTestStartTestReturns,
+  ADTPulseTestZodParseResponse,
 } from '@/types/index.d.ts';
 
 /**
@@ -46,6 +47,15 @@ class ADTPulseTest {
    */
   #selectedPlatform: ADTPulseTestSelectedPlatform;
 
+  /**
+   * ADT Pulse Test - Zod parse response.
+   *
+   * @private
+   *
+   * @since 1.0.0
+   */
+  #zodParseResponse: ADTPulseTestZodParseResponse;
+
   /**
    * ADT Pulse Test - Start test.
    *
@@ -163,6 +173,9 @@ class ADTPulseTest {
         if (adtPlatform !== undefined) {
           const validAdtPlatform = platformConfig.safeParse(adtPlatform);
 
+          // Set this to the instance in case "zod" parse failed.
+          this.#zodParseResponse = validAdtPlatform;
+
           if (validAdtPlatform.success) {
             this.#selectedConfigLocation = possibleLocations[i];
             this.#selectedPlatform = validAdtPlatform.data;
@@ -177,6 +190,12 @@ class ADTPulseTest {
     if (this.#selectedConfigLocation === undefined || this.#selectedPlatform === undefined) {
       debugLog(null, 'test-api.ts', 'error', 'Unable to find a parsable Homebridge config file with a validated "ADTPulse" platform');
 
+      if (this.#zodParseResponse !== undefined) {
+        debugLog(null, 'test-api.ts', 'warn', 'If you just upgraded from "v2 to v3" or from "v3 to v3.1", please update your configuration');
+        debugLog(null, 'test-api.ts', 'warn', 'Carefully observe the error below. The answer you are looking for is there');
+        stackTracer('zod-error', this.#zodParseResponse);
+      }
+
       return false;
     }
 

src/types/index.d.ts

@@ -1067,6 +1067,15 @@ export type ADTPulseTestSelectedPlatform = Config | undefined;
  */
 export type ADTPulseTestStartTestReturns = Promise<void>;
 
+/**
+ * ADT Pulse Test - Zod parse response.
+ *
+ * @private
+ *
+ * @since 1.0.0
+ */
+export type ADTPulseTestZodParseResponse = z.SafeParseReturnType<any, any> | undefined;
+
 /**
  * Clear html line break.
  *