Add option to override hostname

Author: donavanbecker

src/settings.ts

@@ -3,35 +3,35 @@
  *
  * © 2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
  */
-/**
- * This is the main url used to scan for Devices SwitchBot API
- */
-export const baseURL = 'https://api.switch-bot.com/v1.1'
-
-/**
- * This is the main url used to scan for Devices SwitchBot API
- */
-export const devicesURL = 'https://api.switch-bot.com/v1.1/devices'
-
-/**
- * This is the updateWebhook url used to access SwitchBot API
- */
-export const setupWebhook = 'https://api.switch-bot.com/v1.1/webhook/setupWebhook'
+let baseURL = 'https://api.switch-bot.com'
 
-/**
- * This is the updateWebhook url used to access SwitchBot API
- */
-export const queryWebhook = 'https://api.switch-bot.com/v1.1/webhook/queryWebhook'
+let devicesURL = `${baseURL}/v1.1/devices`
+let setupWebhook = `${baseURL}/v1.1/webhook/setupWebhook`
+let queryWebhook = `${baseURL}/v1.1/webhook/queryWebhook`
+let updateWebhook = `${baseURL}/v1.1/webhook/updateWebhook`
+let deleteWebhook = `${baseURL}/v1.1/webhook/deleteWebhook`
 
 /**
- * This is the updateWebhook url used to access SwitchBot API
+ * Updates the base URL for the SwitchBot API endpoints.
+ * @param {string} newBaseURL - The new base URL to use.
  */
-export const updateWebhook = 'https://api.switch-bot.com/v1.1/webhook/updateWebhook'
+export function updateBaseURL(newBaseURL: string): void {
+  baseURL = newBaseURL
+  devicesURL = `${baseURL}/v1.1/devices`
+  setupWebhook = `${baseURL}/v1.1/webhook/setupWebhook`
+  queryWebhook = `${baseURL}/v1.1/webhook/queryWebhook`
+  updateWebhook = `${baseURL}/v1.1/webhook/updateWebhook`
+  deleteWebhook = `${baseURL}/v1.1/webhook/deleteWebhook`
+}
 
-/**
- * This is the deleteWebhook url used to access SwitchBot API
- */
-export const deleteWebhook = 'https://api.switch-bot.com/v1.1/webhook/deleteWebhook'
+export const urls = {
+  get baseURL() { return baseURL },
+  get devicesURL() { return devicesURL },
+  get setupWebhook() { return setupWebhook },
+  get queryWebhook() { return queryWebhook },
+  get updateWebhook() { return updateWebhook },
+  get deleteWebhook() { return deleteWebhook },
+}
 
 /**
  * constants used to access SwitchBot BLE API

src/switchbot-openapi.ts

@@ -16,7 +16,7 @@ import { createServer } from 'node:http'
 
 import { request } from 'undici'
 
-import { baseURL, deleteWebhook, devicesURL, queryWebhook, setupWebhook, updateWebhook } from './settings.js'
+import { updateBaseURL, urls } from './settings.js'
 
 /**
  * The `SwitchBotOpenAPI` class provides methods to interact with the SwitchBot OpenAPI.
@@ -66,11 +66,15 @@ export class SwitchBotOpenAPI extends EventEmitter {
    * @param token - The API token used for authentication.
    * @param secret - The secret key used for signing requests.
    */
-  constructor(token: string, secret: string) {
+  constructor(token: string, secret: string, hostname?: string) {
     super()
     this.token = token
     this.secret = secret
-    this.baseURL = baseURL
+    this.baseURL = urls.baseURL
+
+    if (hostname) {
+      updateBaseURL(hostname)
+    }
   }
 
   /**
@@ -91,7 +95,7 @@ export class SwitchBotOpenAPI extends EventEmitter {
    */
   async getDevices(): Promise<{ response: devices, statusCode: number }> {
     try {
-      const { body, statusCode } = await request(devicesURL, { headers: this.generateHeaders() })
+      const { body, statusCode } = await request(urls.devicesURL, { headers: this.generateHeaders() })
       const response = await body.json() as devices
       this.emitLog('debug', `Got devices: ${JSON.stringify(response)}`)
       this.emitLog('debug', `statusCode: ${statusCode}`)
@@ -233,7 +237,7 @@ export class SwitchBotOpenAPI extends EventEmitter {
     }
 
     try {
-      const { body, statusCode } = await request(setupWebhook, {
+      const { body, statusCode } = await request(urls.setupWebhook, {
         method: 'POST',
         headers: this.generateHeaders(),
         body: JSON.stringify({
@@ -252,7 +256,7 @@ export class SwitchBotOpenAPI extends EventEmitter {
     }
 
     try {
-      const { body, statusCode } = await request(updateWebhook, {
+      const { body, statusCode } = await request(urls.updateWebhook, {
         method: 'POST',
         headers: this.generateHeaders(),
         body: JSON.stringify({
@@ -273,7 +277,7 @@ export class SwitchBotOpenAPI extends EventEmitter {
     }
 
     try {
-      const { body, statusCode } = await request(queryWebhook, {
+      const { body, statusCode } = await request(urls.queryWebhook, {
         method: 'POST',
         headers: this.generateHeaders(),
         body: JSON.stringify({
@@ -302,7 +306,7 @@ export class SwitchBotOpenAPI extends EventEmitter {
    */
   async deleteWebhook(url: string): Promise<void> {
     try {
-      const { body, statusCode } = await request(deleteWebhook, {
+      const { body, statusCode } = await request(urls.deleteWebhook, {
         method: 'POST',
         headers: this.generateHeaders(),
         body: JSON.stringify({

src/test/settings.test.ts

@@ -5,37 +5,33 @@ import {
   CHAR_UUID_NOTIFY,
   CHAR_UUID_WRITE,
   COMMAND_TIMEOUT_MSEC,
-  deleteWebhook,
-  devicesURL,
-  queryWebhook,
   READ_TIMEOUT_MSEC,
   SERV_UUID_PRIMARY,
-  setupWebhook,
-  updateWebhook,
+  urls,
   WoSmartLockCommands,
   WoSmartLockProCommands,
   WRITE_TIMEOUT_MSEC,
 } from '../settings.js'
 
 describe('switchBot API Settings', () => {
   it('should have correct Devices URL', () => {
-    expect(devicesURL).toBe('https://api.switch-bot.com/v1.1/devices')
+    expect(urls.devicesURL).toBe('https://api.switch-bot.com/v1.1/devices')
   })
 
   it('should have correct setupWebhook URL', () => {
-    expect(setupWebhook).toBe('https://api.switch-bot.com/v1.1/webhook/setupWebhook')
+    expect(urls.setupWebhook).toBe('https://api.switch-bot.com/v1.1/webhook/setupWebhook')
   })
 
   it('should have correct queryWebhook URL', () => {
-    expect(queryWebhook).toBe('https://api.switch-bot.com/v1.1/webhook/queryWebhook')
+    expect(urls.queryWebhook).toBe('https://api.switch-bot.com/v1.1/webhook/queryWebhook')
   })
 
   it('should have correct updateWebhook URL', () => {
-    expect(updateWebhook).toBe('https://api.switch-bot.com/v1.1/webhook/updateWebhook')
+    expect(urls.updateWebhook).toBe('https://api.switch-bot.com/v1.1/webhook/updateWebhook')
   })
 
   it('should have correct deleteWebhook URL', () => {
-    expect(deleteWebhook).toBe('https://api.switch-bot.com/v1.1/webhook/deleteWebhook')
+    expect(urls.deleteWebhook).toBe('https://api.switch-bot.com/v1.1/webhook/deleteWebhook')
   })
 
   it('should have correct BLE API constants', () => {