feat: Added getDeviceStates API

.github/dependabot.yml

@@ -11,6 +11,9 @@ updates:
       interval: 'daily'
     labels:
       - 'dependencies'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
     groups:
       dev-dependencies:
         patterns:

example/main.ts

@@ -1,5 +1,4 @@
-import { MysaApiClient } from '@/api/MysaApiClient';
-import { MysaSession } from '@/api/MysaSession';
+import { MysaApiClient, MysaSession } from '@/api';
 import 'dotenv/config';
 import { readFile, rm, writeFile } from 'fs/promises';
 import { pino } from 'pino';
@@ -93,4 +92,6 @@ async function main() {
   }
 }
 
-main().catch(rootLogger.error);
+main().catch((error) => {
+  rootLogger.error(error, 'Error in main');
+});

package.json

@@ -46,21 +46,21 @@
     "build:docs": "typedoc"
   },
   "dependencies": {
-    "@aws-sdk/credential-providers": "3.817.0",
+    "@aws-sdk/credential-providers": "3.821.0",
     "amazon-cognito-identity-js": "6.3.15",
     "aws-iot-device-sdk-v2": "1.21.4",
     "dayjs": "1.11.13",
     "lodash": "4.17.21"
   },
   "devDependencies": {
-    "@eslint/js": "9.27.0",
+    "@eslint/js": "9.28.0",
     "@semantic-release/npm": "12.0.1",
     "@types/lodash": "4.17.17",
-    "@types/node": "22.15.21",
+    "@types/node": "22.15.29",
     "conventional-changelog-conventionalcommits": "9.0.0",
     "dotenv": "16.5.0",
-    "eslint": "9.27.0",
-    "eslint-plugin-jsdoc": "50.6.17",
+    "eslint": "9.28.0",
+    "eslint-plugin-jsdoc": "50.7.1",
     "eslint-plugin-tsdoc": "0.4.0",
     "pino": "9.7.0",
     "pino-pretty": "13.0.0",
@@ -70,9 +70,9 @@
     "semantic-release": "24.2.5",
     "tsup": "8.5.0",
     "tsx": "4.19.4",
-    "typedoc": "0.28.4",
+    "typedoc": "0.28.5",
     "typedoc-material-theme": "1.4.0",
     "typescript": "5.8.3",
-    "typescript-eslint": "8.32.1"
+    "typescript-eslint": "8.33.0"
   }
 }

src/api/MysaApiClient.ts

@@ -6,7 +6,7 @@ import { ChangeDeviceState } from '@/types/mqtt/in/ChangeDeviceState';
 import { InMessageType } from '@/types/mqtt/in/InMessageType';
 import { StartPublishingDeviceStatus } from '@/types/mqtt/in/StartPublishingDeviceStatus';
 import { OutMessageType } from '@/types/mqtt/out/OutMessageType';
-import { Devices } from '@/types/rest/Devices';
+import { Devices, DeviceStates, Firmwares } from '@/types/rest';
 import { fromCognitoIdentityPool } from '@aws-sdk/credential-providers';
 import {
   AuthenticationDetails,
@@ -184,7 +184,43 @@ export class MysaApiClient {
 
     const response = await this._fetcher(`${MysaApiBaseUrl}/devices`, {
       headers: {
-        Authorization: `${session.getAccessToken().getJwtToken()}`
+        Authorization: `${session.getIdToken().getJwtToken()}`
+      }
+    });
+
+    if (!response.ok) {
+      throw new MysaApiError(response);
+    }
+
+    return response.json();
+  }
+
+  async getDeviceFirmwares(): Promise<Firmwares> {
+    this._logger.debug(`Fetching device firmwares...`);
+
+    const session = await this.getFreshSession();
+
+    const response = await this._fetcher(`${MysaApiBaseUrl}/devices/firmware`, {
+      headers: {
+        Authorization: `${session.getIdToken().getJwtToken()}`
+      }
+    });
+
+    if (!response.ok) {
+      throw new MysaApiError(response);
+    }
+
+    return response.json();
+  }
+
+  async getDeviceStates(): Promise<DeviceStates> {
+    this._logger.debug(`Fetching device states...`);
+
+    const session = await this.getFreshSession();
+
+    const response = await this._fetcher(`${MysaApiBaseUrl}/devices/state`, {
+      headers: {
+        Authorization: `${session.getIdToken().getJwtToken()}`
       }
     });
 
@@ -320,7 +356,7 @@ export class MysaApiClient {
 
     if (
       this._cognitoUserSession.isValid() &&
-      dayjs.unix(this._cognitoUserSession.getAccessToken().getExpiration()).isAfter()
+      dayjs.unix(this._cognitoUserSession.getIdToken().getExpiration()).isAfter()
     ) {
       this._logger.info('Session is valid, no need to refresh');
       return Promise.resolve(this._cognitoUserSession);

src/index.ts

@@ -1 +1,2 @@
 export * from './api';
+export * from './types';

src/types/index.ts

@@ -0,0 +1,2 @@
+export * from './mqtt';
+export * from './rest';

src/types/mqtt/in/index.ts

@@ -0,0 +1,4 @@
+export * from './ChangeDeviceState';
+export * from './CheckDeviceSettings';
+export * from './InMessageType';
+export * from './StartPublishingDeviceStatus';

src/types/mqtt/index.ts

@@ -0,0 +1,10 @@
+export * from './in';
+export * from './InPayload';
+export * from './MsgBasePayload';
+export * from './MsgInPayload';
+export * from './MsgOutPayload';
+export * from './MsgTypeBasePayload';
+export * from './MsgTypeInPayload';
+export * from './MsgTypeOutPayload';
+export * from './out';
+export * from './OutPayload';

src/types/mqtt/out/index.ts

@@ -0,0 +1,7 @@
+export * from './DeviceLog';
+export * from './DevicePostBoot';
+export * from './DeviceSetpointChange';
+export * from './DeviceStateChange';
+export * from './DeviceV1Status';
+export * from './DeviceV2Status';
+export * from './OutMessageType';

src/types/rest/Firmwares.ts

@@ -0,0 +1,17 @@
+/** Device firmware information */
+export interface FirmwareDevice {
+  /** Device ID */
+  Device: string;
+  /** Device firmware version */
+  InstalledVersion: string;
+}
+
+/**
+ * Collection of firmware devices indexed by device ID
+ *
+ * Maps device ID strings to their corresponding firmware device objects, providing a lookup table for all devices
+ * associated with a user account.
+ */
+export interface Firmwares {
+  Firmware: Record<string, FirmwareDevice>;
+}

src/types/rest/States.ts

@@ -0,0 +1,69 @@
+/** Represents a timestamped value with metadata */
+export interface TimestampedValue<T = number> {
+  /** Timestamp when the value was recorded */
+  t: number;
+  /** The actual value */
+  v: T;
+}
+
+/** Represents the state of a single device */
+export interface DeviceState {
+  /** Device identifier */
+  Device: string;
+  /** Overall timestamp for the device state */
+  Timestamp: number;
+  /** Time the device has been on */
+  OnTime: TimestampedValue<number>;
+  /** Temperature set point */
+  SetPoint: TimestampedValue<number>;
+  /** Display brightness level */
+  Brightness: TimestampedValue<number>;
+  /** Schedule mode setting */
+  ScheduleMode: TimestampedValue<number>;
+  /** Hold time setting */
+  HoldTime: TimestampedValue<number>;
+  /** Wi-Fi signal strength */
+  Rssi: TimestampedValue<number>;
+  /** Thermostat mode */
+  TstatMode: TimestampedValue<number>;
+  /** Available heap memory */
+  FreeHeap: TimestampedValue<number>;
+  /** Sensor temperature reading */
+  SensorTemp: TimestampedValue<number>;
+  /** Current mode */
+  Mode: TimestampedValue<number>;
+  /** Voltage measurement */
+  Voltage: TimestampedValue<number>;
+  /** Temperature corrected for calibration */
+  CorrectedTemp: TimestampedValue<number>;
+  /** Duty cycle percentage */
+  Duty: TimestampedValue<number>;
+  /** Heat sink temperature */
+  HeatSink: TimestampedValue<number>;
+  /** Time the device has been off */
+  OffTime: TimestampedValue<number>;
+  /** Connection status */
+  Connected: TimestampedValue<boolean>;
+  /** Current consumption */
+  Current: TimestampedValue<number>;
+  /** Humidity reading */
+  Humidity: TimestampedValue<number>;
+  /** Lock status */
+  Lock: TimestampedValue<number>;
+}
+
+/**
+ * Collection of device states indexed by device ID
+ *
+ * Maps device ID strings to their corresponding device state objects, providing a lookup table for all devices
+ * associated with a user account.
+ */
+export interface DeviceStatesObj {
+  /** Device state objects indexed by their unique device ID strings */
+  [deviceId: string]: DeviceState;
+}
+
+/** Top-level interface for the device states REST API response. */
+export interface DeviceStates {
+  DeviceStatesObj: DeviceStatesObj;
+}

src/types/rest/index.ts

@@ -0,0 +1,3 @@
+export * from './Devices';
+export * from './Firmwares';
+export * from './States';