Move to case insensitive header extraction where possible

Author: andyfase

src/lib/bluelink-regions/base.ts

@@ -408,6 +408,17 @@ export class Bluelink {
     })
   }
 
+  // helper function to extract a parameter from header / cookie etc - as the Bluelink API changes case frequently
+  protected caseInsensitiveParamExtraction(key: string, data: Record<string, any>): string | undefined {
+    if (Object.hasOwn(data, key)) return data[key] // check for exact match first
+
+    const lowerKey = key.toLowerCase()
+    for (const [k, v] of Object.entries(data)) {
+      if (lowerKey === k.toLowerCase()) return v
+    }
+    return undefined
+  }
+
   protected async login(): Promise<BluelinkTokens | undefined> {
     // implemented in country specific sub-class
     throw Error('Not Implemented')

src/lib/bluelink-regions/canada.ts

@@ -98,7 +98,7 @@ export class BluelinkCanada extends Bluelink {
     req.method = 'GET'
     await req.load()
     for (const cookie of req.response.cookies) {
-      if (cookie.name === 'dtCookie') {
+      if (cookie.name.toLowerCase() === 'dtcookie') {
         return `dtCookie=${cookie.value}`
       }
     }
@@ -298,15 +298,6 @@ export class BluelinkCanada extends Bluelink {
     throw Error(error)
   }
 
-  protected getTransactionId(headers: Record<string, any>): string {
-    // response is inconsistant re case
-    if (Object.hasOwn(headers, 'transactionId')) return headers.transactionId
-    if (Object.hasOwn(headers, 'transactionid')) return headers.transactionid
-    const error = `Failed to extract transaction id from: ${JSON.stringify(headers)}`
-    if (this.config.debugLogging) this.logger.log(error)
-    throw Error(error)
-  }
-
   protected async pollForCommandCompletion(
     id: string,
     authCode: string,
@@ -376,8 +367,8 @@ export class BluelinkCanada extends Bluelink {
       validResponseFunction: this.requestResponseValid,
     })
     if (this.requestResponseValid(resp.resp, resp.json).valid) {
-      const transactionId = this.getTransactionId(resp.resp.headers)
-      return await this.pollForCommandCompletion(id, authCode, transactionId)
+      const transactionId = this.caseInsensitiveParamExtraction('transactionid', resp.resp.headers)
+      if (transactionId) return await this.pollForCommandCompletion(id, authCode, transactionId)
     }
     const error = `Failed to send lockUnlock command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
     if (this.config.debugLogging) this.logger.log(error)
@@ -411,8 +402,8 @@ export class BluelinkCanada extends Bluelink {
       validResponseFunction: this.requestResponseValid,
     })
     if (this.requestResponseValid(resp.resp, resp.json).valid) {
-      const transactionId = this.getTransactionId(resp.resp.headers)
-      return await this.pollForCommandCompletion(id, authCode, transactionId)
+      const transactionId = this.caseInsensitiveParamExtraction('transactionid', resp.resp.headers)
+      if (transactionId) return await this.pollForCommandCompletion(id, authCode, transactionId)
     }
     const error = `Failed to send charge command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
     if (this.config.debugLogging) this.logger.log(error)
@@ -456,8 +447,8 @@ export class BluelinkCanada extends Bluelink {
       validResponseFunction: this.requestResponseValid,
     })
     if (this.requestResponseValid(resp.resp, resp.json).valid) {
-      const transactionId = this.getTransactionId(resp.resp.headers)
-      return await this.pollForCommandCompletion(id, authCode, transactionId)
+      const transactionId = this.caseInsensitiveParamExtraction('transactionid', resp.resp.headers)
+      if (transactionId) return await this.pollForCommandCompletion(id, authCode, transactionId)
     }
     const error = `Failed to send climateOff command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
     if (this.config.debugLogging) this.logger.log(error)
@@ -480,8 +471,8 @@ export class BluelinkCanada extends Bluelink {
       validResponseFunction: this.requestResponseValid,
     })
     if (this.requestResponseValid(resp.resp, resp.json).valid) {
-      const transactionId = this.getTransactionId(resp.resp.headers)
-      return await this.pollForCommandCompletion(id, authCode, transactionId)
+      const transactionId = this.caseInsensitiveParamExtraction('transactionid', resp.resp.headers)
+      if (transactionId) return await this.pollForCommandCompletion(id, authCode, transactionId)
     }
     const error = `Failed to send climateOff command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
     if (this.config.debugLogging) this.logger.log(error)

src/lib/bluelink-regions/usa.ts

@@ -287,8 +287,8 @@ export class BluelinkUSA extends Bluelink {
       validResponseFunction: this.requestResponseValid,
     })
     if (this.requestResponseValid(resp.resp, resp.json).valid) {
-      const transactionId = resp.resp.headers.tmsTid as string
-      return await this.pollForCommandCompletion(resp, transactionId)
+      const transactionId = this.caseInsensitiveParamExtraction('tmsTid', resp.resp.headers)
+      if (transactionId) return await this.pollForCommandCompletion(resp, transactionId)
     }
     const error = `Failed to send lockUnlock command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
     if (this.config.debugLogging) this.logger.log(error)
@@ -322,8 +322,8 @@ export class BluelinkUSA extends Bluelink {
       validResponseFunction: this.requestResponseValid,
     })
     if (this.requestResponseValid(resp.resp, resp.json).valid) {
-      const transactionId = resp.resp.headers.tmsTid as string
-      return await this.pollForCommandCompletion(resp, transactionId)
+      const transactionId = this.caseInsensitiveParamExtraction('tmsTid', resp.resp.headers)
+      if (transactionId) return await this.pollForCommandCompletion(resp, transactionId)
     }
     const error = `Failed to send charge command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
     if (this.config.debugLogging) this.logger.log(error)
@@ -355,8 +355,8 @@ export class BluelinkUSA extends Bluelink {
       validResponseFunction: this.requestResponseValid,
     })
     if (this.requestResponseValid(resp.resp, resp.json).valid) {
-      const transactionId = resp.resp.headers.tmsTid as string
-      return await this.pollForCommandCompletion(resp, transactionId)
+      const transactionId = this.caseInsensitiveParamExtraction('tmsTid', resp.resp.headers)
+      if (transactionId) return await this.pollForCommandCompletion(resp, transactionId)
     }
     const error = `Failed to send climateOn command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
     if (this.config.debugLogging) this.logger.log(error)
@@ -375,8 +375,8 @@ export class BluelinkUSA extends Bluelink {
       validResponseFunction: this.requestResponseValid,
     })
     if (this.requestResponseValid(resp.resp, resp.json).valid) {
-      const transactionId = resp.resp.headers.tmsTid as string
-      return await this.pollForCommandCompletion(resp, transactionId)
+      const transactionId = this.caseInsensitiveParamExtraction('tmsTid', resp.resp.headers)
+      if (transactionId) return await this.pollForCommandCompletion(resp, transactionId)
     }
     const error = `Failed to send climateOff command: ${JSON.stringify(resp.json)} request ${JSON.stringify(this.debugLastRequest)}`
     if (this.config.debugLogging) this.logger.log(error)